fix(terraform): misc cleanup [khcp-12445] (#1569)

Misc fixes for terraform, part of [KHCP-12445](https://konghq.atlassian.net/browse/KHCP-12445).

Fixes:
- `tags = []` not appearing on it's own line
- correctly handle terraform on consumer credential form
- add `other` type for unsupported terraform entities (Vault secrets) - terraform tab should NOT be displayed
- fix handling for key -> key_set relationship (use `set` instead)

Author: kaiarrowood

packages/entities/entities-plugins/src/components/PluginForm.vue

@@ -126,6 +126,7 @@
         </template>
         <template #terraform>
           <TerraformCodeBlock
+            :credential-type="credentialType"
             :entity-record="getRequestBody"
             :entity-type="SupportedEntityType.Plugin"
           />
@@ -1240,6 +1241,7 @@ watch(actionsDivRef, (newVal) => {
   }
 })
 
+const credentialType = ref('')
 const schemaLoading = ref(false)
 const fetchSchemaError = ref('')
 onBeforeMount(async () => {
@@ -1251,6 +1253,7 @@ onBeforeMount(async () => {
       // credential schema endpoints don't exist for Konnect, so we use hard-coded schemas
       const pluginType = CREDENTIAL_METADATA[props.pluginType]?.schemaEndpoint
       const data = CREDENTIAL_SCHEMAS[pluginType]
+      credentialType.value = pluginType
 
       schema.value = buildFormSchema('', data, {})
       schemaLoading.value = false

packages/entities/entities-shared/src/components/common/TerraformCodeBlock.vue

@@ -27,16 +27,20 @@ const props = defineProps({
     required: true,
     validator: (val: SupportedEntityType) => SupportedEntityTypesArray.includes(val),
   },
+  credentialType: {
+    type: String,
+    default: '',
+  },
 })
 
 const buildBasicValString = (value: string | number | boolean, key: string): string => {
   const indent = SINGLE_INDENT
   let content = ''
 
   if (typeof value === 'string') {
-    content += `\n${indent}${key} = "${value}"`
+    content += `${indent}${key} = "${value}"\n`
   } else { // boolean or number
-    content += `\n${indent}${key} = ${String(value !== undefined && value !== null ? value : '')}`
+    content += `${indent}${key} = ${String(value !== undefined && value !== null ? value : '')}\n`
   }
 
   return content
@@ -52,7 +56,7 @@ const buildObjectStr = (value: Record<string, any>, key?: string, additionalInde
   let content = ''
 
   if (key) {
-    content += `\n${indent}${key} = {\n`
+    content += `${indent}${key} = {\n`
   }
 
   if (value === null) {
@@ -94,7 +98,7 @@ const buildObjectStr = (value: Record<string, any>, key?: string, additionalInde
     content += `${indent}${SINGLE_INDENT}${k} = ${valueContent}\n`
   }
 
-  return key ? content += `${indent}}` : content
+  return key ? content += `${indent}}\n` : content
 }
 
 const buildArrayStr = (arr: any[], key?: string, additionalIndent = ''): string => {
@@ -108,7 +112,7 @@ const buildArrayStr = (arr: any[], key?: string, additionalIndent = ''): string
     if (arr.length === 0) {
       content += `${indent}${key} = [`
     } else {
-      content += `\n${indent}${key} = [\n`
+      content += `${indent}${key} = [\n`
     }
   }
 
@@ -135,9 +139,9 @@ const buildArrayStr = (arr: any[], key?: string, additionalIndent = ''): string
 
   if (key) {
     if (arr.length === 0) {
-      content += ']'
+      content += ']\n'
     } else {
-      content += `${indent}]`
+      content += `${indent}]\n`
     }
   }
 
@@ -201,33 +205,33 @@ const terraformContent = computed((): string => {
     // snis can be a child of certificate
     parentEntityType = 'certificate'
     delete modifiedRecord.certificate
-  } else if (modifiedRecord.key_set?.id) {
+  } else if (modifiedRecord.set?.id) {
     // keys can be a child of key_set
-    parentEntityType = 'key_set'
-    delete modifiedRecord.key_set
+    parentEntityType = 'set'
+    delete modifiedRecord.set
   }
 
   // special handling for plugins
   if (props.entityType === 'plugin') {
     // plugin type is specified separately
     //clone and convert '-' to '_' since terraform doesn't allow '-'
-    const pluginType = (modifiedRecord.name + '').replace(/-/g, '_')
+    const pluginType = props.credentialType.replace(/-/g, '_') || (modifiedRecord.name + '').replace(/-/g, '_')
     delete modifiedRecord.name
 
-    content += `resource "konnect_gateway_plugin_${pluginType}" "my_${pluginType}" {`
+    content += `resource "konnect_gateway_plugin_${pluginType}" "my_${pluginType}" {\n`
   } else { // generic entity
-    content += `resource "konnect_gateway_${props.entityType}" "my_${props.entityType}" {`
+    content += `resource "konnect_gateway_${props.entityType}" "my_${props.entityType}" {\n`
   }
 
   // main config
   content += generateConfig(modifiedRecord)
 
   // control plane id
-  content += `\n${SINGLE_INDENT}control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id\n`
+  content += `${SINGLE_INDENT}control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id\n`
 
   // parent entity information if scoped
   if (parentEntityType) {
-    content += `\n${SINGLE_INDENT}${parentEntityType} = {\n`
+    content += `${SINGLE_INDENT}${parentEntityType} = {\n`
     content += `${SINGLE_INDENT}${SINGLE_INDENT}id = konnect_gateway_${parentEntityType}.my_${parentEntityType}.id\n`
     content += `${SINGLE_INDENT}}\n`
   }

packages/entities/entities-shared/src/components/entity-base-form/EntityBaseForm.vue

@@ -115,8 +115,8 @@ import type { PropType } from 'vue'
 import { computed, ref, onBeforeMount, watch } from 'vue'
 import { useRouter } from 'vue-router'
 import type { AxiosError } from 'axios'
-import type { KonnectBaseFormConfig, KongManagerBaseFormConfig, SupportedEntityType } from '../../types'
-import { SupportedEntityTypesArray } from '../../types'
+import type { KonnectBaseFormConfig, KongManagerBaseFormConfig } from '../../types'
+import { SupportedEntityTypesArray, SupportedEntityType } from '../../types'
 import composables from '../../composables'
 import type { Tab } from '@kong/kongponents'
 import JsonCodeBlock from '../common/JsonCodeBlock.vue'
@@ -291,7 +291,7 @@ const tabs = ref<Tab[]>([
   },
 ])
 
-if (props.enableTerraform) {
+if (props.enableTerraform && props.entityType !== SupportedEntityType.Other) {
   // insert terraform as the third option
   tabs.value.splice(1, 0, {
     title: t('baseForm.configuration.terraform'),

packages/entities/entities-shared/src/types/entity-base-config-card.ts

@@ -1,19 +1,28 @@
 import type { KonnectConfig, KongManagerConfig } from './index'
 
+/**
+ * These entity strings are used for generating terraform scripts.
+ * Only add entity types that are supported by terraform. Use '_' instead of '-'.
+ * DO NOT MODIFY THE VALUES OF THESE STRINGS.
+ */
 export enum SupportedEntityType {
   CaCertificate = 'ca_certificate',
   Certificate = 'certificate',
   Consumer = 'consumer',
   ConsumerGroup = 'consumer_group',
   GatewayService = 'service',
   Key = 'key',
-  KeySet = 'key_set',
+  KeySet = 'set',
   Plugin = 'plugin',
   Route = 'route',
   SNI = 'sni',
   Upstream = 'upstream',
   Target = 'target',
   Vault = 'vault',
+  // Use this for any entity type that is not supported by terraform
+  // If entityType is 'other' terraform scripts will not be available
+  // Note: This is currently only supported by EntityBaseForm not EntityBaseConfigCard!!
+  Other = 'other',
 }
 
 export const SupportedEntityTypesArray = Object.values(SupportedEntityType)

packages/entities/entities-vaults/src/components/SecretForm.vue

@@ -5,7 +5,7 @@
       :config="config"
       :edit-id="secretId"
       :enable-terraform="enableTerraform"
-      :entity-type="SupportedEntityType.Vault"
+      :entity-type="SupportedEntityType.Other"
       :error-message="state.errorMessage"
       :fetch-url="fetchUrl"
       :form-fields="payload"