ActiveDirectoryDsc: Split tests in different AppVeyor jobs

CHANGELOG.md

@@ -6,7 +6,15 @@
   - New resource ADDomainControllerProperties ([issue #301](https://github.com/PowerShell/ActiveDirectoryDsc/issues/301)).
   - New resource ADForestFunctionalLevel ([issue #200](https://github.com/PowerShell/ActiveDirectoryDsc/issues/200)).
   - New resource ADDomainFunctionalLevel ([issue #200](https://github.com/PowerShell/ActiveDirectoryDsc/issues/200)).
-- Changes to xWaitforADDomain
+  - Split the meta tests and the unit and integration tests in different
+    AppVeyor jobs ([issue #437](https://github.com/PowerShell/ActiveDirectoryDsc/issues/437)).
+  - Fixed all stub cmdlets and unit tests so the unit test can be run locally
+    without having the ActiveDirectory module installed on the computer.
+    This will also be reflected in the AppVeyor build worker where there
+    will no longer be an ActiveDirectory module installed. This is
+    to make sure that if the unit tests work locally they should also work
+    in the CI pipeline.
+- Changes to xWaitForADDomain
   - Correct Grammar Issues in Example Descriptions.
 
 ## 4.0.0.0

DSCResources/MSFT_ADDomainDefaultPasswordPolicy/MSFT_ADDomainDefaultPasswordPolicy.psm1

@@ -75,6 +75,7 @@ function Get-TargetResource
         [System.Management.Automation.CredentialAttribute()]
         $Credential
     )
+
     Assert-Module -ModuleName 'ActiveDirectory'
 
     $PSBoundParameters['Identity'] = $DomainName

DSCResources/MSFT_ADDomainFunctionalLevel/en-US/about_ADDomainFunctionalLevel.help.txt

@@ -2,7 +2,7 @@
     ADDomainFunctionalLevel
 
 .DESCRIPTION
-    This resource change the forest functional level. Functional levels can
+    This resource change the domain functional level. Functional levels can
     be read more about in the article [Forest and Domain Functional Levels](https://docs.microsoft.com/sv-se/windows-server/identity/ad-ds/active-directory-functional-levels).
 
     **WARNING: This action might be irreversibel!** Make sure to understand
@@ -15,6 +15,8 @@
     ## Requirements
 
     * Target machine must be running Windows Server 2008 R2 or later.
+    * Target machine must be running the minimum required operating system
+      version for the domain functional level to set.
 
 .PARAMETER DomainIdentity
     Key - String
@@ -30,13 +32,13 @@
 This configuration will change the domain functional level to
 a Windows Server 2012 R2 Domain.
 
-Configuration ADDomainControllerProperties_SetContentFreshness_Config
+Configuration ADDomainFunctionalLevel_SetLevel_Config
 {
     Import-DscResource -ModuleName ActiveDirectoryDsc
 
     node localhost
     {
-        ADDomainControllerProperties 'ChangeForestFunctionalLevel'
+        ADDomainFunctionalLevel 'ChangeDomainFunctionalLevel'
         {
             DomainIdentity          = 'contoso.com'
             DomainMode              = 'Windows2012R2Domain'

DSCResources/MSFT_ADForestFunctionalLevel/en-US/about_ADForestFunctionalLevel.help.txt

@@ -15,6 +15,8 @@
     ## Requirements
 
     * Target machine must be running Windows Server 2008 R2 or later.
+    * Target machine must be running the minimum required operating system
+      version for the forest functional level to set.
 
 .PARAMETER ForestIdentity
     Key - String
@@ -23,20 +25,20 @@
 .PARAMETER ForestMode
     Required - String
     Allowed values: Windows2008R2Forest,  Windows2012Forest,  Windows2012R2Forest,  Windows2016Forest
-    Specifies the the functional level for the Active Directory forest..
+    Specifies the the functional level for the Active Directory forest.
 
 .EXAMPLE 1
 
 This configuration will change the forest functional level to
 a Windows Server 2012 R2 Forest.
 
-Configuration ADDomainControllerProperties_SetContentFreshness_Config
+Configuration ADForestFunctionalLevel_SetLevel_Config
 {
     Import-DscResource -ModuleName ActiveDirectoryDsc
 
     node localhost
     {
-        ADDomainControllerProperties 'ChangeForestFunctionalLevel'
+        ADForestFunctionalLevel 'ChangeForestFunctionalLevel'
         {
             ForestIdentity          = 'contoso.com'
             ForestMode              = 'Windows2012R2Forest'

DSCResources/MSFT_ADGroup/MSFT_ADGroup.psm1

@@ -152,7 +152,16 @@ function Get-TargetResource
 
     try
     {
-        $adGroup = Get-ADGroup @adGroupParams -Property Name, GroupScope, GroupCategory, DistinguishedName, Description, DisplayName, ManagedBy, Info
+        $adGroup = Get-ADGroup @adGroupParams -Properties @(
+            'Name',
+            'GroupScope',
+            'GroupCategory',
+            'DistinguishedName',
+            'Description',
+            'DisplayName',
+            'ManagedBy',
+            'Info'
+        )
 
         Write-Verbose -Message ($script:localizedData.RetrievingGroupMembers -f $MembershipAttribute)
 
@@ -595,7 +604,16 @@ function Set-TargetResource
             }
         }
 
-        $adGroup = Get-ADGroup @adGroupParams -Property Name, GroupScope, GroupCategory, DistinguishedName, Description, DisplayName, ManagedBy, Info
+        $adGroup = Get-ADGroup @adGroupParams -Properties @(
+            'Name',
+            'GroupScope',
+            'GroupCategory',
+            'DistinguishedName',
+            'Description',
+            'DisplayName',
+            'ManagedBy',
+            'Info'
+        )
 
         if ($Ensure -eq 'Present')
         {

DSCResources/MSFT_ADManagedServiceAccount/MSFT_ADManagedServiceAccount.psm1

@@ -87,7 +87,7 @@ function Get-TargetResource
     {
         Write-Verbose -Message ($script:localizedData.RetrievingServiceAccount -f $ServiceAccountName)
 
-        $adServiceAccount = Get-ADServiceAccount @adServiceAccountParameters -Property @(
+        $adServiceAccount = Get-ADServiceAccount @adServiceAccountParameters -Properties @(
             'Name'
             'DistinguishedName'
             'Description'
@@ -117,7 +117,7 @@ function Get-TargetResource
             Write-Verbose -Message ($script:localizedData.RetrievingPrincipalMembers -f $MembershipAttribute)
             $adServiceAccount.PrincipalsAllowedToRetrieveManagedPassword |
                 ForEach-Object {
-                    $member = (Get-ADObject -Identity $_ -Property $MembershipAttribute).$MembershipAttribute
+                    $member = (Get-ADObject -Identity $_ -Properties $MembershipAttribute).$MembershipAttribute
                     $targetResource['Members'] += $member
                 }
 

DSCResources/MSFT_WaitForADDomain/en-US/about_WaitForADDomain.help.txt

@@ -45,7 +45,7 @@
 
 This configuration will wait for an Active Directory domain controller
 to respond within 300 seconds (default) in the domain 'contoso.com'
-before returning and allowing the configuration to continue run.
+before returning and allowing the configuration to continue to run.
 If the timeout is reached an error will be thrown.
 This will use the current user when determining if the domain is available,
 if run though LCM this will use SYSTEM (which might not have access).
@@ -67,9 +67,9 @@ Configuration WaitForADDomain_WaitForDomainController_Config
 
 This configuration will wait for an Active Directory domain controller
 to respond within 300 seconds (default) in the domain 'contoso.com'
-before returning and allowing the configuration to continue run.
+before returning and allowing the configuration to continue to run.
 If the timeout is reached an error will be thrown.
-This will use the user credential passes to the built-in PsDscRunAsCredential
+This will use the user credential passed in the built-in PsDscRunAsCredential
 parameter when determining if the domain is available.
 
 Configuration WaitForADDomain_WaitForDomainControllerUsingBuiltInCredential_Config
@@ -99,9 +99,9 @@ Configuration WaitForADDomain_WaitForDomainControllerUsingBuiltInCredential_Conf
 
 This configuration will wait for an Active Directory domain controller
 to respond within 300 seconds (default) in the domain 'contoso.com'
-before returning and allowing the configuration to continue run.
+before returning and allowing the configuration to continue to run.
 If the timeout is reached an error will be thrown.
-This will use the user credential passes to the parameter Credential
+This will use the user credential passed in the parameter Credential
 when determining if the domain is available.
 
 Configuration WaitForADDomain_WaitForDomainControllerUsingCredential_Config
@@ -131,9 +131,9 @@ Configuration WaitForADDomain_WaitForDomainControllerUsingCredential_Config
 This configuration will wait for an Active Directory domain controller
 in the site 'Europe' to respond within 300 seconds (default) in the
 domain 'contoso.com' before returning and allowing the configuration to
-continue run.
+continue to run.
 If the timeout is reached an error will be thrown.
-This will use the user credential passes to the built-in PsDscRunAsCredential
+This will use the user credential passed in the built-in PsDscRunAsCredential
 parameter when determining if the domain is available.
 
 Configuration WaitForADDomain_WaitForDomainControllerInSite_Config
@@ -164,11 +164,11 @@ Configuration WaitForADDomain_WaitForDomainControllerInSite_Config
 
 This configuration will wait for an Active Directory domain controller
 to respond within 300 seconds (default) in the domain 'contoso.com'
-before returning and allowing the configuration to continue run.
+before returning and allowing the configuration to continue to run.
 If the timeout is reached the node will be restarted up to two times
-and again wait after each restart. If the no domain controller is found
+and again wait after each restart. If no domain controller is found
 after the second restart an error will be thrown.
-This will use the user credential passes to the built-in PsDscRunAsCredential
+This will use the user credential passed in the built-in PsDscRunAsCredential
 parameter when determining if the domain is available.
 
 Configuration WaitForADDomain_WaitForDomainControllerWithReboot_Config
@@ -187,9 +187,9 @@ Configuration WaitForADDomain_WaitForDomainControllerWithReboot_Config
     {
         WaitForADDomain 'contoso.com'
         {
-            DomainName = 'contoso.com'
+            DomainName   = 'contoso.com'
             RestartCount = 2
-
+            
             PsDscRunAsCredential = $Credential
         }
     }
@@ -199,9 +199,9 @@ Configuration WaitForADDomain_WaitForDomainControllerWithReboot_Config
 
 This configuration will wait for an Active Directory domain controller
 to respond within 600 seconds in the domain 'contoso.com' before
-returning and allowing the configuration to continue run. If the timeout
+returning and allowing the configuration to continue to run. If the timeout
 is reached an error will be thrown.
-This will use the user credential passes to the built-in PsDscRunAsCredential
+This will use the user credential passed in the built-in PsDscRunAsCredential
 parameter when determining if the domain is available.
 
 Configuration WaitForADDomain_WaitForDomainControllerWithLongerDelay_Config
@@ -220,7 +220,7 @@ Configuration WaitForADDomain_WaitForDomainControllerWithLongerDelay_Config
     {
         WaitForADDomain 'contoso.com'
         {
-            DomainName = 'contoso.com'
+            DomainName  = 'contoso.com'
             WaitTimeout = 600
 
             PsDscRunAsCredential = $Credential

Tests/TestHelpers/ActiveDirectoryDsc.TestHelper.psm1

@@ -0,0 +1,91 @@
+<#
+    .SYNOPSIS
+        Returns $true if the the environment variable APPVEYOR is set to $true,
+        and the environment variable CONFIGURATION is set to the value passed
+        in the parameter Type.
+
+    .PARAMETER Name
+        Name of the test script that is called. Defaults to the name of the
+        calling script.
+
+    .PARAMETER Type
+        Type of tests in the test file. Can be set to Unit or Integration.
+
+    .PARAMETER Category
+        Optional. One or more categories to check if they are set in
+        $env:CONFIGURATION. If this are not set, the parameter Type
+        is used as category.
+#>
+function Test-RunForCITestCategory
+{
+    [OutputType([System.Boolean])]
+    [CmdletBinding()]
+    param
+    (
+        [Parameter()]
+        [ValidateNotNullOrEmpty()]
+        [System.String]
+        $Name = $MyInvocation.PSCommandPath.Split('\')[-1],
+
+        [Parameter(Mandatory = $true)]
+        [ValidateSet('Unit', 'Integration')]
+        [System.String]
+        $Type,
+
+        [Parameter()]
+        [System.String[]]
+        $Category
+    )
+
+    # Support the use of having the Type parameter as the only category names.
+    if (-not $Category)
+    {
+        $Category = @($Type)
+    }
+
+    $result = $true
+
+    if ($Type -eq 'Integration' -and -not $env:CI -eq $true)
+    {
+        Write-Warning -Message ('{0} test for {1} will be skipped unless $env:CI is set to $true' -f $Type, $Name)
+        $result = $false
+    }
+
+    if (-not (Test-ContinuousIntegrationTaskCategory -Category $Category))
+    {
+        Write-Verbose -Message ('Tests in category ''{0}'' will be skipped unless $env:CONFIGURATION is set to ''{0}''.' -f ($Category -join ''', or '''), $Name) -Verbose
+        $result = $false
+    }
+
+    return $result
+}
+
+<#
+    .SYNOPSIS
+        Returns $true if the the environment variable CI is set to $true,
+        and the environment variable CONFIGURATION is set to the value passed
+        in the parameter Type.
+
+    .PARAMETER Category
+        One or more categories to check if they are set in $env:CONFIGURATION.
+#>
+function Test-ContinuousIntegrationTaskCategory
+{
+    [OutputType([System.Boolean])]
+    [CmdletBinding()]
+    param
+    (
+        [Parameter(Mandatory = $true)]
+        [System.String[]]
+        $Category
+    )
+
+    $result = $true
+
+    if ($env:CI -eq $true -and $env:CONFIGURATION -notin $Category)
+    {
+        $result = $false
+    }
+
+    return $result
+}

Tests/Unit/ActiveDirectory.Common.Tests.ps1

@@ -8,25 +8,35 @@
 #>
 Get-Module -Name 'ActiveDirectoryDsc.Common' -All | Remove-Module -Force
 
+Import-Module -Name (Join-Path -Path $PSScriptRoot -ChildPath '..\TestHelpers\ActiveDirectoryDsc.TestHelper.psm1')
+
+if (-not (Test-RunForCITestCategory -Type 'Unit' -Category 'Tests'))
+{
+    return
+}
+
 # Import the ActiveDirectoryDsc.Common module to test
 $script:resourceModulePath = Split-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -Parent
 $script:modulesFolderPath = Join-Path -Path $script:resourceModulePath -ChildPath 'Modules\ActiveDirectoryDsc.Common'
 
 Import-Module -Name (Join-Path -Path $script:modulesFolderPath -ChildPath 'ActiveDirectoryDsc.Common.psm1') -Force
 
-# If one type does not exist, it's assumed the other ones does not exist either.
-if (-not ('Microsoft.DirectoryServices.Deployment.Types.ForestMode' -as [Type]))
-{
-    Add-Type -Path (Join-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -ChildPath 'Unit\Stubs\Microsoft.DirectoryServices.Deployment.Types.cs')
-}
+InModuleScope 'ActiveDirectoryDsc.Common' {
+    #Load the AD Module Stub, so we can mock the cmdlets, then load the AD types
+    Import-Module (Join-Path -Path $PSScriptRoot -ChildPath 'Stubs\ActiveDirectoryStub.psm1') -Force
 
-# If one type does not exist, it's assumed the other ones does not exist either.
-if (-not ('Microsoft.ActiveDirectory.Management.ADForestMode' -as [Type]))
-{
-    Add-Type -Path (Join-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -ChildPath 'Unit\Stubs\Microsoft.ActiveDirectory.Management.cs')
-}
+    # If one type does not exist, it's assumed the other ones does not exist either.
+    if (-not ('Microsoft.DirectoryServices.Deployment.Types.ForestMode' -as [Type]))
+    {
+        Add-Type -Path (Join-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -ChildPath 'Unit\Stubs\Microsoft.DirectoryServices.Deployment.Types.cs')
+    }
+
+    # If one type does not exist, it's assumed the other ones does not exist either.
+    if (-not ('Microsoft.ActiveDirectory.Management.ADForestMode' -as [Type]))
+    {
+        Add-Type -Path (Join-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -ChildPath 'Unit\Stubs\Microsoft.ActiveDirectory.Management.cs')
+    }
 
-InModuleScope 'ActiveDirectoryDsc.Common' {
     Describe 'ActiveDirectoryDsc.Common\Test-DscParameterState' -Tag TestDscParameterState {
         Context 'When passing values' {
             It 'Should return true for two identical tables' {

Tests/Unit/MSFT_ADComputer.Tests.ps1

@@ -1,3 +1,10 @@
+Import-Module -Name (Join-Path -Path $PSScriptRoot -ChildPath '..\TestHelpers\ActiveDirectoryDsc.TestHelper.psm1')
+
+if (-not (Test-RunForCITestCategory -Type 'Unit' -Category 'Tests'))
+{
+    return
+}
+
 $script:dscModuleName = 'ActiveDirectoryDsc'
 $script:dscResourceName = 'MSFT_ADComputer'