Adds support for optional dependencies (#13)

* Adds optional fields to module dependency models
* Checks for optional flag when getting source module
* Handles resolution of optional module dependencies
* Populates the output name from the BOM, if provided
* Adds script to launch terraform env to apply output
* Adds common services BOM

Signed-off-by: Sean Sundberg <[email protected]>

Author: Sean Sundberg

.gitignore

@@ -11,3 +11,4 @@ compiled
 .rpt2_cache
 docs
 output/
+credentials.properties

credentials.template

@@ -0,0 +1,11 @@
+# Add the values for the Credentials to access the IBM Cloud
+# Instructions to access this information can be found in the README.MD
+classic.username=""
+classic.api.key=""
+ibmcloud.api.key=""
+# Authentication to OCP can either be performed with username/password or token
+# If token is provided it will take precedence
+login.user=""
+login.password=""
+login.token=""
+server.url=""

examples/common-services.yaml

@@ -0,0 +1,14 @@
+apiVersion: cloud.ibm.com/v1alpha1
+kind: BillOfMaterial
+metadata:
+  name: common-services
+spec:
+  modules:
+    - github.com/cloud-native-toolkit/terraform-ibm-access-group
+    - github.com/cloud-native-toolkit/terraform-ibm-activity-tracker
+    - github.com/cloud-native-toolkit/terraform-ibm-object-storage
+    - github.com/cloud-native-toolkit/terraform-ibm-key-protect
+    - github.com/cloud-native-toolkit/terraform-ibm-logdna
+    - github.com/cloud-native-toolkit/terraform-ibm-vpc
+    - github.com/cloud-native-toolkit/terraform-ibm-sysdig
+  variables: []

launch.sh

@@ -0,0 +1,88 @@
+#!/bin/bash
+
+# IBM Cloud Garage, Catalyst Team
+
+SCRIPT_DIR="$(cd $(dirname $0); pwd -P)"
+SRC_DIR="$(cd "${SCRIPT_DIR}/output" ; pwd -P)"
+
+DOCKER_IMAGE="quay.io/ibmgaragecloud/cli-tools:v0.12.0-lite"
+
+helpFunction()
+{
+    RED='\033[0;31m'
+    CYAN='\033[0;36m'
+    LIGHT_GRAY='\033[0;37m'
+    GREEN='\033[0;32m'
+    NC='\033[0m' # No Color
+
+    error="$1"
+
+    echo "Iteration Zero Setup"
+    echo -e "This script will help setup setup a development environment and tools on the IBM Public Kubernetes Service"
+    echo ""
+    echo -e "${CYAN}Usage:${NC} $0"
+    echo ""
+    if [[ "${error}" =~ "file is not found" ]]; then
+        echo -e "${RED}${error}${NC}"
+        echo -e "Credentials should be provided in a file named ${CYAN}'${ENV}.properties'${NC}"
+    else
+        echo -e "${RED}${error}${NC}"
+        echo -e "The ${ENV}.properties file should contain the following values:"
+        echo -e "   ${GREEN}ibmcloud.api.key${NC} is the IBM Cloud api key"
+        echo -e "   ${GREEN}classic.username${NC} is the Classic Infrastructure user name or API user name (e.g. [email protected])"
+        echo -e "   ${GREEN}classic.api.key${NC} is the Classic Infrastructure api key"
+    fi
+
+   echo ""
+   exit 1 # Exit script after printing help
+}
+
+ENV="credentials"
+
+function prop {
+    grep "${1}" ${ENV}.properties | grep -vE "^#" | cut -d'=' -f2 | sed 's/"//g'
+}
+
+if [[ -f "${ENV}.properties" ]]; then
+    # Load the credentials
+    IBMCLOUD_API_KEY=$(prop 'ibmcloud.api.key')
+    CLASSIC_API_KEY=$(prop 'classic.api.key')
+    CLASSIC_USERNAME=$(prop 'classic.username')
+    LOGIN_USER=$(prop 'login.user')
+    LOGIN_PASSWORD=$(prop 'login.password')
+    LOGIN_TOKEN=$(prop 'login.token')
+    SERVER_URL=$(prop 'server.url')
+else
+    helpFunction "The ${ENV}.properties file is not found."
+fi
+
+SUFFIX=$(echo $(basename ${SCRIPT_DIR}) | base64 | sed -E "s/[^a-zA-Z0-9_.-]//g" | sed -E "s/.*(.{5})/\1/g")
+CONTAINER_NAME="ibm-garage-cli-tools-${SUFFIX}"
+
+echo "Cleaning up old container: ${CONTAINER_NAME}"
+
+DOCKER_CMD="docker"
+${DOCKER_CMD} kill ${CONTAINER_NAME} 1> /dev/null 2> /dev/null
+${DOCKER_CMD} rm ${CONTAINER_NAME} 1> /dev/null 2> /dev/null
+
+if [[ -n "$1" ]]; then
+    echo "Pulling container image: ${DOCKER_IMAGE}"
+    ${DOCKER_CMD} pull "${DOCKER_IMAGE}"
+fi
+
+echo "Initializing container ${CONTAINER_NAME} from ${DOCKER_IMAGE}"
+${DOCKER_CMD} run -itd --name ${CONTAINER_NAME} \
+   -v ${SRC_DIR}:/home/devops/src \
+   -e TF_VAR_ibmcloud_api_key="${IBMCLOUD_API_KEY}" \
+   -e TF_VAR_login_user="${LOGIN_USER}" \
+   -e TF_VAR_login_password="${LOGIN_PASSWORD}" \
+   -e TF_VAR_login_token="${LOGIN_TOKEN}" \
+   -e TF_VAR_server_url="${SERVER_URL}" \
+   -e IBMCLOUD_API_KEY="${IBMCLOUD_API_KEY}" \
+   -e IAAS_CLASSIC_USERNAME="${CLASSIC_USERNAME}" \
+   -e IAAS_CLASSIC_API_KEY="${CLASSIC_API_KEY}" \
+   -w /home/devops/src \
+   ${DOCKER_IMAGE}
+
+echo "Attaching to running container..."
+${DOCKER_CMD} attach ${CONTAINER_NAME}

src/commands/iascable-build.ts

@@ -47,7 +47,6 @@ export const builder = (yargs: Argv<any>) => {
     .option('name', {
       description: 'The name for the tile. Required if you want to generate the tile metadata.',
       demandOption: false,
-      default: 'component'
     })
     .option('tileDescription', {
       description: 'The description of the tile.',
@@ -67,18 +66,20 @@ export const builder = (yargs: Argv<any>) => {
 export const handler = async (argv: Arguments<IascableInput & CommandLineInput>) => {
   process.env.LOG_LEVEL = argv.debug ? 'debug' : 'info';
 
-  console.log('Name:', argv.name);
-
   const cmd: IascableApi = Container.get(IascableApi);
   const logger: LoggerApi = Container.get(LoggerApi).child('build');
 
   const bom: BillOfMaterialModel | undefined = await loadBillOfMaterial(argv.input, argv.name);
+
+  const name = bom?.metadata?.name || 'component';
+  console.log('Name:', name);
+
   const options: IascableOptions = buildCatalogBuilderOptions(argv);
 
   try {
     const result = await cmd.build(argv.catalogUrl, bom, options);
 
-    await outputResult(join('output', argv.name), result);
+    await outputResult(join('output', name), result);
   } catch (err) {
     logger.error('Error building config', {err})
   }

src/errors/module-not-found.error.ts

@@ -1,7 +1,7 @@
 
 export class ModuleNotFound extends Error {
-  constructor(readonly source: string) {
-    super(`Unable to find module: ${source}`);
+  constructor(readonly source: string, readonly module?: string) {
+    super(`Unable to find module (${module}): ${source}`);
   }
 }
 

src/models/bill-of-material.model.ts

@@ -78,7 +78,7 @@ export class BillOfMaterial implements BillOfMaterialModel {
         name: nameOrValue
       };
     } else {
-      const metadata = Object.assign({}, nameOrValue.metadata, name ? {name} : {name: nameOrValue.metadata?.name || 'default'});
+      const metadata = Object.assign({}, nameOrValue.metadata, name ? {name} : {name: nameOrValue.metadata?.name || 'component'});
 
       Object.assign(this, nameOrValue, {metadata});
     }

src/models/module.model.ts

@@ -48,6 +48,7 @@ export function isSingleModuleVersion(module: Module | SingleModuleVersion): mod
 export interface ModuleDependency {
   id: string;
   refs: ModuleRef[];
+  optional?: boolean;
 }
 
 export interface ModuleVersion {

src/models/variables.model.ts

@@ -171,9 +171,27 @@ export class TerraformVariableImpl implements TerraformVariable {
       return '';
     }
 
-    const value = (this.type === 'bool' || this.type === 'number') ? this.defaultValue : `"${this.defaultValue}"`;
+    const typeFormatter = getTypeFormatter(this.type);
+
+    const value = typeFormatter(this.defaultValue);
 
     return `
   default = ${value}`;
   }
 }
+
+const getTypeFormatter = (type: string) => {
+  const formatter = typeFormatters[type] || defaultFormatter;
+
+  return formatter;
+}
+
+const defaultFormatter: (value: string) => string = (value: string) => `"${value}"`;
+
+const typeFormatters: {[type: string]: (value: string) => string} = {
+  'bool': (value: string) => value,
+  'number': (value: string) => value,
+  // tslint:disable-next-line:triple-equals
+  'list(string)': (value: any) => value == '' ? '[]' : value,
+  'string': defaultFormatter,
+}

src/services/module-selector/selected-modules.model.ts

@@ -133,11 +133,15 @@ export class SelectedModules {
 
           this.resolveModuleDependencies(depModule);
         } catch (error) {
-          this.addMissingModule(moduleRef);
+          if (!dep.optional) {
+            this.addMissingModule(moduleRef);
+          }
         }
       }
 
       this.addModuleRef(moduleRef);
+    } else if (moduleRefs.length === 0 && dep.optional) {
+      // nothing to do
     } else if (moduleRefs.length === 0) {
       throw new Error(`Unable to find dependent module(s) (${moduleId}): ${dep.refs.map(r => r.source)}`);
     } else {