wip: Refactor CI to use GitHub actions and generic bash scripts #22

.github/workflows/main.yaml

@@ -0,0 +1,23 @@
+name: ci
+on: [ push, workflow_dispatch ]
+
+jobs:
+  build:
+    name: Build
+    if: ${{ !contains(github.event.head_commit.message, 'skip build') }}
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+        with:
+          submodules: true
+      - name: Init runner
+        run: bash ./scripts/init_runner.sh ${{ github.job }}
+      - name: Setup workspace
+        env:
+          GITHUB_DEVELOPMENT_PAT: ${{ secrets.GH_DEVELOPMENT_PAT }}
+        run: bash ./scripts/setup_workspace.sh
+      - name: Build job
+        env:
+          SOPS_AGE_KEY: ${{ secrets.SOPS_AGE_KEY }}
+        run: bash ./scripts/build.sh -p -r ${{ github.job }}

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "scripts/kash"]
+	path = scripts/kash
+	url = https://github.com/kalisio/kash

scripts/build.sh

@@ -0,0 +1,78 @@
+#!/usr/bin/env bash
+set -euo pipefail
+# set -x
+
+THIS_FILE=$(readlink -f "${BASH_SOURCE[0]}")
+THIS_DIR=$(dirname "$THIS_FILE")
+ROOT_DIR=$(dirname "$THIS_DIR")
+
+. "$THIS_DIR/kash/kash.sh"
+
+## Parse options
+##
+
+PUBLISH=false
+CI_STEP_NAME="Build"
+while getopts "pr:" option; do
+    case $option in
+        p) # publish
+            PUBLISH=true
+            ;;
+        r) # report outcome to slack
+            CI_STEP_NAME=$OPTARG
+            trap 'slack_ci_report "$ROOT_DIR" "$CI_STEP_NAME" "$?" "$SLACK_WEBHOOK_JOBS"' EXIT
+            ;;
+        *)
+            ;;
+    esac
+done
+
+## Init workspace
+##
+
+WORKSPACE_DIR="$(dirname "$ROOT_DIR")"
+init_job_infos "$ROOT_DIR"
+
+JOB=$(get_job_name)
+VERSION=$(get_job_version)
+KRAWLER_VERSION=$(get_job_krawler_version)
+GIT_TAG=$(get_job_tag)
+
+if [[ -z "$GIT_TAG" ]]; then
+    echo "About to build ${JOB} development version based on krawler development version..."
+else
+    echo "About to build ${JOB} v${VERSION} based on krawler ${KRAWLER_VERSION}..."
+fi
+
+load_env_files "$WORKSPACE_DIR/development/common/kalisio_dockerhub.enc.env" "$WORKSPACE_DIR/development/common/SLACK_WEBHOOK_JOBS.enc.env"
+load_value_files "$WORKSPACE_DIR/development/common/KALISIO_DOCKERHUB_PASSWORD.enc.value"
+
+## Build container
+##
+
+# Remove trailing @ in module name
+IMAGE_NAME="kalisio/$JOB"
+if [[ -z "$GIT_TAG" ]]; then
+    IMAGE_TAG=latest
+    KRAWLER_TAG=latest
+else
+    IMAGE_TAG=$VERSION
+    KRAWLER_TAG=$KRAWLER_VERSION
+fi
+
+begin_group "Building container ..."
+
+docker login --username "$KALISIO_DOCKERHUB_USERNAME" --password-stdin < "$KALISIO_DOCKERHUB_PASSWORD"
+# DOCKER_BUILDKIT is here to be able to use Dockerfile specific dockerginore (job.Dockerfile.dockerignore)
+DOCKER_BUILDKIT=1 docker build -f dockerfile \
+    --build-arg KRAWLER_TAG=$KRAWLER_TAG \
+    -t "$IMAGE_NAME:$IMAGE_TAG" \
+    "$WORKSPACE_DIR/$JOB"
+
+if [ "$PUBLISH" = true ]; then
+    docker push "$IMAGE_NAME:$IMAGE_TAG"
+fi
+
+docker logout
+
+end_group "Building container ..."

scripts/init_runner.sh

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+set -euo pipefail
+# set -x
+
+JOB_ID=$1
+
+THIS_FILE=$(readlink -f "${BASH_SOURCE[0]}")
+THIS_DIR=$(dirname "$THIS_FILE")
+# ROOT_DIR=$(dirname "$THIS_DIR")
+
+. "$THIS_DIR/kash/kash.sh"
+
+### Github Actions
+
+init_github_build() {
+    install_reqs age sops nvm node16
+}
+
+begin_group "Init $CI_ID for $JOB_ID"
+
+init_"${CI_ID}_${JOB_ID}"
+
+end_group "Init $CI_ID for $JOB_ID"

scripts/setup_workspace.sh

@@ -0,0 +1,54 @@
+#!/usr/bin/env bash
+set -euo pipefail
+# set -x
+
+THIS_FILE=$(readlink -f "${BASH_SOURCE[0]}")
+THIS_DIR=$(dirname "$THIS_FILE")
+ROOT_DIR=$(dirname "$THIS_DIR")
+
+. "$THIS_DIR/kash/kash.sh"
+
+## Parse options
+##
+
+WORKSPACE_BRANCH=
+WORKSPACE_TAG=
+
+begin_group "Setting up workspace ..."
+
+if [ "$CI" = true ]; then
+    WORKSPACE_DIR="$(dirname "$ROOT_DIR")"
+    DEVELOPMENT_REPO_URL="https://$GITHUB_DEVELOPMENT_PAT@github.com/kalisio/development.git"
+else
+    while getopts "b:t" option; do
+        case $option in
+            b) # defines branch
+                WORKSPACE_BRANCH=$OPTARG;;
+            t) # defines tag
+                WORKSPACE_TAG=$OPTARG;;
+            *)
+            ;;
+        esac
+    done
+    shift $((OPTIND-1))
+    WORKSPACE_DIR="$1"
+
+    # NOTE: cloning krawler could be avoided if we could parse app_version from tag/branch name instead
+    # In this case, the kli would clone krawler
+    GIT_OPS="--recurse-submodules"
+    if [ -n "$WORKSPACE_TAG" ] || [ -n "$WORKSPACE_BRANCH" ]; then
+        GIT_OPS="$GIT_OPS --branch ${WORKSPACE_TAG:-$WORKSPACE_BRANCH}"
+    fi
+    git clone --depth 1 $GIT_OPS "$GITHUB_URL/kalisio/k-openaq.git" "$WORKSPACE_DIR/k-openaq"
+
+    DEVELOPMENT_REPO_URL="$GITHUB_URL/kalisio/development.git"
+
+    # unset KALISIO_DEVELOPMENT_DIR because we want kli to clone everything in $WORKSPACE_DIR
+    unset KALISIO_DEVELOPMENT_DIR
+fi
+
+# clone development in $WORKSPACE_DIR
+DEVELOPMENT_DIR="$WORKSPACE_DIR/development"
+git clone --depth 1 "$DEVELOPMENT_REPO_URL" "$DEVELOPMENT_DIR"
+
+end_group "Setting up workspace ..."