Adding data source for retrieving the tags based on a scope.

Added data source for retrieving the tags based on a scope.
    
Added acceptance tests for different cases of the data source usage.
    
Added documentation for the data source added to be updated in the hashicorp doc.

Author: aruntony005

nsxt/data_source_nsxt_policy_tags.go

@@ -0,0 +1,74 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
+package nsxt
+
+import (
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"github.com/vmware/vsphere-automation-sdk-go/runtime/protocol/client"
+	"github.com/vmware/vsphere-automation-sdk-go/services/nsxt/infra"
+	"github.com/vmware/vsphere-automation-sdk-go/services/nsxt/model"
+)
+
+func dataSourceNsxtTags() *schema.Resource {
+	return &schema.Resource{
+		Read: dataSourceNsxtTagsRead,
+		Schema: map[string]*schema.Schema{
+			"scope": getRequiredStringSchema("The scope of the tags to retrieve."),
+			"items": {
+				Type:        schema.TypeList,
+				Description: "List of tags based on the scope.",
+				Computed:    true,
+				Elem: &schema.Schema{
+					Type: schema.TypeString,
+				},
+			},
+		},
+	}
+}
+
+func dataSourceNsxtTagsRead(d *schema.ResourceData, m interface{}) error {
+	connector := getPolicyConnector(m)
+	scope := d.Get("scope").(string)
+	tagsList, err := listTags(connector, scope)
+	if err != nil {
+		return err
+	}
+
+	var tags []string
+	for _, tag := range tagsList {
+		tags = append(tags, *tag.Tag)
+	}
+	d.Set("items", tags)
+
+	d.SetId(newUUID())
+
+	return nil
+}
+
+func listTags(connector client.Connector, scope string) ([]model.TagInfo, error) {
+	client := infra.NewTagsClient(connector)
+	if client == nil {
+		return nil, policyResourceNotSupportedError()
+	}
+	var cursor *string
+	var tagsListResults []model.TagInfo
+	total := 0
+	for {
+		tagsList, err := client.List(cursor, nil, nil, nil, nil, &scope, nil, nil, nil, nil)
+		if err != nil {
+			return nil, err
+		}
+		tagsListResults = append(tagsListResults, tagsList.Results...)
+		if total == 0 && tagsList.ResultCount != nil {
+			total = int(*tagsList.ResultCount)
+		}
+
+		cursor = tagsList.Cursor
+		if len(tagsListResults) >= total {
+			return tagsListResults, nil
+		}
+	}
+
+}

nsxt/data_source_nsxt_policy_tags_test.go

@@ -0,0 +1,87 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
+package nsxt
+
+import (
+	"fmt"
+	"regexp"
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
+)
+
+func TestAccDataSourceNsxtPolicyTags_basic(t *testing.T) {
+	tagName := "testTag"
+	emptyScopeTag := "testEmptyScopeTag"
+	transportZone := getOverlayTransportZoneName()
+	re, _ := regexp.Compile(`.*EmptyScope.*`)
+	resource.Test(t, resource.TestCase{
+		PreCheck: func() {
+			testAccPreCheck(t)
+			testAccOnlyLocalManager(t)
+		},
+		Providers: testAccProviders,
+		Steps: []resource.TestStep{
+			{
+				Config: testAccNSXPolicyTagsReadTemplate(tagName, emptyScopeTag, transportZone),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckOutput("nsxt_tags", tagName),
+					resource.TestMatchOutput("empty_nsxt_tags", re),
+					resource.TestCheckOutput("wildcard_nsxt_tags", tagName),
+				),
+			},
+		},
+	})
+}
+
+func testAccNSXPolicyTagsReadTemplate(tagName string, emptyScopeTag string, transportZone string) string {
+	return fmt.Sprintf(`
+resource "nsxt_policy_segment" "segment1" {
+  display_name        = "segment1"
+  description         = "Terraform provisioned Segment"
+  transport_zone_path = data.nsxt_policy_transport_zone.overlay_transport_zone.path
+  tag {
+    scope = "scope-test"
+    tag   = "%s"
+  }
+  tag {
+    tag   = "%s"
+  }
+
+}
+
+data "nsxt_policy_transport_zone" "overlay_transport_zone" {
+  display_name = "%s"
+}
+
+data "nsxt_policy_tags" "tags" {
+  scope = "scope-test"
+  depends_on = [nsxt_policy_segment.segment1]
+}
+
+output "nsxt_tags" {
+  value = data.nsxt_policy_tags.tags.items[0]
+}
+
+data "nsxt_policy_tags" "emptytags" {
+  scope = ""
+  depends_on = [nsxt_policy_segment.segment1]
+}
+
+output "empty_nsxt_tags" {
+  value = join("--",data.nsxt_policy_tags.emptytags.items)
+}
+
+data "nsxt_policy_tags" "wildcardscope" {
+  scope = "*test"
+  depends_on = [nsxt_policy_segment.segment1]
+}
+
+output "wildcard_nsxt_tags" {
+  value = data.nsxt_policy_tags.wildcardscope.items[0]
+}
+
+`, tagName, emptyScopeTag, transportZone)
+}

nsxt/provider.go

@@ -291,6 +291,7 @@ func Provider() *schema.Provider {
 			"nsxt_policy_gateway_policy":                             dataSourceNsxtPolicyGatewayPolicy(),
 			"nsxt_policy_security_policy":                            dataSourceNsxtPolicySecurityPolicy(),
 			"nsxt_policy_group":                                      dataSourceNsxtPolicyGroup(),
+			"nsxt_policy_tags":                                       dataSourceNsxtTags(),
 			"nsxt_policy_context_profile":                            dataSourceNsxtPolicyContextProfile(),
 			"nsxt_policy_dhcp_server":                                dataSourceNsxtPolicyDhcpServer(),
 			"nsxt_policy_bfd_profile":                                dataSourceNsxtPolicyBfdProfile(),

website/docs/d/policy_tags.html.markdown

@@ -0,0 +1,31 @@
+---
+subcategory: "Beta"
+layout: "nsxt"
+page_title: "NSXT: policy_tags"
+description: Tags data source.
+---
+
+# nsxt_policy_tags
+
+This data source provides the list of tags with a particular scope.
+
+This data source is applicable to NSX Policy Manager.
+
+## Example Usage
+
+```hcl
+data "nsxt_policy_tags" "tags" {
+  scope = "dev"
+}
+```
+
+## Argument Reference
+
+* `scope` - (Required) The scope of the tags to retrieve. Supports starts with, ends with, equals, and contains filters.
+Use * as a suffix for "starts with" and a prefix for "ends with". For "contains," wrap the value with *. Use * alone to fetch all tags, irrespective scope.
+
+## Attributes Reference
+
+The following attributes are exported:
+
+* `items` - List of tags with the scope given in the argument.