Example Unit Test

unittest.ps1

InModuleScope $script:dscResourceName {
    Describe 'ResourceName\Get-TargetResource' -Tag 'Get' {
        BeforeAll {
            # Mocks for all context blocks. Avoid if possible.
        }

        # Context block cannot always be used.
        Context 'When the system is not in the desired state' {
            BeforeAll {
                # Mocks when the system is not in desired state
            }

            It 'Should...' {
                # Test when the system is not in the desired state
            }
        }

        Context 'When the system is the desired state' {
            BeforeAll {
                # Mocks when the system is in desired state
            }

            It 'Should...' {
                # Test when the system is in the desired state
            }
        }
    }

    Describe 'ResourceName\Test-TargetResource' -Tag 'Test' {
        BeforeAll {
            # Mocks for all context blocks. Avoid if possible.
        }

        Context 'When the system is not in the desired state' {
            BeforeAll {
                # Mocks when the system is not in desired state
            }

            It 'Should...' {
                # Test when the system is not in the desired state
            }
        }

        Context 'When the system is the desired state' {
            BeforeAll {
                # Mocks when the system is in desired state
            }

            It 'Should...' {
                # Test when the system is in the desired state
            }
        }
    }

    Describe 'ResourceName\Set-TargetResource' -Tag 'Set' {
        BeforeAll {
            # Mocks for all context blocks. Avoid if possible.
        }

        Context 'When the system is not in the desired state' {
            BeforeAll {
                # Mocks when the system is not in desired state
            }

            It 'Should...' {
                # Test when the system is not in the desired state
            }
        }

        Context 'When the system is the desired state' {
            BeforeAll {
                # Mocks when the system is in desired state
            }

            It 'Should...' {
                # Test when the system is in the desired state
            }
        }
    }

    Describe 'ResourceName\Get-FirstResourceHelperFunction' -Tag 'Helper' {
        BeforeAll {
            # Mocks for all context blocks. Avoid if possible.
        }

        Context 'When helper function returns state 1' {
            It 'Should...' {
                # Test first state of the helper function.
            }
        }


        Context 'When helper function returns state 2' {
            It 'Should...' {
                # Test second state of the helper function.
            }
        }
    }

    Describe 'ResourceName\Get-SecondResourceHelperFunction' -Tag 'Helper' {
        BeforeAll {
            # Mocks for all context blocks. Avoid if possible.
        }

        Context 'When helper function returns state 1' {
            It 'Should...' {
                # Test first state of the helper function.
            }
        }


        Context 'When helper function returns state 2' {
            It 'Should...' {
                # Test second state of the helper function.
            }
        }
    }
}