-
Notifications
You must be signed in to change notification settings - Fork 384
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[CELEBORN-836][BUILD] Initial support sbt
### What changes were proposed in this pull request? This PR introduces the SBT build system implementation that operates independently from the current Maven build system. Different from #1627, the current implementation does not depend on `pom.xml` The implementation enables packaging and testing functionalities for server-related modules and Spark-related modules using SBT. For Flink-related build/test, sbt build documentation, continuous integration, and plugins, they will be submitted in separate PRs ### Why are the changes needed? improve project build speed packing the project. ```shell $ ./build/sbt sbt:celeborn> clean [success] Total time: 1 s, completed 2023-7-25 16:36:12 sbt:celeborn> package [success] Total time: 28 s, completed 2023-7-25 16:36:46 ``` packing and shading the spark 3.3 client ```shell $ ./build/sbt -Pspark-3.3 sbt:celeborn> clean [success] Total time: 1 s, completed 2023-7-25 16:39:11 sbt:celeborn> project celeborn-client-spark-3-shaded sbt:celeborn-client-spark-3-shaded> assembly [success] Total time: 37 s, completed 2023-7-25 16:40:03 ``` packing and shading the spark 2.4 client ```shell $ ./build/sbt -Pspark-2.4 sbt:celeborn> clean [success] Total time: 1 s, completed 2023-7-25 16:41:06 sbt:celeborn> project celeborn-client-spark-2-shaded sbt:celeborn-client-spark-2-shaded> assembly [success] Total time: 36 s, completed 2023-7-25 16:41:53 ``` running server-related tests ```shell $ ./build/sbt clean test [success] Total time: 350 s (05:50), completed 2023-7-25 16:48:58 ``` ### Does this PR introduce _any_ user-facing change? yes ### How was this patch tested? tested locally Closes #1757 from cfmcgrady/pure-sbt. Authored-by: Fu Chen <[email protected]> Signed-off-by: Cheng Pan <[email protected]>
- Loading branch information
Showing
10 changed files
with
1,042 additions
and
0 deletions.
There are no files selected for viewing
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
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 |
---|---|---|
|
@@ -34,4 +34,5 @@ NOTICE* | |
assets/** | ||
build/apache-maven-*/** | ||
build/scala-*/** | ||
build/sbt-config/** | ||
**/benchmarks/** |
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,144 @@ | ||
#!/usr/bin/env bash | ||
|
||
# | ||
# 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. | ||
# | ||
|
||
SELF=$(cd $(dirname $0) && pwd) | ||
. "$SELF/util.sh" | ||
|
||
# Check if repositories-local file exists, otherwise use repositories | ||
SBT_REPOSITORIES_LOCAL_CONFIG="$(dirname "$(realpath "$0")")/sbt-config/repositories-local" | ||
SBT_REPOSITORIES_CONFIG="$(dirname "$(realpath "$0")")/sbt-config/repositories" | ||
|
||
if [ -f "$SBT_REPOSITORIES_LOCAL_CONFIG" ]; then | ||
SBT_OPTS="${SBT_OPTS:="-Dsbt.override.build.repos=true -Dsbt.repository.config=$SBT_REPOSITORIES_LOCAL_CONFIG"}" | ||
else | ||
SBT_OPTS="${SBT_OPTS:="-Dsbt.override.build.repos=true -Dsbt.repository.config=$SBT_REPOSITORIES_CONFIG"}" | ||
fi | ||
|
||
export SBT_OPTS | ||
|
||
. "$(dirname "$(realpath "$0")")"/sbt-launch-lib.bash | ||
|
||
|
||
declare -r noshare_opts="-Dsbt.global.base=project/.sbtboot -Dsbt.boot.directory=project/.boot -Dsbt.ivy.home=project/.ivy" | ||
declare -r sbt_opts_file=".sbtopts" | ||
declare -r etc_sbt_opts_file="/etc/sbt/sbtopts" | ||
declare -r default_sbt_opts="-Xss64m" | ||
|
||
usage() { | ||
cat <<EOM | ||
Usage: $script_name [options] | ||
-h | -help print this message | ||
-v | -verbose this runner is chattier | ||
-d | -debug set sbt log level to debug | ||
-no-colors disable ANSI color codes | ||
-sbt-create start sbt even if current directory contains no sbt project | ||
-sbt-dir <path> path to global settings/plugins directory (default: ~/.sbt) | ||
-sbt-boot <path> path to shared boot directory (default: ~/.sbt/boot in 0.11 series) | ||
-ivy <path> path to local Ivy repository (default: ~/.ivy2) | ||
-mem <integer> set memory options (default: $sbt_default_mem, which is $(get_mem_opts $sbt_default_mem)) | ||
-no-share use all local caches; no sharing | ||
-no-global uses global caches, but does not use global ~/.sbt directory. | ||
-jvm-debug <port> Turn on JVM debugging, open at the given port. | ||
-batch Disable interactive mode | ||
# sbt version (default: from project/build.properties if present, else latest release) | ||
-sbt-version <version> use the specified version of sbt | ||
-sbt-jar <path> use the specified jar as the sbt launcher | ||
-sbt-rc use an RC version of sbt | ||
-sbt-snapshot use a snapshot version of sbt | ||
# java version (default: java from PATH, currently $(java -version 2>&1 | grep version)) | ||
-java-home <path> alternate JAVA_HOME | ||
# jvm options and output control | ||
JAVA_OPTS environment variable, if unset uses "$java_opts" | ||
SBT_OPTS environment variable, if unset uses "$default_sbt_opts" | ||
.sbtopts if this file exists in the current directory, it is | ||
prepended to the runner args | ||
/etc/sbt/sbtopts if this file exists, it is prepended to the runner args | ||
-Dkey=val pass -Dkey=val directly to the java runtime | ||
-J-X pass option -X directly to the java runtime | ||
(-J is stripped) | ||
-S-X add -X to sbt's scalacOptions (-S is stripped) | ||
-PmavenProfiles Enable a maven profile for the build. | ||
In the case of duplicated or conflicting options, the order above | ||
shows precedence: JAVA_OPTS lowest, command line options highest. | ||
EOM | ||
} | ||
|
||
process_my_args () { | ||
while [[ $# -gt 0 ]]; do | ||
case "$1" in | ||
-no-colors) addJava "-Dsbt.log.noformat=true" && shift ;; | ||
-no-share) addJava "$noshare_opts" && shift ;; | ||
-no-global) addJava "-Dsbt.global.base=$(pwd)/project/.sbtboot" && shift ;; | ||
-sbt-boot) require_arg path "$1" "$2" && addJava "-Dsbt.boot.directory=$2" && shift 2 ;; | ||
-sbt-dir) require_arg path "$1" "$2" && addJava "-Dsbt.global.base=$2" && shift 2 ;; | ||
-debug-inc) addJava "-Dxsbt.inc.debug=true" && shift ;; | ||
-batch) exec </dev/null && shift ;; | ||
|
||
-sbt-create) sbt_create=true && shift ;; | ||
|
||
*) addResidual "$1" && shift ;; | ||
esac | ||
done | ||
|
||
# Now, ensure sbt version is used. | ||
[[ "${sbt_version}XXX" != "XXX" ]] && addJava "-Dsbt.version=$sbt_version" | ||
} | ||
|
||
loadConfigFile() { | ||
cat "$1" | sed '/^\#/d' | ||
} | ||
|
||
# if sbtopts files exist, prepend their contents to $@ so it can be processed by this runner | ||
[[ -f "$etc_sbt_opts_file" ]] && set -- $(loadConfigFile "$etc_sbt_opts_file") "$@" | ||
[[ -f "$sbt_opts_file" ]] && set -- $(loadConfigFile "$sbt_opts_file") "$@" | ||
|
||
exit_status=127 | ||
saved_stty="" | ||
|
||
restoreSttySettings() { | ||
stty $saved_stty | ||
saved_stty="" | ||
} | ||
|
||
onExit() { | ||
if [[ "$saved_stty" != "" ]]; then | ||
restoreSttySettings | ||
fi | ||
exit $exit_status | ||
} | ||
|
||
saveSttySettings() { | ||
saved_stty=$(stty -g 2>/dev/null) | ||
if [[ ! $? ]]; then | ||
saved_stty="" | ||
fi | ||
} | ||
|
||
saveSttySettings | ||
trap onExit INT | ||
|
||
run "$@" | ||
|
||
exit_status=$? | ||
onExit |
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,16 @@ | ||
[repositories] | ||
local | ||
local-preloaded-ivy: file:///${sbt.preloaded-${sbt.global.base-${user.home}/.sbt}/preloaded/}, [organization]/[module]/[revision]/[type]s/[artifact](-[classifier]).[ext] | ||
local-preloaded: file:///${sbt.preloaded-${sbt.global.base-${user.home}/.sbt}/preloaded/} | ||
# The system property value of `celeborn.sbt.default.artifact.repository` is | ||
# fetched from the environment variable `DEFAULT_ARTIFACT_REPOSITORY` and | ||
# assigned within the build/sbt-launch-lib.bash script. | ||
private: ${celeborn.sbt.default.artifact.repository-file:///dev/null} | ||
gcs-maven-central-mirror: https://maven-central.storage-download.googleapis.com/repos/central/data/ | ||
maven-central | ||
typesafe-ivy-releases: https://repo.typesafe.com/typesafe/ivy-releases/, [organization]/[module]/[revision]/[type]s/[artifact](-[classifier]).[ext], bootOnly | ||
sbt-ivy-snapshots: https://repo.scala-sbt.org/scalasbt/ivy-snapshots/, [organization]/[module]/[revision]/[type]s/[artifact](-[classifier]).[ext], bootOnly | ||
sbt-plugin-releases: https://repo.scala-sbt.org/scalasbt/sbt-plugin-releases/, [organization]/[module]/(scala_[scalaVersion]/)(sbt_[sbtVersion]/)[revision]/[type]s/[artifact](-[classifier]).[ext] | ||
bintray-typesafe-sbt-plugin-releases: https://dl.bintray.com/typesafe/sbt-plugins/, [organization]/[module]/(scala_[scalaVersion]/)(sbt_[sbtVersion]/)[revision]/[type]s/[artifact](-[classifier]).[ext] | ||
bintray-spark-packages: https://dl.bintray.com/spark-packages/maven/ | ||
typesafe-releases: https://repo.typesafe.com/typesafe/releases/ |
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,16 @@ | ||
# As a Chinese developer facing network issues, you can accelerate the download | ||
# speed of bootstrap/plugin/dependencies jar packages by executing the | ||
# following command to configure the mirror: | ||
# | ||
# ``` | ||
# cp build/sbt-config/repositories-cn.template build/sbt-config/repositories-local | ||
# ``` | ||
|
||
[repositories] | ||
local | ||
# The system property value of `celeborn.sbt.default.artifact.repository` is | ||
# fetched from the environment variable `DEFAULT_ARTIFACT_REPOSITORY` and | ||
# assigned within the build/sbt-launch-lib.bash script. | ||
private: ${celeborn.sbt.default.artifact.repository-file:///dev/null} | ||
aliyun-maven: https://maven.aliyun.com/nexus/content/groups/public/ | ||
huawei-central: https://mirrors.huaweicloud.com/repository/maven/ |
Oops, something went wrong.