commonids: add commonid for TenantId

resourcemanager/commonids/tenant.go

@@ -0,0 +1,105 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package commonids
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/hashicorp/go-azure-helpers/resourcemanager/resourceids"
+)
+
+var _ resourceids.ResourceId = &TenantId{}
+
+// TenantId is a struct representing the Resource ID for a Tenant
+type TenantId struct {
+	TenantId string
+}
+
+// NewTenantID returns a new TenantId struct
+func NewTenantID(tenantId string) TenantId {
+	return TenantId{
+		TenantId: tenantId,
+	}
+}
+
+// ParseTenantID parses 'input' into a TenantId
+func ParseTenantID(input string) (*TenantId, error) {
+	parser := resourceids.NewParserFromResourceIdType(&TenantId{})
+	parsed, err := parser.Parse(input, false)
+	if err != nil {
+		return nil, fmt.Errorf("parsing %q: %+v", input, err)
+	}
+
+	id := TenantId{}
+	if err := id.FromParseResult(*parsed); err != nil {
+		return nil, err
+	}
+
+	return &id, nil
+}
+
+// ParseTenantIDInsensitively parses 'input' case-insensitively into a TenantId
+// note: this method should only be used for API response data and not user input
+func ParseTenantIDInsensitively(input string) (*TenantId, error) {
+	parser := resourceids.NewParserFromResourceIdType(&TenantId{})
+	parsed, err := parser.Parse(input, true)
+	if err != nil {
+		return nil, fmt.Errorf("parsing %q: %+v", input, err)
+	}
+
+	id := TenantId{}
+	if err = id.FromParseResult(*parsed); err != nil {
+		return nil, err
+	}
+
+	return &id, nil
+}
+
+func (id *TenantId) FromParseResult(input resourceids.ParseResult) error {
+	var ok bool
+
+	if id.TenantId, ok = input.Parsed["tenantId"]; !ok {
+		return resourceids.NewSegmentNotSpecifiedError(id, "tenantId", input)
+	}
+
+	return nil
+}
+
+// ValidateTenantID checks that 'input' can be parsed as a Tenant ID
+func ValidateTenantID(input interface{}, key string) (warnings []string, errors []error) {
+	v, ok := input.(string)
+	if !ok {
+		errors = append(errors, fmt.Errorf("expected %q to be a string", key))
+		return
+	}
+
+	if _, err := ParseTenantID(v); err != nil {
+		errors = append(errors, err)
+	}
+
+	return
+}
+
+// ID returns the formatted Tenant ID
+func (id TenantId) ID() string {
+	fmtString := "/tenants/%s"
+	return fmt.Sprintf(fmtString, id.TenantId)
+}
+
+// Segments returns a slice of Resource ID Segments which comprise this Tenant ID
+func (id TenantId) Segments() []resourceids.Segment {
+	return []resourceids.Segment{
+		resourceids.StaticSegment("tenants", "tenants", "tenants"),
+		resourceids.UserSpecifiedSegment("tenantId", "12345678-1234-9876-4563-123456789012"),
+	}
+}
+
+// String returns a human-readable description of this Tenant ID
+func (id TenantId) String() string {
+	components := []string{
+		fmt.Sprintf("Tenant: %q", id.TenantId),
+	}
+	return fmt.Sprintf("Tenant (%s)", strings.Join(components, "\n"))
+}

resourcemanager/commonids/tenant_test.go

@@ -0,0 +1,162 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package commonids
+
+import (
+	"testing"
+
+	"github.com/hashicorp/go-azure-helpers/resourcemanager/resourceids"
+)
+
+var _ resourceids.ResourceId = &TenantId{}
+
+func TestNewTenantID(t *testing.T) {
+	id := NewTenantID("12345678-1234-9876-4563-123456789012")
+
+	if id.TenantId != "12345678-1234-9876-4563-123456789012" {
+		t.Fatalf("Expected %q but got %q for Segment 'TenantId'", id.TenantId, "12345678-1234-9876-4563-123456789012")
+	}
+}
+
+func TestFormatTenantID(t *testing.T) {
+	actual := NewTenantID("12345678-1234-9876-4563-123456789012").ID()
+	expected := "/tenants/12345678-1234-9876-4563-123456789012"
+	if actual != expected {
+		t.Fatalf("Expected the Formatted ID to be %q but got %q", expected, actual)
+	}
+}
+
+func TestParseTenantID(t *testing.T) {
+	testData := []struct {
+		Input    string
+		Error    bool
+		Expected *TenantId
+	}{
+		{
+			// Incomplete URI
+			Input: "",
+			Error: true,
+		},
+		{
+			// Incomplete URI
+			Input: "/tenants",
+			Error: true,
+		},
+		{
+			// Valid URI
+			Input: "/tenants/12345678-1234-9876-4563-123456789012",
+			Expected: &TenantId{
+				TenantId: "12345678-1234-9876-4563-123456789012",
+			},
+		},
+		{
+			// Invalid (Valid Uri with Extra segment)
+			Input: "/tenants/12345678-1234-9876-4563-123456789012/extra",
+			Error: true,
+		},
+	}
+	for _, v := range testData {
+		t.Logf("[DEBUG] Testing %q", v.Input)
+
+		actual, err := ParseTenantID(v.Input)
+		if err != nil {
+			if v.Error {
+				continue
+			}
+
+			t.Fatalf("Expect a value but got an error: %+v", err)
+		}
+		if v.Error {
+			t.Fatal("Expect an error but didn't get one")
+		}
+
+		if actual.TenantId != v.Expected.TenantId {
+			t.Fatalf("Expected %q but got %q for TenantId", v.Expected.TenantId, actual.TenantId)
+		}
+
+	}
+}
+
+func TestParseTenantIDInsensitively(t *testing.T) {
+	testData := []struct {
+		Input    string
+		Error    bool
+		Expected *TenantId
+	}{
+		{
+			// Incomplete URI
+			Input: "",
+			Error: true,
+		},
+		{
+			// Incomplete URI
+			Input: "/tenants",
+			Error: true,
+		},
+		{
+			// Incomplete URI (mIxEd CaSe since this is insensitive)
+			Input: "/TeNaNtS/",
+			Error: true,
+		},
+		{
+			// Valid URI
+			Input: "/tenants/12345678-1234-9876-4563-123456789012",
+			Expected: &TenantId{
+				TenantId: "12345678-1234-9876-4563-123456789012",
+			},
+		},
+		{
+			// Invalid (Valid Uri with Extra segment)
+			Input: "/tenants/12345678-1234-9876-4563-123456789012/extra",
+			Error: true,
+		},
+		{
+			// Valid URI (mIxEd CaSe since this is insensitive)
+			Input: "/TeNaNtS/12345678-1234-9876-4563-123456789012",
+			Expected: &TenantId{
+				TenantId: "12345678-1234-9876-4563-123456789012",
+			},
+		},
+		{
+			// Invalid (Valid Uri with Extra segment - mIxEd CaSe since this is insensitive)
+			Input: "/TeNaNtS/12345678-1234-9876-4563-123456789012/extra",
+			Error: true,
+		},
+	}
+	for _, v := range testData {
+		t.Logf("[DEBUG] Testing %q", v.Input)
+
+		actual, err := ParseTenantIDInsensitively(v.Input)
+		if err != nil {
+			if v.Error {
+				continue
+			}
+
+			t.Fatalf("Expect a value but got an error: %+v", err)
+		}
+		if v.Error {
+			t.Fatal("Expect an error but didn't get one")
+		}
+
+		if actual.TenantId != v.Expected.TenantId {
+			t.Fatalf("Expected %q but got %q for TenantId", v.Expected.TenantId, actual.TenantId)
+		}
+
+	}
+}
+
+func TestSegmentsForTenantId(t *testing.T) {
+	segments := TenantId{}.Segments()
+	if len(segments) == 0 {
+		t.Fatalf("TenantId has no segments")
+	}
+
+	uniqueNames := make(map[string]struct{}, 0)
+	for _, segment := range segments {
+		uniqueNames[segment.Name] = struct{}{}
+	}
+	if len(uniqueNames) != len(segments) {
+		t.Fatalf("Expected the Segments to be unique but got %q unique segments and %d total segments", len(uniqueNames), len(segments))
+	}
+}