ActiveDirectoryDsc: Proof of Concept - Running local integration tests #592

johlju · 2020-04-12T11:24:45Z

Pull Request (PR) description

The goal I had was to be able to run the integration tests on a VM in Hyper-V using Pester and get the Pester output in the console on the host. I had this laying around for a long time now, and spent the weekend converting it to handle the new pipeline which helped with a few steps, and then I wanted to finish this to a point where it is was working.
This is a PoC of that which now runs three of the integration tests in a Hyper-V VM. Comments appreciated! 😄

There are many manual steps to get to a point where we can run tests. I like to see if we can use any automation tool to help with this, all of this or parts of this. Tools like AutomatedLab, LabBuilder, Lability, or Test Kitchen might help.
The reason I focused on using Hyper-V is the seemless integration with PowerShell Direct.

I like to extend this PoC to all the integrations tests we have and also setting up child domain. I looking to have 4 nodes in the lab depending on the memory usage needed by the host.

README.md: https://github.com/dsccommunity/ActiveDirectoryDsc/blob/2d86b1767f3b8240744e9c73904e04be51a7a514/Tests/README.md

Todo:

Lower the memory for each VM but still being able to run the integration tests (currently 4GB per VM)
Fix the rest of the available integration tests so they run.
Setup 2 DC's in parent and 2 DC's in child (and potentially read-only DC's and different sites) - memory usage will limit us here.
Run integration tests using certificate

This Pull Request (PR) fixes the following issues

Fixes Create Integration Tests for Resources #121

Task list

Added an entry to the change log under the Unreleased section of the
file CHANGELOG.md. Entry should say what was changed and how that
affects users (if applicable), and reference the issue being resolved
(if applicable).
Resource documentation added/updated in README.md.
Resource parameter descriptions added/updated in README.md, schema.mof
and comment-based help.
Comment-based help added/updated.
Localization strings added/updated in all localization files as appropriate.
Examples appropriately added/updated.
Unit tests added/updated. See DSC Community Testing Guidelines.
Integration tests added/updated (where possible). See DSC Community Testing Guidelines.
New/changed code adheres to DSC Community Style Guidelines.

This change is

X-Guardian

Reviewable status: 0 of 14 files reviewed, 12 unresolved discussions (waiting on @johlju)

Tests/README.md, line 21 at r1 (raw file):

>**Note:** All these steps are expected to be run in the same elevated
>PowerShell prompt. It also expect that you have downloaded the appropriate

It also expects

Tests/README.md, line 27 at r1 (raw file):

<!-- markdownlint-disable MD031 - Fenced code blocks should be surrounded by blank lines -->
1. Create a Hyper-VM (Generation 2). In an elevated PowerShell prompt run
   this.

this:

Tests/README.md, line 68 at r1 (raw file):

   C:\Windows\System32\SysPrep\sysprep.exe /quiet /generalize /oobe /shutdown
Create the folder where we store the exported image. This folder can

where we will store

Tests/README.md, line 135 at r1 (raw file):

   Get-VM -Name $vmNames | Start-VM -Verbose
On each started VM finish the installation by configure the following

configuring

Tests/README.md, line 146 at r1 (raw file):

### Test prerequisites

The host for the virtual machines must have access to Internet. The

the Internet.

Tests/README.md, line 148 at r1 (raw file):

The host for the virtual machines must have access to Internet. The
below steps assumes the virtual machines that should run the integration
test are only connect to a private virtual switch and does not have access

only connected to a private virtual switch and do not have access

Tests/README.md, line 151 at r1 (raw file):

to the Internet.

The blow steps *must* be run in a elevated PowerShell console.

below steps

Tests/README.md, line 154 at r1 (raw file):

<!-- markdownlint-disable MD031 - Fenced code blocks should be surrounded by blank lines -->
1. Change to folder to root of your local working repository

Change directory to the root

Tests/README.md, line 297 at r1 (raw file):

several times. The integration tests that depend on an already existing
domain can be run several times without reverting to the checkpoint. The
resources that need a clean environment are the resources that configures

configure

Tests/README.md, line 300 at r1 (raw file):

the domain, e.g. `ADDomain` and `ADDomainController`.

1. Change to folder to root of your local working repository

Change directory to the root

Tests/TestHelpers/Prepare-DscLab-dc01.ps1, line 41 at r1 (raw file):

}
}

Format to align hash table properties.

Tests/TestHelpers/Prepare-DscLab-dc02.ps1, line 41 at r1 (raw file):

}
}

Format to align hash table properties

X-Guardian · 2020-04-13T10:19:08Z

Hi @johlju, just a few grammar/typo fixes in reviewable.

Unfortunately, I don't have a Hyper-V host to test it with (my home lab is ESXi).

The way I have been running the integration tests is by git cloning the whole repo onto my test domain controller, then running build.ps1 build then invoke-pester on the relevant integration test. I see you are proposing to remove the code that runs Initialize-TestEnvironment from each integration test, what affect will that have on this process?

johlju · 2020-04-13T10:58:37Z

I see you are proposing to remove the code that runs Initialize-TestEnvironment from each integration test, what affect will that have on this process?

Yes it will, but maybe we shouldn't break your scenario 🤔 I will figure out a way so both ways works.

I tried to use the build process to initiate the tests but that is not 100% when the node reboots since the Initialize-TestEnvironment sets the machine PSModulePath and then Restore-TestEnvironment removes it at the end of the tests, meaning that after a reboot the configuration cannot be run automatically because the modules cannot be found. But for integration tests that will not reboot it works though. Maybe we can solve this by not running Restore-TestEnvironment if a resource requested a reboot? 🤔

try 
{
    # ...

    $DscConfigurationStatus = Get-DscConfigurationStatus
    if ($DscConfigurationStatus.RebootRequested)
    {
        return
    }

    # ...
}
finally
{
    if ($DscConfigurationStatus.RebootRequested)
    {
        Write-Warning 'A Reboot has been requested by the DSC. Please reboot then re-run the test'
    }
    else
    {
        Restore-TestEnvironment -TestEnvironment $script:testEnvironment
    }
}

johlju

Reviewable status: 0 of 14 files reviewed, 12 unresolved discussions (waiting on @X-Guardian)

Tests/README.md, line 21 at r1 (raw file):