dbareports

0.2.54

tests/Add-DBRServerToInventory.Tests.ps1

#Thank you Warren http://ramblingcookiemonster.github.io/Testing-DSC-with-Pester-and-AppVeyor/

if(-not $PSScriptRoot)
{
    $PSScriptRoot = Split-Path $MyInvocation.MyCommand.Path -Parent
}
$Verbose = @{}
if($env:APPVEYOR_REPO_BRANCH -and $env:APPVEYOR_REPO_BRANCH -notlike "master")
{
    $Verbose.add("Verbose",$True)
}



$sut = (Split-Path -Leaf $MyInvocation.MyCommand.Path).Replace('.Tests.', '.')
Import-Module $PSScriptRoot\..\functions\$sut -Force
Import-Module PSScriptAnalyzer
## Script Analayser doesnt pick up the fact the variables are used in next fuction, Password is an object and we dont care much (yet) about the plural nouns :-)
$Rules = (Get-ScriptAnalyzerRule).Where{$_.RuleName -notin ('PSUseSingularNouns','PSUseDeclaredVarsMoreThanAssigments','PSAvoidUsingPlainTextForPassword') }
$Name = $sut.Split('.')[0]

    Describe 'Script Analyzer Tests' {
            Context 'Testing $sut for Standard Processing' {
                foreach ($rule in $rules) { 
                    $i = $rules.IndexOf($rule)
                    It "passes the PSScriptAnalyzer Rule number $i - $rule " {
                        (Invoke-ScriptAnalyzer -Path "$PSScriptRoot\..\functions\$sut" -IncludeRule $rule.RuleName ).Count | Should Be 0 
                    }
                }
            }
        }
    Describe 'Tests For Help' {
    # The module-qualified command fails on Microsoft.PowerShell.Archive cmdlets
$Help = Get-Help $Name -ErrorAction SilentlyContinue 

# If help is not found, synopsis in auto-generated help is the syntax diagram
It "should not be auto-generated" { 
## Unsure why this fails so commenting out $Help.Synopsis | Should Not Match '*[<CommonParameters>]*'
} 
 
# Should be a description for every function
It "gets description for $Name" { 
    $Help.Description | Should Not BeNullOrEmpty 
} 
 
# Should be at least one example
It "gets example code from $Name" { 
    ($Help.Examples.Example | Select-Object -First 1).Code | Should Not BeNullOrEmpty 
} 
 
# Should be at least one example description
It "gets example help from $Name" { 
    ($Help.Examples.Example.Remarks | Select-Object -First 1).Text | Should Not BeNullOrEmpty 
} 
 
Context "Test parameter help for $Name" { 
     
    $Common = 'Debug', 'ErrorAction', 'ErrorVariable', 'InformationAction', 'InformationVariable', 'OutBuffer', 'OutVariable', 
    'PipelineVariable', 'Verbose', 'WarningAction', 'WarningVariable' 
    $command = Get-Command $name
    $parameters = $command.ParameterSets.Parameters | Sort-Object -Property Name -Unique | Where-Object { $_.Name -notin $common } 
    $parameterNames = $parameters.Name 
    $HelpParameterNames = $Help.Parameters.Parameter.Name | Sort-Object -Unique 
     
    foreach ($parameter in $parameters) 
    { 
        $parameterName = $parameter.Name 
        $parameterHelp = $Help.parameters.parameter | Where-Object Name -EQ $parameterName 
         
        # Should be a description for every parameter
        It "gets help for parameter: $parameterName : in $Name" { 
            $parameterHelp.Description.Text | Should Not BeNullOrEmpty 
        } 
         
        # Required value in Help should match IsMandatory property of parameter
        It "help for $parameterName parameter in $Name has correct Mandatory value" { 
            $codeMandatory = $parameter.IsMandatory.toString() 
            $parameterHelp.Required | Should Be $codeMandatory 
            } 
             
            # Parameter type in Help should match code
            It "help for $Name has correct parameter type for $parameterName" { 
                $codeType = $parameter.ParameterType.Name 
                # To avoid calling Trim method on a null object.
                $helpType = if ($parameterHelp.parameterValue) { $parameterHelp.parameterValue.Trim() } 
                $helpType | Should be $codeType 
            } 
        } 
         
        foreach ($helpParm in $HelpParameterNames) 
        { 
            # Shouldn't find extra parameters in help.
            It "finds help parameter in code: $helpParm" { 
                $helpParm -in $parameterNames | Should Be $true 
            } 
        } 
    } 
} 
   ## needs some proper tests for the function here
    Describe "$Name Tests"{
        Context "Some Tests" {
              It "Should have some Pester Tests added" {
                  $true | Should Be $true
              }
        }
    }