chore: Autogen config supports overriding identifier attributes and ignoring specific operations for model generation (#3950)

* initial generation with no config support

* correct generation of service account secret with config working

* add unit test for overriding id attribute

* unit testing in model generation

Author: AgustinBettati

internal/serviceapi/orgserviceaccountsecretapi/resource.go

@@ -43,7 +43,8 @@ func ToCodeSpecModel(atlasAdminAPISpecFilePath, configPath string, resourceName
 	}
 
 	var results []Resource
-	for name, resourceConfig := range resourceConfigsToIterate {
+	for name := range resourceConfigsToIterate {
+		resourceConfig := resourceConfigsToIterate[name]
 		log.Printf("[INFO] Generating resource model: %s", name)
 		// find resource operations, schemas, etc from OAS
 		oasResource, err := getAPISpecResource(&apiSpec.Model, &resourceConfig, name)
@@ -63,7 +64,8 @@ func ToCodeSpecModel(atlasAdminAPISpecFilePath, configPath string, resourceName
 
 func validateRequiredOperations(resourceConfigs map[string]config.Resource) error {
 	var validationErrors []error
-	for name, resourceConfig := range resourceConfigs {
+	for name := range resourceConfigs {
+		resourceConfig := resourceConfigs[name]
 		if resourceConfig.Create == nil {
 			validationErrors = append(validationErrors, fmt.Errorf("resource %s missing Create operation in config file", name))
 		}
@@ -88,16 +90,25 @@ func apiSpecResourceToCodeSpecModel(oasResource APISpecResource, resourceConfig
 		configuredVersion = &resourceConfig.VersionHeader
 	}
 
-	createRequestAttributes, err := opRequestToAttributes(createOp, configuredVersion)
-	if err != nil {
-		return nil, fmt.Errorf("failed to process create request attributes for %s: %w", name, err)
+	var createRequestAttributes, updateRequestAttributes, createResponseAttributes, readResponseAttributes Attributes
+	var err error
+
+	if !resourceConfig.Create.SchemaIgnore {
+		createRequestAttributes, err = opRequestToAttributes(createOp, configuredVersion)
+		if err != nil {
+			return nil, fmt.Errorf("failed to process create request attributes for %s: %w", name, err)
+		}
+		createResponseAttributes = opResponseToAttributes(createOp, configuredVersion)
 	}
-	updateRequestAttributes, err := opRequestToAttributes(updateOp, configuredVersion)
-	if err != nil {
-		return nil, fmt.Errorf("failed to process update request attributes for %s: %w", name, err)
+	if resourceConfig.Update != nil && !resourceConfig.Update.SchemaIgnore {
+		updateRequestAttributes, err = opRequestToAttributes(updateOp, configuredVersion)
+		if err != nil {
+			return nil, fmt.Errorf("failed to process update request attributes for %s: %w", name, err)
+		}
+	}
+	if !resourceConfig.Read.SchemaIgnore {
+		readResponseAttributes = opResponseToAttributes(readOp, configuredVersion)
 	}
-	createResponseAttributes := opResponseToAttributes(createOp, configuredVersion)
-	readResponseAttributes := opResponseToAttributes(readOp, configuredVersion)
 
 	attributes := mergeAttributes(&attributeDefinitionSources{
 		createPathParams: createPathParams,
@@ -127,11 +138,12 @@ func apiSpecResourceToCodeSpecModel(oasResource APISpecResource, resourceConfig
 	}
 
 	resource := &Resource{
-		Name:        name,
-		PackageName: strings.ReplaceAll(name, "_", ""),
-		Schema:      schema,
-		MoveState:   moveState,
-		Operations:  operations,
+		Name:         name,
+		PackageName:  strings.ReplaceAll(name, "_", ""),
+		Schema:       schema,
+		MoveState:    moveState,
+		Operations:   operations,
+		IDAttributes: resourceConfig.IDAttributes,
 	}
 
 	if err := applyTransformationsWithConfigOpts(resourceConfig, resource); err != nil {

internal/serviceapi/orgserviceaccountsecretapi/resource_schema.go

@@ -1358,3 +1358,40 @@ func TestConvertToProviderSpec_pathParamWithAlias(t *testing.T) {
 	assert.Contains(t, result.Resources[0].Operations.Update.Path, "{dbUser}", "Update path should use aliased path param")
 	assert.Contains(t, result.Resources[0].Operations.Delete.Path, "{dbUser}", "Delete path should use aliased path param")
 }
+
+func TestConvertToProviderSpec_ignoreSchemaAndIdAttributes(t *testing.T) {
+	tc := convertToSpecTestCase{
+		inputOpenAPISpecPath: testDataAPISpecPath,
+		inputConfigPath:      testDataConfigPath,
+		inputResourceName:    "test_schema_ignore_and_id_attributes",
+
+		expectedResult: &codespec.Model{
+			Resources: []codespec.Resource{{
+				Schema: &codespec.Schema{
+					Description: conversion.StringPtr("POST API description"),
+					// due to schema_ignore string_attr is not included in the attributes
+					Attributes: codespec.Attributes{
+						{
+							TFSchemaName:             "group_id",
+							TFModelName:              "GroupId",
+							APIName:                  "groupId",
+							ComputedOptionalRequired: codespec.Required,
+							String:                   &codespec.StringAttribute{},
+							Description:              conversion.StringPtr(testPathParamDesc),
+							ReqBodyUsage:             codespec.OmitAlways,
+							CreateOnly:               true,
+						},
+					},
+				},
+				Name:         "test_schema_ignore_and_id_attributes",
+				PackageName:  "testschemaignoreandidattributes",
+				Operations:   simpleTestResourceOperations,
+				IDAttributes: []string{"group_id", "id"},
+			}},
+		},
+	}
+
+	result, err := codespec.ToCodeSpecModel(tc.inputOpenAPISpecPath, tc.inputConfigPath, &tc.inputResourceName)
+	require.NoError(t, err)
+	assert.Equal(t, tc.expectedResult, result, "Expected result to match the specified structure")
+}

tools/codegen/codespec/api_to_provider_spec_mapper.go

@@ -39,11 +39,12 @@ type Model struct {
 }
 
 type Resource struct {
-	Schema      *Schema       `yaml:"schema,omitempty"`
-	Operations  APIOperations `yaml:"operations"`
-	MoveState   *MoveState    `yaml:"move_state,omitempty"`
-	Name        string        `yaml:"name"`
-	PackageName string        `yaml:"packageName"`
+	Schema       *Schema       `yaml:"schema,omitempty"`
+	Operations   APIOperations `yaml:"operations"`
+	MoveState    *MoveState    `yaml:"move_state,omitempty"`
+	Name         string        `yaml:"name"`
+	PackageName  string        `yaml:"packageName"`
+	IDAttributes []string      `yaml:"id_attributes,omitempty"`
 }
 
 type APIOperations struct {

tools/codegen/codespec/api_to_provider_spec_mapper_test.go

@@ -172,3 +172,21 @@ resources:
         # and appears in request/response bodies. The apiname tag should preserve the
         # original API name "username" while the schema uses the aliased name "dbUser"
         username: dbUser
+  
+  test_schema_ignore_and_id_attributes:
+    read:
+      path: /api/atlas/v2/groups/{groupId}/simpleTestResource
+      method: GET
+      schema_ignore: true
+    create:
+      path: /api/atlas/v2/groups/{groupId}/simpleTestResource
+      method: POST
+      schema_ignore: true
+    update:
+      path: /api/atlas/v2/groups/{groupId}/simpleTestResource
+      method: PATCH
+      schema_ignore: true
+    delete:
+      path: /api/atlas/v2/groups/{groupId}/simpleTestResource
+      method: DELETE
+    id_attributes: ["group_id", "id"]

tools/codegen/codespec/model.go

@@ -765,6 +765,25 @@ resources:
         roles:
           type: set
 
+  org_service_account_secret_api:
+    read:
+      path: /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}
+      method: GET
+      schema_ignore: true # get operation for a single secret is not available, individual secret is found in service account read looking in `secrets` property
+    create:
+      path: /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets
+      method: POST
+    delete:
+      path: /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets/{secretId}
+      method: DELETE
+    id_attributes: ["org_id", "client_id", "id"]
+    schema:
+      aliases:
+        secretId: id # path param name does not match the API response property.
+      overrides:
+        secret:
+          sensitive: true
+
   alert_configuration_api:
     read:
       path: /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}

tools/codegen/codespec/testdata/config.yml

@@ -11,6 +11,7 @@ type Resource struct {
 	Delete             *APIOperation `yaml:"delete"`
 	MoveState          *MoveState    `yaml:"move_state"`
 	VersionHeader      string        `yaml:"version_header"` // when not defined latest version defined in API Spec of the resource is used
+	IDAttributes       []string      `yaml:"id_attributes"`
 	DeprecationMessage *string       `yaml:"deprecation_message"`
 	SchemaOptions      SchemaOptions `yaml:"schema"`
 }
@@ -19,7 +20,8 @@ type APIOperation struct {
 	Wait              *Wait  `yaml:"wait"`
 	Path              string `yaml:"path"`
 	Method            string `yaml:"method"`
-	StaticRequestBody string `yaml:"static_request_body"` // use at the moment for Delete when it's done with a PATCH or PUT and needs to send a static request body.
+	StaticRequestBody string `yaml:"static_request_body"`
+	SchemaIgnore      bool   `yaml:"schema_ignore"`
 }
 
 type Wait struct {