snow approval channel (#116)

amiros89 · web-flow · commit e0896c45b0f7 · 2025-01-21T16:23:15.000+02:00
* snow approval channel

* bump versions of marketplace actions in test workflow
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -19,15 +19,15 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 5
     steps:
-      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
-      - uses: actions/setup-go@93397bea11091df50f3d7e59dc26a7711a8bcfbe # v4.1.0
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: actions/setup-go@3041bf56c941b39c61721a86cd11f3bb1338122a # v5.2.0
         with:
           go-version-file: "go.mod"
           cache: true
       - run: go mod download
       - run: go build -v .
       - name: Run linters
-        uses: golangci/golangci-lint-action@3a919529898de77ec3da873e3063ca4b10e7f5cc # v3.7.0
+        uses: golangci/golangci-lint-action@971e284b6050e8a5849b72094c50ab08da042db8 # v6.1.1
         with:
           version: latest
 
@@ -66,12 +66,12 @@ jobs:
           - "1.3.*"
           - "1.4.*"
     steps:
-      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
-      - uses: actions/setup-go@93397bea11091df50f3d7e59dc26a7711a8bcfbe # v4.1.0
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: actions/setup-go@3041bf56c941b39c61721a86cd11f3bb1338122a # v5.2.0
         with:
           go-version-file: "go.mod"
           cache: true
-      - uses: hashicorp/setup-terraform@633666f66e0061ca3b725c73b2ec20cd13a8fdd1 # v2.0.3
+      - uses: hashicorp/setup-terraform@b9cd54a3c349d3f38e8881555d616ced269862dd # v3.1.2
         with:
           terraform_version: ${{ matrix.terraform }}
           terraform_wrapper: false
diff --git a/client/models.go b/client/models.go
@@ -527,6 +527,7 @@ type ApprovalChannel struct {
 type ApprovalChannelDetails struct {
 	Type           string     `json:"type"`
 	Approvers      []Approver `json:"approvers"`
+	Approver       *Approver  `json:"approver,omitempty"`
 	Headers        *string    `json:"headers,omitempty"`
 	BaseUrl        *string    `json:"base_url,omitempty"`
 	UserName       *string    `json:"user_name,omitempty"`
diff --git a/docs/resources/servicenow_approval_channel.md b/docs/resources/servicenow_approval_channel.md
@@ -0,0 +1,55 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "torque_servicenow_approval_channel Resource - terraform-provider-torque"
+subcategory: ""
+description: |-
+  Creates a new ServiceNow approval channel.
+---
+
+# torque_servicenow_approval_channel (Resource)
+
+Creates a new ServiceNow approval channel.
+
+## Example Usage
+
+```terraform
+terraform {
+  required_providers {
+    torque = {
+      source = "qualitorque/torque"
+    }
+  }
+}
+
+provider "torque" {
+  host  = "https://portal.qtorque.io/"
+  space = "space"
+  token = "111111111111"
+}
+
+resource "torque_servicenow_approval_channel" "channel" {
+  name        = "name"
+  description = "description"
+  base_url    = "base_url"
+  username    = "username"
+  password    = "password"
+  headers     = "json"
+  approver    = "approver@company.com"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `approver` (String) ServiceNow Approver
+- `base_url` (String) ServiceNow Instance Base URL
+- `name` (String) Name of the approval channel.
+- `password` (String, Sensitive) ServiceNow Password
+- `user_name` (String) ServiceNow Username
+
+### Optional
+
+- `description` (String) Description of the approval channel
+- `headers` (String) Custom Headers (JSON) - JSON formatted string that represents the custom headers, for example {header:'val'}
diff --git a/examples/resources/torque_servicenow_approval_channel/resource.tf b/examples/resources/torque_servicenow_approval_channel/resource.tf
@@ -0,0 +1,23 @@
+terraform {
+  required_providers {
+    torque = {
+      source = "qualitorque/torque"
+    }
+  }
+}
+
+provider "torque" {
+  host  = "https://portal.qtorque.io/"
+  space = "space"
+  token = "111111111111"
+}
+
+resource "torque_servicenow_approval_channel" "channel" {
+  name        = "name"
+  description = "description"
+  base_url    = "base_url"
+  username    = "username"
+  password    = "password"
+  headers     = "json"
+  approver    = "approver@company.com"
+}
diff --git a/internal/provider/provider.go b/internal/provider/provider.go
@@ -239,6 +239,7 @@ func (p *torqueProvider) Resources(ctx context.Context) []func() resource.Resour
 		resources.NewTorqueDeploymentEngineResource,
 		resources.NewTorqueEmailApprovalChannelResource,
 		resources.NewTorqueTeamsApprovalChannelResource,
+		resources.NewTorqueServiceNowApprovalChannelResource,
 	}
 }
 
diff --git a/internal/provider/resources/torque_servicenow_approval_channel.go b/internal/provider/resources/torque_servicenow_approval_channel.go
@@ -0,0 +1,219 @@
+package resources
+
+import (
+	"context"
+	"fmt"
+
+	"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/stringdefault"
+	"github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier"
+	"github.com/hashicorp/terraform-plugin-framework/types"
+	"github.com/qualitorque/terraform-provider-torque/client"
+)
+
+// Ensure provider defined types fully satisfy framework interfaces.
+var _ resource.Resource = &TorqueServiceNowApprovalChannelResource{}
+var _ resource.ResourceWithImportState = &TorqueServiceNowApprovalChannelResource{}
+
+func NewTorqueServiceNowApprovalChannelResource() resource.Resource {
+	return &TorqueServiceNowApprovalChannelResource{}
+}
+
+// TorqueServiceNowApprovalChannelResource defines the resource implementation.
+type TorqueServiceNowApprovalChannelResource struct {
+	client *client.Client
+}
+
+// TorqueServiceNowApprovalChannelResourceModel describes the resource data model.
+type TorqueServiceNowApprovalChannelResourceModel struct {
+	Name        types.String `tfsdk:"name"`
+	Description types.String `tfsdk:"description"`
+	Approver    types.String `tfsdk:"approver"`
+	BaseUrl     types.String `tfsdk:"base_url"`
+	UserName    types.String `tfsdk:"user_name"`
+	Password    types.String `tfsdk:"password"`
+	Headers     types.String `tfsdk:"headers"`
+}
+
+const (
+	servicenow_approval_channel_type = "ServiceNow"
+)
+
+func (r *TorqueServiceNowApprovalChannelResource) Metadata(ctx context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse) {
+	resp.TypeName = "torque_servicenow_approval_channel"
+}
+
+func (r *TorqueServiceNowApprovalChannelResource) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse) {
+	resp.Schema = schema.Schema{
+		// This description is used by the documentation generator and the language server.
+		MarkdownDescription: "Creates a new ServiceNow approval channel.",
+		Attributes: map[string]schema.Attribute{
+			"name": schema.StringAttribute{
+				MarkdownDescription: "Name of the approval channel.",
+				Optional:            false,
+				Computed:            false,
+				Required:            true,
+				PlanModifiers: []planmodifier.String{
+					stringplanmodifier.RequiresReplace(),
+				},
+			},
+			"description": schema.StringAttribute{
+				MarkdownDescription: "Description of the approval channel",
+				Optional:            true,
+				Computed:            true,
+				Required:            false,
+				Default:             stringdefault.StaticString(""),
+			},
+			"base_url": schema.StringAttribute{
+				MarkdownDescription: "ServiceNow Instance Base URL",
+				Optional:            false,
+				Computed:            false,
+				Required:            true,
+			},
+			"user_name": schema.StringAttribute{
+				MarkdownDescription: "ServiceNow Username",
+				Optional:            false,
+				Computed:            false,
+				Required:            true,
+			},
+			"password": schema.StringAttribute{
+				MarkdownDescription: "ServiceNow Password",
+				Optional:            false,
+				Computed:            false,
+				Required:            true,
+				Sensitive:           true,
+			},
+			"headers": schema.StringAttribute{
+				MarkdownDescription: "Custom Headers (JSON) - JSON formatted string that represents the custom headers, for example {header:'val'}",
+				Optional:            true,
+				Computed:            false,
+				Required:            false,
+			},
+			"approver": schema.StringAttribute{
+				MarkdownDescription: "ServiceNow Approver",
+				Optional:            false,
+				Computed:            false,
+				Required:            true,
+			},
+		},
+	}
+}
+func (r *TorqueServiceNowApprovalChannelResource) Configure(ctx context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse) {
+	// Prevent panic if the provider has not been configured.
+	if req.ProviderData == nil {
+		return
+	}
+
+	client, ok := req.ProviderData.(*client.Client)
+
+	if !ok {
+		resp.Diagnostics.AddError(
+			"Unexpected Resource Configure Type",
+			fmt.Sprintf("Expected *http.Client, got: %T. Please report this issue to the provider developers.", req.ProviderData),
+		)
+
+		return
+	}
+
+	r.client = client
+}
+
+func (r *TorqueServiceNowApprovalChannelResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) {
+	var data TorqueServiceNowApprovalChannelResourceModel
+	var details client.ApprovalChannelDetails
+	details.Approver = &client.Approver{}
+	resp.Diagnostics.Append(req.Plan.Get(ctx, &data)...)
+
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	details.Approver.UserEmail = data.Approver.ValueString()
+	details.Type = servicenow_approval_channel_type
+	details.BaseUrl = data.BaseUrl.ValueStringPointer()
+	details.UserName = data.UserName.ValueStringPointer()
+	details.Password = data.Password.ValueStringPointer()
+	details.Headers = data.Headers.ValueStringPointer()
+	err := r.client.CreateApprovalChannel(data.Name.ValueString(), data.Description.ValueString(), details)
+	if err != nil {
+		resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to create Approval Channel, got error: %s", err))
+		return
+	}
+	resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
+}
+
+func (r *TorqueServiceNowApprovalChannelResource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse) {
+	var data TorqueServiceNowApprovalChannelResourceModel
+
+	diags := req.State.Get(ctx, &data)
+	resp.Diagnostics.Append(diags...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+	approval_channel, err := r.client.GetApprovalChannel(data.Name.ValueString())
+	if err != nil {
+		resp.Diagnostics.AddError(
+			"Error Reading Approval Channel details",
+			"Could not read Approval Channel "+data.Name.ValueString()+": "+err.Error(),
+		)
+		return
+	}
+	data.Name = types.StringValue(approval_channel.Name)
+	data.Description = types.StringValue(approval_channel.Description)
+	data.BaseUrl = types.StringPointerValue(approval_channel.Details.BaseUrl)
+
+	data.Headers = types.StringPointerValue(approval_channel.Details.Headers)
+	data.Approver = types.StringPointerValue(&approval_channel.Details.Approver.UserEmail)
+
+	diags = resp.State.Set(ctx, &data)
+	resp.Diagnostics.Append(diags...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+}
+
+func (r *TorqueServiceNowApprovalChannelResource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse) {
+	var data TorqueServiceNowApprovalChannelResourceModel
+	var details client.ApprovalChannelDetails
+	details.Approver = &client.Approver{}
+
+	resp.Diagnostics.Append(req.Plan.Get(ctx, &data)...)
+
+	details.Approver.UserEmail = data.Approver.ValueString()
+	details.Type = servicenow_approval_channel_type
+	details.BaseUrl = data.BaseUrl.ValueStringPointer()
+	details.UserName = data.UserName.ValueStringPointer()
+	details.Password = data.Password.ValueStringPointer()
+	details.Headers = data.Headers.ValueStringPointer()
+	err := r.client.UpdateApprovalChannel(data.Name.ValueString(), data.Description.ValueString(), details)
+	if err != nil {
+		resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to update Approval Channel, got error: %s", err))
+		return
+	}
+	resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
+}
+
+func (r *TorqueServiceNowApprovalChannelResource) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse) {
+	var data TorqueServiceNowApprovalChannelResourceModel
+
+	// Read Terraform prior state data into the model.
+	resp.Diagnostics.Append(req.State.Get(ctx, &data)...)
+
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	err := r.client.DeleteApprovalChannel(data.Name.ValueString())
+	if err != nil {
+		resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Unable to delete Approval Channel, got error: %s", err))
+		return
+	}
+
+}
+
+func (r *TorqueServiceNowApprovalChannelResource) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse) {
+	resource.ImportStatePassthroughID(ctx, path.Root("name"), req, resp)
+}
diff --git a/internal/provider/tests/torque_servicenow_approval_channel_test.go b/internal/provider/tests/torque_servicenow_approval_channel_test.go

Original file line number	Diff line number	Diff line change
`@@ -239,6 +239,7 @@ func (p *torqueProvider) Resources(ctx context.Context) []func() resource.Resour`
`239`	`239`	`resources.NewTorqueDeploymentEngineResource,`
`240`	`240`	`resources.NewTorqueEmailApprovalChannelResource,`
`241`	`241`	`resources.NewTorqueTeamsApprovalChannelResource,`
	`242`	`+ resources.NewTorqueServiceNowApprovalChannelResource,`
`242`	`243`	`}`
`243`	`244`	`}`
`244`	`245`