299 add partial testing (#1) (#381)

* feat: add partial testing (#299)

* docs: add configuration options for GTA base branch and partial testing

* feat: add conditional task execution for GTA partial testing

* fix: update conditional check for gta-partial-testing input type

* fix: update conditional check for gta-partial-testing input type to handle string input

* fix: improve PKGS assignment for partial testing and handle errors

* fix: update default GTA base branch to use origin/main

* fix: update GTA base branch handling in partial testing task

* fix: remove unnecessary git branch command from golang-log task

* fix: add git diff command to golang-log task for better change tracking

* fix: update GTA base branch reference in partial testing task

* fix: update GTA base branch alias in task configuration

* fix: add git branch command to golang-log task for improved branch management

* fix: enhance partial test suite message with base branch details

* fix: update partial test suite message and adjust base branch reference

* fix: update GTA base branch default value and remove alias

* docs: add note fetch-depth needed

* fix: add GTA_VERSION to updater script

* fix: add removed comment back

* fix: update GTA_VERSION package source to DigitalOcean

* fix: remove unnecessary newline in test task definition

Author: JairJosafath

README.md

@@ -232,11 +232,15 @@ jobs:
       test-timeout: 10m0s
     steps:
       - uses: actions/checkout@v4.1.1
+        with:
+          fetch-depth: 0 # this is necessary for gta partial testing
       - uses: schubergphilis/mcvs-golang-action@v0.9.0
         with:
           build-tags: ${{ matrix.args.build-tags }}
           golang-unit-tests-exclusions: |-
             \(cmd\/some-app\|internal\/app\/some-app\)
+          gta-base-branch: main
+          gta-partial-testing: true
           release-architecture: ${{ matrix.args.release-architecture }}
           release-dir: ${{ matrix.args.release-dir }}
           release-type: ${{ matrix.args.release-type }}
@@ -260,8 +264,10 @@ and a [.golangci.yml](https://golangci-lint.run/usage/configuration/).
 | code-coverage-timeout                           |         |          | Timeout duration for code coverage analysis (e.g., "10m0s")                                                      |
 | github-token-for-downloading-private-go-modules |         |          | GitHub token with permissions to download Go modules from private repositories                                   |
 | golangci-timeout                                | x       |          | Timeout duration for golangci-lint execution                                                                     |
-| golang-unit-tests-exclusions                    | x       |          | Regex pattern to exclude specific packages from unit testing (e.g., `\(cmd\/app\|internal\/app\)`)              |
+| golang-unit-tests-exclusions                    | x       |          | Regex pattern to exclude specific packages from unit testing (e.g., `\(cmd\/app\|internal\/app\)`)               |
 | grype-version                                   |         |          | Specific version of Grype vulnerability scanner to use                                                           |
+| gta-base-branch                                 | x       |          | The branch changed go packages will be compared to, to perform partial tests                                     |           
+| gta-partial-testing                             | x       |          | Whether to run partial tests (true or false)                                                                     |
 | release-application-name                        |         |          | Name of the application binary to build (required when release-type is set)                                      |
 | release-architecture                            |         |          | Target architecture for the binary (e.g., "amd64", "arm64")                                                      |
 | release-build-tags                              |         |          | Build tags to use when building the release binary (e.g., "lambda.norpc")                                        |
@@ -276,6 +282,7 @@ and a [.golangci.yml](https://golangci-lint.run/usage/configuration/).
 | trivy-action-db                                 | x       |          | Trivy vulnerability database configuration                                                                       |
 | trivy-action-java-db                            | x       |          | Trivy Java vulnerability database configuration                                                                  |
 
+
 Note: If an **x** is registered in the Default column, refer to the
 [action.yml](action.yml) for the corresponding value.
 

action.yml

@@ -35,6 +35,15 @@ inputs:
       disabled.
   grype-version:
     description: The grype version to be used by the anchore/scan-action.
+  gta-base-branch:
+    default: main
+    description: |
+      The base branch to compare changed code to.
+  gta-partial-testing:
+    default: false
+    description: |
+      Whether partial testing should be performed. Only changed packages will be
+      tested.
   release-application-name:
     description: |
       The name of the application that has to be released.
@@ -262,13 +271,23 @@ runs:
         task remote:regal --yes
         task remote:opa --yes
     #
+    # Install digitalocean/gta if partial testing is enabled.
+    #
+    - name: install gta for partial testing
+      if: inputs.gta-partial-testing == true || inputs.gta-partial-testing == 'true'
+      shell: bash
+      run: |
+        task remote:gta-install --yes
+    #
     # Unit tests.
     #
     - name: unit tests
       if: inputs.testing-type == 'unit'
       shell: bash
       env:
         GITHUB_TOKEN: ${{ inputs.token }}
+        GTA_BASE_BRANCH: ${{ inputs.gta-base-branch }}
+        GTA_PARTIAL_TESTING: ${{ inputs.gta-partial-testing }}
       run: |
         task remote:test-cicd --yes
     #
@@ -279,6 +298,8 @@ runs:
       shell: bash
       env:
         GITHUB_TOKEN: ${{ inputs.token }}
+        GTA_BASE_BRANCH: ${{ inputs.gta-base-branch }}
+        GTA_PARTIAL_TESTING: ${{ inputs.gta-partial-testing }}
         TEST_TIMEOUT: ${{ inputs.test-timeout }}
       run: |
         task remote:test-integration-cicd --yes
@@ -293,6 +314,8 @@ runs:
         CODE_COVERAGE_FILE_EXCLUSIONS: ${{ inputs.golang-unit-tests-exclusions }}
         GITHUB_TOKEN: ${{ inputs.token }}
         CODE_COVERAGE_TIMEOUT: ${{ inputs.code-coverage-timeout }}
+        GTA_BASE_BRANCH: ${{ inputs.gta-base-branch }}
+        GTA_PARTIAL_TESTING: ${{ inputs.gta-partial-testing }}
       run: |
         task remote:coverage --yes
     #
@@ -303,6 +326,8 @@ runs:
       shell: bash
       env:
         GITHUB_TOKEN: ${{ inputs.token }}
+        GTA_BASE_BRANCH: ${{ inputs.gta-base-branch }}
+        GTA_PARTIAL_TESTING: ${{ inputs.gta-partial-testing }}
       run: |
         task remote:test-component-cicd --yes
     #

build/task.yml

@@ -71,6 +71,9 @@ vars:
   GQLGENC_BIN: "{{.GOBIN}}/gqlgenc"
   GRAPHQL_LINTER_BIN: "{{.GOBIN}}/graphql-linter"
   GRAPHQL_LINTER_VERSION: v0.1.0
+  GTA_BASE_BRANCH: '{{.GTA_BASE_BRANCH | default "main"}}'
+  GTA_PARTIAL_TESTING: '{{.GTA_PARTIAL_TESTING | default "false"}}'
+  GTA_VERSION: v0.1.2
   HELM_VERSION: v3.16.2
   MCVS_TEXTTIDY_BIN: "{{.GOBIN}}/mcvs-texttidy"
   MCVS_TEXTTIDY_VERSION: 0.1.0
@@ -308,6 +311,14 @@ tasks:
           go install github.com/go-swagger/go-swagger/cmd/swagger@{{.GO_SWAGGER_VERSION}}
         fi
     silent: true
+  gta-install:
+    cmds:
+      - |
+        if ! gta version | grep -q "{{.GTA_VERSION}}"; then
+          echo "Installing gta version {{.GTA_VERSION}}..."
+          go install github.com/digitalocean/gta/cmd/gta@{{.GTA_VERSION}}
+        fi
+    silent: true
   osv-scanner-install:
     cmds:
       - |
@@ -676,14 +687,30 @@ tasks:
     cmds:
       - task: golang-log
       - |
+        set -eu
+
+        if [ "{{.GTA_PARTIAL_TESTING}}" = true ]; then
+          echo "Running partial test suite... against origin {{ .GTA_BASE_BRANCH }}"
+
+          PKGS="$(gta -include "$(go list -f '{{ .Module.Path }}')/" -base origin/{{ .GTA_BASE_BRANCH }})" \
+            || { rc=$?; echo "gta failed (exit $rc)"; exit $rc; }
+
+          if [ -z "${PKGS}" ]; then
+            echo "No packages changed compared to base branch {{ .GTA_BASE_BRANCH }}. Skipping tests."
+            exit 0;
+          fi
+        else
+          PKGS=./...
+        fi
+
         # when "if testing.Short() { t.Skip() }" is in the go code then such
         # tests will be skipped if -short is used.
         go test \
           -p {{.GOLANG_PARALLEL_TESTS}} \
           -race \
           -short \
           --tags={{.TEST_TAGS}} \
-          ./... \
+          ${PKGS} \
           {{.TEST_EXTRA_ARGS}} \
           -timeout {{.TEST_TIMEOUT}}
     desc: run test

scripts/package-version-updater.sh

@@ -59,6 +59,7 @@ readonly PACKAGES_TO_BE_UPDATED=(
   "PRESENT_VERSION PRESENT_VERSION present go_list_latest_version golang.org/x/tools"
   "REGAL_VERSION REGAL_VERSION regal latest_stable_package_version_on_github StyraOSS/regal"
   "YQ_VERSION YQ_VERSION yq latest_stable_package_version_on_github mikefarah/yq"
+  "GTA_VERSION GTA_VERSION gta latest_stable_package_version_on_github digitalocean/gta"
 )
 readonly PR_TITLE="build(deps): weekly update package versions that cannot be updated by dependabot"