Merge pull request #92 from PowerShell/dev

Release of version 3.0.0.0 of xStorage

.MetaTestOptIn.json

@@ -0,0 +1,4 @@
+[
+        "Common Tests - Validate Markdown Files",
+        "Common Tests - Validate Example Files"
+]

.codecov.yml

@@ -0,0 +1,26 @@
+codecov:
+  notify:
+    require_ci_to_pass: no
+  # dev should be the baseline for reporting
+  branch: dev
+
+comment:
+  layout: "reach, diff"
+  behavior: default
+
+coverage:
+  range: 50..80
+  round: down
+  precision: 0
+
+  status:
+    project:
+      default:
+        # Set the overall project code coverage requirement to 70%
+        target: 70
+    patch:
+      default:
+        # Set the pull request requirement to not regress overall coverage by more than 5%
+        # and let codecov.io set the goal for the code changed in the patch.
+        target: auto
+        threshold: 5

.gitignore

@@ -1,2 +1,15 @@
-DSCResource.Tests/
+*.suo
+*.user
+*.coverage
+.vs
+.psproj
+.sln
+DscResource.Tests
+DscResource.Tests/*
+Modules/xStorage/DscResource.Tests
+Modules/xStorage/DscResource.Tests/*
+node_modules
+node_modules/*
+markdownissues.txt
+TestResults.xml
 Tests/Integration/test.iso

.vscode/RunAllTests.ps1

@@ -0,0 +1,11 @@
+[string] $repoRoot = Split-Path -Path (Split-Path -Path $Script:MyInvocation.MyCommand.Path)
+if ( (-not (Test-Path -Path (Join-Path -Path $repoRoot -ChildPath 'DSCResource.Tests'))) -or `
+     (-not (Test-Path -Path (Join-Path -Path $repoRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1'))) )
+{
+    & git @('clone','https://github.com/PowerShell/DscResource.Tests.git',(Join-Path -Path $repoRoot -ChildPath '\DSCResource.Tests\'))
+}
+
+Import-Module (Join-Path $PSScriptRoot "..\Tests\TestHarness.psm1" -Resolve)
+$dscTestsPath = Join-Path -Path $PSScriptRoot `
+                          -ChildPath "..\Modules\xStorage\DscResource.Tests\Meta.Tests.ps1"
+Invoke-TestHarness -DscTestsPath $dscTestsPath

.vscode/launch.json

@@ -0,0 +1,19 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "PowerShell",
+            "type": "PowerShell",
+            "request": "launch",
+            "program": "${file}",
+            "args": [],
+            "cwd": "${file}"
+        },
+        {
+            "name": "Run all tests",
+            "type": "PowerShell",
+            "request": "launch",
+            "program": "${workspaceRoot}/.vscode/RunAllTests.ps1"
+        }
+    ]
+}

CHANGELOG.md

@@ -0,0 +1,163 @@
+# Versions
+
+## Unreleased
+
+## 3.0.0.0
+
+- Converted AppVeyor build process to use AppVeyor.psm1.
+- Added support for auto generating wiki, help files, markdown linting
+  and checking examples.
+- Correct name of MSFT_xDiskAccessPath.tests.ps1.
+- Move shared modules into Modules folder.
+- Fixed unit tests.
+- Removed support for WMI cmdlets.
+- Opted in to Markdown and Example tests.
+- Added CodeCov.io support.
+- Removed requirement on using Pester 3.4.6 because Pester bug fixed in 4.0.3.
+- Fixed unit tests for MSFT_xDiskAccessPath resource to be compatible with
+  Pester 4.0.3.
+- xDisk:
+  - BREAKING CHANGE: Renamed parameter DiskNumber to DiskId to enable it to
+    contain either DiskNumber or UniqueId - See [Issue 81](https://github.com/PowerShell/xStorage/issues/81).
+  - Added DiskIdType parameter to enable specifying the type of identifer
+    the DiskId parameter contains - See [Issue 81](https://github.com/PowerShell/xStorage/issues/81).
+  - Changed to use xDiskAccessPath pattern to fix issue with Windows Server
+    2016 - See [Issue 80](https://github.com/PowerShell/xStorage/issues/80).
+  - Fixed style violations in xDisk.
+  - Fixed issue when creating multiple partitions on a single disk with no size
+    specified - See [Issue 86](https://github.com/PowerShell/xStorage/issues/86).
+- xDiskAccessPath:
+  - BREAKING CHANGE: Renamed parameter DiskNumber to DiskId to
+    enable it to contain either DiskNumber or UniqueId - See [Issue 81](https://github.com/PowerShell/xStorage/issues/81).
+  - Added DiskIdType parameter to enable specifying the type
+    of identifer the DiskId parameter contains - See [Issue 81](https://github.com/PowerShell/xStorage/issues/81).
+  - Fixed incorrect logging messages when changing volume label.
+  - Fixed issue when creating multiple partitions on a single disk with no size
+    specified - See [Issue 86](https://github.com/PowerShell/xStorage/issues/86).
+- xWaitForDisk:
+  - BREAKING CHANGE: Renamed parameter DiskNumber to DiskId to
+    enable it to contain either DiskNumber or UniqueId - See [Issue 81](https://github.com/PowerShell/xStorage/issues/81).
+  - Added DiskIdType parameter to enable specifying the type
+    of identifer the DiskId parameter contains - See [Issue 81](https://github.com/PowerShell/xStorage/issues/81).
+
+## 2.9.0.0
+
+- Updated readme.md to remove markdown best practice rule violations.
+- Updated readme.md to match DSCResources/DscResource.Template/README.md.
+- xDiskAccessPath:
+  - Fix bug when re-attaching disk after mount point removed or detatched.
+  - Additional log entries added for improved diagnostics.
+  - Additional integration tests added.
+  - Improve timeout loop.
+- Converted integration tests to use ```$TestDrive``` as working folder or
+  ```temp``` folder when persistence across tests is required.
+- Suppress ```PSUseShouldProcessForStateChangingFunctions``` rule violations in resources.
+- Rename ```Test-AccessPath``` function to ```Assert-AccessPathValid```.
+- Rename ```Test-DriveLetter``` function to ```Assert-DriveLetterValid```.
+- Added ```CommonResourceHelper.psm1``` module (based on PSDscResources).
+- Added ```CommonTestsHelper.psm1``` module  (based on PSDscResources).
+- Converted all modules to load localization data using ```Get-LocalizedData```
+  from CommonResourceHelper.
+- Converted all exception calls and tests to use functions in
+  ```CommonResourceHelper.psm1``` and ```CommonTestsHelper.psm1``` respectively.
+- Fixed examples:
+  - Sample_InitializeDataDisk.ps1
+  - Sample_InitializeDataDiskWithAccessPath.ps1
+  - Sample_xMountImage_DismountISO.ps1
+- xDisk:
+  - Improve timeout loop.
+
+## 2.8.0.0
+
+- added test for existing file system and no drive letter assignment to allow
+  simple drive letter assignment in MSFT_xDisk.psm1
+- added unit test for volume with existing partition and no drive letter
+  assigned for MSFT_xDisk.psm1
+- xMountImage: Fixed mounting disk images on Windows 10 Anniversary Edition
+- Updated to meet HQRM guidelines.
+- Moved all strings into localization files.
+- Fixed examples to import xStorage module.
+- Fixed Readme.md layout issues.
+- xWaitForDisk:
+  - Added support for setting DriveLetter parameter with or without colon.
+  - MOF Class version updated to 1.0.0.0.
+- xWaitForVolume:
+  - Added new resource.
+- StorageCommon:
+  - Added helper function module.
+  - Corrected name of unit tests file.
+- xDisk:
+  - Added validation of DriveLetter parameter.
+  - Added support for setting DriveLetter parameter with or without colon.
+  - Removed obfuscation of drive/partition errors by eliminating try/catch block.
+  - Improved code commenting.
+  - Reordered tests so they are in same order as module functions to ease creation.
+  - Added FSFormat parameter to allow disk format to be specified.
+  - Size or AllocationUnitSize mismatches no longer trigger Set-TargetResource
+    because these values can't be changed (yet).
+  - MOF Class version updated to 1.0.0.0.
+  - Unit tests changed to match xDiskAccessPath methods.
+  - Added additional unit tests to Get-TargetResource.
+  - Fixed bug in Get-TargetResource when disk did not contain any partitions.
+  - Added missing cmdletbinding() to functions.
+- xMountImage (Breaking Change):
+  - Removed Name parameter (Breaking Change)
+  - Added validation of DriveLetter parameter.
+  - Added support for setting DriveLetter parameter with or without colon.
+  - MOF Class version updated to 1.0.0.0.
+  - Enabled mounting of VHD/VHDx/VHDSet disk images.
+  - Added StorageType and Access parameters to allow mounting VHD and VHDx disks
+    as read/write.
+- xDiskAccessPath:
+  - Added new resource.
+  - Added support for changing/setting volume label.
+
+## 2.7.0.0
+
+- Converted appveyor.yml to install Pester from PSGallery instead of from Chocolatey.
+
+## 2.6.0.0
+
+- MSFT_xDisk: Replaced Get-WmiObject with Get-CimInstance
+
+## 2.5.0.0
+
+- added test for existing file system to allow simple drive letter assignment in
+  MSFT_xDisk.psm1
+- modified Test verbose message to correctly reflect blocksize value in
+  MSFT_xDisk.psm1 line 217
+- added unit test for new volume with out existing partition for MSFT_xDisk.psm1
+- Fixed error propagation
+
+## 2.4.0.0
+
+- Fixed bug where AllocationUnitSize was not used
+
+## 2.3.0.0
+
+- Added support for `AllocationUnitSize` in `xDisk`.
+
+## 2.2.0.0
+
+- Updated documentation: changed parameter name Count to RetryCount in
+  xWaitForDisk resource
+
+## 2.1.0.0
+
+- Fixed encoding
+
+## 2.0.0.0
+
+- Breaking change: Added support for following properties: DriveLetter, Size,
+  FSLabel. DriveLetter is a new key property.
+
+## 1.0.0.0
+
+This module was previously named **xDisk**, the version is regressing to a
+"1.0.0.0" release with the addition of xMountImage.
+
+- Initial release of xStorage module with following resources (contains
+  resources from deprecated xDisk module):
+- xDisk (from xDisk)
+- xMountImage
+- xWaitForDisk (from xDisk)