Skip to content

Commit 3668957

Browse files
committed
Gradle build scripts added, for both sql12 and sqfx projects.
- the aim is to take advantage of the incremental build feature of Gradle to produce fast builds during development cycles - Gradle build scripts are added without changes to the existing source code structures in both projects, and with no changes to the existing Ant build scripts or artifacts - for the sql12 project, the Gradle build script produces the same artifacts (zip distributions and IzPack install jars) as those from the existing Ant build script - for the sqfx project, in addition to producing the same portable zip distribution (which excludes the JavaFX libraries which are platform-specific) as that of the Ant build script, the Gradle script also produces an OS-specific zip distribution which includes the JavaFX native libraries of the current OS running the build and works right out of the box without configuration - for ease of use and familiarity with the existing Ant build scripts, the Gradle build scripts have similar tasks such as 'buildAll', 'runApp', etc. - the Gradle scripts produce their build artifacts in their own 'build' directories, while the existing Ant scripts do so in their 'output' directories, to be independent from one another.
1 parent 91ca488 commit 3668957

22 files changed

+1076
-84
lines changed

.gitignore

+9-5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1-
sql12/output
2-
sql12/versionChecker/output
3-
sql12/.classpath
4-
sql12/.project
5-
/.project
1+
bin
2+
output
3+
.classpath
4+
.project
5+
.settings
6+
.gradle
7+
build
8+
.idea
9+
.vscode

README.md

+61-15
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,70 @@
1-
#SQuirreL SQL Client
1+
# SQuirreL SQL Client
22

3-
## Build instructions
4-
SQuirreL SQL uses an Ant based built system, see http://ant.apache.org/. To build SQuirreL you need to download Ant version 1.9.3 or higher from here: http://ant.apache.org/bindownload.cgi
3+
[SQuirreL SQL Client](http://www.squirrelsql.org/) is a graphical Java program
4+
that will allow you to view the structure of a JDBC-compliant database, browse
5+
the data in tables, issue SQL commands, etc.
56

6-
Then open a cmd/shell window and change directory to `<squirrel-git-root>/sql12/`. Form there execute `<ant-home>/bin/ant`. This will generate the directory `<squirrel-git-root>/sql12/output/` where all the build artefacts (installer jars, plainzip packages) are placed.
7+
Original Ant build instructions are described in the
8+
[upstream](https://github.com/squirrel-sql-client/squirrel-sql-code)
9+
repository.
710

8-
The build script itself is located at `<squirrel-git-root>/sql12/build.xml` and contains a few more than 200 lines of code.
11+
---
912

10-
With the restructuring of the build system went a new directory structure:
13+
This fork is to add [Gradle](https://gradle.org/) build scripts to the projects,
14+
to take advantage of the incremental build feature of Gradle to produce fast builds
15+
during development cycles.
1116

12-
* `<squirrel-git-root>/sql12/core/`: Contains the code of SQuirreL's base application..
13-
* `<squirrel-git-root>/sql12/plugins/`: Contains all Plugins.
14-
* `<squirrel-git-root>/sql12/launcher/`: Contains the basis of SQuirreL's start scripts in a way they are needed for building the installer packages.
15-
* `<squirrel-git-root>/sql12/plainZipScript/`: Scripts for plain zip distributions. If copied to the launcher directory these scripts are able to start SQuirreL without installation.
17+
## Gradle build instructions
1618

17-
## Hints for developers
19+
There are two projects in the repository, in their own sub-directories:
1820

19-
* Use `<squirrel-git-root>/sql12/output/dist/` as SQuirreL's home directory (command line: `-home <squirrel-git-root>/sql12/output/dist/`).
20-
* Put the files in `<squirrel-git-root>/sql12/core/lib` in your classpath
21-
* In case you want to work with the Look & Feel Plugin put the files contained in `<squirrel-git-root>/sql12/pluins/laf/` and `<squirrel-git-root>/sql12/pluins/skinlf-theme-packs/` in your classpath
22-
* SQuirreL's source code is in `<squirrel-git-root>/sql12/core/src/` and `<squirrel-git-root>/sql12/plugins/<plugin>/src/`
21+
* [sql12](sql12) is the project of the current SquirrelSQL application. It is based on the Swing framework for the user interface, and has been in use for a long time.
22+
* [sqfx](sqfx) is the next-gen SquirrelSQLFX application which is based on JavaFX for the user interface. This project currently doesn't have as much functionalities as the other one.
2323

24+
The above two projects are independent. The Gradle build scripts for each project
25+
(in their sub-directories) are therefore isolated and are independent builds.
26+
27+
In the main (parent) directory, there's the
28+
[composite build](https://docs.gradle.org/current/userguide/composite_builds.html)
29+
script which composes the two projects as included builds. In this main directory,
30+
execute the `buildAll` task to build the two included projects:
31+
32+
gradlew buildAll
33+
34+
The above composite `buildAll` task is equivalent to running the same task for
35+
each independent project:
36+
37+
gradlew :sql12:buildAll
38+
gradlew :sqfx:buildAll
39+
40+
Plain zip files are then produced in each project's `build` directory:
41+
42+
sql12/build/plainZip/
43+
sqfx/build/plainZip/
44+
45+
For the `sql12` project, IzPack installer jars are also produced in its `build`
46+
directory:
47+
48+
sql12/build/izPackInstallJars/
49+
50+
Installation info for the above build artifacts are described
51+
[here](http://www.squirrelsql.org/#installation).
52+
53+
Each project's application can be independently executed/run by its `runApp` task
54+
using Gradle:
55+
56+
gradlew :sql12:runApp
57+
58+
or:
59+
60+
gradlew :sqfx:runApp
61+
62+
63+
## Ant build instructions
64+
65+
Ant build instructions for the `sql12` project are in the upstream's
66+
[README.md](https://github.com/squirrel-sql-client/squirrel-sql-code).
67+
68+
Ant build info for the `sqfx` project is described briefly
69+
[here](http://www.squirrelsql.org/index.php?page=squirrelFx).
2470

build.gradle

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
//composite build script for the 2 independent projects: sqfx, sql12
2+
3+
defaultTasks 'buildAll'
4+
5+
tasks.wrapper {
6+
gradleVersion = '8.6'
7+
distributionType = Wrapper.DistributionType.ALL
8+
}
9+
10+
task buildAll {
11+
group = 'build'
12+
description = 'Build all included builds'
13+
dependsOn gradle.includedBuild('sqfx').task(':buildAll')
14+
dependsOn gradle.includedBuild('sql12').task(':buildAll')
15+
}
16+
17+
task clean {
18+
group = 'build'
19+
description = 'Delete the build directories of all included builds'
20+
dependsOn gradle.includedBuild('sqfx').task(':clean')
21+
dependsOn gradle.includedBuild('sql12').task(':clean')
22+
}

gradle/wrapper/gradle-wrapper.jar

42.4 KB
Binary file not shown.
+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
distributionBase=GRADLE_USER_HOME
2+
distributionPath=wrapper/dists
3+
distributionUrl=https\://services.gradle.org/distributions/gradle-8.6-all.zip
4+
networkTimeout=10000
5+
validateDistributionUrl=true
6+
zipStoreBase=GRADLE_USER_HOME
7+
zipStorePath=wrapper/dists

gradlew

+249
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,249 @@
1+
#!/bin/sh
2+
3+
#
4+
# Copyright © 2015-2021 the original authors.
5+
#
6+
# Licensed under the Apache License, Version 2.0 (the "License");
7+
# you may not use this file except in compliance with the License.
8+
# You may obtain a copy of the License at
9+
#
10+
# https://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing, software
13+
# distributed under the License is distributed on an "AS IS" BASIS,
14+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
# See the License for the specific language governing permissions and
16+
# limitations under the License.
17+
#
18+
19+
##############################################################################
20+
#
21+
# Gradle start up script for POSIX generated by Gradle.
22+
#
23+
# Important for running:
24+
#
25+
# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
26+
# noncompliant, but you have some other compliant shell such as ksh or
27+
# bash, then to run this script, type that shell name before the whole
28+
# command line, like:
29+
#
30+
# ksh Gradle
31+
#
32+
# Busybox and similar reduced shells will NOT work, because this script
33+
# requires all of these POSIX shell features:
34+
# * functions;
35+
# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
36+
# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
37+
# * compound commands having a testable exit status, especially «case»;
38+
# * various built-in commands including «command», «set», and «ulimit».
39+
#
40+
# Important for patching:
41+
#
42+
# (2) This script targets any POSIX shell, so it avoids extensions provided
43+
# by Bash, Ksh, etc; in particular arrays are avoided.
44+
#
45+
# The "traditional" practice of packing multiple parameters into a
46+
# space-separated string is a well documented source of bugs and security
47+
# problems, so this is (mostly) avoided, by progressively accumulating
48+
# options in "$@", and eventually passing that to Java.
49+
#
50+
# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
51+
# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
52+
# see the in-line comments for details.
53+
#
54+
# There are tweaks for specific operating systems such as AIX, CygWin,
55+
# Darwin, MinGW, and NonStop.
56+
#
57+
# (3) This script is generated from the Groovy template
58+
# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
59+
# within the Gradle project.
60+
#
61+
# You can find Gradle at https://github.com/gradle/gradle/.
62+
#
63+
##############################################################################
64+
65+
# Attempt to set APP_HOME
66+
67+
# Resolve links: $0 may be a link
68+
app_path=$0
69+
70+
# Need this for daisy-chained symlinks.
71+
while
72+
APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
73+
[ -h "$app_path" ]
74+
do
75+
ls=$( ls -ld "$app_path" )
76+
link=${ls#*' -> '}
77+
case $link in #(
78+
/*) app_path=$link ;; #(
79+
*) app_path=$APP_HOME$link ;;
80+
esac
81+
done
82+
83+
# This is normally unused
84+
# shellcheck disable=SC2034
85+
APP_BASE_NAME=${0##*/}
86+
# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
87+
APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
88+
89+
# Use the maximum available, or set MAX_FD != -1 to use that value.
90+
MAX_FD=maximum
91+
92+
warn () {
93+
echo "$*"
94+
} >&2
95+
96+
die () {
97+
echo
98+
echo "$*"
99+
echo
100+
exit 1
101+
} >&2
102+
103+
# OS specific support (must be 'true' or 'false').
104+
cygwin=false
105+
msys=false
106+
darwin=false
107+
nonstop=false
108+
case "$( uname )" in #(
109+
CYGWIN* ) cygwin=true ;; #(
110+
Darwin* ) darwin=true ;; #(
111+
MSYS* | MINGW* ) msys=true ;; #(
112+
NONSTOP* ) nonstop=true ;;
113+
esac
114+
115+
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
116+
117+
118+
# Determine the Java command to use to start the JVM.
119+
if [ -n "$JAVA_HOME" ] ; then
120+
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
121+
# IBM's JDK on AIX uses strange locations for the executables
122+
JAVACMD=$JAVA_HOME/jre/sh/java
123+
else
124+
JAVACMD=$JAVA_HOME/bin/java
125+
fi
126+
if [ ! -x "$JAVACMD" ] ; then
127+
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
128+
129+
Please set the JAVA_HOME variable in your environment to match the
130+
location of your Java installation."
131+
fi
132+
else
133+
JAVACMD=java
134+
if ! command -v java >/dev/null 2>&1
135+
then
136+
die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
137+
138+
Please set the JAVA_HOME variable in your environment to match the
139+
location of your Java installation."
140+
fi
141+
fi
142+
143+
# Increase the maximum file descriptors if we can.
144+
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
145+
case $MAX_FD in #(
146+
max*)
147+
# In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
148+
# shellcheck disable=SC2039,SC3045
149+
MAX_FD=$( ulimit -H -n ) ||
150+
warn "Could not query maximum file descriptor limit"
151+
esac
152+
case $MAX_FD in #(
153+
'' | soft) :;; #(
154+
*)
155+
# In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
156+
# shellcheck disable=SC2039,SC3045
157+
ulimit -n "$MAX_FD" ||
158+
warn "Could not set maximum file descriptor limit to $MAX_FD"
159+
esac
160+
fi
161+
162+
# Collect all arguments for the java command, stacking in reverse order:
163+
# * args from the command line
164+
# * the main class name
165+
# * -classpath
166+
# * -D...appname settings
167+
# * --module-path (only if needed)
168+
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
169+
170+
# For Cygwin or MSYS, switch paths to Windows format before running java
171+
if "$cygwin" || "$msys" ; then
172+
APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
173+
CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
174+
175+
JAVACMD=$( cygpath --unix "$JAVACMD" )
176+
177+
# Now convert the arguments - kludge to limit ourselves to /bin/sh
178+
for arg do
179+
if
180+
case $arg in #(
181+
-*) false ;; # don't mess with options #(
182+
/?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
183+
[ -e "$t" ] ;; #(
184+
*) false ;;
185+
esac
186+
then
187+
arg=$( cygpath --path --ignore --mixed "$arg" )
188+
fi
189+
# Roll the args list around exactly as many times as the number of
190+
# args, so each arg winds up back in the position where it started, but
191+
# possibly modified.
192+
#
193+
# NB: a `for` loop captures its iteration list before it begins, so
194+
# changing the positional parameters here affects neither the number of
195+
# iterations, nor the values presented in `arg`.
196+
shift # remove old arg
197+
set -- "$@" "$arg" # push replacement arg
198+
done
199+
fi
200+
201+
202+
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
203+
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
204+
205+
# Collect all arguments for the java command:
206+
# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
207+
# and any embedded shellness will be escaped.
208+
# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
209+
# treated as '${Hostname}' itself on the command line.
210+
211+
set -- \
212+
"-Dorg.gradle.appname=$APP_BASE_NAME" \
213+
-classpath "$CLASSPATH" \
214+
org.gradle.wrapper.GradleWrapperMain \
215+
"$@"
216+
217+
# Stop when "xargs" is not available.
218+
if ! command -v xargs >/dev/null 2>&1
219+
then
220+
die "xargs is not available"
221+
fi
222+
223+
# Use "xargs" to parse quoted args.
224+
#
225+
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
226+
#
227+
# In Bash we could simply go:
228+
#
229+
# readarray ARGS < <( xargs -n1 <<<"$var" ) &&
230+
# set -- "${ARGS[@]}" "$@"
231+
#
232+
# but POSIX shell has neither arrays nor command substitution, so instead we
233+
# post-process each arg (as a line of input to sed) to backslash-escape any
234+
# character that might be a shell metacharacter, then use eval to reverse
235+
# that process (while maintaining the separation between arguments), and wrap
236+
# the whole thing up as a single "set" statement.
237+
#
238+
# This will of course break if any of these variables contains a newline or
239+
# an unmatched quote.
240+
#
241+
242+
eval "set -- $(
243+
printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
244+
xargs -n1 |
245+
sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
246+
tr '\n' ' '
247+
)" '"$@"'
248+
249+
exec "$JAVACMD" "$@"

0 commit comments

Comments
 (0)