/
resource_frameworkitem.go
240 lines (201 loc) · 8 KB
/
resource_frameworkitem.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
package jupiterone
import (
"context"
"fmt"
"github.com/Khan/genqlient/graphql"
"github.com/hashicorp/terraform-plugin-framework/path"
"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"
"github.com/hashicorp/terraform-plugin-log/tflog"
"github.com/jupiterone/terraform-provider-jupiterone/jupiterone/internal/client"
)
type ComplianceFrameworkItemModel struct {
Id types.String `tfsdk:"id"`
FrameworkId types.String `tfsdk:"framework_id"`
GroupId types.String `tfsdk:"group_id"`
Name types.String `tfsdk:"name"`
Description types.String `tfsdk:"description"`
DisplayCategory types.String `tfsdk:"display_category"`
WebLink types.String `tfsdk:"web_link"`
Ref types.String `tfsdk:"ref"`
}
var _ resource.Resource = &ComplianceFrameworkItemResource{}
var _ resource.ResourceWithConfigure = &ComplianceFrameworkItemResource{}
var _ resource.ResourceWithImportState = &ComplianceFrameworkItemResource{}
type ComplianceFrameworkItemResource struct {
version string
qlient graphql.Client
}
func NewFrameworkItemResource() resource.Resource {
return &ComplianceFrameworkItemResource{}
}
// Metadata implements resource.Resource
func (*ComplianceFrameworkItemResource) Metadata(_ context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse) {
resp.TypeName = req.ProviderTypeName + "_frameworkitem"
}
// Configure implements resource.ResourceWithConfigure
func (r *ComplianceFrameworkItemResource) Configure(_ context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse) {
// Prevent panic if the provider has not been configured.
if req.ProviderData == nil {
return
}
p, ok := req.ProviderData.(*JupiterOneProvider)
if !ok {
resp.Diagnostics.AddError(
"Unexpected Resource Configure Type",
fmt.Sprintf("Expected JupiterOneProvider, got: %T. Please report this issue to the provider developers.", req.ProviderData),
)
return
}
r.version = p.version
r.qlient = p.Qlient
}
// Schema implements resource.Resource
func (*ComplianceFrameworkItemResource) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) {
resp.Schema = schema.Schema{
Description: "A FrameworkItem (Requirement in the web UI) is a control that is part of a framework",
Attributes: map[string]schema.Attribute{
"id": schema.StringAttribute{
Computed: true,
PlanModifiers: []planmodifier.String{
stringplanmodifier.UseStateForUnknown(),
},
},
"framework_id": schema.StringAttribute{
Required: true,
Description: "The internal ID of the framework this item belongs to",
},
"group_id": schema.StringAttribute{
Required: true,
Description: "The internal ID of the framework group this item belongs to",
},
"name": schema.StringAttribute{
Required: true,
Description: "The FrameworkItem's display name",
},
"ref": schema.StringAttribute{
Required: true,
Description: "A unique identifier that can be used to refer to this item",
},
"description": schema.StringAttribute{
Optional: true,
Description: "Description of the item",
},
"display_category": schema.StringAttribute{
Optional: true,
},
"web_link": schema.StringAttribute{
Optional: true,
Description: "A URL for referencing additional information about the item",
// TODO: basic URL pattern matching
//Validators: []validator.String{
//},
},
},
}
}
// ImportState implements resource.ResourceWithImportState
func (*ComplianceFrameworkItemResource) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse) {
resource.ImportStatePassthroughID(ctx, path.Root("id"), req, resp)
}
// Create implements resource.Resource
func (r *ComplianceFrameworkItemResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) {
var data *ComplianceFrameworkItemModel
// Read Terraform plan data into the model
resp.Diagnostics.Append(req.Plan.Get(ctx, &data)...)
if resp.Diagnostics.HasError() {
return
}
created, err := client.CreateComplianceFrameworkItem(ctx, r.qlient, client.CreateComplianceFrameworkItemInput{
Name: data.Name.ValueString(),
Description: data.Description.ValueString(),
DisplayCategory: data.DisplayCategory.ValueString(),
Ref: data.Ref.ValueString(),
FrameworkId: data.FrameworkId.ValueString(),
GroupId: data.GroupId.ValueString(),
WebLink: data.WebLink.ValueString(),
})
if err != nil {
resp.Diagnostics.AddError("failed to create framework item", err.Error())
return
}
data.Id = types.StringValue(created.CreateComplianceFrameworkItem.Id)
tflog.Trace(ctx, "Created framework item (requirement)",
map[string]interface{}{"name": data.Name, "id": data.Id})
resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
}
// Delete implements resource.Resource
func (r *ComplianceFrameworkItemResource) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse) {
var data ComplianceFrameworkItemModel
// Read Terraform ste into the model
resp.Diagnostics.Append(req.State.Get(ctx, &data)...)
if resp.Diagnostics.HasError() {
return
}
if _, err := client.DeleteComplianceFrameworkItem(ctx, r.qlient, data.Id.ValueString()); err != nil {
resp.Diagnostics.AddError("failed to delete framework item", err.Error())
}
}
// Read implements resource.Resource
func (r *ComplianceFrameworkItemResource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse) {
var data ComplianceFrameworkItemModel
// Read Terraform ste into the model
resp.Diagnostics.Append(req.State.Get(ctx, &data)...)
if resp.Diagnostics.HasError() {
return
}
var i client.GetComplianceFrameworkItemByIdComplianceFrameworkItem
if r, err := client.GetComplianceFrameworkItemById(ctx, r.qlient, data.Id.ValueString()); err != nil {
resp.Diagnostics.AddError("failed to find framework item", err.Error())
return
} else {
i = r.ComplianceFrameworkItem
}
data.Name = types.StringValue(i.Name)
data.GroupId = types.StringValue(i.GroupId)
data.FrameworkId = types.StringValue(i.FrameworkId)
if i.Description != "" || !data.Description.IsNull() {
data.Description = types.StringValue(i.Description)
}
if i.DisplayCategory != "" || !data.DisplayCategory.IsNull() {
data.DisplayCategory = types.StringValue(i.DisplayCategory)
}
if i.WebLink != "" || !data.WebLink.IsNull() {
data.WebLink = types.StringValue(i.WebLink)
}
if i.Ref != "" || !data.Ref.IsNull() {
data.Ref = types.StringValue(i.Ref)
}
// Save updated data into Terraform state
resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
}
// Update implements resource.Resource
func (r *ComplianceFrameworkItemResource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse) {
var data *ComplianceFrameworkItemModel
// Read Terraform plan data into the model
resp.Diagnostics.Append(req.Plan.Get(ctx, &data)...)
if resp.Diagnostics.HasError() {
return
}
_, err := client.UpdateComplianceFrameworkItem(ctx, r.qlient, client.UpdateComplianceFrameworkItemInput{
Id: data.Id.ValueString(),
Updates: client.UpdateComplianceFrameworkItemFields{
Name: data.Name.ValueString(),
Description: data.Description.ValueString(),
DisplayCategory: data.DisplayCategory.ValueString(),
GroupId: data.GroupId.ValueString(),
Ref: data.Ref.ValueString(),
WebLink: data.WebLink.ValueString(),
},
})
if err != nil {
resp.Diagnostics.AddError("failed to update framework item", err.Error())
return
}
tflog.Trace(ctx, "Update framework item",
map[string]interface{}{"name": data.Name, "id": data.Id})
resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
}