Merge pull request #184 from PowerShell/dev

Release of version 4.4.0.0 of StorageDsc
dsccommunity · Jan 9, 2019 · 01c2380 · 01c2380
2 parents 689f7c1 + ab35372
commit 01c2380
Show file tree

Hide file tree

Showing 75 changed files with 506 additions and 336 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1 @@
+* text eol=crlf
diff --git a/.vscode/RunAllTests.ps1 b/.vscode/RunAllTests.ps1
diff --git a/.vscode/launch.json b/.vscode/launch.json
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,16 @@
 
 ## Unreleased
 
+## 4.4.0.0
+
+- Refactored module folder structure to move resource to root folder of
+  repository and remove test harness - fixes [Issue #169](https://github.com/PowerShell/StorageDsc/issues/169).
+- Updated Examples to support deployment to PowerShell Gallery scripts.
+- Removed limitation on using Pester 4.0.8 during AppVeyor CI.
+- Moved the Code of Conduct text out of the README.md and into a
+  CODE\_OF\_CONDUCT.md file.
+- Explicitly removed extra hidden files from release package
+
 ## 4.3.0.0
 
 - WaitForDisk:

diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,6 @@
+# Code of conduct
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
+or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional
+questions or comments.
diff --git a/...CResources/MSFTDSC_Disk/MSFTDSC_Disk.psm1 → DSCResources/MSFTDSC_Disk/MSFTDSC_Disk.psm1 b/...CResources/MSFTDSC_Disk/MSFTDSC_Disk.psm1 → DSCResources/MSFTDSC_Disk/MSFTDSC_Disk.psm1
diff --git a/...rces/MSFTDSC_Disk/MSFTDSC_Disk.schema.mof → ...rces/MSFTDSC_Disk/MSFTDSC_Disk.schema.mof b/...rces/MSFTDSC_Disk/MSFTDSC_Disk.schema.mof → ...rces/MSFTDSC_Disk/MSFTDSC_Disk.schema.mof
diff --git a/...geDsc/DSCResources/MSFTDSC_Disk/README.md → DSCResources/MSFTDSC_Disk/README.md b/...geDsc/DSCResources/MSFTDSC_Disk/README.md → DSCResources/MSFTDSC_Disk/README.md
diff --git a/...TDSC_Disk/en-us/MSFTDSC_Disk.strings.psd1 → ...TDSC_Disk/en-us/MSFTDSC_Disk.strings.psd1 b/...TDSC_Disk/en-us/MSFTDSC_Disk.strings.psd1 → ...TDSC_Disk/en-us/MSFTDSC_Disk.strings.psd1
diff --git a/...T_DiskAccessPath/MSFT_DiskAccessPath.psm1 → ...T_DiskAccessPath/MSFT_DiskAccessPath.psm1 b/...T_DiskAccessPath/MSFT_DiskAccessPath.psm1 → ...T_DiskAccessPath/MSFT_DiskAccessPath.psm1
diff --git a/...AccessPath/MSFT_DiskAccessPath.schema.mof → ...AccessPath/MSFT_DiskAccessPath.schema.mof b/...AccessPath/MSFT_DiskAccessPath.schema.mof → ...AccessPath/MSFT_DiskAccessPath.schema.mof
diff --git a/...SCResources/MSFT_DiskAccessPath/README.md → DSCResources/MSFT_DiskAccessPath/README.md b/...SCResources/MSFT_DiskAccessPath/README.md → DSCResources/MSFT_DiskAccessPath/README.md
diff --git a/...th/en-us/MSFT_DiskAccessPath.strings.psd1 → ...th/en-us/MSFT_DiskAccessPath.strings.psd1 b/...th/en-us/MSFT_DiskAccessPath.strings.psd1 → ...th/en-us/MSFT_DiskAccessPath.strings.psd1
diff --git a/...rces/MSFT_MountImage/MSFT_MountImage.psm1 → ...rces/MSFT_MountImage/MSFT_MountImage.psm1 b/...rces/MSFT_MountImage/MSFT_MountImage.psm1 → ...rces/MSFT_MountImage/MSFT_MountImage.psm1
diff --git a/...SFT_MountImage/MSFT_MountImage.schema.mof → ...SFT_MountImage/MSFT_MountImage.schema.mof b/...SFT_MountImage/MSFT_MountImage.schema.mof → ...SFT_MountImage/MSFT_MountImage.schema.mof
diff --git a/...sc/DSCResources/MSFT_MountImage/README.md → DSCResources/MSFT_MountImage/README.md b/...sc/DSCResources/MSFT_MountImage/README.md → DSCResources/MSFT_MountImage/README.md
diff --git a/...tImage/en-us/MSFT_MountImage.strings.psd1 → ...tImage/en-us/MSFT_MountImage.strings.psd1 b/...tImage/en-us/MSFT_MountImage.strings.psd1 → ...tImage/en-us/MSFT_MountImage.strings.psd1
diff --git a/...veLetter/MSFT_OpticalDiskDriveLetter.psm1 → ...veLetter/MSFT_OpticalDiskDriveLetter.psm1 b/...veLetter/MSFT_OpticalDiskDriveLetter.psm1 → ...veLetter/MSFT_OpticalDiskDriveLetter.psm1
diff --git a/...er/MSFT_OpticalDiskDriveLetter.schema.mof → ...er/MSFT_OpticalDiskDriveLetter.schema.mof b/...er/MSFT_OpticalDiskDriveLetter.schema.mof → ...er/MSFT_OpticalDiskDriveLetter.schema.mof
diff --git a/...ces/MSFT_OpticalDiskDriveLetter/README.md → ...ces/MSFT_OpticalDiskDriveLetter/README.md b/...ces/MSFT_OpticalDiskDriveLetter/README.md → ...ces/MSFT_OpticalDiskDriveLetter/README.md
diff --git a/.../MSFT_OpticalDiskDriveLetter.strings.psd1 → .../MSFT_OpticalDiskDriveLetter.strings.psd1 b/.../MSFT_OpticalDiskDriveLetter.strings.psd1 → .../MSFT_OpticalDiskDriveLetter.strings.psd1
diff --git a/...es/MSFT_WaitForDisk/MSFT_WaitForDisk.psm1 → ...es/MSFT_WaitForDisk/MSFT_WaitForDisk.psm1 b/...es/MSFT_WaitForDisk/MSFT_WaitForDisk.psm1 → ...es/MSFT_WaitForDisk/MSFT_WaitForDisk.psm1
diff --git a/...T_WaitForDisk/MSFT_WaitForDisk.schema.mof → ...T_WaitForDisk/MSFT_WaitForDisk.schema.mof b/...T_WaitForDisk/MSFT_WaitForDisk.schema.mof → ...T_WaitForDisk/MSFT_WaitForDisk.schema.mof
diff --git a/...c/DSCResources/MSFT_WaitForDisk/README.md → DSCResources/MSFT_WaitForDisk/README.md b/...c/DSCResources/MSFT_WaitForDisk/README.md → DSCResources/MSFT_WaitForDisk/README.md
diff --git a/...rDisk/en-us/MSFT_WaitForDisk.strings.psd1 → ...rDisk/en-us/MSFT_WaitForDisk.strings.psd1 b/...rDisk/en-us/MSFT_WaitForDisk.strings.psd1 → ...rDisk/en-us/MSFT_WaitForDisk.strings.psd1
diff --git a/...SFT_WaitForVolume/MSFT_WaitForVolume.psm1 → ...SFT_WaitForVolume/MSFT_WaitForVolume.psm1 b/...SFT_WaitForVolume/MSFT_WaitForVolume.psm1 → ...SFT_WaitForVolume/MSFT_WaitForVolume.psm1
diff --git a/...itForVolume/MSFT_WaitForVolume.schema.mof → ...itForVolume/MSFT_WaitForVolume.schema.mof b/...itForVolume/MSFT_WaitForVolume.schema.mof → ...itForVolume/MSFT_WaitForVolume.schema.mof
diff --git a/...DSCResources/MSFT_WaitForVolume/README.md → DSCResources/MSFT_WaitForVolume/README.md b/...DSCResources/MSFT_WaitForVolume/README.md → DSCResources/MSFT_WaitForVolume/README.md
diff --git a/...ume/en-us/MSFT_WaitForVolume.strings.psd1 → ...ume/en-us/MSFT_WaitForVolume.strings.psd1 b/...ume/en-us/MSFT_WaitForVolume.strings.psd1 → ...ume/en-us/MSFT_WaitForVolume.strings.psd1
diff --git a/...ources/Disk/1-Disk_InitializeDataDisk.ps1 → ...ources/Disk/1-Disk_InitializeDataDisk.ps1 b/...ources/Disk/1-Disk_InitializeDataDisk.ps1 → ...ources/Disk/1-Disk_InitializeDataDisk.ps1
@@ -1,10 +1,29 @@
+<#PSScriptInfo
+.VERSION 1.0.0
+.GUID 3f629ab7-358f-4d82-8c0a-556e32514e3e
+.AUTHOR Microsoft Corporation
+.COMPANYNAME Microsoft Corporation
+.COPYRIGHT
+.TAGS DSCConfiguration
+.LICENSEURI https://github.com/PowerShell/StorageDsc/blob/master/LICENSE
+.PROJECTURI https://github.com/PowerShell/StorageDsc
+.ICONURI
+.EXTERNALMODULEDEPENDENCIES
+.REQUIREDSCRIPTS
+.EXTERNALSCRIPTDEPENDENCIES
+.RELEASENOTES First version.
+.PRIVATEDATA 2016-Datacenter,2016-Datacenter-Server-Core
+#>
+
+#Requires -module StorageDsc
+
 <#
-    .EXAMPLE
+    .DESCRIPTION
         This configuration will wait for disk 2 to become available, and then make the disk available as
         two new formatted volumes, 'G' and 'J', with 'J' using all available space after 'G' has been
         created. It also creates a new ReFS formated volume on disk 3 attached as drive letter 'S'.
 #>
-Configuration Example
+Configuration Disk_InitializeDataDisk
 {
     Import-DSCResource -ModuleName StorageDsc
 

diff --git a/...-Disk_InitializeDataDiskUsingUniqueId.ps1 → ...-Disk_InitializeDataDiskUsingUniqueId.ps1 b/...-Disk_InitializeDataDiskUsingUniqueId.ps1 → ...-Disk_InitializeDataDiskUsingUniqueId.ps1
@@ -1,11 +1,30 @@
+<#PSScriptInfo
+.VERSION 1.0.0
+.GUID 56cbc9fc-4168-4662-9dec-12addcfb82da
+.AUTHOR Microsoft Corporation
+.COMPANYNAME Microsoft Corporation
+.COPYRIGHT
+.TAGS DSCConfiguration
+.LICENSEURI https://github.com/PowerShell/StorageDsc/blob/master/LICENSE
+.PROJECTURI https://github.com/PowerShell/StorageDsc
+.ICONURI
+.EXTERNALMODULEDEPENDENCIES
+.REQUIREDSCRIPTS
+.EXTERNALSCRIPTDEPENDENCIES
+.RELEASENOTES First version.
+.PRIVATEDATA 2016-Datacenter,2016-Datacenter-Server-Core
+#>
+
+#Requires -module StorageDsc
+
 <#
-    .EXAMPLE
+    .DESCRIPTION
         This configuration will wait for disk 2 with Unique Id '5E1E50A401000000001517FFFF0AEB84' to become
         available, and then make the disk available as two new formatted volumes, 'G' and 'J', with 'J'
         using all available space after 'G' has been created. It also creates a new ReFS formated
         volume on disk 3 with Unique Id '5E1E50A4010000000029AB39450AC9A5' attached as drive letter 'S'.
 #>
-Configuration Example
+Configuration Disk_InitializeDataDiskUsingUniqueId
 {
     Import-DSCResource -ModuleName StorageDsc
 

diff --git a/...Path_InitializeDataDiskWithAccessPath.ps1 → ...Path_InitializeDataDiskWithAccessPath.ps1 b/...Path_InitializeDataDiskWithAccessPath.ps1 → ...Path_InitializeDataDiskWithAccessPath.ps1
@@ -1,10 +1,29 @@
+<#PSScriptInfo
+.VERSION 1.0.0
+.GUID 98a5636f-0168-47df-9235-13e37a7d6d03
+.AUTHOR Microsoft Corporation
+.COMPANYNAME Microsoft Corporation
+.COPYRIGHT
+.TAGS DSCConfiguration
+.LICENSEURI https://github.com/PowerShell/StorageDsc/blob/master/LICENSE
+.PROJECTURI https://github.com/PowerShell/StorageDsc
+.ICONURI
+.EXTERNALMODULEDEPENDENCIES
+.REQUIREDSCRIPTS
+.EXTERNALSCRIPTDEPENDENCIES
+.RELEASENOTES First version.
+.PRIVATEDATA 2016-Datacenter,2016-Datacenter-Server-Core
+#>
+
+#Requires -module StorageDsc
+
 <#
-    .EXAMPLE
+    .DESCRIPTION
         This configuration will wait for disk 2 to become available, and then make the disk available as
         two new formatted volumes mounted to folders c:\SQLData and c:\SQLLog, with c:\SQLLog using all
         available space after c:\SQLData has been created.
 #>
-Configuration Example
+Configuration DiskAccessPath_InitializeDataDiskWithAccessPath
 {
     Import-DSCResource -ModuleName StorageDsc
 

diff --git a/...zeDataDiskWithAccessPathUsingUniqueId.ps1 → ...zeDataDiskWithAccessPathUsingUniqueId.ps1 b/...zeDataDiskWithAccessPathUsingUniqueId.ps1 → ...zeDataDiskWithAccessPathUsingUniqueId.ps1
@@ -1,10 +1,29 @@
+<#PSScriptInfo
+.VERSION 1.0.0
+.GUID e3997b35-031f-4e35-bb18-2f542d710e92
+.AUTHOR Microsoft Corporation
+.COMPANYNAME Microsoft Corporation
+.COPYRIGHT
+.TAGS DSCConfiguration
+.LICENSEURI https://github.com/PowerShell/StorageDsc/blob/master/LICENSE
+.PROJECTURI https://github.com/PowerShell/StorageDsc
+.ICONURI
+.EXTERNALMODULEDEPENDENCIES
+.REQUIREDSCRIPTS
+.EXTERNALSCRIPTDEPENDENCIES
+.RELEASENOTES First version.
+.PRIVATEDATA 2016-Datacenter,2016-Datacenter-Server-Core
+#>
+
+#Requires -module StorageDsc
+
 <#
-    .EXAMPLE
+    .DESCRIPTION
         This configuration will wait for disk 2 with Unique Id '5E1E50A401000000001517FFFF0AEB84' to become
-        available, and then make the disk available as two new formatted volumes mounted to folders 
+        available, and then make the disk available as two new formatted volumes mounted to folders
         c:\SQLData and c:\SQLLog, with c:\SQLLog using all available space after c:\SQLData has been created.
 #>
-Configuration Example
+Configuration DiskAccessPath_InitializeDataDiskWithAccessPathUsingUniqueId
 {
     Import-DSCResource -ModuleName StorageDsc
 

diff --git a/Examples/Resources/MountImage/1-MountImage_DismountISO.ps1 b/Examples/Resources/MountImage/1-MountImage_DismountISO.ps1
@@ -0,0 +1,34 @@
+<#PSScriptInfo
+.VERSION 1.0.0
+.GUID 12106838-fad0-44c7-b49f-51bfe7109135
+.AUTHOR Microsoft Corporation
+.COMPANYNAME Microsoft Corporation
+.COPYRIGHT
+.TAGS DSCConfiguration
+.LICENSEURI https://github.com/PowerShell/StorageDsc/blob/master/LICENSE
+.PROJECTURI https://github.com/PowerShell/StorageDsc
+.ICONURI
+.EXTERNALMODULEDEPENDENCIES
+.REQUIREDSCRIPTS
+.EXTERNALSCRIPTDEPENDENCIES
+.RELEASENOTES First version.
+.PRIVATEDATA 2016-Datacenter,2016-Datacenter-Server-Core
+#>
+
+#Requires -module StorageDsc
+
+<#
+    .DESCRIPTION
+        This configuration will unmount an ISO file that is mounted in S:.
+#>
+configuration MountImage_DismountISO
+{
+    Import-DscResource -ModuleName StorageDsc
+
+    MountImage ISO
+    {
+        ImagePath = 'c:\Sources\SQL.iso'
+        DriveLetter = 'S'
+        Ensure = 'Absent'
+    }
+}
diff --git a/Examples/Resources/MountImage/2-MountImage_MountISO.ps1 b/Examples/Resources/MountImage/2-MountImage_MountISO.ps1
@@ -0,0 +1,40 @@
+<#PSScriptInfo
+.VERSION 1.0.0
+.GUID 73bdd44d-4944-4217-a5ba-4f63948a1376
+.AUTHOR Microsoft Corporation
+.COMPANYNAME Microsoft Corporation
+.COPYRIGHT
+.TAGS DSCConfiguration
+.LICENSEURI https://github.com/PowerShell/StorageDsc/blob/master/LICENSE
+.PROJECTURI https://github.com/PowerShell/StorageDsc
+.ICONURI
+.EXTERNALMODULEDEPENDENCIES
+.REQUIREDSCRIPTS
+.EXTERNALSCRIPTDEPENDENCIES
+.RELEASENOTES First version.
+.PRIVATEDATA 2016-Datacenter,2016-Datacenter-Server-Core
+#>
+
+#Requires -module StorageDsc
+
+<#
+    .DESCRIPTION
+        This configuration will mount an ISO file as drive S:.
+#>
+configuration MountImage_MountISO
+{
+    Import-DscResource -ModuleName StorageDsc
+
+    MountImage ISO
+    {
+        ImagePath   = 'c:\Sources\SQL.iso'
+        DriveLetter = 'S'
+    }
+
+    WaitForVolume WaitForISO
+    {
+        DriveLetter      = 'S'
+        RetryIntervalSec = 5
+        RetryCount       = 10
+    }
+}
diff --git a/Examples/Resources/MountImage/3-MountImage_MountVHD.ps1 b/Examples/Resources/MountImage/3-MountImage_MountVHD.ps1
@@ -0,0 +1,40 @@
+<#PSScriptInfo
+.VERSION 1.0.0
+.GUID c4b48b7c-2a0f-4d18-9806-9c1063b8de83
+.AUTHOR Microsoft Corporation
+.COMPANYNAME Microsoft Corporation
+.COPYRIGHT
+.TAGS DSCConfiguration
+.LICENSEURI https://github.com/PowerShell/StorageDsc/blob/master/LICENSE
+.PROJECTURI https://github.com/PowerShell/StorageDsc
+.ICONURI
+.EXTERNALMODULEDEPENDENCIES
+.REQUIREDSCRIPTS
+.EXTERNALSCRIPTDEPENDENCIES
+.RELEASENOTES First version.
+.PRIVATEDATA 2016-Datacenter,2016-Datacenter-Server-Core
+#>
+
+#Requires -module StorageDsc
+
+<#
+    .DESCRIPTION
+        This configuration will mount a VHD file and wait for it to become available.
+#>
+configuration MountImage_MountVHD
+{
+    Import-DscResource -ModuleName StorageDsc
+
+    MountImage MountVHD
+    {
+        ImagePath   = 'd:\Data\Disk1.vhd'
+        DriveLetter = 'V'
+    }
+
+    WaitForVolume WaitForVHD
+    {
+        DriveLetter      = 'V'
+        RetryIntervalSec = 5
+        RetryCount       = 10
+    }
+}
diff --git a/Examples/Resources/OpticalDiskDriveLetter/1-OpticalDiskDriveLetter_SetDriveLetter.ps1 b/Examples/Resources/OpticalDiskDriveLetter/1-OpticalDiskDriveLetter_SetDriveLetter.ps1
@@ -0,0 +1,37 @@
+<#PSScriptInfo
+.VERSION 1.0.0
+.GUID 1ef469e5-eabf-4e5d-9ff4-f17d2894991f
+.AUTHOR Microsoft Corporation
+.COMPANYNAME Microsoft Corporation
+.COPYRIGHT
+.TAGS DSCConfiguration
+.LICENSEURI https://github.com/PowerShell/StorageDsc/blob/master/LICENSE
+.PROJECTURI https://github.com/PowerShell/StorageDsc
+.ICONURI
+.EXTERNALMODULEDEPENDENCIES
+.REQUIREDSCRIPTS
+.EXTERNALSCRIPTDEPENDENCIES
+.RELEASENOTES First version.
+.PRIVATEDATA 2016-Datacenter,2016-Datacenter-Server-Core
+#>
+
+#Requires -module StorageDsc
+
+<#
+    .DESCRIPTION
+        This configuration will set the drive letter of the first
+        optical disk drive in the system to 'Z'.
+#>
+Configuration OpticalDiskDriveLetter_SetDriveLetter
+{
+    Import-DSCResource -ModuleName StorageDsc
+
+    Node localhost
+    {
+        OpticalDiskDriveLetter SetFirstOpticalDiskDriveLetterToZ
+        {
+            DiskId      = 1
+            DriveLetter = 'Z'
+        }
+    }
+}
diff --git a/Examples/Resources/OpticalDiskDriveLetter/2-OpticalDiskDriveLetter_RemoveDriveLetter.ps1 b/Examples/Resources/OpticalDiskDriveLetter/2-OpticalDiskDriveLetter_RemoveDriveLetter.ps1
@@ -0,0 +1,38 @@
+<#PSScriptInfo
+.VERSION 1.0.0
+.GUID f7d8127c-90fa-46ef-8dc7-42667a63f4db
+.AUTHOR Microsoft Corporation
+.COMPANYNAME Microsoft Corporation
+.COPYRIGHT
+.TAGS DSCConfiguration
+.LICENSEURI https://github.com/PowerShell/StorageDsc/blob/master/LICENSE
+.PROJECTURI https://github.com/PowerShell/StorageDsc
+.ICONURI
+.EXTERNALMODULEDEPENDENCIES
+.REQUIREDSCRIPTS
+.EXTERNALSCRIPTDEPENDENCIES
+.RELEASENOTES First version.
+.PRIVATEDATA 2016-Datacenter,2016-Datacenter-Server-Core
+#>
+
+#Requires -module StorageDsc
+
+<#
+    .DESCRIPTION
+        This configuration will remove the drive letter of the first
+        optical disk drive.
+#>
+Configuration OpticalDiskDriveLetter_RemoveDriveLetter
+{
+    Import-DSCResource -ModuleName StorageDsc
+
+    Node localhost
+    {
+        OpticalDiskDriveLetter RemoveFirstOpticalDiskDriveLetter
+        {
+            DiskId      = 1
+            DriveLetter = 'X' # This value is ignored
+            Ensure      = 'Absent'
+        }
+    }
+}