@ossy/deployment-tools 0.0.46 → 0.0.48

package/cdk.json

@@ -1,5 +1,5 @@
 {
-  "app": "node src/infrastructure/cli.js",
+  "app": "node ./src/infrastructure/cli.js",
   "watch": {
     "include": [
       "**"

package/jsdoc.config.js

@@ -0,0 +1,19 @@
+
+module.exports = {
+  plugins: ['plugins/markdown'],
+  recurseDepth: 10,
+  source: {
+    // includePattern: '.+\\.js(doc|x)?$',
+    includePattern: '.+\\.js$',
+    excludePattern: '(^|\\/|\\\\)_'
+  },
+  sourceType: 'module',
+  tags: {
+    allowUnknownTags: true,
+    dictionaries: ['jsdoc', 'closure']
+  },
+  templates: {
+    cleverLinks: false,
+    monospaceLinks: false
+  }
+}

package/package.json

@@ -1,23 +1,18 @@
 {
   "name": "@ossy/deployment-tools",
-  "version": "0.0.46",
+  "version": "0.0.48",
   "description": "Collection of scripts and tools to aid deployment of containers and static files to Amazon Web Services through GitHub Actions",
+  "source": "./src/index.js",
   "main": "./src/index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "echo \"The build step is not required when using JavaScript!\" && exit 0",
-    "build:docs": "jsdoc ./src/index.js ./package.json",
+    "build:docs": "jsdoc -c ./jsdoc.config.js ./src/index.js ./package.json",
     "cdk": "cdk"
   },
   "author": "Ossy",
   "license": "ISC",
-  "bin": {
-    "aws": "./src/aws-credentials/cli.js",
-    "deploy": "./src/deploy/cli.js",
-    "template": "./src/template/cli.js",
-    "server": "./src/server/cli.js",
-    "infrastructure": "./src/infrastructure/cli.js"
-  },
+  "bin": "./src/index.cli.js",
   "dependencies": {
     "@actions/core": "^1.10.0",
     "@aws-sdk/client-sqs": "^3.186.0",

package/src/aws-credentials/aws-credentials.js

@@ -35,6 +35,7 @@ class AwsCredentialsService {
         sessionToken: responseData.Credentials.SessionToken,
         secretAccessKey: responseData.Credentials.SecretAccessKey
       }))
+      .then(x => AwsCredentialsService.exportCredentialsToGithubWorkflow({ ...x, awsRegion: platformConfig.awsRegion }))
       .catch(error => {
         logError({ message: '[AwsCredentialsService] Could not resolve temporary credentials', error })
         return undefined
@@ -44,7 +45,7 @@ class AwsCredentialsService {
   static exportCredentialsToGithubWorkflow(params) {
     // Configure the AWS CLI and AWS SDKs using environment variables and set them as secrets.
     // Setting the credentials as secrets masks them in Github Actions logs
-    const { accessKeyId, secretAccessKey, sessionToken } = params
+    const { accessKeyId, secretAccessKey, sessionToken, awsRegion } = params
 
     // AWS_ACCESS_KEY_ID:
     // Specifies an AWS access key associated with an IAM user or role
@@ -65,6 +66,15 @@ class AwsCredentialsService {
       // clear session token from previous credentials action
       core.exportVariable('AWS_SESSION_TOKEN', '')
     }
+
+    if (awsRegion) {
+      core.exportVariable('AWS_REGION', awsRegion)
+    } else if (process.env.AWS_REGION) {
+      // clear AWS_REGION from previous credentials action
+      core.exportVariable('AWS_REGION', '')
+    }
+
+    return params
   }
 
 }

package/src/aws-credentials/cli.js

@@ -1,13 +1,11 @@
-#!/usr/bin/env node
 const arg = require('arg')
 const { AwsCredentialsService } = require('./aws-credentials')
 
+const { PlatformTemplateService } = require('../template')
+const { PlatformConfigService } = require('../config')
 const { logInfo, logError } = require('../log')
 
-//eslint-disable-next-line no-unused-vars
-const [_, __, command, ...options] = process.argv
-
-const resolveCredentials = () => {
+const resolveCredentials = options => {
   logInfo({ message: 'resolve-credentials' })
 
   const parsedArgs = arg({
@@ -23,6 +21,36 @@ const resolveCredentials = () => {
   })
 }
 
-!!command
-  ? { 'resolve-credentials': resolveCredentials }[command]()
-  : logError({ message: 'No command provided' })
+const assumeRole = options => {
+  logInfo({ message: 'assume-role' })
+
+  const parsedArgs = arg({
+    '--platforms': String,
+    '--target-platform': String
+  }, { argv: options })
+
+  const [platformName] = parsedArgs['--target-platform']
+
+  PlatformTemplateService.readFromFile(parsedArgs['--platforms'] || process.env.PLATFORMS)
+    .then(templates => templates.map(PlatformConfigService.from))
+    .then(configs => configs.find(x => x.platformName === platformName))
+    .then(targetConfig => {
+
+      if (!targetConfig) {
+        return logError({ message: 'No configuration found' })
+      }
+
+      AwsCredentialsService.resolveAwsCredentials(targetConfig)
+        .then(() => logInfo({ message: `Assumed role for ${targetConfig.platformName}` }))
+
+    })
+
+}
+
+module.exports = {
+  handler: ([command, ...options]) => {
+    !!command
+      ? { 'resolve-credentials': resolveCredentials, 'assume-role': assumeRole }[command](options)
+      : logError({ message: 'No command provided' })
+  }
+}

package/src/index.cli.js

@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+/* eslint-disable global-require, no-unused-vars */
+
+const [_, __, handlerName, ...restArgs] = process.argv
+
+const { handler } = {
+  aws: require('./aws-credentials/cli.js'),
+  deploy: require('./deploy/cli.js'),
+  template: require('./template/cli.js'),
+  server: require('./server/cli.js')
+}[handlerName]
+
+!!handler && handler(restArgs)

package/src/server/cli.js

@@ -1,22 +1,18 @@
-#!/usr/bin/env node
 const arg = require('arg')
 const { exec } = require('child_process')
-const { PlatformClient } = require('./platform-server')
+const { PlatformServerService } = require('./platform-server')
 
 const { logInfo, logError } = require('../log')
 
-//eslint-disable-next-line no-unused-vars
-const [_, __, command, ...restArgs] = process.argv
-
-const start = cliArgs => {
+const start = options => {
   logInfo({ message: 'Running start command' })
 
   const parsedArgs = arg({
     '--platforms': String,
     '-p': '--platforms'
-  }, { argv: cliArgs })
+  }, { argv: options })
 
-  PlatformClient.start(parsedArgs['--platforms'])
+  PlatformServerService.start(parsedArgs['--platforms'])
 }
 
 const status = () => {
@@ -29,6 +25,10 @@ const stop = () => {
   exec('systemctl stop deployment-tools.service')
 }
 
-!!command
-  ? { start, status, stop }[command]()
-  : logError({ message: 'No command provided' })
+module.exports = {
+  handler: ([command, ...options]) => {
+    !!command
+      ? { start, status, stop }[command](options)
+      : logError({ message: 'No command provided' })
+  }
+}

package/src/template/cli.js

@@ -1,13 +1,9 @@
-#!/usr/bin/env node
 const arg = require('arg')
 const { PlatformTemplateService } = require('./platform-template')
 
 const { logInfo, logError } = require('../log')
 
-//eslint-disable-next-line no-unused-vars
-const [_, __, command, ...options] = process.argv
-
-const validate = () => {
+const validate = options => {
   logInfo({ message: 'Running validate command' })
 
   const parsedArgs = arg({
@@ -19,4 +15,10 @@ const validate = () => {
     .then(() => logInfo({ message: 'Template is valid' }))
 }
 
-command === 'validate' ? validate() : logError({ message: 'No command provided' })
+module.exports = {
+  handler: ([command, ...options]) => {
+    !!command
+      ? { validate }[command](options)
+      : logError({ message: 'No command provided' })
+  }
+}