vscode/build/azure-pipelines/common/sanity-tests.yml

parameters:
  - name: name
    type: string
  - name: displayName
    type: string
  - name: poolName
    type: string
  - name: os
    type: string
    default: linux
  - name: container
    type: string
    default: ""
  - name: arch
    type: string
    default: amd64
  - name: baseImage
    type: string
    default: ""
  - name: args
    type: string
    default: ""

jobs:
  - job: ${{ parameters.name }}
    displayName: ${{ parameters.displayName }}
    continueOnError: true
    pool:
      name: ${{ parameters.poolName }}
      os: ${{ parameters.os }}
    timeoutInMinutes: 30
    templateContext:
      outputs:
        - output: pipelineArtifact
          targetPath: $(SCREENSHOTS_DIR)
          artifactName: screenshots-${{ parameters.name }}-$(System.JobAttempt)
          displayName: Publish Screenshots
          condition: and(succeededOrFailed(), eq(variables.HAS_SCREENSHOTS, 'true'))
          continueOnError: true
          sbomEnabled: false
    variables:
      TEST_DIR: $(Build.SourcesDirectory)/test/sanity
      LOG_FILE: $(TEST_DIR)/results.xml
      SCREENSHOTS_DIR: $(TEST_DIR)/screenshots
      DOCKER_CACHE_DIR: $(Pipeline.Workspace)/docker-cache
      DOCKER_CACHE_FILE: $(DOCKER_CACHE_DIR)/${{ parameters.container }}.tar
    steps:
      - checkout: self
        fetchDepth: 1
        fetchTags: false
        sparseCheckoutDirectories: build/azure-pipelines/config test/sanity .nvmrc
        displayName: Checkout test/sanity

      - ${{ if eq(parameters.os, 'windows') }}:
        - script: mkdir "$(SCREENSHOTS_DIR)"
          displayName: Create Screenshots Directory

      - ${{ else }}:
        - bash: mkdir -p "$(SCREENSHOTS_DIR)"
          displayName: Create Screenshots Directory

      - ${{ if and(eq(parameters.os, 'windows'), eq(parameters.arch, 'arm64')) }}:
        - script: |
            @echo off
            setlocal enabledelayedexpansion

            set "NODE_VERSION=v22.22.0"
            set "EXPECTED_HASH=5b44fd410df7b4cd0a1891a05a7b606f8fb7d8786a94997b996a372e82478d7a"
            set "NODE_ROOT=$(Agent.TempDirectory)\nodejs"
            set "NODE_EXE=!NODE_ROOT!\node.exe"

            if not exist "!NODE_EXE!" (
              if exist "!NODE_ROOT!" rmdir /s /q "!NODE_ROOT!"

              set "NODE_ZIP=$(Agent.TempDirectory)\node.zip"
              curl.exe -fsSL "https://nodejs.org/dist/!NODE_VERSION!/node-!NODE_VERSION!-win-arm64.zip" -o "!NODE_ZIP!"

              set "ACTUAL_HASH="
              for /f "skip=1" %%A in ('certutil -hashfile "!NODE_ZIP!" SHA256') do if not defined ACTUAL_HASH set "ACTUAL_HASH=%%A"
              if /I not "!ACTUAL_HASH!"=="!EXPECTED_HASH!" (
                echo Hash mismatch for node.zip
                echo   expected: !EXPECTED_HASH!
                echo   actual:   !ACTUAL_HASH!
                del "!NODE_ZIP!"
                exit /b 1
              )

              tar -xf "!NODE_ZIP!" -C "$(Agent.TempDirectory)"
              ren "$(Agent.TempDirectory)\node-!NODE_VERSION!-win-arm64" nodejs
              del "!NODE_ZIP!"
            )

            echo ##vso[task.prependpath]%NODE_ROOT%
          displayName: Install Node.js (Windows ARM64)

      - ${{ else }}:
        - task: NodeTool@0
          inputs:
            versionSource: fromFile
            versionFilePath: .nvmrc
          displayName: Install Node.js

      - script: npm config set registry "$(NPM_REGISTRY)" --location=project
        workingDirectory: $(TEST_DIR)
        displayName: Configure NPM Registry

      - task: npmAuthenticate@0
        inputs:
          workingFile: $(TEST_DIR)/.npmrc
        displayName: Authenticate with NPM Registry

      - script: npm ci
        workingDirectory: $(TEST_DIR)
        displayName: Install NPM Dependencies

      - script: npm run compile
        workingDirectory: $(TEST_DIR)
        displayName: Compile Sanity Tests

      - task: AzureKeyVault@2
        displayName: "Azure Key Vault: Get Secrets"
        inputs:
          azureSubscription: vscode
          KeyVaultName: vscode-build-secrets
          SecretsFilter: "sanity-tests-account,sanity-tests-password"

      # Windows
      - ${{ if eq(parameters.os, 'windows') }}:
        - script: $(TEST_DIR)/scripts/run-win32.cmd -c $(BUILD_COMMIT) -q $(BUILD_QUALITY) -t $(LOG_FILE) -s $(SCREENSHOTS_DIR) -v ${{ parameters.args }}
          workingDirectory: $(TEST_DIR)
          displayName: Run Sanity Tests
          env:
            GITHUB_ACCOUNT: $(sanity-tests-account)
            GITHUB_PASSWORD: $(sanity-tests-password)

      # macOS
      - ${{ if eq(parameters.os, 'macOS') }}:
        - bash: $(TEST_DIR)/scripts/run-macOS.sh -c $(BUILD_COMMIT) -q $(BUILD_QUALITY) -t $(LOG_FILE) -s $(SCREENSHOTS_DIR) -v ${{ parameters.args }}
          workingDirectory: $(TEST_DIR)
          displayName: Run Sanity Tests
          env:
            GITHUB_ACCOUNT: $(sanity-tests-account)
            GITHUB_PASSWORD: $(sanity-tests-password)

      # Native Linux host
      - ${{ if and(eq(parameters.container, ''), eq(parameters.os, 'linux')) }}:
        - bash: $(TEST_DIR)/scripts/run-ubuntu.sh -c $(BUILD_COMMIT) -q $(BUILD_QUALITY) -t $(LOG_FILE) -s $(SCREENSHOTS_DIR) -v ${{ parameters.args }}
          workingDirectory: $(TEST_DIR)
          displayName: Run Sanity Tests
          env:
            GITHUB_ACCOUNT: $(sanity-tests-account)
            GITHUB_PASSWORD: $(sanity-tests-password)

      # Linux Docker container
      - ${{ if ne(parameters.container, '') }}:
        - task: Cache@2
          inputs:
            key: 'docker-v3 | "${{ parameters.container }}" | "${{ parameters.arch }}" | "$(Agent.OS)" | $(TEST_DIR)/containers/${{ parameters.container }}.dockerfile'
            path: $(DOCKER_CACHE_DIR)
            restoreKeys: docker-v3 | "${{ parameters.container }}" | "${{ parameters.arch }}" | "$(Agent.OS)"
            cacheHitVar: DOCKER_CACHE_HIT
          displayName: Download Docker Image

        - bash: |
            docker load -i "$(DOCKER_CACHE_FILE)"
            rm -f "$(DOCKER_CACHE_FILE)"
          condition: eq(variables.DOCKER_CACHE_HIT, 'true')
          displayName: Load Docker Image

        - bash: |
            $(TEST_DIR)/scripts/run-docker.sh \
              --container "${{ parameters.container }}" \
              --arch "${{ parameters.arch }}" \
              --base-image "${{ parameters.baseImage }}" \
              --quality "$(BUILD_QUALITY)" \
              --commit "$(BUILD_COMMIT)" \
              --test-results "/root/results.xml" \
              --screenshots-dir "/root/screenshots" \
              --verbose \
              ${{ parameters.args }}
          workingDirectory: $(TEST_DIR)
          displayName: Run Sanity Tests
          env:
            GITHUB_ACCOUNT: $(sanity-tests-account)
            GITHUB_PASSWORD: $(sanity-tests-password)

        - bash: |
            mkdir -p "$(DOCKER_CACHE_DIR)"
            docker save -o "$(DOCKER_CACHE_FILE)" "${{ parameters.container }}"
          condition: and(succeeded(), ne(variables.DOCKER_CACHE_HIT, 'true'))
          displayName: Save Docker Image

      - ${{ if eq(parameters.os, 'windows') }}:
        - script: |
            @echo off
            dir /b "$(SCREENSHOTS_DIR)" 2>nul | findstr . >nul
            if %errorlevel%==0 (
              echo ##vso[task.setvariable variable=HAS_SCREENSHOTS]true
            )
            exit /b 0
          displayName: Check Screenshots
          condition: succeededOrFailed()

      - ${{ else }}:
        - bash: |
            if [ -n "$(ls -A "$(SCREENSHOTS_DIR)" 2>/dev/null)" ]; then
              echo "##vso[task.setvariable variable=HAS_SCREENSHOTS]true"
            fi
          displayName: Check Screenshots
          condition: succeededOrFailed()

      - task: PublishTestResults@2
        inputs:
          testResultsFormat: JUnit
          testResultsFiles: $(LOG_FILE)
          testRunTitle: ${{ parameters.displayName }}
        displayName: Publish Test Results
        condition: succeededOrFailed()