Merge pull request #21 from buildkite/chore_update_example

updated this example to use gomod and tidy

Author: wolfeidau

.buildkite/pipeline.yml

@@ -1,6 +1,30 @@
 steps:
-  - name: ":golang:"
-    command: "./scripts/test.sh"
+  # group up all the steps that are related to the quality assurance of the code
+  - group: ':mag: QA'
+    id: quality_assurance
+    steps:
+    - key: lint
+      label: ':golang: vet'
+      command: go vet ./...
+      plugins:
+        - docker-compose#v5.3.0:
+            run: app
+    - key: test
+      label: ':golang: test'
+      command: 
+        - go test -v -count=1 -cover ./... -coverprofile=coverage.txt -covermode=atomic
+      artifact_paths:
+        - 'coverage.txt' # upload the coverage report as an artifact
+      plugins:
+        - docker-compose#v5.3.0:
+            run: app
+  # build the application after the quality assurance steps are done
+  - key: build
+    label: ':golang: build'
+    command: go build -o dist/app
+    artifact_paths:
+      - 'dist/app' # upload the built application as an artifact
     plugins:
-      - docker-compose#v5.2.0:
+      - docker-compose#v5.3.0:
           run: app
+    depends_on: quality_assurance

Dockerfile

@@ -1,6 +1 @@
-FROM golang:cross
-
-# The golang Docker sets the $GOPATH to be /go
-# https://github.com/docker-library/golang/blob/c1baf037d71331eb0b8d4c70cff4c29cf124c5e0/1.4/Dockerfile
-RUN mkdir -p /go/src/github.com/buildkite/golang-docker-example
-WORKDIR /go/src/github.com/buildkite/golang-docker-example
+FROM golang:latest

Readme.md

@@ -2,8 +2,7 @@
 
 [![Add to Buildkite](https://buildkite.com/button.svg)](https://buildkite.com/new)
 
-This repository is an example on how to test a Golang project through Docker
-using Buildkite.
+This repository is an example on how to test a [Golang](https://go.dev) project through [Docker](https://docker.com) using Buildkite.
 
 ## Using in your own build pipelines
 
@@ -17,30 +16,6 @@ using Buildkite.
    curl -o docker-compose.yml https://raw.githubusercontent.com/buildkite/golang-docker-example/master/docker-compose.yml
    ```
 
-3. Replace `/go/src/github.com/buildkite/golang-docker-example` in the `Dockerfile` and
-   `docker-compose.yml` files with your own Golang import path.  For example,
-   if your import path in Golang looks like this:
-
-   ```go
-   import (
-     "github.com/keithpitt/project/sub-package"
-   )
-   ```
-
-   Then you would replace `/go/src/github.com/buildkite/golang-docker-example`
-   with `/go/src/github.com/keithpitt/project` (note the `sub-package` part of
-   the import is not included). This path should also match the directory
-   structure within the `$GOPATH` on your own development machine.
-
-4. Add to your build pipeline and add the `BUILDKITE_DOCKER_COMPOSE_CONTAINER` env:
-
-   ```yml
-   steps:
-     - command: "./scripts/test.sh"
-       env:
-         BUILDKITE_DOCKER_COMPOSE_CONTAINER: "app"
-   ```
-
 ## License
 
 See [Licence.md](Licence.md) (MIT)

docker-compose.yml

@@ -1,10 +1,15 @@
-app:
-  build: .
-  volumes:
-    - ./:/go/src/github.com/buildkite/golang-docker-example
-    - /usr/bin/buildkite-agent:/usr/bin/buildkite-agent
-  environment:
-    - BUILDKITE_AGENT_ACCESS_TOKEN
-    - BUILDKITE_JOB_ID
-    - BUILDKITE_BUILD_ID
-    - BUILDKITE_BUILD_NUMBER
+services:
+  app:
+    build: .
+    volumes:
+      - ./:/work:cached
+      - ~/gocache:/gocache
+      - ~/gomodcache:/gomodcache
+    working_dir: /work
+    environment:
+      - BUILDKITE_AGENT_ACCESS_TOKEN
+      - BUILDKITE_JOB_ID
+      - BUILDKITE_BUILD_ID
+      - BUILDKITE_BUILD_NUMBER
+      - GOCACHE=/gocache
+      - GOMODCACHE=/gomodcache

go.mod

@@ -0,0 +1,11 @@
+module github.com/buildkite/golang-docker-example
+
+go 1.21
+
+require github.com/stretchr/testify v1.9.0
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)

go.sum

@@ -0,0 +1,10 @@
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
+github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

logger/logger.go

@@ -4,6 +4,6 @@ import (
 	"fmt"
 )
 
-func Print(text string) {
-	fmt.Printf("%s", text)
+func Print(a ...any) {
+	fmt.Println(a...)
 }

main.go

@@ -5,5 +5,5 @@ import (
 )
 
 func main() {
-	logger.Print("This is the best Golang program, ever!\n")
+	logger.Print("This is the best Golang program, ever!")
 }

main_test.go

@@ -2,17 +2,18 @@ package main
 
 import (
 	"testing"
+
 	"github.com/stretchr/testify/assert"
 
-	"os"
-	"io"
 	"bytes"
+	"io"
+	"os"
 )
 
 func TestMain(t *testing.T) {
 	mainStdout := captureStdout(main)
 
-	assert.Equal(t, mainStdout, "This is the best Golang program, ever!\n")
+	assert.Equal(t, "This is the best Golang program, ever!\n", mainStdout)
 }
 
 // Source https://gist.github.com/mindscratch/0faa78bd3c0005d080bf