Replace periods underscore kong2tf (#1756)

* Add kong2tf failing test

* Replace periods with underscores in resource names

* fix: expand slugify to all unsupported chars

---------

Co-authored-by: Harsha Dixit <harsha.dixit@konghq.com>

Author: mheap

kong2tf/generate_resource.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 	"sort"
 	"strings"
+	"unicode"
 )
 
 type importConfig struct {
@@ -113,7 +114,7 @@ resource "konnect_%s" "%s" {
 %s  control_plane_id = var.control_plane_id%s
 }
 `,
-		entityType, name,
+		entityType, slugify(name),
 		strings.TrimRight(output(entityType, entity, 1, true, "\n", customizations, oneOfFields), "\n"),
 		generateParents(parents),
 		generateLifecycle(lifecycle))
@@ -467,3 +468,28 @@ func contains(slice []string, item string) bool {
 	}
 	return false
 }
+
+// This is a helper function used to convert characters not supported by terraform into underscores
+func keepRuneUnicode(r rune) rune {
+	if unicode.IsLetter(r) || unicode.IsDigit(r) || r == '_' || r == '-' {
+		return r
+	}
+	return '_'
+}
+
+// slugify converts a string into a slug using underscores.
+// This replaces all characters that are not letters, numbers, dashes or underscores
+// based on https://developer.hashicorp.com/terraform/language/syntax/configuration#identifiers
+func slugify(input string) string {
+	slug := strings.Map(keepRuneUnicode, input)
+
+	// Remove any consecutive underscores
+	for strings.Contains(slug, "__") {
+		slug = strings.ReplaceAll(slug, "__", "_")
+	}
+
+	// Trim leading and trailing underscores
+	slug = strings.Trim(slug, "_")
+
+	return slug
+}

kong2tf/kong2tf_test.go

@@ -191,6 +191,12 @@ func Test_convertKongGatewayToTerraform(t *testing.T) {
 			outputFilename: "partial-output-expected.tf",
 			wantErr:        false,
 		},
+		{
+			name:           "handles-unsupported-chars",
+			inputFilename:  "handles-unsupported-chars-input.yaml",
+			outputFilename: "handles-unsupported-chars-expected.tf",
+			wantErr:        false,
+		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {

kong2tf/testdata/handles-unsupported-chars-expected.tf

@@ -0,0 +1,28 @@
+variable "control_plane_id" {
+  type    = string
+  default = "YOUR_CONTROL_PLANE_ID"
+}
+
+resource "konnect_gateway_consumer" "my_consumer123_my_org_prod_2_example" {
+  username = "my-consumer123@my-org.prod_2.example"
+  custom_id = "1234567890"
+  tags = ["internal"]
+
+  control_plane_id = var.control_plane_id
+}
+
+resource "konnect_gateway_consumer" "宮本武蔵_my_org_prod_example" {
+  username = "宮本武蔵@my-org.prod.example"
+  custom_id = "1234567891"
+  tags = ["internal"]
+
+  control_plane_id = var.control_plane_id
+}
+
+resource "konnect_gateway_consumer" "my_consumer_124_my_org_prod_example" {
+  username = "my-consumer©124@my-org.prod.example"
+  custom_id = "1234567892"
+  tags = ["internal"]
+
+  control_plane_id = var.control_plane_id
+}

kong2tf/testdata/handles-unsupported-chars-input.yaml

@@ -0,0 +1,14 @@
+consumers:
+  - username: my-consumer123@my-org.prod_2.example
+    custom_id: "1234567890"
+    tags:
+      - internal
+  - username: 宮本武蔵@my-org.prod.example # unicode letters
+    custom_id: "1234567891"
+    tags:
+      - internal
+  - username: my-consumer©124@my-org.prod.example #© is not a letter - it is a symbol
+    custom_id: "1234567892"
+    tags:
+      - internal
+