chore: Adjusts scaffold command to generate config file for schema scaffolding (#1839)

Author: AgustinBettati

CONTRIBUTING.md

@@ -325,6 +325,8 @@ make scaffold resource_name=streamInstance type=resource
 
 This will generate resource/data source files and accompanying test files needed for starting the development, and will contain multiple comments with `TODO:` statements which give guidance for the development.
 
+As a follow up step, use [Scaffolding Schema and Model Definitions](#scaffolding-schema-and-model-definitions) to autogenerate the schema via the Open API specification. This will require making adjustments to the generated `./internal/service/<resource_name>/tfplugingen/generator_config.yml` file.
+
 #### Scaffolding Schema and Model Definitions
 
 Complementary to the `scaffold` command, there is a command which generates the initial Terraform schema definition and associated Go types for a resource or data source. This processes leverages [Code Generation Tools](https://developer.hashicorp.com/terraform/plugin/code-generation) developed by HashiCorp, which in turn make use of the [Atlas Admin API](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/) OpenAPI Specification.

tools/scaffold/scaffold.go

@@ -75,6 +75,10 @@ func filesToGenerate(params *ScaffoldParams) ([]FileGeneration, error) {
 				TemplatePath: "tools/scaffold/template/model_test.tmpl",
 				OutputPath:   fmt.Sprintf("%s/model_%s_test.go", folderPath, params.NameSnakeCase),
 			},
+			{
+				TemplatePath: "tools/scaffold/template/generator_config.tmpl",
+				OutputPath:   fmt.Sprintf("%s/tfplugingen/generator_config.yml", folderPath),
+			},
 		}, nil
 	case DataSourceCmd:
 		return []FileGeneration{
@@ -94,6 +98,10 @@ func filesToGenerate(params *ScaffoldParams) ([]FileGeneration, error) {
 				TemplatePath: "tools/scaffold/template/model_test.tmpl",
 				OutputPath:   fmt.Sprintf("%s/model_%s_test.go", folderPath, params.NameSnakeCase),
 			},
+			{
+				TemplatePath: "tools/scaffold/template/generator_config.tmpl",
+				OutputPath:   fmt.Sprintf("%s/tfplugingen/generator_config.yml", folderPath),
+			},
 		}, nil
 	case PluralDataSourceCmd:
 		return []FileGeneration{
@@ -113,6 +121,10 @@ func filesToGenerate(params *ScaffoldParams) ([]FileGeneration, error) {
 				TemplatePath: "tools/scaffold/template/model_test.tmpl",
 				OutputPath:   fmt.Sprintf("%s/model_%s_test.go", folderPath, params.NameSnakeCase),
 			},
+			{
+				TemplatePath: "tools/scaffold/template/generator_config.tmpl",
+				OutputPath:   fmt.Sprintf("%s/tfplugingen/generator_config.yml", folderPath),
+			},
 		}, nil
 	default:
 		return nil, errors.New("unknown generation type provided")

tools/scaffold/template/datasource.tmpl

@@ -26,21 +26,10 @@ type {{.NameCamelCase}}DS struct {
 	config.DSCommon
 }
 
-// TODO: if resource exists and TF{{.NamePascalCase}}Model is identical to data source attributes the existing model should be reutilized
-// type TF{{.NamePascalCase}}DSModel struct {
-// 	ID          types.String `tfsdk:"id"`
-	// TODO: add attribute definitions
-//}
 
 func (d *{{.NameCamelCase}}DS) Schema(ctx context.Context, req datasource.SchemaRequest, resp *datasource.SchemaResponse) {
-	resp.Schema = schema.Schema{
-		Attributes: map[string]schema.Attribute{
-			"id": schema.StringAttribute{
-				Computed: true,
-			},
-			// TODO: add attribute definitions
-		},
-	}
+	// TODO: Schema and model must be defined in data_source_{{.NameSnakeCase}}_schema.go. Details on scaffolding this file found in CONTRIBUTING.md under "Scaffolding Schema and Model Definitions"
+	resp.Schema = DataSourceSchema(ctx)
 }
 
 func (d *{{.NameCamelCase}}DS) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
@@ -65,4 +54,4 @@ func (d *{{.NameCamelCase}}DS) Read(ctx context.Context, req datasource.ReadRequ
 		return
 	}
 	resp.Diagnostics.Append(resp.State.Set(ctx, new{{.NamePascalCase}}Model)...)
-}
+}

tools/scaffold/template/generator_config.tmpl

@@ -0,0 +1,23 @@
+provider:
+  name: mongodbatlas
+
+# TODO: Endpoints from Atlas Admin API must be specified for schema and model generation. Singular or plural data sources can be removed if not used.
+
+resources:
+  {{.NameSnakeCase}}:
+    read:
+      path: /api/atlas/v2/*
+      method: GET
+    create:
+      path: /api/atlas/v2/*
+      method: POST
+
+data_sources:
+  {{.NameSnakeCase}}:
+    read:
+      path: /api/atlas/v2/*
+      method: GET
+  {{.NameSnakeCase}}s:
+    read:
+      path: /api/atlas/v2/*
+      method: GET

tools/scaffold/template/pluraldatasource.tmpl

@@ -26,20 +26,9 @@ type {{.NameCamelCase}}sDS struct {
 	config.DSCommon
 }
 
-type TF{{.NamePascalCase}}sDSModel struct {
-	ID           types.String `tfsdk:"id"`
-	// TODO: add attribute definitions
-	Results      []TF{{.NamePascalCase}}DSModel `tfsdk:"results"`
-	PageNum      types.Int64 `tfsdk:"page_num"`
-	ItemsPerPage types.Int64 `tfsdk:"items_per_page"`
-	TotalCount   types.Int64 `tfsdk:"total_count"`
-}
-
 func (d *{{.NameCamelCase}}sDS) Schema(ctx context.Context, req datasource.SchemaRequest, resp *datasource.SchemaResponse) {
-	resp.Schema = dsschema.PaginatedDSSchema(
-		map[string]schema.Attribute{}, // TODO: define arguments of the data source
-		map[string]schema.Attribute{}, // TODO: define attributes of the result elements, schema from singular data source can be reused
-        )
+	// TODO: Schema and model must be defined in data_source_{{.NameSnakeCase}}s_schema.go. Details on scaffolding this file found in CONTRIBUTING.md under "Scaffolding Schema and Model Definitions"
+	resp.Schema = PluralDataSourceSchema(ctx)
 }
 
 func (d *{{.NameCamelCase}}sDS) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
@@ -64,4 +53,4 @@ func (d *{{.NameCamelCase}}sDS) Read(ctx context.Context, req datasource.ReadReq
 		return
 	}
 	resp.Diagnostics.Append(resp.State.Set(ctx, new{{.NamePascalCase}}sModel)...)
-}
+}

tools/scaffold/template/resource.tmpl

@@ -26,20 +26,9 @@ type {{.NameCamelCase}}RS struct {
 	config.RSCommon
 }
 
-type TF{{.NamePascalCase}}Model struct {
-	ID          types.String   `tfsdk:"id"`
-    // TODO: add attribute definitions
-}
-
 func (r *{{.NameCamelCase}}RS) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse) {
-	resp.Schema = schema.Schema{
-		Attributes: map[string]schema.Attribute{
-			"id": schema.StringAttribute{
-				Computed: true,
-			},
-            // TODO: add attribute definitions
-        },
-    }
+    // TODO: Schema and model must be defined in resource_{{.NameSnakeCase}}_schema.go. Details on scaffolding this file found in CONTRIBUTING.md under "Scaffolding Schema and Model Definitions"
+	resp.Schema = ResourceSchema(ctx)
 }
 
 func (r *{{.NameCamelCase}}RS) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) {