Merge pull request #11 from squaredup/work/ss/code-review

Rename of Data Source and Simplify DataSource Config

.github/workflows/test.yml

@@ -59,6 +59,7 @@ jobs:
         terraform:
           - '1.6.*'
           - latest
+      max-parallel: 1
     steps:
       - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
       - uses: actions/setup-go@93397bea11091df50f3d7e59dc26a7711a8bcfbe # v4.1.0

docs/data-sources/latest_datasources.md → docs/data-sources/datasources.md

@@ -1,19 +1,19 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "squaredup_latest_datasources Data Source - terraform-provider-squaredup"
+page_title: "squaredup_datasources Data Source - terraform-provider-squaredup"
 subcategory: ""
 description: |-
   Data Sources are used to query third party APIs and SquaredUp visualizes the results
 ---
 
-# squaredup_latest_datasources (Data Source)
+# squaredup_datasources (Data Source)
 
 Data Sources are used to query third party APIs and SquaredUp visualizes the results
 
 ## Example Usage
 
 ```terraform
-data "squaredup_latest_datasources" "sample_data" {
+data "squaredup_datasources" "sample_data" {
   data_source_name = "Sample Data"
 }
 ```

docs/resources/dashboard.md

@@ -13,13 +13,13 @@ Dashboard are used to visualize data from Data Sources
 ## Example Usage
 
 ```terraform
-data "squaredup_latest_datasources" "sample_data" {
+data "squaredup_datasources" "sample_data" {
   data_source_name = "Sample Data"
 }
 
 resource "squaredup_datasource" "sample_data_source" {
   display_name     = "Sample Data"
-  data_source_name = data.squaredup_latest_datasources.sample_data.plugins[0].display_name
+  data_source_name = data.squaredup_datasources.sample_data.plugins[0].display_name
 }
 
 resource "squaredup_workspace" "application_workspace" {
@@ -29,7 +29,7 @@ resource "squaredup_workspace" "application_workspace" {
 }
 
 data "squaredup_data_streams" "sample_data_logs_dataStreams" {
-  data_source_id = data.squaredup_latest_datasources.sample_data.plugins[0].id
+  data_source_id = data.squaredup_datasources.sample_data.plugins[0].id
 }
 
 locals {

docs/resources/datasource.md

@@ -13,13 +13,22 @@ Data Sources are used to query third party APIs and SquaredUp visualizes the res
 ## Example Usage
 
 ```terraform
-data "squaredup_latest_datasources" "sample_data" {
+data "squaredup_datasources" "sample_data" {
   data_source_name = "Sample Data"
 }
 
 resource "squaredup_datasource" "sample_data_source" {
   display_name     = "Sample Data"
-  data_source_name = data.squaredup_latest_datasources.sample_data.plugins[0].display_name
+  data_source_name = data.squaredup_datasources.sample_data.plugins[0].display_name
+}
+
+resource "squaredup_datasource" "ado_datasource" {
+  display_name     = "Azure DevOps"
+  data_source_name = "Azure DevOps"
+  config = jsonencode({
+    org         = "org-name"
+    accessToken = "access-token"
+  })
 }
 ```
 
@@ -34,8 +43,7 @@ resource "squaredup_datasource" "sample_data_source" {
 ### Optional
 
 - `agent_group_id` (String) The ID of the agent group to which the data source should connect to (on-prem data sources only)
-- `json_data_encoded` (String) Additional configuration for configuring data source. Needs to be a valid JSON
-- `secure_json_data_encoded` (String, Sensitive) Sensitive configuration for the data source. Needs to be a valid JSON
+- `config` (String, Sensitive) Sensitive configuration for the data source. Needs to be a valid JSON
 
 ### Read-Only
 

docs/resources/workspace.md

@@ -13,13 +13,13 @@ Each workspace has its own dashboards, data sources, monitors and scopes.
 ## Example Usage
 
 ```terraform
-data "squaredup_latest_datasources" "sample_data" {
+data "squaredup_datasources" "sample_data" {
   data_source_name = "Sample Data"
 }
 
 resource "squaredup_datasource" "sample_data_source" {
   display_name     = "Sample Data"
-  data_source_name = data.squaredup_latest_datasources.sample_data.plugins[0].display_name
+  data_source_name = data.squaredup_datasources.sample_data.plugins[0].display_name
 }
 
 resource "squaredup_workspace" "application_workspace" {

examples/data-sources/squaredup_datasources/data-source.tf

@@ -0,0 +1,3 @@
+data "squaredup_datasources" "sample_data" {
+  data_source_name = "Sample Data"
+}

examples/resources/squaredup_dashboard/resource.tf

@@ -1,10 +1,10 @@
-data "squaredup_latest_datasources" "sample_data" {
+data "squaredup_datasources" "sample_data" {
   data_source_name = "Sample Data"
 }
 
 resource "squaredup_datasource" "sample_data_source" {
   display_name     = "Sample Data"
-  data_source_name = data.squaredup_latest_datasources.sample_data.plugins[0].display_name
+  data_source_name = data.squaredup_datasources.sample_data.plugins[0].display_name
 }
 
 resource "squaredup_workspace" "application_workspace" {
@@ -14,7 +14,7 @@ resource "squaredup_workspace" "application_workspace" {
 }
 
 data "squaredup_data_streams" "sample_data_logs_dataStreams" {
-  data_source_id = data.squaredup_latest_datasources.sample_data.plugins[0].id
+  data_source_id = data.squaredup_datasources.sample_data.plugins[0].id
 }
 
 locals {

examples/resources/squaredup_datasource/resource.tf

@@ -1,8 +1,17 @@
-data "squaredup_latest_datasources" "sample_data" {
+data "squaredup_datasources" "sample_data" {
   data_source_name = "Sample Data"
 }
 
 resource "squaredup_datasource" "sample_data_source" {
   display_name     = "Sample Data"
-  data_source_name = data.squaredup_latest_datasources.sample_data.plugins[0].display_name
+  data_source_name = data.squaredup_datasources.sample_data.plugins[0].display_name
+}
+
+resource "squaredup_datasource" "ado_datasource" {
+  display_name     = "Azure DevOps"
+  data_source_name = "Azure DevOps"
+  config = jsonencode({
+    org         = "org-name"
+    accessToken = "access-token"
+  })
 }

examples/resources/squaredup_workspace/resource.tf

@@ -1,10 +1,10 @@
-data "squaredup_latest_datasources" "sample_data" {
+data "squaredup_datasources" "sample_data" {
   data_source_name = "Sample Data"
 }
 
 resource "squaredup_datasource" "sample_data_source" {
   display_name     = "Sample Data"
-  data_source_name = data.squaredup_latest_datasources.sample_data.plugins[0].display_name
+  data_source_name = data.squaredup_datasources.sample_data.plugins[0].display_name
 }
 
 resource "squaredup_workspace" "application_workspace" {

examples/test-setup/main.tf

@@ -11,28 +11,26 @@ provider "squaredup" {
   api_key = "api-key"
 }
 
-data "squaredup_latest_datasources" "azure_devops" {
+data "squaredup_datasources" "azure_devops" {
   data_source_name = "Azure DevOps"
 }
 
-data "squaredup_latest_datasources" "sample_data" {
+data "squaredup_datasources" "sample_data" {
   data_source_name = "Sample Data"
 }
 
 resource "squaredup_datasource" "ado_datasource" {
   display_name     = "Azure DevOps"
-  data_source_name = data.squaredup_latest_datasources.azure_devops.plugins[0].display_name
-  json_data_encoded = jsonencode({
-    org = "org-name"
-  })
-  secure_json_data_encoded = jsonencode({
+  data_source_name = data.squaredup_datasources.azure_devops.plugins[0].display_name
+  config = jsonencode({
+    org         = "org-name"
     accessToken = "access-token"
   })
 }
 
 resource "squaredup_datasource" "sample_data_source" {
   display_name     = "Sample Data"
-  data_source_name = data.squaredup_latest_datasources.sample_data.plugins[0].display_name
+  data_source_name = data.squaredup_datasources.sample_data.plugins[0].display_name
 }
 
 resource "squaredup_workspace" "application_workspace" {
@@ -51,7 +49,7 @@ resource "squaredup_workspace" "devops_workspace" {
 }
 
 data "squaredup_data_streams" "azure_devops_dataStreams" {
-  data_source_id = data.squaredup_latest_datasources.azure_devops.plugins[0].id
+  data_source_id = data.squaredup_datasources.azure_devops.plugins[0].id
 }
 
 locals {
@@ -60,17 +58,17 @@ locals {
 }
 
 data "squaredup_data_streams" "sample_data_logs_dataStreams" {
-  data_source_id              = data.squaredup_latest_datasources.sample_data.plugins[0].id
+  data_source_id              = data.squaredup_datasources.sample_data.plugins[0].id
   data_stream_definition_name = "logs"
 }
 
 data "squaredup_data_streams" "sample_data_lambdaerrors_dataStreams" {
-  data_source_id              = data.squaredup_latest_datasources.sample_data.plugins[0].id
+  data_source_id              = data.squaredup_datasources.sample_data.plugins[0].id
   data_stream_definition_name = "perf-lambda-errors"
 }
 
 resource "squaredup_dashboard" "devops_team_dashboard" {
-  dashboard_template = file(".\\dashboardTemplate.json")
+  dashboard_template = file("dashboardTemplate.json")
   template_bindings = jsonencode({
     azure_devops_data_source_id = squaredup_datasource.ado_datasource.id
     sample_data_source_id       = squaredup_datasource.sample_data_source.id

internal/provider/client_data_source.go

@@ -42,7 +42,7 @@ func (c *SquaredUpClient) GetLatestDataSources(filterDisplayName string) ([]Late
 	return plugins, nil
 }
 
-func (c *SquaredUpClient) GenerateDataSourcePayload(displayName string, name string, pluginConfig map[string]interface{}, secureJsonData map[string]interface{}, agentGroupId string) (map[string]interface{}, error) {
+func (c *SquaredUpClient) GenerateDataSourcePayload(displayName string, name string, pluginConfig map[string]interface{}, agentGroupId string) (map[string]interface{}, error) {
 	plugins, err := c.GetLatestDataSources(name)
 	if err != nil {
 		return nil, err
@@ -76,20 +76,11 @@ func (c *SquaredUpClient) GenerateDataSourcePayload(displayName string, name str
 		config[key] = value
 	}
 
-	for key, value := range secureJsonData {
-		config, ok := DataSourcePayload["config"].(map[string]interface{})
-		if !ok {
-			config = make(map[string]interface{})
-			DataSourcePayload["config"] = config
-		}
-		config[key] = value
-	}
-
 	return DataSourcePayload, nil
 }
 
-func (c *SquaredUpClient) AddDataSource(displayName string, name string, pluginConfig map[string]interface{}, secureJsonData map[string]interface{}, agentGroupId string) (*DataSource, error) {
-	DataSourcePayload, err := c.GenerateDataSourcePayload(displayName, name, pluginConfig, secureJsonData, agentGroupId)
+func (c *SquaredUpClient) AddDataSource(displayName string, name string, pluginConfig map[string]interface{}, agentGroupId string) (*DataSource, error) {
+	DataSourcePayload, err := c.GenerateDataSourcePayload(displayName, name, pluginConfig, agentGroupId)
 	if err != nil {
 		return nil, err
 	}
@@ -138,8 +129,8 @@ func (c *SquaredUpClient) GetDataSource(dataSourceId string) (*DataSource, error
 	return &dataSource, nil
 }
 
-func (c *SquaredUpClient) UpdateDataSource(dataSourceId string, displayName string, name string, pluginConfig map[string]interface{}, secureJsonData map[string]interface{}, agentGroupId string) error {
-	DataSourcePayload, err := c.GenerateDataSourcePayload(displayName, name, pluginConfig, secureJsonData, agentGroupId)
+func (c *SquaredUpClient) UpdateDataSource(dataSourceId string, displayName string, name string, pluginConfig map[string]interface{}, agentGroupId string) error {
+	DataSourcePayload, err := c.GenerateDataSourcePayload(displayName, name, pluginConfig, agentGroupId)
 	if err != nil {
 		return err
 	}

internal/provider/data_source_latest_data_sources.go → internal/provider/data_source_data_sources.go

@@ -39,7 +39,7 @@ type squaredupPluginModel struct {
 }
 
 func (d *squaredupLatestDataSource) Metadata(_ context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) {
-	resp.TypeName = req.ProviderTypeName + "_latest_datasources"
+	resp.TypeName = req.ProviderTypeName + "_datasources"
 }
 
 func (d *squaredupLatestDataSource) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) {

internal/provider/data_source_data_streams_test.go

@@ -13,12 +13,12 @@ func TestDataStreamsDataSource(t *testing.T) {
 			{
 				Config: providerConfig +
 					`
-data "squaredup_latest_datasources" "sample_data" {
+data "squaredup_datasources" "sample_data" {
 	data_source_name = "Sample Data"
 }
 
 data "squaredup_data_streams" "sample_data_logs_dataStreams" {
-	data_source_id = data.squaredup_latest_datasources.sample_data.plugins[0].id
+	data_source_id = data.squaredup_datasources.sample_data.plugins[0].id
 	data_stream_definition_name = "logs"
 }
 `,

internal/provider/data_source_latest_data_sources_test.go

@@ -13,13 +13,13 @@ func TestLatestDataSourcesDataSource(t *testing.T) {
 			{
 				Config: providerConfig +
 					`
-data "squaredup_latest_datasources" "sample_data" {
+data "squaredup_datasources" "sample_data" {
 	data_source_name = "Sample Data"
 }
 `,
 				Check: resource.ComposeAggregateTestCheckFunc(
-					resource.TestCheckResourceAttr("data.squaredup_latest_datasources.sample_data", "plugins.#", "1"),
-					resource.TestCheckResourceAttr("data.squaredup_latest_datasources.sample_data", "plugins.0.display_name", "Sample Data"),
+					resource.TestCheckResourceAttr("data.squaredup_datasources.sample_data", "plugins.#", "1"),
+					resource.TestCheckResourceAttr("data.squaredup_datasources.sample_data", "plugins.0.display_name", "Sample Data"),
 				),
 			},
 		},

internal/provider/resource_dashboard_test.go

@@ -13,13 +13,13 @@ func TestDashboardResource(t *testing.T) {
 			//Create Dashboard Test
 			{
 				Config: providerConfig + `
-data "squaredup_latest_datasources" "sample_data" {
+data "squaredup_datasources" "sample_data" {
 	data_source_name = "Sample Data"
 }
 	
 resource "squaredup_datasource" "sample_data_source" {
 	display_name     = "Sample Data"
-	data_source_name = data.squaredup_latest_datasources.sample_data.plugins[0].display_name
+	data_source_name = data.squaredup_datasources.sample_data.plugins[0].display_name
 }
 	
 resource "squaredup_workspace" "application_workspace" {
@@ -29,7 +29,7 @@ resource "squaredup_workspace" "application_workspace" {
 }
 	
 data "squaredup_data_streams" "sample_data_logs_dataStreams" {
-	data_source_id = data.squaredup_latest_datasources.sample_data.plugins[0].id
+	data_source_id = data.squaredup_datasources.sample_data.plugins[0].id
 }
 	
 locals {
@@ -149,13 +149,13 @@ EOT
 			//Update Dashboard Test
 			{
 				Config: providerConfig + `
-data "squaredup_latest_datasources" "sample_data" {
+data "squaredup_datasources" "sample_data" {
 	data_source_name = "Sample Data"
 }
 	
 resource "squaredup_datasource" "sample_data_source" {
 	display_name     = "Sample Data"
-	data_source_name = data.squaredup_latest_datasources.sample_data.plugins[0].display_name
+	data_source_name = data.squaredup_datasources.sample_data.plugins[0].display_name
 }
 	
 resource "squaredup_workspace" "application_workspace" {
@@ -165,7 +165,7 @@ resource "squaredup_workspace" "application_workspace" {
 }
 	
 data "squaredup_data_streams" "sample_data_logs_dataStreams" {
-	data_source_id = data.squaredup_latest_datasources.sample_data.plugins[0].id
+	data_source_id = data.squaredup_datasources.sample_data.plugins[0].id
 }
 	
 locals {