build.yml

name: Build and Test

on:
  push:
    branches: master
  pull_request:
    branches: "*"

jobs:
  build:
    name: Build tljh_repo2docker
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Install Conda environment with Micromamba
        uses: mamba-org/setup-micromamba@v1
        with:
          environment-name: tljh
          micromamba-version: "1.5.5-0"
          init-shell: bash
          create-args: >-
            python=3.10
            nodejs=18
            yarn=3

      - name: Setup pip cache
        uses: actions/cache@v2
        with:
          path: ~/.cache/pip
          key: pip-3.10-${{ hashFiles('setup.py') }}
          restore-keys: |
            pip-3.10-
            pip-

      - name: Get yarn cache directory path
        id: yarn-cache-dir-path
        run: echo "::set-output name=dir::$(yarn cache dir)"

      - name: Setup yarn cache
        uses: actions/cache@v2
        id: yarn-cache
        with:
          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
          key: yarn-${{ hashFiles('frontend/yarn.lock') }}
          restore-keys: |
            yarn-

      - name: Package the application
        shell: bash -l {0}
        run: |
          set -eux
          python -m pip install build
          python -m build .

      - name: Upload package
        uses: actions/upload-artifact@v3
        with:
          name: tljh_repo2docker-artifacts
          path: |
            dist/tljh_repo2docker*.whl
          if-no-files-found: error

  isolated-tests:
    name: Isolated tests
    needs: build
    runs-on: ubuntu-latest

    steps:
      - name: Install Python
        uses: actions/setup-python@v4
        with:
          python-version: "3.10"
          architecture: "x64"

      - uses: actions/download-artifact@v3
        with:
          name: tljh_repo2docker-artifacts

      - name: Install and Test
        run: |
          set -eux
          # Remove NodeJS, twice to take care of system and locally installed node versions.
          sudo rm -rf $(which node)
          sudo rm -rf $(which node)

          python -m pip install git+https://github.com/jupyterhub/the-littlest-jupyterhub tljh_repo2docker*.whl

      - name: Test import
        shell: bash -l {0}
        run: python -c "import tljh_repo2docker"

  unit-tests:
    name: Unit tests
    needs: build
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        python-version: ["3.8", "3.9", "3.10"]
        jupyterhub-version: [latest, 1.2.2]

    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Set up Python ${{ matrix.python-version }}
        uses: mamba-org/setup-micromamba@v1
        with:
          micromamba-version: "1.5.5-0"
          environment-name: tljh
          init-shell: bash
          create-args: >-
            python=${{ matrix.python-version }}
            nodejs=18
            yarn=3

      - name: Download app package
        uses: actions/download-artifact@v3
        with:
          name: tljh_repo2docker-artifacts

      - name: Install package
        shell: bash -l {0}
        run: |
          set -eux
          python -m pip install -r dev-requirements.txt
          python -m pip install tljh_repo2docker*.whl
          npm -g install configurable-http-proxy

      - name: Upgrade jupyterhub
        if: ${{ matrix.jupyterhub-version == 'latest' }}
        run: |
          python -m pip install -U 'jupyterhub'

      - name: Downgrade jupyterhub
        if: ${{ matrix.jupyterhub-version != 'latest' }}
        run: |
          python -m pip install -U 'jupyterhub==${{ matrix.jupyterhub-version }}'

      - name: Run Tests
        run: |
          python -m pytest --cov

  integration-tests:
    name: Integration tests
    needs: build
    runs-on: ubuntu-latest

    env:
      PLAYWRIGHT_BROWSERS_PATH: ${{ github.workspace }}/pw-browsers

    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Install Conda environment with Micromamba
        uses: mamba-org/setup-micromamba@v1
        with:
          micromamba-version: "1.5.5-0"
          environment-name: tljh
          init-shell: bash
          create-args: >-
            python=3.10
            nodejs=18
            yarn=3

      - name: Download app package
        uses: actions/download-artifact@v3
        with:
          name: tljh_repo2docker-artifacts

      - name: Install package
        shell: bash -l {0}
        run: |
          set -eux
          python -m pip install -r dev-requirements.txt
          python -m pip install tljh_repo2docker*.whl
          npm -g install configurable-http-proxy

      - name: Install UI test dependencies
        shell: bash -l {0}
        working-directory: frontend/ui-tests
        env:
          PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: 1
        run: yarn install

      - name: Set up browser cache
        uses: actions/cache@v3
        with:
          path: |
            ${{ github.workspace }}/pw-browsers
          key: ${{ runner.os }}-${{ hashFiles('frontend/ui-tests/yarn.lock') }}

      - name: Install browser
        shell: bash -l {0}
        run: npx playwright install chromium
        working-directory: frontend/ui-tests

      - name: Start JupyterHub
        shell: bash -l {0}
        run: |
          python -m jupyterhub -f ./jupyterhub_config.py &

      - name: Wait for JupyterHub
        uses: ifaxity/wait-on-action@v1
        with:
          resource: http-get://localhost:8000
          timeout: 360000

      - name: Execute integration tests
        shell: bash -l {0}
        working-directory: frontend/ui-tests
        run: |
          npx playwright test

      - name: Upload Playwright Test report
        if: always()
        uses: actions/upload-artifact@v3
        with:
          name: tljh-playwright-tests
          path: |
            frontend/ui-tests/test-results
            frontend/ui-tests/playwright-report