Snowplow

0.1.0-beta1

Private/SnowProfiles.ps1

function Get-SnowProfileStorePath {
    [CmdletBinding()]
    param()

    Join-Path (Get-SnowplowDirectories).Config 'profiles.json'
}

function Get-SnowLegacyProfileStorePath {
    [CmdletBinding()]
    param()

    Join-Path ([Environment]::GetFolderPath('UserProfile')) '.snowplow/profiles.json'
}

function Read-SnowProfileStore {
    [CmdletBinding()]
    param()

    $path = Get-SnowProfileStorePath
    if (-not (Test-Path -LiteralPath $path)) {
        $legacyPath = Get-SnowLegacyProfileStorePath
        if ((Get-SnowplowPlatform) -eq 'Linux' -and (Test-Path -LiteralPath $legacyPath)) {
            $path = $legacyPath
        }
        else {
            return @()
        }
    }

    $raw = Get-Content -LiteralPath $path -Raw -ErrorAction Stop
    if ([string]::IsNullOrWhiteSpace($raw)) { return @() }

    try {
        $profiles = @(ConvertFrom-Json -InputObject $raw -ErrorAction Stop)
    }
    catch {
        throw [System.IO.InvalidDataException]::new("The Snowplow profile store '$path' is corrupted.")
    }

    foreach ($profile in $profiles) {
        $propertyNames = @($profile.PSObject.Properties.Name)
        if ($propertyNames -notcontains 'Name' -or $propertyNames -notcontains 'Instance') {
            throw [System.IO.InvalidDataException]::new("The Snowplow profile store '$path' is corrupted.")
        }
        if ($propertyNames -notcontains 'Environment' -or
            [string]::IsNullOrWhiteSpace([string]$profile.Environment) -or
            [string]$profile.Environment -notin @('Dev', 'Test', 'Prod')) {
            throw [System.IO.InvalidDataException]::new("The Snowplow profile store '$path' is corrupted.")
        }

        [pscustomobject]@{
            PSTypeName                 = 'Snowplow.Profile'
            Name                       = [string]$profile.Name
            Instance                   = [string]$profile.Instance
            AuthMethod                 = if (($propertyNames -contains 'AuthMethod') -and $profile.AuthMethod) { [string]$profile.AuthMethod } else { 'OAuth' }
            DefaultBackend             = if (($propertyNames -contains 'DefaultBackend') -and $profile.DefaultBackend) { [string]$profile.DefaultBackend } else { 'Rest' }
            Environment                = [string]$profile.Environment
            ClientCredentialSecretName = if ($propertyNames -contains 'ClientCredentialSecretName') { [string]$profile.ClientCredentialSecretName } else { $null }
            CredentialSecretName       = if ($propertyNames -contains 'CredentialSecretName') { [string]$profile.CredentialSecretName } else { $null }
            Vault                      = if ($propertyNames -contains 'Vault') { [string]$profile.Vault } else { $null }
        }
    }
}

function Resolve-SnowProfileInstance {
    [CmdletBinding()]
    param([Parameter(Mandatory)][string]$Instance)

    try {
        (Resolve-SnowInstanceUri -Instance $Instance).AbsoluteUri
    }
    catch {
        throw [System.ArgumentException]::new('The profile instance must be a valid HTTPS ServiceNow instance name or URL.')
    }
}

function Write-SnowProfileStore {
    [CmdletBinding()]
    param([Parameter(Mandatory)][AllowEmptyCollection()][object[]]$Profiles)

    $path = Get-SnowProfileStorePath
    $directory = Split-Path -Path $path -Parent
    if (-not (Test-Path -LiteralPath $directory)) {
        $null = [System.IO.Directory]::CreateDirectory($directory)
    }
    Protect-SnowplowPath -Path $directory -Type Directory

    $json = if ($Profiles.Count -eq 0) {
        '[]'
    }
    else {
        $Profiles | Sort-Object Name | ConvertTo-Json -Depth 4
    }
    Set-Content -LiteralPath $path -Value $json -Encoding utf8NoBOM
    Protect-SnowplowPath -Path $path -Type File
}

function Get-SnowStoredProfile {
    [CmdletBinding()]
    param([Parameter(Mandatory)][string]$Name)

    $profile = @(Read-SnowProfileStore | Where-Object Name -eq $Name)
    if (-not $profile) {
        throw [System.Management.Automation.ItemNotFoundException]::new("Snowplow profile '$Name' was not found.")
    }

    $profile[0]
}