ArchiveBox/.github/workflows/test.yml

name: Test workflow
on: [push]

env:
  MAX_LINE_LENGTH: 110

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2

      - name: Set up Python
        uses: actions/setup-python@v1
        with:
          python-version: 3.8
          architecture: x64

      - name: Install flake8
        run: |
          pip install flake8          

      - name: Lint with flake8
        run: |
          # one pass for show-stopper syntax errors or undefined names
          flake8 archivebox --count --show-source --statistics
          # one pass for small stylistic things
          flake8 archivebox --count --max-line-length="$MAX_LINE_LENGTH" --statistics          

      # - name: Lint with mypy
      #   run: |
      #     pip install mypy
      #     mypy archivebox || true

  test:
    runs-on: ${{ matrix.os }}

    strategy:
      matrix:
        os: [ubuntu-latest, macos-latest]
        python: [3.7, 3.8]

    steps:
      - uses: actions/checkout@v2
        with:
          fetch-depth: 1

      - name: Set up Python ${{ matrix.python }}
        uses: actions/setup-python@v1
        with:
          python-version: ${{ matrix.python }}
          architecture: x64

      - name: Cache virtualenv
        uses: actions/cache@v2
        id: cache-venv
        with:
          path: .venv
          key: ${{ runner.os }}-${{ matrix.python }}-venv-${{ hashFiles('setup.py') }}
          restore-keys: |
            ${{ runner.os }}-${{ matrix.python }}-venv-            

      - name: Create virtualenv
        if: steps.cache-venv.outputs.cache-hit != 'true'
        run: |
          python3 -m venv .venv
          source .venv/bin/activate
          python3 -m pip install --upgrade pip setuptools          

      - name: Install dependencies
        run: |
          source .venv/bin/activate
          python -m pip install .
          python -m pip install pytest bottle          

      - name: Test built package with pytest
        run: |
          source .venv/bin/activate
          python -m pytest -s          

  docker-test:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v2
        with:
          fetch-depth: 1

      - uses: satackey/action-docker-layer-caching@v0.0.4

      - name: Build image
        run: |
          docker build . -t archivebox          

      - name: Init data dir
        run: |
          mkdir data
          docker run -v "$PWD"/data:/data archivebox init          

      - name: Run test server
        run: |
          sudo bash -c 'echo "127.0.0.1  www.test-nginx-1.local www.test-nginx-2.local" >> /etc/hosts'
          docker run --name www-nginx -p 80:80 -d nginx          

      - name: Add link
        run: |
          docker run -v "$PWD"/data:/data --network host archivebox add http://www.test-nginx-1.local          

      - name: Add stdin link
        run: |
          echo "http://www.test-nginx-2.local" | docker run -i -v "$PWD"/data:/data archivebox add          

      - name: List links
        run: |
          docker run -v "$PWD"/data:/data archivebox list | grep -q "www.test-nginx-1.local" || { echo "The site 1 isn't in the list"; exit 1; }
          docker run -v "$PWD"/data:/data archivebox list | grep -q "www.test-nginx-2.local" || { echo "The site 2 isn't in the list"; exit 1; }          


      - name: Start docker-compose stack
        run: |
          docker-compose run archivebox init
          docker-compose up -d
          sleep 4
          curl --silent --location 'http://127.0.0.1:8000/static/admin/js/jquery.init.js' | grep 'django.jQuery'          

      - name: Check added urls show up in index
        run: |
          docker-compose run archivebox add 'http://example.com/#test_docker' --index-only
          curl --silent --location 'http://127.0.0.1:8000' | grep 'http://example.com/#test_docker'          

      - name: Curl index with PUBLIC_INDEX=False
        run: |
          docker-compose run archivebox config --set PUBLIC_INDEX=False
          docker-compose up -d || true
          sleep 8
          curl --silent --location 'http://127.0.0.1:8000' | grep 'Log in'
          docker-compose down          

      - name: Curl index with PUBLIC_INDEX=True
        run: |
          docker-compose run archivebox config --set PUBLIC_INDEX=True
          docker-compose up -d || true
          sleep 8
          curl --silent --location 'http://127.0.0.1:8000' | grep 'Add Links'
          docker-compose down