CLOUDP-304437: Evaluate the use of pre-built bin for api-generator (#3735)

Author: jeroenvervaeke

.golangci.yml

@@ -31,6 +31,8 @@ linters-settings:
         alias: pluginCmd
       - pkg: github.com/mongodb/mongodb-atlas-cli/atlascli/internal/transport
         alias: storeTransport
+      - pkg: github.com/mongodb/mongodb-atlas-cli/atlascli/tools/shared/api
+        alias: shared_api
   misspell:
     locale: US
     ignore-words:

Makefile

@@ -105,14 +105,11 @@ addcopy: ## Add missing license to files
 .PHONY: generate
 generate: gen-docs gen-mocks gen-api-commands ## Generate docs, mocks, code, api commands, all auto generated assets
 
-bin/api-generator:
-	go build -o ./bin/api-generator ./tools/cmd/api-generator
-
 .PHONY: gen-api-commands
-gen-api-commands: bin/api-generator ## Generate api commands
+gen-api-commands: ## Generate api commands
 	@echo "==> Generating api commands"
-	bin/api-generator --spec ./tools/cmd/api-generator/spec.yaml --overlay ./tools/cmd/api-generator/overlays --output-type commands > ./internal/api/commands.go
-	bin/api-generator --spec ./tools/cmd/api-generator/spec.yaml --overlay ./tools/cmd/api-generator/overlays --output-type metadata > ./tools/cmd/docs/metadata.go
+	go run ./tools/cmd/api-generator --spec ./tools/cmd/api-generator/spec.yaml --overlay ./tools/cmd/api-generator/overlays --output-type commands > ./internal/api/commands.go
+	go run ./tools/cmd/api-generator --spec ./tools/cmd/api-generator/spec.yaml --overlay ./tools/cmd/api-generator/overlays --output-type metadata > ./tools/cmd/docs/metadata.go
 
 .PHONY: otel
 otel: ## Generate code

internal/api/commands.go

@@ -20,6 +20,8 @@ import (
 	"net/http"
 	"net/url"
 	"strings"
+
+	shared_api "github.com/mongodb/mongodb-atlas-cli/atlascli/tools/shared/api"
 )
 
 var (
@@ -98,7 +100,7 @@ func ConvertToHTTPRequest(baseURL string, request CommandRequest) (*http.Request
 // > The default serialization method is style: simple and explode: false.
 // > Given the path /users/{id}, the path parameter id is serialized as follows:
 // > style: simple + exploded: false, example template /users/{id}, single value: /users/5, array: /users/3,4,5.
-func buildPath(path string, commandURLParameters []Parameter, parameterValues map[string][]string) (string, error) {
+func buildPath(path string, commandURLParameters []shared_api.Parameter, parameterValues map[string][]string) (string, error) {
 	for _, commandURLParameter := range commandURLParameters {
 		values, exist := parameterValues[commandURLParameter.Name]
 		if !exist || len(values) == 0 {
@@ -120,7 +122,7 @@ func buildPath(path string, commandURLParameters []Parameter, parameterValues ma
 // https://swagger.io/docs/specification/v3_0/serialization/#query-parameters
 // Our spec only contains the default:
 // style: form + exploded: true, example template /users{?id*}, single value: /users?id=5, array: /users?id=3&id=4&id=5
-func buildQueryParameters(commandQueryParameters []Parameter, parameterValues map[string][]string) (string, error) {
+func buildQueryParameters(commandQueryParameters []shared_api.Parameter, parameterValues map[string][]string) (string, error) {
 	query := new(url.URL).Query()
 
 	for _, commandQueryParameter := range commandQueryParameters {
@@ -143,7 +145,7 @@ func buildQueryParameters(commandQueryParameters []Parameter, parameterValues ma
 }
 
 // select a version from a list of versions, throws an error if no match is found.
-func selectVersion(versionString string, versions []Version) (*Version, error) {
+func selectVersion(versionString string, versions []shared_api.Version) (*shared_api.Version, error) {
 	for _, version := range versions {
 		if version.Version == versionString {
 			return &version, nil
@@ -155,7 +157,7 @@ func selectVersion(versionString string, versions []Version) (*Version, error) {
 
 // generate the accept header using the given format string
 // try to find the content type in the list of response content types, if not found set the type to json.
-func acceptHeader(version *Version, requestedContentType string) (string, error) {
+func acceptHeader(version *shared_api.Version, requestedContentType string) (string, error) {
 	contentType := ""
 	supportedTypes := make([]string, 0)
 
@@ -174,7 +176,7 @@ func acceptHeader(version *Version, requestedContentType string) (string, error)
 	return fmt.Sprintf("application/vnd.atlas.%s+%s", version.Version, contentType), nil
 }
 
-func contentType(version *Version) *string {
+func contentType(version *shared_api.Version) *string {
 	if version.RequestContentType != "" {
 		contentType := fmt.Sprintf("application/vnd.atlas.%s+%s", version.Version, version.RequestContentType)
 		return &contentType

internal/api/httprequest.go

@@ -20,13 +20,14 @@ import (
 	"strings"
 	"testing"
 
+	shared_api "github.com/mongodb/mongodb-atlas-cli/atlascli/tools/shared/api"
 	"github.com/stretchr/testify/require"
 )
 
 func TestBuildQueryParameters(t *testing.T) {
 	tests := []struct {
 		name                   string
-		commandQueryParameters []Parameter
+		commandQueryParameters []shared_api.Parameter
 		parameterValues        map[string][]string
 		shouldFail             bool
 		expectedValue          string
@@ -87,7 +88,7 @@ func TestBuildQueryParameters(t *testing.T) {
 
 		{
 			name:                   "missing query parameters",
-			commandQueryParameters: []Parameter{{Name: "required-test-query-parameter", Required: true, Type: ParameterType{IsArray: false, Type: TypeBool}}},
+			commandQueryParameters: []shared_api.Parameter{{Name: "required-test-query-parameter", Required: true, Type: shared_api.ParameterType{IsArray: false, Type: shared_api.TypeBool}}},
 			parameterValues:        map[string][]string{},
 			shouldFail:             true,
 		},
@@ -111,7 +112,7 @@ func TestBuildPath(t *testing.T) {
 	tests := []struct {
 		name                 string
 		pathTemplate         string
-		commandURLParameters []Parameter
+		commandURLParameters []shared_api.Parameter
 		parameterValues      map[string][]string
 		shouldFail           bool
 		expectedValue        string
@@ -154,9 +155,9 @@ func TestBuildPath(t *testing.T) {
 		{
 			name:         "escape path values",
 			pathTemplate: "/api/atlas/v2/groups/{groupId}/accessList/{entryValue}",
-			commandURLParameters: []Parameter{
-				{Name: "groupId", Required: true, Type: ParameterType{IsArray: false, Type: TypeString}},
-				{Name: "entryValue", Required: true, Type: ParameterType{IsArray: false, Type: TypeString}},
+			commandURLParameters: []shared_api.Parameter{
+				{Name: "groupId", Required: true, Type: shared_api.ParameterType{IsArray: false, Type: shared_api.TypeString}},
+				{Name: "entryValue", Required: true, Type: shared_api.ParameterType{IsArray: false, Type: shared_api.TypeString}},
 			},
 			parameterValues: map[string][]string{
 				"groupId":    {"groupId-01"},
@@ -314,17 +315,17 @@ func TestConvertToHttpRequest(t *testing.T) {
 
 // Please keep fixtures below this command
 // Trying to keep this file readable.
-var getCollStatsLatencyNamespaceClusterMeasurementsCommand = Command{
+var getCollStatsLatencyNamespaceClusterMeasurementsCommand = shared_api.Command{
 	OperationID: `getCollStatsLatencyNamespaceClusterMeasurements`,
 	Description: `Get a list of the Coll Stats Latency cluster-level measurements for the given namespace.`,
-	RequestParameters: RequestParameters{
+	RequestParameters: shared_api.RequestParameters{
 		URL: `/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements`,
-		QueryParameters: []Parameter{
+		QueryParameters: []shared_api.Parameter{
 			{
 				Name:        `envelope`,
 				Description: `Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.`,
 				Required:    false,
-				Type: ParameterType{
+				Type: shared_api.ParameterType{
 					IsArray: false,
 					Type:    `bool`,
 				},
@@ -333,7 +334,7 @@ var getCollStatsLatencyNamespaceClusterMeasurementsCommand = Command{
 				Name:        `metrics`,
 				Description: `List that contains the metrics that you want to retrieve for the associated data series. If you don't set this parameter, this resource returns data series for all Coll Stats Latency metrics.`,
 				Required:    false,
-				Type: ParameterType{
+				Type: shared_api.ParameterType{
 					IsArray: true,
 					Type:    `string`,
 				},
@@ -342,7 +343,7 @@ var getCollStatsLatencyNamespaceClusterMeasurementsCommand = Command{
 				Name:        `start`,
 				Description: `Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.`,
 				Required:    false,
-				Type: ParameterType{
+				Type: shared_api.ParameterType{
 					IsArray: false,
 					Type:    `string`,
 				},
@@ -351,7 +352,7 @@ var getCollStatsLatencyNamespaceClusterMeasurementsCommand = Command{
 				Name:        `end`,
 				Description: `Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.`,
 				Required:    false,
-				Type: ParameterType{
+				Type: shared_api.ParameterType{
 					IsArray: false,
 					Type:    `string`,
 				},
@@ -360,21 +361,21 @@ var getCollStatsLatencyNamespaceClusterMeasurementsCommand = Command{
 				Name:        `period`,
 				Description: `Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set start and end.`,
 				Required:    false,
-				Type: ParameterType{
+				Type: shared_api.ParameterType{
 					IsArray: false,
 					Type:    `string`,
 				},
 			},
 		},
-		URLParameters: []Parameter{
+		URLParameters: []shared_api.Parameter{
 			{
 				Name: `groupId`,
 				Description: `Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
 
 
 NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.`,
 				Required: true,
-				Type: ParameterType{
+				Type: shared_api.ParameterType{
 					IsArray: false,
 					Type:    `string`,
 				},
@@ -383,7 +384,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you
 				Name:        `clusterName`,
 				Description: `Human-readable label that identifies the cluster to retrieve metrics for.`,
 				Required:    true,
-				Type: ParameterType{
+				Type: shared_api.ParameterType{
 					IsArray: false,
 					Type:    `string`,
 				},
@@ -392,7 +393,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you
 				Name:        `clusterView`,
 				Description: `Human-readable label that identifies the cluster topology to retrieve metrics for.`,
 				Required:    true,
-				Type: ParameterType{
+				Type: shared_api.ParameterType{
 					IsArray: false,
 					Type:    `string`,
 				},
@@ -401,7 +402,7 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you
 				Name:        `databaseName`,
 				Description: `Human-readable label that identifies the database.`,
 				Required:    true,
-				Type: ParameterType{
+				Type: shared_api.ParameterType{
 					IsArray: false,
 					Type:    `string`,
 				},
@@ -410,15 +411,15 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you
 				Name:        `collectionName`,
 				Description: `Human-readable label that identifies the collection.`,
 				Required:    true,
-				Type: ParameterType{
+				Type: shared_api.ParameterType{
 					IsArray: false,
 					Type:    `string`,
 				},
 			},
 		},
 		Verb: http.MethodGet,
 	},
-	Versions: []Version{
+	Versions: []shared_api.Version{
 		{
 			Version:            `2023-11-15`,
 			RequestContentType: ``,
@@ -429,17 +430,17 @@ NOTE: Groups and projects are synonymous terms. Your group id is the same as you
 	},
 }
 
-var createClusterCommand = Command{
+var createClusterCommand = shared_api.Command{
 	OperationID: `createCluster`,
 	Description: `Creates one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can create clusters with asymmetrically-sized shards. Each project supports up to 25 database deployments. To use this resource, the requesting API Key must have the Project Owner role. This feature is not available for serverless clusters.`,
-	RequestParameters: RequestParameters{
+	RequestParameters: shared_api.RequestParameters{
 		URL: `/api/atlas/v2/groups/{groupId}/clusters`,
-		QueryParameters: []Parameter{
+		QueryParameters: []shared_api.Parameter{
 			{
 				Name:        `envelope`,
 				Description: `Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.`,
 				Required:    false,
-				Type: ParameterType{
+				Type: shared_api.ParameterType{
 					IsArray: false,
 					Type:    `bool`,
 				},
@@ -448,29 +449,29 @@ var createClusterCommand = Command{
 				Name:        `pretty`,
 				Description: `Flag that indicates whether the response body should be in the prettyprint format.`,
 				Required:    false,
-				Type: ParameterType{
+				Type: shared_api.ParameterType{
 					IsArray: false,
 					Type:    `bool`,
 				},
 			},
 		},
-		URLParameters: []Parameter{
+		URLParameters: []shared_api.Parameter{
 			{
 				Name: `groupId`,
 				Description: `Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
 
 
 NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.`,
 				Required: true,
-				Type: ParameterType{
+				Type: shared_api.ParameterType{
 					IsArray: false,
 					Type:    `string`,
 				},
 			},
 		},
 		Verb: http.MethodPost,
 	},
-	Versions: []Version{
+	Versions: []shared_api.Version{
 		{
 			Version:            `2023-01-01`,
 			RequestContentType: `json`,

internal/api/httprequest_test.go

@@ -18,6 +18,8 @@ import (
 	"context"
 	"io"
 	"net/http"
+
+	"github.com/mongodb/mongodb-atlas-cli/atlascli/tools/shared/api"
 )
 
 type CommandExecutor interface {
@@ -37,7 +39,7 @@ type CommandConverter interface {
 }
 
 type CommandRequest struct {
-	Command     Command
+	Command     api.Command
 	Content     io.Reader
 	ContentType string
 	Format      string

internal/api/interface.go

@@ -26,6 +26,7 @@ import (
 	"time"
 
 	"github.com/PaesslerAG/jsonpath"
+	"github.com/mongodb/mongodb-atlas-cli/atlascli/tools/shared/api"
 )
 
 var (
@@ -51,7 +52,7 @@ const (
 type Watcher struct {
 	executor CommandExecutor
 	request  *CommandRequest
-	expect   *WatcherExpectProperties
+	expect   *api.WatcherExpectProperties
 }
 
 // Create a new watcher
@@ -62,7 +63,7 @@ type Watcher struct {
 //     were used to execute the deleteCluster operation.
 //   - responseBody: the body from the preceding call
 //   - props: the watcher configuration, this is generated using the api-generator tool
-func NewWatcher(executor CommandExecutor, requestParams map[string][]string, responseBody []byte, props WatcherProperties) (*Watcher, error) {
+func NewWatcher(executor CommandExecutor, requestParams map[string][]string, responseBody []byte, props api.WatcherProperties) (*Watcher, error) {
 	// We're making the same request over and over again, so we only have to build it once
 	request, err := buildRequest(Commands, requestParams, responseBody, props)
 	if err != nil || request == nil {
@@ -80,9 +81,9 @@ func NewWatcher(executor CommandExecutor, requestParams map[string][]string, res
 //
 // - `allCommands`, array with all command definitions, realistically this will always be the static `Commands` variable, but this allows easier unit testing
 // See `NewWatcher` for other parameter descriptions.
-func buildRequest(allCommands GroupedAndSortedCommands, requestParams map[string][]string, responseBody []byte, props WatcherProperties) (*CommandRequest, error) {
+func buildRequest(allCommands api.GroupedAndSortedCommands, requestParams map[string][]string, responseBody []byte, props api.WatcherProperties) (*CommandRequest, error) {
 	// Search for the command definition that we're expected to execute
-	var command *Command
+	var command *api.Command
 	for _, commandGroup := range allCommands {
 		for _, loopCommand := range commandGroup.Commands {
 			if loopCommand.OperationID == props.Get.OperationID {
@@ -164,7 +165,7 @@ func (w *Watcher) WatchOne(ctx context.Context) (bool, error) {
 }
 
 // Actual watcher logic without handling.
-func watchInner(ctx context.Context, executor CommandExecutor, expect *WatcherExpectProperties, commandRequest CommandRequest) (bool, error) {
+func watchInner(ctx context.Context, executor CommandExecutor, expect *api.WatcherExpectProperties, commandRequest CommandRequest) (bool, error) {
 	// execute the command using the executor
 	response, err := executor.ExecuteCommand(ctx, commandRequest)
 	if err != nil {