outline-server/.github/workflows/build_and_test_debug.yml

# Copyright 2024 The Outline Authors
#
# 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: Build and Test

concurrency:
  group: ${{ github.head_ref || github.ref }}
  cancel-in-progress: true

on:
  pull_request:
    types:
      - opened
      - synchronize
  push:
    branches:
      - master
  schedule:
    - cron: "0 13 * * *"  # Run daily at 1PM UTC.

jobs:
  lint:
    name: Lint
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2.3.4

      - name: Install Node
        uses: actions/setup-node@v3
        with:
          node-version: 18
          cache: npm

      - name: Install Go
        uses: actions/setup-go@v5
        with:
          go-version-file: go.mod
          cache: false

      - name: Install NPM Dependencies
        run: npm ci
        env:
          PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: 'true'

      - name: Lint
        run: ./task lint

  shadowbox:
    name: Shadowbox
    runs-on: ubuntu-latest
    needs: lint
    steps:
      - name: Checkout
        uses: actions/checkout@v2.3.4

      - name: Install Node
        uses: actions/setup-node@v3
        with:
          node-version: 18
          cache: npm

      - name: Install NPM Dependencies
        run: npm ci

      - name: Shadowbox Debug Build
        run: ./task shadowbox:build

      - name: Shadowbox Unit Test
        run: ./task shadowbox:test

      - name: Shadowbox Integration Test
        run: ./task shadowbox:integration_test

      - name: Verify Open API Spec
        uses: mbowman100/swagger-validator-action@master
        with:
          files: |
            src/shadowbox/server/api.yml

  shadowbox-arm64:
    name: Shadowbox (arm64)
    runs-on: ubuntu-22.04-arm
    needs: lint
    steps:
      - name: Checkout
        uses: actions/checkout@v2.3.4

      - name: Install Node
        uses: actions/setup-node@v3
        with:
          node-version: 18
          cache: npm

      - name: Install Go
        uses: actions/setup-go@v5
        with:
          go-version-file: go.mod
          cache: false

      - name: Install NPM Dependencies
        run: npm ci
        env:
          PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: 'true'

      - name: Shadowbox Debug Build (arm64)
        run: TARGET_ARCH=aarch64 ./task shadowbox:build

      - name: Shadowbox Unit Test
        run: ./task shadowbox:test

      - name: Shadowbox Docker Build (arm64)
        run: TARGET_ARCH=aarch64 ./task shadowbox:docker:build

  manual-install-script:
    name: Manual Install Script
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2.3.4

      - name: Install Outline Server
        run: ./src/server_manager/install_scripts/install_server.sh --hostname localhost

      - name: Test API
        run: 'curl --silent --fail --insecure $(grep "apiUrl" /opt/outline/access.txt | cut -d: -f 2-)/server'

  metrics-server:
    name: Metrics Server
    runs-on: ubuntu-latest
    needs: lint
    steps:
      - name: Checkout
        uses: actions/checkout@v2.3.4

      - name: Install Node
        uses: actions/setup-node@v3
        with:
          node-version: 18
          cache: npm

      - name: Install NPM Dependencies
        run: npm ci

      - name: Metrics Server Debug Build
        run: ./task metrics_server:build

      - name: Metrics Server Test
        run: ./task metrics_server:test

  sentry-webhook:
    name: Sentry Webhook
    # TODO(puppeteer/puppeteer#12818): Update when chromium bug is resolved.
    runs-on: ubuntu-22.04
    needs: lint
    steps:
      - name: Checkout
        uses: actions/checkout@v2.3.4

      - name: Install Node
        uses: actions/setup-node@v3
        with:
          node-version: 18
          cache: npm

      - name: Install NPM Dependencies
        run: npm ci

      - name: Sentry Webhook Debug Build
        run: ./task sentry_webhook:build

      - name: Sentry Webhook Test
        run: ./task sentry_webhook:test