Merge branch 'master' into master

Author: eddiewebb

.circleci/config.yml

@@ -10,7 +10,11 @@ parameters:
 workflows:
   build-deploy:
     jobs:
-      - validate
+      - validate:
+          filters:
+            branches:
+              ignore: 
+                - master
       - test:
           requires: 
             - validate
@@ -83,7 +87,7 @@ jobs:
               PUBLISH_MESSAGE=`circleci orb publish promote eddiewebb/<<pipeline.parameters.orbname>>@dev:${PR_NUMBER} ${SEMVER_INCREMENT} --token ${CIRCLECI_API_KEY}`            
               echo $PUBLISH_MESSAGE
               ORB_VERSION=$(echo $PUBLISH_MESSAGE | sed -n 's/Orb .* was promoted to `\(.*\)`.*/\1/p')
-              echo "export PR_MESSAGE=\"BotComment: *Production* version of orb available for use - \`${ORB_VERSION}\`\"" >> $BASH_ENV
+              echo "export PR_MESSAGE=\"BotComment: *Production* version of orb available for use - \\\`${ORB_VERSION}\\\`\"" >> $BASH_ENV
             fi
       - pr-comment
 
@@ -104,7 +108,7 @@ commands:
           command: |
             curl -L https://github.com/mikefarah/yq/releases/download/2.1.1/yq_linux_amd64 -o yq
             chmod a+x yq
-            mv yq /usr/local/bin/
+            mv yq /usr/local/bin/            
   install-circleci:
     description: installs the new CIrcleCI CLI with orb support
     steps:
@@ -124,7 +128,6 @@ commands:
           command: |
             circleci config pack src/ > packed.yml
             circleci orb validate packed.yml
-
   pr-comment:
     description: add nessage to pr this build originated from
     steps:
@@ -136,13 +139,12 @@ commands:
               exit 0
             fi
             curl -X POST -u eddiewebb:${GHI_TOKEN} "https://api.github.com/repos/${CIRCLE_PROJECT_USERNAME}/${CIRCLE_PROJECT_REPONAME}/issues/${PR_NUMBER}/comments" -d "{\"body\":\"${PR_MESSAGE}\"}"
-
   pr-info:
     description: get PR number this change originated from
     steps:
       - run:
           name: Get PR Info
           command: |
-            PR_NUMBER=`git log -1 --pretty=%s  | sed -En 's/(Try|Merge) #([0-9]*)/\2/p'`
+            PR_NUMBER=`git log -1 --pretty=%s  | sed -En 's/(Try|Merge) #([0-9]*).*/\2/p'`
             echo "PR_NUMBER is ${PR_NUMBER}"
             echo "export PR_NUMBER=${PR_NUMBER}" >> $BASH_ENV

_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-hacker

bors.toml

@@ -1,3 +1,3 @@
 status = [
-  "ci/circleci: publish"
+  'build-deploy'
 ]

src/@orb.yml

@@ -1,9 +1,17 @@
 version: 2.1
-description: Blocks the current job until no previous occurences of same job are running on this branch.
+description: |
+  Allows jobs or entire workflows to be queued to ensure they run in serial.  
+  This is ideal for deployments or other activities that must not run concurrently.
+  May optionaly consider branch-level isolation if unique branches should run concurrently. 
+  This orb requires the project to have an API key in order to query build states.
+  
+display:
+  home_url: https://eddiewebb.github.io/circleci-queue/
+  source_url: https://github.com/eddiewebb/circleci-queue
 
 examples:
   queue_workflow:
-    description: Used typically as first job and will queue until no jobs from a previous workflow are running
+    description: Used typically as first job and will queue until no previous workflows are running
     usage:
       version: 2.1
       orbs:
@@ -20,7 +28,10 @@ examples:
                   - queue/block_workflow
 
   single_concurrency_job:
-    description: Used to ensure that a single job (deploy) is not run concurrently
+    description: |
+      Used to ensure that a only single job (deploy) is not run concurrently. 
+      By default will only queue if the same job from previous worfklows is running on the same branch. 
+      This allows safe jobs like build/test to overlap, minimizing overall queue times.
     usage:
       version: 2.1
       orbs:

src/commands/until_front_of_line.yml

@@ -3,11 +3,6 @@ parameters:
     type: boolean
     default: true
     description: "Should we only consider jobs running on the same branch?"
-  consider-job:
-    type: boolean
-    # deprecated, do not use
-    description: "Deprecated. Please see block-workflow."
-    default: true
   block-workflow:
     type: boolean
     # this is false at COMMAND level as intention is to only block CURRENT job.
@@ -29,6 +24,10 @@ parameters:
     type: string
     default: "github"
     description: "Override VCS to 'bitbucket' if needed."
+  confidence:
+    type: string
+    default: "1"
+    description: "Due to scarce API, we need to requery the recent jobs list to ensure we're not just in a pending state for previous jobs.  This number indicates the threhold for API returning no previous pending jobs. Default is a single confirmation."
 steps:
   - run:
       name: Queue Until Front of Line
@@ -72,33 +71,61 @@ steps:
           fi
         }
 
+        fetch_active_workflows(){
+          cp /tmp/jobstatus.json /tmp/augmented_jobstatus.json
+          for workflow in `jq -r ".[] | .workflows.workflow_id" /tmp/augmented_jobstatus.json | uniq`
+          do
+            echo "Checking time of workflow: ${workflow}"
+            workflow_file=/tmp/workflow-${workflow}.json
+            if [ ! -z $TESTING_MOCK_WORKFLOW_RESPONSES ] && [ -f $TESTING_MOCK_WORKFLOW_RESPONSES/${workflow}.json ]; then
+              echo "Using test mock workflow response"
+              cat $TESTING_MOCK_WORKFLOW_RESPONSES/${workflow}.json > ${workflow_file}
+            else
+              curl -f -s "https://circleci.com/api/v2/workflow/${workflow}?circle-token=${CIRCLECI_API_KEY}" > ${workflow_file}
+            fi
+            created_at=`jq -r '.created_at' ${workflow_file}`
+            echo "Workflow was created at: ${created_at}"
+            cat /tmp/augmented_jobstatus.json | jq --arg created_at "${created_at}" --arg workflow "${workflow}" '(.[] | select(.workflows.workflow_id == $workflow) | .workflows) |= . + {created_at:$created_at}' > /tmp/augmented_jobstatus-${workflow}.json
+            #DEBUG echo "new augmented_jobstatus:"
+            #DEBUG cat /tmp/augmented_jobstatus-${workflow}.json
+            mv /tmp/augmented_jobstatus-${workflow}.json /tmp/augmented_jobstatus.json
+          done
+        }
+
         update_comparables(){     
           fetch_filtered_active_builds
 
+          fetch_active_workflows
+
           load_current_workflow_values
 
           # falsey parameters are empty strings, so always compare against 'true' 
-          if [ "<<parameters.consider-job>>" != "true" ] || [ "<<parameters.block-workflow>>" = "true" ] ;then
+          if [ "<<parameters.block-workflow>>" = "true" ] ;then
             echo "Orb parameter block-workflow is true."
             echo "This job will block until no previous workflows have *any* jobs running."
-            oldest_running_build_num=`jq 'sort_by(.committer_date)| .[0].build_num' /tmp/jobstatus.json`
-            oldest_commit_time=`jq 'sort_by(.committer_date)| .[0].committer_date' /tmp/jobstatus.json`
+            oldest_running_build_num=`jq 'sort_by(.workflows.created_at)| .[0].build_num' /tmp/augmented_jobstatus.json`
+            oldest_commit_time=`jq 'sort_by(.workflows.created_at)| .[0].workflows.created_at' /tmp/augmented_jobstatus.json`
           else
             echo "Orb parameter block-workflow is false."
             echo "Only blocking execution if running previous jobs matching this job: ${CIRCLE_JOB}"
-            oldest_running_build_num=`jq ". | map(select(.build_parameters.CIRCLE_JOB==\"${CIRCLE_JOB}\")) | sort_by(.committer_date)|  .[0].build_num" /tmp/jobstatus.json`
-            oldest_commit_time=`jq ". | map(select(.build_parameters.CIRCLE_JOB==\"${CIRCLE_JOB}\")) | sort_by(.committer_date)|  .[0].committer_date" /tmp/jobstatus.json`
+            oldest_running_build_num=`jq ". | map(select(.build_parameters.CIRCLE_JOB==\"${CIRCLE_JOB}\")) | sort_by(.workflows.created_at)|  .[0].build_num" /tmp/augmented_jobstatus.json`
+            oldest_commit_time=`jq ". | map(select(.build_parameters.CIRCLE_JOB==\"${CIRCLE_JOB}\")) | sort_by(.workflows.created_at)|  .[0].workflows.created_at" /tmp/augmented_jobstatus.json`
           fi
           echo "Oldest job: $oldest_running_build_num"
           if [ -z $oldest_commit_time ];then
             echo "API Call for existing jobs failed, failing this build.  Please check API token"
+            echo "All running jobs:"
+            cat /tmp/jobstatus.json || exit 0
+            echo "All running jobs with created_at:"
+            cat /tmp/augmented_jobstatus.json || exit 0
+            echo "All worfklow details."
+            cat /tmp/workflow-*.json
             exit 1
           fi
         }
 
         load_current_workflow_values(){
-           my_commit_time=`jq '.[] | select( .build_num == '"${CIRCLE_BUILD_NUM}"').committer_date' /tmp/jobstatus.json`
-
+           my_commit_time=`jq '.[] | select( .build_num == '"${CIRCLE_BUILD_NUM}"').workflows.created_at' /tmp/augmented_jobstatus.json`
         }
 
         cancel_current_build(){
@@ -138,15 +165,23 @@ steps:
         #
         # Queue Loop
         #
+        confidence=0
         while true; do
           update_comparables
           echo "This Workflow Timestamp: $my_commit_time"
           echo "Oldest Workflow Timestamp: $oldest_commit_time"
           if [[ "$oldest_commit_time" > "$my_commit_time" ]] || [[ "$oldest_commit_time" = "$my_commit_time" ]] ; then
             # API returns Y-M-D HH:MM (with 24 hour clock) so alphabetical string compare is accurate to timestamp compare as well
-            # in event of race, everyone wins
-            echo "Front of the line, WooHoo!, Build continuing"
-            break
+            # recent-jobs API does not include pending, so it is posisble we queried in between a workfow transition, and we;re NOT really front of line.
+            if [ $confidence -lt <<parameters.confidence>> ];then
+              # To grow confidence, we check again with a delay.
+              confidence=$((confidence+1))
+              echo "API shows no previous jobs/workflows, but it is possible a previous workflow has pending jobs not yet visible in API."
+              echo "Rerunning check ${confidence}/<<parameters.confidence>>"
+            else
+              echo "Front of the line, WooHoo!, Build continuing"
+              break
+            fi
           else
             echo "This build (${CIRCLE_BUILD_NUM}) is queued, waiting for build number (${oldest_running_build_num}) to complete."
             echo "Total Queue time: ${wait_time} seconds."

src/jobs/block_workflow.yml

@@ -3,11 +3,6 @@ parameters:
     type: boolean
     default: true
     description: "Should we only consider jobs running on the same branch?"
-  consider-job:
-    type: boolean
-    # deprecated, do not use.
-    default: false
-    description: "Deprecated. Please see block-workflow."
   block-workflow:
     type: boolean
     # this is true at JOB level as intention is to block workflow
@@ -24,20 +19,25 @@ parameters:
   only-on-branch:
     type: string
     default: "*"
-    description: "Only queue on specified branch"
+    description: "Only queue on specified branch. Default is to enforce serialization on all branches."
   vcs-type:
     type: string
     default: "github"
     description: "Override VCS to 'bitbucket' if needed."
+  confidence:
+    type: string
+    default: "1"
+    description: "Due to scarce API, we need to requery the recent jobs list to ensure we're not just in a pending state for previous jobs.  This number indicates the threhold for API returning no previous pending jobs. Default is a single confirmation."
 
 docker:
-  - image: circleci/node:10 #its just really popular, and therefore fast (cached)
+  - image: cimg/base:stable
+resource_class: small
 steps:
   - until_front_of_line:
       consider-branch: <<parameters.consider-branch>>
-      consider-job: <<parameters.consider-job>>
       block-workflow: <<parameters.block-workflow>>
       time: <<parameters.time>>
       dont-quit: <<parameters.dont-quit>>
       only-on-branch: <<parameters.only-on-branch>>
       vcs-type: <<parameters.vcs-type>>
+      confidence: <<parameters.confidence>>

test/api/nopreviousjobs.json renamed to test/api/jobs/nopreviousjobs.json

@@ -3,7 +3,6 @@
 {
   "testing-note":"This represents the current build, with a job that should be serial",
   "build_num" : 2,
-
   "committer_date": "2019-01-17T11:17:24-05:00",
   "branch" : "master",
   "build_parameters":{

test/api/onepreviousjob-differentname.json renamed to test/api/jobs/onepreviousjob-differentname.json

@@ -31,7 +31,7 @@
   "workflows" : {
     "job_name" : "adifferentjob",
     "job_id" : "random-hash-2",
-    "workflow_id" : "ec6172d3-b286-4d3a-a1da-c4efba0a0c05",
+    "workflow_id" : "aaa8751e-eb0d-4b09-12bd-06a9bb763771",
     "workspace_id" : "a1892dee-6e9e-4f2e-adbc-a5629a97b483",
     "upstream_job_ids" : [ ],
     "upstream_concurrency_map" : { },

test/api/onepreviousjobsamename.json renamed to test/api/jobs/onepreviousjobsamename.json

@@ -31,7 +31,7 @@
   "workflows" : {
     "job_name" : "singlejob",
     "job_id" : "random-hash-2",
-    "workflow_id" : "ec6172d3-b286-4d3a-a1da-c4efba0a0c05",
+    "workflow_id" : "aaa8751e-eb0d-4b09-12bd-06a9bb763771",
     "workspace_id" : "a1892dee-6e9e-4f2e-adbc-a5629a97b483",
     "upstream_job_ids" : [ ],
     "upstream_concurrency_map" : { },

test/api/workflows/aaa8751e-eb0d-4b09-12bd-06a9bb763771.json

@@ -0,0 +1,10 @@
+{
+  "stopped_at" : null,
+  "name" : "build-deploy",
+  "project_slug" : "test/project",
+  "pipeline_number" : 1,
+  "status" : "running",
+  "id" : "aaa8751e-eb0d-4b09-12bd-06a9bb763771",
+  "created_at" : "2019-01-17T10:17:23-05:00",
+  "pipeline_id" : "aaa8751e-eb0d-4b09-12bd-06a9bb763775"
+}