feature: implement a new command to support gotestsum (#93)

.circleci/test-deploy.yml

@@ -137,6 +137,42 @@ jobs:
       - go/install:
           version: 1.16.4
       - run: go version && go build ./...
+  go-test-default:
+    docker:
+      - image: cimg/go:1.23.3
+    steps:
+      - checkout
+      - go/test:
+          project-path: tests
+  int-test-gotestsum-1-test:
+    docker:
+      - image: cimg/go:1.23.3
+    steps:
+      - checkout
+      - go/gotestsum:
+          project-path: tests
+          packages: circleci.com/go-orb/numbers
+      - store_test_results:
+          path: /home/circleci/project/tests
+  int-test-gotestsum-2-test:
+    docker:
+      - image: cimg/go:1.23.3
+    steps:
+      - checkout
+      - go/gotestsum:
+          project-path: tests
+          packages: circleci.com/go-orb/numbers circleci.com/go-orb/words
+      - store_test_results:
+          path: /home/circleci/project/tests
+  int-test-gotestsum-all-test:
+    docker:
+      - image: cimg/go:1.23.3
+    steps:
+      - checkout
+      - go/gotestsum:
+          project-path: tests
+      - store_test_results:
+          path: /home/circleci/project/tests
 workflows:
   test-deploy:
     jobs:
@@ -164,6 +200,14 @@ workflows:
           filters: *filters
       - int-test-vm-arm64:
           filters: *filters
+      - go-test-default:
+          filters: *filters
+      - int-test-gotestsum-1-test:
+          filters: *filters
+      - int-test-gotestsum-2-test:
+          filters: *filters
+      - int-test-gotestsum-all-test:
+          filters: *filters
       - orb-tools/pack:
           filters: *release-filters
       - orb-tools/publish:

src/commands/gotestsum.yml

@@ -0,0 +1,36 @@
+description: |
+  Runs 'go test ./...' but includes extensive parameterization for finer tuning
+parameters:
+  project-path:
+    description: |
+      The path to the directory containing your Go project files:
+      .goreleaser.yaml, go.mod, main.go.
+      Defaults to $HOME.
+    type: string
+    default: ""
+  packages:
+    description: import tests to run, by path glob.
+    type: string
+    default: "./..."
+  junitfile:
+    description: file to save junit format xml file
+    type: string
+    default: "unit-tests.xml"
+  covermode:
+    description: mode used to count coverage
+    type: string
+    default: "atomic"
+  coverprofile:
+    description: file to save coverage profile
+    type: string
+    default: "cover-source.out"
+steps:
+  - run:
+      environment:
+        ORB_EVAL_PROJECT_PATH: <<parameters.project-path>>
+        ORB_VAL_PACKAGES: <<parameters.packages>>
+        ORB_VAL_JUNITFILE: <<parameters.junitfile>>
+        ORB_VAL_COVERMODE: <<parameters.covermode>>
+        ORB_EVAL_COVER_PROFILE: <<parameters.coverprofile>>
+      command: <<include(scripts/gotestsum.sh)>>
+      name: "gotestsum"

src/commands/test.yml

@@ -60,12 +60,19 @@ parameters:
       (Sets -cover.)
     type: string
     default: "./..."
+  project-path:
+    description: |
+      The path to the directory containing your Go project files:
+      .goreleaser.yaml, go.mod, main.go.
+      Defaults to $HOME.
+    type: string
+    default: ""
 steps:
   - run:
       environment:
         ORB_VAL_RACE: <<parameters.race>>
         ORB_VAL_COUNT: <<parameters.count>>
-        ORB_VAL_FAIL_FAST: <<parameters.failfast>>
+        ORB_VAL_FAILFAST: <<parameters.failfast>>
         ORB_VAL_SHORT: <<parameters.short>>
         ORB_VAL_TIMEOUT: <<parameters.timeout>>
         ORB_VAL_PARALLEL: <<parameters.parallel>>
@@ -74,6 +81,7 @@ steps:
         ORB_VAL_PACKAGES: <<parameters.packages>>
         ORB_VAL_COVERPKG: <<parameters.coverpkg>>
         ORB_EVAL_COVER_PROFILE: <<parameters.coverprofile>>
+        ORB_EVAL_PROJECT_PATH: <<parameters.project-path>>
       command: <<include(scripts/test.sh)>>
       name: "go test"
       no_output_timeout: <<parameters.no_output_timeout>>

src/scripts/gotestsum.sh

@@ -0,0 +1,36 @@
+#! /bin/bash
+
+if [ ! "$(which gotestsum)" ]; then
+  echo The gotestsum command is not available in this executor.
+  exit 1
+fi
+
+if [ -n "${ORB_EVAL_PROJECT_PATH}" ]; then
+  cd "${ORB_EVAL_PROJECT_PATH}" || exit
+fi
+
+if [ -n "$ORB_VAL_PACKAGES" ];then
+  set -- "$@" --packages "${ORB_VAL_PACKAGES}"
+fi
+
+if [ -n "$ORB_VAL_JUNITFILE" ];then
+  set -- "$@" --junitfile "${ORB_VAL_JUNITFILE}"
+fi
+
+if [ -n "$ORB_VAL_COVERMODE" ];then
+  COVERMODE="-covermode=${ORB_VAL_COVERMODE}"
+fi
+
+if [ -n "$ORB_EVAL_COVER_PROFILE" ];then
+  INPUT_COVER_PROFILE=$(eval echo "$ORB_EVAL_COVER_PROFILE")
+  COVER_PROFILE="-coverprofile=${INPUT_COVER_PROFILE}"
+fi
+
+set -x
+gotestsum \
+  "$@" \
+  -- \
+  "${COVERMODE}" \
+  "${COVER_PROFILE}" \
+  -coverpkg="$ORB_VAL_PACKAGES"
+set +x

src/scripts/test.sh

@@ -1,8 +1,14 @@
 #!/usr/bin/env bash
+
+if [ -n "${ORB_EVAL_PROJECT_PATH}" ]; then
+  cd "${ORB_EVAL_PROJECT_PATH}" || exit
+fi
+
 COVER_PROFILE=$(eval echo "$ORB_EVAL_COVER_PROFILE")
 
 if [ -n "$ORB_VAL_RACE" ]; then
   set -- "$@" -race
+  ORB_VAL_COVER_MODE=atomic
 fi
 
 if [ "$ORB_VAL_FAILFAST" != "false" ]; then

tests/go.mod

@@ -1,3 +1,3 @@
-module main
+module circleci.com/go-orb
 
-go 1.20
+go 1.23.3

tests/main.go

@@ -1,6 +1,15 @@
 // main.go
 package main
 
+import (
+	"fmt"
+
+	"circleci.com/go-orb/numbers"
+	"circleci.com/go-orb/words"
+)
+
 func main() {
-  println("Hello, World!")
-}
+	word := words.Word()
+	number := numbers.Number()
+	fmt.Printf("%s %d\n", word, number)
+}

tests/numbers/numbers.go

@@ -0,0 +1,5 @@
+package numbers
+
+func Number() int {
+	return 1987
+}

tests/numbers/numbers_test.go

@@ -0,0 +1,10 @@
+package numbers
+
+import "testing"
+
+func TestNumber(t *testing.T) {
+	result := Number()
+	if result != 1987 {
+		t.FailNow()
+	}
+}

tests/words/words.go

@@ -0,0 +1,5 @@
+package words
+
+func Word() string {
+	return "Word"
+}

tests/words/words_test.go

@@ -0,0 +1,10 @@
+package words
+
+import "testing"
+
+func TestWord(t *testing.T) {
+	result := Word()
+	if result != "Word" {
+		t.FailNow()
+	}
+}