test(coscrad-frontend): add cypress test of create note about photograph

.gitignore

@@ -40,6 +40,7 @@ Thumbs.db
 
 # environment files
 *.env
+cypress.env.json
 
 # data for data processing scripts
 /scripts/data-processing/data
@@ -50,3 +51,6 @@ auth_config.json
 **content.config.ts
 # TODO Be careful not to git-ignore third-party configs
 **config.json
+
+# COSCRAD CLI command e2e test dummy files
+__cli-command-test-files__

Jenkinsfile

@@ -1,3 +1,6 @@
+/* groovylint-disable NestedBlockDepth */
+def nodeInstallationName = 'NodeJS 18.12.0'
+
 /* groovylint-disable DuplicateStringLiteral */
 /* groovylint-disable-next-line CompileStatic */
 pipeline {
@@ -9,11 +12,9 @@ pipeline {
     stages {
         stage('ci') {
             agent {
-                docker {
-                    image 'node:18-alpine'
-                    args '-u root'
-                }
+                label 'jenkins-build-agent'
             }
+            tools { nodejs nodeInstallationName }
             environment {
                 NODE_ENV = 'test'
                 NODE_PORT = 3131
@@ -26,7 +27,6 @@ pipeline {
                 ARANGO_DB_NAME = 'staging'
                 AUTH0_ISSUER_URL = 'https://foo.auth0.com/'
                 AUTH0_AUDIENCE = 'https://bar.mydomain.ca'
-                BASE_DIGITAL_ASSET_URL = 'https://www.myaudio.com:5555/media?id='
                 GLOBAL_PREFIX = 'api'
                 SHOULD_ENABLE_LEGACY_GAMES_ENDPOINT = 'false'
             }
@@ -38,6 +38,10 @@ pipeline {
             targetLocation: 'apps/coscrad-frontend/src/auth_config.json')]) {
                     echo 'PR opened or updated...'
                     echo "NODE ENV: ${NODE_ENV}"
+                    echo 'node version:'
+                    sh 'node -v'
+                    echo 'npm version'
+                    sh 'npm -v'
                     echo 'Installing dependencies'
                     sh 'npm ci --legacy-peer-deps'
 
@@ -76,13 +80,11 @@ pipeline {
             }
             }
         }
-        stage('deploy to staging') {
+        stage('build and deploy to staging') {
             agent {
-                docker {
-                    image 'node:18-alpine'
-                    args '-u root'
-                }
+                label 'jenkins-build-agent'
             }
+            tools { nodejs nodeInstallationName }
             environment {
                 NODE_ENV = 'staging'
                 NODE_PORT = 3131
@@ -95,48 +97,206 @@ pipeline {
                 ARANGO_DB_NAME = 'staging'
                 AUTH0_ISSUER_URL = 'https://foo.auth0.com/'
                 AUTH0_AUDIENCE = 'https://bar.mydomain.ca'
-                BASE_DIGITAL_ASSET_URL = 'https://www.myaudio.com:5555/media?id='
                 GLOBAL_PREFIX = 'api'
                 SHOULD_ENABLE_LEGACY_GAMES_ENDPOINT = 'false'
             }
             when {
                 branch 'integration'
             }
-            steps {
-                configFileProvider([configFile(fileId:'42feff14-78da-45fc-a8ee-5f98213a313f',  \
-            targetLocation: 'apps/coscrad-frontend/src/auth_config.json')]) {
-                    echo 'Merged to integration'
-                    echo "NODE ENV: ${NODE_ENV}"
-                    echo 'Installing dependencies'
-                    sh 'npm ci --legacy-peer-deps'
+            stages {
+                stage('install dependencies') {
+                    steps {
+                        echo 'Running staging build'
+                        echo "NODE ENV: ${NODE_ENV}"
+                        echo 'Installing dependencies'
+                        sh 'npm ci --legacy-peer-deps'
+                    }
+                }
+                stage('build front-end for COSCRAD sandbox') {
+                    steps {
+                        runFrontendBuild('COSCRAD')
+                    }
+                    post {
+                        success {
+                            deployFrontend('COSCRAD')
+                        }
+                    }
+                }
+                stage('build front-end for Haida sandbox') {
+                    steps {
+                        runFrontendBuild('Haida')
+                    }
+                    post {
+                        success {
+                            deployFrontend('Haida')
+                        }
+                    }
+                }
+                stage('build back-end') {
+                    steps {
+                        sh 'npx nx run build api --prod'
+                    }
+                    post {
+                        success {
+                            deployBackend()
+                        }
+                    }
+                }
+                stage('build cli') {
+                    steps {
+                        sh 'npx nx run api:build:cli'
+                    }
+                    post {
+                        success {
+                            deployCli()
+                        }
+                    }
+                }
+            }
+        }
+    }
+}
 
-                    echo 'Building COSCRAD'
-                    echo 'with node version'
-                    sh 'node --version'
+/**
+* TODO We might be able to have a single function that switches on `target` and
+* sets several global variables to be used in various steps.
+*/
+String getContentConfigFilename(String target) {
+    if (target == 'COSCRAD') { return 'content.config.SAMPLE.ts' }
 
-                /**
-                * Note that the sample content config is actually valid for
-                * our staging build.
-                **/
-                    echo 'copying sample content config for test build'
-                /* groovylint-disable-next-line LineLength */
-                    sh 'cp apps/coscrad-frontend/src/configurable-front-matter/data/content.config.SAMPLE.ts apps/coscrad-frontend/src/configurable-front-matter/data/content.config.ts'
+    if (target == 'Haida') { return 'content.config.STAGING.ts' }
 
-                    sh 'npm run build:coscrad:prod'
-            }
-            }
-                post {
-                    success {
-                        archiveArtifacts artifacts: 'dist/**, node_modules/**', followSymlinks: false
-                    // Deploy front-end build to staging
-                    sshPublisher(
-                        publishers: [sshPublisherDesc(configName: '[email protected]', transfers: [sshTransfer(cleanRemote: false, excludes: '', execCommand: 'rm -rf /var/www/html && mv build/dist/apps/coscrad-frontend /var/www/html && rm -rf build', execTimeout: 120000, flatten: false, makeEmptyDirs: false, noDefaultExcludes: false, patternSeparator: '[, ]+', remoteDirectory: 'build', remoteDirectorySDF: false, removePrefix: '', sourceFiles: 'dist/**')], usePromotionTimestamp: false, useWorkspaceInPromotion: false, verbose: false)])
-
-                    // Deploy back-end build to staging
-                    sshPublisher(
-                        publishers: [sshPublisherDesc(configName: '[email protected]', transfers: [sshTransfer(cleanRemote: false, excludes: '', execCommand: 'rm -rf archive ; mv build archive; touch archive/dist/apps/api/staging.env; PATH=$PATH://home/coscradmin/.nvm/versions/node/v18.16.0/bin pm2 restart main; echo API restarted', execTimeout: 120000, flatten: false, makeEmptyDirs: false, noDefaultExcludes: false, patternSeparator: '[, ]+', remoteDirectory: 'build', remoteDirectorySDF: false, removePrefix: '', sourceFiles: 'dist/**, node_modules/**')], usePromotionTimestamp: false, useWorkspaceInPromotion: false, verbose: false)])
+    error "unsupported deployment target: ${target}"
+
+    // This is to satisfy the linter. Maybe we should be explicitly throwing in the line above?
+    return ''
+}
+
+/**
+* # Available Targets
+ - COSCRAD
+ - Haida
+**/
+void copyContentConfig(String target) {
+    String contentConfigDirectory = 'apps/coscrad-frontend/src/configurable-front-matter/data/'
+
+    /**
+    * Note that the sample content config is actually valid for
+    * our staging build.
+    **/
+    echo "attempting to copy sample content config for test build for target ${target}"
+
+    /* groovylint-disable-next-line LineLength */
+    sh "cp ${contentConfigDirectory}${getContentConfigFilename(target)} ${contentConfigDirectory}content.config.ts"
+
+    return
+}
+
+void runFrontendBuild(String target) {
+    configFileProvider([configFile(fileId:'staging.auth.config',  \
+                    targetLocation: 'apps/coscrad-frontend/src/auth_config.json')]) {
+            echo "Building COSCRAD front-end for target project: ${target}"
+            echo 'with node version'
+            sh 'node --version'
+
+            copyContentConfig(target)
+            sh 'npx nx build coscrad-frontend --prod --skip-nx-cache'
+
+            echo 'build contents'
+            sh 'ls dist/apps'
                     }
-                }
-                }
+}
+
+String getDeploymentDirectoryForFrontendBuild(String target) {
+    if (target == 'COSCRAD') {
+        return 'html'
+    }
+
+    if (target == 'Haida') {
+        return 'haida'
+    }
+
+    error "No deployment directory found for unknown build target: ${target}"
+
+    return ''
+}
+
+void publishArtifacts(String sshConfigName,  \
+    String postTransferCommand, \
+    String remoteDirectory, \
+    String sourceFilePattern) {
+    sshPublisher(
+        publishers: [
+            sshPublisherDesc(
+                configName: sshConfigName,
+                transfers: [
+                    sshTransfer(
+                        cleanRemote: false,
+                        excludes: '',
+                        execCommand: postTransferCommand,
+                        execTimeout: 120000,
+                        flatten: false, makeEmptyDirs:
+                        false, noDefaultExcludes: false,
+                        patternSeparator: '[, ]+',
+                        remoteDirectory: remoteDirectory,
+                        remoteDirectorySDF: false,
+                        removePrefix: '',
+                        sourceFiles: sourceFilePattern
+                        )],
+                    usePromotionTimestamp: false,
+                    useWorkspaceInPromotion: false,
+                    verbose: false
+                    )])
     }
+
+void archiveArtifacts(String sourceFilePattern) {
+    archiveArtifacts artifacts: sourceFilePattern, followSymlinks: false
+}
+
+void deployFrontend(String target) {
+    String basePath = '/var/www/'
+
+    String deploymentDirectory = getDeploymentDirectoryForFrontendBuild(target)
+
+    String fullDeploymentPath = "${basePath}${deploymentDirectory}"
+
+    String command = "rm -rf ${fullDeploymentPath} \
+     && mv build/dist/apps/coscrad-frontend \
+      ${fullDeploymentPath} && rm -rf build "
+
+    String sourceFilePattern = 'dist/apps/coscrad-frontend/**'
+
+    archiveArtifacts(sourceFilePattern)
+
+    publishArtifacts('[email protected]', command, 'build', sourceFilePattern)
+}
+
+void deployBackend() {
+    String backendArtifactsPattern = 'dist/apps/api/**, node_modules/**'
+
+    String postDeployCommand = 'rm -rf archive ; \
+        mv build archive; \
+        touch archive/dist/apps/api/staging.env; \
+        PATH=$PATH://home/coscradmin/.nvm/versions/node/v18.16.0/bin pm2 restart main; \
+        echo API restarted'
+
+    archiveArtifacts(backendArtifactsPattern)
+
+    publishArtifacts('[email protected]',
+    postDeployCommand, \
+    'build', \
+    backendArtifactsPattern)
+}
+
+void deployCli() {
+    String backendArtifactsPattern = 'dist/apps/coscrad-cli/**'
+
+    String postDeployCommand = 'echo CLI build copied'
+
+    archiveArtifacts(backendArtifactsPattern)
+
+    publishArtifacts('[email protected]',
+    postDeployCommand, \
+    'cli', \
+    backendArtifactsPattern)
 }

README.md

@@ -35,23 +35,7 @@ that leverage the COSCRAD API. The Many ideas explored in the community projects
 will eventually find their way into Coscrad's core.
 
 **COSCRAD CLI**
-We also have built our own command-line interface, `COSCRAD CLI`. This is used
-for administrative tasks like dumping data snapshots (in persistence layer, domain layer
-and view layer formats), seeding test data and restoring data dumps, dumping
-a JSON version of schemas for our domain models, view models, command and event payloads,
-and so on.
-
-Currently, `COSCRAD CLI` is part of the `api`, and it is available via a custom
-build of the `api`. Run `npx nx build:api:cli` to build the `COSCRAD CLI`. The
-cli will be built to `dist/apps/cosccrad-cli`. Run
-
-```
-node main.js <command> <options>
-```
-
-from within this directory to execute a `COSCRAD CLI` command.
-
-<!-- TODO Add documentation for all commands -->
+The `coscrad-cli` is a command line tool for data administration tasks. Its use is documented [here](./apps/api/cli.README.md)
 
 In the future, once our domain has been moved to a separate lib, we will move
 the `COSCRAD CLI` to a standalone app in the mono-repo.