Merge pull request #466 from concourse/debug-mode-370

add debug/verbose mode

Author: taylorsilva

README.md

@@ -287,6 +287,20 @@ commit_filter:
         usually create. See also <code>out params.refs_prefix</code>.
     </td>
   </tr>
+  <tr>
+    <td><code>debug</code> (Optional)</td>
+    <td>
+        Set to <code>true</code> to enable. Sets the following for check/get/put
+        steps of the resource. Secrets may not be correctly redacted due the
+        JSON encoding of longer secret strings.
+        <pre>
+set -x
+export GIT_TRACE=1
+export GIT_TRACE_PACKFILE=1
+export GIT_CURL_VERBOSE=1
+        </pre>
+    </td>
+  </tr>
 </table>
 
 ### Example
@@ -513,6 +527,20 @@ correct key is provided set in `git_crypt_key`.
         <code>source.branch</code> or the default branch) will be fetched.
     </td>
   </tr>
+  <tr>
+    <td><code>debug</code> (Optional)</td>
+    <td>
+        Set to <code>true</code> to enable. Sets the following for check/get/put
+        steps of the resource. Secrets may not be correctly redacted due the
+        JSON encoding of longer secret strings.
+        <pre>
+set -x
+export GIT_TRACE=1
+export GIT_TRACE_PACKFILE=1
+export GIT_CURL_VERBOSE=1
+        </pre>
+    </td>
+  </tr>
 </table>
 
 #### GPG signature verification
@@ -654,6 +682,20 @@ and the `rebase` parameter is not provided, the push will fail.
       Useful when paired with <code>source.search_remote_refs</code> in cases where the git remote renames the ref you pushed.
     </td>
   </tr>
+  <tr>
+    <td><code>debug</code> (Optional)</td>
+    <td>
+        Set to <code>true</code> to enable. Sets the following for check/get/put
+        steps of the resource. Secrets may not be correctly redacted due the
+        JSON encoding of longer secret strings.
+        <pre>
+set -x
+export GIT_TRACE=1
+export GIT_TRACE_PACKFILE=1
+export GIT_CURL_VERBOSE=1
+        </pre>
+    </td>
+  </tr>
 </table>
 
 ## Development

assets/check

@@ -21,6 +21,15 @@ if jq --exit-status 'length > 0' <<< "$unknown_keys" &>/dev/null; then
     exit 1
 fi
 
+debug=$(jq -r '.source.debug // false' <<< "$payload")
+if [[ "$debug" == "true" ]]; then
+    echo "debug mode enabled"
+    set -x
+    export GIT_TRACE=1
+    export GIT_TRACE_PACKFILE=1
+    export GIT_CURL_VERBOSE=1
+fi
+
 load_pubkey "$payload"
 configure_https_tunnel "$payload"
 configure_git_ssl_verification "$payload"

assets/in

@@ -33,6 +33,16 @@ if jq --exit-status 'length > 0' <<< "$unknown_keys" &>/dev/null; then
     exit 1
 fi
 
+src_debug=$(jq -r '.source.debug // false' <<< "$payload")
+params_debug=$(jq -r '.params.debug // false' <<< "$payload")
+if [[ "$src_debug" == "true" || "$params_debug" == "true" ]]; then
+    echo "debug mode enabled"
+    set -x
+    export GIT_TRACE=1
+    export GIT_TRACE_PACKFILE=1
+    export GIT_CURL_VERBOSE=1
+fi
+
 load_pubkey "$payload"
 load_git_crypt_key "$payload"
 configure_https_tunnel "$payload"

assets/in_schema.json

@@ -10,5 +10,6 @@
   "short_ref_format": "",
   "timestamp_format": "",
   "describe_ref_options": "",
-  "all_branches": ""
+  "all_branches": "",
+  "debug": ""
 }

assets/out

@@ -28,6 +28,16 @@ if jq --exit-status 'length > 0' <<< "$unknown_keys" &>/dev/null; then
     exit 1
 fi
 
+src_debug=$(jq -r '.source.debug // false' <<< "$payload")
+params_debug=$(jq -r '.params.debug // false' <<< "$payload")
+if [[ "$src_debug" == "true" || "$params_debug" == "true" ]]; then
+    echo "debug mode enabled"
+    set -x
+    export GIT_TRACE=1
+    export GIT_TRACE_PACKFILE=1
+    export GIT_CURL_VERBOSE=1
+fi
+
 load_pubkey "$payload"
 configure_https_tunnel "$payload"
 configure_git_ssl_verification "$payload"

assets/out_schema.json

@@ -12,5 +12,6 @@
   "annotate": "",
   "notes": "",
   "branch": "",
-  "refs_prefix": ""
+  "refs_prefix": "",
+  "debug": ""
 }

assets/source_schema.json

@@ -25,5 +25,6 @@
   "https_tunnel": "",
   "commit_filter": "",
   "version_depth": "",
-  "search_remote_refs": ""
+  "search_remote_refs": "",
+  "debug": ""
 }