TD-129: Add multiplatform build and CI checks (#6)

* TD-129: Add multiplatform build and CI checks * Add qemu setup * Add covertool * Migrate relevant changes from PM
2024-11-06 02:25:17 +00:00 · 2022-02-11 14:38:49 +03:00 · 2022-02-11 14:38:49 +03:00 · 0b47590a7d
commit 0b47590a7d
parent d3f2615967
9 changed files with 168 additions and 47 deletions
--- a/.env
+++ b/.env
@ -1,6 +1,7 @@
 # NOTE
 # You SHOULD specify point releases here so that build time and run time Erlang/OTPs
 # are the same. See: https://github.com/erlware/relx/pull/902
-ERLANG_VERSION=24.2.0
+SERVICE_NAME=dominant
+OTP_VERSION=24.2.0
+REBAR_VERSION=3.18
 THRIFT_VERSION=0.14.2.2
-SERVICE=dominant
--- a/.github/workflows/build-and-push-image.yaml
+++ b/.github/workflows/build-and-push-image.yaml
@ -0,0 +1,54 @@
+name: Build and push Docker image
+on:
+  push:
+    branches: [master]
+
+env:
+  REGISTRY: ghcr.io
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@v1
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Construct tags / labels for an image
+        id: meta
+        uses: docker/metadata-action@v3
+        with:
+          images: |
+            ${{ env.REGISTRY }}/${{ github.repository }}
+          tags: |
+            type=sha
+
+      # https://docs.github.com/en/actions/learn-github-actions/workflow-commands-for-github-actions#setting-an-environment-variable
+      - name: Update environment variables
+        run: grep -v '^#' .env >> $GITHUB_ENV
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v1
+
+      - name: Setup Buildx
+        uses: docker/setup-buildx-action@v1
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v2
+        with:
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          platforms: linux/amd64,linux/arm64
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+          build-args: |
+            OTP_VERSION=${{ env.OTP_VERSION }}
+            THRIFT_VERSION=${{ env.THRIFT_VERSION }}
+            SERVICE_NAME=${{ env.SERVICE_NAME }}
--- a/.github/workflows/build-image.yaml
+++ b/.github/workflows/build-image.yaml
@ -1,7 +1,5 @@
 name: Build Docker image
 on:
-  push:
-    branches: [master]
  pull_request:
    branches: ["*"]

@ -15,16 +13,9 @@ jobs:
      - name: Checkout code
        uses: actions/checkout@v2

-      - name: Log in to the Container registry
-        uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9
-        with:
-          registry: ghcr.io
-          username: ${{ github.actor }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-
      - name: Construct tags / labels for an image
        id: meta
-        uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38
+        uses: docker/metadata-action@v3
        with:
          images: |
            ${{ env.REGISTRY }}/${{ github.repository }}
@ -38,13 +29,15 @@ jobs:
      - name: Setup Buildx
        uses: docker/setup-buildx-action@v1

-      - name: Build and push Docker image
-        uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc
+      - name: Build Docker image
+        uses: docker/build-push-action@v2
        with:
-          push: ${{ github.event_name == 'push' }}
+          push: false
          tags: ${{ steps.meta.outputs.tags }}
          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
          build-args: |
-            ERLANG_VERSION=${{ env.ERLANG_VERSION }}
+            OTP_VERSION=${{ env.OTP_VERSION }}
            THRIFT_VERSION=${{ env.THRIFT_VERSION }}
-            SERVICE=${{ env.SERVICE }}
+            SERVICE_NAME=${{ env.SERVICE_NAME }}
--- a/.github/workflows/erlang-checks.yaml
+++ b/.github/workflows/erlang-checks.yaml
@ -0,0 +1,39 @@
+name: Erlang CI Checks
+
+on:
+  push:
+    branches:
+      - 'master'
+      - 'epic/**'
+  pull_request:
+    branches: [ '**' ]
+
+jobs:
+  setup:
+    name: Load .env
+    runs-on: ubuntu-latest
+    outputs:
+      otp-version: ${{ steps.otp-version.outputs.version }}
+      rebar-version: ${{ steps.rebar-version.outputs.version }}
+      thrift-version: ${{ steps.thrift-version.outputs.version }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+      - run: grep -v '^#' .env >> $GITHUB_ENV
+      - id: otp-version
+        run: echo "::set-output name=version::$OTP_VERSION"
+      - id: rebar-version
+        run: echo "::set-output name=version::$REBAR_VERSION"
+      - id: thrift-version
+        run: echo "::set-output name=version::$THRIFT_VERSION"
+
+  run:
+    name: Run checks
+    needs: setup
+    uses: valitydev/erlang-workflows/.github/workflows/erlang-parallel-build.yml@v1.0.1
+    with:
+      otp-version: ${{ needs.setup.outputs.otp-version }}
+      rebar-version: ${{ needs.setup.outputs.rebar-version }}
+      use-thrift: true
+      thrift-version: ${{ needs.setup.outputs.thrift-version }}
+      run-ct-with-compose: true
--- a/36
+++ b/36
@ -1,24 +1,42 @@
-ARG ERLANG_VERSION
+ARG OTP_VERSION

-FROM erlang:${ERLANG_VERSION} AS builder
+# Build the release
+FROM docker.io/library/erlang:${OTP_VERSION} AS builder

+# Install thrift compiler
 ARG THRIFT_VERSION
-ARG BUILDARCH
-RUN wget -q -O- "https://github.com/valitydev/thrift/releases/download/${THRIFT_VERSION}/thrift-${THRIFT_VERSION}-linux-${BUILDARCH}.tar.gz" \
+
+ARG TARGETARCH
+RUN wget -q -O- "https://github.com/valitydev/thrift/releases/download/${THRIFT_VERSION}/thrift-${THRIFT_VERSION}-linux-${TARGETARCH}.tar.gz" \
    | tar -xvz -C /usr/local/bin/

+# Copy sources
 RUN mkdir /build
 COPY . /build/
+
+# Build the release
 WORKDIR /build
 RUN rebar3 compile
 RUN rebar3 as prod release

-FROM erlang:${ERLANG_VERSION}-slim
-ARG SERVICE
+# Make a runner image
+FROM docker.io/library/erlang:${OTP_VERSION}-slim
+
+ARG SERVICE_NAME
+
+# Set env
 ENV CHARSET=UTF-8
 ENV LANG=C.UTF-8
-COPY --from=builder /build/_build/prod/rel/${SERVICE} /opt/${SERVICE}
-WORKDIR /opt/${SERVICE}
+
+# Expose SERVICE_NAME as env so CMD expands properly on start
+ENV SERVICE_NAME=${SERVICE_NAME}
+
+# Set runtime
+WORKDIR /opt/${SERVICE_NAME}
+
+COPY --from=builder /build/_build/prod/rel/${SERVICE_NAME} /opt/${SERVICE_NAME}
+
 ENTRYPOINT []
-CMD /opt/${SERVICE}/bin/${SERVICE} foreground
+CMD /opt/${SERVICE_NAME}/bin/${SERVICE_NAME} foreground
+
 EXPOSE 8022
--- a/Dockerfile.dev
+++ b/Dockerfile.dev
@ -1,6 +1,6 @@
-ARG ERLANG_VERSION
+ARG OTP_VERSION

-FROM docker.io/library/erlang:${ERLANG_VERSION}
+FROM docker.io/library/erlang:${OTP_VERSION}

 ARG THRIFT_VERSION
 ARG BUILDARCH
--- a/48
+++ b/48
@ -13,14 +13,14 @@
 DOTENV := $(shell grep -v '^\#' .env)

 # Development images
-
-DEV_IMAGE_TAG = $(SERVICE)-dev
+DEV_IMAGE_TAG = $(TEST_CONTAINER_NAME)-dev
 DEV_IMAGE_ID = $(file < .image.dev)

 DOCKER ?= docker
-DOCKERCOMPOSE ?= docker compose
+DOCKERCOMPOSE ?= docker-compose
 DOCKERCOMPOSE_W_ENV = DEV_IMAGE_TAG=$(DEV_IMAGE_TAG) $(DOCKERCOMPOSE)
 REBAR ?= rebar3
+TEST_CONTAINER_NAME ?= testrunner

 all: compile

@ -29,7 +29,7 @@ all: compile
 dev-image: .image.dev

 .image.dev: Dockerfile.dev .env
-	env $(DOTENV) $(DOCKERCOMPOSE_W_ENV) build $(SERVICE)
+	env $(DOTENV) $(DOCKERCOMPOSE_W_ENV) build $(TEST_CONTAINER_NAME)
 	$(DOCKER) image ls -q -f "reference=$(DEV_IMAGE_ID)" | head -n1 > $@

 clean-dev-image:
@ -40,9 +40,11 @@ endif

 DOCKER_WC_OPTIONS := -v $(PWD):$(PWD) --workdir $(PWD)
 DOCKER_WC_EXTRA_OPTIONS ?= --rm
-DOCKER_RUN = $(DOCKER) run $(DOCKER_WC_OPTIONS) $(DOCKER_WC_EXTRA_OPTIONS)
+DOCKER_RUN = $(DOCKER) run -t $(DOCKER_WC_OPTIONS) $(DOCKER_WC_EXTRA_OPTIONS)

-DOCKERCOMPOSE_RUN = $(DOCKERCOMPOSE_W_ENV) run --name $(SERVICE) --service-ports $(DOCKER_WC_OPTIONS)
+DOCKERCOMPOSE_RUN = $(DOCKERCOMPOSE_W_ENV) run --rm $(DOCKER_WC_OPTIONS) $(TEST_CONTAINER_NAME)
+
+# Utility tasks

 wc-shell: dev-image
 	$(DOCKER_RUN) --interactive --tty $(DEV_IMAGE_TAG)
@ -50,17 +52,21 @@ wc-shell: dev-image
 wc-%: dev-image
 	$(DOCKER_RUN) $(DEV_IMAGE_TAG) make $*

+#  TODO docker compose down doesn't work yet
 wdeps-shell: dev-image
-	$(DOCKERCOMPOSE_RUN) $(SERVICE) su; \
+	$(DOCKERCOMPOSE_RUN) su; \
 	$(DOCKERCOMPOSE_W_ENV) down

 wdeps-%: dev-image
-	$(DOCKERCOMPOSE_RUN) -T $(SERVICE) make $*; \
+	$(DOCKERCOMPOSE_RUN) make $*; \
 	res=$$?; \
 	$(DOCKERCOMPOSE_W_ENV) down; \
 	exit $$res

-# Erlang-specific tasks
+# Rebar tasks
+
+rebar-shell:
+	$(REBAR) shell

 compile:
 	$(REBAR) compile
@ -74,23 +80,31 @@ lint:
 check-format:
 	$(REBAR) fmt -c

-format:
-	$(REBAR) fmt -w
-
 dialyze:
 	$(REBAR) as test dialyzer

 release:
 	$(REBAR) as prod release

+eunit:
+	$(REBAR) eunit --cover
+
+common-test:
+	$(REBAR) ct --cover
+
+cover:
+	$(REBAR) covertool generate
+
+format:
+	$(REBAR) fmt -w
+
 clean:
 	$(REBAR) clean

-distclean:
+distclean: clean-build-image
 	rm -rf _build

-test:
-	$(REBAR) do eunit, ct
+test: eunit common-test

-test.%: test/dmt_%_tests_SUITE.erl
-	$(REBAR) ct --suite=$^
+cover-report:
+	$(REBAR) cover
--- a/docker-compose.yml
+++ b/docker-compose.yml
@ -1,16 +1,17 @@
 version: '3'
 services:

-  dominant: # Keep in sync with $(SERVICE)
+  testrunner:
    image: $DEV_IMAGE_TAG
    build:
      dockerfile: Dockerfile.dev
      context: .
      args:
-        ERLANG_VERSION: $ERLANG_VERSION
+        OTP_VERSION: $OTP_VERSION
        THRIFT_VERSION: $THRIFT_VERSION
    volumes:
      - .:$PWD
+    hostname: $SERVICE_NAME
    working_dir: $PWD
    depends_on:
      - machinegun
--- a/rebar.config
+++ b/rebar.config
@ -109,6 +109,7 @@

 {project_plugins, [
    {rebar3_lint, "1.0.1"},
+    {covertool, "2.0.4"},
    {erlfmt, "1.0.0"}
 ]}.