@suffolklitlab/alkiln 5.0.2-feat-github-server-8 → 5.0.2-feat-github-server-10

package/.github/workflows/github_server.yml

@@ -8,10 +8,10 @@ on:
       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: '@e6 or @al1'
+        # # 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)'
@@ -33,6 +33,7 @@ jobs:
       SECRET_VAR1: secret-var1-value
       SECRET_VAR2: secret-var2-value
       SECRET_FOR_MISSING_FIELD: secret for missing field
+      _ALKILN_DANGEROUS_DEBUG: true
       
     steps:
       - uses: actions/checkout@v3
@@ -49,10 +50,6 @@ jobs:
           CONFIG_CONTENTS: "${{ secrets.CONFIG_CONTENTS }}"
       - run: echo "Finished starting the GitHub server"
 
-      ## Temp
-      #- name: Setup tmate session
-      #  uses: mxschmitt/action-tmate@v3
-
       - name: "Run ALKiln tests"
         if: ${{ success() }}
         uses: ./
@@ -60,6 +57,7 @@ jobs:
           SERVER_URL: "${{ steps.github_server.outputs.SERVER_URL }}"
           DOCASSEMBLE_DEVELOPER_API_KEY: "${{ steps.github_server.outputs.DOCASSEMBLE_DEVELOPER_API_KEY }}"
           INSTALL_METHOD: "server"
-          ALKILN_VERSION: "5.0.2-feat-github-server-8"
+          # TODO: See what happens if this is an empty string
+          ALKILN_VERSION: "5.0.2-feat-github-server-10"
       - run: echo "Finished running ALKiln tests"
 

package/action.yml

@@ -81,17 +81,14 @@ runs:
       if: ${{ inputs.INSTALL_METHOD == 'server' && failure() }}
       shell: bash
 
-    ## debugging
-    #- name: Setup tmate session
-    #  uses: mxschmitt/action-tmate@v3
-
     ############
     ##### !!! WARNING: RESTORE CODE FOR TAGS
     ############
     # run tests
     - name: "ALKiln: Run tests"
       if: ${{ success() }}
-      run: alkiln-run @e6 or @al1
+      # run: alkiln-run @e6 or @al1
+      run: alkiln-run @e6
       shell: bash
 
     #  run: alkiln-run ${{ github.event.inputs.tags && format('{0}', github.event.inputs.tags) }}

package/github_server/action.yml

@@ -1,12 +1,14 @@
 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."
 
-# Wat?
+# Wat? Exit with 52?
 # 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:
+# https://github.com/SuffolkLITLab/ALKiln/actions/runs/5914677262/job/16040233419
 
 inputs:
   CONFIG_CONTENTS:
@@ -24,6 +26,12 @@ outputs:
   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 }}
+    value: "admin@example.com"
+  DA_ADMIN_PASSWORD:
+    #value: ${{ steps.api_key_output_step.outputs.DA_ADMIN_PASSWORD }}
+    value: "password"
 
 
 runs:
@@ -36,9 +44,14 @@ runs:
           echo "CLONE_URL=${{ github.server_url }}/${{ github.repository }}.git" >> $GITHUB_ENV
           echo "OWNER_AND_REPO_NAME=${{ github.repository }}" >> $GITHUB_ENV
           echo "BRANCH_REF=${{ github.ref }}" >> $GITHUB_ENV
+          echo "DA_ADMIN_EMAIL=admin@example.com" >> $GITHUB_ENV
+          echo "DA_ADMIN_PASSWORD=password" >> $GITHUB_ENV
         shell: bash
       - id: api_key_output_step
-        run: echo "::set-output name=DOCASSEMBLE_DEVELOPER_API_KEY::$DA_ADMIN_API_KEY"
+        run: |
+          echo "::set-output name=DOCASSEMBLE_DEVELOPER_API_KEY::$DA_ADMIN_API_KEY"
+          echo "::set-output name=DA_ADMIN_EMAIL::$DA_ADMIN_EMAIL"
+          echo "::set-output name=DA_ADMIN_PASSWORD::$DA_ADMIN_PASSWORD"
         shell: bash
       - name: "github_server: Download and start docker"
         run: |
@@ -71,8 +84,8 @@ runs:
               break
             fi
 
-            ## Set the variable to a new string value in each iteration
-            #result=$(curl -s localhost)
+            # Set the variable to a new string value in each iteration
+            result=$(curl -s localhost)
 
             # Check if the string includes the desired text
             if [[ ! $result == *"Docassemble is starting"* ]]; then
@@ -88,19 +101,19 @@ runs:
 
       - name: Install the package
         run: |
-          echo $CLONE_URL
+          echo "CLONE_URL is $CLONE_URL"
           git clone $CLONE_URL
 
           # Split the full repository name by '/' and get the last element (repo name)
           IFS='/' read -ra repo_parts <<< "$OWNER_AND_REPO_NAME"
           repo_name=${repo_parts[-1]}
-          echo $repo_name
+          echo "repo_name is $repo_name"
           cd $repo_name
 
-          echo "branch ref $BRANCH_REF"
+          echo "BRANCH_REF is $BRANCH_REF"
           ref_name=$BRANCH_REF
           branch_name="${ref_name#refs/heads/}"
-          echo "branch name: $branch_name"
+          echo "branch name is $branch_name"
           git checkout -b $branch_name
           git fetch origin $branch_name
           git reset --hard origin/$branch_name

package/lib/docassemble/get_base_interview_url.js

@@ -11,18 +11,12 @@ let get_base_interview_url = async function () {
   *    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();
-  console.log(session_vars.get_install_type());
   if (session_vars.get_install_type() === "server") {
-    let x = `${ server_url }/interview?new_session=1&i=docassemble.${session_vars.get_package_name().replace("-", ".")}%3Adata/questions/`;
-    // e.g. http://localhost/interview?new_session=1&i=ALKiln%3A
-    console.log(`base_interview_url: ${x}`)
-    return x;
+    return `${ server_url }/interview?new_session=1&i=docassemble.${session_vars.get_package_name().replace("-", ".")}%3Adata/questions/`;
   } else {
     let dev_id = await docassemble_api_interface.get_dev_id();
     let project_name = session_vars.get_project_name();
-    let x = `${ server_url }/interview?new_session=1&i=docassemble.playground${ dev_id }${ project_name }%3A`;
-    console.log(`base_interview_url: ${x}`)
-    return x;
+    return `${ server_url }/interview?new_session=1&i=docassemble.playground${ dev_id }${ project_name }%3A`;
   }
 };
 

package/lib/scope.js

@@ -44,6 +44,9 @@ 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;
@@ -755,7 +758,7 @@ module.exports = {
     if ( session_vars.get_debug() ) { console.log( `interview_url:`, interview_url ); }
 
     if ( !scope.page ) { scope.page = await scope.browser.newPage(); }
-    
+
     console.log(`interview_url:`, interview_url);
 
     // TODO: implement and use scope.handle_possible_timeout()
@@ -2522,6 +2525,10 @@ 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,
@@ -2665,7 +2672,10 @@ 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 });
@@ -2698,6 +2708,10 @@ 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/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() ) {
+  if ( session_vars.get_debug() || session_vars.get_dangerous_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

@@ -23,6 +23,7 @@ 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 () { 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; };

package/package.json

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

package/setup.py

@@ -53,7 +53,7 @@ setup(name='docassemble.ALKiln',
       url='https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/automated_integrated_testing',
       packages=find_packages(),
       namespace_packages=['docassemble'],
-      install_requires=['docassemble.ALToolbox>=0.5.1'],
+      install_requires=['docassemble.ALToolbox>=0.8.2', 'docassemble.AssemblyLine>=2.24.0'],
       zip_safe=False,
       package_data=find_package_data(where='docassemble/ALKiln/', package='docassemble.ALKiln'),
      )