Create AWS plugin for s3 uploads deployments

.eslintrc.json

@@ -3,6 +3,11 @@
   "ignorePatterns": ["**/*"],
   "plugins": ["@nx"],
   "overrides": [
+    {
+      "files": "*.json",
+      "parser": "jsonc-eslint-parser",
+      "rules": {}
+    },
     {
       "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
       "rules": {

.github/workflows/ci.yml

@@ -193,12 +193,13 @@ jobs:
           aws-region: eu-central-1
 
       - name: Deploy Dev Client
-        if: ${{ env.is-pull-request == 'true' }}
-        run: npx nx affected --target=deploy  --exclude='*,!tag:frontend' --environment=dev
+        if: ${{ env.is-main-branch != 'true' }}
+        run: npx nx affected --target=deploy  --exclude='*,!tag:frontend' --configuration=development
+
 
       - name: Deploy Prod Client
         if: ${{ env.is-main-branch == 'true' }}
-        run: npx nx affected --target=deploy  --exclude='*,!tag:frontend' --environment=prod
+        run: npx nx affected --target=deploy  --exclude='*,!tag:frontend' --configuration=production
 
   deploy-server:
     name: Deploy Server
@@ -232,9 +233,9 @@ jobs:
           aws-region: eu-central-1
 
       - name: Deploy Dev Server
-        if: ${{ env.is-pull-request == 'true' }}
-        run: npx nx affected --target=deploy  --exclude='*,!tag:backend' --environment=dev
+        if: ${{ env.is-main-branch != 'true' }}
+        run: npx nx affected --target=deploy  --exclude='*,!tag:backend' --configuration=development
 
       - name: Deploy Prod Server
         if: ${{ env.is-main-branch == 'true' }}
-        run: npx nx affected --target=deploy  --exclude='*,!tag:backend' --environment=dev
+        run: npx nx affected --target=deploy  --exclude='*,!tag:backend' --configuration=production

apps/audit-runner/project.json

@@ -71,29 +71,19 @@
         }
       }
     },
+    "s3-upload": {
+      "executor": "@app-speed/aws-deploy:s3-upload",
+      "dependsOn": ["build"],
+      "options": {
+        "upload": "dist/apps/audit-runner",
+        "bucket": "s3://ufo-runner-dev"
+      }
+    },
     "deploy": {
       "executor": "nx:run-commands",
-      "dependsOn": ["build"],
+      "dependsOn": ["s3-upload"],
       "options": {
-        "parallel": false,
-        "commands": [
-          {
-            "command": "`[ {args.environment} != dev ]` && `[ {args.environment} != prod ]` && exit 1 || exit 0",
-            "forwardAllArgs": true
-          },
-          {
-            "command": "echo 'Deploying Server to {args.environment} environment'",
-            "forwardAllArgs": true
-          },
-          {
-            "command": "`[ {args.environment} == prod ]` &&  aws s3 sync ./dist/apps/audit-runner s3://ufo-runner-dev --delete && node ./scripts/deploy-runner.js || exit 0",
-            "forwardAllArgs": true
-          },
-          {
-            "command": "`[ {args.environment} == dev ]` &&  aws s3 sync ./dist/apps/audit-runner s3://ufo-runner-dev --delete && node ./scripts/deploy-runner.js || exit 0",
-            "forwardAllArgs": true
-          }
-        ]
+        "command": "node ./scripts/deploy-runner.js"
       }
     }
   },

apps/user-flow-manager/project.json

@@ -79,28 +79,20 @@
       }
     },
     "deploy": {
-      "executor": "nx:run-commands",
+      "executor": "@app-speed/aws-deploy:s3-upload",
       "dependsOn": ["build"],
       "options": {
-        "commands": [
-          {
-            "command": "`[ {args.environment} != dev ]` && `[ {args.environment} != prod ]` && exit 1 || exit 0",
-            "forwardAllArgs": true
-          },
-          {
-            "command": "echo 'Deploying Front-End to {args.environment} environment'",
-            "forwardAllArgs": true
-          },
-          {
-            "command": "`[ {args.environment} == prod ]` && aws s3 sync ./dist/apps/user-flow-manager s3://app.deep-blue.io --delete || exit 0",
-            "forwardAllArgs": true
-          },
-          {
-            "command": "`[ {args.environment} == dev ]` && aws s3 sync ./dist/apps/user-flow-manager s3://dev.deep-blue.io --delete || exit 0",
-            "forwardAllArgs": true
-          }
-        ]
-      }
+        "upload": "dist/apps/user-flow-manager"
+      },
+      "configurations": {
+        "production": {
+          "bucket": "s3://app.deep-blue.io"
+        },
+        "development": {
+          "bucket": "s3://dev.deep-blue.io"
+        }
+      },
+      "defaultConfiguration": "development"
     }
   },
   "tags": ["frontend"]

libs/aws-deploy/.eslintrc.json

@@ -0,0 +1,32 @@
+{
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.json"],
+      "parser": "jsonc-eslint-parser",
+      "rules": {
+        "@nx/dependency-checks": "error"
+      }
+    },
+    {
+      "files": ["./package.json", "./executors.json"],
+      "parser": "jsonc-eslint-parser",
+      "rules": {
+        "@nx/nx-plugin-checks": "error"
+      }
+    }
+  ]
+}

libs/aws-deploy/README.md

@@ -0,0 +1,11 @@
+# aws-deploy
+
+This library was generated with [Nx](https://nx.dev).
+
+## Building
+
+Run `nx build aws-deploy` to build the library.
+
+## Running unit tests
+
+Run `nx test aws-deploy` to execute the unit tests via [Jest](https://jestjs.io).

libs/aws-deploy/executors.json

@@ -0,0 +1,9 @@
+{
+  "executors": {
+    "s3-upload": {
+      "implementation": "./src/executors/s3-upload/executor",
+      "schema": "./src/executors/s3-upload/schema.json",
+      "description": "Executor to upload files to an s3 bucket"
+    }
+  }
+}

libs/aws-deploy/jest.config.ts

@@ -0,0 +1,10 @@
+/* eslint-disable */
+export default {
+  displayName: 'aws-deploy',
+  preset: '../../jest.preset.js',
+  transform: {
+    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '../../coverage/libs/aws-deploy',
+};

libs/aws-deploy/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "@app-speed/aws-deploy",
+  "version": "0.0.1",
+  "dependencies": {
+    "@nx/devkit": "16.10.0"
+  },
+  "type": "commonjs",
+  "main": "./src/index.js",
+  "typings": "./src/index.d.ts",
+  "executors": "./executors.json"
+}

libs/aws-deploy/project.json

@@ -0,0 +1,66 @@
+{
+  "name": "aws-deploy",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "libs/aws-deploy/src",
+  "projectType": "library",
+  "targets": {
+    "build": {
+      "executor": "@nx/js:tsc",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "outputPath": "dist/libs/aws-deploy",
+        "main": "libs/aws-deploy/src/index.ts",
+        "tsConfig": "libs/aws-deploy/tsconfig.lib.json",
+        "assets": [
+          "libs/aws-deploy/*.md",
+          {
+            "input": "./libs/aws-deploy/src",
+            "glob": "**/!(*.ts)",
+            "output": "./src"
+          },
+          {
+            "input": "./libs/aws-deploy/src",
+            "glob": "**/*.d.ts",
+            "output": "./src"
+          },
+          {
+            "input": "./libs/aws-deploy",
+            "glob": "generators.json",
+            "output": "."
+          },
+          {
+            "input": "./libs/aws-deploy",
+            "glob": "executors.json",
+            "output": "."
+          }
+        ]
+      }
+    },
+    "lint": {
+      "executor": "@nx/linter:eslint",
+      "outputs": ["{options.outputFile}"],
+      "options": {
+        "lintFilePatterns": [
+          "libs/aws-deploy/**/*.ts",
+          "libs/aws-deploy/package.json",
+          "libs/aws-deploy/executors.json"
+        ]
+      }
+    },
+    "test": {
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
+      "options": {
+        "jestConfig": "libs/aws-deploy/jest.config.ts",
+        "passWithNoTests": true
+      },
+      "configurations": {
+        "ci": {
+          "ci": true,
+          "codeCoverage": true
+        }
+      }
+    }
+  },
+  "tags": []
+}

libs/aws-deploy/src/executors/s3-upload/constants.ts

@@ -0,0 +1,16 @@
+
+const EXECUTOR_FAIL_BASE = 'Executor failed because';
+const EXECUTOR_SUCCESS_BASE = 'Successfully ran executor';
+
+const MISSING_BUCKET = 'bucket name was not found in options';
+const INVALID_BUCKET = 'bucket name was invalid';
+
+const MISSING_UPLOAD = 'upload was not found in options';
+
+export {
+  EXECUTOR_FAIL_BASE,
+  EXECUTOR_SUCCESS_BASE,
+  MISSING_BUCKET,
+  INVALID_BUCKET,
+  MISSING_UPLOAD
+};

libs/aws-deploy/src/executors/s3-upload/executor.spec.ts

@@ -0,0 +1,46 @@
+import { S3UploadExecutorSchema } from './schema';
+import executor from './executor';
+import { EXECUTOR_FAIL_BASE, EXECUTOR_SUCCESS_BASE, INVALID_BUCKET, MISSING_BUCKET, MISSING_UPLOAD } from './constants';
+
+const options: S3UploadExecutorSchema = {
+  bucket: 'example-bucket',
+  upload: 'example-upload',
+};
+
+describe('S3Upload Executor', () => {
+  it('can run', async () => {
+    const output = await executor(options);
+    expect(output.success).toBe(true);
+    expect(output.message).toContain(EXECUTOR_SUCCESS_BASE);
+  });
+
+  it('fails if no bucket option', async () => {
+    const output = await executor({
+      ...options,
+      bucket: undefined as unknown as string,
+    });
+    expect(output.success).toBe(false);
+    expect(output.message).toContain(EXECUTOR_FAIL_BASE);
+    expect(output.message).toContain(MISSING_BUCKET);
+  });
+
+  it('fails on invalid bucket option', async () => {
+    const output = await executor({
+      ...options,
+      bucket: 'invalid bucket name',
+    });
+    expect(output.success).toBe(false);
+    expect(output.message).toContain(EXECUTOR_FAIL_BASE);
+    expect(output.message).toContain(INVALID_BUCKET);
+  });
+
+  it('fails if no upload option', async () => {
+    const output = await executor({
+      ...options,
+      upload: undefined as unknown as string,
+    });
+    expect(output.success).toBe(false);
+    expect(output.message).toContain(EXECUTOR_FAIL_BASE);
+    expect(output.message).toContain(MISSING_UPLOAD);
+  });
+});