Service principal fix and plugin name fixes (#7)

DodinViorel · web-flow · commit d413bbd9e53a · 2024-04-16T08:44:29.000-07:00
* Fix for service principal auth (#7) Signed-off-by: Viorel Dodin <vdodin@cisco.com> * Fix naming from cop to observability (#8) Various errors were encountered during testing. Binnary plugin name and provider name must match. Signed-off-by: Viorel Dodin <vdodin@cisco.com> --------- Signed-off-by: Viorel Dodin <vdodin@cisco.com>
diff --git a/examples/data-sources/cop_example/data-source.tf b/examples/data-sources/cop_example/data-source.tf
@@ -6,23 +6,24 @@
 
 terraform {
   required_providers {
-    cop = {
-      source = "testTerraform.com/appd/cop"
+    observability = {
+      source = "testTerraform.com/appd/observability"
     }
   }
 }
 
-provider "cop" {
-  tenant      = "47a01df9-54a0-472b-96b8-7c8f64eb7cbf"
-  auth_method = "oauth"
-  url         = "https://alameda-c0-test-02.saas.appd-test.com"
+provider "observability" {
+  tenant="0eb4e853-34fb-4f77-b3fc-b9cd3b462366"
+  auth_method="service-principal"
+  url="https://aiops-dev.saas.appd-test.com"
+  secrets_file="/home/vdodin/aiops_secret.json"
 }
 
 
-data "cop_type" "ns" {
+data "observability_type" "ns" {
   type_name = "fmm:namespace"
 }
 
 output "myType" {
-  value = data.cop_type.ns
+  value = data.observability_type.ns
 }
diff --git a/examples/provider/provider_oauth.tf b/examples/provider/provider_oauth.tf
@@ -6,13 +6,13 @@
 
 terraform {
   required_providers {
-    cop = {
-      source = "testTerraform.com/appd/cop"
+    observability = {
+      source = "testTerraform.com/appd/observability"
     }
   }
 }
 
-provider "cop" {
+provider "observability" {
   tenant="47a01df9-54a0-472b-96b8-7c8f64eb7cbf"
   auth_method="oauth"
   url="https://alameda-c0-test-02.saas.appd-test.com"
diff --git a/examples/provider/provider_service_principal.tf b/examples/provider/provider_service_principal.tf
@@ -6,13 +6,13 @@
 
 terraform {
   required_providers {
-    cop = {
-      source = "testTerraform.com/appd/cop"
+    observability = {
+      source = "testTerraform.com/appd/observability"
     }
   }
 }
 
-provider "cop" {
+provider "observability" {
   tenant="47a01df9-54a0-472b-96b8-7c8f64eb7cbf"
   auth_method="service-principal"
   url="https://alameda-c0-test-02.saas.appd-test.com"
diff --git a/examples/resources/cop_example/resource.tf b/examples/resources/cop_example/resource.tf
@@ -6,19 +6,19 @@
 
 terraform {
   required_providers {
-    cop = {
-      source = "testTerraform.com/appd/cop"
+    observability = {
+      source = "testTerraform.com/appd/observability"
     }
   }
 }
 
-provider "cop" {
+provider "observability" {
   tenant      = "47a01df9-54a0-472b-96b8-7c8f64eb7cbf"
   auth_method = "oauth"
   url         = "https://alameda-c0-test-02.saas.appd-test.com"
 }
 
-resource "cop_object" "ns" {
+resource "observability_object" "ns" {
   type_name = "fmm:namespace"
   object_id = "aws"
   layer_type = "TENANT"
diff --git a/internal/api/objectapi.go b/internal/api/objectapi.go
@@ -34,10 +34,7 @@ func (ac *AppdClient) GetObject(fullyQualifiedTypeName, objectID, layerID, layer
 
 	req.Header.Add("Content-Type", contentType)
 	req.Header.Add("Accept", contentType)
-
-	if ac.AuthMethod == authMethodOAuth {
-		req.Header.Add("Authorization", "Bearer "+ac.Token)
-	}
+	req.Header.Add("Authorization", "Bearer "+ac.Token)
 
 	req.Header.Add("layer-id", layerID)
 	req.Header.Add("layer-type", layerType)
diff --git a/internal/api/typeapi.go b/internal/api/typeapi.go
@@ -27,10 +27,7 @@ func (ac *AppdClient) GetType(fullyQualifiedTypeName string) ([]byte, error) {
 
 	req.Header.Add("Content-Type", contentType)
 	req.Header.Add("Accept", contentType)
-
-	if ac.AuthMethod == authMethodOAuth {
-		req.Header.Add("Authorization", "Bearer "+ac.Token)
-	}
+	req.Header.Add("Authorization", "Bearer "+ac.Token)
 
 	// Do request
 	resp, err := ac.APIClient.Do(req)
diff --git a/internal/provider/provider.go b/internal/provider/provider.go
@@ -41,15 +41,15 @@ type COPProviderModel struct {
 }
 
 func (p *COPProvider) Metadata(_ context.Context, _ provider.MetadataRequest, resp *provider.MetadataResponse) {
-	resp.TypeName = "cop"
+	resp.TypeName = "observability"
 	resp.Version = p.version
 }
 
 func (p *COPProvider) Schema(_ context.Context, _ provider.SchemaRequest, resp *provider.SchemaResponse) {
 	resp.Schema = schema.Schema{
 		Attributes: map[string]schema.Attribute{
 			"auth_method": schema.StringAttribute{
-				MarkdownDescription: "Authentication type selected for COP API requests. Possible values(oauth, headless, service-principal)",
+				MarkdownDescription: "Authentication type selected for observability API requests. Possible values(oauth, headless, service-principal)",
 				Required:            true,
 			},
 			"tenant": schema.StringAttribute{
@@ -92,47 +92,47 @@ func (p *COPProvider) Configure(ctx context.Context, req provider.ConfigureReque
 	if data.AuthMethod.IsUnknown() {
 		resp.Diagnostics.AddAttributeError(
 			path.Root("auth_method"),
-			"Unknown cop API auth_method",
+			"Unknown observability API auth_method",
 			"Please make sure you configure the auth_method field",
 		)
 	}
 
 	if data.Tenant.IsUnknown() {
 		resp.Diagnostics.AddAttributeError(
 			path.Root("tenant"),
-			"Unknown cop API tenant",
+			"Unknown observability API tenant",
 			"Please make sure you configure the tenant field",
 		)
 	}
 
 	if data.Username.IsUnknown() {
 		resp.Diagnostics.AddAttributeError(
 			path.Root("username"),
-			"Unknown cop API username",
+			"Unknown observability API username",
 			"Please make sure you configure the username field",
 		)
 	}
 
 	if data.Password.IsUnknown() {
 		resp.Diagnostics.AddAttributeError(
 			path.Root("password"),
-			"Unknown cop API password",
+			"Unknown observability API password",
 			"Please make sure you configure the password field",
 		)
 	}
 
 	if data.URL.IsUnknown() {
 		resp.Diagnostics.AddAttributeError(
 			path.Root("url"),
-			"Unknown cop API url",
+			"Unknown observability API url",
 			"Please make sure you configure the url field",
 		)
 	}
 
 	if data.URL.IsUnknown() {
 		resp.Diagnostics.AddAttributeError(
 			path.Root("secrets_file"),
-			"Unknown cop API secrets_file",
+			"Unknown observability API secrets_file",
 			"Please make sure you configure the secrets_file field",
 		)
 	}
@@ -186,7 +186,7 @@ func (p *COPProvider) Configure(ctx context.Context, req provider.ConfigureReque
 	if authMethod == "" {
 		resp.Diagnostics.AddAttributeError(
 			path.Root("auth_method"),
-			"Missing cop API auth_method",
+			"Missing observability API auth_method",
 			"SET the COP_AUTH_METHOD env var or the config",
 		)
 		tflog.Error(ctx, "Missing or empty value for auth_method attribute")
@@ -197,39 +197,39 @@ func (p *COPProvider) Configure(ctx context.Context, req provider.ConfigureReque
 		if url == "" {
 			resp.Diagnostics.AddAttributeError(
 				path.Root("url"),
-				"Missing cop API url",
+				"Missing observability API url",
 				"SET the COP_URL env var or the config",
 			)
 		}
 
 		if tenantID == "" {
 			resp.Diagnostics.AddAttributeError(
 				path.Root("tenant"),
-				"Missing cop API tenant",
+				"Missing observability API tenant",
 				"SET the COP_TENANT env var or the config",
 			)
 		}
 	case "headless":
 		if username == "" {
 			resp.Diagnostics.AddAttributeError(
 				path.Root("username"),
-				"Missing cop API username",
+				"Missing observability API username",
 				"SET the COP_USERNAME env var or the config",
 			)
 		}
 
 		if password == "" {
 			resp.Diagnostics.AddAttributeError(
 				path.Root("password"),
-				"Missing cop API password",
+				"Missing observability API password",
 				"SET the COP_PASSWORD env var or the config",
 			)
 		}
 	case "service-principal":
 		if secretsFile == "" {
 			resp.Diagnostics.AddAttributeError(
 				path.Root("secrets_file"),
-				"Missing cop API secrets_file",
+				"Missing observability API secrets_file",
 				"SET the SECRETS_FILE env var or the config",
 			)
 		}
@@ -253,10 +253,10 @@ func (p *COPProvider) Configure(ctx context.Context, req provider.ConfigureReque
 
 	err := appdClient.Login()
 	if err != nil {
-		tflog.Error(ctx, fmt.Sprintf("Failed to authenticate to COP client: %s", err.Error()))
+		tflog.Error(ctx, fmt.Sprintf("Failed to authenticate to observability client: %s", err.Error()))
 	}
 
-	tflog.Debug(ctx, fmt.Sprintf("Successful authentication to COP client using %s", appdClient.AuthMethod))
+	tflog.Debug(ctx, fmt.Sprintf("Successful authentication to observability client using %s", appdClient.AuthMethod))
 
 	// TODO change this to a real client
 	resp.DataSourceData = appdClient
diff --git a/main.go b/main.go
@@ -45,7 +45,7 @@ func main() {
 		// TODO: Update this string with the published name of your provider.
 		// Also update the tfplugindocs generate command to either remove the
 		// -provider-name flag or set its value to the updated provider name.
-		Address: "testTerraform.com/appd/cop",
+		Address: "testTerraform.com/appd/observability",
 		Debug:   debug,
 	}
 

Original file line number	Diff line number	Diff line change
`@@ -6,23 +6,24 @@`
`6`	`6`
`7`	`7`	`terraform {`
`8`	`8`	`required_providers {`
`9`		`- cop = {`
`10`		`- source = "testTerraform.com/appd/cop"`
	`9`	`+ observability = {`
	`10`	`+ source = "testTerraform.com/appd/observability"`
`11`	`11`	`}`
`12`	`12`	`}`
`13`	`13`	`}`
`14`	`14`
`15`		`-provider "cop" {`
`16`		`- tenant = "47a01df9-54a0-472b-96b8-7c8f64eb7cbf"`
`17`		`- auth_method = "oauth"`
`18`		`- url = "https://alameda-c0-test-02.saas.appd-test.com"`
	`15`	`+provider "observability" {`
	`16`	`+ tenant="0eb4e853-34fb-4f77-b3fc-b9cd3b462366"`
	`17`	`+ auth_method="service-principal"`
	`18`	`+ url="https://aiops-dev.saas.appd-test.com"`
	`19`	`+ secrets_file="/home/vdodin/aiops_secret.json"`
`19`	`20`	`}`
`20`	`21`
`21`	`22`
`22`		`-data "cop_type" "ns" {`
	`23`	`+data "observability_type" "ns" {`
`23`	`24`	`type_name = "fmm:namespace"`
`24`	`25`	`}`
`25`	`26`
`26`	`27`	`output "myType" {`
`27`		`- value = data.cop_type.ns`
	`28`	`+ value = data.observability_type.ns`
`28`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,13 +6,13 @@`
`6`	`6`
`7`	`7`	`terraform {`
`8`	`8`	`required_providers {`
`9`		`- cop = {`
`10`		`- source = "testTerraform.com/appd/cop"`
	`9`	`+ observability = {`
	`10`	`+ source = "testTerraform.com/appd/observability"`
`11`	`11`	`}`
`12`	`12`	`}`
`13`	`13`	`}`
`14`	`14`
`15`		`-provider "cop" {`
	`15`	`+provider "observability" {`
`16`	`16`	`tenant="47a01df9-54a0-472b-96b8-7c8f64eb7cbf"`
`17`	`17`	`auth_method="oauth"`
`18`	`18`	`url="https://alameda-c0-test-02.saas.appd-test.com"`
Original file line number	Diff line number	Diff line change
`@@ -6,19 +6,19 @@`
`6`	`6`
`7`	`7`	`terraform {`
`8`	`8`	`required_providers {`
`9`		`- cop = {`
`10`		`- source = "testTerraform.com/appd/cop"`
	`9`	`+ observability = {`
	`10`	`+ source = "testTerraform.com/appd/observability"`
`11`	`11`	`}`
`12`	`12`	`}`
`13`	`13`	`}`
`14`	`14`
`15`		`-provider "cop" {`
	`15`	`+provider "observability" {`
`16`	`16`	`tenant = "47a01df9-54a0-472b-96b8-7c8f64eb7cbf"`
`17`	`17`	`auth_method = "oauth"`
`18`	`18`	`url = "https://alameda-c0-test-02.saas.appd-test.com"`
`19`	`19`	`}`
`20`	`20`
`21`		`-resource "cop_object" "ns" {`
	`21`	`+resource "observability_object" "ns" {`
`22`	`22`	`type_name = "fmm:namespace"`
`23`	`23`	`object_id = "aws"`
`24`	`24`	`layer_type = "TENANT"`
Original file line number	Diff line number	Diff line change
`@@ -41,15 +41,15 @@ type COPProviderModel struct {`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`func (p COPProvider) Metadata(_ context.Context, _ provider.MetadataRequest, resp provider.MetadataResponse) {`
`44`		`- resp.TypeName = "cop"`
	`44`	`+ resp.TypeName = "observability"`
`45`	`45`	`resp.Version = p.version`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`func (p COPProvider) Schema(_ context.Context, _ provider.SchemaRequest, resp provider.SchemaResponse) {`
`49`	`49`	`resp.Schema = schema.Schema{`
`50`	`50`	`Attributes: map[string]schema.Attribute{`
`51`	`51`	`"auth_method": schema.StringAttribute{`
`52`		`- MarkdownDescription: "Authentication type selected for COP API requests. Possible values(oauth, headless, service-principal)",`
	`52`	`+ MarkdownDescription: "Authentication type selected for observability API requests. Possible values(oauth, headless, service-principal)",`
`53`	`53`	`Required: true,`
`54`	`54`	`},`
`55`	`55`	`"tenant": schema.StringAttribute{`
`@@ -92,47 +92,47 @@ func (p *COPProvider) Configure(ctx context.Context, req provider.ConfigureReque`
`92`	`92`	`if data.AuthMethod.IsUnknown() {`
`93`	`93`	`resp.Diagnostics.AddAttributeError(`
`94`	`94`	`path.Root("auth_method"),`
`95`		`- "Unknown cop API auth_method",`
	`95`	`+ "Unknown observability API auth_method",`
`96`	`96`	`"Please make sure you configure the auth_method field",`
`97`	`97`	`)`
`98`	`98`	`}`
`99`	`99`
`100`	`100`	`if data.Tenant.IsUnknown() {`
`101`	`101`	`resp.Diagnostics.AddAttributeError(`
`102`	`102`	`path.Root("tenant"),`
`103`		`- "Unknown cop API tenant",`
	`103`	`+ "Unknown observability API tenant",`
`104`	`104`	`"Please make sure you configure the tenant field",`
`105`	`105`	`)`
`106`	`106`	`}`
`107`	`107`
`108`	`108`	`if data.Username.IsUnknown() {`
`109`	`109`	`resp.Diagnostics.AddAttributeError(`
`110`	`110`	`path.Root("username"),`
`111`		`- "Unknown cop API username",`
	`111`	`+ "Unknown observability API username",`
`112`	`112`	`"Please make sure you configure the username field",`
`113`	`113`	`)`
`114`	`114`	`}`
`115`	`115`
`116`	`116`	`if data.Password.IsUnknown() {`
`117`	`117`	`resp.Diagnostics.AddAttributeError(`
`118`	`118`	`path.Root("password"),`
`119`		`- "Unknown cop API password",`
	`119`	`+ "Unknown observability API password",`
`120`	`120`	`"Please make sure you configure the password field",`
`121`	`121`	`)`
`122`	`122`	`}`
`123`	`123`
`124`	`124`	`if data.URL.IsUnknown() {`
`125`	`125`	`resp.Diagnostics.AddAttributeError(`
`126`	`126`	`path.Root("url"),`
`127`		`- "Unknown cop API url",`
	`127`	`+ "Unknown observability API url",`
`128`	`128`	`"Please make sure you configure the url field",`
`129`	`129`	`)`
`130`	`130`	`}`
`131`	`131`
`132`	`132`	`if data.URL.IsUnknown() {`
`133`	`133`	`resp.Diagnostics.AddAttributeError(`
`134`	`134`	`path.Root("secrets_file"),`
`135`		`- "Unknown cop API secrets_file",`
	`135`	`+ "Unknown observability API secrets_file",`
`136`	`136`	`"Please make sure you configure the secrets_file field",`
`137`	`137`	`)`
`138`	`138`	`}`
`@@ -186,7 +186,7 @@ func (p *COPProvider) Configure(ctx context.Context, req provider.ConfigureReque`
`186`	`186`	`if authMethod == "" {`
`187`	`187`	`resp.Diagnostics.AddAttributeError(`
`188`	`188`	`path.Root("auth_method"),`
`189`		`- "Missing cop API auth_method",`
	`189`	`+ "Missing observability API auth_method",`
`190`	`190`	`"SET the COP_AUTH_METHOD env var or the config",`
`191`	`191`	`)`
`192`	`192`	`tflog.Error(ctx, "Missing or empty value for auth_method attribute")`
`@@ -197,39 +197,39 @@ func (p *COPProvider) Configure(ctx context.Context, req provider.ConfigureReque`
`197`	`197`	`if url == "" {`
`198`	`198`	`resp.Diagnostics.AddAttributeError(`
`199`	`199`	`path.Root("url"),`
`200`		`- "Missing cop API url",`
	`200`	`+ "Missing observability API url",`
`201`	`201`	`"SET the COP_URL env var or the config",`
`202`	`202`	`)`
`203`	`203`	`}`
`204`	`204`
`205`	`205`	`if tenantID == "" {`
`206`	`206`	`resp.Diagnostics.AddAttributeError(`
`207`	`207`	`path.Root("tenant"),`
`208`		`- "Missing cop API tenant",`
	`208`	`+ "Missing observability API tenant",`
`209`	`209`	`"SET the COP_TENANT env var or the config",`
`210`	`210`	`)`
`211`	`211`	`}`
`212`	`212`	`case "headless":`
`213`	`213`	`if username == "" {`
`214`	`214`	`resp.Diagnostics.AddAttributeError(`
`215`	`215`	`path.Root("username"),`
`216`		`- "Missing cop API username",`
	`216`	`+ "Missing observability API username",`
`217`	`217`	`"SET the COP_USERNAME env var or the config",`
`218`	`218`	`)`
`219`	`219`	`}`
`220`	`220`
`221`	`221`	`if password == "" {`
`222`	`222`	`resp.Diagnostics.AddAttributeError(`
`223`	`223`	`path.Root("password"),`
`224`		`- "Missing cop API password",`
	`224`	`+ "Missing observability API password",`
`225`	`225`	`"SET the COP_PASSWORD env var or the config",`
`226`	`226`	`)`
`227`	`227`	`}`
`228`	`228`	`case "service-principal":`
`229`	`229`	`if secretsFile == "" {`
`230`	`230`	`resp.Diagnostics.AddAttributeError(`
`231`	`231`	`path.Root("secrets_file"),`
`232`		`- "Missing cop API secrets_file",`
	`232`	`+ "Missing observability API secrets_file",`
`233`	`233`	`"SET the SECRETS_FILE env var or the config",`
`234`	`234`	`)`
`235`	`235`	`}`
`@@ -253,10 +253,10 @@ func (p *COPProvider) Configure(ctx context.Context, req provider.ConfigureReque`
`253`	`253`
`254`	`254`	`err := appdClient.Login()`
`255`	`255`	`if err != nil {`
`256`		`- tflog.Error(ctx, fmt.Sprintf("Failed to authenticate to COP client: %s", err.Error()))`
	`256`	`+ tflog.Error(ctx, fmt.Sprintf("Failed to authenticate to observability client: %s", err.Error()))`
`257`	`257`	`}`
`258`	`258`
`259`		`- tflog.Debug(ctx, fmt.Sprintf("Successful authentication to COP client using %s", appdClient.AuthMethod))`
	`259`	`+ tflog.Debug(ctx, fmt.Sprintf("Successful authentication to observability client using %s", appdClient.AuthMethod))`
`260`	`260`
`261`	`261`	`// TODO change this to a real client`
`262`	`262`	`resp.DataSourceData = appdClient`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ func main() {`
`45`	`45`	`// TODO: Update this string with the published name of your provider.`
`46`	`46`	`// Also update the tfplugindocs generate command to either remove the`
`47`	`47`	`// -provider-name flag or set its value to the updated provider name.`
`48`		`- Address: "testTerraform.com/appd/cop",`
	`48`	`+ Address: "testTerraform.com/appd/observability",`
`49`	`49`	`Debug: debug,`
`50`	`50`	`}`
`51`	`51`