specification/quantum/Quantum.Workspace/eng/build.ps1

# --------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# --------------------------------------------------------------------------------------------

Import-Module (Join-Path $PSScriptRoot "./common.psm1")
$outputFolder = "./output/build/"

try {
    Push-Location (Join-Path $PSScriptRoot "../")

    $outputDirectory = Join-Path (Resolve-Path .) $outputFolder
    Remove-Item -Path $outputDirectory -Recurse -Force *> $null
    New-Item -ItemType Directory -Force -Path $outputDirectory *> $null

    $logDirectory = Join-Path $outputDirectory "./logs"
    Remove-Item -Path $outputDirectory -Recurse -Force *> $null
    New-Item -ItemType Directory -Force -Path $logDirectory *> $null

    function GetVersions {
        param (
            [string] $configFile
        )
        # get new/current tag from the Autorest config
        $configContents = Get-Content -Path $configFile
        $tagRegex = '(?<tag>package-(?<version>\d{4}-\d{2}-\d{2}(?<modifier>-preview)?))'    
        $reMatches = ($configContents | Select-String "^tag:\s$tagRegex$").Matches | Select-Object -First 1
        $newTag = $reMatches.Groups["tag"].Value
        $newVersion = $reMatches.Groups["version"].Value

        # get all tags from the Autorest config and determine the previous version
        $reMatches = ($configContents | Select-String "^###\sTag:\s$tagRegex$").Matches
        $previousVersion = ""
        $previousTag = ""
        $allVersions = New-Object System.Collections.Generic.List[string]
        foreach ($match in $reMatches) {
            $tag = $match.Groups["tag"].Value
            $version = $match.Groups["version"].Value           
            $allVersions.Add($version)
            if ($tag -gt $previousTag && $tag -ne $newTag) {
                $previousTag = $tag
                $previousVersion = $version
            }
        }
        return [PSCustomObject]@{
            NewTag = $newTag
            NewVersion = $newVersion
            PreviousTag = $previousTag
            PreviousVersion = $previousVersion
            AllVersions = $allVersions
        }
    }

    $configFile =  Resolve-Path "../data-plane/readme.md"
    $versions = GetVersions $configFile

    $newSwaggerFolder = "../data-plane/Microsoft.Quantum/preview/$($versions.NewVersion)/"
    Remove-Item -Path $newSwaggerFolder -Recurse -Force *> $null
    New-Item -ItemType Directory -Force -Path $newSwaggerFolder *> $null
    $newSwaggerFolder = Resolve-Path $newSwaggerFolder
    $newSwaggerFile = Join-Path $newSwaggerFolder "/quantum.json"

    $previousSwaggerFile = Resolve-Path "../data-plane/Microsoft.Quantum/preview/$($versions.PreviousVersion)/quantum.json"

    Write-Host @"
------------------------------------------------------------------------
Azure Quantum TypeSpec build - BEGIN
------------------------------------------------------------------------
Started at
    $(Get-Date -format "yyyy-MM-dd HH:mm:ss")
Compiling TypeSpec and generating Swagger for version
    $($versions.NewVersion)
    $newSwaggerFile
Comparisons will be made against previous version
    $($versions.PreviousVersion)
    $previousSwaggerFile
Writing output logs to
    $logDirectory
------------------------------------------------------------------------
"@

    # Copy examples from previous version
    # if they don't exist for the new version.
    $newVersionExamples = ".\examples\$($versions.NewVersion)"
    if (-not (Test-Path -Path $newVersionExamples)) {
        $source = ".\examples\$($versions.PreviousVersion)"
        Write-Host @"
Examples not found for $($versions.NewVersion).
Copying examples from $source to $newVersionExamples
"@
        Copy-Item -Path $source -Destination $newVersionExamples -Recurse
        ForEach($file in Get-ChildItem -Path $newVersionExamples -File){
            $example = Get-Content -Path $file
            $example = $example -replace $versions.PreviousVersion, $versions.NewVersion
            Set-Content $file $example                
        }
    }

    RunAndCheck "tsp-format" $logDirectory {
        tsp format **/*.tsp
    }

    RunAndCheck "prettify-examples" $logDirectory {
        $examples = $newVersionExamples
        # Uncomment this line if you need to prettify all examples
        # $examples = ".\examples\"
        ForEach($file in Get-ChildItem -Path $examples -File -Recurse){
            npx prettier --write $file
        }
    }

    RunAndCheck "prettify-tspconfig" $logDirectory {
        npx prettier --write "tspconfig.yaml"
    }

    RunAndCheck "tsp-compile" $logDirectory {
        tsp compile . --pretty --debug
    }

    RunAndCheck "tsp-compile-api-view" $logDirectory {
        tsp compile . --pretty --debug --emit=@azure-tools/typespec-apiview --output-dir (Join-Path $logDirectory "../api-view/")
    }
        
    # copy to swagger folder to easy upload to https://apiview.dev/
    New-Item -ItemType Directory -Force -Path (Join-Path $outputDirectory "./swagger/") *> $null
    Copy-Item $newSwaggerFile (Join-Path $outputDirectory "./swagger/quantum.swagger") -Force *> $null

    RunAndCheck "swagger-preview" $logDirectory {
        $openApi = Get-Content -Path $newSwaggerFile
        $spec = "let spec = $openApi"
        Set-Content ./eng/swagger-ui/spec.js $spec
    }

    # RunAndCheck "generate-examples" \ {
    #     # Ideally we should use the example generation with the custom payloads, but I didn't
    #     # figured out yet what's wrong with the initial payload I created (Jobs_Cancel/204.json)).
    #     # oav generate-examples $newSwaggerFile -l info -p --payloadDir (Join-Path $PSScriptRoot "../example-payloads/")
    #     oav generate-examples $newSwaggerFile -l info -p
    # }

    # Pipeline validations
    # from https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/ci-fix.md

    RunAndCheck "tsp-validate" $logDirectory {
        # To run the TypeSpec Validation we need to go
        # to the root of the azure-rest-api-specs repo
        Push-Location (Join-Path $PSScriptRoot "../../../../")
        try
        {
            npx --no tsv .\specification\quantum\Quantum.Workspace\        
        }
        finally
        {
            Pop-Location
        }     
    }   

    RunAndCheck "example-validation" $logDirectory {
        oav validate-example $newSwaggerFile
    }

    RunAndCheck "semantic-validation" $logDirectory {
        oav validate-spec $newSwaggerFile
    }

    RunAndCheck "model-compare" $logDirectory {
        oad compare $previousSwaggerFile $newSwaggerFile --logFilepath (Join-Path $logDirectory "/oad-compare-log.json") > (Join-Path $logDirectory "/model-compare.json")
    }

    RunAndCheck "model-compare-viz" $logDirectory {
        $modelCompare = Get-Content -Path (Join-Path $logDirectory "/model-compare.json")
        $modelCompare = "let modelCompare = $modelCompare"
        Set-Content ./eng/model-compare/model-compare.js $modelCompare

        $openApi = Get-Content -Path $newSwaggerFile
        $spec = "let newSpec = $openApi"
        Set-Content ./eng/model-compare/new-spec.js $spec

        $openApi = Get-Content -Path $previousSwaggerFile
        $spec = "let oldSpec = $openApi"
        Set-Content ./eng/model-compare/old-spec.js $spec
    }

    RunAndCheck "lint-diff" $logDirectory {
        autorest --v3 --spectral --validation --azure-validator --openapi-type=data-plane --use=@microsoft.azure/openapi-validator@latest $newTag $configFile
    }

    RunAndCheck "avocado" $logDirectory {
        avocado -f (Join-Path $logDirectory "/avocado-log.txt") -d (Join-Path $logDirectory "../data-plane")
    }

    Write-Host @"
------------------------------------------------------------------------
Azure Quantum TypeSpec build - END
------------------------------------------------------------------------
Completed at
    $(Get-Date -format "yyyy-MM-dd HH:mm:ss")
------------------------------------------------------------------------
"@
}
finally
{
    Pop-Location
}