Update readmes, add tests, and update CI

Signed-off-by: Peter Nied <[email protected]>
opensearch-project · Oct 24, 2024 · e6c6dd0 · e6c6dd0
1 parent 60e1b90
commit e6c6dd0
Show file tree

Hide file tree

Showing 8 changed files with 82 additions and 200 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -188,11 +188,17 @@ jobs:
           docker stop $(docker ps -q) && docker system prune --volumes -f
           docker image ls --format '{{.Repository}}:{{.Tag}}' | grep '^migrations/' | xargs -I {} docker image rm {}
 
-  cdk-tests:
+  node-tests:
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        npm-project:
+          - ./deployment/cdk/opensearch-service-migration
+          - ./deployment/migration-assistant-solution
     defaults:
       run:
-        working-directory: ./deployment/cdk/opensearch-service-migration
+        working-directory: ${{ matrix.npm-project }}
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
@@ -227,7 +233,7 @@ jobs:
   all-ci-checks-pass:
     needs:
       - style-check
-      - cdk-tests
+      - node-tests
       - gradle-tests
       - link-checker
       - python-e2e-tests

diff --git a/deployment/README.md b/deployment/README.md
@@ -9,6 +9,10 @@ This directory is aimed at housing deployment/distribution methods for various m
 A containerized end-to-end solution (including a source and target cluster as well as the migration services) can be deployed locally using the
 [Docker Solution](../TrafficCapture/dockerSolution/README.md).
 
+### Deploying the Migration Assistant Solution to AWS
+
+The Migration Assistant is avaliable as an AWS Solution, [learn more](./migration-assistant-solution/README.md).
+
 ### Deploying Migration solution to AWS
 
 **Note**: These features are still under development and subject to change

diff --git a/deployment/migration-assistant-solution/README.md b/deployment/migration-assistant-solution/README.md
@@ -26,4 +26,18 @@ sequenceDiagram
     Note over MA: Migration Assistant is ready
     User ->> MA: Log into Migration Assistant Console
     User ->> MA: Migration Actions
-```
+```
+
+### Migration Assistant
+
+The full range of functionality offered by the migration assistant deployed through the opensearch-service-migration project, see its [README.MD](../cdk/opensearch-service-migration/README.md) for additon details.
+
+## Development
+
+This project is writen in TypeScript and uses the cloud developer tookit (CDK) to produce its build artifacts, cloud formation templates that can be used to deploy onto Amazon Web Services.
+
+### Quick Start Guide
+
+* Install Node 18+ & Npm 10+ https://docs.npmjs.com/downloading-and-installing-node-js-and-npm
+* Build the project `npm run build`
+* Creat the deployment artifacts `npm run snyth`
diff --git a/deployment/migration-assistant-solution/eslint.config.mjs b/deployment/migration-assistant-solution/eslint.config.mjs
@@ -7,5 +7,8 @@ export default tseslint.config(
     ...tseslint.configs.stylistic,
     {
         ignores: ['**/*.js'],
+        "env": {
+            "jest": true
+        }
     }
 );
diff --git a/deployment/migration-assistant-solution/jest.config.js b/deployment/migration-assistant-solution/jest.config.js
@@ -0,0 +1,7 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} **/
+module.exports = {
+  testEnvironment: "node",
+  transform: {
+    "^.+.tsx?$": ["ts-jest",{}],
+  },
+};