XML

Word

Printable

JSON

Details

Type: Task
Status: Resolved
Priority: P3
Resolution: Fixed
Affects Version/s: None
Fix Version/s: 2.26.0
Component/s: build-system
Labels:
None

Description

Shall we use GCP Libraries BOM to specify Google-related library versions?

I've been working on Beam's dependency upgrades in the past few months. I think it's time to consider a long-term solution to keep the libraries up-to-date with small maintenance effort. To achieve that, I propose Beam to use GCP Libraries BOM to set the Google-related library versions, rather than trying to make changes in each of ~30 Google libraries.

Background

A BOM is pom.xml that provides dependencyManagement to importing projects.

GCP Libraries BOM is a BOM that includes many Google Cloud related libraries + gRPC + protobuf. We (Google Cloud Java Diamond Dependency team) maintain the BOM so that the set of the libraries are compatible with each other.

Implementation

Notes for obstacles.

BeamModulePlugin's "force" does not take BOM into account (thus fails)

forcedModules via version resolution strategy is playing bad. This causes

A problem occurred evaluating project ':sdks:java:extensions:sql'. 
Could not resolve all dependencies for configuration ':sdks:java:extensions:sql:fmppTemplates'.
Invalid format: 'com.google.cloud:google-cloud-core'. Group, name and version cannot be empty. Correct example: 'org.gradle:gradle-core:1.0'

:sdks:java:maven-archetypes:examples needs the version of google-http-client

The task requires the version for the library:

    'google-http-client.version': dependencies.create(project.library.java.google_http_client).getVersion(),

This would generate NullPointerException. Running gradlew without the subproject:

./gradlew -p sdks/java check -x :sdks:java:maven-archetypes:examples:check

Problem in Gradle-generated pom files

The generated Maven artifact POM has invalid data due to the BOM change. For example my locally installed ~/.m2/repository/org/apache/beam/beam-sdks-java-io-google-cloud-platform/2.21.0-SNAPSHOT/beam-sdks-java-io-google-cloud-platform-2.21.0-SNAPSHOT.pom had the following problems.

The GCP Libraries BOM showing up in dependencies section:

  <dependencies>
    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>libraries-bom</artifactId>
      <version>4.2.0</version>
      <scope>compile</scope>
      <exclusions>
        <exclusion>
          <groupId>com.google.guava</groupId>
          <artifactId>guava-jdk5</artifactId>
        </exclusion>...
      </exclusions>
    </dependency>

The artifact that use the BOM in Gradle is missing version in the dependency.

    <dependency>
      <groupId>com.google.api</groupId>
      <artifactId>gax</artifactId>
      <version/>
      <scope>compile</scope>
      ...
    </dependency>