Migrate all scripts to use standard variables for Jira

Author: andrewnicols

jira.sh

@@ -0,0 +1,36 @@
+#!/usr/bin/env bash
+#
+# This file contains the standard configuration relating to all queries used for tracker automations.
+# Any use of numeric custom fields or filters should be defined here.
+# This file should be sourced by any script that needs to use the tracker.
+
+set -e
+
+customfield_automatedTestResults=17112
+customfield_componentLeadReview=15810
+customfield_currentlyInIntegration=10211
+customfield_integrationDate=10210
+customfield_integrationPriority=12210
+customfield_integrator=10110
+customfield_pullFromRepository=10100
+customfield_tester=10011
+
+filter_candidatesForCLR=23329
+filter_candidatesForIntegration=14000
+filter_integrationCLRDecision=23535
+filter_issuesHeldUntilAfterRelease=21366
+filter_issuesVotedToUnhold=22054
+filter_issuesWaitingForReviewOrInProgress=22610
+filter_mustFixIssues=21363
+
+# Verify everything is set
+required="jiraclicmd jiraserver jirauser jirapass"
+for var in $required; do
+    if [ -z "${!var}" ]; then
+        echo "Error: ${var} environment variable is not defined. See the script comments."
+        exit 1
+    fi
+done
+
+# Set the base request command.
+basereq="${jiraclicmd} --server ${jiraserver} --user ${jirauser} --password ${jirapass}"

tracker_automations/bulk_precheck_issues/bulk_precheck_issues.sh

@@ -4,9 +4,9 @@
 #jiraserver: jira server url we are going to connect to
 #jirauser: user that will perform the execution
 #jirapass: password of the user
-#cf_repository: id for "Pull from Repository" custom field (customfield_10100)
-#cf_branches: pairs of moodle branch and id for "Pull XXXX Branch" custom field (main:customfield_10111,....)
-#cf_testinginstructions: id for testing instructions custom field (customfield_10117)
+#cf_repository: id for "Pull from Repository" custom field (customfield_XXXXX)
+#cf_branches: pairs of moodle branch and id for "Pull XXXX Branch" custom field (main:customfield_XXXXX,....)
+#cf_testinginstructions: id for testing instructions custom field (customfield_XXXXX)
 #criteria: "awaiting peer review", "awaiting integration", "developer request"
 #informtofiles: comma separated list of files where each MDL processed will be informed (format MDL-xxxx unixseconds)
 #$maxcommitswarn: Max number of commits accepted per run. Warning if exceeded. Defaults to 10.
@@ -22,14 +22,17 @@
 set -e
 
 # Verify everything is set
-required="WORKSPACE jiraclicmd jiraserver jirauser jirapass cf_repository cf_branches cf_testinginstructions criteria quiet jenkinsjobname jenkinsserver publishserver"
+required="WORKSPACE cf_repository cf_branches cf_testinginstructions criteria quiet jenkinsjobname jenkinsserver publishserver"
 for var in $required; do
     if [ -z "${!var}" ]; then
         echo "Error: ${var} environment variable is not defined. See the script comments."
         exit 1
     fi
 done
 
+# Load Jira Configuration.
+source ../jira.sh
+
 # wipe the workspace
 rm -fr "${WORKSPACE}"/*
 
@@ -39,7 +42,6 @@ echo -n > "${resultfile}"
 
 # Calculate some variables
 mydir="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
-basereq="${jiraclicmd} --server ${jiraserver} --user ${jirauser} --password ${jirapass}"
 
 # Normalise criteria
 criteria=${criteria// /_}

tracker_automations/bulk_prelaunch_jobs/bulk_prelaunch_jobs.sh

@@ -8,9 +8,9 @@
 #jenkinsauth: String that defines the method to connect to the jenkins server, can be -ssh
 #  (requiring keys to be in place and jenkins ssh enabled), or also -html (and then
 #  use a combination of user and password or token). See Jenkins CLI docs for more info.
-#cf_repository: id for "Pull from Repository" custom field (customfield_10100)
+#cf_repository: id for "Pull from Repository" custom field (customfield_XXXXX)
 #cf_branches: comma separated trios of moodle branch, id for "Pull XXXX Branch" custom field and php version.
-#             Trios are colon separated, example: main:customfield_10111:7.3,....). All them required.
+#             Trios are colon separated, example: main:customfield_XXXXX:7.3,....). All them required.
 #criteria: "awaiting integration"...
 #schedulemins: Frecuency (in minutes) of the schedule (cron) of this job. IMPORTANT to ensure that they match or there will be issues processed more than once or skipped.
 #jobtype: defaulting to "all", allows to just pick one of the available jobs: phpunit, behat-(firefox|chrome|nonjs|all).
@@ -20,14 +20,17 @@
 set -e
 
 # Verify everything is set
-required="WORKSPACE jiraclicmd jiraserver jirauser jirapass jenkinsserver jenkinsauth cf_repository cf_branches criteria schedulemins quiet"
+required="WORKSPACE jenkinsserver jenkinsauth cf_repository cf_branches criteria schedulemins quiet"
 for var in $required; do
     if [ -z "${!var}" ]; then
         echo "Error: ${var} environment variable is not defined. See the script comments."
         exit 1
     fi
 done
 
+# Load Jira Configuration.
+source ../jira.sh
+
 # wipe the workspace
 rm -fr "${WORKSPACE}"/*
 
@@ -37,7 +40,6 @@ echo -n > "${resultfile}"
 
 # Calculate some variables
 mydir="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
-basereq="${jiraclicmd} --server ${jiraserver} --user ${jirauser} --password ${jirapass}"
 
 # Normalise criteria
 criteria=${criteria// /_}

tracker_automations/bulk_prelaunch_jobs/criteria/list_of_mdls_sdev/query.sh

@@ -1,7 +1,7 @@
 ${basereq} --action getIssueList \
            --jql "project = 'Moodle' \
                  AND issue IN (${issueslist}) \
-                 AND cf[10100] ~ 'integration/security-testing' \
+                 AND cf[${customfield_pullFromRepository}] ~ 'integration/security-testing' \
                  AND level IS NOT EMPTY \
                  ORDER BY priority DESC, votes DESC, 'Last comment date' ASC" \
            --outputFormat 101 \

tracker_automations/check_marked_as_integrated/check_marked_as_integrated.sh

@@ -22,21 +22,23 @@ if [ -z "$gitremotename" ]; then
 fi
 
 # Verify everything is set
-required="WORKSPACE jiraclicmd jiraserver jirauser jirapass gitcmd gitdir gitremotename devbranches"
+required="WORKSPACE gitcmd gitdir gitremotename devbranches"
 for var in $required; do
     if [ -z "${!var}" ]; then
         echo "Error: ${var} environment variable is not defined. See the script comments."
         exit 1
     fi
 done
 
+# Load Jira Configuration.
+source ../jira.sh
+
 # file where results will be sent
 resultfile="$WORKSPACE/check_marked_as_integrated.csv"
 echo -n > "${resultfile}"
 
 # Calculate some variables
 mydir="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
-basereq="${jiraclicmd} --server ${jiraserver} --user ${jirauser} --password ${jirapass}"
 IFS=',' read -a devbranchesarr <<< "$devbranches" # Convert devbranches to array.
 
 # Include some utility functions

tracker_automations/close_tested_issues/close_tested_issues.sh

@@ -16,14 +16,17 @@
 set -e
 
 # Verify everything is set
-required="WORKSPACE jiraclicmd jiraserver jirauser jirapass"
+required="WORKSPACE"
 for var in $required; do
     if [ -z "${!var}" ]; then
         echo "Error: ${var} environment variable is not defined. See the script comments."
         exit 1
     fi
 done
 
+# Load Jira Configuration.
+source ../jira.sh
+
 # file where results will be sent
 resultfile=$WORKSPACE/close_tested_issues.csv
 echo -n > "${resultfile}"
@@ -33,7 +36,6 @@ logfile=$WORKSPACE/close_tested_issues.log
 
 # Calculate some variables
 mydir="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
-basereq="${jiraclicmd} --server ${jiraserver} --user ${jirauser} --password ${jirapass}"
 BUILD_TIMESTAMP="$(date +'%Y-%m-%d_%H-%M-%S')"
 
 # Set closedate and closecomment if not specified
@@ -59,8 +61,8 @@ for issue in $( sed -n 's/^"\(MDL-[0-9]*\)".*/\1/p' "${resultfile}" ); do
         --issue ${issue} \
         --transition "Mark as committed" \
         --resolution "Fixed" \
-        --field "customfield_10211=" \
-        --field "customfield_10210=${altdate}" \
+        --field "customfield_${customfield_currentlyInIntegration}=" \
+        --field "customfield_${customfield_integrationDate}=${altdate}" \
         --comment "${altcomment}"
     echo "$BUILD_NUMBER $BUILD_TIMESTAMP ${issue}" >> "${logfile}"
 done

tracker_automations/component_leads_integration_mover/component_leads_integration_mover.sh

@@ -15,14 +15,17 @@
 set -e
 
 # Verify everything is set
-required="WORKSPACE jiraclicmd jiraserver jirauser jirapass jsonclrurl releasedate"
+required="WORKSPACE jsonclrurl releasedate"
 for var in $required; do
     if [ -z "${!var}" ]; then
         echo "Error: ${var} environment variable is not defined. See the script comments."
         exit 1
     fi
 done
 
+# Load Jira Configuration.
+source ../jira.sh
+
 # We need curl to execute this script.
 if [[ ! $(which curl) ]]; then
     echo "Error: This script needs \"curl\" installed to work"
@@ -47,7 +50,6 @@ clrfile=${WORKSPACE}/clr.json
 
 # Calculate some variables
 mydir="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
-basereq="${jiraclicmd} --server ${jiraserver} --user ${jirauser} --password ${jirapass}"
 BUILD_TIMESTAMP="$(date +'%Y-%m-%d_%H-%M-%S')"
 
 if [[ "${clearcache}" == "true" ]]; then
@@ -110,9 +112,8 @@ if [ "${nowdate}" -ge "${freezedate}" ] && [ "${nowdate}" -lt "${onsyncenddate}"
 fi
 
 # Search for all the issues awaiting for integration and not being decided between CLR/IR.
-# Note: customfield_10118 is the peer reviewer custom field.
 ${basereq} --action getIssueList \
-           --jql "filter = 23535 ${excludequery}" \
+           --jql "filter = ${filter_integrationCLRDecision} ${excludequery}" \
            --columns="Key,Assignee,Peer reviewer,Components,Security Level,Summary" \
            --outputFormat=4 \
            --outputType=json \
@@ -159,13 +160,13 @@ jq -c '.[]' ${resultfile} | while read -r json; do
         # we are setting some custom fields not available (on purpose) on that screen. So we have created a
         # global transition, only available to the bots, not transitioning but bringing access to all the fields
         # via special screen. So we'll ne using that global transition via transitionIssue instead.
-        # customfield_15810 is the "Component Lead Review" field (Yes => CLR, No => IR, empty => undecided).
+        # "Component Lead Review" field: (Yes => CLR, No => IR, empty => undecided).
         if [[ "${outcome}" == "IR" ]]; then
             # No CLR. Just update the field.
             ${basereq} --action transitionIssue \
                        --issue ${issue} \
                        --transition "CI Global Self-Transition" \
-                       --field "customfield_15810=No"
+                       --field "customfield_${customfield_componentLeadReview}=No"
         else
             # CLR. Real transition to Waiting for CLR.
             ${basereq} --action transitionIssue \

tracker_automations/continuous_manage_queues/continuous_manage_queues.sh

@@ -44,14 +44,17 @@
 set -e
 
 # Verify everything is set
-required="WORKSPACE jiraclicmd jiraserver jirauser jirapass releasedate"
+required="WORKSPACE releasedate"
 for var in $required; do
     if [ -z "${!var}" ]; then
         echo "Error: ${var} environment variable is not defined. See the script comments."
         exit 1
     fi
 done
 
+# Load Jira Configuration.
+source ../jira.sh
+
 # file where results will be sent
 resultfile=$WORKSPACE/continuous_manage_queues.csv
 echo -n > "${resultfile}"
@@ -61,7 +64,6 @@ logfile=$WORKSPACE/continuous_manage_queues.log
 
 # Calculate some variables
 mydir="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
-basereq="${jiraclicmd} --server ${jiraserver} --user ${jirauser} --password ${jirapass}"
 BUILD_TIMESTAMP="$(date +'%Y-%m-%d_%H-%M-%S')"
 
 source ${mydir}/lib.sh # Add all the functions.