Automatically Run Tests on PR and Push Docker Image (#38)

* Add github actions tests

* native running is a bit more complicated

* Add actual builder

* Add runner os

* and this one too

* fix naming

* checkout submodules

* remove backslash

* fix test runner

* Add documentation and fix up docker deployment stuff

* use different caching method

* also for tests

* update caches for main

* specify target

* specify target

* remove docker cache from tests

* Optimize dockerfile for better caching

* significantly speed up cached builds

* use gha cache

* update action versions

* only build one os for now

* test non-code change

* Update docker actions

* fix typo

* fake commit

* reset changes

* build other platforms for tests

.github/workflows/push.yaml

@@ -0,0 +1,93 @@
+name: Build and push Docker image (latest)
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - v*
+jobs:
+  docker-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: Set up Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@master
+        with:
+          install: true
+
+      - name: Build test image
+        uses: docker/build-push-action@v3
+        with:
+          context: ./
+          file: Dockerfile
+          push: false
+          pull: true
+          target: builder
+          tags: ${{secrets.REGISTRY_LOGIN_SERVER}}/${{ secrets.REGISTRY_USERNAME }}/frankenphp:${{ github.sha }}-builder
+          builder: ${{ steps.buildx.outputs.name }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+          outputs: type=docker,dest=/tmp/.builder.tar
+
+      - name: Run tests
+        run: |
+          docker load -i /tmp/.builder.tar
+          docker run --rm ${{secrets.REGISTRY_LOGIN_SERVER}}/${{ secrets.REGISTRY_USERNAME }}/frankenphp:${{ github.sha }}-builder "go test"
+  push-image:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: Docker Login
+        uses: docker/login-action@v2
+        with:
+          registry: ${{secrets.REGISTRY_LOGIN_SERVER}}
+          username: ${{secrets.REGISTRY_USERNAME}}
+          password: ${{secrets.REGISTRY_PASSWORD}}
+
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          # list of Docker images to use as base name for tags
+          images: |
+            ${{ secrets.REGISTRY_LOGIN_SERVER }}/${{ secrets.REGISTRY_REPO }}/frankenphp
+          # generate Docker tags based on the following events/attributes
+          tags: |
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
+
+      - name: Set up Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@master
+        with:
+          install: true
+
+      - name: Setup QEMU
+        uses: docker/setup-qemu-action@v2
+
+      - name: Build and Push Image
+        uses: docker/build-push-action@v3
+        with:
+          context: ./
+          file: Dockerfile
+          push: true
+          pull: true
+          target: final
+          platforms: linux/amd64,linux/arm64
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          builder: ${{ steps.buildx.outputs.name }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

.github/workflows/tests.yaml

@@ -0,0 +1,91 @@
+name: Tests
+on:
+  pull_request:
+    branches:
+      - main
+jobs:
+  docker-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: Set up Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@master
+        with:
+          install: true
+
+      - name: Build test image
+        uses: docker/build-push-action@v3
+        with:
+          context: ./
+          file: Dockerfile
+          push: false
+          pull: true
+          target: builder
+          tags: ${{secrets.REGISTRY_LOGIN_SERVER}}/${{ secrets.REGISTRY_USERNAME }}/frankenphp:${{ github.sha }}-builder
+          builder: ${{ steps.buildx.outputs.name }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+          outputs: type=docker,dest=/tmp/.builder.tar
+
+      - name: Run tests
+        run: |
+          docker load -i /tmp/.builder.tar
+          docker run --rm ${{secrets.REGISTRY_LOGIN_SERVER}}/${{ secrets.REGISTRY_USERNAME }}/frankenphp:${{ github.sha }}-builder "go test"
+  push-image:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: Docker Login
+        uses: docker/login-action@v2
+        with:
+          registry: ${{secrets.REGISTRY_LOGIN_SERVER}}
+          username: ${{secrets.REGISTRY_USERNAME}}
+          password: ${{secrets.REGISTRY_PASSWORD}}
+
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          # list of Docker images to use as base name for tags
+          images: |
+            ${{ secrets.REGISTRY_LOGIN_SERVER }}/${{ secrets.REGISTRY_REPO }}/frankenphp
+          # generate Docker tags based on the following events/attributes
+          tags: |
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
+
+      - name: Set up Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@master
+        with:
+          install: true
+
+      - name: Setup QEMU
+        uses: docker/setup-qemu-action@v2
+
+      - name: Build and Push Image
+        uses: docker/build-push-action@v3
+        with:
+          context: ./
+          file: Dockerfile
+          push: true
+          pull: true
+          target: final
+          platforms: linux/amd64,linux/arm64
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          builder: ${{ steps.buildx.outputs.name }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

Dockerfile

@@ -84,14 +84,18 @@ COPY --from=golang:bullseye /usr/local/go /usr/local/go
 WORKDIR /go/src/app
 
 COPY go.mod go.sum ./
-RUN go get -v ./...
+RUN go mod graph | awk '{if ($1 !~ "@") print $2}' | xargs go get
 
 RUN mkdir caddy && cd caddy
-COPY go.mod go.sum ./
+COPY caddy/go.mod caddy/go.sum ./caddy/
 
-RUN go get -v ./...
+RUN cd caddy && go mod graph | awk '{if ($1 !~ "@") print $2}' | xargs go get
 
-COPY . .
+COPY *.* .
+COPY caddy caddy
+COPY C-Thread-Pool C-Thread-Pool
+COPY internal internal
+COPY testdata testdata
 
 # todo: automate this?
 # see https://github.com/docker-library/php/blob/master/8.2-rc/bullseye/zts/Dockerfile#L57-L59 for php values
@@ -102,6 +106,8 @@ RUN cd caddy/frankenphp && \
     cp frankenphp /usr/local/bin && \
     cp /go/src/app/caddy/frankenphp/Caddyfile /etc/Caddyfile
 
+ENTRYPOINT ["/bin/bash","-c"]
+
 FROM php:8.2.0RC4-zts-bullseye AS final
 
 COPY --from=mlocati/php-extension-installer /usr/bin/install-php-extensions /usr/local/bin/

docs/github-actions.md

@@ -0,0 +1,31 @@
+# Using GitHub Actions
+
+This repository builds and deploys the Docker image to [Docker Hub](https://hub.docker.com/r/dunglas/frankenphp) on
+every approved pull request or on your own fork once setup.
+
+## Setting up GitHub Actions
+
+In the repository settings, under secrets, add the following secrets:
+
+- `REGISTRY_LOGIN_SERVER`: The docker registry to use (e.g. `docker.io`).
+- `REGISTRY_USERNAME`: The username to use to login to the registry (e.g. `dunglas`).
+- `REGISTRY_REPO`: The repository to use (e.g. `dunglas`).
+- `REGISTRY_PASSWORD`: The password to use to login to the registry (e.g. an access key).
+
+## Building and pushing the image
+
+1. Create a pull request or push to your fork.
+2. GitHub Actions will build the image and run any tests.
+3. If the build is successful, the image will be pushed to the registry using the `pr-x`, where `x` is the PR number, as the tag.
+
+## Deploying the image
+
+1. Once the pull request is merged, GitHub Actions will again run the tests and build a new image.
+2. If the build is successful, the `main` tag will be updated in the Docker registry.
+
+## Releases
+
+1. Create a new tag in the repository.
+2. GitHub Actions will build the image and run any tests.
+3. If the build is successful, the image will be pushed to the registry using the tag name as the tag (e.g. `v1.2.3` and `v1.2` will be created).
+4. The `latest` tag will also be updated.