Merge remote-tracking branch 'origin/main'

Author: mcasperson

.github/workflows/go.yaml

@@ -33,7 +33,7 @@ jobs:
 
       - name: Split integration tests
         id: test_split
-        uses: hashicorp-forge/go-test-split-action@v1
+        uses: hashicorp-forge/go-test-split-action@v2.0.0
         with:
           index: ${{ matrix.index }}
           total: ${{ matrix.parallel }}
@@ -202,7 +202,8 @@ jobs:
         env:
           GOOS: darwin
           GOARCH: arm64
-          CGO_ENABLED: 0
+          CGO_ENABLED: 0    
+      # Create azure version for linux_amd64
       - run: go build -ldflags="-X 'main.Version=${{ steps.determine_version.outputs.semVer }}'" -o functions/octolint_linux_amd64_azure cmd/azure/octolint.go
         env:
           GOOS: linux
@@ -213,7 +214,28 @@ jobs:
       - run: |
           zip -r octolint_linux_amd64_azure.zip . -x local.settings.json
           cp octolint_linux_amd64_azure.zip octolint_azure.${{ steps.determine_version.outputs.semVer }}.zip
-        working-directory: functions
+        working-directory: functions    
+      # Create azure version for macOS (amd64 and arm64)
+      - run: go build -ldflags="-X 'entry.Version=${{ steps.determine_version.outputs.semVer }}'" -o functions/octolint_macos_amd64_azure cmd/azure/octolint.go
+        env:
+          GOOS: darwin
+          GOARCH: amd64
+          CGO_ENABLED: 0
+      - run: go build -ldflags="-X 'entry.Version=${{ steps.determine_version.outputs.semVer }}'" -o functions/octolint_macos_arm64_azure cmd/azure/octolint.go
+        env:
+          GOOS: darwin
+          GOARCH: arm64
+          CGO_ENABLED: 0
+      - run: go build -ldflags="-X 'entry.Version=${{ steps.determine_version.outputs.semVer }}'" -o functions/octolint_windows_amd64_azure.exe cmd/azure/octolint.go
+        env:
+          GOOS: windows
+          GOARCH: amd64
+          CGO_ENABLED: 0               
+      # Create macOS azure version zips
+      - run: |
+          zip -r octolint_macos_arm64_azure.zip . -x local.settings.json -x octolint_linux_amd64_azure -x octolint_linux_amd64_azure.zip -x octolint_windows_amd64_azure.exe -x octolint_macos_amd64_azure 
+          zip -r octolint_macos_amd64_azure.zip . -x local.settings.json -x octolint_linux_amd64_azure -x octolint_linux_amd64_azure.zip -x octolint_windows_amd64_azure.exe -x octolint_macos_arm64_azure -x octolint_macos_arm64_azure.zip
+        working-directory: functions        
       - id: create_release
         uses: "marvinpinto/action-automatic-releases@latest"
         with:
@@ -249,7 +271,7 @@ jobs:
           asset_path: octolint_macos_arm64
           asset_name: octolint_macos_arm64
           asset_content_type: application/octet-stream
-      - name: Upload Azure Functions Release Asset
+      - name: Upload linux amd64 Azure Functions Release Asset
         uses: actions/upload-release-asset@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -258,6 +280,33 @@ jobs:
           asset_path: functions/octolint_linux_amd64_azure.zip
           asset_name: octolint_linux_amd64_azure.zip
           asset_content_type: application/octet-stream
+      - name: Upload macOS amd64 Azure Functions Release Asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: functions/octolint_macos_amd64_azure.zip
+          asset_name: octolint_macos_amd64_azure.zip
+          asset_content_type: application/octet-stream
+      - name: Upload macOS arm64 Azure Functions Release Asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: functions/octolint_macos_arm64_azure.zip
+          asset_name: octolint_macos_arm64_azure.zip
+          asset_content_type: application/octet-stream
+      - name: Upload windows amd64 Azure Functions Release Asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: functions/octolint_windows_amd64_azure.exe
+          asset_name: octolint_windows_amd64_azure.exe
+          asset_content_type: application/octet-stream                              
       - name: Push packages to Octopus Deploy
         if: ${{ steps.branch-name.outputs.current_branch == 'main' }}
         uses: OctopusDeploy/push-package-action@v3

Dockerfile

@@ -1,6 +1,6 @@
 # syntax=docker/dockerfile:1
 
-FROM golang:1.22 as build
+FROM golang:1.23 AS build
 
 ARG Version=development
 

README.md

@@ -11,7 +11,7 @@ This CLI tool scans an Octopus instance to find potential issues in the configur
 Feel free to report
 an [issue](https://github.com/OctopusSalesEngineering/OctopusRecommendationEngine/issues).
 
-This tool is not officially supported by Octopus. Please do not contact the Octopus support channels regarding octolint.
+Alternatively, contact [Octopus Support](https://octopus.com/support). 
 
 ## Usage
 

cmd/azure/octolint.go

@@ -5,13 +5,17 @@ import (
 	"github.com/OctopusSolutionsEngineering/OctopusRecommendationEngine/internal/args"
 	"github.com/OctopusSolutionsEngineering/OctopusRecommendationEngine/internal/checks"
 	"github.com/OctopusSolutionsEngineering/OctopusRecommendationEngine/internal/entry"
+	"github.com/OctopusSolutionsEngineering/OctopusRecommendationEngine/internal/environment"
 	"github.com/OctopusSolutionsEngineering/OctopusRecommendationEngine/internal/reporters"
 	"go.uber.org/zap"
 	"io"
 	"log"
 	"net/http"
+	"net/url"
 	"os"
 	"path/filepath"
+	"strconv"
+	"strings"
 )
 
 type AzureFunctionRequestDataReq struct {
@@ -29,7 +33,20 @@ type AzureFunctionRequest struct {
 func octoterraHandler(w http.ResponseWriter, r *http.Request) {
 	// Allow the more sensitive values to be passed as headers
 	apiKey := r.Header.Get("X-Octopus-ApiKey")
+	accessToken := r.Header.Get("X-Octopus-AccessToken")
 	url := r.Header.Get("X-Octopus-Url")
+	redirectorRedirections := r.Header.Get("X_REDIRECTION_REDIRECTIONS")
+	redirectorApiKey := r.Header.Get("X_REDIRECTION_API_KEY")
+	redirectorServiceApiKey, _ := os.LookupEnv("REDIRECTION_SERVICE_API_KEY")
+	redirectorHost, _ := os.LookupEnv("REDIRECTION_HOST")
+	disableRedirector, _ := os.LookupEnv("DISABLE_REDIRECTION")
+
+	enableRedirector, err := useRedirector(url, disableRedirector, redirectorServiceApiKey, redirectorHost, redirectorRedirections, redirectorApiKey)
+
+	if err != nil {
+		handleError(err, w)
+		return
+	}
 
 	respBytes, err := io.ReadAll(r.Body)
 
@@ -81,12 +98,22 @@ func octoterraHandler(w http.ResponseWriter, r *http.Request) {
 
 	if apiKey != "" {
 		commandLineArgs = append(commandLineArgs, "-apiKey", apiKey)
+	} else if accessToken != "" {
+		commandLineArgs = append(commandLineArgs, "-accessToken", accessToken)
 	}
 
 	if url != "" {
 		commandLineArgs = append(commandLineArgs, "-url", url)
 	}
 
+	if enableRedirector {
+		commandLineArgs = append(commandLineArgs, "-useRedirector")
+		commandLineArgs = append(commandLineArgs, "-redirectorHost", redirectorHost)
+		commandLineArgs = append(commandLineArgs, "-redirectorServiceApiKey", redirectorServiceApiKey)
+		commandLineArgs = append(commandLineArgs, "-redirecrtorApiKey", redirectorApiKey)
+		commandLineArgs = append(commandLineArgs, "-redirectorRedirections", redirectorRedirections)
+	}
+
 	webArgs, err := args.ParseArgs(commandLineArgs)
 
 	if err != nil {
@@ -116,6 +143,31 @@ func octoterraHandler(w http.ResponseWriter, r *http.Request) {
 	}
 }
 
+func useRedirector(octopusUrl string, disableRedirector string, redirectorServiceApiKey string, redirectorHost string, redirections string, redirectorApiKey string) (bool, error) {
+	parsedUrl, err := url.Parse(octopusUrl)
+
+	if err != nil {
+		return false, err
+	}
+
+	disableRedirectorParsed, err := strconv.ParseBool(disableRedirector)
+
+	if err != nil {
+		disableRedirectorParsed = false
+	}
+
+	return !disableRedirectorParsed && redirectorServiceApiKey != "" && redirectorHost != "" &&
+		(!hostIsCloudOrLocal(parsedUrl.Hostname()) ||
+			(redirections != "" && redirectorApiKey != "")), nil
+}
+
+func hostIsCloudOrLocal(host string) bool {
+	return strings.HasSuffix(host, ".octopus.app") ||
+		strings.HasSuffix(host, ".testoctopus.com") ||
+		host == "localhost" ||
+		host == "127.0.0.1"
+}
+
 // sanitizeConfig removes sensitive information from the config so it is not
 // persisted to the disk.
 func sanitizeConfig(rawConfig []byte) ([]byte, error) {
@@ -129,6 +181,11 @@ func sanitizeConfig(rawConfig []byte) ([]byte, error) {
 	}
 	delete(config, "apiKey")
 	delete(config, "url")
+	delete(config, "redirectorServiceApiKey")
+	delete(config, "redirecrtorApiKey")
+	delete(config, "redirectorHost")
+	delete(config, "useRedirector")
+	delete(config, "redirectorRedirections")
 	return json.Marshal(config)
 }
 
@@ -141,10 +198,7 @@ func handleError(err error, w http.ResponseWriter) {
 }
 
 func main() {
-	listenAddr := ":8080"
-	if val, ok := os.LookupEnv("FUNCTIONS_CUSTOMHANDLER_PORT"); ok {
-		listenAddr = ":" + val
-	}
+	listenAddr := ":" + environment.GetPort()
 	http.HandleFunc("/api/octolint", func(writer http.ResponseWriter, request *http.Request) {
 		switch request.Method {
 		case http.MethodPost:

go.mod

@@ -1,113 +1,107 @@
 module github.com/OctopusSolutionsEngineering/OctopusRecommendationEngine
 
-go 1.21
+go 1.23.0
 
-toolchain go1.22.1
+toolchain go1.23.7
 
 require (
-	github.com/OctopusDeploy/go-octopusdeploy/v2 v2.51.1
-	github.com/OctopusSolutionsEngineering/OctopusTerraformTestFramework v0.0.0-20240820223218-e33b5c4d2771
-	github.com/avast/retry-go/v4 v4.5.1
-	github.com/briandowns/spinner v1.23.0
-	github.com/samber/lo v1.39.0
-	github.com/spf13/pflag v1.0.5
-	github.com/spf13/viper v1.18.2
+	github.com/OctopusDeploy/go-octopusdeploy/v2 v2.65.5
+	github.com/OctopusSolutionsEngineering/OctopusTerraformTestFramework v1.0.0
+	github.com/avast/retry-go/v4 v4.6.1
+	github.com/briandowns/spinner v1.23.2
+	github.com/hayageek/threadsafe v1.0.1
+	github.com/samber/lo v1.49.1
+	github.com/spf13/viper v1.20.1
 	go.uber.org/zap v1.27.0
-	golang.org/x/exp v0.0.0-20230905200255-921286631fa9
-	golang.org/x/sync v0.8.0
+	golang.org/x/exp v0.0.0-20250305212735-054e65f0b394
+	golang.org/x/sync v0.12.0
 )
 
 require (
 	dario.cat/mergo v1.0.1 // indirect
-	github.com/Azure/go-ansiterm v0.0.0-20230124172434-306776ec8161 // indirect
+	github.com/Azure/go-ansiterm v0.0.0-20250102033503-faa5f7b0171c // indirect
 	github.com/Microsoft/go-winio v0.6.2 // indirect
-	github.com/Microsoft/hcsshim v0.11.7 // indirect
 	github.com/OctopusDeploy/go-octodiff v1.0.0 // indirect
 	github.com/bahlo/generic-list-go v0.2.0 // indirect
 	github.com/buger/jsonparser v1.1.1 // indirect
 	github.com/cenkalti/backoff/v4 v4.3.0 // indirect
-	github.com/containerd/containerd v1.7.20 // indirect
 	github.com/containerd/log v0.1.0 // indirect
 	github.com/containerd/platforms v0.2.1 // indirect
-	github.com/cpuguy83/dockercfg v0.3.1 // indirect
+	github.com/cpuguy83/dockercfg v0.3.2 // indirect
 	github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
 	github.com/dghubble/sling v1.4.1 // indirect
 	github.com/distribution/reference v0.6.0 // indirect
-	github.com/docker/distribution v2.8.2+incompatible // indirect
-	github.com/docker/docker v27.1.2+incompatible // indirect
+	github.com/docker/docker v27.5.1+incompatible // indirect
 	github.com/docker/go-connections v0.5.0 // indirect
 	github.com/docker/go-units v0.5.0 // indirect
-	github.com/fatih/color v1.14.1 // indirect
+	github.com/fatih/color v1.18.0 // indirect
 	github.com/felixge/httpsnoop v1.0.4 // indirect
-	github.com/fsnotify/fsnotify v1.7.0 // indirect
-	github.com/gabriel-vasile/mimetype v1.4.5 // indirect
+	github.com/fsnotify/fsnotify v1.8.0 // indirect
+	github.com/gabriel-vasile/mimetype v1.4.8 // indirect
 	github.com/go-logr/logr v1.4.2 // indirect
 	github.com/go-logr/stdr v1.2.2 // indirect
 	github.com/go-ole/go-ole v1.3.0 // indirect
 	github.com/go-playground/locales v0.14.1 // indirect
 	github.com/go-playground/universal-translator v0.18.1 // indirect
-	github.com/go-playground/validator/v10 v10.22.0 // indirect
+	github.com/go-playground/validator/v10 v10.25.0 // indirect
+	github.com/go-viper/mapstructure/v2 v2.2.1 // indirect
 	github.com/gogo/protobuf v1.3.2 // indirect
 	github.com/golang-collections/collections v0.0.0-20130729185459-604e922904d3 // indirect
-	github.com/golang/protobuf v1.5.4 // indirect
 	github.com/google/go-querystring v1.1.0 // indirect
 	github.com/google/uuid v1.6.0 // indirect
-	github.com/hashicorp/hcl v1.0.0 // indirect
-	github.com/hayageek/threadsafe v1.0.1 // indirect
-	github.com/klauspost/compress v1.17.9 // indirect
+	github.com/klauspost/compress v1.17.11 // indirect
 	github.com/leodido/go-urn v1.4.0 // indirect
-	github.com/lufia/plan9stats v0.0.0-20240819163618-b1d8f4d146e7 // indirect
-	github.com/magiconair/properties v1.8.7 // indirect
+	github.com/lufia/plan9stats v0.0.0-20240909124753-873cd0166683 // indirect
+	github.com/magiconair/properties v1.8.9 // indirect
 	github.com/mailru/easyjson v0.7.7 // indirect
-	github.com/mattn/go-colorable v0.1.13 // indirect
-	github.com/mattn/go-isatty v0.0.17 // indirect
-	github.com/mitchellh/mapstructure v1.5.0 // indirect
+	github.com/mattn/go-colorable v0.1.14 // indirect
+	github.com/mattn/go-isatty v0.0.20 // indirect
 	github.com/moby/docker-image-spec v1.3.1 // indirect
 	github.com/moby/patternmatcher v0.6.0 // indirect
 	github.com/moby/sys/sequential v0.6.0 // indirect
 	github.com/moby/sys/user v0.3.0 // indirect
 	github.com/moby/sys/userns v0.1.0 // indirect
-	github.com/moby/term v0.5.0 // indirect
+	github.com/moby/term v0.5.2 // indirect
 	github.com/morikuni/aec v1.0.0 // indirect
 	github.com/opencontainers/go-digest v1.0.0 // indirect
 	github.com/opencontainers/image-spec v1.1.0 // indirect
-	github.com/opencontainers/runc v1.1.5 // indirect
 	github.com/otiai10/copy v1.14.0 // indirect
-	github.com/pelletier/go-toml/v2 v2.1.0 // indirect
+	github.com/pelletier/go-toml/v2 v2.2.3 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
 	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
 	github.com/power-devops/perfstat v0.0.0-20240221224432-82ca36839d55 // indirect
-	github.com/sagikazarmark/locafero v0.4.0 // indirect
-	github.com/sagikazarmark/slog-shim v0.1.0 // indirect
+	github.com/sagikazarmark/locafero v0.9.0 // indirect
 	github.com/shirou/gopsutil/v3 v3.24.5 // indirect
 	github.com/shoenig/go-m1cpu v0.1.6 // indirect
 	github.com/sirupsen/logrus v1.9.3 // indirect
 	github.com/sourcegraph/conc v0.3.0 // indirect
-	github.com/spf13/afero v1.11.0 // indirect
-	github.com/spf13/cast v1.6.0 // indirect
-	github.com/stretchr/testify v1.9.0 // indirect
+	github.com/spf13/afero v1.14.0 // indirect
+	github.com/spf13/cast v1.7.1 // indirect
+	github.com/spf13/pflag v1.0.6 // indirect
+	github.com/stretchr/testify v1.10.0 // indirect
 	github.com/subosito/gotenv v1.6.0 // indirect
-	github.com/testcontainers/testcontainers-go v0.33.0 // indirect
+	github.com/testcontainers/testcontainers-go v0.35.0 // indirect
 	github.com/tklauser/go-sysconf v0.3.14 // indirect
-	github.com/tklauser/numcpus v0.8.0 // indirect
+	github.com/tklauser/numcpus v0.9.0 // indirect
 	github.com/wk8/go-ordered-map/v2 v2.1.8 // indirect
 	github.com/yusufpapurcu/wmi v1.2.4 // indirect
-	go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.53.0 // indirect
-	go.opentelemetry.io/otel v1.28.0 // indirect
-	go.opentelemetry.io/otel/metric v1.28.0 // indirect
-	go.opentelemetry.io/otel/trace v1.28.0 // indirect
-	go.uber.org/atomic v1.9.0 // indirect
+	go.opentelemetry.io/auto/sdk v1.1.0 // indirect
+	go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.59.0 // indirect
+	go.opentelemetry.io/otel v1.34.0 // indirect
+	go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.19.0 // indirect
+	go.opentelemetry.io/otel/metric v1.34.0 // indirect
+	go.opentelemetry.io/otel/sdk v1.29.0 // indirect
+	go.opentelemetry.io/otel/trace v1.34.0 // indirect
+	go.opentelemetry.io/proto/otlp v1.0.0 // indirect
 	go.uber.org/multierr v1.11.0 // indirect
-	golang.org/x/crypto v0.26.0 // indirect
-	golang.org/x/mod v0.17.0 // indirect
-	golang.org/x/net v0.27.0 // indirect
-	golang.org/x/sys v0.24.0 // indirect
-	golang.org/x/term v0.23.0 // indirect
-	golang.org/x/text v0.17.0 // indirect
-	golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d // indirect
-	google.golang.org/genproto/googleapis/rpc v0.0.0-20240318140521-94a12d6c2237 // indirect
-	google.golang.org/grpc v1.64.1 // indirect
-	google.golang.org/protobuf v1.33.0 // indirect
-	gopkg.in/ini.v1 v1.67.0 // indirect
+	golang.org/x/crypto v0.32.0 // indirect
+	golang.org/x/net v0.34.0 // indirect
+	golang.org/x/sys v0.31.0 // indirect
+	golang.org/x/term v0.30.0 // indirect
+	golang.org/x/text v0.23.0 // indirect
+	google.golang.org/genproto/googleapis/api v0.0.0-20241209162323-e6fa225c2576 // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20241206012308-a4fef0638583 // indirect
+	google.golang.org/grpc v1.67.1 // indirect
+	google.golang.org/protobuf v1.35.2 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )