Adding terraform file generation

Author: khalidx

release/v2.0.0.md

@@ -45,6 +45,7 @@ rx test    # --load --chaos
 - [x] I should be able to browse and use an automatically generated Swagger UI for my API
 - [ ] I should be able to automatically generate an SDK for calling my API
 - [x] I should be able to automatically generate a Postman collection file
+- [x] I should be able to automatically generate a Terraform file for interpolating and implementing the API
 - [ ] I should be able to automatically generate a UML diagram of my resource relationships
 - [ ] I should be able to issue API keys for my API
 

src/library/cli/files.ts

@@ -50,6 +50,13 @@ export const swaggerFile = (directory: string, file: string): string => path.joi
  */
 export const postmanFile = (directory: string, file: string): string => path.join(rxSubdirectory(directory, file), 'postman.json')
 
+/**
+ * Returns the resolved path to the Terraform file 
+ * @param directory the absolute path of the directory to use
+ * @param file the path of the document file to use
+ */
+export const terraformFile = (directory: string, file: string): string => path.join(rxSubdirectory(directory, file), 'main.tf')
+
 /**
  * Returns the resolved path to the Swagger with mocks file
  * @param directory the absolute path of the directory to use
@@ -100,6 +107,14 @@ export const writeSwaggerFile = (directory: string, file: string, specification:
  */
 export const writePostmanFile = (directory: string, file: string, object: object): Promise<void> => fse.writeFile(postmanFile(directory, file), JSON.stringify(object, null, 2))
 
+/**
+ * Writes the Terraform file
+ * @param directory the absolute path of the directory to use
+ * @param file the path of the document file to use
+ * @param string the Terraform string
+ */
+export const writeTerraformFile = (directory: string, file: string, string: string): Promise<void> => fse.writeFile(terraformFile(directory, file), string)
+
 /**
  * Reads the Swagger with mocks file
  * @param directory the absolute path of the directory to use

src/library/cli/generate.ts

@@ -15,6 +15,7 @@ import * as rx from '../index'
  * Currently, it generates:
  *   - a Swagger API specification file
  *   - a Postman Collection file
+ *   - a Terraform file
  * @param directory the absolute path of the directory to use
  * @param file the path of the document file to use
  */
@@ -48,6 +49,13 @@ export const generate = async (directory: string, file: string): Promise<void> =
   await files.writePostmanFile(directory, file, collection)
   log('success', `Generated the ${basename(files.postmanFile(directory, file))} file successfully.`)
   log('info', `path: ${files.postmanFile(directory, file)}`)
+  // Check if the corresponding terraform file for the provided document file exists 
+  await proceed(await files.exists(files.terraformFile(directory, file)), basename(files.terraformFile(directory, file)))
+  let terraform = await rx.terraform(specification)
+  // Write the Terraform string to the file-specific directory
+  await files.writeTerraformFile(directory, file, terraform)
+  log('success', `Generated the ${basename(files.terraformFile(directory, file))} file successfully.`)
+  log('info', `path: ${files.terraformFile(directory, file)}`)
 }
 
 const proceed = async (exists: boolean, name: string): Promise<void> => {

src/library/index.ts

@@ -308,6 +308,60 @@ export const mocks = async (specification: OpenAPIV2.Document & { [key: string]:
   }
 }
 
+/**
+ * Generates a Terraform string based on the provided Swagger API specification
+ * @param specification the Swagger API specification object
+ */
+export const terraform = async (spec: OpenAPIV2.Document & { [key: string]: any }): Promise<string> => {
+  try {
+    // validate and dereference the specification, and generate mock integrations
+    const specification = await mocks(cloneDeep(spec))
+    // initialize the terraform string
+    let terraformString = ''
+    terraformString += `variable "title" {`                          + '\n'
+    terraformString += '  type = string'                             + '\n'
+    terraformString += `  description = "The title of the API"`      + '\n'
+    terraformString += `  default = "${specification.info.title}"`   + '\n'
+    terraformString += '}'                                           + '\n' + '\n'
+    terraformString += `variable "version" {`                        + '\n'
+    terraformString += '  type = string'                             + '\n'
+    terraformString += `  description = "The version of the API"`    + '\n'
+    terraformString += `  default = "${specification.info.version}"` + '\n'
+    terraformString += '}'                                           + '\n' + '\n'
+    // add terraform interpolation support to specification fields
+    specification.info.title = '${var.title}'
+    specification.info.version = '${var.version}'
+    // generate terraform variables for providing AWS API Gateway integrations for each operation
+    for (let pathKey of Object.keys(specification.paths)) {
+      for (let operationKey of Object.keys(specification.paths[pathKey])) {
+        const operationId = specification.paths[pathKey][operationKey].operationId
+        const integration = specification.paths[pathKey][operationKey]['x-amazon-apigateway-integration']
+        const description = `Provide the AWS API Gateway integration configuration for the ${operationId} operation`
+        terraformString += `variable "${operationId}" {`             + '\n'
+        terraformString += '  type = string'                         + '\n'
+        terraformString += `  description = "${description}"`        + '\n'
+        terraformString += '  default = <<EOF'                       + '\n'
+        terraformString += `${JSON.stringify(integration, null, 2)}` + '\n'
+        terraformString += 'EOF'                                     + '\n'
+        terraformString += '}'                                       + '\n' + '\n'
+        specification.paths[pathKey][operationKey]['x-amazon-apigateway-integration'] = '${var.' + operationId + '}'
+      }
+    }
+    terraformString += `output "swagger_specification" {`                                + '\n'
+    terraformString += `  description = "The interpolated Swagger Specification string"` + '\n'
+    terraformString += `  value = local.swagger_specification`                           + '\n'
+    terraformString += '}'                                                               + '\n' + '\n'
+    terraformString += 'locals {'                                                        + '\n'
+    terraformString += '  swagger_specification = <<EOF'                                 + '\n'
+    terraformString += `${JSON.stringify(specification, null, 2)}`                       + '\n'
+    terraformString += 'EOF'                                                             + '\n'
+    terraformString += '}'                                                               + '\n'
+    return terraformString
+  } catch (error) {
+    throw new Error(`Error while generating the terraform for the swagger specification: ${error.message}`)
+  }
+}
+
 export interface Deploy {
   id: string
   url: string