refactor: change jq expression to golang script

Author: jessesimpson36

.github/actions/generate-chart-matrix/action.yml

@@ -36,15 +36,10 @@ runs:
 
         ls -d ${{ inputs.charts-path }} | while read chart_dir; do
           if [[ $(echo ${ALL_MODIFIED_FILES} | grep "${chart_dir}") ]]; then
-            camunda_version="$(basename ${chart_dir} | sed 's/camunda-platform-//')";
-            echo "Camunda version: ${camunda_version}"
-            chart_version="$(cat ${chart_dir}/Chart.yaml | grep '^version:' | head -n 1 | sed 's/version: //')";
-            chart_previous_camunda_version="$(echo ${camunda_version} | jq '. | (((.|tonumber) - .1)*10|round/10)')"
-            chart_previous_helm_version="$(cat charts/camunda-platform-${chart_previous_camunda_version}/Chart.yaml | grep '^version:' | head -n 1 | sed 's/version: //')"
-            echo "${camunda_version} ${chart_version} ${chart_previous_helm_version}" >> matrix_versions.txt;
+            echo ${chart_dir} >> matrix_versions.txt
           fi
         done
 
-        matrix="$(cat matrix_versions.txt | jq --slurp --compact-output --raw-input '[ split("\n") | .[] | split(" ") | { version: .[0], chartVersion: .[1], previousHelmVersion: .[2] } | select(.version != null)] ')"
-
+        cd scripts/generate-gha-matrix/
+        matrix="$(cat ../../matrix_versions.txt | go run .)"
         echo "matrix=${matrix}" | tee -a $GITHUB_OUTPUT

scripts/generate-gha-matrix/Makefile

@@ -0,0 +1,11 @@
+
+PHONY: test
+
+build:
+	go build
+
+run:
+	go run .
+
+test:
+	go test *.go

scripts/generate-gha-matrix/errors.go

@@ -0,0 +1,25 @@
+package main
+
+import (
+	"fmt"
+)
+
+type ProcessError string
+
+func (e ProcessError) Error() string {
+	return "process: " + string(e)
+}
+
+func ProcessErrorf(msg string, args ...interface{}) error {
+	return ProcessError(fmt.Sprintf(msg, args...))
+}
+
+type VersionParsingError string
+
+func (e VersionParsingError) Error() string {
+	return "versions: " + string(e)
+}
+
+func VersionParsingErrorf(msg string, args ...interface{}) error {
+	return VersionParsingError(fmt.Sprintf(msg, args...))
+}

scripts/generate-gha-matrix/generate-gha-matrix.go

@@ -0,0 +1,27 @@
+package main
+
+import (
+	"encoding/json"
+	"fmt"
+)
+
+/*
+This script accepts input piped into it and outputs a github-actions readable
+matrix of tests to run.
+
+ex: echo charts/camunda-platform-8.3 charts/camunda-platform-8.4 charts/camunda-platform-8.8 | go run . | jq
+*/
+func main() {
+	input := parseInput()
+
+	output, err := processInputs(input)
+	if err != nil {
+		panic(err)
+	}
+
+	final, err := json.Marshal(output)
+	if err != nil {
+		panic(err)
+	}
+	fmt.Println(string(final))
+}

scripts/generate-gha-matrix/go.mod

@@ -0,0 +1,15 @@
+module main
+
+go 1.23.7
+
+require (
+	github.com/Masterminds/semver/v3 v3.3.0 // indirect
+	github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
+	github.com/pkg/errors v0.9.1 // indirect
+	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
+	github.com/stretchr/testify v1.10.0 // indirect
+	golang.org/x/mod v0.24.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+	helm.sh/helm/v3 v3.17.3 // indirect
+	sigs.k8s.io/yaml v1.4.0 // indirect
+)

scripts/generate-gha-matrix/go.sum

@@ -0,0 +1,20 @@
+github.com/Masterminds/semver/v3 v3.3.0 h1:B8LGeaivUe71a5qox1ICM/JLl0NqZSW5CHyL+hmvYS0=
+github.com/Masterminds/semver/v3 v3.3.0/go.mod h1:4V+yj/TJE1HU9XfppCwVMZq3I84lprf4nC11bSS5beM=
+github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc h1:U9qPSI2PIWSS1VwoXQT9A3Wy9MM3WgvqSxFWenqJduM=
+github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
+github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
+github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
+github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 h1:Jamvg5psRIccs7FGNTlIRMkT8wgtp5eCXdBlqhYGL6U=
+github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
+github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+golang.org/x/mod v0.24.0 h1:ZfthKaKaT4NrhGVZHO1/WDTwGES4De8KtWO0SIbNJMU=
+golang.org/x/mod v0.24.0/go.mod h1:IXM97Txy2VM4PJ3gI61r1YEk/gAj6zAHN3AdZt6S9Ww=
+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=
+helm.sh/helm/v3 v3.17.3 h1:3n5rW3D0ArjFl0p4/oWO8IbY/HKaNNwJtOQFdH2AZHg=
+helm.sh/helm/v3 v3.17.3/go.mod h1:+uJKMH/UiMzZQOALR3XUf3BLIoczI2RKKD6bMhPh4G8=
+sigs.k8s.io/yaml v1.4.0 h1:Mk1wCc2gy/F0THH0TAp1QYyJNzRm2KCLy3o5ASXVI5E=
+sigs.k8s.io/yaml v1.4.0/go.mod h1:Ejl7/uTz7PSA4eKMyQCUTnhZYNmLIl+5c2lQPGR2BPY=

scripts/generate-gha-matrix/inputs.go

@@ -0,0 +1,18 @@
+package main
+
+import (
+	"bufio"
+	"os"
+)
+
+func parseInput() Input {
+	stdinReader := bufio.NewReader(os.Stdin)
+	scanner := bufio.NewScanner(stdinReader)
+	scanner.Split(bufio.ScanWords)
+
+	var input Input
+	for scanner.Scan() {
+		input.HelmChartModifiedDirectories = append(input.HelmChartModifiedDirectories, scanner.Text())
+	}
+	return input
+}

scripts/generate-gha-matrix/process.go

@@ -0,0 +1,30 @@
+package main
+
+import (
+	"helm.sh/helm/v3/pkg/chart/loader"
+)
+
+func processInputs(input Input) ([]Output, error) {
+	var output []Output
+	for _, modifiedDir := range input.HelmChartModifiedDirectories {
+		chart, err := loader.Load("../../" + modifiedDir)
+		if err != nil {
+			return nil, ProcessErrorf("failed to load chart for modified dir %s : %s", modifiedDir, err)
+		}
+
+		version := getCamundaVersion(chart)
+		previousVersionMajor, err := getPreviousHelmChartVersion(chart, version)
+		if err != nil {
+			return nil, ProcessErrorf("failed to get previous helm chart metadata for version %s : %s", version, err)
+		}
+
+		matrixRunVector := Output{
+			CamundaVersion:           version[1:],
+			HelmChartVersion:         chart.Metadata.Version,
+			PreviousHelmChartVersion: previousVersionMajor,
+		}
+
+		output = append(output, matrixRunVector)
+	}
+	return output, nil
+}

scripts/generate-gha-matrix/process_test.go

@@ -0,0 +1,30 @@
+package main
+
+import (
+	"github.com/stretchr/testify/require"
+	"testing"
+)
+
+func TestProcess(t *testing.T) {
+	inputs := Input{
+		HelmChartModifiedDirectories: []string{"charts/camunda-platform-8.8"},
+	}
+
+	outputs, err := processInputs(inputs)
+	require.NoError(t, err)
+
+	require.Len(t, outputs, 1)
+	require.Contains(t, outputs[0].CamundaVersion, "8.8")
+	require.Contains(t, outputs[0].HelmChartVersion, "13")
+	require.Contains(t, outputs[0].PreviousHelmChartVersion, "12")
+}
+
+func TestProcessInvalidChartDir(t *testing.T) {
+	inputs := Input{
+		HelmChartModifiedDirectories: []string{"charts/invalid"},
+	}
+
+	outputs, err := processInputs(inputs)
+	require.NotNil(t, err)
+	require.Nil(t, outputs)
+}

scripts/generate-gha-matrix/types.go

@@ -0,0 +1,11 @@
+package main
+
+type Input struct {
+	HelmChartModifiedDirectories []string
+}
+
+type Output struct {
+	CamundaVersion           string `json:"version"`
+	HelmChartVersion         string `json:"chartVersion"`
+	PreviousHelmChartVersion string `json:"previousHelmVersion"`
+}

scripts/generate-gha-matrix/versions.go

@@ -0,0 +1,39 @@
+package main
+
+import (
+	"golang.org/x/mod/semver"
+	"helm.sh/helm/v3/pkg/chart"
+	"helm.sh/helm/v3/pkg/chart/loader"
+	"strconv"
+	"strings"
+)
+
+func getCamundaVersion(chart *chart.Chart) string {
+	var version string
+	if chart.Values["zeebe"] == nil {
+		version = "v" + chart.Values["core"].(map[string]interface{})["image"].(map[string]interface{})["tag"].(string)
+	} else {
+		version = "v" + chart.Values["zeebe"].(map[string]interface{})["image"].(map[string]interface{})["tag"].(string)
+	}
+	return version
+}
+
+func getPreviousHelmChartVersion(chart *chart.Chart, version string) (string, error) {
+	if !strings.HasPrefix(version, "v") {
+		return "", VersionParsingErrorf("input version is not valid: %s. Expected vX.Y.Z", version)
+	}
+	camundaVersionParsed := semver.MajorMinor(version)[1:]
+	camundaVersionFloat, err := strconv.ParseFloat(camundaVersionParsed, 64)
+	if err != nil {
+		return "", VersionParsingErrorf("failed to parse version from input: %s", err)
+	}
+	previousVersionFloat := (camundaVersionFloat*10 - 1) / 10
+	previousCamundaVersion := strconv.FormatFloat(previousVersionFloat, 'f', -1, 64)
+	previousChart, err := loader.Load("../../charts/camunda-platform-" + previousCamundaVersion)
+	if err != nil {
+		return "", VersionParsingErrorf("failed to load the previous chart: %s", err)
+	}
+	previousChartVersionSemver := "v" + previousChart.Metadata.Version
+	previousVersionMajor := semver.Major(previousChartVersionSemver)[1:]
+	return previousVersionMajor, nil
+}

scripts/generate-gha-matrix/versions_test.go

@@ -0,0 +1,60 @@
+package main
+
+import (
+	"github.com/stretchr/testify/require"
+	"helm.sh/helm/v3/pkg/chart/loader"
+	"regexp"
+	"testing"
+)
+
+var validVersionRegex = regexp.MustCompile(`^v\d+\.\d+\.\d+(-[a-zA-Z1-9]*)?$`)
+
+func TestGetCamundaVersionPre88(t *testing.T) {
+	chart, err := loader.Load("../../charts/camunda-platform-8.6")
+	require.NoError(t, err)
+
+	version := getCamundaVersion(chart)
+	valid := validVersionRegex.MatchString(version)
+
+	require.True(t, valid)
+}
+
+func TestGetCamundaVersionPost88(t *testing.T) {
+	chart, err := loader.Load("../../charts/camunda-platform-8.8")
+	require.NoError(t, err)
+
+	version := getCamundaVersion(chart)
+	valid := validVersionRegex.MatchString(version)
+
+	require.True(t, valid)
+}
+
+func TestGetPreviousChart(t *testing.T) {
+	chart, err := loader.Load("../../charts/camunda-platform-8.8")
+	require.NoError(t, err)
+
+	version := getCamundaVersion(chart)
+	previousVersion, err := getPreviousHelmChartVersion(chart, version)
+	require.NoError(t, err)
+	require.Equal(t, "12", previousVersion)
+}
+
+func TestGetPreviousChartInvalidVersion(t *testing.T) {
+	chart, err := loader.Load("../../charts/camunda-platform-8.8")
+	require.NoError(t, err)
+
+	version := "badversion"
+	_, err = getPreviousHelmChartVersion(chart, version)
+	require.NotNil(t, err)
+	require.Contains(t, err.Error(), "input version is not valid")
+}
+
+func TestGetPreviousChartChartTooOld(t *testing.T) {
+	chart, err := loader.Load("../../charts/camunda-platform-8.2")
+	require.NoError(t, err)
+
+	version := getCamundaVersion(chart)
+	_, err = getPreviousHelmChartVersion(chart, version)
+	require.NotNil(t, err)
+	require.Contains(t, err.Error(), "failed to load the previous chart")
+}