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

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,15 +28,18 @@ jobs:
         node-version: [18.x]
 
     env:
-      USER1_EMAIL: admin@example.com
-      USER1_PASSWORD: password
+      # 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
@@ -50,6 +53,23 @@ jobs:
           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: Set more env vars
+        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.
+      #    # 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() }}
         uses: ./
@@ -58,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-10"
+          ALKILN_VERSION: "5.0.2-feat-github-server-12"
       - 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
@@ -75,23 +75,17 @@ runs:
     # Install on server
     - name: "ALKiln: Install the GitHub package onto the server"
       if: ${{ inputs.INSTALL_METHOD == 'server' }}
-      run: alkiln-startserver
+      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
 
-    ############
-    ##### !!! 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,14 +1,26 @@
 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?
+# 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
+# 150 secs with exit code 56:
+# https://github.com/SuffolkLITLab/ALKiln/actions/runs/5914677262/job/16040233419#step:4:196
+# 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:
@@ -27,17 +39,17 @@ outputs:
     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"
+    value: ${{ steps.api_key_output_step.outputs.DA_ADMIN_EMAIL }}
   DA_ADMIN_PASSWORD:
-    #value: ${{ steps.api_key_output_step.outputs.DA_ADMIN_PASSWORD }}
-    value: "password"
+    value: ${{ steps.api_key_output_step.outputs.DA_ADMIN_PASSWORD }}
 
 
 runs:
   using: "composite"
   steps:
-      - name: "github_server: Set environment variables"
+      - 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
@@ -45,22 +57,24 @@ runs:
           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
+          # 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: "github_server: Download and start docker"
+
+      - name: "ALKiln github_server: Download and start docker"
         run: |
           mkdir /tmp/config
-          echo "${{ inputs.CONFIG_CONTENTS }}" > /tmp/config/myconfig.yml 
+          echo "${{ inputs.CONFIG_CONTENTS }}" > /tmp/config/myconfig.yml
           docker pull jhpyle/docassemble
-          docker run --env DA_ADMIN_EMAIL="admin@example.com" --env DA_ADMIN_PASSWORD="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
+          docker run --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: "github_server: Wait for server to start"
+      - name: "ALKiln github_server: Wait for server to start"
         run: |
           # github_server: Wait for server to start
 
@@ -69,26 +83,26 @@ runs:
           # 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
@@ -99,39 +113,34 @@ 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"
+      # 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
 
-      - name: Docker logs
+      # Upload artifacts that subscribers can download on the Actions summary page
+      - name: "ALKiln github_server: Docker logs"
         if: ${{ always() }}
-        # TODO: create an arifact for this instead
         run: |
-          docker logs $(docker ps --filter "ancestor=jhpyle/docassemble" --format {{.ID}})
+          docker_logs=$(docker logs $(docker ps --filter "ancestor=jhpyle/docassemble" --format {{.ID}}))
+          # Should this name have a date/time attached? The logs themselves have timestamps
+          echo "$docker_logs" > /tmp/alkiln_docker_logs.txt
         shell: bash
+    
+      # 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
+      - 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

@@ -0,0 +1,18 @@
+#!/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-10",
+  "version": "5.0.2-feat-github-server-12",
   "description": "Integrated automated end-to-end testing with docassemble, puppeteer, and cucumber.",
   "main": "lib/index.js",
   "scripts": {
@@ -9,7 +9,7 @@
     "local": "npm run setup && npm run cucumber; npm run takedown",
     "setup": "./lib/docassemble/setup.js",
     "takedown": "./lib/docassemble/takedown.js",
-    "startserver": "./lib/docassemble/startserver.js",
+    "server_install": "./lib/docassemble/server_install.js",
     "unit": "mocha tests/unit_tests/*.test.*"
   },
   "repository": {
@@ -48,7 +48,7 @@
     "uuid": "8.3.2"
   },
   "bin": {
-    "alkiln-startserver": "./lib/docassemble/startserver.js",
+    "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/lib/docassemble/startserver.js

@@ -1,69 +0,0 @@
-#!/usr/bin/env node
-const puppeteer = require('puppeteer');
-const da_i = require('./docassemble_api_interface');
-const session_vars = require('../utils/session_vars');
-
-const fs = require('fs')
-
-const startserver = async () => {
-  // Open the browser, login with env var creds
-  /*
-  let browser = await puppeteer.launch({headless: !session_vars.get_debug()})
-  let page = await browser.newPage();
-  // Go to the sign in page
-  let login_url = `${ session_vars.get_da_server_url() }/user/sign-in`;
-  try {
-    // puppeteer will ensure proper timeout.
-    await page.goto( login_url, { waitUntil: `domcontentloaded`, timeout: 3000 });
-    await page.waitForSelector( `.dabody` );
-  } catch ( error ) {
-    let err_msg = `Error occurred when ALKiln tried to go to "${ login_url }: ${ error }".`
-    console.log(err_msg);
-    throw error;
-  } 
-
-  let email = process.env[ "DA_ADMIN_API_KEY" ];
-  let password = process.env[ "USER_PASSWORD" ];
-
-  // Try to log in
-  await page.type( `#email`, email );
-  await page.type( `#password`, password );
-  let elem = await page.$( `button[name="submit"]` );
-  await elem.click();
-  await page.waitForNavigation({waitUntil: 'domcontentloaded'});
-
-  // Wait to see the success message.
-  // This is a bit of an assumption and needs success and failure testing
-  // TODO: use a Promise.race to fail faster.
-  await page.waitForSelector( `.datopcenter .alert-success` );
-  // make an API key
-
-  // TODO(brycew): with or without the API key?
-  // Install the package in order to also install all of its dependencies
-  let api_key_url = `${ session_vars.get_da_server_url() }/manage_api?action=new`;
-  await page.goto( api_key_url, { waitUntil: `domcontentloaded`, timeout: 3000 });
-  await page.type( `#name`, "ALKiln tmp key");
-  await page.select( `#method`, "none");
-  let winner = await Promise.all([page.click(`#submit`), page.waitForNavigation({waitUntil: 'domcontentloaded'})]);
-  console.log(`submitted`);
-  const api_text = await page.$eval('body p code', elem => elem.innerText);
-  process.env.DOCASSEMBLE_DEVELOPER_API_KEY = api_text;
-  console.log(`api key: ${api_text}`);
-  let file = fs.writeFileSync( ".tmpenv", `export DOCASSEMBLE_DEVELOPER_API_KEY=${api_text}`);
-
-  await page.goto(`${ session_vars.get_da_server_url() }/user/sign-out`, {waitUntil: `domcontentloaded`});  
-  console.log(`signed out`);
-  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!")
-  session_vars.save_install_type("server");
-
-};  // Ends startserver();
-
-startserver();