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

package/CHANGELOG.md

@@ -42,8 +42,14 @@ Format:
 ### Internal
 - 
 -->
+
 <!-- ## [Unreleased] -->
 
+## [5.4.2] - 2023-10-22
+
+### Changed
+- Downloads are now faster! You won't have to wait for the full duration of a step (30 seconds by default) to download a file anymore. See [this PR](https://github.com/SuffolkLITLab/ALKiln/pull/798) for more details.
+
 ## [5.4.1] - 2023-10-18
 
 ### Internal

package/action.yml

@@ -22,15 +22,6 @@ inputs:
     description: "Max amount of time to give the server to reload if it needs to"
     required: false
     # no default to let the custom Scenario timeouts create the reload timeout
-  # INSTALL_LOCATION? Will that get confused with the location passed into the command line?
-  # Maybe `INSTALL_LOCATION` could be "playground", "server", or a custom path and we could handle all those.
-  INSTALL_METHOD:
-    description: "Default is 'playground'. Other option: 'server'. How to install the package onto the server."
-    required: false
-    default: "playground"
-  ALKILN_TAG_EXPRESSION:
-    description: "The tag expression to use to limit which tests to run. Default is no tag expression."
-    required: false
 
 runs:
   using: "composite"
@@ -55,43 +46,29 @@ runs:
         echo -e "\nALKiln version is $ALKILN_VERSION\nRepo is $REPO_URL\nBranch ref is $BRANCH_PATH\nMAX_SECONDS_FOR_SETUP is $MAX_SECONDS_FOR_SETUP\nSERVER_RELOAD_TIMEOUT_SECONDS is $SERVER_RELOAD_TIMEOUT_SECONDS\n"
       shell: bash
 
-    # Install
+    # Install node
     - name: "ALKiln: Install node packages"
       uses: actions/setup-node@v3
       with:
         node-version: "18"
     - name: Install ALKiln directly from npm
       run: |
-        npm install -g @suffolklitlab/alkiln@$ALKILN_VERSION
+        npm install -g @suffolklitlab/alkiln
       shell: bash
 
-    # Install on playground
+    # Run tests
     - name: "ALKiln: Create a Project and pull the package from GitHub"
-      if: ${{ inputs.INSTALL_METHOD == 'playground' }}
       run: alkiln-setup
       shell: bash
-    - run: echo -e "\n\n====\nALKiln could not create a project on your server's testing account or pull your package into it. Check the messages above this line.\n\n"
-      if: ${{ inputs.INSTALL_METHOD == 'playground' && failure() }}
-      shell: bash
-
-    # Install on server
-    - name: "ALKiln: Install the GitHub package onto the server"
-      if: ${{ inputs.INSTALL_METHOD == 'server' }}
-      run: alkiln-server-install
-      shell: bash
-    - run: echo -e "\n\n====\nALKiln could not install the package on the temporary GitHub docassemble server. Check the steps above this line.\n\n"
-      if: ${{ inputs.INSTALL_METHOD == 'server' && failure() }}
-      shell: bash
-
-    # run tests
     - name: "ALKiln: Run tests"
       if: ${{ success() }}
-      run: alkiln-run ${{ inputs.ALKILN_TAG_EXPRESSION || github.event.inputs.tags && format('{0}', github.event.inputs.tags) }}
+      run: alkiln-run ${{ github.event.inputs.tags && format('{0}', github.event.inputs.tags) }}
       shell: bash
-    
-    # on playground, delete project
-    - name: "ALKiln: Try to delete the project from the playground of the docassemble test account."
-      if: ${{ inputs.INSTALL_METHOD == 'playground' }}
+    - run: echo -e "\n\n====ALKiln could not create a project on your server's testing account or pull your package into it. Check the messages above this line.\n\n"
+      if: ${{ failure() }}
+      shell: bash
+    - name: "ALKiln: Delete project from docassemble test account"
+      if: ${{ always() }}
       run: alkiln-takedown
       shell: bash
     
@@ -104,7 +81,7 @@ runs:
         path: ./alkiln-*
 
 # ##################################
-# # A developer's workflow should look similar to the below.
+# # A developer's workflow should look similar to the below
 # # In place of `uses: suffolkLITLab/ALKiln@v5`, they
 # # might use another version.
 #

package/lib/docassemble/docassemble_api_REST.js

@@ -79,21 +79,13 @@ da.pull = async function ( timeout ) {
 };  // Ends da.pull()
 
 
-da.has_playground_task_finished = async function ( task_id, timeout ) {
-  return await da.has_task_finished( "/api/restart_status", task_id, timeout);
-}
-
-da.has_package_task_finished = async function ( task_id, timeout ) {
-  return await da.has_task_finished( "/api/package_update_status", task_id, timeout);
-}
-
 // node -e 'require("./lib/docassemble/docassemble_api_REST.js").has_task_finished()'
-da.has_task_finished = async function ( api_endpoint, task_id, timeout ) {
+da.has_task_finished = async function ( task_id, timeout ) {
   /* Check task status based on `task_id`. */
   let options = {
     method: 'GET',
     headers: {'X-API-Key': session_vars.get_dev_api_key()},
-    url: `${ session_vars.get_da_server_url() }${ api_endpoint }`,
+    url: `${ session_vars.get_da_server_url() }/api/restart_status`,
     params: {
       task_id: task_id,
     },

package/lib/docassemble/docassemble_api_interface.js

@@ -329,8 +329,9 @@ da_i.pull = async function ( pull_options ) {
   }
 };  // Ends da_i.pull()
 
+
 // node -e 'require("./lib/docassemble/docassemble_api_interface.js").has_task_finished()'
-da_i.has_task_finished = async function ( api_endpoint, task_id, options ) {
+da_i.has_task_finished = async function ( task_id, options ) {
   /** Check task status if it exists. If not, return true as task did
   *    not require a server restart. See da_i.pull().
   *    See https://docassemble.org/docs/api.html#restart_status. */
@@ -341,7 +342,7 @@ da_i.has_task_finished = async function ( api_endpoint, task_id, options ) {
   try {
 
     // If server did need to restart, check if it's done.
-    let response = await _da_REST.has_task_finished( api_endpoint, task_id, timeout );
+    let response = await _da_REST.has_task_finished( task_id, timeout );
     log.debug({ pre: `Task status: ${ response.status }. Docassemble status text: ${ response.data.status }. Task id: ${ task_id }` });
     
     if ( response.data.status === 'completed' ) {
@@ -352,15 +353,16 @@ da_i.has_task_finished = async function ( api_endpoint, task_id, options ) {
       return false;
 
     } else if ( response.data.status === 'unknown' ) {
-      // Server is working, but status 'unknown'? Bad design, but this
-      // does get returned when install packages, so return true
+      // Server is working, but status 'unknown'? We shouldn't even
+      // get here according to the API docs, but it feels weird to have
+      // no default behavior. What to return? Throw?
       log.info({
         pre: `\`task_id\` "${ task_id }" has expired. If it's been `
           + `less than 1 hour since the task started, the task is `
           + `complete. See https://docassemble.org/docs/api.html#restart_status.`,
-        data: response.data,
+        data: response,
       });
-      return true;
+      return null;
     }  // ends status type
 
   } catch ( error ) {
@@ -376,15 +378,8 @@ da_i.has_task_finished = async function ( api_endpoint, task_id, options ) {
 
 };  // Ends da_i.has_task_finished()
 
-da_i.wait_for_playground_to_restart = async ( task_id, options ) => {
-  return await da_i.wait_for_server_to_restart( "/api/restart_status", task_id, options );
-};
-
-da_i.wait_for_package_to_restart = async ( task_id, options ) => {
-  return await da_i.wait_for_server_to_restart( "/api/package_update_status", task_id, options );
-};
 
-da_i.wait_for_server_to_restart = async ( api_endpoint, task_id, options ) => {
+da_i.wait_for_server_to_restart = async ( task_id, options ) => {
   /** Wait for the server to finish restarting in case a module needs to load.
   *     This is a polling function because things may be returned
   *     that aren't equivalent to the server being done with a task. */
@@ -415,7 +410,7 @@ da_i.wait_for_server_to_restart = async ( api_endpoint, task_id, options ) => {
   while ( !done_restarting && num_tries <= max_loops ) {
     num_tries++;
     // Wait only a short time for the task to finish, not the full default timeout
-    done_restarting = await da_i.has_task_finished( api_endpoint, task_id, { timeout: wait_for_response } );
+    done_restarting = await da_i.has_task_finished( task_id, { timeout: wait_for_response } );
     if ( !done_restarting ) {
       if ( num_tries < max_loops ) {
         // Show a slightly different message after a number of tries to reassure

package/lib/docassemble/get_base_interview_url.js

@@ -10,20 +10,10 @@ let get_base_interview_url = async function () {
   *    When finishing a test, we go to the sign out page (which is supposed to help even
   *    when the user is not logged in.) We can't use `reset=2` because it caused an
   *    'Unable to locate interview session' error. */
-
   let server_url = session_vars.get_da_server_url();
-
-  if (session_vars.get_install_method() === `server`) {
-
-    return `${ server_url }/interview?new_session=1&i=docassemble.${session_vars.get_repo_folder_name()}%3Adata/questions/`;
-
-  } else {
-
-    let dev_id = await docassemble_api_interface.get_dev_id();
-    let project_name = session_vars.get_project_name();
-    return `${ server_url }/interview?new_session=1&i=docassemble.playground${ dev_id }${ project_name }%3A`;
-
-  }
+  let dev_id = await docassemble_api_interface.get_dev_id();
+  let project_name = session_vars.get_project_name();
+  return `${ server_url }/interview?new_session=1&i=docassemble.playground${ dev_id }${ project_name }%3A`;
 };
 
 module.exports = get_base_interview_url;

package/lib/docassemble/setup.js

@@ -39,7 +39,7 @@ const setup = async () => {
   let task_id = await da_i.pull();
   // Task id will be null if server did not need to restart
   if ( task_id ) {
-    await da_i.wait_for_playground_to_restart( task_id );
+    await da_i.wait_for_server_to_restart( task_id );
   }
 
   // Finish

package/lib/scope.js

@@ -46,9 +46,6 @@ let printable_var_value = function(row) {
   /* `row` might be a row, a source row, or an original row. */
   let original = get_original_row(row);
   if ( is_secret_var(original) ) {
-    if ( session_vars.get_dangerous_debug() ) {
-      return `alkiln_dangerous ${ row.value }`;
-    }
     return original.flags.secret_name;
   }
   return row.value;
@@ -2440,10 +2437,6 @@ module.exports = {
       /** Sets a non-story table variable to a "secret" value (i.e. an env var) */
       // Prevent pictures of a screen with a secret.
       scope.disable_error_screenshot = true;
-      if ( session_vars.get_dangerous_debug() ) {
-        scope.disable_error_screenshot = false;
-      }
-
       let var_data = await scope.normalizeTable( scope, {
               var_data: [{
                 var: var_name,
@@ -2492,10 +2485,39 @@ module.exports = {
       if ( !elem ) { reports.addToReport(scope, { type: `error`, value: msg }); }
       expect( elem, msg ).to.exist;
 
-      scope.toDownload = filename;
-      // Should this be using `scope.tapElement()`?
-      await elem.evaluate( elem => { return elem.click(); });
-      await scope.detectDownloadComplete( scope );
+      let failed_to_download = false;
+      let err_msg = "";
+      try {
+        const binaryStr = await scope.page.evaluate(el => {
+          const url = el.getAttribute("href");
+          return new Promise(async (resolve, reject) => {
+            const response = await fetch(url, {method: "GET"});
+            const reader = new FileReader();
+            reader.readAsBinaryString(await response.blob());
+            reader.onload = () => resolve(reader.result);
+            reader.onerror = () => reject(`Error occurred on page when downloading ${ url }: ${ reader.error }`);
+          });
+        }, elem);
+        if (binaryStr !== '') {
+          const fileData = Buffer.from(binaryStr, 'binary');
+          fs.writeFileSync(`${ scope.paths.scenario }/${ filename }`, fileData);
+          reports.addToReport(scope, { type: `info`, value: `Downloaded ${ filename } (${ fileData.length } bytes) to ${ scope.paths.scenario }`});
+        } else {
+          failed_to_download = true;
+          err_msg = `Couldn't download ${ filename }, binary data for download was empty`;
+        }
+      } catch (error) {
+        failed_to_download = true;
+        err_msg = error;
+      }
+
+      if (failed_to_download) {
+        reports.addToReport(scope, { type: `warning`, value: `Could not download file using fetch (${ err_msg }). ALKiln will now fallback to the click download method` });
+        scope.toDownload = filename;
+        // Should this be using `scope.tapElement()`?
+        await elem.evaluate( elem => { return elem.click(); });
+        await scope.detectDownloadComplete( scope );
+      }
     },  // Ends scope.steps.download()
 
     compare_pdfs: async function (scope, {existing_pdf_path, new_pdf_path}) {
@@ -2613,10 +2635,7 @@ module.exports = {
       */
       // Don't take a picture of a failed login in case one of the inputs is correct
       scope.disable_error_screenshot = true;
-      if ( session_vars.get_dangerous_debug() ) {
-        scope.disable_error_screenshot = false;
-      }
-      
+
       // If there is no browser open, start a new one
       if (!scope.browser) {
         scope.browser = await scope.driver.launch({ headless: !session_vars.DEBUG });
@@ -2649,10 +2668,6 @@ module.exports = {
       let email = process.env[ email_secret_name ];
       let password = process.env[ password_secret_name ];
 
-      if ( session_vars.get_dangerous_debug() ) {
-        log.debug({ type: `unsafe`, data: `login: ${ email }, ${ password }` });
-      }
-
       // Give as many useful messages to the user as possible if the env vars
       // aren't defined. Eventually, just provide a link to the docs because
       // this is complex

package/lib/steps.js

@@ -203,7 +203,6 @@ Given(/I start the interview at "([^"]+)"/, {timeout: -1}, async (file_name) =>
   scope.page.on('response', async response => {
     // Note: We can expect that only one file will be getting downloaded
     // at any one time since each step completes synchronously
-
     // If response has a file in it that matches the file we are downloading
     // Sadly, 'content-disposition' isn't working. We're not sure what will.
     if ( response.headers()['content-disposition'] && (response.headers()['content-disposition']).includes(`attachment;filename=${scope.toDownload}`) ) {

package/lib/utils/log.js

@@ -42,7 +42,7 @@ log.error = function ({ type='', pre='', data='', post='' }) {
 
 log.debug = function ({ type='', pre='', data='', post='' }) {
   /* If debugging is turned on, log a message that includes `ALKiln` and `debug` */
-  if ( session_vars.get_debug() || session_vars.get_dangerous_debug() ) {
+  if ( session_vars.get_debug() ) {
     let start = create_msg_start([ type, 'debug' ], pre );
     // Log them each on a separate line
     console.log( `ALKiln ${ type } debug: ${ pre }` );

package/lib/utils/session_vars.js

@@ -24,11 +24,6 @@ module.exports = session_vars;
 // These default to null
 // TODO: How to isolate debug elsewhere so this file can use the logger?
 session_vars.get_debug = function () { return process.env.DEBUG || null; };
-session_vars.get_dangerous_debug = function () {
-  /** Note this will cause failure of tests that reassure the user about
-  *   security precautions we took, like not taking a screenshot. */
-  return process.env._ALKILN_DANGEROUS_DEBUG || null;
-};
 session_vars.is_dev_env = function () { return process.env.DEV || null; }
 
 session_vars.get_dev_api_key = function () { return process.env.DOCASSEMBLE_DEVELOPER_API_KEY || null; };
@@ -178,120 +173,8 @@ 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. */
-  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. */
-  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_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 ) );
-  // }
-
-  // // 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_method()
-
-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_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
+  // 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 ) );
@@ -299,35 +182,27 @@ session_vars.save_runtime_config_var = function ({ key, value }) {
 
   // Get the json, changing it, and re-write the file from scratch
   let json = JSON.parse( fs.readFileSync( runtime_config_path ) );
-  json[ key ] = value;
+  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 runtime config var: Stored "${key}" locally as "${value}".` );
+    console.log( `ALKiln debug: Stored name of artifacts directory "${ path_name }" locally.` );
   }
   return file;
-};  // Ends session_vars.save_runtime_config_var()
+};  // Ends save_artifacts_path_name()
 
-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.
-  */
+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 value = json[ key ];
-    if ( session_vars.get_debug() ) {
-      console.log( `ALKiln debug runtime config var: "${key}"" is "${value}".` );
-    }
+    let path_name = json[ artifacts_path_key ];
 
-    return value;
+    if ( session_vars.get_debug() ) { console.log( `ALKiln debug: Artifacts directory is "${ path_name }".` ); }
+    return path_name;
   } catch ( error ) {
     return null;
   }
-};  // Ends session_vars.get_runtime_config_var()
-
+};  // Ends get_artifacts_path_name()
 
 session_vars.set_sources_paths = function ( paths ) {
   /** Returns whether at least one of the given path exists. Store
@@ -360,7 +235,7 @@ session_vars.set_sources_paths = function ( paths ) {
   // Warn about missing paths
   if ( missing_paths.length > 0 ) {
     console.warn(
-      `ALKiln WARNING: ALKiln can't find folders at "${ paths.join('", "') }".`
+      `ALKiln WARNING: ALKiln can't find folders at "${ paths.join(", ") }".`
     );
   }
 
@@ -370,14 +245,10 @@ session_vars.set_sources_paths = function ( paths ) {
     return false;
   }
 
-  console.info(
-    `ALKiln info: Did find "sources" folder(s) at "${ existing_paths.join('", "') }".`
-  )
-
   // 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
@@ -388,7 +259,6 @@ 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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suffolklitlab/alkiln",
-  "version": "5.4.1-feat-github-server-19",
+  "version": "5.4.2",
   "description": "Integrated automated end-to-end testing with docassemble, puppeteer, and cucumber.",
   "main": "lib/index.js",
   "scripts": {
@@ -9,7 +9,6 @@
     "local": "npm run setup && npm run cucumber; npm run takedown",
     "setup": "./lib/docassemble/setup.js",
     "takedown": "./lib/docassemble/takedown.js",
-    "server_install": "./lib/docassemble/server_install.js",
     "unit": "mocha tests/unit_tests/*.test.*"
   },
   "repository": {
@@ -51,7 +50,6 @@
     "diff": "5.0.0"
   },
   "bin": {
-    "alkiln-server-install": "./lib/docassemble/server_install.js",
     "alkiln-setup": "./lib/docassemble/setup.js",
     "alkiln-takedown": "./lib/docassemble/takedown.js",
     "alkiln-run": "./lib/run_cucumber.js"

package/setup.py

@@ -50,10 +50,10 @@ setup(name='docassemble.ALKilnTests',
       author='plocket',
       author_email='example@example.com',
       license='The MIT License (MIT)',
-      url='https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln',
+      url='https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/automated_integrated_testing',
       packages=find_packages(),
       namespace_packages=['docassemble'],
-      install_requires=['docassemble.ALToolbox>=0.8.2', 'docassemble.AssemblyLine>=2.24.0'],
+      install_requires=['docassemble.ALToolbox>=0.5.1'],
       zip_safe=False,
       package_data=find_package_data(where='docassemble/ALKilnTests/', package='docassemble.ALKilnTests'),
      )

package/.github/workflows/github_server.yml

@@ -1,77 +0,0 @@
-name: GitHub server tests
-
-on:
-  push:
-  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)'
-      enable_tmate:
-        type: boolean
-        description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'
-        required: false
-        default: false
-      # TODO: alkiln_version:
-
-jobs:
-
-  github-server-tests:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [18.x]
-
-    env:
-      # 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
-      
-    steps:
-      # Place the root directory in this branch
-      - uses: actions/checkout@v3
-
-      # Debugging. Maybe add a long sleep after whatever it is we want to check
-      # to give us time to explore.
-      - name: Setup tmate session
-        if: ${{ inputs.enable_tmate }}
-        uses: mxschmitt/action-tmate@v3
-        with:
-          detached: true
-
-      - name: Start the temporary GitHub server
-        id: github_server
-        uses: ./github_server
-        with:
-          CONFIG_CONTENTS: "${{ secrets.CONFIG_CONTENTS }}"
-      - run: echo "Finished starting the GitHub server"
-
-      # Debugging on failure
-      # Trying to catch that intermittent bug mentioned in ./github_server/action.yml
-      - name: Docker failure tmate session
-        if: ${{ failure() }}
-        uses: mxschmitt/action-tmate@v3
-
-      - name: Env vars from server output
-        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: |
-      #    container_name=$(docker ps --format '{{.Names}}' | head -n 1)
-      #    echo "container_name is $container_name"
-
-      - name: "Run ALKiln tests"
-        if: ${{ success() }}
-        uses: ./
-        with:
-          SERVER_URL: "${{ steps.github_server.outputs.SERVER_URL }}"
-          DOCASSEMBLE_DEVELOPER_API_KEY: "${{ steps.github_server.outputs.DOCASSEMBLE_DEVELOPER_API_KEY }}"
-          INSTALL_METHOD: "server"
-          # TODO: See what happens if this is an empty string
-          ALKILN_VERSION: "server"
-          #ALKILN_TAG_EXPRESSION: "@al1"
-      - run: echo "Finished running ALKiln tests"
-

package/github_server/action.yml

@@ -1,126 +0,0 @@
-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."
-
-# 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
-# using git checkout to select a particular version, and then using docker build
-# to build an image. https://docassemble.org/docs/docker.html#downgrading
-# If we just want to use an older version of da (as long as it works with
-# the latest image):
-# If you have an existing container you can use dainstall from the command
-# line to install docassemble.webapp==1.4.68
-
-inputs:
-  CONFIG_CONTENTS:
-    description: "The contents of the config file of the docassemble server"
-    required: false
-  MAX_SECONDS_FOR_DOCKER:
-    description: "Maximum amount of seconds to give the docassemble docker container to serve the site."
-    required: false
-    default: 600  # 10 min
-
-outputs:
-  DOCASSEMBLE_DEVELOPER_API_KEY:
-    description: "Use this inside `with:` for the ALKiln step. Temporary admin api key. It will be destroyed after the tests are done."
-    value: ${{ steps.api_key_output_step.outputs.DOCASSEMBLE_DEVELOPER_API_KEY }}
-  SERVER_URL:
-    description: "Use this inside `with:` for the ALKiln step. URL of the temporary docassemble server."
-    value: "http://localhost"
-  DA_ADMIN_EMAIL:
-    value: ${{ steps.api_key_output_step.outputs.DA_ADMIN_EMAIL }}
-  DA_ADMIN_PASSWORD:
-    value: ${{ steps.api_key_output_step.outputs.DA_ADMIN_PASSWORD }}
-
-
-runs:
-  using: "composite"
-  steps:
-      - uses: actions/checkout@v3
-
-      - name: "ALKiln github_server: Set environment variables"
-        run: |
-          echo "DA_ADMIN_API_KEY=abcd1234abcd1234abcd5678abdc5678" >> $GITHUB_ENV
-          echo "MAX_SECONDS_FOR_DOCKER=${{ inputs.MAX_SECONDS_FOR_DOCKER }}" >> $GITHUB_ENV
-          echo "DA_ADMIN_EMAIL=admin@example.com" >> $GITHUB_ENV
-          # Login will fail if this is "password"
-          echo "DA_ADMIN_PASSWORD=@123abcdefg" >> $GITHUB_ENV
-        shell: bash
-      - id: api_key_output_step
-        run: |
-          echo "DOCASSEMBLE_DEVELOPER_API_KEY=$DA_ADMIN_API_KEY" >> "$GITHUB_OUTPUT"
-          echo "DA_ADMIN_EMAIL=$DA_ADMIN_EMAIL" >> "$GITHUB_OUTPUT"
-          echo "DA_ADMIN_PASSWORD=$DA_ADMIN_PASSWORD" >> "$GITHUB_OUTPUT"
-        shell: bash
-
-      - name: "ALKiln github_server: Download and start docker"
-        run: |
-          mkdir /tmp/config
-          echo "${{ inputs.CONFIG_CONTENTS }}" > /tmp/config/myconfig.yml
-          docker pull 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: |
-          # ALKiln github_server: Wait for server to start
-
-          # Reset the SECONDS variable
-          SECONDS=0
-          # Wait 1 minute before pinging the server constantly
-          sleep 60
-
-          response="start"
-
-          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 1
-            fi
-
-            # Set the variable to a new string value in each iteration
-            response=$(curl -o /dev/null -s -w "%{http_code}\n" http://localhost:80/health_check?ready=1)
-            echo "response is $response"
-
-            # Check if the string includes the desired text
-            if [[ $response == *"200"* ]]; then
-              echo "Success! The docker container is ready!"
-            else
-              echo "The docker container isn't ready yet. Will check again in 30 seconds."
-              sleep 30
-            fi
-
-          done
-        shell: bash
-
-      # Don't rely on the environment's version of python
-      - uses: actions/setup-python@v4
-        with:
-          python-version: '3.10'
-      - run: pip install docassemblecli
-        shell: bash
-      # Install the current directory onto the docassemble server
-      - run: dainstall . --apiurl http://localhost --apikey $DA_ADMIN_API_KEY
-        shell: bash
-
-      # TODO: Upload artifacts that subscribers can download on the Actions summary page
-      - name: "ALKiln github_server: Docker logs"
-        if: ${{ always() }}
-        run: |
-          # Should this name have a date/time attached? The logs themselves have timestamps
-          echo "$(docker logs docassemble_container)" > /tmp/alkiln_docker_logs.txt
-        shell: bash
-      
-      - name: "ALKiln github_server: Get folder name with date and time"
-        if: ${{ always() }}
-        run: |
-          echo "GITHUB_SERVER_ARTIFACT_NAME=alkiln-github-server-$(date +'%Y-%m-%d at %Hh%Mm%Ss' -u)UTC" >> $GITHUB_ENV
-        shell: bash
-      - name: "ALKiln github_server: Upload artifacts folder"
-        if: ${{ always() }}
-        uses: actions/upload-artifact@v3
-        with:
-          name: ${{ env.GITHUB_SERVER_ARTIFACT_NAME }}
-          path: /tmp/alkiln_docker_logs.txt

package/lib/docassemble/server_install.js

@@ -1,40 +0,0 @@
-#!/usr/bin/env node
-
-const session_vars = require('../utils/session_vars');
-const log = require('../utils/log');
-const fg = require('fast-glob');
-
-const server_install = async () => {
-  session_vars.save_install_method(`server`);
-
-  let current_dir = process.cwd();
-  let path = `${ current_dir }/docassemble/*`;
-  let dirs = fg.sync(
-    [ path ],
-    {
-      suppressErrors: true,
-      onlyDirectories: true
-    }
-  );
-
-  let folders = dirs.map(function (dir) { return dir.split('/').pop(); })
-
-  let chosen_folder = folders[0];
-  if ( folders.length === 0 ) {
-    let msg = `There are 0 folders at ${path}. Tests won't run.`;
-    log.error({ type: `setup`, data: msg })
-    throw new ReferenceError( msg );
-  }
-
-  if ( folders.length > 1 ) {
-    log.warn({
-      type: `setup`,
-      data: `There are ${folders.length} folders at ${path}: "${folders.join('", "')}". ALKiln chose to use the folder "${chosen_folder}".`
-    })
-  }
-
-  console.log(`\n===========\nchosen_folder: ${chosen_folder}\n===========\n`);
-  session_vars.save_repo_folder_name( chosen_folder );
-};  // Ends server_install();
-
-server_install();