Added support for access token

Author: mcasperson

cmd/azure/octolint.go

@@ -29,6 +29,7 @@ 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")
 
 	respBytes, err := io.ReadAll(r.Body)
@@ -81,6 +82,8 @@ 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 != "" {

internal/args/args.go

@@ -29,6 +29,7 @@ func ParseArgs(args []string) (*config.OctolintConfig, error) {
 	flags.StringVar(&octolintConfig.Url, "url", "", "The Octopus URL e.g. https://myinstance.octopus.app")
 	flags.StringVar(&octolintConfig.Space, "space", "", "The Octopus space name or ID")
 	flags.StringVar(&octolintConfig.ApiKey, "apiKey", "", "The Octopus api key")
+	flags.StringVar(&octolintConfig.AccessToken, "accessToken", "", "The Octopus access token")
 	flags.StringVar(&octolintConfig.SkipTests, "skipTests", "", "A comma separated list of tests to skip")
 	flags.StringVar(&octolintConfig.OnlyTests, "onlyTests", "", "A comma separated list of tests to include")
 	flags.StringVar(&octolintConfig.ConfigFile, "configFile", "octolint", "The name of the configuration file to use. Do not include the extension. Defaults to octolint")
@@ -98,7 +99,7 @@ func ParseArgs(args []string) (*config.OctolintConfig, error) {
 		octolintConfig.Url = os.Getenv("OCTOPUS_CLI_SERVER")
 	}
 
-	if octolintConfig.ApiKey == "" {
+	if octolintConfig.ApiKey == "" && octolintConfig.AccessToken == "" {
 		octolintConfig.ApiKey = os.Getenv("OCTOPUS_CLI_API_KEY")
 	}
 

internal/config/args.go

@@ -9,6 +9,7 @@ type OctolintConfig struct {
 	Url           string
 	Space         string
 	ApiKey        string
+	AccessToken   string
 	SkipTests     string
 	OnlyTests     string
 	VerboseErrors bool

internal/entry/entry.go

@@ -4,13 +4,13 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
+	"github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/client"
 	"github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/resources"
 	"github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/spaces"
 	"github.com/OctopusSolutionsEngineering/OctopusRecommendationEngine/internal/checks"
 	"github.com/OctopusSolutionsEngineering/OctopusRecommendationEngine/internal/checks/factory"
 	"github.com/OctopusSolutionsEngineering/OctopusRecommendationEngine/internal/config"
 	"github.com/OctopusSolutionsEngineering/OctopusRecommendationEngine/internal/executor"
-	"github.com/OctopusSolutionsEngineering/OctopusTerraformTestFramework/octoclient"
 	"github.com/briandowns/spinner"
 	"go.uber.org/zap"
 	"go.uber.org/zap/zapcore"
@@ -51,7 +51,7 @@ func Entry(octolintConfig *config.OctolintConfig) ([]checks.OctopusCheckResult,
 		return nil, errors.New("The URL \"" + octolintConfig.Url + "\" is not valid")
 	}
 
-	if octolintConfig.ApiKey == "" {
+	if octolintConfig.ApiKey == "" && octolintConfig.AccessToken == "" {
 		return nil, errors.New("You must specify the API key with the -apiKey argument")
 	}
 
@@ -60,7 +60,7 @@ func Entry(octolintConfig *config.OctolintConfig) ([]checks.OctopusCheckResult,
 	}
 
 	if !strings.HasPrefix(octolintConfig.Space, "Spaces-") {
-		spaceId, err := lookupSpaceAsName(octolintConfig.Url, octolintConfig.Space, octolintConfig.ApiKey)
+		spaceId, err := lookupSpaceAsName(octolintConfig.Url, octolintConfig.Space, octolintConfig.ApiKey, octolintConfig.AccessToken)
 
 		if err != nil {
 			return nil, errors.New("Failed to create the Octopus client_wrapper. Check that the url, api key, and space are correct.\nThe error was: " + err.Error())
@@ -69,7 +69,7 @@ func Entry(octolintConfig *config.OctolintConfig) ([]checks.OctopusCheckResult,
 		octolintConfig.Space = spaceId
 	}
 
-	client, err := octoclient.CreateClient(octolintConfig.Url, octolintConfig.Space, octolintConfig.ApiKey)
+	client, err := createClient(octolintConfig.Url, octolintConfig.Space, octolintConfig.ApiKey, octolintConfig.AccessToken)
 
 	if err != nil {
 		return nil, errors.New("Failed to create the Octopus client_wrapper. Check that the url, api key, and space are correct.\nThe error was: " + err.Error())
@@ -109,12 +109,42 @@ func Entry(octolintConfig *config.OctolintConfig) ([]checks.OctopusCheckResult,
 	return results, nil
 }
 
+func createClient(octopusUrl string, spaceId string, apiKey string, accessToken string) (*client.Client, error) {
+	url, err := url.Parse(octopusUrl)
+
+	if err != nil {
+		return nil, err
+	}
+
+	if apiKey != "" {
+		return createClientApiKey(url, spaceId, apiKey)
+	}
+
+	return createClientAccessToken(url, spaceId, accessToken)
+}
+
+func createClientApiKey(apiURL *url.URL, spaceId string, apiKey string) (*client.Client, error) {
+	apiKeyCredential, err := client.NewApiKey(apiKey)
+	if err != nil {
+		return nil, err
+	}
+	return client.NewClientWithCredentials(nil, apiURL, apiKeyCredential, spaceId, "")
+}
+
+func createClientAccessToken(apiURL *url.URL, spaceId string, accessToken string) (*client.Client, error) {
+	accessTokenCredential, err := client.NewAccessToken(accessToken)
+	if err != nil {
+		return nil, err
+	}
+	return client.NewClientWithCredentials(nil, apiURL, accessTokenCredential, spaceId, "")
+}
+
 func ErrorExit(message string) {
 	fmt.Println(message)
 	os.Exit(1)
 }
 
-func lookupSpaceAsName(octopusUrl string, spaceName string, apiKey string) (string, error) {
+func lookupSpaceAsName(octopusUrl string, spaceName string, apiKey string, accessToken string) (string, error) {
 	if len(strings.TrimSpace(spaceName)) == 0 {
 		return "", errors.New("space can not be empty")
 	}
@@ -129,6 +159,8 @@ func lookupSpaceAsName(octopusUrl string, spaceName string, apiKey string) (stri
 
 	if apiKey != "" {
 		req.Header.Set("X-Octopus-ApiKey", apiKey)
+	} else if accessToken != "" {
+		req.Header.Set("Authorization", "Bearer "+accessToken)
 	}
 
 	res, err := http.DefaultClient.Do(req)