.github/workflows/ci-cd.yaml

# Copyright Jiaqi Liu
#
# 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: CI/CD

"on":
  pull_request:
  push:
    branches:
      - master

env:
  PYTHON_VERSION: "3.10"
  NEO4J_ENTERPRISE_VERSION: 5.23.0-enterprise
  NEO4J_URI: neo4j://localhost:7687
  NEO4J_DATABASE: neo4j
  NEO4J_USERNAME: not used
  NEO4J_PASSWORD: not used

jobs:
  cancel-previous:
    name: Cancel Previous Runs In Order to Allocate Action Resources Immediately for Current Run
    if: github.ref != 'refs/heads/master'
    runs-on: ubuntu-latest
    steps:
      - name: Cancel previous
        uses: styfle/cancel-workflow-action@0.10.1
        with:
          access_token: ${{ github.token }}

  yaml-lint:
    name: YAML Style Check
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actionshub/yamllint@main

  markdown-lint:
    name: Markdown Style Check
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actionshub/markdownlint@main

  linkChecker:
    name: Link Check
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Link Checker
        uses: lycheeverse/lychee-action@v1.9.0
        with:
          fail: true

  tests:
    needs: [yaml-lint, markdown-lint, linkChecker]
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        language: [
          {
            name: German,
            load-script: .github/load_german.py
          },
          {
            name: Ancient Greek,
            load-script: .github/load_ancient_greek.py
          },
          {
            name: Latin,
            load-script: .github/load_latin.py
          },
          {
            name: all languages (race condition test ①),
            load-script: .github/load_all_in_parallel.py
          },
          {
            name: all languages (race condition test ②),
            load-script: .github/load_all_in_parallel.py
          },
          {
            name: all languages (race condition test ③),
            load-script: .github/load_all_in_parallel.py
          },
          {
            name: all languages (race condition test ④),
            load-script: .github/load_all_in_parallel.py
          },
          {
            name: all languages (race condition test ⑤),
            load-script: .github/load_all_in_parallel.py
          },
          {
            name: all languages (race condition test ⑥),
            load-script: .github/load_all_in_parallel.py
          },
          {
            name: all languages (race condition test ⑦),
            load-script: .github/load_all_in_parallel.py
          },
          {
            name: all languages (race condition test ⑧),
            load-script: .github/load_all_in_parallel.py
          },
          {
            name: all languages (race condition test ⑨),
          },
          {
            name: all languages (race condition test ⑩),
            load-script: .github/load_all_in_parallel.py
          }
        ]
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0
      - name: Set up Python ${{ env.PYTHON_VERSION }}
        uses: actions/setup-python@v4
        with:
          python-version: ${{ env.PYTHON_VERSION }}
      - name: Startup a Neo4J database
        run: docker run --publish=7474:7474 --publish=7687:7687 --env=NEO4J_AUTH=none --env=NEO4J_ACCEPT_LICENSE_AGREEMENT=yes neo4j:${{ env.NEO4J_ENTERPRISE_VERSION }} &
      - name: Wait for database to be ready
        uses: iFaxity/wait-on-action@v1
        with:
          resource: http://localhost:7474
      - name: Test loading ${{ matrix.language.name }}
        run: |
          pip3 install --upgrade --force-reinstall wilhelm-python-sdk
          python3 ${{ matrix.language.load-script }}
        env:
          NEO4J_URI: ${{ env.NEO4J_URI }}
          NEO4J_DATABASE: ${{ env.NEO4J_DATABASE }}
          NEO4J_USERNAME: ${{ env.NEO4J_USERNAME }}
          NEO4J_PASSWORD: ${{ env.NEO4J_PASSWORD }}

  docker:
    name: Test Docker build and publish image to DockerHub
    needs: [yaml-lint, markdown-lint, linkChecker]
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0
      - name: Set up Python ${{ env.PYTHON_VERSION }}
        uses: actions/setup-python@v4
        with:
          python-version: ${{ env.PYTHON_VERSION }}
      - name: Startup a Neo4J database
        run: docker run --publish=7474:7474 --publish=7687:7687 --env=NEO4J_AUTH=none --name data-loader --env=NEO4J_ACCEPT_LICENSE_AGREEMENT=yes neo4j:${{ env.NEO4J_ENTERPRISE_VERSION }} &
      - name: Wait for database to be ready
        uses: iFaxity/wait-on-action@v1
        with:
          resource: http://localhost:7474
      - name: Load all languages into the intermediate container
        run: |
          pip3 install --upgrade --force-reinstall wilhelm-python-sdk
          python3 .github/load_german.py
          python3 .github/load_ancient_greek.py
          python3 .github/load_latin.py
        env:
          NEO4J_URI: ${{ env.NEO4J_URI }}
          NEO4J_DATABASE: ${{ env.NEO4J_DATABASE }}
          NEO4J_USERNAME: ${{ env.NEO4J_USERNAME }}
          NEO4J_PASSWORD: ${{ env.NEO4J_PASSWORD }}
      - name: Copy over data onto host
        run: docker cp data-loader:/data .
      - name: Test image build
        uses: docker/build-push-action@v3
        with:
          context: .
          push: false
      - name: Login to DockerHub
        if: github.ref == 'refs/heads/master'
        uses: docker/login-action@v2
        with:
          username: ${{ secrets.DOCKERHUB_USERNAME }}
          password: ${{ secrets.DOCKERHUB_TOKEN }}
      - name: Push image to DockerHub
        if: github.ref == 'refs/heads/master'
        uses: docker/build-push-action@v3
        with:
          context: .
          push: true
          tags: ${{ secrets.DOCKERHUB_USERNAME }}/wilhelm-vocabulary:latest
      - name: Push image Description
        if: github.ref == 'refs/heads/master'
        uses: peter-evans/dockerhub-description@v4
        with:
          username: jack20191124
          password: ${{ secrets.DOCKERHUB_TOKEN }}
          repository: ${{ secrets.DOCKERHUB_USERNAME }}/wilhelm-vocabulary
          readme-filepath: README.md

  cleanup-neo4j:
    if: github.ref == 'refs/heads/master'
    needs: [tests, docker]
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0
      - name: Set up Python ${{ env.PYTHON_VERSION }}
        uses: actions/setup-python@v4
        with:
          python-version: ${{ env.PYTHON_VERSION }}
      - name: Cleanup
        run: |
          pip3 install --upgrade --force-reinstall wilhelm-python-sdk
          python3 .github/cleanup_neo4j.py
        env:
          NEO4J_URI: ${{ secrets.NEO4J_URI }}
          NEO4J_DATABASE: ${{ secrets.NEO4J_DATABASE }}
          NEO4J_USERNAME: ${{ secrets.NEO4J_USERNAME }}
          NEO4J_PASSWORD: ${{ secrets.NEO4J_PASSWORD }}

  load-vocabulary:
    name: Load ${{ matrix.language.name }} vocabularies
    if: github.ref == 'refs/heads/master'
    needs: cleanup-neo4j
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        language: [
          {
            name: German,
            load-script: .github/load_german.py
          },
          {
            name: Ancient Greek,
            load-script: .github/load_ancient_greek.py
          },
          {
            name: Latin,
            load-script: .github/load_latin.py
          }
        ]
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0
      - name: Set up Python ${{ env.PYTHON_VERSION }}
        uses: actions/setup-python@v4
        with:
          python-version: ${{ env.PYTHON_VERSION }}
      - name: Load ${{ matrix.language.name }}
        run: |
          pip3 install --upgrade --force-reinstall wilhelm-python-sdk
          python3 ${{ matrix.language.load-script }}
        env:
          NEO4J_URI: ${{ secrets.NEO4J_URI }}
          NEO4J_DATABASE: ${{ secrets.NEO4J_DATABASE }}
          NEO4J_USERNAME: ${{ secrets.NEO4J_USERNAME }}
          NEO4J_PASSWORD: ${{ secrets.NEO4J_PASSWORD }}

  sync-to-huggingface-space:
    if: github.ref == 'refs/heads/master'
    needs: tests
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0
          lfs: true
      - name: Push to hub
        run: git push https://QubitPi:$HF_TOKEN@huggingface.co/datasets/QubitPi/wilhelm-vocabulary master:main -f
        env:
          HF_TOKEN: ${{ secrets.HF_TOKEN }}