ci(tidy): add tidy check and format codebase (#170)

Add `make tidy` target that runs several Go source code file formatting
checks. Add CI job to verify code formatting is correct.

Remove redundant `make lint` and `make golines` targets and CI jobs.

Change default `make` target to display help.

Apply formatting across the codebase.

Author: tiborsimko

.github/workflows/ci.yml

@@ -79,7 +79,7 @@ jobs:
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
 
-  go-lint:
+  go-tidy:
     runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
@@ -89,30 +89,13 @@ jobs:
         with:
             go-version: '>=1.18.X'
 
-      - name: Run lint action
-        uses: golangci/golangci-lint-action@v4
-        with:
-            version: latest
-            args: --enable=gofmt --enable=goimports
-
-  go-lines:
-    runs-on: ubuntu-24.04
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Setup Go
-        uses: actions/setup-go@v5
-        with:
-            go-version: '>=1.18.X'
-
-      - name: Run golines
+      - name: Check code formatting
         run: |
-            if [[ $(make golines | wc -l) -gt 2 ]]; then
-                echo "Golines would make the following changes:"
-                make golines
+            make tidy
+            if [[ -n $(git status --porcelain) ]]; then
+                echo "Code is not properly formatted. Please run 'make tidy' locally."
+                git diff
                 exit 1
-            else
-                echo "No file exceeds the line size limit"
             fi
 
   go-audit:

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (C) 2022, 2023, 2024 CERN.
+Copyright (C) 2022, 2023, 2024, 2025, 2026 CERN.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -8,7 +8,7 @@
 
 SWAGGER := docker run --rm -it -e GOPATH=$(shell go env GOPATH):/go -v $(HOME):$(HOME) -w $(shell pwd) --pull always quay.io/goswagger/swagger
 
-all: build
+all: help
 
 audit: # Run quality control checks.
 	go install honnef.co/go/tools/cmd/staticcheck@latest
@@ -45,16 +45,16 @@ swagger-validate-specs: # Validate OpenAPI specification.
 test: # Run test suite.
 	go test -coverprofile coverage.txt ./cmd/... ./pkg/...
 
+tidy: # Format code and tidy go.mod.
+	go install github.com/segmentio/golines@latest
+	go install golang.org/x/tools/cmd/goimports@latest
+	go fmt ./...
+	goimports -w .
+	golines -w -m 80 -t 4 .
+	go mod tidy
+
 update: # Update go module dependencies.
 	go get -u
 	go mod tidy
 
-lint: # Run lint checks
-	go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
-	golangci-lint run --enable=gofmt --enable=goimports
-
-golines: # Run line size checks
-	go install github.com/segmentio/golines@latest
-	golines --dry-run ./
-
-.PHONY: all audit build clean help release swagger-generate-client swagger-validate-specs test update lint golines
+.PHONY: all audit build clean help release swagger-generate-client swagger-validate-specs test tidy update

client/client.go

@@ -29,7 +29,9 @@ func ApiClient() (*API, error) {
 		return nil, err
 	}
 	if u.Host == "" {
-		return nil, errors.New("environment variable REANA_SERVER_URL is not set")
+		return nil, errors.New(
+			"environment variable REANA_SERVER_URL is not set",
+		)
 	}
 
 	// create the transport

cmd/close.go

@@ -51,11 +51,18 @@ func newCloseCmd() *cobra.Command {
 	}
 
 	f := cmd.Flags()
-	f.StringVarP(&o.token, "access-token", "t", "", "Access token of the current user.")
+	f.StringVarP(
+		&o.token,
+		"access-token",
+		"t",
+		"",
+		"Access token of the current user.",
+	)
 	f.StringVarP(
 		&o.workflow,
 		"workflow",
-		"w", "",
+		"w",
+		"",
 		"Name or UUID of the workflow. Overrides value of REANA_WORKON environment variable.",
 	)
 
@@ -78,7 +85,10 @@ func (o *closeOptions) run(cmd *cobra.Command) error {
 	}
 
 	displayer.DisplayMessage(
-		fmt.Sprintf("Interactive session for workflow %s was successfully closed", o.workflow),
+		fmt.Sprintf(
+			"Interactive session for workflow %s was successfully closed",
+			o.workflow,
+		),
 		displayer.Success,
 		false,
 		cmd.OutOrStdout(),

cmd/close_test.go

@@ -37,8 +37,10 @@ func TestClose(t *testing.T) {
 					responseFile: "close_no_open.json",
 				},
 			},
-			args:      []string{"-w", "my_workflow"},
-			expected:  []string{"Workflow - my_workflow has no open interactive session."},
+			args: []string{"-w", "my_workflow"},
+			expected: []string{
+				"Workflow - my_workflow has no open interactive session.",
+			},
 			wantError: true,
 		},
 	}

cmd/completion.go

@@ -65,7 +65,10 @@ func newCompletionCmd() *cobra.Command {
 		Long:                  completionLongDesc,
 		DisableFlagsInUseLine: true,
 		ValidArgs:             []string{"bash", "zsh", "fish", "powershell"},
-		Args:                  cobra.MatchAll(cobra.ExactArgs(1), cobra.OnlyValidArgs),
+		Args: cobra.MatchAll(
+			cobra.ExactArgs(1),
+			cobra.OnlyValidArgs,
+		),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			switch args[0] {
 			case "bash":

cmd/delete.go

@@ -53,14 +53,27 @@ func newDeleteCmd() *cobra.Command {
 	}
 
 	f := cmd.Flags()
-	f.StringVarP(&o.token, "access-token", "t", "", "Access token of the current user.")
+	f.StringVarP(
+		&o.token,
+		"access-token",
+		"t",
+		"",
+		"Access token of the current user.",
+	)
 	f.StringVarP(
 		&o.workflow,
 		"workflow",
-		"w", "",
+		"w",
+		"",
 		"Name or UUID of the workflow. Overrides value of REANA_WORKON environment variable.",
 	)
-	f.BoolVarP(&o.includeWorkspace, "include-workspace", "", true, "Delete workspace from REANA.")
+	f.BoolVarP(
+		&o.includeWorkspace,
+		"include-workspace",
+		"",
+		true,
+		"Delete workspace from REANA.",
+	)
 	f.BoolVarP(
 		&o.includeAllRuns,
 		"include-all-runs",
@@ -87,14 +100,22 @@ func (o *deleteOptions) run(cmd *cobra.Command) error {
 	var message string
 	if o.includeAllRuns {
 		name, _ := workflows.GetNameAndRunNumber(o.workflow)
-		message = fmt.Sprintf("All workflows named '%s' have been deleted", name)
+		message = fmt.Sprintf(
+			"All workflows named '%s' have been deleted",
+			name,
+		)
 	} else {
 		message, err = workflows.StatusChangeMessage(o.workflow, "deleted")
 		if err != nil {
 			return err
 		}
 	}
-	displayer.DisplayMessage(message, displayer.Success, false, cmd.OutOrStdout())
+	displayer.DisplayMessage(
+		message,
+		displayer.Success,
+		false,
+		cmd.OutOrStdout(),
+	)
 
 	return nil
 }

cmd/diff.go

@@ -64,11 +64,27 @@ func newDiffCmd() *cobra.Command {
 	}
 
 	f := cmd.Flags()
-	f.StringVarP(&o.token, "access-token", "t", "", "Access token of the current user.")
-	f.BoolVarP(&o.brief, "brief", "q", false, `If not set, differences in the contents of the
-files in the two workspaces are shown.`)
+	f.StringVarP(
+		&o.token,
+		"access-token",
+		"t",
+		"",
+		"Access token of the current user.",
+	)
+	f.BoolVarP(
+		&o.brief,
+		"brief",
+		"q",
+		false,
+		`If not set, differences in the contents of the
+files in the two workspaces are shown.`,
+	)
 	f.IntVarP(
-		&o.unified, "unified", "u", 5, "Sets number of context lines for workspace diff output.",
+		&o.unified,
+		"unified",
+		"u",
+		5,
+		"Sets number of context lines for workspace diff output.",
 	)
 
 	return cmd
@@ -100,7 +116,10 @@ func (o *diffOptions) run(cmd *cobra.Command) error {
 	return nil
 }
 
-func displayDiffPayload(cmd *cobra.Command, p *operations.GetWorkflowDiffOKBody) error {
+func displayDiffPayload(
+	cmd *cobra.Command,
+	p *operations.GetWorkflowDiffOKBody,
+) error {
 	if p.ReanaSpecification != "" {
 		specificationDiff := orderedmap.New()
 		err := json.Unmarshal([]byte(p.ReanaSpecification), &specificationDiff)
@@ -120,21 +139,31 @@ func displayDiffPayload(cmd *cobra.Command, p *operations.GetWorkflowDiffOKBody)
 			sectionDiffs, _ := specificationDiff.Get(section)
 			linesInterface, ok := sectionDiffs.([]any)
 			if !ok {
-				return fmt.Errorf("expected diff to be an array, got %v", sectionDiffs)
+				return fmt.Errorf(
+					"expected diff to be an array, got %v",
+					sectionDiffs,
+				)
 			}
 			lines := make([]string, 0, len(linesInterface))
 			for _, line := range linesInterface {
 				lineString, ok := line.(string)
 				if !ok {
-					return fmt.Errorf("expected diff line to be a string, got %v", line)
+					return fmt.Errorf(
+						"expected diff line to be a string, got %v",
+						line,
+					)
 				}
 				lines = append(lines, lineString)
 			}
 
 			if len(lines) != 0 {
 				equalSpecification = false
 				displayer.PrintColorable(
-					fmt.Sprintf("%s Differences in workflow %s\n", config.LeadingMark, section),
+					fmt.Sprintf(
+						"%s Differences in workflow %s\n",
+						config.LeadingMark,
+						section,
+					),
 					cmd.OutOrStdout(),
 					text.FgYellow,
 					text.Bold,
@@ -144,7 +173,10 @@ func displayDiffPayload(cmd *cobra.Command, p *operations.GetWorkflowDiffOKBody)
 		}
 		if equalSpecification {
 			displayer.PrintColorable(
-				fmt.Sprintf("%s No differences in REANA specifications.\n", config.LeadingMark),
+				fmt.Sprintf(
+					"%s No differences in REANA specifications.\n",
+					config.LeadingMark,
+				),
 				cmd.OutOrStdout(),
 				text.FgYellow,
 				text.Bold,
@@ -162,7 +194,10 @@ func displayDiffPayload(cmd *cobra.Command, p *operations.GetWorkflowDiffOKBody)
 		workspaceDiff := datautils.SplitLinesNoEmpty(workspaceDiffRaw)
 
 		displayer.PrintColorable(
-			fmt.Sprintf("%s Differences in workflow workspace\n", config.LeadingMark),
+			fmt.Sprintf(
+				"%s Differences in workflow workspace\n",
+				config.LeadingMark,
+			),
 			cmd.OutOrStdout(),
 			text.FgYellow,
 			text.Bold,

cmd/diff_test.go

@@ -141,8 +141,18 @@ func TestPrintDiff(t *testing.T) {
 			expectedColors: []text.Color{text.FgGreen},
 		},
 		"mixed text": {
-			lines:          []string{"@@ -1 +1 @@", "context", "- removed text", "+ added text"},
-			expectedColors: []text.Color{text.FgCyan, text.Reset, text.FgRed, text.FgGreen},
+			lines: []string{
+				"@@ -1 +1 @@",
+				"context",
+				"- removed text",
+				"+ added text",
+			},
+			expectedColors: []text.Color{
+				text.FgCyan,
+				text.Reset,
+				text.FgRed,
+				text.FgGreen,
+			},
 		},
 	}
 
@@ -153,11 +163,19 @@ func TestPrintDiff(t *testing.T) {
 			result := datautils.SplitLinesNoEmpty(resBuf.String())
 
 			if len(result) != len(test.lines) {
-				t.Fatalf("Expected %d lines, got %d", len(test.lines), len(result))
+				t.Fatalf(
+					"Expected %d lines, got %d",
+					len(test.lines),
+					len(result),
+				)
 			}
 			for i, line := range result {
 				testBuf := new(bytes.Buffer)
-				displayer.PrintColorable(test.lines[i], testBuf, test.expectedColors[i])
+				displayer.PrintColorable(
+					test.lines[i],
+					testBuf,
+					test.expectedColors[i],
+				)
 				expected := testBuf.String()
 				if line != expected {
 					t.Errorf("Expected %s, got %s", expected, line)