Inckudes module readmes in output files (#5)

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

Author: Sean Sundberg

src/commands/iascable-build.ts

@@ -2,7 +2,7 @@ import {Container} from 'typescript-ioc';
 import {Arguments, Argv} from 'yargs';
 import {promises} from 'fs';
 import {default as jsYaml} from 'js-yaml';
-import {join} from 'path';
+import {join, dirname} from 'path';
 
 import {IascableInput} from './inputs/iascable.input';
 import {CommandLineInput} from './inputs/command-line.input';
@@ -11,7 +11,7 @@ import {
   BillOfMaterialModel,
   isBillOfMaterialModel,
   isTileConfig,
-  OutputFile,
+  OutputFile, OutputFileType,
   TerraformComponent,
   Tile
 } from '../models';
@@ -124,10 +124,13 @@ async function outputBillOfMaterial(rootPath: string, billOfMaterial: BillOfMate
 }
 
 async function outputTerraform(rootPath: string, terraformComponent: TerraformComponent) {
-  await promises.mkdir(rootPath, {recursive: true})
+  return Promise.all(terraformComponent.files.map(async (file: OutputFile) => {
+    const path = join(rootPath, file.name);
+    await promises.mkdir(dirname(path), {recursive: true})
+
+    const fileContents = await file.contents;
 
-  return Promise.all(terraformComponent.files.map((file: OutputFile) => {
-    return promises.writeFile(join(rootPath, file.name), file.contents);
+    return promises.writeFile(path, fileContents);
   }));
 }
 
@@ -138,7 +141,7 @@ async function outputTile(rootPath: string, tile: Tile | undefined) {
 
   await promises.mkdir(rootPath, {recursive: true})
 
-  return promises.writeFile(join(rootPath, tile.file.name), tile.file.contents);
+  return promises.writeFile(join(rootPath, tile.file.name), await tile.file.contents);
 }
 
 async function outputResult(rootPath: string, result: IascableResult): Promise<void> {

src/models/file.model.ts

@@ -1,5 +1,33 @@
+import * as superagent from 'superagent';
+
+export enum OutputFileType {
+  terraform = 'terraform',
+  tileConfig = 'tile-config',
+  documentation = 'documentation'
+}
 
 export interface OutputFile {
   name: string;
-  readonly contents: string;
+  type?: OutputFileType;
+  readonly contents: string | Promise<string>;
+}
+
+export class UrlFile implements OutputFile {
+  name: string;
+  url: string;
+  type?: OutputFileType;
+
+  constructor({name, url, type}: {name: string, url: string, type?: OutputFileType}) {
+    this.name = name;
+    this.url = url;
+    this.type = type;
+  }
+
+  get contents() {
+    return new Promise<string>(async (resolve) => {
+      const req: superagent.Response = await superagent.get(this.url);
+
+      resolve(req.text);
+    });
+  }
 }

src/models/module.model.ts

@@ -22,6 +22,7 @@ export interface ModuleTemplate {
   tags?: string[];
   ibmCatalogId?: string;
   fsReady?: string;
+  documentation?: string;
 }
 
 export interface Module extends ModuleTemplate {

src/models/stages.model.ts

@@ -3,9 +3,10 @@ import {
   fromBaseVariable,
   IBaseVariable,
   StagePrinter,
-  TerraformVariable, TerraformVariableImpl
+  TerraformVariable,
+  TerraformVariableImpl
 } from './variables.model';
-import {OutputFile} from './file.model';
+import {OutputFile, OutputFileType, UrlFile} from './file.model';
 import {SingleModuleVersion} from './module.model';
 
 export * from './module.model';
@@ -23,6 +24,7 @@ export interface Stage extends IStage, StagePrinter {
 export interface TerraformComponentModel {
   stages: { [source: string]: Stage };
   baseVariables: IBaseVariable[];
+  modules?: SingleModuleVersion[];
   files: OutputFile[];
 }
 
@@ -31,6 +33,7 @@ export class TerraformStageFile implements OutputFile {
   }
 
   name = 'stages.tf';
+  type = OutputFileType.terraform;
 
   get contents(): string {
     const buffer: Buffer = Object.values(this.stages).reduce((previousBuffer: Buffer, stage: Stage) => {
@@ -53,6 +56,7 @@ export class TerraformVariablesFile implements OutputFile {
   }
 
   name = 'variables.tf';
+  type = OutputFileType.terraform;
 
   get contents(): string {
     const buffer: Buffer = this.variables.reduce((previousBuffer: Buffer, variable: TerraformVariable) => {
@@ -73,6 +77,7 @@ export class TerraformVariablesFile implements OutputFile {
 export class TerraformComponent implements TerraformComponentModel {
   stages: { [source: string]: Stage } = {};
   baseVariables: TerraformVariable[] = [];
+  modules?: SingleModuleVersion[];
 
   constructor(model: TerraformComponentModel) {
     Object.assign(this, model);
@@ -83,13 +88,40 @@ export class TerraformComponent implements TerraformComponentModel {
   }
 
   get files(): OutputFile[] {
-    return [
+    const files: OutputFile[] = [
       new TerraformStageFile(this.stages),
       new TerraformVariablesFile(this.baseVariables),
+      ...buildModuleReadmes(this.modules),
     ];
+
+    return files;
   }
 }
 
+function buildModuleReadmes(modules: SingleModuleVersion[] = []): OutputFile[] {
+  return modules.map(module => {
+    const url = getModuleDocumentationUrl(module);
+
+    return new UrlFile({
+      name: `docs/${module.name}.md`,
+      type: OutputFileType.documentation,
+      url
+    });
+  });
+}
+
+function getModuleDocumentationUrl(module: SingleModuleVersion): string {
+  if (module.documentation) {
+    return module.documentation;
+  }
+
+  const regex = new RegExp('[^/]+/(.*)')
+  const gitSlug = module.id.replace(regex, '$1');
+  const branch = 'main';
+
+  return `https://raw.githubusercontent.com/${gitSlug}/${branch}/README.md`;
+}
+
 export class StageImpl implements Stage, StagePrinter {
   name: string;
   source: string;

src/models/tile.model.ts

@@ -1,4 +1,4 @@
-import {OutputFile} from './file.model';
+import {OutputFile, OutputFileType} from './file.model';
 import {omit} from '../util/object-util';
 
 export interface TileVariable {
@@ -83,6 +83,7 @@ export class Tile implements TileModel {
   get file(): OutputFile {
     return {
       name: `offering-${this.name}.json`,
+      type: OutputFileType.tileConfig,
       contents: JSON.stringify(omit(this, 'file')),
     }
   }

src/services/catalog-loader/catalog-loader.impl.ts

@@ -3,7 +3,7 @@ import {promises} from 'fs';
 import {default as superagent, Response} from 'superagent';
 import {JSON_SCHEMA, load} from 'js-yaml';
 
-import {Catalog, CatalogLoaderApi} from './catalog-loader.api';
+import {Catalog, CatalogLoaderApi, CatalogModel} from './catalog-loader.api';
 import {LoggerApi} from '../../util/logger';
 
 export class CatalogLoader implements CatalogLoaderApi {

src/services/terraform-builder/terraform-builder.impl.ts

@@ -1,30 +1,25 @@
+import {Inject} from 'typescript-ioc';
 import {TerraformBuilderApi} from './terraform-builder.api';
 import {
+  BaseVariable,
+  GlobalRefVariable,
+  IBaseVariable,
+  isPlaceholderVariable,
   ModuleDependency,
   ModuleOutputRef,
+  ModuleRefVariable,
   ModuleVariable,
   ModuleVersion,
-  SingleModuleVersion
-} from '../../models/module.model';
-import {
+  PlaceholderVariable,
+  SingleModuleVersion,
   Stage,
   StageImpl,
-  TerraformComponent,
-  TerraformComponentModel
-} from '../../models/stages.model';
-import {Inject} from 'typescript-ioc';
+  TerraformComponent
+} from '../../models';
 import {ModuleSelectorApi} from '../module-selector';
-import {
-  BaseVariable, GlobalRefVariable,
-  IBaseVariable, isPlaceholderVariable,
-  ModuleRefVariable,
-  PlaceholderVariable
-} from '../../models/variables.model';
-import {of as arrayOf} from '../../util/array-util';
-import {isUndefined, isUndefinedOrNull} from '../../util/object-util';
-import {CatalogModel} from '../../models/catalog.model';
-import {BillOfMaterialModel} from '../../models/bill-of-material.model';
 import {ModuleNotFound} from '../../errors';
+import {of as arrayOf} from '../../util/array-util';
+import {isUndefined} from '../../util/object-util';
 
 export class TerraformBuilder implements TerraformBuilderApi {
   constructor(@Inject private selector: ModuleSelectorApi) {
@@ -43,7 +38,7 @@ export class TerraformBuilder implements TerraformBuilderApi {
       stages[stageSources[i]] = await processStageVariables(stages[stageSources[i]], baseVariables);
     }
 
-    return new TerraformComponent({stages, baseVariables, files: []});
+    return new TerraformComponent({stages, baseVariables, modules: selectedModules, files: []});
   }
 }