apiview.yml

parameters:
  - name: AzureSdkForNetDevOpsFeed
    type: string
    default: 'https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-net/nuget/v3/index.json'
  - name: CSharpAPIParserVersion
    type: string
    default: '1.0.0-dev.20240828.2'
  - name: JavaScriptAPIParser
    type: string
    default: '@azure-tools/ts-genapi@2.0.3'
  - name: JavaScriptArtifactRegistry
    type: string
    default: 'https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-js/npm/registry/'

trigger:
  branches:
    include:
      - main
      - feature/*
      - release/*
      - hotfix/*
  paths:
    include:
      - .azure-pipelines/apiview.yml
      - src/dotnet/APIView
      - src/java/apiview-java-processor
      - src/go
      - src/swift
      - tools/apiview/parsers/js-api-parser

pr:
  branches:
    include:
      - main
      - feature/*
      - release/*
      - hotfix/*
  paths:
    include:
      - .azure-pipelines/apiview.yml
      - src/dotnet/APIView
      - src/java/apiview-java-processor
      - src/go
      - src/swift
      - tools/apiview/parsers/js-api-parser

extends:
  template: /eng/pipelines/templates/stages/1es-redirect.yml
  parameters:
    GenerateBaselines: true
    stages:
      - stage: 'Build'
        displayName: 'Build and Test'

        variables:
          - name: 'WebClientProjectDirectory'
            value: 'src/dotnet/APIView/APIViewWeb/Client'
          - name: 'SPAClientProjectDirectory'
            value: 'src/dotnet/APIView/ClientSPA'
          - name: WebProjectPath
            value: 'src/dotnet/APIView/APIViewWeb/APIViewWeb.csproj'
          - name: NodeVersion
            value: '18.x'
          - name: BuildConfiguration
            value: 'Release'
          - name: GoParserPackagePath
            value: 'src/go'
          - name: GoVersion
            value: '1.22.1'
          - name: NugetSecurityAnalysisWarningLevel
            value: 'none'
          - name: AzuriteConnectionString
            value: "DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;BlobEndpoint=http://127.0.0.1:10000/devstoreaccount1"
          - name: CosmosEmulatorConnectionString
            value: "AccountEndpoint=https://localhost:8081/;AccountKey=C2y6yDjf5/R+ob0N8A7Cgv30VRDJIWEHLM+4QDU5DE2nQ9nDuVTqobD4b8mGGyPMbIZnqyMsEcaGQy67XIw/Jw=="
          - name: TestingDataContainer
            value: "https://apiviewuitest.blob.core.windows.net/testingdata"
          - ${{ if ne(variables['System.TeamProject'], 'internal') }}:
            - name: CollectCoverage
              value: false
          - ${{ if eq(variables['System.TeamProject'], 'internal') }}:
            - name: CollectCoverage
              value: true
          - template: /eng/pipelines/templates/variables/image.yml

        jobs:
          - job: 'Build'

            pool:
              name: $(WINDOWSPOOL)
              image: $(WINDOWSVMIMAGE)
              os: windows

            steps:
              - task: NodeTool@0
                inputs:
                  versionSpec: '$(NodeVersion)'
                displayName: 'Use NodeJS $(NodeVersion)'

              - task: GoTool@0
                inputs:
                  version: '$(GoVersion)'
                displayName: "Use Go $(GoVersion)"

              - script: |
                  npm install -g @angular/cli@16.1.8
                workingDirectory: $(SPAClientProjectDirectory)
                displayName: "Install Angular CLI"

              - script: |
                  npm install
                workingDirectory: $(WebClientProjectDirectory)
                displayName: "Install npm packages"

              - script: |
                  npm run-script build
                workingDirectory: $(WebClientProjectDirectory)
                displayName: "Build client assets"

              - script: |
                  npm install
                workingDirectory: $(SPAClientProjectDirectory)
                displayName: "Install Client SPA Packages"

              - script: |
                  npm run-script build
                workingDirectory: $(SPAClientProjectDirectory)
                displayName: "Build Client SPA assets"

              - script: |
                  npx workbox-cli generateSW workbox-config.js
                workingDirectory: $(SPAClientProjectDirectory)
                displayName: "Configure Service Worker"

              - task: Maven@3
                inputs:
                  mavenPomFile: 'src/java/apiview-java-processor/pom.xml'
                  goals: 'clean package'

              - script: |
                  go build
                workingDirectory: $(GoParserPackagePath)
                displayName: 'Build go parser'

              - task: UseDotNet@2
                inputs:
                  packageType: 'sdk'
                  useGlobalJson: true
                  workingDirectory: $(Build.SourcesDirectory)

              - script: 'dotnet build $(WebProjectPath) -warnaserror'
                displayName: 'Build and Package'
                env:
                  DOTNET_SKIP_FIRST_TIME_EXPERIENCE: 1
                  DOTNET_CLI_TELEMETRY_OPTOUT: 1
                  DOTNET_MULTILEVEL_LOOKUP: 0

              - task: DotNetCoreCLI@2
                displayName: 'Publish site'
                env:
                  DOTNET_SKIP_FIRST_TIME_EXPERIENCE: 1
                  DOTNET_CLI_TELEMETRY_OPTOUT: 1
                  DOTNET_MULTILEVEL_LOOKUP: 0
                inputs:
                  command: 'publish'
                  projects: '$(WebProjectPath)'
                  publishWebProjects: false
                  arguments: '--configuration $(BuildConfiguration) --output $(Build.ArtifactStagingDirectory)'
                  zipAfterPublish: true

              - template: /eng/common/pipelines/templates/steps/publish-1es-artifact.yml
                parameters:
                  ArtifactName: 'APIView'
                  ArtifactPath: '$(Build.ArtifactStagingDirectory)'

          - job: 'Test'

            pool:
              name: azsdk-pool-mms-win-2022-general
              vmImage: windows-2022

            steps:
              - script: |
                  npm install -g @angular/cli@16.1.8
                workingDirectory: $(SPAClientProjectDirectory)
                displayName: "Install Angular CLI"

              - script: |
                  npm install
                workingDirectory: $(WebClientProjectDirectory)
                displayName: "Install npm packages"

              - script: |
                  npm install
                workingDirectory: $(SPAClientProjectDirectory)
                displayName: "Install Client SPA Packages"

              - script: |
                  ng test --no-watch --no-progress --browsers=ChromeHeadless
                workingDirectory: $(SPAClientProjectDirectory)
                displayName: "Run SPA Tests"
              #- template: /eng/common/pipelines/templates/steps/cosmos-emulator.yml
              #  parameters:
              #    StartParameters: '/noexplorer /noui /enablepreview /disableratelimiting /enableaadauthentication /partitioncount=50 /consistency=Strong'

              #- script: |
              #    npm install -g azurite
              #  displayName: 'Install Azurite'

              #- task: Powershell@2
              #  inputs:
              #    workingDirectory: $(Agent.TempDirectory)
              #    filePath: $(Build.SourcesDirectory)/eng/scripts/Start-LocalHostApp.ps1
              #    arguments: >
              #      -Process "azurite.cmd"
              #      -ArgumentList "--silent"
              #      -Port "10000"
              #    pwsh: true
              #  displayName: 'Start Azurite'

              - template: /eng/pipelines/templates/steps/install-dotnet.yml

              - pwsh: |
                  dotnet --list-runtimes
                  dotnet --version
                displayName: 'List .NET run times'

              - script: >-
                 dotnet test src/dotnet/APIView/APIViewUnitTests/APIViewUnitTests.csproj
                 --logger trx --collect:"XPlat Code Coverage"
                displayName: "Build & Test (APIViewUnitTests)"
                env:
                  DOTNET_SKIP_FIRST_TIME_EXPERIENCE: 1
                  DOTNET_CLI_TELEMETRY_OPTOUT: 1
                  DOTNET_MULTILEVEL_LOOKUP: 0

              #- task: GoTool@0
              #  inputs:
              #    version: '$(GoVersion)'
              #  displayName: "Use Go $(GoVersion)"
              #
              #- script: |
              #    go test ./... -v
              #  workingDirectory: $(GoParserPackagePath)
              #  displayName: 'Test Go parser'

              #- task: Palmmedia.reportgenerator.reportgenerator-build-release-task.reportgenerator@4
              #  condition: and(succeededOrFailed(), eq(variables['CollectCoverage'], 'true'))
              #  displayName: Generate Code Coverage Reports
              #  inputs:
              #    reports: $(Build.SourcesDirectory)\src\dotnet\APIView\APIViewUnitTests\**\coverage.cobertura.xml
              #    targetdir: $(Build.ArtifactStagingDirectory)\coverage
              #    reporttypes: Cobertura
              #    filefilters: +$(Build.SourcesDirectory)\src\dotnet\APIView\**
              #    verbosity: Verbose

              #- task: PublishCodeCoverageResults@2
              #  condition: and(succeededOrFailed(), eq(variables['CollectCoverage'], 'true'))
              #  displayName: Publish Code Coverage Reports
              #  inputs:
              #    summaryFileLocation: $(Build.ArtifactStagingDirectory)\coverage\Cobertura.xml

              #- script: >-
              #    dotnet test src/dotnet/APIView/APIViewIntegrationTests/APIViewIntegrationTests.csproj
              #    --logger trx
              #  displayName: "Build & Test (Integration)"
              #  env:
              #    DOTNET_SKIP_FIRST_TIME_EXPERIENCE: 1
              #    DOTNET_CLI_TELEMETRY_OPTOUT: 1
              #    DOTNET_MULTILEVEL_LOOKUP: 0
              #    APIVIEW_ENDPOINT: "http://localhost:5000"
              #    APIVIEW_BLOB__CONNECTIONSTRING: $(AzuriteConnectionString)
              #    APIVIEW_COSMOS__CONNECTIONSTRING: $(CosmosEmulatorConnectionString)

              #- script: |
              #    npm install
              #  workingDirectory: $(WebClientProjectDirectory)
              #  displayName: "Install Client Dependencies"

              #- script: |
              #    npx playwright install --with-deps
              #  workingDirectory: $(WebClientProjectDirectory)
              #  displayName: "Install Playwright Browsers"

              #- script: |
              #    npx playwright test --project=unit-tests
              #  workingDirectory: $(WebClientProjectDirectory)
              #  displayName: "Run Client-Side Unit Tests"

              #- task: 1ES.PublishPipelineArtifact@1
              #  inputs:
              #    path: '$(Build.SourcesDirectory)\src\dotnet\APIView\APIViewWeb\Client\playwright-report'
              #    artifact: 'Client-Side Unit Test Reports'

              #- ${{ if and(ne(variables['Build.Reason'], 'PullRequest'), eq(variables['System.TeamProject'], 'internal')) }}:
              #  - template: /eng/pipelines/templates/steps/apiview-ui-tests.yml
              #    parameters:
              #      NodeVersion: $(NodeVersion)
              #      WebClientProjectDirectory: $(WebClientProjectDirectory)
              #      AzuriteConnectionString: $(AzuriteConnectionString)
              #      CosmosEmulatorConnectionString: $(CosmosEmulatorConnectionString)

              #  - task: PublishTestResults@2
              #    condition: succeededOrFailed()
              #    inputs:
              #      testResultsFiles: '**/*.trx'
              #      testRunTitle: 'Tests against Windows .NET'
              #      testResultsFormat: 'VSTest'
              #      mergeTestResults: true

      - ${{ if eq(variables['System.TeamProject'], 'internal') }}:
        - stage: Staging_Publish
          displayName: Pre-Prod
          dependsOn: Build

          variables:
            - name: 'apiUrl'
              value: 'https://apiviewstagingtest.com/api/'
            - name: 'hubUrl'
              value: 'https://apiviewstagingtest.com/hubs/'
            - name: 'webAppUrl'
              value: 'https://apiviewstagingtest.com/'

          jobs:
            - job: Publish_to_Staging
              displayName: Publish to Staging
              pool:
                name: azsdk-pool-mms-ubuntu-2004-general
                image: azsdk-pool-mms-ubuntu-2004-1espt
                os: linux

              steps:
              - checkout: self

              - download: current
                artifact: APIView
                timeoutInMinutes: 5

              - task: FileTransform@1
                displayName: 'Update Angular Config for Environment'
                inputs:
                  folderPath: '$(Pipeline.Workspace)/APIView/APIViewWeb.zip'
                  fileType: json
                  targetFiles: wwwroot/spa/assets/config.json

              - task: AzureRmWebAppDeployment@4
                displayName: 'Deploy Azure App Service'
                inputs:
                  azureSubscription: 'APIview staging resource group'
                  appType: 'webApp'
                  WebAppName: 'apiviewstaging'
                  packageForLinux: '$(Pipeline.Workspace)/APIView/**/APIViewWeb.zip'
                  ScriptType: 'Inline Script'
                  InlineScript: |
                    @echo off
                    echo Installing .NET tool
                    call dotnet tool install --add-source ${{ parameters.AzureSdkForNetDevOpsFeed }} --version  ${{ parameters.CSharpAPIParserVersion }} --tool-path D:\home\site\wwwroot\csharp-parser CSharpAPIParser
                    echo Installing JavaScript parser
                    call npm install --prefix D:\home\site\wwwroot\js-parser ${{ parameters.JavaScriptAPIParser }} --registry ${{ parameters.JavaScriptArtifactRegistry }}  
                  enableCustomDeployment: true
                  DeploymentType: zipDeploy

      - ${{ if and(in(variables['Build.Reason'], 'Manual', ''), eq(variables['System.TeamProject'], 'internal')) }}:
        - stage: Test_UI_Publish
          displayName: Publish Test UI
          dependsOn: Build

          variables:
            - name: 'apiUrl'
              value: 'https://apiviewuxtest.com/api/'
            - name: 'hubUrl'
              value: 'https://apiviewuxtest.com/hubs/'
            - name: 'webAppUrl'
              value: 'https://apiviewuxtest.com/'

          jobs:
            - deployment: Publish_Test_UI
              displayName: Publish Test UI
              environment: 'package-publish'
              pool:
                name: azsdk-pool-mms-ubuntu-2004-general
                image: azsdk-pool-mms-ubuntu-2004-1espt
                os: linux

              strategy:
                runOnce:
                  deploy:
                    steps:
                    - checkout: self

                    - download: current
                      artifact: APIView
                      timeoutInMinutes: 5

                    - task: FileTransform@1
                      displayName: 'Update Angular Config for Environment'
                      inputs:
                        folderPath: '$(Pipeline.Workspace)/APIView/APIViewWeb.zip'
                        fileType: json
                        targetFiles: wwwroot/spa/assets/config.json

                    - task: AzureRmWebAppDeployment@4
                      displayName: 'Azure App Service Deploy: apiviewuat'
                      inputs:
                        azureSubscription: 'APIViewUI-Instance-deployment-connection'
                        WebAppName: apiviewuat
                        packageForLinux: $(Pipeline.Workspace)/APIView/**/*.zip
                        InlineScript: |
                          @echo off
                          echo Installing .NET tool
                          call dotnet tool install --add-source ${{ parameters.AzureSdkForNetDevOpsFeed }} --version  ${{ parameters.CSharpAPIParserVersion }} --tool-path D:\home\site\wwwroot\csharp-parser CSharpAPIParser
                          echo Installing JavaScript parser
                          call npm install --prefix D:\home\site\wwwroot\js-parser ${{ parameters.JavaScriptAPIParser }} --registry ${{ parameters.JavaScriptArtifactRegistry }} 
                        enableCustomDeployment: true
                        DeploymentType: zipDeploy

        - stage: Production_Publish
          displayName: Prod
          dependsOn: Staging_Publish

          variables:
            - name: 'apiUrl'
              value: 'https://apiview.dev/api/'
            - name: 'hubUrl'
              value: 'https://apiview.dev/hubs/'
            - name: 'webAppUrl'
              value: 'https://apiview.dev/'

          jobs:
            - deployment: Publish_to_Prod
              displayName: Publish to Prod
              environment: 'package-publish'
              pool:
                name: azsdk-pool-mms-ubuntu-2004-general
                image: azsdk-pool-mms-ubuntu-2004-1espt
                os: linux

              strategy:
                runOnce:
                  deploy:
                    steps:
                    - checkout: self

                    - download: current
                      artifact: APIView
                      timeoutInMinutes: 5

                    - task: FileTransform@1
                      displayName: 'Update Angular Config for Environment'
                      inputs:
                        folderPath: '$(Pipeline.Workspace)/APIView/APIViewWeb.zip'
                        fileType: json
                        targetFiles: wwwroot/spa/assets/config.json

                    - task: AzureRmWebAppDeployment@4
                      displayName: 'Deploy Azure App Service'
                      inputs:
                        azureSubscription: 'APIView prod deployment'
                        appType: 'webApp'
                        WebAppName: 'APIView'
                        deployToSlotOrASE: true
                        ResourceGroupName: apiview
                        SlotName: staging
                        ScriptType: 'Inline Script'
                        packageForLinux: $(Pipeline.Workspace)/APIView/**/*.zip
                        InlineScript: |
                          @echo off
                          echo Installing .NET tool
                          call dotnet tool install --add-source ${{ parameters.AzureSdkForNetDevOpsFeed }} --version  ${{ parameters.CSharpAPIParserVersion }} --tool-path D:\home\site\wwwroot\csharp-parser CSharpAPIParser
                          echo Installing JavaScript parser
                          call npm install --prefix D:\home\site\wwwroot\js-parser ${{ parameters.JavaScriptAPIParser }} --registry ${{ parameters.JavaScriptArtifactRegistry }} 
                        enableCustomDeployment: true
                        DeploymentType: zipDeploy