@suffolklitlab/alkiln 5.0.2-feat-github-server-7 → 5.0.2-feat-github-server-9

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
@@ -56,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-7"
+          # TODO: See what happens if this is an empty string
+          ALKILN_VERSION: "5.0.2-feat-github-server-9"
       - run: echo "Finished running ALKiln tests"
 

package/action.yml

@@ -53,7 +53,7 @@ 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 node
+    # Install
     - name: "ALKiln: Install node packages"
       uses: actions/setup-node@v3
       with:
@@ -81,33 +81,31 @@ 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 ${{ 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: alkiln-takedown
-    #  shell: bash
-    #
-    ## Upload artifacts that subscribers can download on the Actions summary page
-    #- name: "ALKiln: Upload artifacts folder"
-    #  if: ${{ always() }}
-    #  uses: actions/upload-artifact@v3
-    #  with:
-    #    name: ${{ env.ARTIFACT_NAME }}
-    #    path: ./alkiln-*
+    # run tests
+    - name: "ALKiln: Run tests"
+      if: ${{ success() }}
+      # run: alkiln-run @e6 or @al1
+      run: alkiln-run @al1
+      shell: bash
+
+    #  run: alkiln-run ${{ github.event.inputs.tags && format('{0}', github.event.inputs.tags) }}
+    
+    # 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: alkiln-takedown
+      shell: bash
+    
+    # Upload artifacts that subscribers can download on the Actions summary page
+    - name: "ALKiln: Upload artifacts folder"
+      if: ${{ always() }}
+      uses: actions/upload-artifact@v3
+      with:
+        name: ${{ env.ARTIFACT_NAME }}
+        path: ./alkiln-*
 
 # ##################################
 # # A developer's workflow should look similar to the below

package/github_server/action.yml

@@ -1,6 +1,12 @@
 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? 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
 
 inputs:
   CONFIG_CONTENTS:
@@ -27,6 +33,9 @@ runs:
         run: |
           echo "DA_ADMIN_API_KEY=abcd1234abcd1234abcd5678abdc5678" >> $GITHUB_ENV
           echo "MAX_SECONDS_FOR_DOCKER=${{ inputs.MAX_SECONDS_FOR_DOCKER }}" >> $GITHUB_ENV
+          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
         shell: bash
       - id: api_key_output_step
         run: echo "::set-output name=DOCASSEMBLE_DEVELOPER_API_KEY::$DA_ADMIN_API_KEY"
@@ -47,8 +56,8 @@ runs:
           # Wait 1 minute before pinging the server constantly
           sleep 60
 
-          # Use a variable we can control to avoid race conditions from
-          # preventing the success log message.
+          # Use a variable instead of checking $result so we can control to avoid race
+          # conditions from preventing the success log message.
           ready="false"
 
           while [[ $ready == "false" ]]; do
@@ -76,6 +85,37 @@ runs:
 
           done
         shell: bash
+
+      - name: Install the package
+        run: |
+          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 is $repo_name"
+          cd $repo_name
+
+          echo "BRANCH_REF is $BRANCH_REF"
+          ref_name=$BRANCH_REF
+          branch_name="${ref_name#refs/heads/}"
+          echo "branch name is $branch_name"
+          git checkout -b $branch_name
+          git fetch origin $branch_name
+          git reset --hard origin/$branch_name
+
+          cd ..
+          pip install docassemblecli
+          dainstall $repo_name --apiurl http://localhost --apikey $DA_ADMIN_API_KEY
+
+          ## Below here is just for development
+          #container_name=$(docker ps --format '{{.Names}}' | head -n 1)
+          #echo $container_name
+          #docker exec -it "$container_name /bin/bash"
+          #echo "ls /usr/share/docassemble/local3.10/lib/python3.10/site-packages/docassemble"
+        shell: bash
+
       - name: Docker logs
         if: ${{ always() }}
         # TODO: create an arifact for this instead

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/docassemble/startserver.js

@@ -56,12 +56,12 @@ const startserver = async () => {
   await browser.close();
   */
 
-  let task_id = await da_i.install_on_server();
-  if (task_id) {
-    console.log("Waiting...")
-    await da_i.wait_for_package_to_restart(task_id);
-  }
-  console.log("Done!")
+  // let task_id = await da_i.install_on_server();
+  // if (task_id) {
+  //   console.log("Waiting...")
+  //   await da_i.wait_for_package_to_restart(task_id);
+  // }
+  // console.log("Done!")
   session_vars.save_install_type("server");
 
 };  // Ends startserver();

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/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-7",
+  "version": "5.0.2-feat-github-server-9",
   "description": "Integrated automated end-to-end testing with docassemble, puppeteer, and cucumber.",
   "main": "lib/index.js",
   "scripts": {

package/docassemble/setup.py

@@ -1,61 +0,0 @@
-import os
-import sys
-from setuptools import setup, find_packages
-from fnmatch import fnmatchcase
-from distutils.util import convert_path
-
-standard_exclude = ('*.pyc', '*~', '.*', '*.bak', '*.swp*')
-standard_exclude_directories = ('.*', 'CVS', '_darcs', './build', './dist', 'EGG-INFO', '*.egg-info')
-
-def find_package_data(where='.', package='', exclude=standard_exclude, exclude_directories=standard_exclude_directories):
-    out = {}
-    stack = [(convert_path(where), '', package)]
-    while stack:
-        where, prefix, package = stack.pop(0)
-        for name in os.listdir(where):
-            fn = os.path.join(where, name)
-            if os.path.isdir(fn):
-                bad_name = False
-                for pattern in exclude_directories:
-                    if (fnmatchcase(name, pattern)
-                        or fn.lower() == pattern.lower()):
-                        bad_name = True
-                        break
-                if bad_name:
-                    continue
-                if os.path.isfile(os.path.join(fn, '__init__.py')):
-                    if not package:
-                        new_package = name
-                    else:
-                        new_package = package + '.' + name
-                        stack.append((fn, '', new_package))
-                else:
-                    stack.append((fn, prefix + name + '/', package))
-            else:
-                bad_name = False
-                for pattern in exclude:
-                    if (fnmatchcase(name, pattern)
-                        or fn.lower() == pattern.lower()):
-                        bad_name = True
-                        break
-                if bad_name:
-                    continue
-                out.setdefault(package, []).append(prefix+name)
-    return out
-
-setup(name='docassemble.ALKiln',
-      version='0.0.1',
-      description=('A docassemble extension.'),
-      long_description='# docassemble.ALKiln\r\n\r\nA docassemble extension.\r\n\r\nALKiln, or Assembly Line Kiln, is an open source project that helps [docassemble](https://docassemble.org/) developers create automated tests for their interviews (online forms). It works well with the [Document Assembly Line Project](https://suffolklitlab.org/docassemble-AssemblyLine-documentation) but is independent of it.\r\n\r\n',
-      long_description_content_type='text/markdown',
-      author='plocket',
-      author_email='52798256+plocket@users.noreply.github.com',
-      license='The MIT License (MIT)',
-      url='https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln',
-      packages=find_packages(),
-      namespace_packages=['docassemble'],
-      install_requires=[],
-      zip_safe=False,
-      package_data=find_package_data(where='docassemble/ALKiln/', package='docassemble.ALKiln'),
-     )
-