@suffolklitlab/alkiln 5.0.2-feat-github-server-11 → 5.0.2-feat-github-server-13

package/.github/workflows/github_server.yml

@@ -16,7 +16,7 @@ on:
         type: boolean
         description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'
         required: false
-        default: true
+        default: false
       # TODO: alkiln_version:
 
 jobs:
@@ -28,16 +28,18 @@ jobs:
         node-version: [18.x]
 
     env:
-      # USER1_EMAIL: admin@example.com
-      # USER1_PASSWORD: "@12lsdnejewng"
       # 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
+      #_ALKILN_DANGEROUS_DEBUG: true
       
     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
@@ -51,15 +53,22 @@ jobs:
           CONFIG_CONTENTS: "${{ secrets.CONFIG_CONTENTS }}"
       - run: echo "Finished starting the GitHub server"
 
-      - name: Set more env vars
+      # 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
-      - name: Work with docker
-        run: |
-          # Authors can use this to do more with the docker container
-          container_name=$(docker ps --format '{{.Names}}' | head -n 1)
-          echo "container_name is $container_name"
+      #- 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"
 
       - name: "Run ALKiln tests"
         if: ${{ success() }}
@@ -69,6 +78,6 @@ jobs:
           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: "5.0.2-feat-github-server-11"
+          ALKILN_VERSION: "5.0.2-feat-github-server-13"
       - run: echo "Finished running ALKiln tests"
 

package/action.yml

@@ -24,7 +24,7 @@ inputs:
     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 it could be "playground", "server", or a custom path and we could handle all those.
+  # 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
@@ -81,17 +81,11 @@ runs:
       if: ${{ inputs.INSTALL_METHOD == 'server' && failure() }}
       shell: bash
 
-    ############
-    ##### !!! WARNING: RESTORE CODE FOR TAGS
-    ############
     # run tests
     - name: "ALKiln: Run tests"
       if: ${{ success() }}
-      # run: alkiln-run @e6 or @al1
-      run: alkiln-run @e6
+      run: alkiln-run ${{ github.event.inputs.tags && format('{0}', github.event.inputs.tags) }}
       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."
@@ -108,7 +102,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/github_server/action.yml

@@ -1,7 +1,7 @@
 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
+# 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
@@ -12,6 +12,16 @@ description: "Download and start up a temporary docassemble server on GitHub's s
 # 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
+# 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"
@@ -37,23 +47,23 @@ outputs:
 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 "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
           # Login will fail if this is "password"
           echo "DA_ADMIN_PASSWORD=@123abcdefg" >> $GITHUB_ENV
         shell: bash
       - id: api_key_output_step
         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"
+          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
@@ -63,33 +73,33 @@ runs:
         shell: bash
       - name: "ALKiln github_server: Wait for server to start"
         run: |
-          # github_server: Wait for server to start
+          # ALKiln github_server: Wait for server to start
 
           # Reset the SECONDS variable
           SECONDS=0
           # Wait 1 minute before pinging the server constantly
           sleep 60
 
-          # Use a variable instead of checking $result so we can control to avoid race
+          # Use a variable instead of checking $response so we can control to avoid race
           # conditions from preventing the success log message.
           ready="false"
 
           while [[ $ready == "false" ]]; do
             echo "Time ellapsed: $SECONDS seconds"
 
-            # Get input for max number of seconds to wait
-            # ${{ inputs.MAX_SECONDS_FOR_DOCKER }} as a number? Bash doesn't have types, just strings
             # 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
             fi
 
             # Set the variable to a new string value in each iteration
-            result=$(curl -s localhost)
+            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 [[ ! $result == *"Docassemble is starting"* ]]; then
+            if [[ $response == *"200"* ]]; then
               echo "Success! The docker container is ready!"
               ready="true"
             else
@@ -100,29 +110,14 @@ runs:
           done
         shell: bash
 
-      - name: "ALKiln github_server: Install the package"
-        id: container_output_step
-        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
+      # 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 into docassemble
+      - run: dainstall . --apiurl http://localhost --apikey $DA_ADMIN_API_KEY
         shell: bash
 
       # Upload artifacts that subscribers can download on the Actions summary page
@@ -136,6 +131,7 @@ runs:
     
       # 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: |
           echo "GITHUB_SERVER_ARTIFACT_NAME=alkiln-github-server-$(date +'%Y-%m-%d at %Hh%Mm%Ss' -u)UTC" >> $GITHUB_ENV
         shell: bash

package/lib/docassemble/docassemble_api_REST.js

@@ -54,22 +54,6 @@ da.create_project = async function ( project_name, timeout ) {
   }
 };  // Ends da.create_project()
 
-da.install_on_server = async function ( github_repo, branch_name, timeout ) {
-  let options = {
-    method: 'POST',
-    url: `${ session_vars.get_da_server_url() }/api/package`,
-    data: qs.stringify( {
-      key: session_vars.get_dev_api_key(),
-      github_url: github_repo,
-      branch: branch_name
-    }),
-    timeout: timeout,
-  };
-  console.log("%o", options);
-
-  return await axios.request(options);
-};
-
 
 // node -e 'require("./lib/docassemble/docassemble_api_REST.js").pull()'
 da.pull = async function ( timeout ) {

package/lib/docassemble/docassemble_api_interface.js

@@ -329,27 +329,6 @@ da_i.pull = async function ( pull_options ) {
   }
 };  // Ends da_i.pull()
 
-
-da_i.install_on_server = async function ( install_options ) {
-  let { timeout } = install_options || { timeout: DEFAULT_MAX_REQUEST_MS };
-
-  try {
-    let response = await _da_REST.install_on_server(
-      session_vars.get_repo_url(),
-      session_vars.get_branch_name(),
-      timeout
-    );
-    if ( response && response.status === 200 ) {
-      log.debug({ pre: `install task id: ${ response.data.task_id }` });
-      return response.data.task_id;
-    }
-    return null;
-  } catch (error ) {
-    log.error({ pre: `Installing on the docassemble serve ran into an unexpected error.`, data: error.toJSON()});
-  }
-
-};
-
 // node -e 'require("./lib/docassemble/docassemble_api_interface.js").has_task_finished()'
 da_i.has_task_finished = async function ( api_endpoint, task_id, options ) {
   /** Check task status if it exists. If not, return true as task did

package/lib/docassemble/server_install.js

@@ -1,18 +1,9 @@
 #!/usr/bin/env node
 
-//const da_i = require('./docassemble_api_interface');
 const session_vars = require('../utils/session_vars');
 
 const server_install = async () => {
-  // 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 server_install();
 
 server_install();

package/lib/scope.js

@@ -759,8 +759,6 @@ module.exports = {
 
     if ( !scope.page ) { scope.page = await scope.browser.newPage(); }
 
-    console.log(`interview_url:`, interview_url);
-
     // TODO: implement and use scope.handle_possible_timeout()
     try {
 

package/package.json

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