PS-Sudoku

2.0.2

build.ps1

param (
    [parameter(Mandatory=$true)]
    [ValidateSet("ImportModules", "RunPSScriptAnalyzer", "RunUnitTests", "RunIntegrationTests", "RunAcceptanceTests", "PublishModule", "InstallPSSudoku")]
    [string]$FunctionToRun,
    [Parameter(Mandatory=$false)]
    [String]$NugetAPIKey
)

function ImportModules {
    $WarningPreference = "SilentlyContinue"
    Write-Verbose -Message "Initializing Module PSScriptAnalyzer"
    if (-not(Get-Module -Name PSScriptAnalyzer -ListAvailable)){
        Write-Warning "Module 'PSScriptAnalyzer' is missing or out of date. Installing module now."
        Install-Module -Name PSScriptAnalyzer -Scope CurrentUser -Force
    }

    Write-Verbose -Message "Initializing Module Pester"
    if (-not(Get-Module -Name Pester -ListAvailable)){
        Write-Warning "Module 'Pester' is missing or out of date. Installing module now."
        Install-Module -Name Pester -Scope CurrentUser -Force
    }

    Write-Verbose -Message "Initializing PowerShellGet"
    if (-not(Get-Module -Name PowerShellGet -ListAvailable)){
        Write-Warning "Module 'PowerShellGet' is missing or out of date. Installing module now."
        Install-Module -Name PowerShellGet -Scope CurrentUser -Force
    }

    Write-Verbose -Message "Initializing platyPS"
    if (-not(Get-Module -Name platyPS -ListAvailable)){
        Write-Warning "Module 'platyPS' is missing or out of date. Installing module now."
        Install-Module -Name platyPS -Scope CurrentUser -Force
    }

    Write-Verbose -Message "Initializing PowerShellGet"
    if (-not(Get-Module -Name PowerShellGet -ListAvailable)){
        Write-Warning "Module 'PowerShellGet' is missing or out of date. Installing module now."
        Install-Module -Name PowerShellGet -Scope CurrentUser -Force
    }

    Write-Verbose -Message "Initializing PS-Sudoku"
    InstallPSSudoku
    $WarningPreference = $null
}

function InstallPSSudoku {
    # Script to install the module locally.
    # This is used prior to publishing the module to the PowerShell Gallery
    $Version = "2.0.2"
    $InstallPath = $null
    if ($IsWindows) {
        $InstallPath = "C:\Users\runneradmin\Documents\PowerShell\Modules\PS-Sudoku"
    }
    if ($IsLinux) {
        $InstallPath = "/home/runner/.local/share/powershell/Modules/PS-Sudoku"
    }
    elseif ($IsMacOS) {
        $InstallPath = "/Users/runner/.local/share/powershell/Modules/PS-Sudoku"
    }
    else {
        $PossiblePaths = $env:PSModulePath.Split(";")
        $InstallPath = $PossiblePaths[0]
        $InstallPath = $InstallPath + "\PS-Sudoku"
    }
    if (Test-Path $InstallPath) {
        Write-Verbose "Uninstalling pre-existing module versions..."
        Remove-Item -Recurse -Force $InstallPath
    }
    Write-Verbose "Installing PS-Sudoku module version $Version`..."
    New-Item -ItemType Directory "$InstallPath\$Version" | Out-Null
    Copy-Item "$($PSScriptRoot)\*" -Exclude "*git*" -Recurse -Destination "$InstallPath\$Version"
    Write-Verbose "Ensuring module is properly installed..." 
    Import-Module PS-Sudoku -Force
    if (-not (Get-Command -Module PS-Sudoku)){
        Write-Verbose "Module not installed properly. Manually move the folder to $InstallPath`\`$Version"
    }
    else {
        Write-Verbose "PS-Sudoku version $Version installed successfully!"
    }
}

function PublishModule {
    Write-Verbose -Message "Publishing Module PS-Sudoku"
    Try {
        Publish-Module -Path "." -NuGetAPIKey $NugetAPIKey
    }
    Catch {
        Write-Warning "Publishing Module PS-Sudoku failed."
        Write-Error $_
    }
    Write-Verbose "PS-Sudoku published successfully."
}

function RunPSScriptAnalyzer {
    try {
        Write-Verbose -Message "Running PSScriptAnalyzer on Public functions"
        Invoke-ScriptAnalyzer ".\Public" -Recurse
        Write-Verbose -Message "Running PSScriptAnalyzer on Private functions"
        Invoke-ScriptAnalyzer ".\Private" -Recurse
    }
    catch {
        Write-Error $_
        throw "Couldn't run Script Analyzer"
    }
}

Function RunUnitTests {
    Import-Module .\PS-Sudoku.psm1
    $container = New-PesterContainer -Path ".\Tests\UnitTests\*.ps1" -Data @{runDirectory = ".\Tests\UnitTests\"}
    $PesterArgs = New-PesterConfiguration
    $PesterArgs.Run.Container = $container
    $PesterArgs.Run.PassThru = $true
    $PesterArgs.CodeCoverage.Path = @(
        '.\Public\FindEmptySpot.ps1',
        '.\Public\GenerateGrid.ps1',
        '.\Public\IsMoveValid.ps1',
        '.\Public\SolveSudoku.ps1',
        '.\Public\IsSubgridPlacementValid.ps1',
        '.\Public\IsRowPlacementValid.ps1',
        '.\Private\RemoveRandomNumsFromGrid.ps1'
    )
    $PesterArgs.Output.Verbosity = "Detailed"
    $PesterArgs.CodeCoverage.Enabled = $true
    $PesterArgs.CodeCoverage.CoveragePercentTarget = 80
    $PesterArgs.CodeCoverage.ExcludeTests = $true
    $PesterArgs.CodeCoverage.OutputPath = ".\Tests\UnitTests\CodeCoverage.xml"
    Write-Verbose -Message "Running Pester Unit Tests"
    $Results = Invoke-Pester -Configuration $PesterArgs
    if($Results.FailedCount -gt 0){
        throw "$($Results.FailedCount) Tests failed"
    }
}

Function RunIntegrationTests {
    Import-Module .\PS-Sudoku.psm1
    $container = New-PesterContainer -Path ".\Tests\IntegrationTests\*.ps1" -Data @{runDirectory = ".\Tests\IntegrationTests\"}
    $PesterArgs = New-PesterConfiguration
    $PesterArgs.Run.Container = $container
    $PesterArgs.Run.PassThru = $true
    $PesterArgs.CodeCoverage.Path = @(
        '.\Private\FindValidSudokuGrid.ps1',
        '.\Private\DeepCopyArray.ps1',
        '.\Public\IsMoveValid.ps1',
        '.\Public\SolveSudoku.ps1'
    )
    $PesterArgs.Output.Verbosity = "Detailed"
    $PesterArgs.CodeCoverage.CoveragePercentTarget = 70
    $PesterArgs.CodeCoverage.Enabled = $true
    $PesterArgs.CodeCoverage.ExcludeTests = $true
    $PesterArgs.CodeCoverage.OutputPath = ".\Tests\IntegrationTests\CodeCoverage.xml"
    Write-Verbose -Message "Running Pester Integration Tests"
    $Results = Invoke-Pester -Configuration $PesterArgs
    if($Results.FailedCount -gt 0){
        throw "$($Results.FailedCount) Tests failed"
    }
}

Function RunAcceptanceTests {
    Import-Module .\PS-Sudoku.psm1
    $container = New-PesterContainer -Path ".\Tests\AcceptanceTests\*.ps1" -Data @{runDirectory = ".\Tests\AcceptanceTests\"}
    $PesterArgs = New-PesterConfiguration
    $PesterArgs.Run.Container = $container
    $PesterArgs.Run.PassThru = $true
    $PesterArgs.CodeCoverage.Path = @(
        '.\Private\FindValidSudokuGrid.ps1',
        '.\Private\DeepCopyArray.ps1',
        '.\Public\IsMoveValid.ps1',
        '.\Public\SolveSudoku.ps1',
        '.\Public\GenerateGrid.ps1',
        '.\Public\IsSubgridPlacementValid.ps1',
        '.\Public\IsRowPlacementValid.ps1',
        '.\Public\FindEmptySpot.ps1',
        '.\Private\RemoveRandomNumsFromGrid.ps1',
        '.\Public\IsColumnPlacementValid.ps1'
    )
    $PesterArgs.Output.Verbosity = "Detailed"
    $PesterArgs.CodeCoverage.CoveragePercentTarget = 60
    $PesterArgs.CodeCoverage.Enabled = $true
    $PesterArgs.CodeCoverage.ExcludeTests = $true
    $PesterArgs.CodeCoverage.OutputPath = ".\Tests\AcceptanceTests\CodeCoverage.xml"
    Write-Verbose -Message "Running Pester Acceptance Tests"
    $Results = Invoke-Pester -Configuration $PesterArgs
    if($Results.FailedCount -gt 0){
        throw "$($Results.FailedCount) Tests failed"
    }
}

Invoke-Expression $FunctionToRun