ci-build.yml

name: CI Build

on:
  pull_request:
  push:
    branches:
      - main
      - develop

jobs:
  lint-and-unit-test:
    name: Lint & Unit Tests
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repo
        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4

      - name: Setup Node.js
        uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4
        with:
          node-version: 20
          cache: 'yarn'

      - name: Install dependencies
        run: |
          sudo apt-get install libgconf-2-4
          yarn --immutable

      - name: Run linting
        run: yarn lint

      - name: Run unit tests
        run: yarn test

      - name: Upload coverage reports to Codecov
        if: success()
        uses: codecov/codecov-action@84508663e988701840491b86de86b666e8a86bed # v4
        with:
          token: ${{ secrets.CODECOV_TOKEN }}

  e2e-tests:
    name: End-to-End (with mock data) Tests
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repo
        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4

      - name: Setup Node.js
        uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4
        with:
          node-version: 20
          cache: 'yarn'

      - name: Install dependencies
        run: |
          sudo apt-get install libgconf-2-4
          yarn --immutable

      - name: Run e2e tests
        run: yarn e2e

      - name: Upload Cypress screenshots
        if: failure()
        uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4
        with:
          name: Inventory management system Screenshots
          path: cypress/screenshots

  e2e-tests-api:
    name: End-to-End (with api) Tests
    runs-on: ubuntu-latest

    services:
      ims-api:
        image: harbor.stfc.ac.uk/inventory-management-system/ims-api:develop
        ports:
          - 8000:8000
        env:
          AUTHENTICATION__ENABLED: false
          API__TITLE: Inventory Management System API
          API__DESCRIPTION: This is the API for the Inventory Management System
          API__ROOT_PATH: /inventory-management-system-api
          DATABASE__PROTOCOL: mongodb
          DATABASE__USERNAME: root
          DATABASE__PASSWORD: example
          DATABASE__HOSTNAME: mongodb
          DATABASE__PORT: 27017
          DATABASE__NAME: ims
          API__ALLOWED_CORS_HEADERS: '["*"]'
          API__ALLOWED_CORS_ORIGINS: '["*"]'
          API__ALLOWED_CORS_METHODS: '["*"]'

          options: --name inventory-management-system-api

    steps:
      - name: Clone api repo
        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11
        with:
          repository: ral-facilities/inventory-management-system-api
          ref: add-common-dev-task-script-#235

      - name: Set up Python
        uses: actions/setup-python@0a5c61591373683505ea898e09a3ea4f39ef2b9c # v5.0.0
        with:
          python-version: '3.12'
          cache: 'pip'

      - name: Setup MongoDB
        run: |
          python ./scripts/dev_cli.py db-init --replicaSetMemberHost localhost
          python ./scripts/dev_cli.py db-import

      - name: Checkout repo
        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4

      - name: Setup Node.js
        uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4
        with:
          node-version: 20
          cache: 'yarn'

      - name: Install dependencies
        run: |
          sudo apt-get install libgconf-2-4
          yarn --immutable

      - name: Run e2e tests
        run: yarn e2e:api

      - name: Upload Cypress screenshots
        if: failure()
        uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4
        with:
          name: Inventory management system (with api) Screenshots
          path: cypress/screenshots

  docker:
    # This job triggers only if all the other jobs succeed. It builds the Docker image and if successful,
    # it pushes it to Harbor.
    needs: [lint-and-unit-test, e2e-tests, e2e-tests-api]
    name: Docker
    runs-on: ubuntu-latest
    steps:
      - name: Check out repo
        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1

      - name: Login to Harbor
        uses: docker/login-action@e92390c5fb421da1463c202d546fed0ec5c39f20 # v3.1.0
        with:
          registry: ${{ secrets.HARBOR_URL }}
          username: ${{ secrets.HARBOR_USERNAME }}
          password: ${{ secrets.HARBOR_TOKEN }}

      - name: Extract metadata (tags, labels) for Docker
        id: meta
        uses: docker/metadata-action@dbef88086f6cef02e264edb7dbf63250c17cef6c # v5.5.0
        with:
          images: ${{ secrets.HARBOR_URL }}/ims

      - name: Build and push Docker image to Harbor
        uses: docker/build-push-action@2cdde995de11925a030ce8070c3d77a52ffcf1c0 # v5.3.0
        with:
          context: .
          file: ./Dockerfile.prod
          push: true
          tags: ${{ steps.meta.outputs.tags }}
          labels: ${{ steps.meta.outputs.labels }}