pr-request.yaml

# Copyright 2024 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

name: PR Tests

on:
  pull_request:
    branches:
      - 'main'
      - epic/**

jobs:
  markdownlint:
    runs-on: ubuntu-latest
    steps:
      - name: Check out repository
        uses: actions/checkout@v4

      - name: Run markdownlint
        uses: DavidAnson/markdownlint-cli2-action@30a0e04f1870d58f8d717450cc6134995f993c63 # 19.1.0

  backend-tests:
    runs-on: ubuntu-latest
    permissions:
      contents: 'read'
      id-token: 'write'
    steps:
    - name: Checkout
      uses: actions/checkout@v4

    - name: Set up Go
      uses: actions/setup-go@v5
      with:
        go-version-file: './go.mod'

    # TODO: Configure Github Action after getting the Workload Identity Pool for this project
    # https://github.com/GoogleCloudPlatform/khi/issues/29
    # - name: Authenticate to Google Cloud
    #   uses: google-github-actions/auth@v2
    #   with:
    #     workload_identity_provider: ${{ secrets.WORKLOAD_IDENTITY_PROVIDER }}
    #     project_id: ${{ secrets.GCP_PROJECT_ID }}

    # - name: Install gcloud CLI and get token
    #   uses: google-github-actions/setup-gcloud@v2

    # - name: Get gcloud token
    #   id: gcloud-token
    #   run: |
    #     echo "#!/bin/bash\necho \"$(gcloud auth print-access-token)\"" > /usr/bin/gcloud
    #     chmod +x /usr/bin/gcloud

    # - name: Backend Test
    #   run: |
    #     mkdir ./pkg/server/dist
    #     # A placeholder frontend code read from backend test
    #     echo "" > ./pkg/server/dist/index.html
    #     make coverage-go

    # For now, we skip the cloud logging test
    # TODO: Remove the flag after the cloud logging test is ready
    - name: Backend Test
      run: |
        make generate-backend
        mkdir -p pkg/server/dist/session
        # A placeholder frontend code read from backend test
        echo '<!--INJECT GENERATED CODE HERE FROM BACKEND-->' > ./pkg/server/dist/index.html
        go test ./... -args -skip-cloud-logging=true
    - name: Backend Format and Lint Check
      run: |
        make check-format-go
    - name: Run golangci-lint
      uses: golangci/golangci-lint-action@4afd733a84b1f43292c63897423277bb7f4313a9 # v8.0.0
      with:
        version: v2.1.6
        args: --config=.golangci.yaml
    - name: Prepare depguard config for golangci-lint
      run: make generate-depguard-rules
    - name: Check for diff in depguard config
      run: git diff --exit-code .generated-golangci-depguard.yaml
    - name: Run golangci-lint for depguard
      uses: golangci/golangci-lint-action@4afd733a84b1f43292c63897423277bb7f4313a9 # v8.0.0
      with:
        version: v2.1.6
        args: --config=.generated-golangci-depguard.yaml --issues-exit-code=0 # This check is currently optional. Remove `--issues-exit-code=0` once issues are fixed.

  frontend-tests:
    runs-on: ubuntu-latest
    permissions:
      contents: 'read'
    steps:
    - name: Checkout
      uses: actions/checkout@v4

    - name: Set up Node.js
      uses: actions/setup-node@v4
      with:
        node-version-file: './.node-version'

    - name: Set up Go # Go dependency is needed for `make prepare-frontend`
      uses: actions/setup-go@v5
      with:
        go-version-file: './go.mod'

    - name: Install jq
      run: sudo apt-get update && sudo apt-get install -y jq

    - name: npm install
      working-directory: ./web
      run: npm ci

    - name: Generate frontend codes
      run: make prepare-frontend

    - name: Install Chrome for Angular Test
      uses: browser-actions/setup-chrome@c785b87e244131f27c9f19c1a33e2ead956ab7ce # 1.7.3
      with:
        chrome-version: stable

    - name: Angular Test
      run: make coverage-web

    - name: Frontend Format and Lint Check
      run: |
        make check-format-web
        make lint-web

  build-frontend:
    runs-on: ubuntu-latest
    permissions:
      contents: 'read'
    strategy:
      matrix:
        configuration: [prod, dev]
    steps:
    - name: Checkout
      uses: actions/checkout@v4

    - name: Set up Node.js
      uses: actions/setup-node@v4
      with:
        node-version-file: './.node-version'

    - name: Set up Go # Go dependency is needed for `make prepare-frontend`
      uses: actions/setup-go@v5
      with:
        go-version-file: './go.mod'

    - name: npm install
      working-directory: ./web
      run: npm ci

    - name: Generate frontend codes
      run: make prepare-frontend

    - name: Build web
      working-directory: ./web
      run: npx ng build --configuration ${{ matrix.configuration }}

  license-header-check:
    runs-on: ubuntu-latest
    permissions:
      contents: read
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Set up Go
        uses: actions/setup-go@v5
        with:
          go-version-file: './go.mod'

      - name: Install addlicense package
        run: go install github.com/google/addlicense@latest

      - name: Run addlicense
        id: license_header_check
        run: addlicense  -c "Google LLC" -l apache -v -check .