Skip to content

TEZ-4428: Use protoc-jar-maven-plugin to generate protobuf classes #218

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
abstractdog merged 3 commits into from
Jun 21, 2022
Merged

TEZ-4428: Use protoc-jar-maven-plugin to generate protobuf classes #218

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3c0163a
TEZ-4428: Use protoc-jar-maven-plugin to generate protobuf classes
mark-bathori Jun 7, 2022
5222289
Support custom protoc usage through env variable
mark-bathori Jun 8, 2022
2f9b73b
Restore protobuf installation in Dockerfile
mark-bathori Jun 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions .travis.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,6 @@ sudo: required

env: MAVEN_OPTS="-Xmx2G -XX:MaxPermSize=512M"

before_install:
- ./build-tools/install-protobuf.sh

script:
- jdk_switcher use oraclejdk8
- mvn -B clean install package -DskipTests=true -Dmaven.javadoc.skip=true
Expand Down
9 changes: 5 additions & 4 deletions BUILDING.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,10 +122,11 @@ The version of Protocol Buffer compiler, protoc, can be defined on-the-fly as:

The default version is defined in the root pom.xml.

If you have multiple versions of protoc in your system, you can set in your
build shell the PROTOC_PATH environment variable to point to the one you
want to use for the Tez build. If you don't define this environment variable,
protoc is looked up in the PATH.
If you have multiple versions of protoc in your system, you can set in your
build shell the PROTOC_PATH environment variable to point to the one you
want to use for the Tez build. If you don't define this environment variable then the
embedded protoc compiler will be used with the version defined in ${protobuf.version}.
It detects the platform and executes the corresponding protoc binary at build time.

You can also specify the path to protoc while building using -Dprotoc.path

Expand Down
2 changes: 0 additions & 2 deletions build-tools/docker/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,6 @@ RUN apt-get -q update && apt-get -q install --no-install-recommends -y \
rsync \
software-properties-common \
ssh-client \
sudo \
wget \
xz-utils \
&& apt-get clean \
&& rm -rf /var/lib/apt/lists/*
Expand Down
88 changes: 0 additions & 88 deletions build-tools/install-protobuf.sh
View file
Open in desktop

This file was deleted.

32 changes: 0 additions & 32 deletions build-tools/protocw
View file
Open in desktop

This file was deleted.

22 changes: 0 additions & 22 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1310,28 +1310,6 @@
</dependency>
</dependencies>
</profile>
<!-- This is because <protoc.path>${env.PROTOC_PATH}</protoc.path> above
doesn't let us define a default value in the absence of env.PROTOC_PATH.
By defining this profile, the following order is considered:

0. protoc.path == env.PROTOC_PATH by pom.xml, if protoc.path is not defined
1. -Dprotoc.path: if defined, it wins
2. env.PROTOC_PATH: if protoc.path is not defined, but env.PROTOC_PATH is defined, env.PROTOC_PATH wins
(because protoc.path ==> env.PROTOC_PATH)
3. if neither -Dprotoc.path, nor PROTOC_PATH is defined, protocw script will run
(which can run protoc from the PATH, or an automatically installed version from build-tools/protobuf)
-->
<profile>
<id>protoc-path-env-variable-not-defined</id>
<activation>
<property>
<name>!env.PROTOC_PATH</name>
</property>
</activation>
<properties>
<protoc.path>${basedir}/../build-tools/protocw</protoc.path>
</properties>
</profile>
</profiles>

<reporting>
Expand Down
53 changes: 14 additions & 39 deletions tez-api/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,53 +145,28 @@
<groupId>org.apache.rat</groupId>
<artifactId>apache-rat-plugin</artifactId>
</plugin>
<!-- This plugin takes care of on-the-fly installation of the needed protobuf version.
The needed version is always what's defined as protobuf.version in the pom,
so if user wants to change protobuf version quickly in development time,
supposed to change only protobuf.version and then rebuild tez-api. -->
<plugin>
<artifactId>exec-maven-plugin</artifactId>
<groupId>org.codehaus.mojo</groupId>
<version>1.6.0</version>
<groupId>com.github.os72</groupId>
<artifactId>protoc-jar-maven-plugin</artifactId>
<version>3.11.4</version>
<executions>
<execution>
<id>Install protobuf</id>
<phase>initialize</phase>
<goals>
<goal>exec</goal>
</goals>
<configuration>
<executable>${basedir}/../build-tools/install-protobuf.sh</executable>
<arguments>${protobuf.version}</arguments>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.hadoop</groupId>
<artifactId>hadoop-maven-plugins</artifactId>
<executions>
<execution>
<id>compile-protoc</id>
<phase>generate-sources</phase>
<goals>
<goal>protoc</goal>
<goal>run</goal>
</goals>
<configuration>
<protocVersion>${protobuf.version}</protocVersion>
<protocArtifact>com.google.protobuf:protoc:${protobuf.version}</protocArtifact>
<protocCommand>${protoc.path}</protocCommand>
<imports>
<param>${basedir}/src/main/proto</param>
</imports>
<source>
<directory>${basedir}/src/main/proto</directory>
<includes>
<include>DAGApiRecords.proto</include>
<include>DAGClientAMProtocol.proto</include>
<include>Events.proto</include>
</includes>
</source>
<output>${project.build.directory}/generated-sources/java</output>
<addSources>none</addSources>
<inputDirectories>
<include>${basedir}/src/main/proto</include>
</inputDirectories>
<outputTargets>
<outputTarget>
<outputDirectory>${project.build.directory}/generated-sources/java</outputDirectory>
</outputTarget>
</outputTargets>
</configuration>
</execution>
</executions>
Expand Down
35 changes: 18 additions & 17 deletions tez-dag/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,30 +211,31 @@
</configuration>
</plugin>
<plugin>
<groupId>org.apache.hadoop</groupId>
<artifactId>hadoop-maven-plugins</artifactId>
<groupId>com.github.os72</groupId>
<artifactId>protoc-jar-maven-plugin</artifactId>
<version>3.11.4</version>
<executions>
<execution>
<id>compile-protoc</id>
<phase>generate-sources</phase>
<goals>
<goal>protoc</goal>
<goal>run</goal>
</goals>
<configuration>
<protocVersion>${protobuf.version}</protocVersion>
<protocArtifact>com.google.protobuf:protoc:${protobuf.version}</protocArtifact>
<protocCommand>${protoc.path}</protocCommand>
<imports>
<param>${basedir}/src/main/proto</param>
<param>${basedir}/../tez-api/src/main/proto</param>
<param>${basedir}/../tez-runtime-internals/src/main/proto</param>
</imports>
<source>
<directory>${basedir}/src/main/proto</directory>
<includes>
<include>HistoryEvents.proto</include>
</includes>
</source>
<output>${project.build.directory}/generated-sources/java</output>
<addSources>none</addSources>
<includeDirectories>
<include>${basedir}/../tez-api/src/main/proto</include>
<include>${basedir}/../tez-runtime-internals/src/main/proto</include>
</includeDirectories>
<inputDirectories>
<include>${basedir}/src/main/proto</include>
</inputDirectories>
<outputTargets>
<outputTarget>
<outputDirectory>${project.build.directory}/generated-sources/java</outputDirectory>
</outputTarget>
</outputTargets>
</configuration>
</execution>
</executions>
Expand Down
31 changes: 16 additions & 15 deletions tez-ext-service-tests/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,29 +165,30 @@
<artifactId>apache-rat-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.apache.hadoop</groupId>
<artifactId>hadoop-maven-plugins</artifactId>
<groupId>com.github.os72</groupId>
<artifactId>protoc-jar-maven-plugin</artifactId>
<version>3.11.4</version>
<executions>
<execution>
<id>compile-protoc</id>
<phase>generate-sources</phase>
<goals>
<goal>protoc</goal>
<goal>run</goal>
</goals>
<configuration>
<protocVersion>${protobuf.version}</protocVersion>
<protocArtifact>com.google.protobuf:protoc:${protobuf.version}</protocArtifact>
<protocCommand>${protoc.path}</protocCommand>
<imports>
<param>${basedir}/src/test/proto</param>
<addSources>none</addSources>
<includeDirectories>
<param>${basedir}/../tez-api/src/main/proto</param>
</imports>
<source>
<directory>${basedir}/src/test/proto</directory>
<includes>
<include>TezDaemonProtocol.proto</include>
</includes>
</source>
<output>${project.build.directory}/generated-test-sources/java</output>
</includeDirectories>
<inputDirectories>
<include>${basedir}/src/test/proto</include>
</inputDirectories>
<outputTargets>
<outputTarget>
<outputDirectory>${project.build.directory}/generated-test-sources/java</outputDirectory>
</outputTarget>
</outputTargets>
</configuration>
</execution>
</executions>
Expand Down
29 changes: 14 additions & 15 deletions tez-mapreduce/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,28 +137,27 @@
<artifactId>apache-rat-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.apache.hadoop</groupId>
<artifactId>hadoop-maven-plugins</artifactId>
<groupId>com.github.os72</groupId>
<artifactId>protoc-jar-maven-plugin</artifactId>
<version>3.11.4</version>
<executions>
<execution>
<id>compile-protoc</id>
<phase>generate-sources</phase>
<goals>
<goal>protoc</goal>
<goal>run</goal>
</goals>
<configuration>
<protocVersion>${protobuf.version}</protocVersion>
<protocArtifact>com.google.protobuf:protoc:${protobuf.version}</protocArtifact>
<protocCommand>${protoc.path}</protocCommand>
<imports>
<param>${basedir}/src/main/proto</param>
</imports>
<source>
<directory>${basedir}/src/main/proto</directory>
<includes>
<include>MRRuntimeProtos.proto</include>
</includes>
</source>
<output>${project.build.directory}/generated-sources/java</output>
<addSources>none</addSources>
<inputDirectories>
<include>${basedir}/src/main/proto</include>
</inputDirectories>
<outputTargets>
<outputTarget>
<outputDirectory>${project.build.directory}/generated-sources/java</outputDirectory>
</outputTarget>
</outputTargets>
</configuration>
</execution>
</executions>
Expand Down
Loading