Merge pull request #76 from PlagueHO/Issue-74

Refactored to remove harness structure - Fixes #74
dsccommunity · Sep 4, 2018 · cb2ea83 · cb2ea83
2 parents 02ff46e + e1dc262
commit cb2ea83
Show file tree

Hide file tree

Showing 74 changed files with 650 additions and 363 deletions.
diff --git a/.vscode/RunAllTests.ps1 b/.vscode/RunAllTests.ps1
diff --git a/.vscode/analyzersettings.psd1 b/.vscode/analyzersettings.psd1
@@ -0,0 +1,53 @@
+@{
+    <#
+        For the custom rules to work, the DscResource.Tests repo must be
+        cloned. It is automatically clone as soon as any unit or
+        integration tests are run.
+    #>
+    CustomRulePath = '.\DSCResource.Tests\DscResource.AnalyzerRules'
+
+    IncludeRules   = @(
+        # DSC Resource Kit style guideline rules.
+        'PSAvoidDefaultValueForMandatoryParameter',
+        'PSAvoidDefaultValueSwitchParameter',
+        'PSAvoidInvokingEmptyMembers',
+        'PSAvoidNullOrEmptyHelpMessageAttribute',
+        'PSAvoidUsingCmdletAliases',
+        'PSAvoidUsingComputerNameHardcoded',
+        'PSAvoidUsingDeprecatedManifestFields',
+        'PSAvoidUsingEmptyCatchBlock',
+        'PSAvoidUsingInvokeExpression',
+        'PSAvoidUsingPositionalParameters',
+        'PSAvoidShouldContinueWithoutForce',
+        'PSAvoidUsingWMICmdlet',
+        'PSAvoidUsingWriteHost',
+        'PSDSCReturnCorrectTypesForDSCFunctions',
+        'PSDSCStandardDSCFunctionsInResource',
+        'PSDSCUseIdenticalMandatoryParametersForDSC',
+        'PSDSCUseIdenticalParametersForDSC',
+        'PSMisleadingBacktick',
+        'PSMissingModuleManifestField',
+        'PSPossibleIncorrectComparisonWithNull',
+        'PSProvideCommentHelp',
+        'PSReservedCmdletChar',
+        'PSReservedParams',
+        'PSUseApprovedVerbs',
+        'PSUseCmdletCorrectly',
+        'PSUseOutputTypeCorrectly',
+        'PSAvoidGlobalVars',
+        'PSAvoidUsingConvertToSecureStringWithPlainText',
+        'PSAvoidUsingPlainTextForPassword',
+        'PSAvoidUsingUsernameAndPasswordParams',
+        'PSDSCUseVerboseMessageInDSCResource',
+        'PSShouldProcess',
+        'PSUseDeclaredVarsMoreThanAssignments',
+        'PSUsePSCredentialType',
+
+        <#
+            This is to test all the DSC Resource Kit custom rules.
+            The name of the function-blocks of each custom rule start
+            with 'Measure*'.
+        #>
+        'Measure-*'
+    )
+}
diff --git a/.vscode/launch.json b/.vscode/launch.json
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -10,5 +10,6 @@
     "powershell.codeFormatting.ignoreOneLineBlock": false,
     "powershell.codeFormatting.preset": "Custom",
     "files.trimTrailingWhitespace": true,
-    "files.insertFinalNewline": true
+    "files.insertFinalNewline": true,
+    "powershell.scriptAnalysis.settingsPath": ".vscode\\analyzersettings.psd1"
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,13 @@
 
 ## Unreleased
 
+- Refactored module folder structure to move resource to root folder of
+  repository and remove test harness - fixes [Issue #74](https://github.com/PowerShell/DfsDsc/issues/74).
+- Updated Examples to support deployment to PowerShell Gallery scripts.
+- Remove exclusion of all tags in appveyor.yml, so all common tests can be run
+  if opt-in.
+- Added .VSCode settings for applying DSC PSSA rules - fixes [Issue #75](https://github.com/PowerShell/DfsDsc/issues/75).
+
 ## 4.1.0.0
 
 - Added Hub and Spoke replication group example - fixes [Issue #62](https://github.com/PowerShell/DFSDsc/issues/62).

diff --git a/Modules/DFSDsc/DFSDsc.psd1 → DFSDsc.psd1 b/Modules/DFSDsc/DFSDsc.psd1 → DFSDsc.psd1
diff --git a/...espaceFolder/MSFT_DFSNamespaceFolder.psm1 → ...espaceFolder/MSFT_DFSNamespaceFolder.psm1 b/...espaceFolder/MSFT_DFSNamespaceFolder.psm1 → ...espaceFolder/MSFT_DFSNamespaceFolder.psm1
diff --git a/...Folder/MSFT_DFSNamespaceFolder.schema.mof → ...Folder/MSFT_DFSNamespaceFolder.schema.mof b/...Folder/MSFT_DFSNamespaceFolder.schema.mof → ...Folder/MSFT_DFSNamespaceFolder.schema.mof
diff --git a/...sources/MSFT_DFSNamespaceFolder/README.md → ...sources/MSFT_DFSNamespaceFolder/README.md b/...sources/MSFT_DFSNamespaceFolder/README.md → ...sources/MSFT_DFSNamespaceFolder/README.md
diff --git a/...n-us/MSFT_DFSNamespaceFolder.strings.psd1 → ...n-us/MSFT_DFSNamespaceFolder.strings.psd1 b/...n-us/MSFT_DFSNamespaceFolder.strings.psd1 → ...n-us/MSFT_DFSNamespaceFolder.strings.psd1
diff --git a/...SNamespaceRoot/MSFT_DFSNamespaceRoot.psm1 → ...SNamespaceRoot/MSFT_DFSNamespaceRoot.psm1 b/...SNamespaceRoot/MSFT_DFSNamespaceRoot.psm1 → ...SNamespaceRoot/MSFT_DFSNamespaceRoot.psm1
diff --git a/...paceRoot/MSFT_DFSNamespaceRoot.schema.mof → ...paceRoot/MSFT_DFSNamespaceRoot.schema.mof b/...paceRoot/MSFT_DFSNamespaceRoot.schema.mof → ...paceRoot/MSFT_DFSNamespaceRoot.schema.mof
diff --git a/...Resources/MSFT_DFSNamespaceRoot/README.md → DSCResources/MSFT_DFSNamespaceRoot/README.md b/...Resources/MSFT_DFSNamespaceRoot/README.md → DSCResources/MSFT_DFSNamespaceRoot/README.md
diff --git a/.../en-us/MSFT_DFSNamespaceRoot.strings.psd1 → .../en-us/MSFT_DFSNamespaceRoot.strings.psd1 b/.../en-us/MSFT_DFSNamespaceRoot.strings.psd1 → .../en-us/MSFT_DFSNamespaceRoot.strings.psd1
diff --git a/...MSFT_DFSNamespaceServerConfiguration.psm1 → ...MSFT_DFSNamespaceServerConfiguration.psm1 b/...MSFT_DFSNamespaceServerConfiguration.psm1 → ...MSFT_DFSNamespaceServerConfiguration.psm1
diff --git a/...FSNamespaceServerConfiguration.schema.mof → ...FSNamespaceServerConfiguration.schema.mof b/...FSNamespaceServerConfiguration.schema.mof → ...FSNamespaceServerConfiguration.schema.mof
diff --git a/...DFSNamespaceServerConfiguration/README.md → ...DFSNamespaceServerConfiguration/README.md b/...DFSNamespaceServerConfiguration/README.md → ...DFSNamespaceServerConfiguration/README.md
diff --git a/...NamespaceServerConfiguration.strings.psd1 → ...NamespaceServerConfiguration.strings.psd1 b/...NamespaceServerConfiguration.strings.psd1 → ...NamespaceServerConfiguration.strings.psd1
diff --git a/...cationGroup/MSFT_DFSReplicationGroup.psm1 → ...cationGroup/MSFT_DFSReplicationGroup.psm1 b/...cationGroup/MSFT_DFSReplicationGroup.psm1 → ...cationGroup/MSFT_DFSReplicationGroup.psm1
diff --git a/...Group/MSFT_DFSReplicationGroup.schema.mof → ...Group/MSFT_DFSReplicationGroup.schema.mof b/...Group/MSFT_DFSReplicationGroup.schema.mof → ...Group/MSFT_DFSReplicationGroup.schema.mof
diff --git a/...ources/MSFT_DFSReplicationGroup/README.md → ...ources/MSFT_DFSReplicationGroup/README.md b/...ources/MSFT_DFSReplicationGroup/README.md → ...ources/MSFT_DFSReplicationGroup/README.md
diff --git a/...-us/MSFT_DFSReplicationGroup.strings.psd1 → ...-us/MSFT_DFSReplicationGroup.strings.psd1 b/...-us/MSFT_DFSReplicationGroup.strings.psd1 → ...-us/MSFT_DFSReplicationGroup.strings.psd1
diff --git a/...n/MSFT_DFSReplicationGroupConnection.psm1 → ...n/MSFT_DFSReplicationGroupConnection.psm1 b/...n/MSFT_DFSReplicationGroupConnection.psm1 → ...n/MSFT_DFSReplicationGroupConnection.psm1
diff --git a/..._DFSReplicationGroupConnection.schema.mof → ..._DFSReplicationGroupConnection.schema.mof b/..._DFSReplicationGroupConnection.schema.mof → ..._DFSReplicationGroupConnection.schema.mof
diff --git a/...T_DFSReplicationGroupConnection/README.md → ...T_DFSReplicationGroupConnection/README.md b/...T_DFSReplicationGroupConnection/README.md → ...T_DFSReplicationGroupConnection/README.md
diff --git a/...FSReplicationGroupConnection.strings.psd1 → ...FSReplicationGroupConnection.strings.psd1 b/...FSReplicationGroupConnection.strings.psd1 → ...FSReplicationGroupConnection.strings.psd1
diff --git a/...older/MSFT_DFSReplicationGroupFolder.psm1 → ...older/MSFT_DFSReplicationGroupFolder.psm1 b/...older/MSFT_DFSReplicationGroupFolder.psm1 → ...older/MSFT_DFSReplicationGroupFolder.psm1
diff --git a/...MSFT_DFSReplicationGroupFolder.schema.mof → ...MSFT_DFSReplicationGroupFolder.schema.mof b/...MSFT_DFSReplicationGroupFolder.schema.mof → ...MSFT_DFSReplicationGroupFolder.schema.mof
diff --git a/.../MSFT_DFSReplicationGroupFolder/README.md → .../MSFT_DFSReplicationGroupFolder/README.md b/.../MSFT_DFSReplicationGroupFolder/README.md → .../MSFT_DFSReplicationGroupFolder/README.md
diff --git a/...FT_DFSReplicationGroupFolder.strings.psd1 → ...FT_DFSReplicationGroupFolder.strings.psd1 b/...FT_DFSReplicationGroupFolder.strings.psd1 → ...FT_DFSReplicationGroupFolder.strings.psd1
diff --git a/...p/MSFT_DFSReplicationGroupMembership.psm1 → ...p/MSFT_DFSReplicationGroupMembership.psm1 b/...p/MSFT_DFSReplicationGroupMembership.psm1 → ...p/MSFT_DFSReplicationGroupMembership.psm1
diff --git a/..._DFSReplicationGroupMembership.schema.mof → ..._DFSReplicationGroupMembership.schema.mof b/..._DFSReplicationGroupMembership.schema.mof → ..._DFSReplicationGroupMembership.schema.mof
diff --git a/...T_DFSReplicationGroupMembership/README.md → ...T_DFSReplicationGroupMembership/README.md b/...T_DFSReplicationGroupMembership/README.md → ...T_DFSReplicationGroupMembership/README.md
diff --git a/...FSReplicationGroupMembership.strings.psd1 → ...FSReplicationGroupMembership.strings.psd1 b/...FSReplicationGroupMembership.strings.psd1 → ...FSReplicationGroupMembership.strings.psd1
diff --git a/...mespaceFolder/1_Domain_MultipleTarget.ps1 → ...ceFolder_Domain_MultipleTarget_Config.ps1 b/...mespaceFolder/1_Domain_MultipleTarget.ps1 → ...ceFolder_Domain_MultipleTarget_Config.ps1
@@ -1,25 +1,40 @@
+<#PSScriptInfo
+.VERSION 1.0.0
+.GUID c99703be-abb1-424a-a856-b69af295ccfe
+.AUTHOR Microsoft Corporation
+.COMPANYNAME Microsoft Corporation
+.COPYRIGHT
+.TAGS DSCConfiguration
+.LICENSEURI https://github.com/PowerShell/DfsDsc/blob/master/LICENSE
+.PROJECTURI https://github.com/PowerShell/DfsDsc
+.ICONURI
+.EXTERNALMODULEDEPENDENCIES
+.REQUIREDSCRIPTS
+.EXTERNALSCRIPTDEPENDENCIES
+.RELEASENOTES First version.
+.PRIVATEDATA 2016-Datacenter,2016-Datacenter-Server-Core
+#>
+
+#Requires -module DfsDsc
+
 <#
-    .EXAMPLE
-    Create an AD Domain V2 based DFS namespace called software in the domain contoso.com with
-    a three targets on the servers ca-fileserver, ma-fileserver and ny-fileserver. It also
-    creates a IT folder in each namespace.
+    .DESCRIPTION
+        Create an AD Domain V2 based DFS namespace called software in the domain contoso.com with
+        a three targets on the servers ca-fileserver, ma-fileserver and ny-fileserver. It also
+        creates a IT folder in each namespace.
 #>
-Configuration Example
+Configuration DFSNamespaceFolder_Domain_MultipleTarget_Config
 {
     param
     (
-        [Parameter()]
-        [System.String[]]
-        $NodeName = 'localhost',
-
         [Parameter()]
         [PSCredential]
         $Credential
     )
 
     Import-DscResource -ModuleName 'DFSDsc'
 
-    Node $NodeName
+    Node localhost
     {
         <#
             Install the Prerequisite features first

diff --git a/...NamespaceFolder/2_Domain_SingleTarget.ps1 → ...paceFolder_Domain_SingleTarget_Config.ps1 b/...NamespaceFolder/2_Domain_SingleTarget.ps1 → ...paceFolder_Domain_SingleTarget_Config.ps1
@@ -1,25 +1,40 @@
+<#PSScriptInfo
+.VERSION 1.0.0
+.GUID 9f8adea6-6aed-42e8-a87a-10ba1d93e732
+.AUTHOR Microsoft Corporation
+.COMPANYNAME Microsoft Corporation
+.COPYRIGHT
+.TAGS DSCConfiguration
+.LICENSEURI https://github.com/PowerShell/DfsDsc/blob/master/LICENSE
+.PROJECTURI https://github.com/PowerShell/DfsDsc
+.ICONURI
+.EXTERNALMODULEDEPENDENCIES
+.REQUIREDSCRIPTS
+.EXTERNALSCRIPTDEPENDENCIES
+.RELEASENOTES First version.
+.PRIVATEDATA 2016-Datacenter,2016-Datacenter-Server-Core
+#>
+
+#Requires -module DfsDsc
+
 <#
-    .EXAMPLE
-    Create an AD Domain V2 based DFS namespace called departments in the domain contoso.com
-    with a single root target on the computer fs_1. Two sub-folders are defined under the
-    departments folder with targets that direct to shares on servers fs_3 and fs_8.
+    .DESCRIPTION
+        Create an AD Domain V2 based DFS namespace called departments in the domain contoso.com
+        with a single root target on the computer fs_1. Two sub-folders are defined under the
+        departments folder with targets that direct to shares on servers fs_3 and fs_8.
 #>
-Configuration Example
+Configuration DFSNamespaceFolder_Domain_SingleTarget_Config
 {
     param
     (
-        [Parameter()]
-        [System.String[]]
-        $NodeName = 'localhost',
-
         [Parameter()]
         [PSCredential]
         $Credential
     )
 
     Import-DscResource -ModuleName 'DFSDsc'
 
-    Node $NodeName
+    Node localhost
     {
         <#
             Install the Prerequisite features first

diff --git a/...ServerConfiguration/1_Standalone_FQDN.ps1 → ...amespaceFolder_Standalone_FQDN_Config.ps1 b/...ServerConfiguration/1_Standalone_FQDN.ps1 → ...amespaceFolder_Standalone_FQDN_Config.ps1
@@ -1,25 +1,40 @@
+<#PSScriptInfo
+.VERSION 1.0.0
+.GUID 3a26d1aa-17d0-40e7-8900-e9bf21662b46
+.AUTHOR Microsoft Corporation
+.COMPANYNAME Microsoft Corporation
+.COPYRIGHT
+.TAGS DSCConfiguration
+.LICENSEURI https://github.com/PowerShell/DfsDsc/blob/master/LICENSE
+.PROJECTURI https://github.com/PowerShell/DfsDsc
+.ICONURI
+.EXTERNALMODULEDEPENDENCIES
+.REQUIREDSCRIPTS
+.EXTERNALSCRIPTDEPENDENCIES
+.RELEASENOTES First version.
+.PRIVATEDATA 2016-Datacenter,2016-Datacenter-Server-Core
+#>
+
+#Requires -module DfsDsc
+
 <#
-    .EXAMPLE
-    Create a standalone DFS namespace using FQDN called public on the server
-    fileserver1.contoso.com. A namespace folder called brochures is also created in this
-    namespace that targets the \\fileserver2.contoso.com\brochures share.
+    .DESCRIPTION
+        Create a standalone DFS namespace using FQDN called public on the server
+        fileserver1.contoso.com. A sub-folder called brochures is also created in
+        this namespace that targets the \\fileserver2.contoso.com\brochures share.
 #>
-Configuration Example
+Configuration DFSNamespaceFolder_Standalone_FQDN_Config
 {
     param
     (
-        [Parameter()]
-        [System.String[]]
-        $NodeName = 'localhost',
-
         [Parameter()]
         [PSCredential]
         $Credential
     )
 
     Import-DscResource -ModuleName 'DFSDsc'
 
-    Node $NodeName
+    Node localhost
     {
         <#
             Install the Prerequisite features first

diff --git a/...sources/DFSNamespaceRoot/4_Standalone.ps1 → ...-DFSNamespaceFolder_Standalone_Config.ps1 b/...sources/DFSNamespaceRoot/4_Standalone.ps1 → ...-DFSNamespaceFolder_Standalone_Config.ps1
@@ -1,25 +1,40 @@
+<#PSScriptInfo
+.VERSION 1.0.0
+.GUID 7bacca7a-9602-4af1-98d5-ba35d4af1290
+.AUTHOR Microsoft Corporation
+.COMPANYNAME Microsoft Corporation
+.COPYRIGHT
+.TAGS DSCConfiguration
+.LICENSEURI https://github.com/PowerShell/DfsDsc/blob/master/LICENSE
+.PROJECTURI https://github.com/PowerShell/DfsDsc
+.ICONURI
+.EXTERNALMODULEDEPENDENCIES
+.REQUIREDSCRIPTS
+.EXTERNALSCRIPTDEPENDENCIES
+.RELEASENOTES First version.
+.PRIVATEDATA 2016-Datacenter,2016-Datacenter-Server-Core
+#>
+
+#Requires -module DfsDsc
+
 <#
-    .EXAMPLE
-    Create a standalone DFS namespace called public on the server fileserver1. A namespace
-    folder called brochures is also created in this namespace that targets the
-    \\fileserver2\brochures share.
+    .DESCRIPTION
+        Create a standalone DFS namespace called public on the server fileserver1. A namespace
+        folder called brochures is also created in this namespace that targets the
+        \\fileserver2\brochures share.
 #>
-Configuration Example
+Configuration DFSNamespaceFolder_Standalone_Config
 {
     param
     (
-        [Parameter()]
-        [System.String[]]
-        $NodeName = 'localhost',
-
         [Parameter()]
         [PSCredential]
         $Credential
     )
 
     Import-DscResource -ModuleName 'DFSDsc'
 
-    Node $NodeName
+    Node localhost
     {
         <#
             Install the Prerequisite features first

diff --git a/...NamespaceRoot/1_Domain_MultipleTarget.ps1 → ...paceRoot_Domain_MultipleTarget_Config.ps1 b/...NamespaceRoot/1_Domain_MultipleTarget.ps1 → ...paceRoot_Domain_MultipleTarget_Config.ps1
@@ -1,25 +1,40 @@
+<#PSScriptInfo
+.VERSION 1.0.0
+.GUID f79dac3a-89dd-4a46-95cf-02be7f029cd5
+.AUTHOR Microsoft Corporation
+.COMPANYNAME Microsoft Corporation
+.COPYRIGHT
+.TAGS DSCConfiguration
+.LICENSEURI https://github.com/PowerShell/DfsDsc/blob/master/LICENSE
+.PROJECTURI https://github.com/PowerShell/DfsDsc
+.ICONURI
+.EXTERNALMODULEDEPENDENCIES
+.REQUIREDSCRIPTS
+.EXTERNALSCRIPTDEPENDENCIES
+.RELEASENOTES First version.
+.PRIVATEDATA 2016-Datacenter,2016-Datacenter-Server-Core
+#>
+
+#Requires -module DfsDsc
+
 <#
-    .EXAMPLE
-    Create an AD Domain V2 based DFS namespace called software in the domain contoso.com with
-    a three targets on the servers ca-fileserver, ma-fileserver and ny-fileserver. It also
-    creates a IT folder in each namespace.
+    .DESCRIPTION
+        Create an AD Domain V2 based DFS namespace called software in the domain contoso.com with
+        a three targets on the servers ca-fileserver, ma-fileserver and ny-fileserver. It also
+        creates a IT folder in each namespace.
 #>
-Configuration Example
+Configuration DFSNamespaceRoot_Domain_MultipleTarget_Config
 {
     param
     (
-        [Parameter()]
-        [System.String[]]
-        $NodeName = 'localhost',
-
         [Parameter()]
         [PSCredential]
         $Credential
     )
 
     Import-DscResource -ModuleName 'DFSDsc'
 
-    Node $NodeName
+    Node localhost
     {
         <#
             Install the Prerequisite features first