migrate to mvnw

Author: pan3793

.github/workflows/website.yml

@@ -42,13 +42,13 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-maven-
       - name: Build Hadoop maven plugins
-        run: cd hadoop-maven-plugins && mvn --batch-mode install
+        run: cd hadoop-maven-plugins && ../mvnw --batch-mode install
       - name: Build Hadoop
-        run: mvn clean install -DskipTests -DskipShade
+        run: ./mvnw clean install -DskipTests -DskipShade
       - name: Build document
-        run: mvn clean site
+        run: ./mvnw clean site
       - name: Stage document
-        run: mvn site:stage -DstagingDirectory=${GITHUB_WORKSPACE}/staging/
+        run: ./mvnw site:stage -DstagingDirectory=${GITHUB_WORKSPACE}/staging/
       - name: Deploy to GitHub Pages
         uses: peaceiris/actions-gh-pages@v3
         with:

.mvn/jvm.config

@@ -0,0 +1,2 @@
+-Xms256m
+-Xmx3072m

BUILDING.txt

@@ -5,7 +5,6 @@ Requirements:
 
 * Unix System
 * JDK 1.8
-* Maven 3.3 or later
 * Boost 1.86.0 (if compiling native code)
 * Protocol Buffers 3.21.12 (if compiling native code)
 * CMake 3.19 or newer (if compiling native code)
@@ -62,8 +61,6 @@ Refer to  dev-support/docker/Dockerfile):
 * Open JDK 1.8
   $ sudo apt-get update
   $ sudo apt-get -y install openjdk-8-jdk
-* Maven
-  $ sudo apt-get -y install maven
 * Native libraries
   $ sudo apt-get -y install build-essential autoconf automake libtool cmake zlib1g-dev pkg-config libssl-dev libsasl2-dev
 * GCC 9.3.0
@@ -139,19 +136,19 @@ Where to run Maven from?
 ----------------------------------------------------------------------------------
 Maven build goals:
 
- * Clean                     : mvn clean [-Preleasedocs]
- * Compile                   : mvn compile [-Pnative]
- * Run tests                 : mvn test [-Pnative] [-Pshelltest]
- * Create JAR                : mvn package
- * Run spotbugs              : mvn compile spotbugs:spotbugs
- * Run checkstyle            : mvn compile checkstyle:checkstyle
- * Install JAR in M2 cache   : mvn install
- * Deploy JAR to Maven repo  : mvn deploy
- * Run clover                : mvn test -Pclover
- * Run Rat                   : mvn apache-rat:check
- * Build javadocs            : mvn javadoc:javadoc
- * Build distribution        : mvn package [-Pdist][-Pdocs][-Psrc][-Pnative][-Dtar][-Preleasedocs][-Pyarn-ui]
- * Change Hadoop version     : mvn versions:set -DnewVersion=NEWVERSION
+ * Clean                     : ./mvnw clean [-Preleasedocs]
+ * Compile                   : ./mvnw compile [-Pnative]
+ * Run tests                 : ./mvnw test [-Pnative] [-Pshelltest]
+ * Create JAR                : ./mvnw package
+ * Run spotbugs              : ./mvnw compile spotbugs:spotbugs
+ * Run checkstyle            : ./mvnw compile checkstyle:checkstyle
+ * Install JAR in M2 cache   : ./mvnw install
+ * Deploy JAR to Maven repo  : ./mvnw deploy
+ * Run clover                : ./mvnw test -Pclover
+ * Run Rat                   : ./mvnw apache-rat:check
+ * Build javadocs            : ./mvnw javadoc:javadoc
+ * Build distribution        : ./mvnw package [-Pdist][-Pdocs][-Psrc][-Pnative][-Dtar][-Preleasedocs][-Pyarn-ui]
+ * Change Hadoop version     : ./mvnw versions:set -DnewVersion=NEWVERSION
 
  Build options:
 
@@ -244,10 +241,10 @@ Maven build goals:
   * -Dtest=<TESTCLASSNAME>,<TESTCLASSNAME#METHODNAME>,....
   * -Dtest.exclude=<TESTCLASSNAME>
   * -Dtest.exclude.pattern=**/<TESTCLASSNAME1>.java,**/<TESTCLASSNAME2>.java
-  * To run all native unit tests, use: mvn test -Pnative -Dtest=allNative
-  * To run a specific native unit test, use: mvn test -Pnative -Dtest=<test>
+  * To run all native unit tests, use: ./mvnw test -Pnative -Dtest=allNative
+  * To run a specific native unit test, use: ./mvnw test -Pnative -Dtest=<test>
   For example, to run test_bulk_crc32, you would use:
-  mvn test -Pnative -Dtest=test_bulk_crc32
+  ./mvnw test -Pnative -Dtest=test_bulk_crc32
 
  Intel ISA-L build options:
 
@@ -279,7 +276,7 @@ Maven build goals:
    OWASP's dependency-check plugin will scan the third party dependencies
    of this project for known CVEs (security vulnerabilities against them).
    It will produce a report in target/dependency-check-report.html. To
-   invoke, run 'mvn dependency-check:aggregate'.
+   invoke, run './mvnw dependency-check:aggregate'.
 
  PMDK library build options:
 
@@ -348,7 +345,7 @@ If you are building a submodule directory, all the hadoop dependencies this
 submodule has will be resolved as all other 3rd party dependencies. This is,
 from the Maven cache or from a Maven repository (if not available in the cache
 or the SNAPSHOT 'timed out').
-An alternative is to run 'mvn install -DskipTests' from Hadoop source top
+An alternative is to run './mvnw install -DskipTests' from Hadoop source top
 level once; and then work from the submodule. Keep in mind that SNAPSHOTs
 time out after a while, using the Maven '-nsu' will stop Maven from trying
 to update SNAPSHOTs from external repos.
@@ -358,7 +355,7 @@ Importing projects to eclipse
 
 At first, install artifacts including hadoop-maven-plugins at the top of the source tree.
 
-  $ mvn clean install -DskipTests -DskipShade
+  $ ./mvnw clean install -DskipTests -DskipShade
 
 Then, import to eclipse by specifying the root directory of the project via
 [File] > [Import] > [Maven] > [Existing Maven Projects].
@@ -368,23 +365,23 @@ Building distributions:
 
 Create binary distribution without native code and without Javadocs:
 
-  $ mvn package -Pdist -DskipTests -Dtar -Dmaven.javadoc.skip=true
+  $ ./mvnw package -Pdist -DskipTests -Dtar -Dmaven.javadoc.skip=true
 
 Create binary distribution with native code:
 
-  $ mvn package -Pdist,native -DskipTests -Dtar
+  $ ./mvnw package -Pdist,native -DskipTests -Dtar
 
 Create source distribution:
 
-  $ mvn package -Psrc -DskipTests
+  $ ./mvnw package -Psrc -DskipTests
 
 Create source and binary distributions with native code:
 
-  $ mvn package -Pdist,native,src -DskipTests -Dtar
+  $ ./mvnw package -Pdist,native,src -DskipTests -Dtar
 
 Create a local staging version of the website (in /tmp/hadoop-site)
 
-  $ mvn site site:stage -Preleasedocs,docs -DstagingDirectory=/tmp/hadoop-site
+  $ ./mvnw site site:stage -Preleasedocs,docs -DstagingDirectory=/tmp/hadoop-site
 
 Note that the site needs to be built in a second pass after other artifacts.
 
@@ -406,13 +403,7 @@ Handling out of memory errors in builds
 ----------------------------------------------------------------------------------
 
 If the build process fails with an out of memory error, you should be able to fix
-it by increasing the memory used by maven which can be done via the environment
-variable MAVEN_OPTS.
-
-Here is an example setting to allocate between 256 MB and 1.5 GB of heap space to
-Maven
-
-export MAVEN_OPTS="-Xms256m -Xmx1536m"
+it by increasing the memory used by maven which can be done by modifying .mvn/jvm.config.
 
 ----------------------------------------------------------------------------------
 
@@ -424,12 +415,11 @@ Installing required dependencies for clean install of macOS 10.14:
 * Install Xcode Command Line Tools
   $ xcode-select --install
 * Install Homebrew
-  $ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
+  $ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
 * Install OpenJDK 8
-  $ brew tap AdoptOpenJDK/openjdk
-  $ brew cask install adoptopenjdk8
-* Install maven and tools
-  $ brew install maven autoconf automake cmake wget
+  $ brew install openjdk@8
+* Install toolchains
+  $ brew install autoconf automake cmake wget
 * Install native libraries, only openssl is required to compile native code,
 you may optionally install zlib, lz4, etc.
   $ brew install openssl
@@ -451,7 +441,7 @@ you need to backport both YARN-8622 and YARN-9487 in order to build native code.
 Building command example:
 
 * Create binary distribution with native code but without documentation:
-  $ mvn package -Pdist,native -DskipTests -Dmaven.javadoc.skip \
+  $ ./mvnw package -Pdist,native -DskipTests -Dmaven.javadoc.skip \
     -Dopenssl.prefix=/usr/local/opt/openssl
 
 Note that the command above manually specified the openssl library and include
@@ -465,9 +455,9 @@ Building on CentOS 8
 ----------------------------------------------------------------------------------
 
 
-* Install development tools such as GCC, autotools, OpenJDK and Maven.
+* Install development tools such as GCC, autotools, OpenJDK.
   $ sudo dnf group install --with-optional 'Development Tools'
-  $ sudo dnf install java-1.8.0-openjdk-devel maven
+  $ sudo dnf install java-1.8.0-openjdk-devel
 
 * Install python2 for building documentation.
   $ sudo dnf install python2
@@ -528,7 +518,6 @@ Requirements:
 
 * Windows 10
 * JDK 1.8
-* Maven 3.3 or later (maven.apache.org)
 * Boost 1.86.0 (boost.org)
 * Protocol Buffers 3.21.12 (https://github.com/protocolbuffers/protobuf/tags)
 * CMake 3.19 or newer (cmake.org)
@@ -538,7 +527,7 @@ Requirements:
 * Zlib (zlib.net, if building native code bindings for zlib)
 * Git (preferably, get this from https://git-scm.com/download/win since the package also contains
        Unix command-line tools that are needed during packaging).
-* Python (python.org, for generation of docs using 'mvn site')
+* Python (python.org, for generation of docs using 'mvnw.cmd site')
 * Internet connection for first build (to fetch all Maven and Hadoop dependencies)
 
 ----------------------------------------------------------------------------------
@@ -610,7 +599,6 @@ OpenSSL and Zlib dependencies. Run the following commands to setup these depende
 Set the following environment variables -
 (Assuming that vcpkg was checked out at C:\vcpkg)
 > set PROTOBUF_HOME=C:\vcpkg\installed\x64-windows
-> set MAVEN_OPTS=-Xmx2048M -Xss128M
 
 All Maven goals are the same as described above with the exception that
 native code is built by enabling the 'native-win' Maven profile. -Pnative-win
@@ -641,7 +629,7 @@ container. The Docker image does not have a full VS install, so you need to add
 
 > set classpath=
 > set PROTOBUF_HOME=C:\vcpkg\installed\x64-windows
-> mvn clean package -Dhttps.protocols=TLSv1.2 -DskipTests -DskipDocs -Pnative-win,dist -Dskip.platformToolsetDetection^
+> mvnw.cmd clean package -Dhttps.protocols=TLSv1.2 -DskipTests -DskipDocs -Pnative-win,dist -Dskip.platformToolsetDetection^
     -Drequire.openssl -Drequire.test.libhadoop -Pyarn-ui -Dshell-executable=C:\Git\bin\bash.exe^
     -Dtar -Dopenssl.prefix=C:\vcpkg\installed\x64-windows^
     -Dcmake.prefix.path=C:\vcpkg\installed\x64-windows^
@@ -665,7 +653,7 @@ letter (like 'h') and rebuild -
 ----------------------------------------------------------------------------------
 Building distributions:
 
- * Build distribution with native code    : mvn package [-Pdist][-Pdocs][-Psrc][-Dtar][-Dmaven.javadoc.skip=true]
+ * Build distribution with native code    : mvnw.cmd package [-Pdist][-Pdocs][-Psrc][-Dtar][-Dmaven.javadoc.skip=true]
 
 ----------------------------------------------------------------------------------
 Running compatibility checks with checkcompatibility.py
@@ -683,6 +671,6 @@ Changing the Hadoop version declared returned by VersionInfo
 
 If for compatibility reasons the version of Hadoop has to be declared as a 2.x release in the information returned by
 org.apache.hadoop.util.VersionInfo, set the property declared.hadoop.version to the desired version.
-For example: mvn package -Pdist -Ddeclared.hadoop.version=2.11
+For example: mvnw.cmd package -Pdist -Ddeclared.hadoop.version=2.11
 
 If unset, the project version declared in the POM file is used.

dev-support/bin/create-release

@@ -228,11 +228,7 @@ function set_defaults
   LOGDIR="${BASEDIR}/patchprocess"
 
   if [[ -z "${MVN}" ]]; then
-    if [[ -n "${MAVEN_HOME}" ]]; then
-      MVN=${MAVEN_HOME}/bin/mvn
-    else
-      MVN=$(command -v mvn)
-    fi
+    MVN="${BASEDIR}/mvnw"
   fi
 
   NATIVE=false

dev-support/bin/verify-license-files

@@ -124,7 +124,7 @@ BASEDIR=$(hadoop_abs "${BINDIR}/../..")
 
 pushd "${BASEDIR}" >/dev/null
 #shellcheck disable=SC2016
-PROJ_VERSION=$(mvn -q -Dexec.executable="echo" -Dexec.args='${project.version}' --non-recursive exec:exec)
+PROJ_VERSION=$(${BASEDIR}/mvnw -q -Dexec.executable="echo" -Dexec.args='${project.version}' --non-recursive exec:exec)
 popd >/dev/null
 
 DIST_DIR="${BASEDIR}/hadoop-dist/target/hadoop-${PROJ_VERSION}"

dev-support/docker/Dockerfile

@@ -61,8 +61,6 @@ ENV PYTHONIOENCODING=utf-8
 ######
 # Set env vars required to build Hadoop
 ######
-ENV MAVEN_HOME /usr
-# JAVA_HOME must be set in Maven >= 3.5.0 (MNG-6003)
 ENV JAVA_HOME /usr/lib/jvm/java-8-openjdk-amd64
 
 #######
@@ -76,11 +74,6 @@ ENV SPOTBUGS_HOME /opt/spotbugs
 ENV PROTOBUF_HOME /opt/protobuf
 ENV PATH "${PATH}:/opt/protobuf/bin"
 
-###
-# Avoid out of memory errors in builds
-###
-ENV MAVEN_OPTS -Xms256m -Xmx3072m
-
 # Skip gpg verification when downloading Yetus via yetus-wrapper
 ENV HADOOP_SKIP_YETUS_VERIFICATION true
 

dev-support/docker/Dockerfile_aarch64

@@ -62,8 +62,6 @@ ENV PYTHONIOENCODING=utf-8
 ######
 # Set env vars required to build Hadoop
 ######
-ENV MAVEN_HOME /usr
-# JAVA_HOME must be set in Maven >= 3.5.0 (MNG-6003)
 ENV JAVA_HOME /usr/lib/jvm/java-8-openjdk-arm64
 
 #######
@@ -77,11 +75,6 @@ ENV SPOTBUGS_HOME /opt/spotbugs
 ENV PROTOBUF_HOME /opt/protobuf
 ENV PATH "${PATH}:/opt/protobuf/bin"
 
-###
-# Avoid out of memory errors in builds
-###
-ENV MAVEN_OPTS -Xms256m -Xmx3072m
-
 # Skip gpg verification when downloading Yetus via yetus-wrapper
 ENV HADOOP_SKIP_YETUS_VERIFICATION true
 

dev-support/docker/Dockerfile_centos_7

@@ -77,9 +77,6 @@ ENV INFOPATH "${GCC_HOME}/root/usr/share/info"
 ######
 # Set env vars required to build Hadoop
 ######
-ENV MAVEN_HOME /opt/maven
-ENV PATH "${PATH}:${MAVEN_HOME}/bin"
-# JAVA_HOME must be set in Maven >= 3.5.0 (MNG-6003)
 ENV JAVA_HOME /usr/lib/jvm/java-1.8.0
 
 #######
@@ -96,7 +93,6 @@ ENV PATH "${PATH}:/opt/protobuf/bin"
 ######
 # Install packages
 ######
-RUN pkg-resolver/install-maven.sh centos:7
 RUN pkg-resolver/install-cmake.sh centos:7
 RUN pkg-resolver/install-zstandard.sh centos:7
 RUN pkg-resolver/install-yasm.sh centos:7

dev-support/docker/Dockerfile_centos_8

@@ -90,9 +90,6 @@ ENV INFOPATH "${GCC_HOME}/root/usr/share/info"
 ######
 # Set env vars required to build Hadoop
 ######
-ENV MAVEN_HOME /opt/maven
-ENV PATH "${PATH}:${MAVEN_HOME}/bin"
-# JAVA_HOME must be set in Maven >= 3.5.0 (MNG-6003)
 ENV JAVA_HOME /usr/lib/jvm/java-1.8.0
 
 #######
@@ -109,7 +106,6 @@ ENV PATH "${PATH}:/opt/protobuf/bin"
 ######
 # Install packages
 ######
-RUN pkg-resolver/install-maven.sh centos:8
 RUN pkg-resolver/install-cmake.sh centos:8
 RUN pkg-resolver/install-boost.sh centos:8
 RUN pkg-resolver/install-spotbugs.sh centos:8

dev-support/docker/Dockerfile_debian_10

@@ -56,8 +56,6 @@ RUN apt-get -q update \
 ######
 # Set env vars required to build Hadoop
 ######
-ENV MAVEN_HOME /usr
-# JAVA_HOME must be set in Maven >= 3.5.0 (MNG-6003)
 ENV JAVA_HOME /usr/lib/jvm/java-11-openjdk-amd64
 
 #######
@@ -71,11 +69,6 @@ ENV SPOTBUGS_HOME /opt/spotbugs
 ENV PROTOBUF_HOME /opt/protobuf
 ENV PATH "${PATH}:/opt/protobuf/bin"
 
-###
-# Avoid out of memory errors in builds
-###
-ENV MAVEN_OPTS -Xms256m -Xmx3072m
-
 # Skip gpg verification when downloading Yetus via yetus-wrapper
 ENV HADOOP_SKIP_YETUS_VERIFICATION true