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.

Sign up for GitHub

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

Adding support for Nested Services in Policy Service #836

Merged
merged 10 commits into from
Mar 1, 2023
+257 −0
Merged

Adding support for Nested Services in Policy Service #836

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
9cb33ee
Adding support for Nested Services
Feb 13, 2023
0af5578
Removing forgotten comment
Feb 13, 2023
1337ed2
Resolving comment #1
Feb 20, 2023
d7aff15
Resolving linter warning
Feb 20, 2023
808b08b
Resolving comment #2
Feb 20, 2023
f9fbaaf
Bugfix : wrong name is schema
Feb 20, 2023
ab07065
Adding tests
Feb 20, 2023
0af0086
Resolving comment #3
Feb 27, 2023
8258e62
Merge branch 'vmware:master' into master
Feb 27, 2023
ca1a03f
Fix web linter and comment #4
Mar 1, 2023
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
59 changes: 59 additions & 0 deletions nsxt/resource_nsxt_policy_service.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,19 @@ func resourceNsxtPolicyService() *schema.Resource {
},
},
},

"nested_service_entry": {
Type: schema.TypeSet,
Description: "Nested service service entry",
Optional: true,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"display_name": getOptionalDisplayNameSchema(false),
"description": getDescriptionSchema(),
"nested_service_path": getPolicyPathSchema(true, false, "Nested Service Path"),
},
},
},
},
}
}
Expand Down Expand Up @@ -377,6 +390,34 @@ func resourceNsxtPolicyServiceGetEntriesFromSchema(d *schema.ResourceData) ([]*d
serviceEntries = append(serviceEntries, entryStruct)
}

// Nested Service service entries
nestedEntries := d.Get("nested_service_entry").(*schema.Set).List()
for _, nestedEntry := range nestedEntries {
entryData := nestedEntry.(map[string]interface{})
displayName := entryData["display_name"].(string)
description := entryData["description"].(string)
nestedServicePath := entryData["nested_service_path"].(string)

// Use a different random Id each time
id := newUUID()

serviceEntry := model.NestedServiceServiceEntry{
Id: &id,
DisplayName: &displayName,
Description: &description,
NestedServicePath: &nestedServicePath,
ResourceType: model.ServiceEntry_RESOURCE_TYPE_NESTEDSERVICESERVICEENTRY,
}

dataValue, errs := converter.ConvertToVapi(serviceEntry, model.NestedServiceServiceEntryBindingType())
if errs != nil {
return serviceEntries, errs[0]
}
entryStruct := dataValue.(*data.StructValue)
serviceEntries = append(serviceEntries, entryStruct)

}

return serviceEntries, nil
}

Expand Down Expand Up @@ -500,6 +541,7 @@ func resourceNsxtPolicyServiceRead(d *schema.ResourceData, m interface{}) error
var etherEntriesList []map[string]interface{}
var ipProtEntriesList []map[string]interface{}
var algEntriesList []map[string]interface{}
var nestedServiceEntriesList []map[string]interface{}

for _, entry := range obj.ServiceEntries {
elem := make(map[string]interface{})
Expand Down Expand Up @@ -588,6 +630,18 @@ func resourceNsxtPolicyServiceRead(d *schema.ResourceData, m interface{}) error
elem["display_name"] = filterServiceEntryDisplayName(*serviceEntry.DisplayName, *serviceEntry.Id)
elem["description"] = serviceEntry.Description
igmpEntriesList = append(igmpEntriesList, elem)
} else if resourceType == model.ServiceEntry_RESOURCE_TYPE_NESTEDSERVICESERVICEENTRY {
nestedEntry, errs := converter.ConvertToGolang(entry, model.NestedServiceServiceEntryBindingType())
if errs != nil {
return errs[0]
}

serviceEntry := nestedEntry.(model.NestedServiceServiceEntry)
elem["display_name"] = filterServiceEntryDisplayName(*serviceEntry.DisplayName, *serviceEntry.Id)
elem["description"] = serviceEntry.Description
elem["nested_service_path"] = serviceEntry.NestedServicePath
nestedServiceEntriesList = append(nestedServiceEntriesList, elem)

} else {
return fmt.Errorf("Unrecognized Service Entry Type %s", resourceType)
}
Expand Down Expand Up @@ -623,6 +677,11 @@ func resourceNsxtPolicyServiceRead(d *schema.ResourceData, m interface{}) error
return err
}

err = d.Set("nested_service_entry", nestedServiceEntriesList)
if err != nil {
return err
}

return nil
}

Expand Down
193 changes: 193 additions & 0 deletions nsxt/resource_nsxt_policy_service_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ package nsxt

import (
"fmt"
"regexp"
"testing"

"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
Expand Down Expand Up @@ -575,6 +576,129 @@ func TestAccResourceNsxtPolicyService_algType(t *testing.T) {
})
}

func TestAccResourceNsxtPolicyService_nestedServiceType(t *testing.T) {
name := getAccTestResourceName()
updateName := getAccTestResourceName()
testResourceName := "nsxt_policy_service.test"
testNestedService1Name := "HTTP"
testNestedService2Name := "HTTPS"
regexpService1Name, err := regexp.Compile("/.*/" + testNestedService1Name)

if err != nil {
fmt.Printf("Error while compiling regexp: %v", err)
}

regexpService2Name, err := regexp.Compile("/.*/" + testNestedService2Name)

if err != nil {
fmt.Printf("Error while compiling regexp: %v", err)
}

resource.Test(t, resource.TestCase{
PreCheck: func() { testAccPreCheck(t) },
Providers: testAccProviders,
CheckDestroy: func(state *terraform.State) error {
return testAccNsxtPolicyServiceCheckDestroy(state, updateName)
},
Steps: []resource.TestStep{
{
// Step 0: Create a nested service
Config: testAccNsxtPolicyNestedServiceCreateTemplate(name, testNestedService1Name),
Check: resource.ComposeTestCheckFunc(
testAccNsxtPolicyServiceExists(testResourceName),
resource.TestCheckResourceAttr(testResourceName, "display_name", name),
resource.TestCheckResourceAttr(testResourceName, "description", "Nested service"),
resource.TestCheckResourceAttrSet(testResourceName, "path"),
resource.TestCheckResourceAttrSet(testResourceName, "revision"),
resource.TestCheckResourceAttr(testResourceName, "tag.#", "1"),
resource.TestCheckResourceAttr(testResourceName, "algorithm_entry.#", "0"),
resource.TestCheckResourceAttr(testResourceName, "l4_port_set_entry.#", "0"),
resource.TestCheckResourceAttr(testResourceName, "icmp_entry.#", "0"),
resource.TestCheckResourceAttr(testResourceName, "igmp_entry.#", "0"),
resource.TestCheckResourceAttr(testResourceName, "ether_type_entry.#", "0"),
resource.TestCheckResourceAttr(testResourceName, "ip_protocol_entry.#", "0"),
resource.TestCheckResourceAttr(testResourceName, "nested_service_entry.#", "1"),
resource.TestCheckResourceAttr(testResourceName, "nested_service_entry.0.display_name", testNestedService1Name),
resource.TestCheckResourceAttr(testResourceName, "nested_service_entry.0.description", "Entry-1"),
resource.TestMatchResourceAttr(testResourceName, "nested_service_entry.0.nested_service_path", regexpService1Name),
),
},
{
// Step 1: Add another nested service
Config: testAccNsxtPolicyNestedServiceUpdateTemplate(name, testNestedService1Name, testNestedService2Name),
Check: resource.ComposeTestCheckFunc(
testAccNsxtPolicyServiceExists(testResourceName),
resource.TestCheckResourceAttr(testResourceName, "display_name", name),
resource.TestCheckResourceAttr(testResourceName, "description", "Nested service"),
resource.TestCheckResourceAttrSet(testResourceName, "path"),
resource.TestCheckResourceAttrSet(testResourceName, "revision"),
resource.TestCheckResourceAttr(testResourceName, "tag.#", "1"),
resource.TestCheckResourceAttr(testResourceName, "algorithm_entry.#", "0"),
resource.TestCheckResourceAttr(testResourceName, "l4_port_set_entry.#", "0"),
resource.TestCheckResourceAttr(testResourceName, "icmp_entry.#", "0"),
resource.TestCheckResourceAttr(testResourceName, "igmp_entry.#", "0"),
resource.TestCheckResourceAttr(testResourceName, "ether_type_entry.#", "0"),
resource.TestCheckResourceAttr(testResourceName, "ip_protocol_entry.#", "0"),
resource.TestCheckResourceAttr(testResourceName, "nested_service_entry.#", "2"),
resource.TestCheckResourceAttr(testResourceName, "nested_service_entry.0.display_name", testNestedService1Name),
resource.TestCheckResourceAttr(testResourceName, "nested_service_entry.0.description", "Entry-1"),
resource.TestMatchResourceAttr(testResourceName, "nested_service_entry.0.nested_service_path", regexpService1Name),
resource.TestCheckResourceAttr(testResourceName, "nested_service_entry.1.display_name", testNestedService2Name),
resource.TestCheckResourceAttr(testResourceName, "nested_service_entry.1.description", "Entry-2"),
resource.TestMatchResourceAttr(testResourceName, "nested_service_entry.1.nested_service_path", regexpService2Name),
),
},
{
// Step 2: Remove nested service 2
Config: testAccNsxtPolicyNestedServiceCreateTemplate(name, testNestedService1Name),
Check: resource.ComposeTestCheckFunc(
testAccNsxtPolicyServiceExists(testResourceName),
resource.TestCheckResourceAttr(testResourceName, "display_name", name),
resource.TestCheckResourceAttr(testResourceName, "description", "Nested service"),
resource.TestCheckResourceAttrSet(testResourceName, "path"),
resource.TestCheckResourceAttrSet(testResourceName, "revision"),
resource.TestCheckResourceAttr(testResourceName, "tag.#", "1"),
resource.TestCheckResourceAttr(testResourceName, "algorithm_entry.#", "0"),
resource.TestCheckResourceAttr(testResourceName, "l4_port_set_entry.#", "0"),
resource.TestCheckResourceAttr(testResourceName, "icmp_entry.#", "0"),
resource.TestCheckResourceAttr(testResourceName, "igmp_entry.#", "0"),
resource.TestCheckResourceAttr(testResourceName, "ether_type_entry.#", "0"),
resource.TestCheckResourceAttr(testResourceName, "ip_protocol_entry.#", "0"),
resource.TestCheckResourceAttr(testResourceName, "nested_service_entry.#", "1"),
resource.TestCheckResourceAttr(testResourceName, "nested_service_entry.0.display_name", testNestedService1Name),
resource.TestCheckResourceAttr(testResourceName, "nested_service_entry.0.description", "Entry-1"),
resource.TestMatchResourceAttr(testResourceName, "nested_service_entry.0.nested_service_path", regexpService1Name),
),
},
{
// Step 3: Mix with other service types
Config: testAccNsxtPolicyNestedServiceMixedTemplate(name, testNestedService1Name),
Check: resource.ComposeTestCheckFunc(
testAccNsxtPolicyServiceExists(testResourceName),
resource.TestCheckResourceAttr(testResourceName, "display_name", name),
resource.TestCheckResourceAttr(testResourceName, "description", "Nested service"),
resource.TestCheckResourceAttrSet(testResourceName, "path"),
resource.TestCheckResourceAttrSet(testResourceName, "revision"),
resource.TestCheckResourceAttr(testResourceName, "tag.#", "1"),
resource.TestCheckResourceAttr(testResourceName, "algorithm_entry.#", "0"),
resource.TestCheckResourceAttr(testResourceName, "l4_port_set_entry.#", "1"),
resource.TestCheckResourceAttr(testResourceName, "l4_port_set_entry.0.display_name", "entry-2"),
resource.TestCheckResourceAttr(testResourceName, "l4_port_set_entry.0.description", "Entry-2"),
resource.TestCheckResourceAttr(testResourceName, "l4_port_set_entry.0.protocol", "TCP"),
resource.TestCheckResourceAttr(testResourceName, "icmp_entry.#", "0"),
resource.TestCheckResourceAttr(testResourceName, "igmp_entry.#", "0"),
resource.TestCheckResourceAttr(testResourceName, "ether_type_entry.#", "0"),
resource.TestCheckResourceAttr(testResourceName, "ip_protocol_entry.#", "0"),
resource.TestCheckResourceAttr(testResourceName, "nested_service_entry.#", "1"),
resource.TestCheckResourceAttr(testResourceName, "nested_service_entry.0.display_name", testNestedService1Name),
resource.TestCheckResourceAttr(testResourceName, "nested_service_entry.0.description", "Entry-1"),
resource.TestMatchResourceAttr(testResourceName, "nested_service_entry.0.nested_service_path", regexpService1Name),
),
},
},
})
}

func TestAccResourceNsxtPolicyService_importBasic(t *testing.T) {
name := getAccTestResourceName()
testResourceName := "nsxt_policy_service.test"
Expand Down Expand Up @@ -921,3 +1045,72 @@ resource "nsxt_policy_service" "test" {
}
}`, serviceName, serviceName, alg, sourcePorts, destPort)
}

func testAccNsxtPolicyNestedServiceCreateTemplate(serviceName string, nestedServiceEntryName string) string {
return fmt.Sprintf(`
resource "nsxt_policy_service" "test" {
description = "Nested service"
display_name = "%s"

nested_service_entry {
display_name = "%s"
description = "Entry-1"
nested_service_path = "%s"
}

tag {
scope = "scope1"
tag = "tag1"
}
}`, serviceName, nestedServiceEntryName, testAccAdjustPolicyInfraConfig("/infra/services/"+nestedServiceEntryName))
}

func testAccNsxtPolicyNestedServiceUpdateTemplate(serviceName string, nestedServiceEntry1Name string, nestedServiceEntry2Name string) string {
return fmt.Sprintf(`resource "nsxt_policy_service" "test" {
description = "Nested service"
display_name = "%s"

nested_service_entry {
display_name = "%s"
description = "Entry-1"
nested_service_path = "%s"
}

nested_service_entry {
display_name = "%s"
description = "Entry-2"
nested_service_path = "%s"
}

tag {
scope = "scope1"
tag = "tag1"
}
}`, serviceName, nestedServiceEntry1Name, testAccAdjustPolicyInfraConfig("/infra/services/"+nestedServiceEntry1Name), nestedServiceEntry2Name, testAccAdjustPolicyInfraConfig("/infra/services/"+nestedServiceEntry2Name))

}

func testAccNsxtPolicyNestedServiceMixedTemplate(serviceName string, nestedServiceEntryName string) string {
return fmt.Sprintf(`resource "nsxt_policy_service" "test" {
description = "Nested service"
display_name = "%s"

nested_service_entry {
display_name = "%s"
description = "Entry-1"
nested_service_path = "%s"
}

l4_port_set_entry {
display_name = "entry-2"
description = "Entry-2"
protocol = "TCP"
destination_ports = [ "443" ]
}

tag {
scope = "scope1"
tag = "tag1"
}
}`, serviceName, nestedServiceEntryName, testAccAdjustPolicyInfraConfig("/infra/services/"+nestedServiceEntryName))
}
5 changes: 5 additions & 0 deletions website/docs/r/policy_service.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,11 @@ The service must contain at least 1 entry (of at least one of the types), and po
* `destination_port` - (Required) a single destination port.
* `source_ports` - (Optional) Set of source ports/ranges.
* `algorithm` - (Required) Algorithm, one of `ORACLE_TNS`, `FTP`, `SUN_RPC_TCP`, `SUN_RPC_UDP`, `MS_RPC_TCP`, `MS_RPC_UDP`, `NBNS_BROADCAST`(Deprecated), `NBDG_BROADCAST`(Deprecated), `TFTP`.
* `nested_service_entry` - (Optional) Feature introduced since at least NSX-T 3.1, set of Nested service entries. Each with the following attributes:
* `display_name` - (Optional) Display name of the service entry.
* `description` - (Optional) Description of the service entry.
* `nested_service_path` - (Required) Path of the nested service.

AxFrancois marked this conversation as resolved.
Show resolved Hide resolved

## Attributes Reference

Expand Down