-
Notifications
You must be signed in to change notification settings - Fork 172
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
SNOW-804145: Java best practice changes for streaming sdk (#1382)
* Java library best practices - fix pom.xml url - add sortpom plugin and sort pom.xml - remove internal repository reference - fix scm section - add a pluginManagement section - add version properties for plugins - update plugin versions - add dependency convergence and upper bounds checks - fill out dependencyManagement section to converge all dependencies at the upper bound - add unused declared and used undeclared dependency checks - remove unused declared dependencies - add used undeclared dependencies - fix the <scope> declaration of several dependencies - remove all dependency <exclusions> sections - remove maven-install-plugin - add japicmp plugin to enforce semantic versioning - update maven required version to 3.6.3 - add linkage checker enforcer rule - add linkage exclusions covering the current set of linkage issues - add duplicate class enforcer check from extra-enforcer-rules - adjust the java-9 profile to activate for jdks 9 or greater - add JPMS line for tests with jdk>8 "--add-opens=java.base/java.nio=ALL-UNNAMED" - update fmt-maven-plugin - add maven wrapper, pin maven to 3.8 for compatibility with linkage checker - disable shading by default, fixes #174 #608 - dependency fixes possibly fix #1211 - update json-smart to 2.4.9, related #1311 - httpclient to 4.5.14, #1273 * Adjust for JDBC workflow - Add include/exclude for japicmp - downgrade sortpom's version to 3.0.1 for java8; 3.2.1 is compiled by java11 - use src, target flag instead of release flag in maven-compiler-plugin because java 8 in test infra doesn't support release flag. - run new formatter as suggested - disable enforce-linkage-checker in self-contained-jar - change back slf4j to provided scope - disable japicmp in jenkinsIT profile - disable maven-dependency-plugin:analyze-only in jenkinsIT profile - change default build back to fat jar - add slf4j & logback version bumps --------- Co-authored-by: Preston Bennes <preston.bennes@gmail.com> Co-authored-by: wshangguan <wufan.shangguan@snowflake.com> Co-authored-by: igarish <ilesh.garish@snowflake.com>
- Loading branch information
1 parent
77e286b
commit 81eb493
Showing
39 changed files
with
1,772 additions
and
796 deletions.
There are no files selected for viewing
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Licensed to the Apache Software Foundation (ASF) under one | ||
# or more contributor license agreements. See the NOTICE file | ||
# distributed with this work for additional information | ||
# regarding copyright ownership. The ASF licenses this file | ||
# to you under the Apache License, Version 2.0 (the | ||
# "License"); you may not use this file except in compliance | ||
# with the License. You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, | ||
# software distributed under the License is distributed on an | ||
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
# KIND, either express or implied. See the License for the | ||
# specific language governing permissions and limitations | ||
# under the License. | ||
|
||
# NOTE: Maven 3.9 is incompatible with the linkage checker rules | ||
distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.8/apache-maven-3.8.8-bin.zip | ||
wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
<LinkageCheckerFilter> | ||
<LinkageError> | ||
<Target><Package name="org.graalvm.nativeimage"/></Target> | ||
<Source><Package name="com.google.api.gax.nativeimage"/></Source> | ||
<Reason>?</Reason> | ||
</LinkageError> | ||
<LinkageError> | ||
<Target><Package name="com.google.crypto.tink"/></Target> | ||
<Source><Package name="com.nimbusds.jose"/></Source> | ||
<Reason>Optional</Reason> | ||
</LinkageError> | ||
<LinkageError> | ||
<Target><Package name="org.bouncycastle.jcajce.provider"/></Target> | ||
<Source><Package name="com.nimbusds.jose"/></Source> | ||
<Reason>Optional</Reason> | ||
</LinkageError> | ||
<LinkageError> | ||
<Target><Package name="org.brotli.dec"/></Target> | ||
<Source><Package name="org.apache.commons.compress.compressors"/></Source> | ||
<Reason>Optional</Reason> | ||
</LinkageError> | ||
<LinkageError> | ||
<Target><Package name="com.github.luben.zstd"/></Target> | ||
<Source><Package name="org.apache.commons.compress.compressors"/></Source> | ||
<Reason>Optional</Reason> | ||
</LinkageError> | ||
<LinkageError> | ||
<Target><Package name="com.google.appengine.api.urlfetch"/></Target> | ||
<Source><Package name="com.google.api.client.extensions.appengine"/></Source> | ||
<Reason>provided appengine</Reason> | ||
</LinkageError> | ||
<LinkageError> | ||
<Target><Package name="com.oracle"/></Target> | ||
<Source><Package name="com.google.api.gax"/></Source> | ||
<Reason>?</Reason> | ||
</LinkageError> | ||
<LinkageError> | ||
<Target><Package name="org.osgi"/></Target> | ||
<Source><Package name="org.apache.tika.config"/></Source> | ||
<Reason>?</Reason> | ||
</LinkageError> | ||
<!-- | ||
<LinkageError> | ||
<Target><Package name=""/></Target> | ||
<Source><Package name=""/></Source> | ||
<Reason></Reason> | ||
</LinkageError> | ||
--> | ||
</LinkageCheckerFilter> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,308 @@ | ||
#!/bin/sh | ||
# ---------------------------------------------------------------------------- | ||
# Licensed to the Apache Software Foundation (ASF) under one | ||
# or more contributor license agreements. See the NOTICE file | ||
# distributed with this work for additional information | ||
# regarding copyright ownership. The ASF licenses this file | ||
# to you under the Apache License, Version 2.0 (the | ||
# "License"); you may not use this file except in compliance | ||
# with the License. You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, | ||
# software distributed under the License is distributed on an | ||
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
# KIND, either express or implied. See the License for the | ||
# specific language governing permissions and limitations | ||
# under the License. | ||
# ---------------------------------------------------------------------------- | ||
|
||
# ---------------------------------------------------------------------------- | ||
# Apache Maven Wrapper startup batch script, version 3.2.0 | ||
# | ||
# Required ENV vars: | ||
# ------------------ | ||
# JAVA_HOME - location of a JDK home dir | ||
# | ||
# Optional ENV vars | ||
# ----------------- | ||
# MAVEN_OPTS - parameters passed to the Java VM when running Maven | ||
# e.g. to debug Maven itself, use | ||
# set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 | ||
# MAVEN_SKIP_RC - flag to disable loading of mavenrc files | ||
# ---------------------------------------------------------------------------- | ||
|
||
if [ -z "$MAVEN_SKIP_RC" ] ; then | ||
|
||
if [ -f /usr/local/etc/mavenrc ] ; then | ||
. /usr/local/etc/mavenrc | ||
fi | ||
|
||
if [ -f /etc/mavenrc ] ; then | ||
. /etc/mavenrc | ||
fi | ||
|
||
if [ -f "$HOME/.mavenrc" ] ; then | ||
. "$HOME/.mavenrc" | ||
fi | ||
|
||
fi | ||
|
||
# OS specific support. $var _must_ be set to either true or false. | ||
cygwin=false; | ||
darwin=false; | ||
mingw=false | ||
case "$(uname)" in | ||
CYGWIN*) cygwin=true ;; | ||
MINGW*) mingw=true;; | ||
Darwin*) darwin=true | ||
# Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home | ||
# See https://developer.apple.com/library/mac/qa/qa1170/_index.html | ||
if [ -z "$JAVA_HOME" ]; then | ||
if [ -x "/usr/libexec/java_home" ]; then | ||
JAVA_HOME="$(/usr/libexec/java_home)"; export JAVA_HOME | ||
else | ||
JAVA_HOME="/Library/Java/Home"; export JAVA_HOME | ||
fi | ||
fi | ||
;; | ||
esac | ||
|
||
if [ -z "$JAVA_HOME" ] ; then | ||
if [ -r /etc/gentoo-release ] ; then | ||
JAVA_HOME=$(java-config --jre-home) | ||
fi | ||
fi | ||
|
||
# For Cygwin, ensure paths are in UNIX format before anything is touched | ||
if $cygwin ; then | ||
[ -n "$JAVA_HOME" ] && | ||
JAVA_HOME=$(cygpath --unix "$JAVA_HOME") | ||
[ -n "$CLASSPATH" ] && | ||
CLASSPATH=$(cygpath --path --unix "$CLASSPATH") | ||
fi | ||
|
||
# For Mingw, ensure paths are in UNIX format before anything is touched | ||
if $mingw ; then | ||
[ -n "$JAVA_HOME" ] && [ -d "$JAVA_HOME" ] && | ||
JAVA_HOME="$(cd "$JAVA_HOME" || (echo "cannot cd into $JAVA_HOME."; exit 1); pwd)" | ||
fi | ||
|
||
if [ -z "$JAVA_HOME" ]; then | ||
javaExecutable="$(which javac)" | ||
if [ -n "$javaExecutable" ] && ! [ "$(expr "\"$javaExecutable\"" : '\([^ ]*\)')" = "no" ]; then | ||
# readlink(1) is not available as standard on Solaris 10. | ||
readLink=$(which readlink) | ||
if [ ! "$(expr "$readLink" : '\([^ ]*\)')" = "no" ]; then | ||
if $darwin ; then | ||
javaHome="$(dirname "\"$javaExecutable\"")" | ||
javaExecutable="$(cd "\"$javaHome\"" && pwd -P)/javac" | ||
else | ||
javaExecutable="$(readlink -f "\"$javaExecutable\"")" | ||
fi | ||
javaHome="$(dirname "\"$javaExecutable\"")" | ||
javaHome=$(expr "$javaHome" : '\(.*\)/bin') | ||
JAVA_HOME="$javaHome" | ||
export JAVA_HOME | ||
fi | ||
fi | ||
fi | ||
|
||
if [ -z "$JAVACMD" ] ; then | ||
if [ -n "$JAVA_HOME" ] ; then | ||
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then | ||
# IBM's JDK on AIX uses strange locations for the executables | ||
JAVACMD="$JAVA_HOME/jre/sh/java" | ||
else | ||
JAVACMD="$JAVA_HOME/bin/java" | ||
fi | ||
else | ||
JAVACMD="$(\unset -f command 2>/dev/null; \command -v java)" | ||
fi | ||
fi | ||
|
||
if [ ! -x "$JAVACMD" ] ; then | ||
echo "Error: JAVA_HOME is not defined correctly." >&2 | ||
echo " We cannot execute $JAVACMD" >&2 | ||
exit 1 | ||
fi | ||
|
||
if [ -z "$JAVA_HOME" ] ; then | ||
echo "Warning: JAVA_HOME environment variable is not set." | ||
fi | ||
|
||
# traverses directory structure from process work directory to filesystem root | ||
# first directory with .mvn subdirectory is considered project base directory | ||
find_maven_basedir() { | ||
if [ -z "$1" ] | ||
then | ||
echo "Path not specified to find_maven_basedir" | ||
return 1 | ||
fi | ||
|
||
basedir="$1" | ||
wdir="$1" | ||
while [ "$wdir" != '/' ] ; do | ||
if [ -d "$wdir"/.mvn ] ; then | ||
basedir=$wdir | ||
break | ||
fi | ||
# workaround for JBEAP-8937 (on Solaris 10/Sparc) | ||
if [ -d "${wdir}" ]; then | ||
wdir=$(cd "$wdir/.." || exit 1; pwd) | ||
fi | ||
# end of workaround | ||
done | ||
printf '%s' "$(cd "$basedir" || exit 1; pwd)" | ||
} | ||
|
||
# concatenates all lines of a file | ||
concat_lines() { | ||
if [ -f "$1" ]; then | ||
# Remove \r in case we run on Windows within Git Bash | ||
# and check out the repository with auto CRLF management | ||
# enabled. Otherwise, we may read lines that are delimited with | ||
# \r\n and produce $'-Xarg\r' rather than -Xarg due to word | ||
# splitting rules. | ||
tr -s '\r\n' ' ' < "$1" | ||
fi | ||
} | ||
|
||
log() { | ||
if [ "$MVNW_VERBOSE" = true ]; then | ||
printf '%s\n' "$1" | ||
fi | ||
} | ||
|
||
BASE_DIR=$(find_maven_basedir "$(dirname "$0")") | ||
if [ -z "$BASE_DIR" ]; then | ||
exit 1; | ||
fi | ||
|
||
MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}; export MAVEN_PROJECTBASEDIR | ||
log "$MAVEN_PROJECTBASEDIR" | ||
|
||
########################################################################################## | ||
# Extension to allow automatically downloading the maven-wrapper.jar from Maven-central | ||
# This allows using the maven wrapper in projects that prohibit checking in binary data. | ||
########################################################################################## | ||
wrapperJarPath="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" | ||
if [ -r "$wrapperJarPath" ]; then | ||
log "Found $wrapperJarPath" | ||
else | ||
log "Couldn't find $wrapperJarPath, downloading it ..." | ||
|
||
if [ -n "$MVNW_REPOURL" ]; then | ||
wrapperUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" | ||
else | ||
wrapperUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" | ||
fi | ||
while IFS="=" read -r key value; do | ||
# Remove '\r' from value to allow usage on windows as IFS does not consider '\r' as a separator ( considers space, tab, new line ('\n'), and custom '=' ) | ||
safeValue=$(echo "$value" | tr -d '\r') | ||
case "$key" in (wrapperUrl) wrapperUrl="$safeValue"; break ;; | ||
esac | ||
done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" | ||
log "Downloading from: $wrapperUrl" | ||
|
||
if $cygwin; then | ||
wrapperJarPath=$(cygpath --path --windows "$wrapperJarPath") | ||
fi | ||
|
||
if command -v wget > /dev/null; then | ||
log "Found wget ... using wget" | ||
[ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--quiet" | ||
if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then | ||
wget $QUIET "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" | ||
else | ||
wget $QUIET --http-user="$MVNW_USERNAME" --http-password="$MVNW_PASSWORD" "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" | ||
fi | ||
elif command -v curl > /dev/null; then | ||
log "Found curl ... using curl" | ||
[ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--silent" | ||
if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then | ||
curl $QUIET -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" | ||
else | ||
curl $QUIET --user "$MVNW_USERNAME:$MVNW_PASSWORD" -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" | ||
fi | ||
else | ||
log "Falling back to using Java to download" | ||
javaSource="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.java" | ||
javaClass="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.class" | ||
# For Cygwin, switch paths to Windows format before running javac | ||
if $cygwin; then | ||
javaSource=$(cygpath --path --windows "$javaSource") | ||
javaClass=$(cygpath --path --windows "$javaClass") | ||
fi | ||
if [ -e "$javaSource" ]; then | ||
if [ ! -e "$javaClass" ]; then | ||
log " - Compiling MavenWrapperDownloader.java ..." | ||
("$JAVA_HOME/bin/javac" "$javaSource") | ||
fi | ||
if [ -e "$javaClass" ]; then | ||
log " - Running MavenWrapperDownloader.java ..." | ||
("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$wrapperUrl" "$wrapperJarPath") || rm -f "$wrapperJarPath" | ||
fi | ||
fi | ||
fi | ||
fi | ||
########################################################################################## | ||
# End of extension | ||
########################################################################################## | ||
|
||
# If specified, validate the SHA-256 sum of the Maven wrapper jar file | ||
wrapperSha256Sum="" | ||
while IFS="=" read -r key value; do | ||
case "$key" in (wrapperSha256Sum) wrapperSha256Sum=$value; break ;; | ||
esac | ||
done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" | ||
if [ -n "$wrapperSha256Sum" ]; then | ||
wrapperSha256Result=false | ||
if command -v sha256sum > /dev/null; then | ||
if echo "$wrapperSha256Sum $wrapperJarPath" | sha256sum -c > /dev/null 2>&1; then | ||
wrapperSha256Result=true | ||
fi | ||
elif command -v shasum > /dev/null; then | ||
if echo "$wrapperSha256Sum $wrapperJarPath" | shasum -a 256 -c > /dev/null 2>&1; then | ||
wrapperSha256Result=true | ||
fi | ||
else | ||
echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." | ||
echo "Please install either command, or disable validation by removing 'wrapperSha256Sum' from your maven-wrapper.properties." | ||
exit 1 | ||
fi | ||
if [ $wrapperSha256Result = false ]; then | ||
echo "Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised." >&2 | ||
echo "Investigate or delete $wrapperJarPath to attempt a clean download." >&2 | ||
echo "If you updated your Maven version, you need to update the specified wrapperSha256Sum property." >&2 | ||
exit 1 | ||
fi | ||
fi | ||
|
||
MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" | ||
|
||
# For Cygwin, switch paths to Windows format before running java | ||
if $cygwin; then | ||
[ -n "$JAVA_HOME" ] && | ||
JAVA_HOME=$(cygpath --path --windows "$JAVA_HOME") | ||
[ -n "$CLASSPATH" ] && | ||
CLASSPATH=$(cygpath --path --windows "$CLASSPATH") | ||
[ -n "$MAVEN_PROJECTBASEDIR" ] && | ||
MAVEN_PROJECTBASEDIR=$(cygpath --path --windows "$MAVEN_PROJECTBASEDIR") | ||
fi | ||
|
||
# Provide a "standardized" way to retrieve the CLI args that will | ||
# work with both Windows and non-Windows executions. | ||
MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $*" | ||
export MAVEN_CMD_LINE_ARGS | ||
|
||
WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain | ||
|
||
# shellcheck disable=SC2086 # safe args | ||
exec "$JAVACMD" \ | ||
$MAVEN_OPTS \ | ||
$MAVEN_DEBUG_OPTS \ | ||
-classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ | ||
"-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ | ||
${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" |
Oops, something went wrong.