Run acceptance tests only when 'acceptance' go:build tag is present (#21)

Author: bogdanguranda

Makefile

@@ -50,7 +50,11 @@ lint-fix: $(GOLANGCI_LINT)
 
 .PHONY: test
 test:
-	TF_ACC=1 go test ./... -v $(TESTARGS) -timeout 120m
+	go test ./... -v -tags=unit $(TESTARGS) -timeout 120m
+
+.PHONY: acctest
+acctest:
+	TF_ACC=1 go test ./... -v -tags=acceptance $(TESTARGS) -timeout 120m
 
 .PHONY: plugin
 plugin:

docs/data-sources/type.md

@@ -10,7 +10,18 @@ description: |-
 
 Type data source
 
+Enables you to read any type of Cisco Observability Platform. Types are just schemas for the objects.
+Type name is the field required to get the type data source.
 
+## Example usage
+
+In this example we want to fetch a type called fmm:namespace.
+
+```terraform
+data "observability_type" "ns" {
+  type_name = "fmm:namespace"
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/index.md

@@ -6,11 +6,50 @@ description: |-
   
 ---
 
-# observability Provider
+# Observability Provider
 
+Terraform Observability provider enables users to provision objects as resources and read types as data sources
 
+## Authentication
 
+To start using the Observability Terraform Provider you need to authenticate with the Cisco Observability Platform. 
 
+You can do this by either using service-principal or oauth as an authentication method:
+
+
+```terraform
+terraform {
+  required_providers {
+    observability = {
+      source = "registry.terraform.io/cisco-open/observability"
+    }
+  }
+}
+
+provider "observability" {
+  tenant       = "<your cisco observability account>"
+  auth_method  = "service-principal"
+  url          = "https://<your environment/host>"
+  secrets_file = "<path to your secrets file>"
+}
+
+```
+
+```terraform
+terraform {
+  required_providers {
+    observability = {
+      source = "registry.terraform.io/cisco-open/observability"
+    }
+  }
+}
+
+provider "observability" {
+  tenant       = "<your cisco observability account>"
+  auth_method  = "oauth"
+  url          = "https://<your environment/host>"
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/resources/object.md

@@ -10,7 +10,26 @@ description: |-
 
 Object resource
 
-
+Enables you to create and manage any object of Cisco Observability Platform. Objects are actual populated values of a type. Data is a field which acts like a container for any object payload.
+
+## Example usage
+
+```terraform
+resource "observability_object" "conn" {
+  type_name  = "<your type>"
+  object_id  = "<object id of the object>"
+  layer_type = "TENANT"
+  layer_id   = "<your tenant>"
+  import_id  = "<object type>|<object id>|TENANT|<your tenant>"
+  data = jsonencode(
+    {
+      "field1" : "value1",
+      "field2" : "value2",
+      ...
+    }
+  )
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

internal/api/login_test.go

@@ -4,6 +4,8 @@
 //
 // SPDX-License-Identifier: MPL-2.0
 
+//go:build unit
+
 package api_test
 
 import (

internal/api/objectapi_test.go

@@ -4,6 +4,8 @@
 //
 // SPDX-License-Identifier: MPL-2.0
 
+//go:build unit
+
 package api_test
 
 import (

internal/api/pkce_test.go

@@ -4,6 +4,8 @@
 //
 // SPDX-License-Identifier: MPL-2.0
 
+//go:build unit
+
 package api_test
 
 import (

internal/api/typeapi_test.go

@@ -4,6 +4,8 @@
 //
 // SPDX-License-Identifier: MPL-2.0
 
+//go:build unit
+
 package api_test
 
 import (

internal/provider/type_data_source.go renamed to internal/provider/datasource_knowledge_type.go

@@ -16,30 +16,30 @@ import (
 )
 
 // Ensure provider defined types fully satisfy framework interfaces.
-var _ datasource.DataSource = &TypeDataSource{}
+var _ datasource.DataSource = &KnowledgeTypeDataSource{}
 
-func NewTypeDataSource() datasource.DataSource {
-	return &TypeDataSource{}
+func NewKnowledgeTypeDataSource() datasource.DataSource {
+	return &KnowledgeTypeDataSource{}
 }
 
-// TypeDataSource defines the data source implementation.
-type TypeDataSource struct {
+// KnowledgeTypeDataSource defines the data source implementation.
+type KnowledgeTypeDataSource struct {
 	client *api.AppdClient
 }
 
-// TypeDataSourceModel describes the data source data model.
-type TypeDataSourceModel struct {
+// KnowledgeTypeDataSourceModel describes the data source data model.
+type KnowledgeTypeDataSourceModel struct {
 	Typename types.String  `tfsdk:"type_name"`
 	Data     types.Dynamic `tfsdk:"data"`
 	ID       types.String  `tfsdk:"id"`
 }
 
-func (d *TypeDataSource) Metadata(_ context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) {
+func (d *KnowledgeTypeDataSource) Metadata(_ context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) {
 	resp.TypeName = req.ProviderTypeName + "_type"
 }
 
 // Schema defines the schema for the data source.
-func (d *TypeDataSource) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) {
+func (d *KnowledgeTypeDataSource) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) {
 	resp.Schema = schema.Schema{
 		// This description is used by the documentation generator and the language server.
 		MarkdownDescription: "Type data source",
@@ -61,7 +61,7 @@ func (d *TypeDataSource) Schema(_ context.Context, _ datasource.SchemaRequest, r
 	}
 }
 
-func (d *TypeDataSource) Configure(_ context.Context, req datasource.ConfigureRequest, resp *datasource.ConfigureResponse) {
+func (d *KnowledgeTypeDataSource) Configure(_ context.Context, req datasource.ConfigureRequest, resp *datasource.ConfigureResponse) {
 	// Prevent panic if the provider has not been configured.
 	if req.ProviderData == nil {
 		return
@@ -80,8 +80,8 @@ func (d *TypeDataSource) Configure(_ context.Context, req datasource.ConfigureRe
 }
 
 //nolint:gocritic // Terraform framework requires the method signature to be as is
-func (d *TypeDataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
-	var data TypeDataSourceModel
+func (d *KnowledgeTypeDataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
+	var data KnowledgeTypeDataSourceModel
 
 	// Read Terraform configuration data into the model
 	resp.Diagnostics.Append(req.Config.Get(ctx, &data)...)

internal/provider/type_data_source_test.go renamed to internal/provider/datasource_knowledge_type_acc_test.go

@@ -4,6 +4,8 @@
 //
 // SPDX-License-Identifier: MPL-2.0
 
+//go:build acceptance
+
 package provider
 
 import (
@@ -13,7 +15,7 @@ import (
 )
 
 //lint:ignore U1000 Ignore unused function temporarily for debugging
-func _TestAccTypeDataSource(t *testing.T) {
+func TestAccKnowledgeTypeDataSource(t *testing.T) {
 	resource.Test(t, resource.TestCase{
 		ProtoV6ProviderFactories: testAccProtoV6ProviderFactories,
 		Steps: []resource.TestStep{