build: Replace make with just

* Adjust the '$ git describe --tag' invocation in the Justfile to work on a shallow clone of a repo. This error was always present when building via makefile, but execution was allowed to continue. When just is used, then the error is a show-stopper. * Use shell interpreter in some Justfile recipes so that build environments can use the default shell, /bin/sh, rather than requiring them to install bash. * Remove .dockerignore because we only need to pay attention to files under version control, and therefore could leverage the gitignore. Docker-related artifacts should be built from repo clones, which will only contain version-controlled files. Use of the ci.Justfile when building docker artifacts will make that happen.
rafaelespinoza · Jun 30, 2024 · e730f4b · e730f4b
1 parent 96fd978
commit e730f4b
Show file tree

Hide file tree

Showing 23 changed files with 299 additions and 265 deletions.
diff --git a/.ci/cassandra/client.Dockerfile b/.ci/cassandra/client.Dockerfile
@@ -1,7 +1,7 @@
 FROM godfish_test/client_base:latest
 
 WORKDIR /src
-RUN make build-cassandra
+RUN just build-cassandra
 
 # Alpine linux doesn't have a cassandra client. Build a golang binary to check
 # if server is ready and setup the test DB. Use it in the entrypoint.

diff --git a/.ci/cassandra/client.sh b/.ci/cassandra/client.sh
@@ -5,9 +5,9 @@ set -eu
 dbhost="${1:?missing dbhost}"
 
 echo "building binary"
-make build-cassandra
+just build-cassandra
 echo "testing godfish"
-make test ARGS='-v -count=1 -coverprofile=/tmp/cover.out'
+just test '-v -count=1 -coverprofile=/tmp/cover.out'
 
 # Wait for db server to be ready, with some limits.
 num_attempts=0
@@ -25,4 +25,4 @@ done
 >&2 echo "db is up"
 
 echo "testing godfish against live db"
-make test-cassandra ARGS='-v -count=1 -coverprofile=/tmp/cover_driver.out'
+just test-cassandra '-v -count=1 -coverprofile=/tmp/cover_driver.out'
diff --git a/.ci/client_base.Dockerfile b/.ci/client_base.Dockerfile
@@ -1,6 +1,6 @@
 FROM golang:alpine
 WORKDIR /src
-RUN apk update && apk --no-cache add gcc g++ git make
+RUN apk update && apk --no-cache add gcc g++ git just
 COPY go.mod /src
 RUN go mod download && go mod verify
 COPY . /src
diff --git a/.ci/mysql/client.Dockerfile b/.ci/mysql/client.Dockerfile
@@ -3,7 +3,7 @@ FROM godfish_test/client_base:latest
 WORKDIR /src
 RUN apk update && \
  apk --no-cache add mysql-client && \
- make build-mysql
+ just build-mysql
 
 COPY .ci/mysql/client.sh /
 ENTRYPOINT /client.sh
diff --git a/.ci/mysql/client.sh b/.ci/mysql/client.sh
@@ -6,9 +6,9 @@ dbhost="${1:?missing dbhost}"
 dbuser='godfish'
 
 echo "building binary"
-make build-mysql
+just build-mysql
 echo "testing godfish"
-make test ARGS='-v -count=1 -coverprofile=/tmp/cover.out'
+just test '-v -count=1 -coverprofile=/tmp/cover.out'
 
 # Wait for db server to be ready, with some limits.
 
@@ -27,4 +27,4 @@ done
 >&2 echo "db is up"
 
 echo "testing godfish against live db"
-make test-mysql ARGS='-v -count=1 -coverprofile=/tmp/cover_driver.out'
+just test-mysql '-v -count=1 -coverprofile=/tmp/cover_driver.out'
diff --git a/.ci/postgres/client.Dockerfile b/.ci/postgres/client.Dockerfile
@@ -3,7 +3,7 @@ FROM godfish_test/client_base:latest
 WORKDIR /src
 RUN apk update && \
  apk --no-cache add postgresql-client && \
- make build-postgres
+ just build-postgres
 
 COPY .ci/postgres/client.sh /
 ENTRYPOINT /client.sh
diff --git a/.ci/postgres/client.sh b/.ci/postgres/client.sh
@@ -7,9 +7,9 @@ dbname='godfish_test'
 dbuser='godfish'
 
 echo "building binary"
-make build-postgres
+just build-postgres
 echo "testing godfish"
-make test ARGS='-v -count=1 -coverprofile=/tmp/cover.out'
+just test '-v -count=1 -coverprofile=/tmp/cover.out'
 
 # Wait for db server to be ready, with some limits.
 
@@ -27,4 +27,4 @@ done
 >&2 echo "db is up"
 
 echo "testing godfish against live db"
-make test-postgres ARGS='-v -count=1 -coverprofile=/tmp/cover_driver.out'
+just test-postgres '-v -count=1 -coverprofile=/tmp/cover_driver.out'
diff --git a/.ci/sqlite3/Dockerfile b/.ci/sqlite3/Dockerfile
@@ -5,7 +5,7 @@ ENV DB_DSN="file:/godfish_test.db"
 WORKDIR /src
 RUN apk update && \
  apk --no-cache add musl-dev sqlite && \
- make build-sqlite3
+ just build-sqlite3
 
 COPY .ci/sqlite3/client.sh /
 ENTRYPOINT /client.sh
diff --git a/.ci/sqlite3/client.sh b/.ci/sqlite3/client.sh
@@ -3,10 +3,10 @@
 set -eu
 
 echo "building binary"
-make build-sqlite3
+just build-sqlite3
 
 echo "testing godfish"
-make test ARGS='-v -count=1 -coverprofile=/tmp/cover.out'
+just test '-v -count=1 -coverprofile=/tmp/cover.out'
 
 echo "testing godfish against live db"
-make test-sqlite3 ARGS='-v -count=1 -coverprofile=/tmp/cover_driver.out'
+just test-sqlite3 '-v -count=1 -coverprofile=/tmp/cover_driver.out'
diff --git a/.ci/sqlserver/client.Dockerfile b/.ci/sqlserver/client.Dockerfile
@@ -1,7 +1,7 @@
 FROM godfish_test/client_base:latest
 
 WORKDIR /src
-RUN make build-sqlserver
+RUN just build-sqlserver
 
 # Alpine linux doesn't have a SQL Server client. Build a golang binary to
 # check if server is ready. Use it in the entrypoint.

diff --git a/.ci/sqlserver/client.sh b/.ci/sqlserver/client.sh
@@ -3,9 +3,9 @@
 set -eu
 
 echo "building binary"
-make build-sqlserver
+just build-sqlserver
 echo "testing godfish"
-make test ARGS='-v -count=1 -coverprofile=/tmp/cover.out'
+just test '-v -count=1 -coverprofile=/tmp/cover.out'
 
 # Wait for db server to be ready, with some limits.
 
@@ -24,4 +24,4 @@ done
 >&2 echo "db is up"
 
 echo "testing godfish against live db"
-make test-sqlserver ARGS='-v -count=1 -coverprofile=/tmp/cover_driver.out'
+just test-sqlserver '-v -count=1 -coverprofile=/tmp/cover_driver.out'
diff --git a/.dockerignore b/.dockerignore
diff --git a/.github/workflows/build-cassandra.yml b/.github/workflows/build-cassandra.yml
@@ -7,8 +7,10 @@ jobs:
  steps:
  - name: Checkout repo
  uses: actions/checkout@v4
+ - name: Install just
+ uses: extractions/setup-just@v2
  - name: Build environment and run tests
- run: make -f ci.Makefile ci-cassandra3-up
+ run: just -f ci.Justfile ci-cassandra3-up
  - name: Upload code coverage
  uses: codecov/codecov-action@v4
  with:
@@ -17,15 +19,17 @@ jobs:
  token: ${{ secrets.CODECOV_TOKEN }}
  verbose: true
  - name: Teardown
- run: make -f ci.Makefile ci-cassandra3-down
+ run: just -f ci.Justfile ci-cassandra3-down
  v4:
  name: cassandra_v4
  runs-on: ubuntu-latest
  steps:
  - name: Checkout repo
  uses: actions/checkout@v4
+ - name: Install just
+ uses: extractions/setup-just@v2
  - name: Build environment and run tests
- run: make -f ci.Makefile ci-cassandra4-up
+ run: just -f ci.Justfile ci-cassandra4-up
  - name: Upload code coverage
  uses: codecov/codecov-action@v4
  with:
@@ -34,4 +38,4 @@ jobs:
  token: ${{ secrets.CODECOV_TOKEN }}
  verbose: true
  - name: Teardown
- run: make -f ci.Makefile ci-cassandra4-down
+ run: just -f ci.Justfile ci-cassandra4-down
diff --git a/.github/workflows/build-mysql.yml b/.github/workflows/build-mysql.yml
@@ -7,8 +7,10 @@ jobs:
  steps:
  - name: Checkout repo
  uses: actions/checkout@v4
+ - name: Install just
+ uses: extractions/setup-just@v2
  - name: Build environment and run tests
- run: make -f ci.Makefile ci-mariadb-up
+ run: just -f ci.Justfile ci-mariadb-up
  - name: Upload code coverage
  uses: codecov/codecov-action@v4
  with:
@@ -17,15 +19,17 @@ jobs:
  token: ${{ secrets.CODECOV_TOKEN }}
  verbose: true
  - name: Teardown
- run: make -f ci.Makefile ci-mariadb-down
+ run: just -f ci.Justfile ci-mariadb-down
  mysql_v57:
  name: mysql v5.7
  runs-on: ubuntu-latest
  steps:
  - name: Checkout repo
  uses: actions/checkout@v4
+ - name: Install just
+ uses: extractions/setup-just@v2
  - name: Build environment and run tests
- run: make -f ci.Makefile ci-mysql57-up
+ run: just -f ci.Justfile ci-mysql57-up
  - name: Upload code coverage
  uses: codecov/codecov-action@v4
  with:
@@ -34,15 +38,17 @@ jobs:
  token: ${{ secrets.CODECOV_TOKEN }}
  verbose: true
  - name: Teardown
- run: make -f ci.Makefile ci-mysql57-down
+ run: just -f ci.Justfile ci-mysql57-down
  mysql_v8:
  name: mysql v8.0
  runs-on: ubuntu-latest
  steps:
  - name: Checkout repo
  uses: actions/checkout@v4
+ - name: Install just
+ uses: extractions/setup-just@v2
  - name: Build environment and run tests
- run: make -f ci.Makefile ci-mysql8-up
+ run: just -f ci.Justfile ci-mysql8-up
  - name: Upload code coverage
  uses: codecov/codecov-action@v4
  with:
@@ -51,4 +57,4 @@ jobs:
  token: ${{ secrets.CODECOV_TOKEN }}
  verbose: true
  - name: Teardown
- run: make -f ci.Makefile ci-mysql8-down
+ run: just -f ci.Justfile ci-mysql8-down
diff --git a/.github/workflows/build-postgres.yml b/.github/workflows/build-postgres.yml
@@ -7,8 +7,10 @@ jobs:
  steps:
  - name: Checkout repo
  uses: actions/checkout@v4
+ - name: Install just
+ uses: extractions/setup-just@v2
  - name: Build environment and run tests
- run: make -f ci.Makefile ci-postgres14-up
+ run: just -f ci.Justfile ci-postgres14-up
  - name: Upload code coverage
  uses: codecov/codecov-action@v4
  with:
@@ -17,15 +19,17 @@ jobs:
  token: ${{ secrets.CODECOV_TOKEN }}
  verbose: true
  - name: Teardown
- run: make -f ci.Makefile ci-postgres14-down
+ run: just -f ci.Justfile ci-postgres14-down
  v15:
  name: postgres v15
  runs-on: ubuntu-latest
  steps:
  - name: Checkout repo
  uses: actions/checkout@v4
+ - name: Install just
+ uses: extractions/setup-just@v2
  - name: Build environment and run tests
- run: make -f ci.Makefile ci-postgres15-up
+ run: just -f ci.Justfile ci-postgres15-up
  - name: Upload code coverage
  uses: codecov/codecov-action@v4
  with:
@@ -34,4 +38,4 @@ jobs:
  token: ${{ secrets.CODECOV_TOKEN }}
  verbose: true
  - name: Teardown
- run: make -f ci.Makefile ci-postgres15-down
+ run: just -f ci.Justfile ci-postgres15-down
diff --git a/.github/workflows/build-sqlite3.yml b/.github/workflows/build-sqlite3.yml
@@ -6,8 +6,10 @@ jobs:
  steps:
  - name: Checkout repo
  uses: actions/checkout@v4
+ - name: Install just
+ uses: extractions/setup-just@v2
  - name: Build environment and run tests
- run: make -f ci.Makefile ci-sqlite3-up
+ run: just -f ci.Justfile ci-sqlite3-up
  - name: Upload code coverage
  uses: codecov/codecov-action@v4
  with:
@@ -16,4 +18,4 @@ jobs:
  token: ${{ secrets.CODECOV_TOKEN }}
  verbose: true
  - name: Teardown
- run: make -f ci.Makefile ci-sqlite3-down
+ run: just -f ci.Justfile ci-sqlite3-down
diff --git a/.github/workflows/build-sqlserver.yml b/.github/workflows/build-sqlserver.yml
@@ -6,8 +6,10 @@ jobs:
  steps:
  - name: Checkout repo
  uses: actions/checkout@v4
+ - name: Install just
+ uses: extractions/setup-just@v2
  - name: Build environment and run tests
- run: make -f ci.Makefile ci-sqlserver-up
+ run: just -f ci.Justfile ci-sqlserver-up
  - name: Upload code coverage
  uses: codecov/codecov-action@v4
  with:
@@ -16,4 +18,4 @@ jobs:
  token: ${{ secrets.CODECOV_TOKEN }}
  verbose: true
  - name: Teardown
- run: make -f ci.Makefile ci-sqlserver-down
+ run: just -f ci.Justfile ci-sqlserver-down
diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml
@@ -20,5 +20,7 @@ jobs:
  uses: actions/setup-go@v5
  with:
  go-version: 1.18
+ - name: Install just
+ uses: extractions/setup-just@v2
  - name: Vet source
- run: make vet
+ run: just vet