Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement map data sources for policy services and groups #1476

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 66 additions & 0 deletions nsxt/data_source_nsxt_policy_groups.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
/* Copyright © 2024 Broadcom, Inc. All Rights Reserved.
SPDX-License-Identifier: MPL-2.0 */

package nsxt

import (
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"

"github.com/vmware/terraform-provider-nsxt/api/infra/domains"
)

func dataSourceNsxtPolicyGroups() *schema.Resource {
return &schema.Resource{
Read: dataSourceNsxtPolicyGroupsRead,

Schema: map[string]*schema.Schema{
"context": getContextSchema(false, false, false),
"domain": getDomainNameSchema(),
"items": {
Type: schema.TypeList,
Description: "Mapping of service UUID by display name",
Computed: true,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"id": {
Type: schema.TypeString,
Optional: true,
},
"display_name": {
Type: schema.TypeString,
Optional: true,
},
"path": {
Type: schema.TypeString,
Optional: true,
},
},
},
},
},
}
}

func dataSourceNsxtPolicyGroupsRead(d *schema.ResourceData, m interface{}) error {
connector := getPolicyConnector(m)
domainName := d.Get("domain").(string)

client := domains.NewGroupsClient(getSessionContext(d, m), connector)

var groupsList []interface{}
results, err := client.List(domainName, nil, nil, nil, nil, nil, nil, nil)
if err != nil {
return err
}
for _, r := range results.Results {
groupMap := make(map[string]interface{})
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we want to error out for duplicate display_name?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep done

groupMap["id"] = r.Id
groupMap["display_name"] = r.DisplayName
groupMap["path"] = r.Path
groupsList = append(groupsList, groupMap)
}

d.SetId(newUUID())
d.Set("items", groupsList)
return nil
}
74 changes: 74 additions & 0 deletions nsxt/data_source_nsxt_policy_groups_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
/* Copyright © 2024 Broadcom, Inc. All Rights Reserved.
SPDX-License-Identifier: MPL-2.0 */

package nsxt

import (
"fmt"
"testing"

"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"
)

func TestAccDataSourceNsxtPolicyGroups_basic(t *testing.T) {
testAccDataSourceNsxtPolicyGroupsBasic(t, false, func() {
testAccPreCheck(t)
})
}

func TestAccDataSourceNsxtPolicyGroups_multitenancy(t *testing.T) {
testAccDataSourceNsxtPolicyGroupsBasic(t, true, func() {
testAccPreCheck(t)
testAccOnlyMultitenancy(t)
})
}

func testAccDataSourceNsxtPolicyGroupsBasic(t *testing.T, withContext bool, preCheck func()) {
domain := "default"
groupName := getAccTestDataSourceName()
testResourceName := "data.nsxt_policy_Groups.test"
checkResourceName := "data.nsxt_policy_group.test"

resource.ParallelTest(t, resource.TestCase{
PreCheck: preCheck,
Providers: testAccProviders,
CheckDestroy: func(state *terraform.State) error {
return testAccDataSourceNsxtPolicyGroupDeleteByName(domain, groupName)
},
Steps: []resource.TestStep{
{
PreConfig: func() {
if err := testAccDataSourceNsxtPolicyGroupCreate(domain, groupName); err != nil {
t.Error(err)
}
},
Config: testAccNSXPolicyGroupsReadTemplate(groupName, withContext),
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttrSet(testResourceName, "id"),
resource.TestCheckResourceAttr(checkResourceName, "display_name", groupName),
),
},
},
})
}

func testAccNSXPolicyGroupsReadTemplate(groupName string, withContext bool) string {
context := ""
if withContext {
context = testAccNsxtPolicyMultitenancyContext()
}
return fmt.Sprintf(`
data "nsxt_policy_groups" "test" {
%s
}

locals {
group_from_list = data.nsxt_policy_groups.test.items[index(data.nsxt_policy_groups.test.items.*.display_name, "%s")]
}

data "nsxt_policy_group" "test" {
id = local.group_from_list.id
}
`, context, groupName)
}
63 changes: 63 additions & 0 deletions nsxt/data_source_nsxt_policy_services.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
/* Copyright © 2024 Broadcom, Inc. All Rights Reserved.
SPDX-License-Identifier: MPL-2.0 */

package nsxt

import (
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"

"github.com/vmware/terraform-provider-nsxt/api/infra"
)

func dataSourceNsxtPolicyServices() *schema.Resource {
return &schema.Resource{
Read: dataSourceNsxtPolicyServicesRead,

Schema: map[string]*schema.Schema{
"context": getContextSchema(false, false, false),
"items": {
Type: schema.TypeList,
Description: "List of services",
Computed: true,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"id": {
Type: schema.TypeString,
Optional: true,
},
"display_name": {
Type: schema.TypeString,
Optional: true,
},
"path": {
Type: schema.TypeString,
Optional: true,
},
},
},
},
},
}
}

func dataSourceNsxtPolicyServicesRead(d *schema.ResourceData, m interface{}) error {
connector := getPolicyConnector(m)
client := infra.NewServicesClient(getSessionContext(d, m), connector)

var servicesList []interface{}
results, err := client.List(nil, nil, nil, nil, nil, nil, nil)
if err != nil {
return err
}
for _, r := range results.Results {
serviceMap := make(map[string]interface{})
serviceMap["id"] = r.Id
serviceMap["display_name"] = r.DisplayName
serviceMap["path"] = r.Path
servicesList = append(servicesList, serviceMap)
}

d.SetId(newUUID())
d.Set("items", servicesList)
return nil
}
65 changes: 65 additions & 0 deletions nsxt/data_source_nsxt_policy_services_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
/* Copyright © 2024 Broadcom, Inc. All Rights Reserved.
SPDX-License-Identifier: MPL-2.0 */

package nsxt

import (
"fmt"
"testing"

"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
)

func TestAccDataSourceNsxtPolicyServices_basic(t *testing.T) {
testAccDataSourceNsxtPolicyServicesBasic(t, false, func() {
testAccPreCheck(t)
})
}

func TestAccDataSourceNsxtPolicyServices_multitenancy(t *testing.T) {
testAccDataSourceNsxtPolicyServicesBasic(t, true, func() {
testAccPreCheck(t)
testAccOnlyMultitenancy(t)
})
}

func testAccDataSourceNsxtPolicyServicesBasic(t *testing.T, withContext bool, preCheck func()) {
serviceName := getAccTestDataSourceName()
testResourceName := "data.nsxt_policy_services.test"
checkResourceName := "data.nsxt_policy_service.test"

resource.ParallelTest(t, resource.TestCase{
PreCheck: preCheck,
Providers: testAccProviders,
Steps: []resource.TestStep{
{
Config: testAccNSXPolicyServicesReadTemplate(serviceName, withContext),
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttrSet(testResourceName, "id"),
resource.TestCheckResourceAttr(checkResourceName, "display_name", serviceName),
),
},
},
})
}

func testAccNSXPolicyServicesReadTemplate(serviceName string, withContext bool) string {
context := ""
if withContext {
context = testAccNsxtPolicyMultitenancyContext()
}
return testAccNsxtPolicyIcmpTypeServiceCreateTypeCodeTemplate(serviceName, "3", "1", "ICMPv4", withContext) + fmt.Sprintf(`
data "nsxt_policy_services" "test" {
depends_on = [nsxt_policy_service.test]
%s
}

locals {
service_from_list = data.nsxt_policy_services.test.items[index(data.nsxt_policy_services.test.service_from_list.*.display_name, "%s")]
}

data "nsxt_policy_service" "test" {
id = local.service_from_list.id
}
`, context, serviceName)
}
18 changes: 2 additions & 16 deletions nsxt/provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -340,6 +340,8 @@ func Provider() *schema.Provider {
"nsxt_vpc_ip_address_allocation": dataSourceNsxtVpcIpAddressAllocation(),
"nsxt_policy_gateway_connection": dataSourceNsxtPolicyGatewayConnection(),
"nsxt_policy_distributed_vlan_connection": dataSourceNsxtPolicyDistributedVlanConnection(),
"nsxt_policy_services": dataSourceNsxtPolicyServices(),
"nsxt_policy_groups": dataSourceNsxtPolicyGroups(),
},

ResourcesMap: map[string]*schema.Resource{
Expand Down Expand Up @@ -511,24 +513,8 @@ func Provider() *schema.Provider {
"nsxt_vpc_security_policy": resourceNsxtVPCSecurityPolicy(),
"nsxt_vpc_group": resourceNsxtVPCGroup(),
"nsxt_vpc_gateway_policy": resourceNsxtVPCGatewayPolicy(),
"nsxt_vpc_service_profile": resourceNsxtVpcServiceProfile(),
"nsxt_vpc_connectivity_profile": resourceNsxtVpcConnectivityProfile(),
"nsxt_policy_transit_gateway": resourceNsxtPolicyTransitGateway(),
"nsxt_policy_share": resourceNsxtPolicyShare(),
"nsxt_policy_shared_resource": resourceNsxtPolicySharedResource(),
"nsxt_policy_gateway_connection": resourceNsxtPolicyGatewayConnection(),
"nsxt_policy_distributed_vlan_connection": resourceNsxtPolicyDistributedVlanConnection(),
"nsxt_vpc": resourceNsxtVpc(),
"nsxt_vpc_attachment": resourceNsxtVpcAttachment(),
"nsxt_vpc_nat_rule": resourceNsxtPolicyVpcNatRule(),
"nsxt_policy_transit_gateway_attachment": resourceNsxtPolicyTransitGatewayAttachment(),
"nsxt_vpc_external_address": resourceNsxtVpcExternalAddress(),
"nsxt_vpc_ip_address_allocation": resourceNsxtVpcIpAddressAllocation(),
"nsxt_vpc_subnet": resourceNsxtVpcSubnet(),
"nsxt_policy_transit_gateway_nat_rule": resourceNsxtPolicyTransitGatewayNatRule(),
"nsxt_vpc_static_route": resourceNsxtVpcStaticRoutes(),
"nsxt_policy_project_ip_address_allocation": resourceNsxtPolicyProjectIpAddressAllocation(),
"nsxt_vpc_dhcp_v4_static_binding": resourceNsxtVpcSubnetDhcpV4StaticBindingConfig(),
},

ConfigureFunc: providerConfigure,
Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/ns_services.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: A networking and security services data source. This data source bu

# nsxt_ns_services

This data source builds a "name to uuid" map of the whole NS Services table. Such map can be referenced in configuration to obtain object uuids by display name at a cost of single roudtrip to NSX, which improves apply and refresh
This data source builds a "name to uuid" map of the whole NS Services table. Such map can be referenced in configuration to obtain object uuids by display name at a cost of single roundtrip to NSX, which improves apply and refresh
time at scale, compared to multiple instances of `nsxt_ns_service` data source.

## Example Usage
Expand Down
69 changes: 69 additions & 0 deletions website/docs/d/policy_groups.html.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
---
subcategory: "Firewall"
layout: "nsxt"
page_title: "NSXT: policy_groups"
description: A policy groups data source. This data source builds a list representation of the whole groups table, containing `id`, `display_name` and `path` attributes.
---

# nsxt_policy_groups

This data source builds a list of the whole policy Groups table. Such list can be referenced in configuration to obtain object identifier attributes lookup by display name at a cost of single roundtrip to NSX, which improves apply and refresh
time at scale, compared to multiple instances of `nsxt_policy_group` data source.

## Example Usage

```hcl
data "nsxt_policy_groups" "grouplist" {
}

resource "nsxt_policy_predefined_security_policy" "test" {
path = data.nsxt_policy_security_policy.default_l3.path

tag {
scope = "color"
tag = "orange"
}

rule {
display_name = "allow_icmp"
destination_groups = [
data.nsxt_policy_groups.test.items[index(data.nsxt_policy_groups.test.items.*.display_name, "Cats")].path,
data.nsxt_policy_groups.test.items[index(data.nsxt_policy_groups.test.items.*.display_name, "Dogs")].path
]
action = "ALLOW"
services = [nsxt_policy_service.icmp.path]
logged = true
}

rule {
display_name = "allow_udp"
source_groups = [data.nsxt_policy_groups.grouplist.items[index(data.nsxt_policy_groups.grouplist.items.*.display_name, "Fish")].path]
sources_excluded = true
scope = [data.nsxt_policy_groups.grouplist.items[index(data.nsxt_policy_groups.grouplist.items.*.display_name, "Aquarium")].path]
action = "ALLOW"
services = [nsxt_policy_service.udp.path]
logged = true
disabled = true
}

default_rule {
action = "DROP"
}

}
```

## Argument Reference

* `domain` - (Optional) The domain this Group belongs to. For VMware Cloud on AWS use `cgw`. For Global Manager, please use site id for this field. If not specified, this field is default to `default`.
* `context` - (Optional) The context which the object belongs to
* `project_id` - (Required) The ID of the project which the object belongs to

## Attributes Reference

In addition to arguments listed above, the following attributes are exported:

* `items` - List of policy group entries.
* `id` - The ID of the group.
* `display_name` - Display name of the group entry.
* `path` - The NSX path of the policy resource.
Loading
Loading