eng/common/pipeline-logging-functions.sh

   1 #!/usr/bin/env bash
   2
   3 function Write-PipelineTelemetryError {
   4   local telemetry_category=''
   5   local force=false
   6   local function_args=()
   7   local message=''
   8   while [[ $# -gt 0 ]]; do
   9     opt="$(echo "${1/#--/-}" | awk '{print tolower($0)}')"
  10     case "$opt" in
  11       -category|-c)
  12         telemetry_category=$2
  13         shift
  14         ;;
  15       -force|-f)
  16         force=true
  17         ;;
  18       -*)
  19         function_args+=("$1 $2")
  20         shift
  21         ;;
  22       *)
  23         message=$*
  24         ;;
  25     esac
  26     shift
  27   done
  28
  29   if [[ $force != true ]] && [[ "$ci" != true ]]; then
  30     echo "$message" >&2
  31     return
  32   fi
  33
  34   message="(NETCORE_ENGINEERING_TELEMETRY=$telemetry_category) $message"
  35   function_args+=("$message")
  36   if [[ $force == true ]]; then
  37     function_args+=("-force")
  38   fi
  39
  40   Write-PipelineTaskError $function_args
  41 }
  42
  43 function Write-PipelineTaskError {
  44   if [[ $force != true ]] && [[ "$ci" != true ]]; then
  45     echo "$@" >&2
  46     return
  47   fi
  48
  49   local message_type="error"
  50   local sourcepath=''
  51   local linenumber=''
  52   local columnnumber=''
  53   local error_code=''
  54
  55   while [[ $# -gt 0 ]]; do
  56     opt="$(echo "${1/#--/-}" | awk '{print tolower($0)}')"
  57     case "$opt" in
  58       -type|-t)
  59         message_type=$2
  60         shift
  61         ;;
  62       -sourcepath|-s)
  63         sourcepath=$2
  64         shift
  65         ;;
  66       -linenumber|-ln)
  67         linenumber=$2
  68         shift
  69         ;;
  70       -columnnumber|-cn)
  71         columnnumber=$2
  72         shift
  73         ;;
  74       -errcode|-e)
  75         error_code=$2
  76         shift
  77         ;;
  78       *)
  79         break
  80         ;;
  81     esac
  82
  83     shift
  84   done
  85
  86   local message="##vso[task.logissue"
  87
  88   message="$message type=$message_type"
  89
  90   if [ -n "$sourcepath" ]; then
  91     message="$message;sourcepath=$sourcepath"
  92   fi
  93
  94   if [ -n "$linenumber" ]; then
  95     message="$message;linenumber=$linenumber"
  96   fi
  97
  98   if [ -n "$columnnumber" ]; then
  99     message="$message;columnnumber=$columnnumber"
 100   fi
 101
 102   if [ -n "$error_code" ]; then
 103     message="$message;code=$error_code"
 104   fi
 105
 106   message="$message]$*"
 107   echo "$message"
 108 }
 109
 110 function Write-PipelineSetVariable {
 111   if [[ "$ci" != true ]]; then
 112     return
 113   fi
 114
 115   local name=''
 116   local value=''
 117   local secret=false
 118   local as_output=false
 119   local is_multi_job_variable=true
 120
 121   while [[ $# -gt 0 ]]; do
 122     opt="$(echo "${1/#--/-}" | awk '{print tolower($0)}')"
 123     case "$opt" in
 124       -name|-n)
 125         name=$2
 126         shift
 127         ;;
 128       -value|-v)
 129         value=$2
 130         shift
 131         ;;
 132       -secret|-s)
 133         secret=true
 134         ;;
 135       -as_output|-a)
 136         as_output=true
 137         ;;
 138       -is_multi_job_variable|-i)
 139         is_multi_job_variable=$2
 140         shift
 141         ;;
 142     esac
 143     shift
 144   done
 145
 146   value=${value/;/%3B}
 147   value=${value/\\r/%0D}
 148   value=${value/\\n/%0A}
 149   value=${value/]/%5D}
 150
 151   local message="##vso[task.setvariable variable=$name;isSecret=$secret;isOutput=$is_multi_job_variable]$value"
 152
 153   if [[ "$as_output" == true ]]; then
 154     $message
 155   else
 156     echo "$message"
 157   fi
 158 }
 159
 160 function Write-PipelinePrependPath {
 161   local prepend_path=''
 162
 163   while [[ $# -gt 0 ]]; do
 164     opt="$(echo "${1/#--/-}" | awk '{print tolower($0)}')"
 165     case "$opt" in
 166       -path|-p)
 167         prepend_path=$2
 168         shift
 169         ;;
 170     esac
 171     shift
 172   done
 173
 174   export PATH="$prepend_path:$PATH"
 175
 176   if [[ "$ci" == true ]]; then
 177     echo "##vso[task.prependpath]$prepend_path"
 178   fi
 179 }