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

package/.github/workflows/github_server.yml

@@ -49,6 +49,10 @@ 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: ./
@@ -56,6 +60,6 @@ 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-6"
+          ALKILN_VERSION: "5.0.2-feat-github-server-8"
       - run: echo "Finished running ALKiln tests"
 

package/CONTRIBUTING.md

@@ -194,7 +194,7 @@ Our `./action.yml` is a [composite action](https://docs.github.com/en/actions/cr
 
 ### Internal tests
 
-We have our own docassemble package in our repo to test our own end-to-end tests. Most of what the package needs is in `./docassemble`. That docassemble package is what the test setup pulls into the docassemble server. Our internal end-to-end cucumber tests are `.feature` files that are stored in `./docassemble/ALKilnTests/data/sources`. The interview (online form) `.yml` files that those `.feature` files use are also deep in the `./docassemble` package. You probably won't be touching the interview files. If you get curious, feel free to ask us.
+We have our own docassemble package in our repo to test our own end-to-end tests. Most of what the package needs is in `./docassemble`. That docassemble package is what the test setup pulls into the docassemble server. Our internal end-to-end cucumber tests are `.feature` files that are stored in `./docassemble/ALKiln/data/sources`. The interview (online form) `.yml` files that those `.feature` files use are also deep in the `./docassemble` package. You probably won't be touching the interview files. If you get curious, feel free to ask us.
 
 There are other files the docassemble package needs, like `./setup.py`, so if you see them around, don't worry about them.
 

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,34 @@ runs:
       if: ${{ inputs.INSTALL_METHOD == 'server' && failure() }}
       shell: bash
 
-    # debugging
-    - name: Setup tmate session
-      uses: mxschmitt/action-tmate@v3
+    ## 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
+      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?
+# 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"
@@ -43,12 +52,12 @@ runs:
           # github_server: Wait for server to start
 
           # Reset the SECONDS variable
-          SECONDS=60
+          SECONDS=0
           # Wait 1 minute before pinging the server constantly
-          sleep $SECONDS
+          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
@@ -62,8 +71,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
@@ -76,6 +85,37 @@ runs:
 
           done
         shell: bash
+
+      - name: Install the package
+        run: |
+          echo $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
+          cd $repo_name
+
+          echo "branch ref $BRANCH_REF"
+          ref_name=$BRANCH_REF
+          branch_name="${ref_name#refs/heads/}"
+          echo "branch name: $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/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

@@ -755,8 +755,7 @@ module.exports = {
     if ( session_vars.get_debug() ) { console.log( `interview_url:`, interview_url ); }
 
     if ( !scope.page ) { scope.page = await scope.browser.newPage(); }
-
-    interview_url = `http://localhost/interview?new_session=1&i=docassemble.ALKilnTests%3Adata/questions/AL_tests.yml`
+    
     console.log(`interview_url:`, interview_url);
 
     // TODO: implement and use scope.handle_possible_timeout()

package/package.json

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

package/setup.py

@@ -42,7 +42,7 @@ def find_package_data(where='.', package='', exclude=standard_exclude, exclude_d
                 out.setdefault(package, []).append(prefix+name)
     return out
 
-setup(name='docassemble.ALKilnTests',
+setup(name='docassemble.ALKiln',
       version='1.0.0',
       description=('A docassemble extension for testing the ALKiln integrated testing framework.'),
       long_description='# ALKiln support package\r\n\r\nAssembly Line Kiln (ALKiln) is a framework for automatically testing **any** [docassemble](https://docassemble.org/) package using GitHub. ALKiln is being developed as part of the SuffolkLITLab Document Assembly Line project. See [documentation for kiln](https://suffolklitlab.github.io/docassemble-AssemblyLine-documentation/docs/automated_integrated_testing).\r\n\r\nThis package supports ALKiln in different ways.\r\n\r\n## Tool to set up testing\r\n\r\n[Tap here to set up automated integrated testing for your docassemble interview](https://apps-dev.suffolklitlab.org/start/test-setup/).\r\n\r\nThis repo contains a step-by-step form that a developer can use to set up automated integrated testing for **any** docassemble package. It requires, among other things, a docassemble account and a temporary GitHub personal access token with correct permissions. It will add necessary GitHub secrets, make a new branch, push necessary files to that branch, and make a PR with that branch.\r\n\r\n',
@@ -55,6 +55,6 @@ setup(name='docassemble.ALKilnTests',
       namespace_packages=['docassemble'],
       install_requires=['docassemble.ALToolbox>=0.5.1'],
       zip_safe=False,
-      package_data=find_package_data(where='docassemble/ALKilnTests/', package='docassemble.ALKilnTests'),
+      package_data=find_package_data(where='docassemble/ALKiln/', package='docassemble.ALKiln'),
      )
 

package/docassemble/ALKiln/__init__.py

@@ -1 +0,0 @@
-__version__ = '1.0.0'

package/docassemble/ALKiln/data/questions/AL_tests.yml

@@ -1,40 +0,0 @@
-metadata:
-  title: Test testing AssemblyLine-specific Steps
-  short title: Test ALKiln for AL
-  comment: Test the AssemblyLine automated integrated testing library for packages that use AssemblyLine itself
----
-include:
-  - docassemble.AssemblyLine:al_package.yml
----
-# Necessary to tell us what the sought var is on each page
-# Every interview that wants testing will need to have an element like this
-default screen parts:
-  post: |
-    <div data-variable="${ encode_name(str( user_info().variable )) }" id="trigger" aria-hidden="true" style="display: none;"></div>
----
-id: interview order
-mandatory: True
-code: |
-  users[0].name.first
-  users[0].address.address
-  users[1].name.first
-  end
----
-id: field code mix
-sets:
-  - users[i].name.first
-question: |
-  Mix of code and proxy var
-subquestion: |
-  The name fields variables will be using `users[0]` while the last field
-  will be using `users[i]`. The sought variable will be using
-  `users[0]`. The testing framework needs to be able to handle that.
-fields:
-  - code: |
-      users[i].name_fields()
-  - A proxy var: users[i].proxy_var
----
-id: end
-event: end
-question: Great test!
----

package/docassemble/ALKiln/data/questions/all_tests.yml

@@ -1,312 +0,0 @@
-metadata:
-  title: Test testing library
-  short title: Test ALKiln
-  comment: Test the automated integrated testing library created with the AssemblyLine project
----
-features:
-  css:
-    - styles.css
----
-# Necessary to tell us what the sought var is on each page
-# Every interview that wants testing will need to have an element like this
-default screen parts:
-  post: |
-    <div data-variable="${ encode_name(str( user_info().variable )) }" id="trigger" aria-hidden="true" style="display: none;"></div>
----
-mandatory: True
-id: interview order
-code: |
-  upload_files_visible
-  double_quote_dict["double_quote_key"]
-  direct_standard_fields
-  direct_showifs
-  object_checkboxes_test
-  buttons_yesnomaybe
-  buttons_other
-  button_continue
-  screen_features
-  proxy_list.gather()
-  signature_1
-  signature_2
-  see_simple_doc
-  
-  button_event_action
-  single_dropdown_field
-  end
----
-id: upload files
-question: |
-  Upload a file
-subquestion: |
-  [https://github.com/plocket/docassemble-ALAutomatedTestingTests/issues/151](https://github.com/plocket/docassemble-ALAutomatedTestingTests/issues/151)
-fields:
-  - Upload file field: upload_files_visible
-    datatype: files
-    required: False
-    maximum image size: 1024
-    image upload type: jpeg
-    accept: |
-      "image/png, image/jpg, .doc,.docx,application/msword,application/vnd.openxmlformats-officedocument.wordprocessingml.document,application/pdf,.pdf"
-  - Show other file upload: show_upload
-    datatype: yesno
-  - Hidden upload field: upload_files_hidden
-    show if: show_upload
-    datatype: files
-    required: False
-    maximum image size: 1024
-    image upload type: jpeg
-    accept: |
-      "image/png, image/jpg, .doc,.docx,application/msword,application/vnd.openxmlformats-officedocument.wordprocessingml.document,application/pdf,.pdf"
----
-id: group of complex fields
-question: |
-  Some complex fields
-fields:
-  - Singly quoted key: single_quote_dict['single_quote_key']
-    datatype: checkboxes
-    required: False
-    none of the above: False
-    choices:
-      - 1: sq_one
-      - 2: sq_two
-      - 3: sq_three
-  - Doubly quoted key: double_quote_dict["double_quote_key"]
-    datatype: checkboxes
-    required: False
-    none of the above: False
-    choices:
-      - 1: dq_one
-      - 2: dq_two
-      - 3: dq_three
----
-id: direct standard fields
-continue button field: direct_standard_fields
-question: |
-  Direct standard fields
-subquestion: |
-  Excludes proxy vars (x, i, j, etc.) or choices created with objects.
-fields:
-  - checkboxes (yesno): checkboxes_yesno
-    datatype: yesno
-  # TODO: Add checkbox yesno to leave blank
-  - checkboxes (other): checkboxes_other
-    datatype: checkboxes
-    choices: 
-       - checkboxes opt 1: checkbox_other_opt_1
-       - checkboxes opt 2: checkbox_other_opt_2
-       - checkboxes opt 3: checkbox_other_opt_3
-  # TODO: Add checkbox (other) to test 'none of the above'
-  - radio (yesno): radio_yesno
-    datatype: yesnoradio
-  # TODO: Add radio yesno to choose 'no'
-  - radio (other): radio_other
-    datatype: radio
-    choices: 
-      - radio opt 1: radio_other_opt_1
-      - radio opt 2: radio_other_opt_2
-      - radio opt 3: radio_other_opt_3
-  # Same DOM as `datatype: area`
-  - text input: text_input
-  - textarea: textarea
-    input type: area
-  - date field: date_input
-    datatype: date
-    required: False
-  - dropdown: dropdown_test
-    datatype: dropdown
-    choices:
-      - dropdown opt 1: dropdown_opt_1
-      - dropdown opt 2: dropdown_opt_2
-      - dropdown opt 3: dropdown_opt_3
----
-id: showifs
-continue button field: direct_showifs
-question: |
-  Reveal showifs
-subquestion: |
-  We start only seeing layer 1, the first question. All other layers are hidden to test finding various hidden fields in the DOM.
-
-  TODO:
-
-  - object
-  - object_checkbox
-
-  No showifs: yesnomaybe: (buttons), buttons: (other), continue button field:
-fields:
-  - Show layer 2: show_2
-    datatype: yesno
-  - Show layer 3: show_3
-    datatype: yesno
-    show if: show_2
-  # TODO: Add checkbox yesno to leave blank
-  - showif checkbox yesno: showif_checkbox_yesno
-    datatype: yesno
-    show if: show_3
-  # A checkbox's none of the above `for` value is unique
-  - showif checkboxes (multiple): showif_checkboxes_other
-    datatype: checkboxes
-    choices:
-      - showif checkbox nota 1: showif_checkboxes_nota_1
-      - showif checkbox nota 2: showif_checkboxes_nota_2
-      - showif checkbox nota 3: showif_checkboxes_nota_3
-    show if: show_3
-  # TODO: Add checkbox (other) to test 'none of the above'
-  - showif yesnoradio: showif_yesnoradio 
-    datatype: yesnoradio
-    show if: show_3
-  # TODO: Add radio yesno to choose 'no'
-  - showif radio (multiple): showif_radio_other
-    datatype: radio
-    choices:
-      - showif radio multi 1: showif_radio_multi_1
-      - showif radio multi 2: showif_radio_multi_2
-      - showif radio multi 3: showif_radio_multi_3
-    show if: show_3
-  - showif text input: showif_text_input
-    show if: show_3
-  - showif text input: showif_textarea
-    datatype: area
-    show if: show_3
-  - showif dropdown: showif_dropdown  
-    show if: show_3
-    choices: 
-    - showif dropdown opt 1: showif_dropdown_1
-    - showif dropdown opt 2: showif_dropdown_2
-    - showif dropdown opt 3: showif_dropdown_3
-    - showif dropdown opt 4: showif_dropdown_4
----
-objects:
-  - obj_chkbx_opt_1: DAObject
-  - obj_chkbx_opt_2: DAObject
-  - obj_chkbx_opt_3: DAObject
-  - obj_opt_1: DAObject
-  - obj_opt_2: DAObject
-  - obj_opt_3: DAObject
----
-code: |
-  obj_chkbx_opt_1.name = 'obj_chkbx_opt_1'
-  obj_chkbx_opt_2.name = 'obj_chkbx_opt_2'
-  obj_chkbx_opt_3.name = 'obj_chkbx_opt_3'
-  obj_opt_1.name = 'obj_opt_1'
-  obj_opt_2.name = 'obj_opt_2'
-  obj_opt_3.name = 'obj_opt_3'
----
-id: object checkboxes
-question: |
-  Objects
-fields:
-  - Object checkboxes: object_checkboxes_test
-    datatype: object_checkboxes
-    choices:
-      - obj_chkbx_opt_1
-      - obj_chkbx_opt_2
-      - obj_chkbx_opt_3
-  - Object dropdown: object_dropdown
-    datatype: object
-    choices:
-      - obj_opt_1
-      - obj_opt_2
-      - obj_opt_3
----
-id: buttons yesnomaybe
-question: |
-  Button (yes/no/maybe)
-yesnomaybe: buttons_yesnomaybe
----
-id: buttons other
-question: |
-  Button (other)
-field: buttons_other
-buttons:
-  - button 1: button_1
-  - button 2: button_2
-  - button 3: button_3
----
-id: button continue
-continue button field: button_continue
-question: |
-  Button (continue)
----
-id: screen features
-continue button field: screen_features
-question: |
-  Other screen features
-subquestion: | 
-  * [Link to external page](http://ecosia.org/). Its value is always the same.
-  * [Link: reload the page](${ interview_url() }). Its value changes.
-  * {Term} (working).
-  * {Broken term}.
-terms: 
-  term: |
-    A term is a word that you click on if you don't know what the definition is.
----
-objects:
-  - proxy_list: DAList.using(object_type=Individual, there_are_any=True)
----
-id: proxy vars
-generic object: DAList
-question: |
-  Proxy var ${ i + 1 }
-fields:
-  - ${ ordinal(i) } proxy name: x[i].name.first
----
-id: is there another generic
-generic object: DAList
-question: |
-  Is there another proxy var?
-yesno: x.there_is_another
----
-objects:
-  - single_quote_dict: DADict
-  - double_quote_dict: DADict
----
-id: first signature
-question: |
-  Signature 1
-signature: signature_1
----
-id: second signature
-question: |
-  Signature 2
-signature: signature_2
----
-id: button event action
-question: |
-  Button (event action)
-field: button_event_action
-action buttons: 
-  - label: Do not pass go
-    action: end
-    icon: laugh-wink
----
-id: Single dropdown field
-question: Single dropdown field
-field: single_dropdown_field
-dropdown:
-  - Efile and serve: efile_and_serve
-  - Email: email
-  - Mail: mail
-  - Hand delivery: hand_delivery
----
-id: simple doc
-question: |
-  Document
-subquestion: |
-  [Tap to download](${ simple_doc.pdf.url_for( attachment=True ) })
-continue button field: see_simple_doc
----
-id: simple attachment
-attachment:
-    variable name: simple_doc
-    pdf template file: simple.pdf
-    filename: simple-doc
-    skip undefined: True
-    editable: False
-    fields:
-      - "proxy1_name_first": ${ proxy_list[0].name.first }
-      - "proxy1_signature": ${ proxy_list[0].signature }
----
-id: the end
-event: end
-question: |
-  Congratulations! Tests have passed!

package/docassemble/ALKiln/data/questions/test.yml

@@ -1,14 +0,0 @@
-metadata:
-  title: Test testing library
-  short title: Test ALKiln
-  comment: Test the automated integrated testing library for AssemblyLine
----
-mandatory: True
-id: interview order
-code: |
-  end
----
-id: the end
-event: end
-question: |
-  Congradulations! Tests have passed!

package/docassemble/ALKiln/data/questions/test_date_and_time.yml

@@ -1,34 +0,0 @@
-metadata:
-  title: Test testing library - date and time
-  short title: Test ALKiln
----
-features:
-  css:
-    - styles.css
----
-# Necessary to tell us what the sought var is on each page
-# Every interview that wants testing will need to have an element like this
-default screen parts:
-  post: |
-    <div data-variable="${ encode_name(str( user_info().variable )) }" id="trigger" aria-hidden="true" style="display: none;"></div>
----
-mandatory: True
-id: interview order
-code: |
-  date_and_time
-  end
----
-id: date and time
-continue button field: date_and_time
-question: |
-  Date and time
-fields:
-  - date field: date_input
-    datatype: date
-  - time field: time_input
-    datatype: time
----
-id: the end
-event: end
-question: |
-  Congratulations! Tests have passed!