endjin-gists

0.3.2

endjin-gists.module.tests.ps1

# <copyright file="endjin-gists.module.tests.ps1" company="Endjin Limited">
# Copyright (c) Endjin Limited. All rights reserved.
# </copyright>

$moduleName = Split-Path -Leaf $PSCommandPath.Replace('.module.tests.ps1', '')

Describe "'$moduleName' Module Tests" {

    BeforeDiscovery {
        Write-Host "PSScriptRoot: $PSScriptRoot" -f Magenta
        $functions = Get-ChildItem -Recurse $PSScriptRoot/functions -Include *.ps1 |
                        Where-Object { $_ -notmatch ".Tests.ps1" }
    }
    
    BeforeAll {
        $moduleName = Split-Path -Leaf $PSCommandPath.Replace('.module.tests.ps1', '')
    }
    
    Context 'Module Setup' {
        It "has the root module $moduleName.psm1" {
            "$PSScriptRoot/$moduleName.psm1" | Should -Exist
        }

        It "has the a manifest file of $moduleName.psd1" {
            "$PSScriptRoot/$moduleName.psd1" | Should -Exist
            "$PSScriptRoot/$moduleName.psd1" | Should -FileContentMatch "$moduleName.psm1"
        }
    
        It "$moduleName folder has functions folder" {
            "$PSScriptRoot/functions" | Should -Exist
        }

        It "$moduleName is valid PowerShell code" {
            $psFile = Get-Content -Path "$PSScriptRoot/$moduleName.psm1" -ErrorAction Stop
            $errors = $null
            $null = [System.Management.Automation.PSParser]::Tokenize($psFile, [ref]$errors)
            $errors.Count | Should -Be 0
        }
    }
    
    Context 'Module Exports' {
        BeforeAll {
            $canImport = Get-Module -ListAvailable powershell-yaml -ErrorAction SilentlyContinue
        }

        It "Should export public functions and not private ones" -Skip:(-not $canImport) {
            Import-Module "$PSScriptRoot/$moduleName.psd1" -Force
            $exportedCommands = (Get-Command -Module $moduleName).Name

            $exportedCommands | Should -Contain 'Get-EndjinGist'
            $exportedCommands | Should -Contain 'Get-EndjinGists'
            $exportedCommands | Should -Not -Contain '_Install-Vendir'
            $exportedCommands | Should -Not -Contain '_Get-VendirPath'
            $exportedCommands | Should -Not -Contain '_Get-GistMapData'
        }

        It "Should export the 'gist' alias" -Skip:(-not $canImport) {
            Import-Module "$PSScriptRoot/$moduleName.psd1" -Force
            $alias = Get-Alias gist -ErrorAction SilentlyContinue

            $alias | Should -Not -BeNullOrEmpty
            $alias.Definition | Should -Be 'Get-EndjinGist'
        }

        It "Should export the 'gists' alias" -Skip:(-not $canImport) {
            Import-Module "$PSScriptRoot/$moduleName.psd1" -Force
            $alias = Get-Alias gists -ErrorAction SilentlyContinue

            $alias | Should -Not -BeNullOrEmpty
            $alias.Definition | Should -Be 'Get-EndjinGists'
        }
    }

    Context 'PSScriptAnalyzer' {
        It "Should pass PSScriptAnalyzer rules" {
            $settingsPath = Join-Path $PSScriptRoot 'PSScriptAnalyzerSettings.psd1'
            $filesToAnalyze = @(
                (Get-ChildItem -Path "$PSScriptRoot/functions" -Filter '*.ps1' -Recurse |
                    Where-Object { $_ -notmatch '\.Tests\.ps1$' }).FullName
                (Join-Path $PSScriptRoot "$moduleName.psm1")
            )
            $results = $filesToAnalyze | ForEach-Object {
                Invoke-ScriptAnalyzer -Path $_ -Settings $settingsPath
            }
            $results | Should -BeNullOrEmpty
        }
    }

    Context "Test Function <_>" -ForEach $functions {
        
        BeforeAll {
            $function = $_.Name
            $functionPath = $_.FullName
            $functionTestsPath = $_.FullName.Replace('.ps1', '.Tests.ps1')
            $functionDir = $_.Directory.FullName
            $isPrivateFunction = $_.Name.StartsWith('_')
        }
        
        It "<function> should exist" {
            $functionPath | Should -Exist
        }

        It "<function> should have a copyright block" {
            $functionPath | Should -FileContentMatch 'Copyright \(c\) Endjin Limited'
        }

        It "<function> should have help block" {
            $functionPath | Should -FileContentMatch '<#'
            $functionPath | Should -FileContentMatch '#>'
        }

        It "<function> should have a SYNOPSIS section in the help block" {
            $functionPath | Should -FileContentMatch '.SYNOPSIS'
        }

        It "<function> should have a DESCRIPTION section in the help block" {
            $functionPath | Should -FileContentMatch '.DESCRIPTION'
        }

        It "<function> should have a EXAMPLE section in the help block" {
          $functionPath | Should -FileContentMatch '.EXAMPLE'
        }

        It "<function> should be an advanced function" {
            $functionPath | Should -FileContentMatch 'function'
            $functionContent = Get-Content -raw $functionPath
            if ($functionContent -notmatch '#SUPPRESS-ParameterChecks') {
                $functionPath | Should -FileContentMatch 'cmdletbinding'
                $functionPath | Should -FileContentMatch 'param'
            }
        }
    
        It "<function> is valid PowerShell code" {
            $psFile = Get-Content -Path $functionPath -ErrorAction Stop
            $errors = $null
            $null = [System.Management.Automation.PSParser]::Tokenize($psFile, [ref]$errors)
            $errors.Count | Should -Be 0
        }

        It "<function> should have tests" {
            if (!$isPrivateFunction) {
                $functionTestsPath | Should -Exist
            }
        }
    }
}