feat: expose more enterprise settings for projects (#264)

Author: gastonfournier

docs/resources/project.md

@@ -28,6 +28,25 @@ resource "unleash_project" "test_project" {
   id          = "my_project"
   name        = "My Terraform project"
   description = "A project created through terraform"
+
+  mode = "protected"
+
+  feature_naming = {
+    pattern     = "^feature_[a-z0-9_-]+$"
+    example     = "feature_user_signup"
+    description = "Feature keys must start with feature_ and use lowercase alphanumerics."
+  }
+
+  link_templates = [
+    {
+      title        = "Product Spec"
+      url_template = "https://docs.example.com/projects/{{project}}/features/{{feature}}"
+    },
+    {
+      title        = "Issue Tracker"
+      url_template = "https://issues.example.com/browse/{{feature}}"
+    }
+  ]
 }
 ```
 
@@ -42,4 +61,30 @@ resource "unleash_project" "test_project" {
 ### Optional
 
 - `description` (String) A description of the project's purpose.
+- `feature_naming` (Attributes) Optional feature naming pattern applied to all features created in this project. (see [below for nested schema](#nestedatt--feature_naming))
+- `link_templates` (Attributes List) Optional list of link templates automatically added to new feature flags. (see [below for nested schema](#nestedatt--link_templates))
 - `mode` (String) The project's collaboration mode. Determines whether non project members can submit change requests and the projects visibility to non members. Valid values are 'open', 'protected' and 'private'. If a value is not set, the project will default to 'open'
+
+<a id="nestedatt--feature_naming"></a>
+### Nested Schema for `feature_naming`
+
+Required:
+
+- `pattern` (String) A JavaScript regular expression pattern, without the start and end delimiters.
+
+Optional:
+
+- `description` (String) A human-readable description of the pattern.
+- `example` (String) An example feature name that matches the pattern.
+
+
+<a id="nestedatt--link_templates"></a>
+### Nested Schema for `link_templates`
+
+Required:
+
+- `url_template` (String) URL template that can contain {{project}} or {{feature}} placeholders.
+
+Optional:
+
+- `title` (String) Link title shown in the Unleash UI.

examples/resources/unleash_project/resource.tf

@@ -13,4 +13,23 @@ resource "unleash_project" "test_project" {
   id          = "my_project"
   name        = "My Terraform project"
   description = "A project created through terraform"
+
+  mode = "protected"
+
+  feature_naming = {
+    pattern     = "^feature_[a-z0-9_-]+$"
+    example     = "feature_user_signup"
+    description = "Feature keys must start with feature_ and use lowercase alphanumerics."
+  }
+
+  link_templates = [
+    {
+      title        = "Product Spec"
+      url_template = "https://docs.example.com/projects/{{project}}/features/{{feature}}"
+    },
+    {
+      title        = "Issue Tracker"
+      url_template = "https://issues.example.com/browse/{{feature}}"
+    }
+  ]
 }

internal/provider/project_resource.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 
 	unleash "github.com/Unleash/unleash-server-api-go/client"
+	"github.com/hashicorp/terraform-plugin-framework/diag"
 	"github.com/hashicorp/terraform-plugin-framework/path"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
@@ -27,10 +28,23 @@ type projectResource struct {
 }
 
 type projectResourceModel struct {
-	Id          types.String `tfsdk:"id"`
-	Name        types.String `tfsdk:"name"`
+	Id            types.String               `tfsdk:"id"`
+	Name          types.String               `tfsdk:"name"`
+	Description   types.String               `tfsdk:"description"`
+	Mode          types.String               `tfsdk:"mode"`
+	FeatureNaming *featureNamingModel        `tfsdk:"feature_naming"`
+	LinkTemplates []projectLinkTemplateModel `tfsdk:"link_templates"`
+}
+
+type featureNamingModel struct {
+	Pattern     types.String `tfsdk:"pattern"`
+	Example     types.String `tfsdk:"example"`
 	Description types.String `tfsdk:"description"`
-	Mode        types.String `tfsdk:"mode"`
+}
+
+type projectLinkTemplateModel struct {
+	Title       types.String `tfsdk:"title"`
+	UrlTemplate types.String `tfsdk:"url_template"`
 }
 
 // Configure adds the provider configured client to the data source.
@@ -77,6 +91,40 @@ func (r *projectResource) Schema(_ context.Context, _ resource.SchemaRequest, re
 				Computed: true,
 				Optional: true,
 			},
+			"feature_naming": schema.SingleNestedAttribute{
+				Description: "Optional feature naming pattern applied to all features created in this project.",
+				Optional:    true,
+				Attributes: map[string]schema.Attribute{
+					"pattern": schema.StringAttribute{
+						Description: "A JavaScript regular expression pattern, without the start and end delimiters.",
+						Required:    true,
+					},
+					"example": schema.StringAttribute{
+						Description: "An example feature name that matches the pattern.",
+						Optional:    true,
+					},
+					"description": schema.StringAttribute{
+						Description: "A human-readable description of the pattern.",
+						Optional:    true,
+					},
+				},
+			},
+			"link_templates": schema.ListNestedAttribute{
+				Description: "Optional list of link templates automatically added to new feature flags.",
+				Optional:    true,
+				NestedObject: schema.NestedAttributeObject{
+					Attributes: map[string]schema.Attribute{
+						"title": schema.StringAttribute{
+							Description: "Link title shown in the Unleash UI.",
+							Optional:    true,
+						},
+						"url_template": schema.StringAttribute{
+							Description: "URL template that can contain {{project}} or {{feature}} placeholders.",
+							Required:    true,
+						},
+					},
+				},
+			},
 		},
 	}
 }
@@ -122,6 +170,22 @@ func (r *projectResource) Create(ctx context.Context, req resource.CreateRequest
 	updateProjectSettingsRequest := *unleash.NewUpdateProjectEnterpriseSettingsSchemaWithDefaults()
 	updateProjectSettingsRequest.SetMode(mode)
 
+	featureNaming := expandFeatureNaming(plan.FeatureNaming, &resp.Diagnostics)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+	if featureNaming != nil {
+		updateProjectSettingsRequest.SetFeatureNaming(*featureNaming)
+	}
+
+	linkTemplates := expandLinkTemplates(plan.LinkTemplates, &resp.Diagnostics)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+	if linkTemplates != nil {
+		updateProjectSettingsRequest.SetLinkTemplates(linkTemplates)
+	}
+
 	updateSettingsResponse, err := r.client.ProjectsAPI.UpdateProjectEnterpriseSettings(ctx, *plan.Id.ValueStringPointer()).UpdateProjectEnterpriseSettingsSchema(updateProjectSettingsRequest).Execute()
 
 	if !ValidateApiResponse(updateSettingsResponse, 200, &resp.Diagnostics, err) {
@@ -189,20 +253,29 @@ func (r *projectResource) Read(ctx context.Context, req resource.ReadRequest, re
 
 func (r *projectResource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse) {
 	tflog.Debug(ctx, "Preparing to update project resource")
-	var state projectResourceModel
-	resp.Diagnostics.Append(req.Plan.Get(ctx, &state)...)
+	var plan projectResourceModel
+	resp.Diagnostics.Append(req.Plan.Get(ctx, &plan)...)
 
 	if resp.Diagnostics.HasError() {
 		return
 	}
 
 	updateProjectSchema := *unleash.NewUpdateProjectSchemaWithDefaults()
-	updateProjectSchema.Name = *state.Name.ValueStringPointer()
-	if !state.Description.IsNull() {
-		updateProjectSchema.Description = state.Description.ValueStringPointer()
+	updateProjectSchema.Name = *plan.Name.ValueStringPointer()
+	if !plan.Description.IsNull() {
+		updateProjectSchema.Description = plan.Description.ValueStringPointer()
 	}
 
-	mode, err := resolveRequestedMode(state)
+	if plan.Id.IsNull() || plan.Id.IsUnknown() {
+		var state projectResourceModel
+		resp.Diagnostics.Append(req.State.Get(ctx, &state)...)
+		if resp.Diagnostics.HasError() {
+			return
+		}
+		plan.Id = state.Id
+	}
+
+	mode, err := resolveRequestedMode(plan)
 	if err != nil {
 		resp.Diagnostics.AddError(err.Error(), "InvalidMode")
 		return
@@ -211,15 +284,29 @@ func (r *projectResource) Update(ctx context.Context, req resource.UpdateRequest
 	updateProjectSettingsRequest := *unleash.NewUpdateProjectEnterpriseSettingsSchemaWithDefaults()
 	updateProjectSettingsRequest.SetMode(mode)
 
-	updateSettingsResponse, err := r.client.ProjectsAPI.UpdateProjectEnterpriseSettings(ctx, *state.Id.ValueStringPointer()).UpdateProjectEnterpriseSettingsSchema(updateProjectSettingsRequest).Execute()
+	featureNaming := expandFeatureNaming(plan.FeatureNaming, &resp.Diagnostics)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+	if featureNaming != nil {
+		updateProjectSettingsRequest.SetFeatureNaming(*featureNaming)
+	}
 
-	if !ValidateApiResponse(updateSettingsResponse, 200, &resp.Diagnostics, err) {
+	linkTemplates := expandLinkTemplates(plan.LinkTemplates, &resp.Diagnostics)
+	if resp.Diagnostics.HasError() {
 		return
 	}
+	if linkTemplates != nil {
+		updateProjectSettingsRequest.SetLinkTemplates(linkTemplates)
+	}
 
-	req.State.Get(ctx, &state)
+	updateSettingsResponse, err := r.client.ProjectsAPI.UpdateProjectEnterpriseSettings(ctx, *plan.Id.ValueStringPointer()).UpdateProjectEnterpriseSettingsSchema(updateProjectSettingsRequest).Execute()
+
+	if !ValidateApiResponse(updateSettingsResponse, 200, &resp.Diagnostics, err) {
+		return
+	}
 
-	api_response, err := r.client.ProjectsAPI.UpdateProject(ctx, state.Id.ValueString()).UpdateProjectSchema(updateProjectSchema).Execute()
+	api_response, err := r.client.ProjectsAPI.UpdateProject(ctx, plan.Id.ValueString()).UpdateProjectSchema(updateProjectSchema).Execute()
 
 	if !ValidateApiResponse(api_response, 200, &resp.Diagnostics, err) {
 		return
@@ -230,26 +317,26 @@ func (r *projectResource) Update(ctx context.Context, req resource.UpdateRequest
 
 	var project unleash.ProjectSchema
 	for _, p := range projects.Projects {
-		if p.Id == state.Id.ValueString() {
+		if p.Id == plan.Id.ValueString() {
 			project = p
 		}
 	}
 	if !ValidateApiResponse(api_response, 200, &resp.Diagnostics, err) {
 		return
 	}
 
-	state.Id = types.StringValue(fmt.Sprintf("%v", project.Id))
-	state.Name = types.StringValue(fmt.Sprintf("%v", project.Name))
+	plan.Id = types.StringValue(fmt.Sprintf("%v", project.Id))
+	plan.Name = types.StringValue(fmt.Sprintf("%v", project.Name))
 
-	setModelMode(project.Mode, &state)
+	setModelMode(project.Mode, &plan)
 
 	if project.Description.IsSet() {
-		state.Description = types.StringValue(*project.Description.Get())
+		plan.Description = types.StringValue(*project.Description.Get())
 	} else {
-		state.Description = types.StringNull()
+		plan.Description = types.StringNull()
 	}
 
-	resp.Diagnostics.Append(resp.State.Set(ctx, &state)...)
+	resp.Diagnostics.Append(resp.State.Set(ctx, &plan)...)
 	tflog.Debug(ctx, "Finished updating project data source", map[string]any{"success": true})
 }
 
@@ -294,3 +381,83 @@ func resolveRequestedMode(plan projectResourceModel) (string, error) {
 		return "open", nil
 	}
 }
+
+func expandFeatureNaming(model *featureNamingModel, diagnostics *diag.Diagnostics) *unleash.CreateFeatureNamingPatternSchema {
+	if model == nil {
+		return nil
+	}
+
+	if model.Pattern.IsUnknown() {
+		diagnostics.AddError("Invalid feature_naming.pattern", "feature_naming.pattern cannot be unknown")
+		return nil
+	}
+
+	if model.Pattern.IsNull() || model.Pattern.ValueString() == "" {
+		diagnostics.AddError("Invalid feature_naming.pattern", "feature_naming.pattern must be provided and cannot be empty")
+		return nil
+	}
+
+	featureNaming := unleash.CreateFeatureNamingPatternSchema{}
+	featureNaming.SetPattern(model.Pattern.ValueString())
+
+	if model.Example.IsUnknown() {
+		diagnostics.AddError("Invalid feature_naming.example", "feature_naming.example cannot be unknown")
+		return nil
+	}
+
+	if model.Example.IsNull() {
+		featureNaming.SetExampleNil()
+	} else {
+		featureNaming.SetExample(model.Example.ValueString())
+	}
+
+	if model.Description.IsUnknown() {
+		diagnostics.AddError("Invalid feature_naming.description", "feature_naming.description cannot be unknown")
+		return nil
+	}
+
+	if model.Description.IsNull() {
+		featureNaming.SetDescriptionNil()
+	} else {
+		featureNaming.SetDescription(model.Description.ValueString())
+	}
+
+	return &featureNaming
+}
+
+func expandLinkTemplates(models []projectLinkTemplateModel, diagnostics *diag.Diagnostics) []unleash.ProjectLinkTemplateSchema {
+	if models == nil {
+		return nil
+	}
+
+	templates := make([]unleash.ProjectLinkTemplateSchema, len(models))
+
+	for i, model := range models {
+		if model.UrlTemplate.IsUnknown() {
+			diagnostics.AddError("Invalid link_templates url", fmt.Sprintf("link_templates[%d].url_template cannot be unknown", i))
+			return nil
+		}
+
+		if model.UrlTemplate.IsNull() || model.UrlTemplate.ValueString() == "" {
+			diagnostics.AddError("Invalid link_templates url", fmt.Sprintf("link_templates[%d].url_template must be provided and cannot be empty", i))
+			return nil
+		}
+
+		template := unleash.NewProjectLinkTemplateSchema(model.UrlTemplate.ValueString())
+
+		if model.Title.IsUnknown() {
+			diagnostics.AddError("Invalid link_templates title", fmt.Sprintf("link_templates[%d].title cannot be unknown", i))
+			return nil
+		}
+
+		if model.Title.IsNull() {
+			template.SetTitleNil()
+		} else {
+			template.SetTitle(model.Title.ValueString())
+		}
+
+		templates[i] = *template
+	}
+
+	return templates
+}