CCM-10057: user transfer data migration (#476)

Author: mark-r-bjss

.gitignore

@@ -38,6 +38,7 @@ dist
 # misc
 .DS_Store
 *.pem
+data-migration/user-transfer/backups/
 
 # debug
 npm-debug.log*

data-migration/user-transfer/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "../../.eslintrc"
+  ]
+}

data-migration/user-transfer/README.md

@@ -0,0 +1,26 @@
+# User Transfer Data Migration
+
+The purpose of this tool is to transfer templates stored in DynamoDB from one owner to another. It does not transfer ownership of any files in S3, this would need to be done separately.
+
+The owner field is the partition key for database entries and as such they are deleted and re-created with the new owner. They will retain their unique ID.
+
+A local backup of the data is persisted before any updates into a `./backup` directory.
+
+## Parameters
+
+| Parameter          | Optional | Description                                     |
+| ------------------ | -------- | ----------------------------------------------- |
+| --sourceOwner      | Required | The current owner of the data, typically a UUID |
+| --destinationOwner | Required | The new owner of the data, typically a UUID     |
+| --environment      | Required | The environment name, e.g. main                 |
+|                    |          |                                                 |
+
+## Authentication
+
+You should establish a local AWS authentication session to the target AWS account with sufficient permissions to read, write and delete template data from DynamoDB.
+
+## Example
+
+```shell
+npm run transfer -- --sourceOwner 26d202d4-f001-7043-1781-77c935224d18 --destinationOwner e6f232b4-6051-7096-a238-5527b8615d11 --environment main
+```

data-migration/user-transfer/jest.config.ts

@@ -0,0 +1,62 @@
+/**
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+import type { Config } from 'jest';
+import { pathsToModuleNameMapper } from 'ts-jest';
+import { compilerOptions } from './tsconfig.json';
+
+const config: Config = {
+  preset: 'ts-jest',
+
+  // Automatically clear mock calls, instances, contexts and results before every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: true,
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: './.reports/unit/coverage',
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: 'v8',
+
+  coverageThreshold: {
+    global: {
+      branches: 100,
+      functions: 100,
+      lines: 100,
+      statements: -10,
+    },
+  },
+
+  collectCoverageFrom: ['src/**/*.ts*'],
+
+  coveragePathIgnorePatterns: ['handler.ts', 'constants.ts'],
+
+  // Set the absolute path for imports
+  moduleNameMapper: pathsToModuleNameMapper(compilerOptions.paths, {
+    prefix: '<rootDir>/',
+  }),
+
+  // Use this configuration option to add custom reporters to Jest
+  reporters: [
+    'default',
+    [
+      '../../node_modules/jest-html-reporter',
+      {
+        pageTitle: 'Test Report',
+        outputPath: './.reports/unit/test-report.html',
+        includeFailureMsg: true,
+      },
+    ],
+  ],
+
+  // The test environment that will be used for testing
+  testEnvironment: 'node',
+
+  testPathIgnorePatterns: ['/node_modules/', '/tests/'],
+};
+
+export default config;