Merge remote-tracking branch 'origin/erichaagdev/maven-exp2-scan-dump' into dev

* origin/erichaagdev/maven-exp2-scan-dump:
  Fail when scans-support-tools not found
  Adjust interactive text accordingly
  Use Build Scan dumps for maven-exp2
  Extract common components to new lib

Author: erichaagdev

components/scripts/gradle/03-validate-local-build-caching-different-locations.sh

@@ -19,7 +19,6 @@ readonly SCRIPT_NAME
 SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")"; cd -P "$(dirname "$(readlink "${BASH_SOURCE[0]}" || echo .)")"; pwd)"
 readonly SCRIPT_DIR
 readonly LIB_DIR="${SCRIPT_DIR}/lib"
-readonly SCANS_SUPPORT_TOOLS_JAR="${SCRIPT_DIR}/scans-support-tools.jar"
 
 # Include and parse the command line arguments
 # shellcheck source=lib/03-cli-parser.sh
@@ -38,9 +37,6 @@ enable_ge=''
 ge_server=''
 interactive_mode=''
 
-# Used when Build Scan publishing is disabled
-build_scan_dumps=()
-
 main() {
   if [[ "$build_scan_publishing_mode" == "off" ]]; then
     verify_scans_support_tools
@@ -55,12 +51,6 @@ main() {
   exit_with_return_code
 }
 
-verify_scans_support_tools() {
-  if [ ! -f "$SCANS_SUPPORT_TOOLS_JAR" ]; then
-    die "ERROR: scans-support-tools.jar is required when running with --disable-build-scan-publishing."
-  fi
-}
-
 execute() {
   print_bl
   validate_required_config
@@ -184,34 +174,10 @@ fetch_build_cache_metrics() {
     read_build_scan_metadata
     fetch_and_read_build_scan_data build_cache_metrics_only "${build_scan_urls[@]}"
   else
-    find_build_scan_dumps
-    read_build_scan_dumps
+    find_and_read_build_scan_dumps
   fi
 }
 
-find_build_scan_dumps() {
-  find_build_scan_dump "first"
-  find_build_scan_dump "second"
-}
-
-find_build_scan_dump() {
-  local build_name="$1"
-  local build_dir="${EXP_DIR}/$build_name-build_${project_name}"
-  build_scan_dump="$(find "$build_dir" -maxdepth 1 -type f -regex '^.*build-scan-.*-.*-.*-.*\.scan' | sort | tail -n 1)"
-  if [ -z "$build_scan_dump" ]; then
-    die "ERROR: No Build Scan dump found for the $build_name build"
-  fi
-  build_scan_dumps+=("${build_scan_dump}")
-}
-
-read_build_scan_dumps() {
-  local build_scan_csv
-  echo -n "Extracting build scan data"
-  build_scan_csv="$(invoke_java "$SCANS_SUPPORT_TOOLS_JAR" extract "${build_scan_dumps[0]}"  "${build_scan_dumps[1]}")"
-  parse_build_scan_csv "$build_scan_csv"
-  echo ", done."
-}
-
 # Overrides info.sh#print_performance_metrics
 print_performance_metrics() {
   print_build_caching_leverage_metrics

components/scripts/lib/build-scan-dump.sh

@@ -0,0 +1,39 @@
+#!/usr/bin/env bash
+
+readonly SCANS_SUPPORT_TOOLS_JAR="${SCRIPT_DIR}/scans-support-tools.jar"
+
+build_scan_dumps=()
+
+verify_scans_support_tools() {
+  if [ ! -f "$SCANS_SUPPORT_TOOLS_JAR" ]; then
+    die "ERROR: scans-support-tools.jar is required when running with --disable-build-scan-publishing."
+  fi
+}
+
+find_and_read_build_scan_dumps() {
+  find_build_scan_dumps
+  read_build_scan_dumps
+}
+
+find_build_scan_dumps() {
+  find_build_scan_dump "first"
+  find_build_scan_dump "second"
+}
+
+find_build_scan_dump() {
+  local build_name="$1"
+  local build_dir="${EXP_DIR}/$build_name-build_${project_name}"
+  build_scan_dump="$(find "$build_dir" -maxdepth 1 -type f -regex '^.*build-scan-.*-.*-.*-.*\.scan' | sort | tail -n 1)"
+  if [ -z "$build_scan_dump" ]; then
+    die "ERROR: No Build Scan dump found for the $build_name build"
+  fi
+  build_scan_dumps+=("${build_scan_dump}")
+}
+
+read_build_scan_dumps() {
+  local build_scan_csv
+  echo -n "Extracting build scan data"
+  build_scan_csv="$(invoke_java "$SCANS_SUPPORT_TOOLS_JAR" extract "${build_scan_dumps[0]}"  "${build_scan_dumps[1]}")"
+  parse_build_scan_csv "$build_scan_csv"
+  echo ", done."
+}

components/scripts/lib/cli-parsers/maven/02-cli-parser.m4

@@ -1,6 +1,7 @@
 #!/usr/bin/env bash
 # shellcheck disable=SC2034  # It is common for variables in this auto-generated file to go unused
 # Created by argbash-init v2.10.0
+# ARG_OPTIONAL_BOOLEAN([disable-build-scan-publishing],[x],[])
 # ARG_HELP([This function is overridden later on.])
 # ARG_VERSION([print_version],[v],[version],[])
 # ARGBASH_WRAP([common])
@@ -26,6 +27,7 @@ function print_help() {
   print_option_usage -a
   print_option_usage -s
   print_option_usage -e
+  print_option_usage -x
   print_option_usage -f
   print_option_usage -v
   print_option_usage -h

components/scripts/lib/libs.sh

@@ -12,6 +12,12 @@ failed_to_load_lib() {
   exit "${_UNEXPECTED_ERROR}"
 }
 
+# shellcheck source=lib/build-scan-dump.sh
+source "${LIB_DIR}/build-scan-dump.sh" || failed_to_load_lib build-scan-dump.sh
+
+# shellcheck source=lib/build-scan-parse.sh
+source "${LIB_DIR}/build-scan-parse.sh" || failed_to_load_lib build-scan-parse.sh
+
 # shellcheck source=lib/build_scan.sh
 source "${LIB_DIR}/build_scan.sh" || failed_to_load_lib build_scan.sh
 
@@ -45,9 +51,6 @@ source "${LIB_DIR}/java.sh" || failed_to_load_lib java.sh
 # shellcheck source=lib/maven.sh
 source "${LIB_DIR}/maven.sh" || failed_to_load_lib maven.sh
 
-# shellcheck source=lib/build-scan-parse.sh
-source "${LIB_DIR}/build-scan-parse.sh" || failed_to_load_lib build-scan-parse.sh
-
 # shellcheck source=lib/paths.sh
 source "${LIB_DIR}/paths.sh" || failed_to_load_lib paths.sh
 

components/scripts/lib/maven.sh

@@ -40,8 +40,13 @@ invoke_maven() {
     done
   fi
 
+  if [ "$build_scan_publishing_mode" == "off" ]; then
+    args+=("-Dscan.dump")
+  else
+    args+=("-Dscan")
+  fi
+
   args+=(
-    -Dscan
     -Dmaven.ext.class.path="${extension_classpath}"
     -Dcom.gradle.enterprise.build_validation.experimentDir="${EXP_DIR}"
     -Dcom.gradle.enterprise.build_validation.expId="${EXP_SCAN_TAG}"

components/scripts/maven/02-validate-local-build-caching-different-locations.sh

@@ -38,6 +38,10 @@ ge_server=''
 interactive_mode=''
 
 main() {
+  if [[ "$build_scan_publishing_mode" == "off" ]]; then
+    verify_scans_support_tools
+  fi
+
   if [ "${interactive_mode}" == "on" ]; then
     wizard_execute
   else
@@ -74,11 +78,15 @@ wizard_execute() {
   print_bl
   print_introduction
 
-  print_bl
-  explain_prerequisites_ccud_maven_extension "I."
-
-  print_bl
-  explain_prerequisites_api_access "II."
+  if [[ "${build_scan_publishing_mode}" == "on" ]]; then
+    print_bl
+    explain_prerequisites_ccud_maven_extension "I."
+    print_bl
+    explain_prerequisites_api_access "II."
+  else
+    print_bl
+    explain_prerequisites_ccud_maven_extension
+  fi
 
   print_bl
   explain_collect_git_details
@@ -122,7 +130,7 @@ wizard_execute() {
 
 execute_first_build() {
   info "Running first build:"
-  info "./mvnw -Dscan -Dscan.tag.${EXP_SCAN_TAG} -Dscan.value.runId=${RUN_ID} clean ${tasks}$(print_extra_args)"
+  print_maven_command
 
   # shellcheck disable=SC2086  # we want tasks to expand with word splitting in this case
   invoke_maven \
@@ -134,7 +142,7 @@ execute_first_build() {
 
 execute_second_build() {
   info "Running second build:"
-  info "./mvnw -Dscan -Dscan.tag.${EXP_SCAN_TAG} -Dscan.value.runId=${RUN_ID} clean ${tasks}$(print_extra_args)"
+  print_maven_command
 
   cd "${EXP_DIR}/second-build_${project_name}" || die "Unable to cd to ${EXP_DIR}/second-build_${project_name}"
 
@@ -146,9 +154,21 @@ execute_second_build() {
      clean ${tasks}
 }
 
+print_maven_command() {
+  if [[ "${build_scan_publishing_mode}" == "on" ]]; then
+    info "./mvnw -Dscan -Dscan.tag.${EXP_SCAN_TAG} -Dscan.value.runId=${RUN_ID} clean ${tasks}$(print_extra_args)"
+  else
+    info "./mvnw -Dscan.dump -Dscan.tag.${EXP_SCAN_TAG} -Dscan.value.runId=${RUN_ID} clean ${tasks}$(print_extra_args)"
+  fi
+}
+
 fetch_build_cache_metrics() {
-  read_build_scan_metadata
-  fetch_and_read_build_scan_data build_cache_metrics_only "${build_scan_urls[@]}"
+  if [ "$build_scan_publishing_mode" == "on" ]; then
+    read_build_scan_metadata
+    fetch_and_read_build_scan_data build_cache_metrics_only "${build_scan_urls[@]}"
+  else
+    find_and_read_build_scan_dumps
+  fi
 }
 
 # Overrides info.sh#print_performance_metrics
@@ -288,7 +308,8 @@ EOF
 
 explain_measure_build_results() {
   local text
-  IFS='' read -r -d '' text <<EOF
+  if [[ "${build_scan_publishing_mode}" == "on" ]]; then
+    IFS='' read -r -d '' text <<EOF
 $(print_separator)
 ${HEADER_COLOR}Measure build results${RESTORE}
 
@@ -301,22 +322,36 @@ two builds to assist you in your investigation.
 
 ${USER_ACTION_COLOR}Press <Enter> to measure the build results.${RESTORE}
 EOF
+  else
+    IFS='' read -r -d '' text <<EOF
+$(print_separator)
+${HEADER_COLOR}Measure build results${RESTORE}
+
+Now that the second build has finished successfully, you are ready to measure in
+Gradle Enterprise how well your build leverages the local build cache for
+the invoked set of Maven goals.
+
+Some of the build scan data will be extracted from the locally stored, intermediate
+build data produced by the two builds to assist you in your investigation.
+
+${USER_ACTION_COLOR}Press <Enter> to measure the build results.${RESTORE}
+EOF
+  fi
   print_wizard_text "${text}"
   wait_for_enter
 }
 
 explain_and_print_summary() {
   read_build_scan_metadata
   local text
-  IFS='' read -r -d '' text <<EOF
+  if [[ "${build_scan_publishing_mode}" == "on" ]]; then
+    IFS='' read -r -d '' text <<EOF
 The ‘Summary’ section below captures the configuration of the experiment and the
 two build scans that were published as part of running the experiment. The build
 scan of the second build is particularly interesting since this is where you can
 inspect what goals were not leveraging the local build cache.
 
-The ‘Build Caching Leverage’ section below reveals the realized and potential
-savings from build caching. All cacheable goals' outputs need to be taken from
-the build cache in the second build for the build to be fully cacheable.
+$(explain_build_cache_leverage)
 
 The ‘Investigation Quick Links’ section below allows quick navigation to the
 most relevant views in build scans to investigate what goals were avoided due to
@@ -332,8 +367,35 @@ $(print_command_to_repeat_experiment)
 
 $(explain_when_to_rerun_experiment)
 EOF
+  else
+    IFS='' read -r -d '' text <<EOF
+The ‘Summary’ section below captures the configuration of the experiment. No
+build scans are available for inspection since publishing was disabled for the
+experiment.
+
+$(explain_build_cache_leverage)
+
+$(explain_command_to_repeat_experiment)
+
+$(print_summary)
+
+$(print_command_to_repeat_experiment)
+
+$(explain_when_to_rerun_experiment)
+EOF
+  fi
   print_wizard_text "${text}"
 }
 
+explain_build_cache_leverage() {
+  local text
+  IFS='' read -r -d '' text <<EOF
+The ‘Build Caching Leverage’ section below reveals the realized and potential
+savings from build caching. All cacheable goals' outputs need to be taken from
+the build cache in the second build for the build to be fully cacheable.
+EOF
+  echo -n "${text}"
+}
+
 process_arguments "$@"
 main