feat: Added support for Squadcast provider

cmd/provider_cmd_squadcast.go

@@ -0,0 +1,38 @@
+package cmd
+
+import (
+	squadcast_terraforming "github.com/GoogleCloudPlatform/terraformer/providers/squadcast"
+
+	"github.com/GoogleCloudPlatform/terraformer/terraformutils"
+	"github.com/spf13/cobra"
+)
+
+func newCmdSquadcastImporter(options ImportOptions) *cobra.Command {
+	var refreshToken, teamName, region, serviceName string
+
+	cmd := &cobra.Command{
+		Use:   "squadcast",
+		Short: "Import current state to Terraform configuration from Squadcast",
+		Long:  "Import current state to Terraform configuration from Squadcast",
+		RunE: func(cmd *cobra.Command, args []string) error {
+			provider := newSquadcastProvider()
+			options.PathPattern += region + "/"
+			err := Import(provider, options, []string{refreshToken, region, teamName, serviceName})
+			if err != nil {
+				return err
+			}
+			return nil
+		},
+	}
+	cmd.AddCommand(listCmd(newSquadcastProvider()))
+	baseProviderFlags(cmd.PersistentFlags(), &options, "user", "")
+	cmd.PersistentFlags().StringVarP(&refreshToken, "refresh-token", "", "", "YOUR_SQUADCAST_REFRESH_TOKEN or env variable SQUADCAST_REFRESH_TOKEN")
+	cmd.PersistentFlags().StringVarP(&region, "region", "", "", "eu or us")
+	cmd.PersistentFlags().StringVarP(&teamName, "team-name", "", "", "Squadcast team name")
+	cmd.PersistentFlags().StringVarP(&serviceName, "service-name", "", "", "Squadcast service name")
+	return cmd
+}
+
+func newSquadcastProvider() terraformutils.ProviderGenerator {
+	return &squadcast_terraforming.SCProvider{}
+}

cmd/root.go

@@ -78,6 +78,7 @@ func providerImporterSubcommands() []func(options ImportOptions) *cobra.Command
 		newCmdPagerDutyImporter,
 		newCmdOpsgenieImporter,
 		newCmdHoneycombioImporter,
+		newCmdSquadcastImporter,
 		newCmdOpalImporter,
 		// Community
 		newCmdKeycloakImporter,

docs/squadcast.md

@@ -0,0 +1,143 @@
+# Use with Squadcast
+
+Syntax:
+
+`export SQUADCAST_REFRESH_TOKEN=<YOUR_SQUADCAST_REFRESH_TOKEN>`
+
+OR
+
+Add `--refresh-token` flag in cmd
+
+```
+terraformer import squadcast --resources=<SERVICE_NAMES> --region=SQUADCAST_REGION
+```
+
+### Examples:
+
+- `Import Resource by providing refresh-token as a flag`
+
+```
+terraformer import squadcast --resources=team --region=us --team-name="Default Team" --refresh-token=YOUR_REFRESH_TOKEN
+```
+
+- `Import User Resource`
+
+```
+terraformer import squadcast --resources=user --region=us --team-name="Defualt Team"
+```
+
+- `Import Squad Resource`
+
+```
+terraformer import squadcast --resources=team --region=us --team-name="Default Team"
+```
+
+- `Import Deduplication Rules Resource` (without `--service-name` flag)
+  - Deduplication Rules for all the services under Default Team will be generated.
+
+```
+terraformer import squadcast --resources=deduplication_rules --region=us --team-name="Default Team"
+```
+
+- `Import Deduplication Rules Resource`
+  - Deduplication Rules only for Example Service will be generated.
+
+```
+terraformer import squadcast --resources=deduplication_rules --region=us --team-name="Default Team" --service-name="Example Service"
+```
+
+### In order to use terraform files:
+
+- Update version and add source in `provider.tf`
+  - Go to `/generated/squadcast/<RESOURCE>/<REGION>/provider.tf`
+  - Add `source = "SquadcastHub/squadcast"` to squadcast inside `required_providers`
+  - Update `version` in `required_providers` by removing `.exe` (Windows users only)
+- Update `terraform_version`
+  - `cd /generated/squadcast/<RESOURCE>/<REGION>`
+  - `terraform state replace-provider -auto-approve "registry.terraform.io/-/squadcast" "SquadcastHub/squadcast"`
+
+### Example:
+
+```
+terraform {
+    required_providers {
+        squadcast = {
+            version = "~> 2.0.1"
+            source = "SquadcastHub/squadcast"
+        }
+    }
+}
+```
+
+### Flags:
+
+- `--team-name`
+
+  - Required for the following resources:
+    - deduplication_rules
+    - escalation_policy
+    - routing_rules
+    - runbook
+    - service
+    - slo
+    - squad
+    - suppression_rules
+    - tagging_rules
+    - team_member
+    - team_roles
+    - user
+    - webform
+    - schedules_v2
+    - global_event_rules
+    - status_pages
+    - status_page_components
+    - status_page_groups
+
+- `--region`
+
+  - Supported Values:
+    - `us`
+    - `eu`
+
+- `--service-name` (optional)
+
+  - Supported for the following resources:
+    - deduplication_rules
+    - routing_rules
+    - suppression_rules
+    - tagging_rules
+    - deduplication_rules_v2
+    - routing_rules_v2
+    - suppression_rules_v2
+    - tagging_rules_v2
+  - If service name is not provided, resources for specified automation rule for all the service within the specified team will be generated. However it will only generate for a specific service when this flag is used. [see examples](squadcast.md:36)
+
+- `--refresh-token` (optional)
+  - Supported Values:
+    - <YOUR_SQUADCAST_REFRESH_TOKEN>
+
+### Supported resources:
+
+- [`deduplication_rules`](https://registry.terraform.io/providers/SquadcastHub/squadcast/latest/docs/resources/deduplication_rules)
+- [`deduplication_rule_v2`](https://registry.terraform.io/providers/SquadcastHub/squadcast/latest/docs/resources/deduplication_rule_v2)
+- [`escalation_policy`](https://registry.terraform.io/providers/SquadcastHub/squadcast/latest/docs/resources/escalation_policy)
+- [`routing_rules`](https://registry.terraform.io/providers/SquadcastHub/squadcast/latest/docs/resources/routing_rules)
+- [`routing_rule_v2`](https://registry.terraform.io/providers/SquadcastHub/squadcast/latest/docs/resources/routing_rule_v2)
+- [`runbook`](https://registry.terraform.io/providers/SquadcastHub/squadcast/latest/docs/resources/runbook)
+- [`service`](https://registry.terraform.io/providers/SquadcastHub/squadcast/latest/docs/resources/service)
+- [`slo`](https://registry.terraform.io/providers/SquadcastHub/squadcast/latest/docs/resources/slo)
+- [`squad`](https://registry.terraform.io/providers/SquadcastHub/squadcast/latest/docs/resources/squad)
+- [`suppression_rules`](https://registry.terraform.io/providers/SquadcastHub/squadcast/latest/docs/resources/suppression_rules)
+- [`suppression_rule_v2`](https://registry.terraform.io/providers/SquadcastHub/squadcast/latest/docs/resources/suppression_rule_v2)
+- [`tagging_rules`](https://registry.terraform.io/providers/SquadcastHub/squadcast/latest/docs/resources/tagging_rules)
+- [`tagging_rule_v2`](https://registry.terraform.io/providers/SquadcastHub/squadcast/latest/docs/resources/tagging_rule_v2)
+- [`team`](https://registry.terraform.io/providers/SquadcastHub/squadcast/latest/docs/resources/team)
+- [`team_member`](https://registry.terraform.io/providers/SquadcastHub/squadcast/latest/docs/resources/team_member)
+- [`team_roles`](https://registry.terraform.io/providers/SquadcastHub/squadcast/latest/docs/resources/team_role)
+- [`user`](https://registry.terraform.io/providers/SquadcastHub/squadcast/latest/docs/resources/user)
+- [`webforms`](https://registry.terraform.io/providers/SquadcastHub/squadcast/latest/docs/resources/webform)
+- [`status_pages`](https://registry.terraform.io/providers/SquadcastHub/squadcast/latest/docs/resources/status_page)
+- [`status_page_components`](https://registry.terraform.io/providers/SquadcastHub/squadcast/latest/docs/resources/status_page_component)
+- [`status_page_groups`](https://registry.terraform.io/providers/SquadcastHub/squadcast/latest/docs/resources/status_page_group)
+- [`global_event_rules`](https://registry.terraform.io/providers/SquadcastHub/squadcast/latest/docs/resources/ger)
+- [`schedules_v2`](https://registry.terraform.io/providers/SquadcastHub/squadcast/latest/docs/resources/schedule_v2)

go.mod

@@ -257,7 +257,7 @@ require (
 	github.com/google/go-querystring v1.1.0 // indirect
 	github.com/google/gofuzz v1.1.0 // indirect
 	github.com/google/jsonapi v1.0.0 // indirect
-	github.com/google/uuid v1.3.0 // indirect
+	github.com/google/uuid v1.6.0 // indirect
 	github.com/googleapis/gax-go/v2 v2.12.0 // indirect
 	github.com/gorilla/websocket v1.4.2 // indirect
 	github.com/hashicorp/errwrap v1.1.0 // indirect
@@ -389,11 +389,13 @@ require (
 	google.golang.org/genproto/googleapis/api v0.0.0-20230629202037-9506855d4529 // indirect
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20230706204954-ccb25ca9f130 // indirect
 	k8s.io/kube-openapi v0.0.0-20220328201542-3ee0da9b0b42 // indirect
+	nhooyr.io/websocket v1.8.10 // indirect
 	sigs.k8s.io/json v0.0.0-20211208200746-9f7c6b3444d2 // indirect
 )
 
 require (
 	github.com/gofrs/uuid/v3 v3.1.2
+	github.com/hasura/go-graphql-client v0.12.1
 	github.com/ionos-cloud/sdk-go-cert-manager v1.0.0
 	github.com/ionos-cloud/sdk-go-container-registry v1.0.0
 	github.com/ionos-cloud/sdk-go-dataplatform v1.0.1

go.sum

@@ -895,6 +895,8 @@ github.com/google/uuid v1.1.1/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+
 github.com/google/uuid v1.1.2/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I=
 github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
+github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
+github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/googleapis/enterprise-certificate-proxy v0.0.0-20220520183353-fd19c99a87aa/go.mod h1:17drOmN3MwGY7t0e+Ei9b45FFGA3fBs3x36SsCg1hq8=
 github.com/googleapis/enterprise-certificate-proxy v0.1.0/go.mod h1:17drOmN3MwGY7t0e+Ei9b45FFGA3fBs3x36SsCg1hq8=
 github.com/googleapis/enterprise-certificate-proxy v0.2.0/go.mod h1:8C0jb7/mgJe/9KK8Lm7X9ctZC2t60YyIpYEI16jx0Qg=
@@ -1036,6 +1038,8 @@ github.com/hashicorp/vault v0.10.4/go.mod h1:KfSyffbKxoVyspOdlaGVjIuwLobi07qD1bA
 github.com/hashicorp/yamux v0.0.0-20180604194846-3520598351bb/go.mod h1:+NfK9FKeTrX5uv1uIXGdwYDTeHna2qgaIlx54MXqjAM=
 github.com/hashicorp/yamux v0.0.0-20211028200310-0bc27b27de87 h1:xixZ2bWeofWV68J+x6AzmKuVM/JWCQwkWm6GW/MUR6I=
 github.com/hashicorp/yamux v0.0.0-20211028200310-0bc27b27de87/go.mod h1:CtWFDAQgb7dxtzFs4tWbplKIe2jSi3+5vKbgIO0SLnQ=
+github.com/hasura/go-graphql-client v0.12.1 h1:tL+BCoyubkYYyaQ+tJz+oPe/pSxYwOJHwe5SSqqi6WI=
+github.com/hasura/go-graphql-client v0.12.1/go.mod h1:F4N4kR6vY8amio3gEu3tjSZr8GPOXJr3zj72DKixfLE=
 github.com/heimweh/go-pagerduty v0.0.0-20210930203304-530eff2acdc6 h1:/D0VtHEOCdotE1vSB9XznceAjIGkUieZ4BF6VKUIqNU=
 github.com/heimweh/go-pagerduty v0.0.0-20210930203304-530eff2acdc6/go.mod h1:JtJGtgN0y9KOCaqFMZFaBCWskpO/KK3Ro9TwjP9ss6w=
 github.com/heroku/heroku-go/v5 v5.4.1 h1:J1nNnR3/571b2iUDHl+y1B3VkhKm6YOXIq9GGzQUv5s=
@@ -2416,6 +2420,8 @@ k8s.io/kube-openapi v0.0.0-20220328201542-3ee0da9b0b42/go.mod h1:Z/45zLw8lUo4wdi
 k8s.io/utils v0.0.0-20210802155522-efc7438f0176/go.mod h1:jPW/WVKK9YHAvNhRxK0md/EJ228hCsBRufyofKtW8HA=
 k8s.io/utils v0.0.0-20220210201930-3a6ce19ff2f9 h1:HNSDgDCrr/6Ly3WEGKZftiE7IY19Vz2GdbOCyI4qqhc=
 k8s.io/utils v0.0.0-20220210201930-3a6ce19ff2f9/go.mod h1:jPW/WVKK9YHAvNhRxK0md/EJ228hCsBRufyofKtW8HA=
+nhooyr.io/websocket v1.8.10 h1:mv4p+MnGrLDcPlBoWsvPP7XCzTYMXP9F9eIGoKbgx7Q=
+nhooyr.io/websocket v1.8.10/go.mod h1:rN9OFWIUwuxg4fR5tELlYC04bXYowCP9GX47ivo2l+c=
 rsc.io/binaryregexp v0.2.0/go.mod h1:qTv7/COck+e2FymRvadv62gMdZztPaShugOCi3I+8D8=
 rsc.io/pdf v0.1.1/go.mod h1:n8OzWcQ6Sp37PL01nO98y4iUCRdTGarVfzxY20ICaU4=
 rsc.io/quote/v3 v3.1.0/go.mod h1:yEA65RcK8LyAZtP9Kv3t0HmxON59tX3rD+tICJqUlj0=

providers/squadcast/deduplication_rules.go

@@ -0,0 +1,84 @@
+package squadcast
+
+import (
+	"fmt"
+
+	"github.com/GoogleCloudPlatform/terraformer/terraformutils"
+)
+
+type DeduplicationRulesGenerator struct {
+	SCService
+}
+
+type DeduplicationRules struct {
+	ID        string               `json:"id"`
+	ServiceID string               `json:"service_id"`
+	Rules     []*DeduplicationRule `json:"rules"`
+}
+
+type DeduplicationRule struct {
+	ID string `json:"rule_id"`
+}
+
+func (g *DeduplicationRulesGenerator) createResources(deduplicationRules DeduplicationRules) []terraformutils.Resource {
+	var resourceList []terraformutils.Resource
+	for _, rule := range deduplicationRules.Rules {
+		resourceList = append(resourceList, terraformutils.NewResource(
+			rule.ID,
+			fmt.Sprintf("deduplication_rule_%s", rule.ID),
+			"squadcast_deduplication_rules",
+			g.GetProviderName(),
+			map[string]string{
+				"team_id":    g.Args["team_id"].(string),
+				"service_id": deduplicationRules.ServiceID,
+			},
+			[]string{},
+			map[string]interface{}{},
+		))
+	}
+	return resourceList
+}
+
+func (g *DeduplicationRulesGenerator) InitResources() error {
+	if len(g.Args["service_name"].(string)) == 0 {
+		req := TRequest{
+			URL:             "/v3/services",
+			AccessToken:     g.Args["access_token"].(string),
+			Region:          g.Args["region"].(string),
+			IsAuthenticated: true,
+		}
+		responseService, _, err := Request[[]Service](req)
+		if err != nil {
+			return err
+		}
+
+		for _, service := range *responseService {
+			req := TRequest{
+				URL:             fmt.Sprintf("/v3/services/%s/deduplication-rules", service.ID),
+				AccessToken:     g.Args["access_token"].(string),
+				Region:          g.Args["region"].(string),
+				IsAuthenticated: true,
+			}
+			response, _, err := Request[DeduplicationRules](req)
+			if err != nil {
+				return err
+			}
+
+			g.Resources = append(g.Resources, g.createResources(*response)...)
+		}
+	} else {
+		req := TRequest{
+			URL:             fmt.Sprintf("/v3/services/%s/deduplication-rules", g.Args["service_id"]),
+			AccessToken:     g.Args["access_token"].(string),
+			Region:          g.Args["region"].(string),
+			IsAuthenticated: true,
+		}
+		response, _, err := Request[DeduplicationRules](req)
+		if err != nil {
+			return err
+		}
+
+		g.Resources = g.createResources(*response)
+	}
+	return nil
+}