unit_template.ps1

<#
    .SYNOPSIS
        Template for creating DSC Resource Unit Tests
    .DESCRIPTION
        To Use:
        1. Copy to \Tests\Unit\ folder and rename <ResourceName>.tests.ps1 (e.g. MSFT_xFirewall.tests.ps1)
        2. Customize TODO sections.
        3. Delete all template comments (TODOs, etc.)

    .NOTES
        There are multiple methods for writing unit tests. This template provides a few examples
        which you are welcome to follow but depending on your resource, you may want to
        design it differently.
#>


#region HEADER

# Unit Test Template Version: 1.2.0
$script:moduleRoot = Split-Path -Parent (Split-Path -Parent $PSScriptRoot)
if ( (-not (Test-Path -Path (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests'))) -or `
     (-not (Test-Path -Path (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1'))) )
{
    & git @('clone','https://github.com/PowerShell/DscResource.Tests.git',(Join-Path -Path $script:moduleRoot -ChildPath '\DSCResource.Tests\'))
}

Import-Module (Join-Path -Path $script:moduleRoot -ChildPath 'DSCResource.Tests\TestHelper.psm1') -Force

# TODO: Insert the correct <ModuleName> and <ResourceName> for your resource
$TestEnvironment = Initialize-TestEnvironment `
    -DSCModuleName '<ModuleName>' `
    -DSCResourceName '<ResourceName>' `
    -TestType Unit 

#endregion HEADER


# Begin Testing
try
{

    Invoke-TestSetup

    InModuleScope '<ResourceName>' {
        # TODO: Optionally create any variables here for use by your tests
    
        # TODO: Complete the Describe blocks below and add more as needed.
        # The most common method for unit testing is to test by function. For more information
        # check out this introduction to writing unit tests in Pester: 
        # https://www.simple-talk.com/sysadmin/powershell/practical-powershell-unit-testing-getting-started/#eleventh
        # You may also follow one of the patterns provided in the TestsGuidelines.md file:
        # https://github.com/PowerShell/DscResources/blob/master/TestsGuidelines.md
        
        Describe '<Test-name>' {
            
            BeforeEach {
                # per-test-initialization
            }
            AfterEach {
                # per-test-cleanup
            }
            Context 'Context-description' {
            
                BeforeEach {
                    # per-test-initialization
                }
                AfterEach {
                    # per-test-cleanup
                }

                It 'Should...test-description' {
                    # test-code
                }
                . . .
                It 'Should...test-description' {
                    # test-code
                }
            }

            Context 'Context-description' {
                It 'Should ....test-description' {
                    # test-code
                }
            }
        }

        Describe '<Test-name>' {
            Context '<Context-description>' {
                It 'Should ...test-description' {
                    # test-code
                }
            }
        }
        
        # TODO: add more Describe blocks as needed
    }
}
finally
{
 
    Invoke-TestCleanup
    
}

function Invoke-TestSetup {

    # TODO: Optional init code goes here...
    
}

function Invoke-TestCleanup {

    Restore-TestEnvironment -TestEnvironment $TestEnvironment
    
    # TODO: Other Optional Cleanup Code Goes Here...
    
}