Merge branch 'bbz/gofmt'

Author: benbz

.github/workflows/matrix-tools.yml

@@ -2,7 +2,7 @@
 #
 # SPDX-License-Identifier: AGPL-3.0-only
 
-name: Build matrix-tool Docker Images
+name: matrix-tools linting and building
 
 on:
   pull_request:
@@ -18,6 +18,27 @@ env:
   GO_VERSION: "1.24"
 
 jobs:
+  gofmt:
+    permissions:
+      contents: read
+      packages: read
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8  # v5
+
+    - uses: actions/setup-go@44694675825211faa026b3c33043df3e48a5fa00  # v6
+      with:
+        go-version: "${{ env.GO_VERSION }}"
+
+    - name: gofmt check
+      run: |
+        unformatted_files="$(gofmt -l matrix-tools)"
+        if [ "$unformatted_files" != "" ]; then
+          echo "There are .go files that aren't formatted correctly:"
+          echo "$unformatted_files"
+          exit 1
+        fi
+
   tests:
     permissions:
       contents: read

matrix-tools/cmd/main.go

@@ -16,7 +16,6 @@ import (
 	"github.com/element-hq/ess-helm/matrix-tools/internal/pkg/args"
 )
 
-
 func main() {
 	options, err := args.ParseArgs(os.Args)
 	if err != nil {

matrix-tools/internal/cmd/deployment-markers/args.go

@@ -11,15 +11,14 @@ import (
 )
 
 const (
-		FlagSetName = "deployment-markers"
+	FlagSetName = "deployment-markers"
 )
 
 type DeploymentMarkersOptions struct {
-	Labels     map[string]string
+	Labels            map[string]string
 	DeploymentMarkers []DeploymentMarker
 }
 
-
 type DeploymentMarker struct {
 	Name          string
 	Key           string

matrix-tools/internal/cmd/generate-secrets/args.go

@@ -18,14 +18,14 @@ const (
 
 type GenerateSecretsOptions struct {
 	GeneratedSecrets []GeneratedSecret
-	Labels     map[string]string
+	Labels           map[string]string
 }
 
 type GeneratedSecret struct {
-	ArgValue      string
-	Name          string
-	Key           string
-	Type          secret.SecretType
+	ArgValue string
+	Name     string
+	Key      string
+	Type     secret.SecretType
 }
 
 func parseSecretType(value string) (secret.SecretType, error) {
@@ -47,7 +47,6 @@ func parseSecretType(value string) (secret.SecretType, error) {
 	}
 }
 
-
 func ParseArgs(args []string) (*GenerateSecretsOptions, error) {
 	var options GenerateSecretsOptions
 

matrix-tools/internal/cmd/render-config/args.go

@@ -10,14 +10,13 @@ import (
 	"strings"
 )
 
-
 const (
-		FlagSetName = "render-config"
+	FlagSetName = "render-config"
 )
 
 type RenderConfigOptions struct {
-	Files            []string
-	Output           string
+	Files  []string
+	Output string
 }
 
 func ParseArgs(args []string) (*RenderConfigOptions, error) {

matrix-tools/internal/cmd/syn2mas/args.go

@@ -13,10 +13,9 @@ const (
 	FlagSetName = "syn2mas"
 )
 
-
 type Syn2MasOptions struct {
-	SynapseConfig    string
-	MASConfig        string
+	SynapseConfig string
+	MASConfig     string
 }
 
 func ParseArgs(args []string) (*Syn2MasOptions, error) {

matrix-tools/internal/cmd/syn2mas/cmd.go

@@ -8,8 +8,8 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/element-hq/ess-helm/matrix-tools/internal/pkg/util"
 	executor "github.com/element-hq/ess-helm/matrix-tools/internal/pkg/syn2mas"
+	"github.com/element-hq/ess-helm/matrix-tools/internal/pkg/util"
 )
 
 func Run(options *Syn2MasOptions) {

matrix-tools/internal/pkg/args/args.go

@@ -24,14 +24,13 @@ const (
 	TCPWait
 )
 
-
 type Options struct {
-	Command             CommandType
-	RenderConfig        *renderconfig.RenderConfigOptions
-	GenerateSecrets     *generatesecrets.GenerateSecretsOptions
-	DeploymentMarkers     *deploymentmarkers.DeploymentMarkersOptions
-	Syn2Mas             *syn2mas.Syn2MasOptions
-	TcpWait             *tcpwait.TcpWaitOptions
+	Command           CommandType
+	RenderConfig      *renderconfig.RenderConfigOptions
+	GenerateSecrets   *generatesecrets.GenerateSecretsOptions
+	DeploymentMarkers *deploymentmarkers.DeploymentMarkersOptions
+	Syn2Mas           *syn2mas.Syn2MasOptions
+	TcpWait           *tcpwait.TcpWaitOptions
 }
 
 func ParseArgs(args []string) (*Options, error) {

matrix-tools/internal/pkg/args/args_test.go

@@ -5,14 +5,14 @@
 package args
 
 import (
-	"testing"
 	"github.com/stretchr/testify/assert"
+	"testing"
 
 	deploymentmarkers "github.com/element-hq/ess-helm/matrix-tools/internal/cmd/deployment-markers"
 	generatesecrets "github.com/element-hq/ess-helm/matrix-tools/internal/cmd/generate-secrets"
 	renderconfig "github.com/element-hq/ess-helm/matrix-tools/internal/cmd/render-config"
 	"github.com/element-hq/ess-helm/matrix-tools/internal/cmd/syn2mas"
-  "github.com/element-hq/ess-helm/matrix-tools/internal/cmd/tcpwait"
+	"github.com/element-hq/ess-helm/matrix-tools/internal/cmd/tcpwait"
 	"github.com/element-hq/ess-helm/matrix-tools/internal/pkg/secret"
 )
 
@@ -33,7 +33,7 @@ func TestParseArgs(t *testing.T) {
 			name: "Missing --output flag",
 			args: []string{"cmd", "render-config", "file1"},
 			expected: &Options{
-					RenderConfig: &renderconfig.RenderConfigOptions{
+				RenderConfig: &renderconfig.RenderConfigOptions{
 					Files: []string{"file1"},
 				},
 			},
@@ -50,7 +50,7 @@ func TestParseArgs(t *testing.T) {
 			args: []string{"cmd", "render-config", "-output", "outputFile", "file1", "file2"},
 			expected: &Options{
 				RenderConfig: &renderconfig.RenderConfigOptions{
-					Files: []string{"file1", "file2"},
+					Files:  []string{"file1", "file2"},
 					Output: "outputFile",
 				},
 			},
@@ -61,7 +61,7 @@ func TestParseArgs(t *testing.T) {
 			args: []string{"cmd", "render-config", "-output", "outputFile", "file1", "file2"},
 			expected: &Options{
 				RenderConfig: &renderconfig.RenderConfigOptions{
-					Files: []string{"file1", "file2"},
+					Files:  []string{"file1", "file2"},
 					Output: "outputFile",
 				},
 				Command: RenderConfig,
@@ -86,9 +86,9 @@ func TestParseArgs(t *testing.T) {
 				GenerateSecrets: &generatesecrets.GenerateSecretsOptions{
 					GeneratedSecrets: []generatesecrets.GeneratedSecret{
 						{ArgValue: "secret1:value1:rand32", Name: "secret1", Key: "value1", Type: secret.Rand32},
-						},
-					Labels: map[string]string{"app.kubernetes.io/managed-by":"matrix-tools-init-secrets", "mykey":"myval"},
 					},
+					Labels: map[string]string{"app.kubernetes.io/managed-by": "matrix-tools-init-secrets", "mykey": "myval"},
+				},
 				Command: GenerateSecrets,
 			},
 			err: false,
@@ -103,7 +103,7 @@ func TestParseArgs(t *testing.T) {
 						{ArgValue: "secret1:value1:rand32", Name: "secret1", Key: "value1", Type: secret.Rand32},
 						{ArgValue: "secret2:value2:signingkey", Name: "secret2", Key: "value2", Type: secret.SigningKey},
 					},
-					Labels: map[string]string{"app.kubernetes.io/managed-by":"matrix-tools-init-secrets"},
+					Labels: map[string]string{"app.kubernetes.io/managed-by": "matrix-tools-init-secrets"},
 				},
 				Command: GenerateSecrets,
 			},
@@ -132,7 +132,7 @@ func TestParseArgs(t *testing.T) {
 						{Name: "cm1", Key: "key1", Step: "pre", NewValue: "value1", AllowedValues: []string{"value1"}},
 						{Name: "cm1", Key: "key2", Step: "pre", NewValue: "value2", AllowedValues: []string{"value1", "value2"}},
 					},
-					Labels: map[string]string{"app.kubernetes.io/managed-by":"matrix-tools-deployment-markers"},
+					Labels: map[string]string{"app.kubernetes.io/managed-by": "matrix-tools-deployment-markers"},
 				},
 				Command: DeploymentMarkers,
 			},
@@ -147,14 +147,13 @@ func TestParseArgs(t *testing.T) {
 						{Name: "cm1", Key: "key1", Step: "post", NewValue: "value1", AllowedValues: []string{"value1"}},
 						{Name: "cm1", Key: "key2", Step: "post", NewValue: "value2", AllowedValues: []string{"value1", "value2"}},
 					},
-					Labels: map[string]string{"app.kubernetes.io/managed-by":"matrix-tools-deployment-markers"},
+					Labels: map[string]string{"app.kubernetes.io/managed-by": "matrix-tools-deployment-markers"},
 				},
 				Command: DeploymentMarkers,
 			},
 			err: false,
 		},
 
-
 		{
 			name:     "Invalid secret type",
 			args:     []string{"cmd", "generate-secrets", "-secrets", "secret1:value1:unknown"},
@@ -170,30 +169,30 @@ func TestParseArgs(t *testing.T) {
 		},
 
 		{
-			name:     "Proper syntax of syn2mas",
-			args:     []string{"cmd", "syn2mas", "-config", "file1", "-synapse-config", "file2"},
+			name: "Proper syntax of syn2mas",
+			args: []string{"cmd", "syn2mas", "-config", "file1", "-synapse-config", "file2"},
 			expected: &Options{
 				Syn2Mas: &syn2mas.Syn2MasOptions{
-					MASConfig: "file1",
+					MASConfig:     "file1",
 					SynapseConfig: "file2",
 				},
 				Command: Syn2Mas,
 			},
-			err:      false,
+			err: false,
 		},
 		{
-			name:     "Wrong syntax of syn2mas",
-			args:     []string{"cmd", "syn2mas"},
+			name: "Wrong syntax of syn2mas",
+			args: []string{"cmd", "syn2mas"},
 			expected: &Options{
 				Command: Syn2Mas,
 			},
-			err:      true,
+			err: true,
 		},
 	}
 
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
-			options, err := ParseArgs(tc.args);
+			options, err := ParseArgs(tc.args)
 			if tc.err {
 				assert.Error(t, err)
 				assert.Nil(t, options)

matrix-tools/internal/pkg/marker/marker.go

@@ -52,28 +52,28 @@ func GenerateConfigMap(client kubernetes.Interface, labels map[string]string, na
 
 	currentValueIsAllowed := false
 	switch step {
-		case "pre":
-			// During pre-install, we check if the current value is in the allowed values
-			// If it is not, it means the state of the deployment will not support the helm upgrade
-			// and the upgrade will fail
-			if _, ok := existingConfigMap.Data[key]; ok {
-				for _, allowed := range allowedValues {
-					if string(existingConfigMap.Data[key]) == allowed {
-						fmt.Printf("Existing value: %s", string(existingConfigMap.Data[key]))
-						currentValueIsAllowed = true
-						break
-					}
-				}
-				if !currentValueIsAllowed {
-					return fmt.Errorf("%s marker prevented transitioning to value %s from value %s because it is not in the allowed values : %s", key, newValue, string(existingConfigMap.Data[key]), strings.Join(allowedValues, ", "))
+	case "pre":
+		// During pre-install, we check if the current value is in the allowed values
+		// If it is not, it means the state of the deployment will not support the helm upgrade
+		// and the upgrade will fail
+		if _, ok := existingConfigMap.Data[key]; ok {
+			for _, allowed := range allowedValues {
+				if string(existingConfigMap.Data[key]) == allowed {
+					fmt.Printf("Existing value: %s", string(existingConfigMap.Data[key]))
+					currentValueIsAllowed = true
+					break
 				}
 			}
-		case "post":
-			// During post-install, we update the configmap with the new value as the upgrade succeeded
-			existingConfigMap.Data[key] = newValue
-		default:
-			return fmt.Errorf("unknown step: %s", step)
+			if !currentValueIsAllowed {
+				return fmt.Errorf("%s marker prevented transitioning to value %s from value %s because it is not in the allowed values : %s", key, newValue, string(existingConfigMap.Data[key]), strings.Join(allowedValues, ", "))
+			}
 		}
+	case "post":
+		// During post-install, we update the configmap with the new value as the upgrade succeeded
+		existingConfigMap.Data[key] = newValue
+	default:
+		return fmt.Errorf("unknown step: %s", step)
+	}
 
 	_, err = configMapsClient.Update(ctx, existingConfigMap, metav1.UpdateOptions{})
 	if err != nil {