@suffolklitlab/alkiln 5.0.2-feat-github-server-1 → 5.0.2-feat-github-server-3

package/.github/workflows/github_server.yml

@@ -2,6 +2,7 @@ name: GitHub server tests
 
 on:
   push:
+  # why is workflow dispatch not showing up in github?
   workflow_dispatch:
     inputs:
       tags:
@@ -11,6 +12,12 @@ on:
         # They test if env vars get set correctly and depencencies get
         # pulled in correctly.
         default: '@e6 or @al1'
+      enable_tmate:
+        type: boolean
+        description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'
+        required: false
+        default: true
+      # TODO: alkiln_version:
 
 jobs:
 
@@ -21,17 +28,34 @@ jobs:
         node-version: [18.x]
 
     env:
-      USER1_EMAIL: ${{ secrets.USER1_EMAIL }}
-      USER1_PASSWORD: ${{ secrets.USER1_PASSWORD }}
+      USER1_EMAIL: admin@example.com
+      USER1_PASSWORD: password
       SECRET_VAR1: secret-var1-value
       SECRET_VAR2: secret-var2-value
       SECRET_FOR_MISSING_FIELD: secret for missing field
       
     steps:
       - uses: actions/checkout@v3
-      - name: Run ALKiln on the GitHub server
-        uses: SuffolkLITLab/ALKiln/github_server@start_server_take_2
+      - name: Setup tmate session
+        if: ${{ inputs.enable_tmate }}
+        uses: mxschmitt/action-tmate@v3
+        with:
+          detached: true
+
+      - name: Start the temporary GitHub server
+        id: github_server
+        uses: ./github_server
         with:
           CONFIG_CONTENTS: "${{ secrets.CONFIG_CONTENTS }}"
-          ALKILN_VERSION: 5.0.2-feat-github-server-1
-      - run: echo "Finished running on the GitHub server"
+      - run: echo "Finished starting the GitHub server"
+
+      - name: "Run ALKiln tests"
+        if: ${{ success() }}
+        uses: ./
+        with:
+          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-3"
+      - run: echo "Finished running ALKiln tests"
+

package/action.yml

@@ -23,6 +23,12 @@ inputs:
     description: "Max amount of time to give the server to reload if it needs to"
     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.
+  INSTALL_METHOD:
+    description: "Default is 'playground'. Other option: 'server'. How to install the package onto the server."
+    required: false
+    default: "playground"
 
 runs:
   using: "composite"
@@ -54,22 +60,44 @@ runs:
         node-version: "18"
     - name: Install ALKiln directly from npm
       run: |
-        npm install -g @suffolklitlab/alkiln
+        npm install -g @suffolklitlab/alkiln@$ALKILN_VERSION
       shell: bash
 
-    # Run tests
+    # Install on playground
     - name: "ALKiln: Create a Project and pull the package from GitHub"
+      if: ${{ inputs.INSTALL_METHOD == 'playground' }}
       run: alkiln-setup
       shell: bash
+    - run: echo -e "\n\n====\nALKiln could not create a project on your server's testing account or pull your package into it. Check the messages above this line.\n\n"
+      if: ${{ inputs.INSTALL_METHOD == 'playground' && failure() }}
+      shell: bash
+
+    # Install on server
+    - name: "ALKiln: Install the GitHub package onto the server"
+      if: ${{ inputs.INSTALL_METHOD == 'server' }}
+      run: alkiln-startserver
+      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
+
+    ## 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 ${{ github.event.inputs.tags && format('{0}', github.event.inputs.tags) }}
-      shell: bash
-    - run: echo -e "\n\n====ALKiln could not create a project on your server's testing account or pull your package into it. Check the messages above this line.\n\n"
-      if: ${{ failure() }}
+      run: alkiln-run @e6 or @al1
+      #run: alkiln-run ${{ github.event.inputs.tags && format('{0}', github.event.inputs.tags) }}
       shell: bash
-    - name: "ALKiln: Delete project from docassemble test account"
-      if: ${{ always() }}
+
+    # 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
     

package/github_server/action.yml

@@ -1,26 +1,23 @@
 name: "ALKiln/github_server: Isolated docassemble tests"
-description: "Automatically test docassemble interviews on GitHub's servers, in an isolated environment. Avoids docassemble reload errors and other external factors."
+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."
 
 
 inputs:
   CONFIG_CONTENTS:
     description: "The contents of the config file of the docassemble server"
     required: false
-  # This is necessary to test pre-releases at the very least. It does seem
-  # strange considering we're controlling everything through the action, but
-  # that actually doesn't touch the npm version that's pulled in.
-  ALKILN_VERSION:
-    description: 'Version of ALKiln to get from npm.'
+  MAX_SECONDS_FOR_DOCKER:
+    description: "Maximum amount of seconds to give the docassemble docker container to serve the site."
     required: false
-    default: '^5.0.0'
-  MAX_SECONDS_FOR_SETUP:
-    description: "Amount of time to give the Project to upload your package's GitHub code."
-    required: false
-    default: '120'
-  SERVER_RELOAD_TIMEOUT_SECONDS:
-    description: "Max amount of time to give the server to reload if it needs to"
-    required: false
-    # no default to let the custom Scenario timeouts create the reload timeout
+    default: 600  # 10 min
+
+outputs:
+  DOCASSEMBLE_DEVELOPER_API_KEY:
+    description: "Use this inside `with:` for the ALKiln step. Temporary admin api key. It will be destroyed after the tests are done."
+    value: ${{ steps.api_key_output_step.outputs.DOCASSEMBLE_DEVELOPER_API_KEY }}
+  SERVER_URL:
+    description: "Use this inside `with:` for the ALKiln step. URL of the temporary docassemble server."
+    value: "http://localhost"
 
 
 runs:
@@ -29,28 +26,58 @@ runs:
       - name: "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
+        shell: bash
+      - id: api_key_output_step
+        run: echo "::set-output name=DOCASSEMBLE_DEVELOPER_API_KEY::$DA_ADMIN_API_KEY"
         shell: bash
       - name: "github_server: Download and start docker"
         run: |
           mkdir /tmp/config
-          echo "$CONFIG_CONTENTS" > /tmp/config/myconfig.yml 
-          docker pull brycewilley/smoldocassemble
+          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
-          # TODO before merge: do a while loop here until `localhost` shows "It's ready"
-          sleep 600
-          sleep 600
-          curl localhost
         shell: bash
-      - name: "github_server: Install the package"
-        run: alkiln-startserver
+      - name: "github_server: Wait for server to start"
+        run: |
+          # github_server: Wait for server to start
+
+          # Reset the SECONDS variable
+          SECONDS=60
+          # Wait 1 minute before pinging the server constantly
+          sleep $SECONDS
+
+          # Use a variable 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."
+              break
+            fi
+
+            # 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
+              echo "Success! The docker container is ready!"
+              ready="true"
+            else
+              echo "The docker container isn't ready yet. Will check again in 30 seconds."
+              sleep 30
+            fi
+
+          done
         shell: bash
-      - name: "github_server: Run Kiln"
-        # TODO: Research how to get this to always be the same branch we're on
-        uses: SuffolkLITLab/ALKiln@v5
-        with:
-          SERVER_URL: "http://localhost"
-          DOCASSEMBLE_DEVELOPER_API_KEY: "${{ env.DA_ADMIN_API_KEY }}"
       - name: Docker logs
+        if: ${{ always() }}
         # TODO: create an arifact for this instead
         run: |
           docker logs $(docker ps --filter "ancestor=jhpyle/docassemble" --format {{.ID}})

package/lib/docassemble/docassemble_api_interface.js

@@ -340,11 +340,9 @@ da_i.install_on_server = async function ( install_options ) {
       timeout
     );
     if ( response && response.status === 200 ) {
-      // console.log("%o", response);
       log.debug({ pre: `install task id: ${ response.data.task_id }` });
       return response.data.task_id;
     }
-    // console.log(`${ response.status }: ${ response.data }`);
     return null;
   } catch (error ) {
     log.error({ pre: `Installing on the docassemble serve ran into an unexpected error.`, data: error.toJSON()});

package/lib/docassemble/get_base_interview_url.js

@@ -13,7 +13,8 @@ let get_base_interview_url = async function () {
   let server_url = session_vars.get_da_server_url();
   console.log(session_vars.get_install_type());
   if (session_vars.get_install_type() === "server") {
-    let x = `${ server_url }/interview?new_session=1&i=${session_vars.get_package_name().replace("-", ".")}%3A`;
+    let x = `${ server_url }/interview?new_session=1&i=docassemble.${session_vars.get_package_name().replace("-", ".")}%3Adata/questions/`;
+    // e.g. http://localhost/interview?new_session=1&i=ALKiln%3A
     console.log(`base_interview_url: ${x}`)
     return x;
   } else {

package/package.json

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