Skip to content

Commit

Permalink
Add resource for config property
Browse files Browse the repository at this point in the history
  • Loading branch information
michal-futurice committed Jul 30, 2024
1 parent 2d4d8b1 commit b21a176
Show file tree
Hide file tree
Showing 6 changed files with 584 additions and 1 deletion.
31 changes: 31 additions & 0 deletions docs/resources/config_property.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "dependencytrack_config_property Resource - dependencytrack"
subcategory: ""
description: |-
Configuration property
---

# dependencytrack_config_property (Resource)

Configuration property



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `group_name` (String) Name of the property group
- `name` (String) Name of the property
- `value` (String, Sensitive) Value of the property

### Optional

- `destroy_value` (String, Sensitive) Value of the property to set on destroy

### Read-Only

- `id` (String) Synthetic property ID in the form of group_name/name
- `original_value` (String, Sensitive) Original value of the property to be restored on destroy (if any) unless `destroy_value` is set
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module github.com/futurice/terraform-provider-dependencytrack
go 1.21

require (
github.com/futurice/dependency-track-client-go v0.0.0-20240408102005-c3ad5fb57202
github.com/futurice/dependency-track-client-go v0.0.0-20240730102435-ec2e22cc097c
github.com/google/go-cmp v0.6.0
github.com/google/uuid v1.6.0
github.com/hashicorp/terraform-plugin-docs v0.19.0
Expand Down
4 changes: 4 additions & 0 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,10 @@ github.com/frankban/quicktest v1.14.3 h1:FJKSZTDHjyhriyC81FLQ0LY93eSai0ZyR/ZIkd3
github.com/frankban/quicktest v1.14.3/go.mod h1:mgiwOwqx65TmIk1wJ6Q7wvnVMocbUorkibMOrVTHZps=
github.com/futurice/dependency-track-client-go v0.0.0-20240408102005-c3ad5fb57202 h1:RIhdzp/3/9vIx+lMOwJzmo8kLJoGp70JPSu6jlehqgU=
github.com/futurice/dependency-track-client-go v0.0.0-20240408102005-c3ad5fb57202/go.mod h1:nSSUhNjXItvlllTmfE3BdooP1GtAuu6dDXFAHSem0Jk=
github.com/futurice/dependency-track-client-go v0.0.0-20240730072954-1cd773465f63 h1:ic7N/FIPMYsLvBp/Q8k0JXY41QJd//sSrOLAOtJ7Pak=
github.com/futurice/dependency-track-client-go v0.0.0-20240730072954-1cd773465f63/go.mod h1:nSSUhNjXItvlllTmfE3BdooP1GtAuu6dDXFAHSem0Jk=
github.com/futurice/dependency-track-client-go v0.0.0-20240730102435-ec2e22cc097c h1:rUmqDSw/clCENP/eMA8EMhlqoPL0n9ILOLiKwWttmW8=
github.com/futurice/dependency-track-client-go v0.0.0-20240730102435-ec2e22cc097c/go.mod h1:nSSUhNjXItvlllTmfE3BdooP1GtAuu6dDXFAHSem0Jk=
github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 h1:+zs/tPmkDkHx3U66DAb0lQFJrpS6731Oaa12ikc+DiI=
github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376/go.mod h1:an3vInlBmSxCcxctByoQdvwPiA7DTK7jaaFDBTtu0ic=
github.com/go-git/go-billy/v5 v5.5.0 h1:yEY4yhzCDuMGSv83oGxiBotRzhwhNr8VZyphhiu+mTU=
Expand Down
277 changes: 277 additions & 0 deletions internal/provider/configproperty/config_property_resource.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,277 @@
// Copyright (c) 2024 Futurice Oy
// SPDX-License-Identifier: MPL-2.0

package configproperty

import (
"context"
"fmt"
dtrack "github.com/futurice/dependency-track-client-go"
"github.com/hashicorp/terraform-plugin-framework/diag"
"github.com/hashicorp/terraform-plugin-framework/resource"
"github.com/hashicorp/terraform-plugin-framework/resource/schema"
"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
"github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier"
"github.com/hashicorp/terraform-plugin-framework/types"
)

// Ensure provider defined types fully satisfy framework interfaces.
var _ resource.Resource = &ConfigPropertyResource{}
var _ resource.ResourceWithImportState = &ConfigPropertyResource{}

func NewConfigPropertyResource() resource.Resource {
return &ConfigPropertyResource{}
}

// ConfigPropertyResource defines the resource implementation.
type ConfigPropertyResource struct {
client *dtrack.Client
}

// ConfigPropertyResourceModel describes the resource data model.
type ConfigPropertyResourceModel struct {
ID types.String `tfsdk:"id"`
GroupName types.String `tfsdk:"group_name"`
Name types.String `tfsdk:"name"`
Value types.String `tfsdk:"value"`
DestroyValue types.String `tfsdk:"destroy_value"`
OriginalValue types.String `tfsdk:"original_value"`
}

func (r *ConfigPropertyResource) Metadata(ctx context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse) {
resp.TypeName = req.ProviderTypeName + "_config_property"
}

func (r *ConfigPropertyResource) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse) {
resp.Schema = schema.Schema{
MarkdownDescription: "Configuration property",

Attributes: map[string]schema.Attribute{
"group_name": schema.StringAttribute{
MarkdownDescription: "Name of the property group",
Required: true,
PlanModifiers: []planmodifier.String{
stringplanmodifier.RequiresReplace(),
},
},
"name": schema.StringAttribute{
MarkdownDescription: "Name of the property",
Required: true,
PlanModifiers: []planmodifier.String{
stringplanmodifier.RequiresReplace(),
},
},
"value": schema.StringAttribute{
MarkdownDescription: "Value of the property",
Required: true,
Sensitive: true, // not for all variables, but for some yes
},
"destroy_value": schema.StringAttribute{
MarkdownDescription: "Value of the property to set on destroy",
Optional: true,
Sensitive: true,
},
"original_value": schema.StringAttribute{
MarkdownDescription: "Original value of the property to be restored on destroy (if any) unless `destroy_value` is set",
Computed: true,
Sensitive: true,
},
"id": schema.StringAttribute{
MarkdownDescription: "Synthetic property ID in the form of group_name/name",
Computed: true,
},
},
}
}

func (r *ConfigPropertyResource) Configure(ctx context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse) {
if req.ProviderData == nil {
return
}

client, ok := req.ProviderData.(*dtrack.Client)

if !ok {
resp.Diagnostics.AddError(
"Unexpected Resource Configure Type",
fmt.Sprintf("Expected *dtrack.Client, got: %T. Please report this issue to the provider developers.", req.ProviderData),
)

return
}

r.client = client
}

func (r *ConfigPropertyResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) {
var plan, state ConfigPropertyResourceModel

resp.Diagnostics.Append(req.Plan.Get(ctx, &plan)...)
if resp.Diagnostics.HasError() {
return
}

groupName := plan.GroupName.ValueString()
name := plan.Name.ValueString()
value := plan.Value.ValueString()

originalProperty, originalPropertyDiags := r.findConfigProperty(ctx, groupName, name)
resp.Diagnostics.Append(originalPropertyDiags...)
if resp.Diagnostics.HasError() {
return
}

setConfigPropertyRequest := dtrack.SetConfigPropertyRequest{
GroupName: groupName,
PropertyName: name,
PropertyValue: value,
}

_, err := r.client.Config.SetConfigProperty(ctx, setConfigPropertyRequest)
if err != nil {
resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to set config property, got error: %s", err))
return
}

state.ID = types.StringValue(makeConfigPropertyID(groupName, name))
state.GroupName = types.StringValue(groupName)
state.Name = types.StringValue(name)
state.Value = types.StringValue(value)
state.DestroyValue = plan.DestroyValue

if originalProperty != nil && originalProperty.PropertyValue != nil {
state.OriginalValue = types.StringValue(*originalProperty.PropertyValue)
} else {
state.OriginalValue = types.StringNull()
}

resp.Diagnostics.Append(resp.State.Set(ctx, &state)...)
}

func (r *ConfigPropertyResource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse) {
var state ConfigPropertyResourceModel

resp.Diagnostics.Append(req.State.Get(ctx, &state)...)
if resp.Diagnostics.HasError() {
return
}

groupName := state.GroupName.ValueString()
name := state.Name.ValueString()

property, propertyDiags := r.findConfigProperty(ctx, groupName, name)
resp.Diagnostics.Append(propertyDiags...)
if resp.Diagnostics.HasError() {
return
}

if property == nil {
resp.State.RemoveResource(ctx)
return
}

if property.PropertyValue != nil {
state.Value = types.StringValue(*property.PropertyValue)
} else {
state.Value = types.StringNull()
}

resp.Diagnostics.Append(resp.State.Set(ctx, &state)...)
}

func (r *ConfigPropertyResource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse) {
var plan, state ConfigPropertyResourceModel

resp.Diagnostics.Append(req.Plan.Get(ctx, &plan)...)
resp.Diagnostics.Append(req.State.Get(ctx, &state)...)
if resp.Diagnostics.HasError() {
return
}

// only value can change via Update, destroy_value can change in TF state only
groupName := state.GroupName.ValueString()
name := state.Name.ValueString()
value := plan.Value.ValueString()

setConfigPropertyRequest := dtrack.SetConfigPropertyRequest{
GroupName: groupName,
PropertyName: name,
PropertyValue: value,
}

_, err := r.client.Config.SetConfigProperty(ctx, setConfigPropertyRequest)
if err != nil {
resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to set config property, got error: %s", err))
return
}

state.Value = types.StringValue(value)
state.DestroyValue = plan.DestroyValue

resp.Diagnostics.Append(resp.State.Set(ctx, &state)...)
}

func (r *ConfigPropertyResource) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse) {
var state ConfigPropertyResourceModel

resp.Diagnostics.Append(req.State.Get(ctx, &state)...)
if resp.Diagnostics.HasError() {
return
}

groupName := state.GroupName.ValueString()
name := state.Name.ValueString()

var restoreValue *string
if !state.DestroyValue.IsUnknown() && !state.DestroyValue.IsNull() {
destroyValueTmp := state.DestroyValue.ValueString()
restoreValue = &destroyValueTmp
} else if !state.OriginalValue.IsUnknown() && !state.OriginalValue.IsNull() {
originalValueTmp := state.OriginalValue.ValueString()
restoreValue = &originalValueTmp
} else {
resp.Diagnostics.AddWarning("No value to restore", "Neither destroy_value not original_value is available on destroy - the property will not be modified in Dependency-Track")
}

if restoreValue != nil {
setConfigPropertyRequest := dtrack.SetConfigPropertyRequest{
GroupName: groupName,
PropertyName: name,
PropertyValue: *restoreValue,
}

_, err := r.client.Config.SetConfigProperty(ctx, setConfigPropertyRequest)
if err != nil {
resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to reset config property to original value, got error: %s", err))
return
}
}

resp.State.RemoveResource(ctx)
}

func (r *ConfigPropertyResource) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse) {
resp.Diagnostics.AddError("Not supported", "Importing this resource is not necessary. Instead just create a resource to set the property value to what you want it to be")
}

func (r *ConfigPropertyResource) findConfigProperty(ctx context.Context, groupName, name string) (*dtrack.ConfigProperty, diag.Diagnostics) {
var diags diag.Diagnostics

configProperties, err := r.client.Config.GetAllConfigProperties(ctx)
if err != nil {
diags.AddError("Client Error", fmt.Sprintf("Unable to get config properties, got error: %s", err))
return nil, diags
}

for _, configProperty := range configProperties {
if configProperty.GroupName == groupName && configProperty.PropertyName == name {
return &configProperty, diags
}
}

return nil, diags
}

func makeConfigPropertyID(groupName string, name string) string {
return fmt.Sprintf("%s/%s", groupName, name)
}
Loading

0 comments on commit b21a176

Please sign in to comment.