ci: add PR linting and tests to CI

.github/workflows/lint-pr.yml

@@ -0,0 +1,47 @@
+name: "Lint PR"
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+permissions:
+  contents: read
+
+jobs:
+  main:
+    permissions:
+      pull-requests: read
+      statuses: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/[email protected]
+        id: lint_pr_title
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - uses: marocchino/sticky-pull-request-comment@v2
+        # When the previous steps fails, the workflow would stop. By adding this
+        # condition you can continue the execution with the populated error message.
+        if: always() && (steps.lint_pr_title.outputs.error_message != null)
+        with:
+          header: pr-title-lint-error
+          message: |
+            Hey there and thank you for opening this pull request! 👋🏼
+
+            We require pull request titles to follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) and it looks like your proposed title needs to be adjusted.
+
+            Details:
+
+            ```
+            ${{ steps.lint_pr_title.outputs.error_message }}
+            ```
+
+      # Delete a previous comment when the issue has been resolved
+      - if: ${{ steps.lint_pr_title.outputs.error_message == null }}
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          header: pr-title-lint-error
+          delete: true

.github/workflows/tests.yml

@@ -0,0 +1,90 @@
+name: "Run tests"
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - '**'
+    types:
+      - opened
+      - edited
+      - synchronize
+  workflow_dispatch:
+
+env:
+  DOCKER_API_VERSION: '1.45'
+
+jobs:
+  docker-e2e:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: '1.22'
+      - name: Set up Docker
+        run: |
+          echo "DOCKER_API_VERSION=1.45" >> $GITHUB_ENV
+      - name: Debug Docker Setup
+        run: |
+          docker version
+          echo "DOCKER_API_VERSION=$DOCKER_API_VERSION"
+      - name: Run Docker E2E tests
+        run: |
+          make tidy
+          make docker-e2e
+
+  digitalocean-e2e:
+    runs-on: ubuntu-latest
+    if: |
+      github.event_name == 'workflow_dispatch' ||
+      github.event_name == 'push' && github.ref == 'refs/heads/main' ||
+      github.event_name == 'pull_request' && (
+        contains(github.event.pull_request.files.*.path, 'cosmos/') ||
+        contains(github.event.pull_request.files.*.path, 'core/provider/digitalocean/') ||
+        contains(github.event.pull_request.files.*.path, 'core/provider/clients/')
+      )
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: '1.22'
+      - name: Run DigitalOcean E2E tests
+        env:
+          DO_API_TOKEN: ${{ secrets.DO_API_TOKEN }}
+          DO_IMAGE_ID: ${{ vars.DO_IMAGE_ID }}
+        run: |
+          make tidy
+          make digitalocean-e2e
+
+  unit-test:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: '1.22'
+      - name: Set up Docker
+        run: |
+          echo "DOCKER_API_VERSION=1.45" >> $GITHUB_ENV
+      - name: Debug Docker Setup
+        run: |
+          docker version
+          echo "DOCKER_API_VERSION=$DOCKER_API_VERSION"
+      - name: Run unit tests
+        run: |
+          make tidy
+          make unit-test

Makefile

@@ -3,9 +3,18 @@ tidy:
 	@cd ./core && go mod tidy
 	@cd ./cosmos && go mod tidy
 
-test:
+unit-test:
 	@cd ./core && go test ./... -race
-	@cd ./cosmos && go test ./... -race
+	@cd ./cosmos && go test `go list ./... | grep -v e2e` -race
+
+docker-e2e:
+	@cd ./cosmos && go test ./tests/e2e/docker/... -race -v
+
+digitalocean-e2e:
+	@cd ./cosmos && go test ./tests/e2e/digitalocean/... -race -v
+
+e2e-test:
+	@cd ./cosmos && go test ./tests/e2e/... -race -v
 
 govulncheck:
 	@echo "--> Running govulncheck"
@@ -28,4 +37,4 @@ format:
 	@find . -name '*.go' -type f -not -path "*.git*" | xargs go run github.com/client9/misspell/cmd/misspell -w
 	@find . -name '*.go' -type f -not -path "*.git*" | xargs go run golang.org/x/tools/cmd/goimports -w -local github.com/skip-mev/petri
 
-.PHONY: format lint-fix lint govulncheck test tidy
+.PHONY: format lint-fix lint govulncheck unit-test docker-e2e digitalocean-e2e e2e-test tidy

core/go.mod

@@ -152,8 +152,6 @@ require (
 	github.com/hashicorp/go-version v1.6.0 // indirect
 	github.com/hashicorp/golang-lru v1.0.2 // indirect
 	github.com/hashicorp/hcl v1.0.0 // indirect
-	github.com/hexops/gotextdiff v1.0.3 // indirect
-	github.com/iancoleman/strcase v0.3.0 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
 	github.com/jgautheron/goconst v1.7.0 // indirect
 	github.com/jingyugao/rowserrcheck v1.1.1 // indirect

core/go.sum

@@ -526,6 +526,8 @@ github.com/iancoleman/strcase v0.3.0 h1:nTXanmYxhfFAMjZL34Ov6gkzEsSJZ5DbhxWjvSAS
 github.com/iancoleman/strcase v0.3.0/go.mod h1:iwCmte+B7n89clKwxIoIXy/HfoL7AsD47ZCWhYzw7ho=
 github.com/ianlancetaylor/demangle v0.0.0-20181102032728-5e5cf60278f6/go.mod h1:aSSvb/t6k1mPoxDqO4vJh6VOCGPwU4O0C2/Eqndh1Sc=
 github.com/ianlancetaylor/demangle v0.0.0-20200824232613-28f6c0f3b639/go.mod h1:aSSvb/t6k1mPoxDqO4vJh6VOCGPwU4O0C2/Eqndh1Sc=
+github.com/icza/dyno v0.0.0-20230330125955-09f820a8d9c0 h1:nHoRIX8iXob3Y2kdt9KsjyIb7iApSvb3vgsd93xb5Ow=
+github.com/icza/dyno v0.0.0-20230330125955-09f820a8d9c0/go.mod h1:c1tRKs5Tx7E2+uHGSyyncziFjvGpgv4H2HrqXeUQ/Uk=
 github.com/improbable-eng/grpc-web v0.15.0 h1:BN+7z6uNXZ1tQGcNAuaU1YjsLTApzkjt2tzCixLaUPQ=
 github.com/improbable-eng/grpc-web v0.15.0/go.mod h1:1sy9HKV4Jt9aEs9JSnkWlRJPuPtwNr0l57L4f878wP8=
 github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=

core/provider/digitalocean/droplet.go

@@ -5,15 +5,14 @@ import (
 	"fmt"
 	"time"
 
-	"github.com/skip-mev/petri/core/v3/provider/clients"
-
 	"github.com/pkg/errors"
 
 	"github.com/digitalocean/godo"
 	"go.uber.org/zap"
 	"golang.org/x/crypto/ssh"
 
 	"github.com/skip-mev/petri/core/v3/provider"
+	"github.com/skip-mev/petri/core/v3/provider/clients"
 	"github.com/skip-mev/petri/core/v3/util"
 
 	"strconv"

core/provider/digitalocean/provider.go

@@ -10,17 +10,16 @@ import (
 	"sync"
 	"time"
 
-	"github.com/docker/docker/api/types/image"
-	"github.com/skip-mev/petri/core/v3/provider/clients"
-
 	"github.com/digitalocean/godo"
 	"github.com/docker/docker/api/types/container"
+	"github.com/docker/docker/api/types/image"
 	"github.com/docker/docker/api/types/mount"
 	"github.com/docker/docker/client"
 
 	"go.uber.org/zap"
 
 	"github.com/skip-mev/petri/core/v3/provider"
+	"github.com/skip-mev/petri/core/v3/provider/clients"
 	"github.com/skip-mev/petri/core/v3/util"
 )
 

core/provider/digitalocean/task.go

@@ -9,8 +9,6 @@ import (
 	"sync"
 	"time"
 
-	"github.com/skip-mev/petri/core/v3/provider/clients"
-
 	"golang.org/x/crypto/ssh"
 
 	"github.com/docker/docker/api/types/container"
@@ -23,6 +21,7 @@ import (
 	"go.uber.org/zap"
 
 	"github.com/skip-mev/petri/core/v3/provider"
+	"github.com/skip-mev/petri/core/v3/provider/clients"
 	"github.com/skip-mev/petri/core/v3/util"
 )
 

core/provider/docker/task.go

@@ -7,13 +7,12 @@ import (
 	"sync"
 	"time"
 
-	"github.com/skip-mev/petri/core/v3/provider/clients"
-
 	"github.com/docker/docker/api/types/container"
 	"github.com/docker/docker/api/types/mount"
 	"github.com/docker/docker/pkg/stdcopy"
 	"github.com/docker/go-connections/nat"
 	"github.com/skip-mev/petri/core/v3/provider"
+	"github.com/skip-mev/petri/core/v3/provider/clients"
 	"github.com/skip-mev/petri/core/v3/util"
 	"go.uber.org/zap"
 )