@suffolklitlab/alkiln 5.4.1-feat-github-server-18 → 5.4.1-feat-github-server-19

package/.github/workflows/github_server.yml

@@ -2,17 +2,11 @@ name: GitHub server tests
 
 on:
   push:
-  # `workflow dispatch` isn't showing up in github because it's not the default branch
-  # See https://stackoverflow.com/a/75250828
   workflow_dispatch:
     inputs:
       tags:
         required: False
         description: 'Optional. Use a "tag expression" specify which tagged tests to run (https://cucumber.io/docs/cucumber/api/#tag-expressions)'
-        # # Only test 2 tests - one uses an env var, the other uses AL.
-        # # They test if env vars get set correctly and depencencies get
-        # # pulled in correctly.
-        # default: '@al1'
       enable_tmate:
         type: boolean
         description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'
@@ -29,11 +23,10 @@ jobs:
         node-version: [18.x]
 
     env:
-      # How would a dev make another user/password if they wanted to?
+      # TODO: Must solve - how would a dev make another user/password if they wanted to?
       SECRET_VAR1: secret-var1-value
       SECRET_VAR2: secret-var2-value
       SECRET_FOR_MISSING_FIELD: secret for missing field
-      #_ALKILN_DANGEROUS_DEBUG: true
       
     steps:
       # Place the root directory in this branch
@@ -64,10 +57,9 @@ jobs:
         run: |
           echo "USER1_EMAIL=${{ steps.github_server.outputs.DA_ADMIN_EMAIL }}" >> $GITHUB_ENV
           echo "USER1_PASSWORD=${{ steps.github_server.outputs.DA_ADMIN_PASSWORD }}" >> $GITHUB_ENV
+      ## Example of working with the docker container after it's been started
       #- name: Work with docker
       #  run: |
-      #    # Authors can use this to do more with the docker container.
-      #    # There may be a better way. Would take research. A docker action?
       #    container_name=$(docker ps --format '{{.Names}}' | head -n 1)
       #    echo "container_name is $container_name"
 
@@ -80,6 +72,6 @@ jobs:
           INSTALL_METHOD: "server"
           # TODO: See what happens if this is an empty string
           ALKILN_VERSION: "server"
-          ALKILN_TAG_EXPRESSION: "@al1"
+          #ALKILN_TAG_EXPRESSION: "@al1"
       - run: echo "Finished running ALKiln tests"
 

package/github_server/action.yml

@@ -1,17 +1,6 @@
 name: "ALKiln/github_server: Isolated docassemble tests"
 description: "Download and start up a temporary docassemble server on GitHub's servers, in an isolated environment. Avoids docassemble reload errors and other external factors."
 
-# Bug? Race condition? Exit with 52 when waiting for container to finish starting
-# https://github.com/SuffolkLITLab/ALKiln/actions/runs/5912900256/job/16036751264#step:4:188
-# Had no completion messages, but it exited with an error anyway
-# Took 121 seconds
-# The rerun of the test completed that step just fine, though it took less time
-# Took 120 and was fine: https://github.com/SuffolkLITLab/ALKiln/actions/runs/5913167036/job/16037288791
-# 150 secs with exit code 56:
-# https://github.com/SuffolkLITLab/ALKiln/actions/runs/5914677262/job/16040233419#step:4:196
-# 120 sec with exit code 56:
-# https://github.com/SuffolkLITLab/ALKiln/actions/runs/5914963614/job/16040773624#step:4:206
-
 # If we want to control the version of the docassemble image, we'd have
 # to make our own image:
 # You can build your own image by doing git clone jhpyle/docassemble  and then
@@ -69,7 +58,7 @@ runs:
           mkdir /tmp/config
           echo "${{ inputs.CONFIG_CONTENTS }}" > /tmp/config/myconfig.yml
           docker pull jhpyle/docassemble
-          docker run --env DA_ADMIN_EMAIL="${{ env.DA_ADMIN_EMAIL }}" --env DA_ADMIN_PASSWORD="${{ env.DA_ADMIN_PASSWORD }}" --env DA_ADMIN_API_KEY="${{ env.DA_ADMIN_API_KEY }}" --env DA_CONFIG=/tmp/config/myconfig.yml --volume /tmp/config:/tmp/config --cap-add SYS_PTRACE --memory="4gb" -d -p 80:80 jhpyle/docassemble
+          docker run --name docassemble_container --env DA_ADMIN_EMAIL="${{ env.DA_ADMIN_EMAIL }}" --env DA_ADMIN_PASSWORD="${{ env.DA_ADMIN_PASSWORD }}" --env DA_ADMIN_API_KEY="${{ env.DA_ADMIN_API_KEY }}" --env DA_CONFIG=/tmp/config/myconfig.yml --volume /tmp/config:/tmp/config --cap-add SYS_PTRACE --memory="4gb" -d -p 80:80 jhpyle/docassemble
         shell: bash
       - name: "ALKiln github_server: Wait for server to start"
         run: |
@@ -80,18 +69,15 @@ runs:
           # Wait 1 minute before pinging the server constantly
           sleep 60
 
-          # Use a variable instead of checking $response so we can control to avoid race
-          # conditions from preventing the success log message.
-          ready="false"
+          response="start"
 
-          while [[ $ready == "false" ]]; do
-            echo "Time ellapsed: $SECONDS seconds"
+          while [[ $response != *"200"* ]]; do
+            echo "Time elapsed: $SECONDS seconds"
 
             # Check if max seconds till loading has passed
             if [[ $SECONDS -ge $MAX_SECONDS_FOR_DOCKER ]]; then
               echo "ALKiln GitHub Server Error: Timed out waiting for docker container to serve the site. If you want to give your docker container more timem to install, set the MAX_SECONDS_FOR_DOCKER input for this action."
-              # Exit with failure, or allow this to keep going?
-              break
+              exit 1
             fi
 
             # Set the variable to a new string value in each iteration
@@ -101,7 +87,6 @@ runs:
             # Check if the string includes the desired text
             if [[ $response == *"200"* ]]; then
               echo "Success! The docker container is ready!"
-              ready="true"
             else
               echo "The docker container isn't ready yet. Will check again in 30 seconds."
               sleep 30
@@ -117,41 +102,17 @@ runs:
       - run: pip install docassemblecli
         shell: bash
       # Install the current directory onto the docassemble server
-
-      #- name: Setup tmate session
-      #  uses: mxschmitt/action-tmate@v3
-      
-      ## da doesn't need to know the name of the folder
-      ## alkiln does so it can locate the Project or package installed on the server
-      - run: |
-          # if `docassemble` cd `docassemble`
-          #cd docassemble
-          ## Get the name of the package folder
-          #dirs2=(*/)
-          #len=${#dirs2[@]}
-          #if (( $len > 1 ));
-          #then echo There are multiple files in your repo's `docassemble` folder. ALkiln will use the first one;
-          #fi
-          #folder=5
-          #
-          #
-          ## Get back out of the docassemble folder
-          #cd ..
-          ## Install on server
-
-          dainstall . --apiurl http://localhost --apikey $DA_ADMIN_API_KEY
+      - run: dainstall . --apiurl http://localhost --apikey $DA_ADMIN_API_KEY
         shell: bash
 
-      # Upload artifacts that subscribers can download on the Actions summary page
+      # TODO: Upload artifacts that subscribers can download on the Actions summary page
       - name: "ALKiln github_server: Docker logs"
         if: ${{ always() }}
         run: |
-          docker_logs=$(docker logs $(docker ps --filter "ancestor=jhpyle/docassemble" --format {{.ID}}))
           # Should this name have a date/time attached? The logs themselves have timestamps
-          echo "$docker_logs" > /tmp/alkiln_docker_logs.txt
+          echo "$(docker logs docassemble_container)" > /tmp/alkiln_docker_logs.txt
         shell: bash
-    
-      # Should this date/time be created at the start of this action?
+      
       - name: "ALKiln github_server: Get folder name with date and time"
         if: ${{ always() }}
         run: |

package/lib/docassemble/get_base_interview_url.js

@@ -13,7 +13,7 @@ let get_base_interview_url = async function () {
 
   let server_url = session_vars.get_da_server_url();
 
-  if (session_vars.get_install_type() === `server`) {
+  if (session_vars.get_install_method() === `server`) {
 
     return `${ server_url }/interview?new_session=1&i=docassemble.${session_vars.get_repo_folder_name()}%3Adata/questions/`;
 

package/lib/docassemble/server_install.js

@@ -5,7 +5,7 @@ const log = require('../utils/log');
 const fg = require('fast-glob');
 
 const server_install = async () => {
-  session_vars.save_install_type(`server`);
+  session_vars.save_install_method(`server`);
 
   let current_dir = process.cwd();
   let path = `${ current_dir }/docassemble/*`;

package/lib/utils/session_vars.js

@@ -178,72 +178,118 @@ session_vars.delete_project_name = function () {
 const artifacts_path_key = `artifacts_path`;
 session_vars.save_artifacts_path_name = function ( path_name ) {
   /* Save a key with the name of the current artifacts folder in case it doesn't exist. */
-
-  // Ensure artifacts path file exists
-  if ( !fs.existsSync( runtime_config_path ) ) {
-    // If the file doesn't exist, make one because next we need to read it
-    fs.writeFileSync( runtime_config_path, JSON.stringify( {}, null, 2 ) );
-  }
-
-  // Get the json, changing it, and re-write the file from scratch
-  let json = JSON.parse( fs.readFileSync( runtime_config_path ) );
-  json[ artifacts_path_key ] = path_name;
-  let file = fs.writeFileSync( runtime_config_path, JSON.stringify( json, null, 2 ) );
-
-  if ( session_vars.get_debug() ) {
-    console.log( `ALKiln debug: Stored name of artifacts directory "${ path_name }" locally.` );
-  }
-  return file;
+  return session_vars.save_runtime_config_var({ key: artifacts_path_key, value: path_name });
+
+  // // Ensure artifacts path file exists
+  // if ( !fs.existsSync( runtime_config_path ) ) {
+  //   // If the file doesn't exist, make one because next we need to read it
+  //   fs.writeFileSync( runtime_config_path, JSON.stringify( {}, null, 2 ) );
+  // }
+
+  // // Get the json, changing it, and re-write the file from scratch
+  // let json = JSON.parse( fs.readFileSync( runtime_config_path ) );
+  // json[ artifacts_path_key ] = path_name;
+  // let file = fs.writeFileSync( runtime_config_path, JSON.stringify( json, null, 2 ) );
+
+  // if ( session_vars.get_debug() ) {
+  //   console.log( `ALKiln debug: Stored name of artifacts directory "${ path_name }" locally.` );
+  // }
+  // return file;
 };  // Ends save_artifacts_path_name()
 
 session_vars.get_artifacts_path_name = function () {
   /* Get the name of the current artifacts path. */
-  try {
-    let json = JSON.parse( fs.readFileSync( runtime_config_path ));
-    let path_name = json[ artifacts_path_key ];
-
-    if ( session_vars.get_debug() ) { console.log( `ALKiln debug: Artifacts directory is "${ path_name }".` ); }
-    return path_name;
-  } catch ( error ) {
-    return null;
-  }
+  return session_vars.get_runtime_config_var( artifacts_path_key );
+  // try {
+  //   let json = JSON.parse( fs.readFileSync( runtime_config_path ));
+  //   let path_name = json[ artifacts_path_key ];
+
+  //   if ( session_vars.get_debug() ) { console.log( `ALKiln debug: Artifacts directory is "${ path_name }".` ); }
+  //   return path_name;
+  // } catch ( error ) {
+  //   return null;
+  // }
 };  // Ends get_artifacts_path_name()
 
 
-const install_type_key = `da_install_type`;
-session_vars.save_install_type = function (install_type) {
+const install_method_key = `da_install_method`;
+session_vars.save_install_method = function (install_method) {
   /* Save a key with the name of the current artifacts folder in case it doesn't exist. */
+  return session_vars.save_runtime_config_var({ key: install_method_key, value: install_method });
 
-  // Ensure artifacts path file exists
-  if ( !fs.existsSync( runtime_config_path ) ) {
-    // If the file doesn't exist, make one because next we need to read it
-    fs.writeFileSync( runtime_config_path, JSON.stringify( {}, null, 2 ) );
-  }
+  // // Ensure artifacts path file exists
+  // if ( !fs.existsSync( runtime_config_path ) ) {
+  //   // If the file doesn't exist, make one because next we need to read it
+  //   fs.writeFileSync( runtime_config_path, JSON.stringify( {}, null, 2 ) );
+  // }
 
-  // Get the json, changing it, and re-write the file from scratch
-  let json = JSON.parse( fs.readFileSync( runtime_config_path ) );
-  json[ install_type_key ] = install_type;
-  let file = fs.writeFileSync( runtime_config_path, JSON.stringify( json, null, 2 ) );
+  // // Get the json, changing it, and re-write the file from scratch
+  // let json = JSON.parse( fs.readFileSync( runtime_config_path ) );
+  // json[ install_method_key ] = install_method;
+  // let file = fs.writeFileSync( runtime_config_path, JSON.stringify( json, null, 2 ) );
 
-  return file;
-};  // Ends save_install_type()
+  // return file;
+};  // Ends save_install_method()
 
-session_vars.get_install_type = function () {
-  /* Get the name of the current artifacts path. */
-  try {
-    let json = JSON.parse( fs.readFileSync( runtime_config_path ));
-    let install_type = json[ install_type_key ];
+session_vars.get_install_method = function () {
+  /* Get the name of the current install method. */
+  return session_vars.get_runtime_config_var( install_method_key );
+  // try {
+  //   let json = JSON.parse( fs.readFileSync( runtime_config_path ));
+  //   let install_method = json[ install_method_key ];
 
-    return install_type;
-  } catch ( error ) {
-    return null;
-  }
-};  // Ends get_install_type()
+  //   return install_method;
+  // } catch ( error ) {
+  //   return null;
+  // }
+};  // Ends get_install_method()
 
 
 const repo_folder_key = `da_repo_folder_name`;
 session_vars.save_repo_folder_name = function (repo_folder_name) {
   /** Save a key with the name of the main package folder in the repository. */
+  return session_vars.save_runtime_config_var({ key: repo_folder_key, value: repo_folder_name });
+
+  // // Ensure runtime config file exists
+  // if ( !fs.existsSync( runtime_config_path ) ) {
+  //   // If the file doesn't exist, make one because next we need to read it
+  //   fs.writeFileSync( runtime_config_path, JSON.stringify( {}, null, 2 ) );
+  // }
+
+  // // Get the json, changing it, and re-write the file from scratch
+  // let json = JSON.parse( fs.readFileSync( runtime_config_path ) );
+  // json[ repo_folder_key ] = repo_folder_name;
+  // let file = fs.writeFileSync( runtime_config_path, JSON.stringify( json, null, 2 ) );
+
+  // return file;
+};  // Ends session_vars.save_repo_folder_name()
+
+session_vars.get_repo_folder_name = function () {
+  /** Get the name of the main folder in the repository. */
+  return session_vars.get_runtime_config_var( repo_folder_key );
+  // try {
+  //   let json = JSON.parse( fs.readFileSync( runtime_config_path ));
+  //   let name = json[ repo_folder_key ];
+
+  //   return name;
+  // } catch ( error ) {
+  //   return null;
+  // }
+};  // Ends session_vars.get_repo_folder_name()
+
+
+// TODO: Should we replace the other method calls with this one?
+// i.e. `save_repo_folder_name`, etc. It would clarify exactly
+// what those calls are doing, but would lock in implementation
+session_vars.save_runtime_config_var = function ({ key, value }) {
+  /** Write to the runtime config file by adding a key/value pair to
+  *   the json object there.
+  * 
+  * @param key {str} Key to use to store `value` in runtime config file
+  * @param value {any} Value to store in runtime config file
+  * 
+  * @returns file {binary?} Runtime config file
+  */
 
   // Ensure runtime config file exists
   if ( !fs.existsSync( runtime_config_path ) ) {
@@ -253,23 +299,34 @@ session_vars.save_repo_folder_name = function (repo_folder_name) {
 
   // Get the json, changing it, and re-write the file from scratch
   let json = JSON.parse( fs.readFileSync( runtime_config_path ) );
-  json[ repo_folder_key ] = repo_folder_name;
+  json[ key ] = value;
   let file = fs.writeFileSync( runtime_config_path, JSON.stringify( json, null, 2 ) );
 
+  if ( session_vars.get_debug() ) {
+    console.log( `ALKiln debug runtime config var: Stored "${key}" locally as "${value}".` );
+  }
   return file;
-};  // Ends session_vars.save_repo_folder_name()
+};  // Ends session_vars.save_runtime_config_var()
 
-session_vars.get_repo_folder_name = function () {
-  /** Get the name of the main folder in the repository. */
+session_vars.get_runtime_config_var = function ( key ) {
+  /** Get the value of the given key from the runtime config file.
+  * 
+  * @param key {str} Key in runtime config file that contains the desired value
+  * @returns value | null {any} Value of key in runtime config file. If it
+  *    doesn't exist, returns null.
+  */
   try {
     let json = JSON.parse( fs.readFileSync( runtime_config_path ));
-    let name = json[ repo_folder_key ];
+    let value = json[ key ];
+    if ( session_vars.get_debug() ) {
+      console.log( `ALKiln debug runtime config var: "${key}"" is "${value}".` );
+    }
 
-    return name;
+    return value;
   } catch ( error ) {
     return null;
   }
-};  // Ends session_vars.get_repo_folder_name()
+};  // Ends session_vars.get_runtime_config_var()
 
 
 session_vars.set_sources_paths = function ( paths ) {
@@ -320,7 +377,7 @@ session_vars.set_sources_paths = function ( paths ) {
   // Otherwise, store valid paths
   session_vars._sources_paths = existing_paths;
   return true;
-};
+};  // End session_vars.set_sources_paths()
 
 session_vars.get_sources_paths = function () {
   /** Get the "sources" folder path. Should never be undefined during
@@ -331,6 +388,7 @@ session_vars.get_sources_paths = function () {
   return session_vars._sources_paths;
 };
 
+
 session_vars.validateEnvironment = function() {
   /** Throw a useful error for the developer if any of the env vars
   *    required by absolutely all tests are missing. Gather all
@@ -395,36 +453,3 @@ session_vars.validateEnvironment = function() {
 };
 
 session_vars.validateEnvironment();
-
-
-const save_runtime_config_var = function (key, value) {
-  /** Save a key and its value in the runtime config file. */
-
-  // Ensure runtime config file exists
-  if ( !fs.existsSync( runtime_config_path ) ) {
-    // If the file doesn't exist, make one because next we need to read it
-    fs.writeFileSync( runtime_config_path, JSON.stringify( {}, null, 2 ) );
-  }
-
-  // Get the json, changing it, and re-write the file from scratch
-  let json = JSON.parse( fs.readFileSync( runtime_config_path ) );
-  json[ key ] = value;
-  let file = fs.writeFileSync( runtime_config_path, JSON.stringify( json, null, 2 ) );
-
-  if ( session_vars.get_debug() ) {
-    console.log( `ALKiln debug: Stored "${key}" locally as "${value}".` );
-  }
-  return file;
-};  // Ends save_runtime_config_var()
-
-const get_runtime_config_var = function (key) {
-  /** Get the value of the given key from the runtime config file. */
-  try {
-    let json = JSON.parse( fs.readFileSync( runtime_config_path ));
-    let value = json[ key ];
-
-    return value;
-  } catch ( error ) {
-    return null;
-  }
-};  // Ends get_runtime_config_var()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suffolklitlab/alkiln",
-  "version": "5.4.1-feat-github-server-18",
+  "version": "5.4.1-feat-github-server-19",
   "description": "Integrated automated end-to-end testing with docassemble, puppeteer, and cucumber.",
   "main": "lib/index.js",
   "scripts": {