BREAKING CHANGE: xHyper-V renamed to HyperVDsc: Renamed all DSCResour…

…ces, Examples, Modules and Tests where applicable (#194)

.vscode/tasks.json

@@ -84,7 +84,11 @@
             "label": "test",
             "type": "shell",
             "command": "&${cwd}/build.ps1",
-            "args": ["-AutoRestore","-Tasks","test"],
+            "args": [
+                "-AutoRestore",
+                "-Tasks",
+                "test"
+            ],
             "presentation": {
                 "echo": true,
                 "reveal": "always",

CHANGELOG.md

@@ -6,6 +6,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 For older change log history see the [historic changelog](HISTORIC_CHANGELOG.md).
 
 ## [Unreleased]
+- xHyper-V
+  - BREAKING CHANGE
+    - Renamed _xHyper-V_ to _HyperVDsc - fixes [Issue #69](https://github.com/PowerShell/xHyper-V/issues/213).
+    - Changed all MSFT_xResourceName to DSC_ResourceName.
+    - Updated DSCResources, Examples, Modules and Tests for new naming.
+    - Updated README.md from _xHyper-V_ to _HyperVDsc
 
 ## [3.18.0] - 2022-06-04
 

RequiredModules.psd1

@@ -18,9 +18,7 @@
     MarkdownLinkCheck           = 'latest'
     'DscResource.Test'          = 'latest'
     'DscResource.AnalyzerRules' = 'latest'
-    xDscResourceDesigner        = 'latest'
     'DscResource.DocGenerator'  = 'latest'
-
-    # Build dependent modules
     'DscResource.Common'        = 'latest'
+    xDscResourceDesigner        = 'latest'
 }

Resolve-Dependency.ps1

@@ -241,7 +241,7 @@ try
 
         $installPowerShellGetParameters = @{
             Name               = 'PowerShellGet'
-            Force              = $True
+            Force              = $true
             SkipPublisherCheck = $true
             AllowClobber       = $true
             Scope              = $Scope

build.ps1

@@ -356,8 +356,7 @@ Begin
 
             $BuildConfig = $config[0]
         }
-        else
-        {
+        else {
             $BuildConfig = $config
         }
     }

build.yaml

@@ -2,7 +2,6 @@
 ####################################################
 #          ModuleBuilder Configuration             #
 ####################################################
-
 CopyPaths:
   - en-US
   - DSCResources
@@ -22,7 +21,7 @@ NestedModule:
       Exclude: PSGetModuleInfo.xml
 
 ####################################################
-#       Sampler Pipeline Configuration             #
+#       Pipeline Configuration                     #
 ####################################################
 BuildWorkflow:
   '.':
@@ -33,7 +32,7 @@ BuildWorkflow:
     - Clean
     - Build_Module_ModuleBuilder
     - Build_NestedModules_ModuleBuilder
-    - Create_changelog_release_output
+    - Create_Changelog_Release_Output
     - Generate_Conceptual_Help
     - Generate_Wiki_Content
 
@@ -46,15 +45,15 @@ BuildWorkflow:
 
   test:
     - Pester_Tests_Stop_On_Fail
-    - Pester_if_Code_Coverage_Under_Threshold
+    - Pester_If_Code_Coverage_Under_Threshold
 
   publish:
     - publish_module_to_gallery
     - Publish_Release_To_GitHub
     - Publish_GitHub_Wiki_Content
 
 ####################################################
-#       PESTER  Configuration                      #
+#       PESTER Configuration                       #
 ####################################################
 
 Pester:
@@ -64,18 +63,19 @@ Pester:
   Script:
     - tests/Unit
   Tag:
-  CodeCoverageThreshold: 83
   CodeCoverageOutputFile: JaCoCo_coverage.xml
   CodeCoverageOutputFileEncoding: ascii
+  CodeCoverageThreshold: 80
 
 DscTest:
+  OutputFormat: NUnitXML
   ExcludeTag:
-    - "Common Tests - New Error-Level Script Analyzer Rules"
-  Tag:
+    - 'Common Tests - New Error-Level Script Analyzer Rules'
   ExcludeSourceFile:
     - output
   ExcludeModuleFile:
     - Modules/DscResource.Common
+  MainGitBranch: master
 
 ModuleBuildTasks:
   Sampler:

codecov.yml

@@ -1,6 +1,6 @@
 codecov:
   require_ci_to_pass: no
-  # master should be the baseline for reporting
+  # main should be the baseline for reporting
   branch: master
 
 comment:
@@ -16,13 +16,14 @@ coverage:
     project:
       default:
         # Set the overall project code coverage requirement to 70%
-        target: 70
+        target: 80
     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
 
+# This is not needed if the module only contain class-based resources.
 fixes:
   - '^\d+\.\d+\.\d+::source'  # move path "X.Y.Z" => "source"

source/DSCResources/MSFT_xVHD/MSFT_xVHD.psm1 → source/DSCResources/DSC_VHD/DSC_Vhd.psm1

@@ -6,7 +6,7 @@ $script:localizedData = Get-LocalizedData -DefaultUICulture 'en-US'
 
 <#
 .SYNOPSIS
-    Gets MSFT_xVHD resource current state.
+    Gets DSC_VHD resource current state.
 
 .PARAMETER Name
     The desired VHD file name.
@@ -72,7 +72,7 @@ function Get-TargetResource
 
 <#
 .SYNOPSIS
-    Configures MSFT_xVHD resource state.
+    Configures DSC_VHD resource state.
 
 .PARAMETER Name
     The desired VHD file name.
@@ -224,7 +224,7 @@ function Set-TargetResource
 
 <#
 .SYNOPSIS
-    Tests if MSFT_xVHD resource state is in the desired state or not.
+    Tests if DSC_VHD resource state is in the desired state or not.
 
 .PARAMETER Name
     The desired VHD file name.

source/DSCResources/MSFT_xVHD/MSFT_xVHD.schema.mof → source/DSCResources/DSC_VHD/DSC_Vhd.schema.mof

@@ -1,5 +1,5 @@
-[ClassVersion("1.0.0"), FriendlyName("xVHD")]
-class MSFT_xVHD : OMI_BaseResource
+[ClassVersion("1.0.0"), FriendlyName("Vhd")]
+class DSC_Vhd : OMI_BaseResource
 {
     [Key, Description("Name of the VHD File")] String Name;
     [Key, Description("Folder where the VHD will be created")] String Path;

source/DSCResources/MSFT_xVMDvdDrive/MSFT_xVMDvdDrive.schema.mof → source/DSCResources/DSC_VMDvdDrive/DSC_VMDvdDrive.schema.mof

@@ -1,5 +1,5 @@
-[ClassVersion("1.0.0.0"), FriendlyName("xVMDvdDrive")]
-class MSFT_xVMDvdDrive : OMI_BaseResource
+[ClassVersion("1.0.0.0"), FriendlyName("VMDvdDrive")]
+class DSC_VMDvdDrive : OMI_BaseResource
 {
     [Key, Description("Specifies the name of the virtual machine to which the DVD drive is to be added.")] String VMName;
     [Key, Description("Specifies the number of the controller to which the DVD drive is to be added.")] Uint32 ControllerNumber;

source/DSCResources/MSFT_xVMHardDiskDrive/MSFT_xVMHardDiskDrive.schema.mof → source/DSCResources/DSC_VMHardDiskDrive/DSC_VMHardDiskDrive.schema.mof

@@ -1,5 +1,5 @@
-[ClassVersion("1.0.0"), FriendlyName("xVMHardDiskDrive")]
-class MSFT_xVMHardDiskDrive : OMI_BaseResource
+[ClassVersion("1.0.0"), FriendlyName("VMHardDiskDrive")]
+class DSC_VMHardDiskDrive : OMI_BaseResource
 {
     [Key, Description("Specifies the name of the virtual machine whose hard disk drive is to be manipulated.")] String VMName;
     [Key, Description("Specifies the full path to the location of the VHD that represents the hard disk drive.")] String Path;

source/DSCResources/MSFT_xVMHost/MSFT_xVMHost.psm1 → source/DSCResources/DSC_VMHost/DSC_VMHost.psm1

@@ -8,7 +8,7 @@ $script:localizedData = Get-LocalizedData -DefaultUICulture 'en-US'
 
 <#
 .SYNOPSIS
-    Gets MSFT_xVMHost resource current state.
+    Gets DSC_VMHost resource current state.
 
 .PARAMETER IsSingleInstance
     Specifies the resource is a single instance, the value must be 'Yes'.
@@ -62,7 +62,7 @@ function Get-TargetResource
 
 <#
 .SYNOPSIS
-    Tests if MSFT_xVMHost resource state is in the desired state or not.
+    Tests if DSC_VMHost resource state is in the desired state or not.
 
 .PARAMETER IsSingleInstance
     Specifies the resource is a single instance, the value must be 'Yes'.
@@ -241,7 +241,7 @@ function Test-TargetResource
 
 <#
 .SYNOPSIS
-    Configures MSFT_xVMHost resource state.
+    Configures DSC_VMHost resource state.
 
 .PARAMETER IsSingleInstance
     Specifies the resource is a single instance, the value must be 'Yes'.

source/DSCResources/MSFT_xVMHost/MSFT_xVMHost.schema.mof → source/DSCResources/DSC_VMHost/DSC_VMHost.schema.mof

@@ -1,5 +1,5 @@
-[ClassVersion("1.0.0.0"), FriendlyName("xVMHost")]
-class MSFT_xVMHost : OMI_BaseResource
+[ClassVersion("1.0.0.0"), FriendlyName("VMHost")]
+class DSC_VMHost : OMI_BaseResource
 {
     [Key, Description("Specifies the resource is a single instance, the value must be 'Yes'."), ValueMap{"Yes"}, Values{"Yes"}] String IsSingleInstance;
     [Write, Description("Indicates whether users can use enhanced mode when they connect to virtual machines on this server by using Virtual Machine Connection.")] Boolean EnableEnhancedSessionMode;

source/DSCResources/MSFT_xVMHyperV/MSFT_xVMHyperV.schema.mof → source/DSCResources/DSC_VMHyperV/DSC_VMHyperV.schema.mof

@@ -1,5 +1,5 @@
-[ClassVersion("1.0.0"), FriendlyName("xVMHyperV")]
-class MSFT_xVMHyperV : OMI_BaseResource
+[ClassVersion("1.0.0"), FriendlyName("VMHyperV")]
+class DSC_VMHyperV : OMI_BaseResource
 {
     [Key, Description("Name of the VM")] String Name;
     [Required, Description("VHD associated with the VM")] String VhdPath;

source/DSCResources/MSFT_xVMNetworkAdapter/MSFT_xVMNetworkAdapter.psm1 → source/DSCResources/DSC_VMNetworkAdapter/DSC_VMNetworkAdapter.psm1

@@ -6,7 +6,7 @@ $script:localizedData = Get-LocalizedData -DefaultUICulture 'en-US'
 
 <#
 .SYNOPSIS
-    Gets MSFT_xVMNetworkAdapter resource current state.
+    Gets DSC_VMNetworkAdapter resource current state.
 
 .PARAMETER Id
     Specifies an unique identifier for the network adapter.
@@ -88,7 +88,7 @@ function Get-TargetResource
         $networkInfo = Get-NetworkInformation -VMName $VMName -Name $Name
         if ($networkInfo)
         {
-            $item = New-CimInstance -ClassName MSFT_xNetworkSettings -Property $networkInfo -Namespace root/microsoft/windows/desiredstateconfiguration -ClientOnly
+            $item = New-CimInstance -ClassName MSFT_NetworkSettings -Property $networkInfo -Namespace root/microsoft/windows/desiredstateconfiguration -ClientOnly
             $configuration.Add('NetworkSetting', $item)
         }
 
@@ -112,7 +112,7 @@ function Get-TargetResource
 
 <#
 .SYNOPSIS
-    Sets MSFT_xVMNetworkAdapter resource state.
+    Sets DSC_VMNetworkAdapter resource state.
 
 .PARAMETER Id
     Specifies an unique identifier for the network adapter.
@@ -344,7 +344,7 @@ function Set-TargetResource
 
 <#
 .SYNOPSIS
-    Tests if MSFT_xVMNetworkAdapter resource state is indeed desired state or not.
+    Tests if DSC_VMNetworkAdapter resource state is indeed desired state or not.
 
 .PARAMETER Id
     Specifies an unique identifier for the network adapter.

source/DSCResources/MSFT_xVMNetworkAdapter/MSFT_xVMNetworkAdapter.schema.mof → source/DSCResources/DSC_VMNetworkAdapter/DSC_VMNetworkAdapter.schema.mof

@@ -1,22 +1,22 @@
 
 [ClassVersion("2.0.0.0")]
-Class xNetworkSettings
+Class NetworkSettings
 {
   [Write] string IpAddress;
   [Write] string Subnet;
   [Write] string DefaultGateway;
   [Write] string DnsServer;
 };
 
-[ClassVersion("2.0.0.0"), FriendlyName("xVMNetworkAdapter")]
-class MSFT_xVMNetworkAdapter : OMI_BaseResource
+[ClassVersion("2.0.0.0"), FriendlyName("VMNetworkAdapter")]
+class DSC_VMNetworkAdapter : OMI_BaseResource
 {
     [Key] String Id;
     [Required] String Name;
     [Required] String SwitchName;
     [Required] String VMName;
     [Write] String MacAddress;
-    [Write, EmbeddedInstance("xNetworkSettings")] String NetworkSetting;
+    [Write, EmbeddedInstance("NetworkSettings")] String NetworkSetting;
     [Write] String VlanId;
     [Write, ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;
     [Read] Boolean DynamicMacAddress;

source/DSCResources/MSFT_xVMProcessor/MSFT_xVMProcessor.psm1 → source/DSCResources/DSC_VMProcessor/DSC_VMProcessor.psm1

@@ -8,7 +8,7 @@ $script:localizedData = Get-LocalizedData -DefaultUICulture 'en-US'
 
 <#
 .SYNOPSIS
-    Gets MSFT_xVMProcessor resource current state.
+    Gets DSC_VMProcessor resource current state.
 
 .PARAMETER VMName
     Specifies the name of the virtual machine on which the processor is to be configured.
@@ -47,7 +47,7 @@ function Get-TargetResource
 
 <#
 .SYNOPSIS
-    Tests if MSFT_xVMProcessor resource state is in the desired state or not.
+    Tests if DSC_VMProcessor resource state is in the desired state or not.
 
 .PARAMETER VMName
     Specifies the name of the virtual machine on which the processor is to be configured.
@@ -195,7 +195,7 @@ function Test-TargetResource
 
 <#
 .SYNOPSIS
-    Configures MSFT_xVMProcessor resource state.
+    Configures DSC_VMProcessor resource state.
 
 .PARAMETER VMName
     Specifies the name of the virtual machine on which the processor is to be configured.

source/DSCResources/MSFT_xVMProcessor/MSFT_xVMProcessor.schema.mof → source/DSCResources/DSC_VMProcessor/DSC_VMProcessor.schema.mof

@@ -1,5 +1,5 @@
-[ClassVersion("1.0.0.0"), FriendlyName("xVMProcessor")]
-class MSFT_xVMProcessor : OMI_BaseResource
+[ClassVersion("1.0.0.0"), FriendlyName("VMProcessor")]
+class DSC_VMProcessor : OMI_BaseResource
 {
     [Key, Description("Specifies the name of the virtual machine on which the processor is to be configured.")] String VMName;
     [Write, Description("Specifies whether to enable host resource protection.")] Boolean EnableHostResourceProtection;

source/DSCResources/MSFT_xVMScsiController/MSFT_xVMScsiController.schema.mof → source/DSCResources/DSC_VMScsiController/DSC_VMScsiController.schema.mof

@@ -1,5 +1,5 @@
-[ClassVersion("1.0.0"), FriendlyName("xVMScsiController")]
-class MSFT_xVMScsiController : OMI_BaseResource
+[ClassVersion("1.0.0"), FriendlyName("VMScsiController")]
+class DSC_VMScsiController : OMI_BaseResource
 {
     [Key, Description("Specifies the name of the virtual machine whose SCSI controller status is to be controlled")] String VMName;
     [Key, Description("Specifies the number of the SCSI controller whose status is to be controlled. If not specified, it defaults to 0."), ValueMap{"0","1","2","3"}, Values{"0","1","2","3"}] Uint32 ControllerNumber;

source/DSCResources/MSFT_xVMSwitch/MSFT_xVMSwitch.psm1 → source/DSCResources/DSC_VMSwitch/DSC_VMSwitch.psm1

@@ -8,7 +8,7 @@ $script:localizedData = Get-LocalizedData -DefaultUICulture 'en-US'
 
 <#
 .SYNOPSIS
-    Gets MSFT_xVMSwitch resource current state.
+    Gets DSC_VMSwitch resource current state.
 
 .PARAMETER Name
     Name of the VM Switch.
@@ -101,7 +101,7 @@ function Get-TargetResource
 
 <#
 .SYNOPSIS
-    Configures MSFT_xVMSwitch resource state.
+    Configures DSC_VMSwitch resource state.
 
 .PARAMETER Name
     Name of the VM Switch.
@@ -381,7 +381,7 @@ function Set-TargetResource
 
 <#
 .SYNOPSIS
-    Tests if MSFT_xVMSwitch resource state is in the desired state or not.
+    Tests if DSC_VMSwitch resource state is in the desired state or not.
 
 .PARAMETER Name
     Name of the VM Switch.

source/DSCResources/MSFT_xVMSwitch/MSFT_xVMSwitch.schema.mof → source/DSCResources/DSC_VMSwitch/DSC_VMSwitch.schema.mof

@@ -1,5 +1,5 @@
-[ClassVersion("1.0.0.0"), FriendlyName("xVMSwitch")]
-class MSFT_xVMSwitch : OMI_BaseResource
+[ClassVersion("1.0.0.0"), FriendlyName("VMSwitch")]
+class DSC_VMSwitch : OMI_BaseResource
 {
     [Key, Description("Name of the VM Switch")] String Name;
     [Key, Description("Type of switch"), ValueMap{"External","Internal","Private"}, Values{"External","Internal","Private"}] String Type;