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

package/.github/workflows/github_server.yml

@@ -28,8 +28,9 @@ jobs:
         node-version: [18.x]
 
     env:
-      USER1_EMAIL: admin@example.com
-      USER1_PASSWORD: password
+      # 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
@@ -50,6 +51,16 @@ jobs:
           CONFIG_CONTENTS: "${{ secrets.CONFIG_CONTENTS }}"
       - run: echo "Finished starting the GitHub server"
 
+      - 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
+          container_name=$(docker ps --format '{{.Names}}' | head -n 1)
+          echo "container_name is $container_name"
+
       - name: "Run ALKiln tests"
         if: ${{ success() }}
         uses: ./
@@ -58,6 +69,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-9"
+          ALKILN_VERSION: "5.0.2-feat-github-server-11"
       - run: echo "Finished running ALKiln tests"
 

package/action.yml

@@ -75,7 +75,7 @@ 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() }}
@@ -88,7 +88,7 @@ runs:
     - name: "ALKiln: Run tests"
       if: ${{ success() }}
       # run: alkiln-run @e6 or @al1
-      run: alkiln-run @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,16 @@
 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 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
 
 inputs:
   CONFIG_CONTENTS:
@@ -24,30 +28,40 @@ 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 }}
+  DA_ADMIN_PASSWORD:
+    value: ${{ steps.api_key_output_step.outputs.DA_ADMIN_PASSWORD }}
 
 
 runs:
   using: "composite"
   steps:
-      - name: "github_server: Set environment variables"
+      - 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"
+        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"
+      - 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
 
@@ -86,7 +100,8 @@ runs:
           done
         shell: bash
 
-      - name: Install the package
+      - name: "ALKiln github_server: Install the package"
+        id: container_output_step
         run: |
           echo "CLONE_URL is $CLONE_URL"
           git clone $CLONE_URL
@@ -108,17 +123,25 @@ runs:
           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
+      # 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"
+        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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suffolklitlab/alkiln",
-  "version": "5.0.2-feat-github-server-9",
+  "version": "5.0.2-feat-github-server-11",
   "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/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'),
      )

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();