Merge pull request #1218 from vmware/policy-path-parser

Add utility to parse standard policy path

nsxt/policy_utils.go

@@ -67,6 +67,29 @@ func getOrGenerateID(d *schema.ResourceData, m interface{}, presenceChecker func
 	return id, nil
 }
 
+//lint:ignore U1000 Ignore unused function temporarily until used in autogenerated resource
+func getOrGenerateIDWithParent(d *schema.ResourceData, m interface{}, presenceChecker func(utl.SessionContext, string, string, client.Connector) (bool, error)) (string, error) {
+	connector := getPolicyConnector(m)
+
+	id := d.Get("nsx_id").(string)
+	if id == "" {
+		return newUUID(), nil
+	}
+
+	parentPath := d.Get("parent_path").(string)
+
+	exists, err := presenceChecker(getSessionContext(d, m), parentPath, id, connector)
+	if err != nil {
+		return "", err
+	}
+
+	if exists {
+		return "", fmt.Errorf("Resource with id %s already exists", id)
+	}
+
+	return id, nil
+}
+
 func newUUID() string {
 	uuid, _ := uuid.NewRandom()
 	return uuid.String()
@@ -252,6 +275,67 @@ func getResourceIDFromResourcePath(rPath string, rType string) string {
 	return ""
 }
 
+func parseStandardPolicyPath(path string) ([]string, error) {
+	var parents []string
+	segments := strings.Split(path, "/")
+	if len(segments) < 3 {
+		return nil, fmt.Errorf("invalid policy path %s", path)
+	}
+	if segments[0] != "" {
+		return nil, fmt.Errorf("policy path is expected to start with /")
+	}
+	// starting with *infra index
+	idx := 1
+	infraPath := true
+	if segments[1] == "orgs" {
+		if len(segments) < 5 {
+			return nil, fmt.Errorf("invalid multitenant policy path %s", path)
+		}
+
+		// append org and project
+		parents = append(parents, segments[2])
+		parents = append(parents, segments[4])
+		idx = 5
+
+		if len(segments) > 6 && segments[5] == "vpcs" {
+			parents = append(parents, segments[6])
+			idx = 7
+			// vpc paths do not contain infra
+			infraPath = false
+		}
+	}
+	if len(segments) <= idx {
+		return nil, fmt.Errorf("unexpected policy path %s", path)
+	}
+	if infraPath {
+		// continue after infra marker
+		if segments[idx] != "infra" && segments[idx] != "global-infra" {
+			return nil, fmt.Errorf("policy path %s is expected to contain *infra marker", path)
+		}
+		idx++
+	}
+
+	for i, seg := range segments[idx:] {
+		// in standard policy path, odd segments are object ids
+		if i%2 == 1 {
+			parents = append(parents, seg)
+		}
+	}
+	return parents, nil
+}
+
+func parseStandardPolicyPathVerifySize(path string, expectedSize int) ([]string, error) {
+	parents, err := parseStandardPolicyPath(path)
+	if err != nil {
+		return parents, err
+	}
+	if len(parents) != expectedSize {
+		return parents, fmt.Errorf("Unexpected parent path %s (expected %d parent ids, got %d)", path, expectedSize, len(parents))
+	}
+
+	return parents, nil
+}
+
 func nsxtDomainResourceImporter(d *schema.ResourceData, m interface{}) ([]*schema.ResourceData, error) {
 	importDomain := defaultDomain
 	importID := d.Id()

nsxt/policy_utils_test.go

@@ -0,0 +1,101 @@
+/* Copyright © 2024 Broadcom, Inc. All Rights Reserved.
+   SPDX-License-Identifier: MPL-2.0 */
+
+package nsxt
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+type policyPathTest struct {
+	path    string
+	parents []string
+}
+
+func TestParseStandardPolicyPath(t *testing.T) {
+
+	testData := []policyPathTest{
+		{
+			path:    "/infra/tier-1s/mygw1",
+			parents: []string{"mygw1"},
+		},
+		{
+			path:    "/global-infra/tier-0s/mygw1",
+			parents: []string{"mygw1"},
+		},
+		{
+			path:    "/orgs/myorg/projects/myproj/infra/tier-1s/mygw1",
+			parents: []string{"myorg", "myproj", "mygw1"},
+		},
+		{
+			path:    "/orgs/myorg/projects/myproj/vpcs/myvpc/tier-1s/mygw1",
+			parents: []string{"myorg", "myproj", "myvpc", "mygw1"},
+		},
+		{
+			path:    "/orgs/myorg/projects/myproj/infra/domains/d1/groups/g1",
+			parents: []string{"myorg", "myproj", "d1", "g1"},
+		},
+		{
+			path:    "/global-infra/tier-1s/t15/ipsec-vpn-services/default/sessions/xxx-yyy-xxx",
+			parents: []string{"t15", "default", "xxx-yyy-xxx"},
+		},
+		{
+			path:    "/infra/evpn-tenant-configs/{config-id}",
+			parents: []string{"{config-id}"},
+		},
+		{
+			path:    "/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/service-interfaces/{interface-id}",
+			parents: []string{"{tier-0-id}", "{locale-service-id}", "{interface-id}"},
+		},
+	}
+
+	for _, test := range testData {
+		parents, err := parseStandardPolicyPath(test.path)
+		assert.Nil(t, err)
+		assert.Equal(t, test.parents, parents)
+	}
+}
+
+func TestIsPolicyPath(t *testing.T) {
+
+	testData := []string{
+		"/infra/tier-1s/mygw1",
+		"/global-infra/tier-1s/mygw1",
+		"/orgs/infra/tier-1s/mygw1",
+		"/orgs/myorg/projects/myproj/domains/d",
+	}
+
+	for _, test := range testData {
+		pp := isPolicyPath(test)
+		assert.True(t, pp)
+	}
+}
+
+func TestNegativeParseStandardPolicyPath(t *testing.T) {
+
+	testData := []string{
+		"/some-infra/tier-1s/mygw1",
+		"orgs/infra/tier-1s/mygw1-1",
+		"orgs/infra  /tier-1s/mygw1-1",
+	}
+
+	for _, test := range testData {
+		_, err := parseStandardPolicyPath(test)
+		assert.NotNil(t, err)
+	}
+}
+
+func TestParseStandardPolicyPathVerifySize(t *testing.T) {
+
+	_, err := parseStandardPolicyPathVerifySize("/infra/things/thing1/sub-things/sub-thing1", 3)
+	assert.NotNil(t, err)
+
+	parents, err := parseStandardPolicyPathVerifySize("/infra/things/thing1/sub-things/sub-thing1", 2)
+	assert.Nil(t, err)
+	assert.Equal(t, 2, len(parents))
+
+	_, err = parseStandardPolicyPathVerifySize("/global-infra/things/1/sub-things/2/fine-tuned-thing/3", 1)
+	assert.NotNil(t, err)
+}