Skip to content

perf(ci): replace mvn help:evaluate with native bash and sed extraction - #14218

Open
lqiu96 wants to merge 1 commit into
googleapis:fix-split-it-module-detectionfrom
lqiu96:perf-replace-mvn-help-evaluate
Open

perf(ci): replace mvn help:evaluate with native bash and sed extraction#14218
lqiu96 wants to merge 1 commit into
googleapis:fix-split-it-module-detectionfrom
lqiu96:perf-replace-mvn-help-evaluate

Conversation

@lqiu96

@lqiu96 lqiu96 commented Aug 31, 2026

Copy link
Copy Markdown
Member

This PR is part 2 of 2 in a stacked series:

  1. fix: avoid running split ITs unexpectedly on unrelated changes (#12029) #14217: fix: avoid running split ITs unexpectedly on unrelated changes (#12029)
  2. This PR: perf(ci): replace mvn help:evaluate with native bash and sed extraction

Problem

In Kokoro CI scripts, mvn help:evaluate was used to parse POM values:

  • In generate_modified_modules_list (.kokoro/common.sh), evaluating project.modules launched a full JVM and evaluated the monorepo POMs, taking 20–30+ seconds on every single CI run.
  • In downstream-build.sh (.kokoro/presubmit/downstream-build.sh), evaluating gapic-showcase.version launched another Maven JVM process.

Changes

  • Pure-Bash Module Extraction: Updated generate_modified_modules_list to use extract_pom_modules pom.xml, extracting all 270 modules in ~0.02s without JVM boot overhead.
  • Sed Showcase Version Extraction: Updated downstream-build.sh to parse <gapic-showcase.version> directly using sed with fail-fast validation.
  • Unit Tests: Added automated unit tests in .kokoro/common_test.sh for extract_pom_modules and generate_modified_modules_list.
  • Refactoring & Best Practices: Scoped all temporary variables as local, used read -r module <<< "${module}" for pure-bash whitespace trimming, and anchored paths with ${scriptDir}/...

@lqiu96
lqiu96 requested review from a team as code owners August 31, 2026 15:36
@lqiu96
lqiu96 force-pushed the perf-replace-mvn-help-evaluate branch from 6521b89 to 0770ed3 Compare August 31, 2026 15:38

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request optimizes the Kokoro CI build scripts by replacing slow Maven commands with pure Bash alternatives to extract module lists and showcase versions, significantly reducing build setup times. It also introduces a helper function to skip integration and GraalVM tests for unmodified modules, backed by new unit tests. The code review feedback points out two important issues in the common script: first, a potential 'dubious ownership' Git error in Docker environments because the safe directory configuration is bypassed in some jobs; and second, a risk of script termination under 'set -e' when using a here-string read to trim whitespace. Both issues should be addressed using the provided code suggestions.

I am having trouble creating individual review comments. Click here to see my feedback.

.kokoro/common.sh (350-354)

high

Since generate_modified_modules_list is no longer called in integration-single and graalvm-single jobs, is_module_modified will be executed without git config --global --add safe.directory having been run. In Kokoro/Docker environments where the build runs under a different user, this will cause git diff to fail with a 'dubious ownership' error.

We should ensure git config --global --add safe.directory "$(realpath .)" is run before executing git diff inside is_module_modified as well.

  if [[ -z "${modified_files:-}" ]]; then
    git config --global --add safe.directory "$(realpath .)"
    local target_branch="${KOKORO_GITHUB_PULL_REQUEST_TARGET_BRANCH:-origin/main}"
    local target_commit="${KOKORO_GITHUB_PULL_REQUEST_COMMIT:-HEAD}"
    modified_files=$(git diff --name-only "${target_branch}...${target_commit}")
  fi

.kokoro/common.sh (125-126)

medium

Using read -r module <<< "${module}" for trimming whitespace can be risky if set -e is enabled in the calling script. If module is empty or contains only whitespace, read will return a non-zero exit status (1), causing the script to abort immediately.

Additionally, here-strings (<<<) can be less efficient as they may write to temporary files or spawn subshells depending on the Bash version. Reverting to the original pure parameter expansion is safer, faster, and avoids any exit status issues.

      # Trim leading/trailing whitespace without spawning external processes
      module="${module#"${module%%[![:space:]]*}"}"
      module="${module%"${module##*[![:space:]]}"}"

@lqiu96
lqiu96 force-pushed the fix-split-it-module-detection branch from c66781c to 4a6a76b Compare August 31, 2026 15:53
@lqiu96
lqiu96 force-pushed the perf-replace-mvn-help-evaluate branch from 0770ed3 to be49b9d Compare August 31, 2026 15:55
@lqiu96
lqiu96 force-pushed the fix-split-it-module-detection branch from 4a6a76b to a15b6a5 Compare August 31, 2026 16:02
@lqiu96
lqiu96 force-pushed the perf-replace-mvn-help-evaluate branch from be49b9d to c185259 Compare August 31, 2026 16:02
lqiu96 added a commit to lqiu96/google-cloud-java that referenced this pull request Aug 31, 2026
…eapis#12029)

This PR is part 1 of 2 in a stacked series:
1. This PR (googleapis#14217): fix: avoid running split ITs unexpectedly on unrelated changes (googleapis#12029)
2. googleapis#14218: perf(ci): replace mvn help:evaluate with native bash and sed extraction

## Problem
In split integration and GraalVM tests (e.g. integration-single and graalvm-single),
module modification detection previously checked if the module name was present as a
substring in modified_module_list. For modules with shared prefixes (such as
java-bigquery vs java-bigquerystorage, java-bigquery-jdbc, or java-bigqueryconnection),
modifying one module could trigger tests for other prefix-sharing modules.

## Changes
- **Modular Helper Functions with Single Responsibility**:
  - `populate_modified_files`: Encapsulates diff retrieval, caching in `modified_files`,
    and configuring git `safe.directory` for Docker container ownership mismatches.
  - `should_test_all_modules`: Purely checks global overrides that require testing all
    modules (parent POMs, core shared dependencies, and `TEST_ALL_MODULES="true"`).
  - `is_module_modified`: Strictly checks if files within a specific module directory
    were modified (`^${module}/`), avoiding prefix collisions.
- **Explicit Job Control in Split Jobs**:
  - In `.kokoro/build.sh` (`integration-single` and `graalvm-single`), runs tests if
    either monorepo-wide testing is required or the specific module was modified:
    `! should_test_all_modules && ! is_module_modified "${BUILD_SUBDIR}"` -> skip.
- **Updated generate_modified_modules_list**:
  - Reuses `populate_modified_files` and `should_test_all_modules`.
- **Unit Tests**:
  - Added unit tests in `.kokoro/common_test.sh` for `is_module_modified` and
    `should_test_all_modules`.

Fixes googleapis#12029
@lqiu96
lqiu96 force-pushed the fix-split-it-module-detection branch from a15b6a5 to 54fb41a Compare August 31, 2026 16:20
@lqiu96
lqiu96 force-pushed the perf-replace-mvn-help-evaluate branch from c185259 to 5ccf52b Compare August 31, 2026 16:21
lqiu96 added a commit to lqiu96/google-cloud-java that referenced this pull request Aug 31, 2026
…eapis#12029)

This PR is part 1 of 2 in a stacked series:
1. This PR (googleapis#14217): fix: avoid running split ITs unexpectedly on unrelated changes (googleapis#12029)
2. googleapis#14218: perf(ci): replace mvn help:evaluate with native bash and sed extraction

## Problem
In split integration and GraalVM tests (e.g. integration-single and graalvm-single),
module modification detection previously checked if the module name was present as a
substring in modified_module_list. For modules with shared prefixes (such as
java-bigquery vs java-bigquerystorage, java-bigquery-jdbc, or java-bigqueryconnection),
modifying one module could trigger tests for other prefix-sharing modules.

## Changes
- **Modular Helper Functions with Single Responsibility**:
  - `populate_modified_files`: Encapsulates diff retrieval, caching in `modified_files`,
    and configuring git `safe.directory` for Docker container ownership mismatches.
  - `should_test_all_modules`: Purely checks global overrides that require testing all
    modules (parent POMs, core shared dependencies, and `TEST_ALL_MODULES="true"`).
  - `is_module_modified`: Strictly checks if files within a specific module directory
    were modified (`^${module}/`), avoiding prefix collisions.
- **Explicit Job Control in Split Jobs**:
  - In `.kokoro/build.sh` (`integration-single` and `graalvm-single`), runs tests if
    either monorepo-wide testing is required or the specific module was modified:
    `! should_test_all_modules && ! is_module_modified "${BUILD_SUBDIR}"` -> skip.
- **Updated generate_modified_modules_list**:
  - Reuses `populate_modified_files` and `should_test_all_modules`.
- **Unit Tests**:
  - Added unit tests in `.kokoro/common_test.sh` for `is_module_modified` and
    `should_test_all_modules`.

Fixes googleapis#12029
@lqiu96
lqiu96 force-pushed the fix-split-it-module-detection branch from 54fb41a to 16b1841 Compare August 31, 2026 16:28
This PR is part 2 of 2 in a stacked series:
1. googleapis#14217: fix: avoid running split ITs unexpectedly on unrelated changes (googleapis#12029)
2. This PR: perf(ci): replace mvn help:evaluate with native bash and sed extraction

In Kokoro CI scripts, mvn help:evaluate was used to parse POM values:
- In generate_modified_modules_list (.kokoro/common.sh), evaluating
  project.modules launched a full JVM and evaluated the monorepo POMs,
  taking 20–30+ seconds on every single CI run.
- In downstream-build.sh (.kokoro/presubmit/downstream-build.sh),
  evaluating gapic-showcase.version launched another Maven JVM process.

- Pure-Bash Module Extraction: Updated generate_modified_modules_list to use
  extract_pom_modules pom.xml, extracting all 270 modules in ~0.02s without JVM
  boot overhead.
- Sed Showcase Version Extraction: Updated downstream-build.sh to parse
  <gapic-showcase.version> directly using sed with fail-fast validation.
- Unit Tests: Added automated unit tests in .kokoro/common_test.sh for
  extract_pom_modules and generate_modified_modules_list.
- Refactoring & Best Practices: Scoped all temporary variables as local,
  used read -r module <<< "${module}" for pure-bash whitespace trimming,
  and anchored paths with ${scriptDir}/..
@lqiu96
lqiu96 force-pushed the perf-replace-mvn-help-evaluate branch from 5ccf52b to d56af14 Compare August 31, 2026 16:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant