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

package/.github/workflows/github_server.yml

@@ -59,7 +59,7 @@ jobs:
         if: ${{ failure() }}
         uses: mxschmitt/action-tmate@v3
 
-      - name: Set more env vars
+      - 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
@@ -78,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-12"
+          ALKILN_VERSION: "5.0.2-feat-github-server-14"
       - 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/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.
+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.
 
 There are other files the docassemble package needs, like `./setup.py`, so if you see them around, don't worry about them.
 

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
@@ -53,9 +53,6 @@ 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
           echo "DA_ADMIN_EMAIL=admin@example.com" >> $GITHUB_ENV
           # Login will fail if this is "password"
           echo "DA_ADMIN_PASSWORD=@123abcdefg" >> $GITHUB_ENV
@@ -76,7 +73,7 @@ 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

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suffolklitlab/alkiln",
-  "version": "5.0.2-feat-github-server-12",
+  "version": "5.0.2-feat-github-server-14",
   "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.ALKiln',
+setup(name='docassemble.ALKilnTests',
       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',
@@ -50,11 +50,11 @@ setup(name='docassemble.ALKiln',
       author='plocket',
       author_email='example@example.com',
       license='The MIT License (MIT)',
-      url='https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/automated_integrated_testing',
+      url='https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln',
       packages=find_packages(),
       namespace_packages=['docassemble'],
       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_data=find_package_data(where='docassemble/ALKilnTests/', package='docassemble.ALKilnTests'),
      )