1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
#!/bin/sh
# Purpose: Prepare an ESAPI release.
#
# Usage: esapi-release.sh esapi_svn_dir
# where, esapi_svn_dir is the directory where you retrieved the ESAPI
# SVN tree to and built ESAPI via Maven or Eclipse.
# This directory _must_ already exist.
# There should be a 'src' and 'target' directories
# under this directory and the 'target' directory
# is where we will build the ESAPI zip file that
# you then will be placed into the owasp-esapi-java
# project hosting on Google Code.
#
# Assumptions: Maven (mvn) is available in $PATH. If not, modify PATH
# in script (see 'Tunable Parameters') accordingly.
#
# The correct version has been set / updated in pom.xml for
# the 'esapi' <artifactId> and this has been committed to SVN.
#
# All tests pass. We skip the running of all the JUnit tests.
# (See the call to mvn and the -Dmaven.test.skip=true argument.)
#
# Bugs: This is going to be a bitch to write as a DOS .bat script. I should
# have my head examined for termites! What *was* I thinking???
#
# Need to figure out how to create changelog.txt using 'svn log' command.
#
#############################################################################
#
# This file is part of the Open Web Application Security Project (OWASP)
# Enterprise Security API (ESAPI) project. For details, please see
# http://www.owasp.org/index.php/ESAPI.
#
# Copyright (c) 2010 - The OWASP Foundation
#
# ESAPI is published by OWASP under the BSD license. You should read and
# accept the LICENSE before you use, modify, and/or redistribute this software.
#
# Author: kevin.w.wall@gmail.com
############################################################################
echo $0: This script is obsolete and will be replaced soon.
echo In the meantime, read through the release instructions in:
echo " documentation/ESAPI-release-steps.odt"
exit 2
#
# Tunable parameters
#
#PATH=$PATH:/path/to/maven
zipcmd=zip # Is there something better for Linux?
# This doesn't seem to have very good compression.
unzipcmd=unzip
# clean=clean # Comment out if you don't Maven to do 'clean'. Will speed
# things up a little bit.
#esapiConfig=.esapi # Sub-directory where ESAPI.properties resides
esapiConfig=esapi # Sub-directory where ESAPI.properties resides
#
# Non-tunable parameters
#
PROG="${0##*/}"
USAGE="Usage: $PROG esapi_svn_dir"
tmpdir="/tmp/$PROG.$RANDOM-$$"
esapi_release_dir="$tmpdir/esapi_release_dir"
# This is the directory under esapi_svn_dir where the log4j and ESAPI
# properties files are located as well as the $esapiConfig/* config files.
# Note that formerly used to be under src/main/resources, but it since
# has been moved because where it was previously was causing problems with
# Sonatype's Nexus. That particular problem may have been resolved, but it
# it was, the ESAPI configuration stuff has never been moved back.
configDir="configuration"
# Cause the 'echo' builtin to interpret backslash-escaped characters.
# If KornShell is installed as /bin/sh, this command won't be available,
# but for ksh, 'echo' already works the way we want it to anyhow.
shopt -s xpg_echo 2>/dev/null
if [[ $# -eq 1 ]]
then
esapi_svn_dir="$1"
else
echo >&2 "$USAGE"
# Note: exit code '2' is standard for a simple usage error, w/ no other
# error message. Unfortunaely, no one (at least the GNU folks)
# seem to follow this convention any longer and all use 1. We're
# sticking with old school, 'cuz I'm an old guy. ;-)
exit 2
fi
# A few simple directory sanity checks. The 1st check is VERY unlikely to fail.
[[ $esapi_svn_dir == $esapi_release_dir ]] &&
{ echo >&2 "$PROG: ESAPI SVN directory same as tmp dir!\n$USAGE"; exit 1; }
[[ ! -d $esapi_svn_dir ]] &&
{ echo >&2 "$PROG: ESAPI SVN directory, $esapi_svn_dir, does not exist or not a directory."; exit 1; }
[[ ! -d $esapi_svn_dir/src/main ]] &&
{ echo >&2 "$PROG: Wrong directory specified??? Missing 'src/main' directory: $esapi_svn_dir/src/main - does not exist or not a directory."; exit 1; }
[[ -f "$esapi_svn_dir"/pom.xml ]] ||
{ echo 2>&1 "$PROG: missing pom.xml. Looks like $esapi_svn_dir is not the SVN dir.";
echo 2>&1 "USAGE"; exit 1; }
mkdir $tmpdir || exit 1 # Exit if it already exists.
trap "rm -fr $tmpdir" EXIT # We probably want this skipped if the mkdir fails
umask 022
mkdir $tmpdir/esapi_release_dir || exit 1
# Create an intermediate distribution zip file. The zip file will be
# left in the 'target' directory and named according to what <version>
# is in the pom.xml file for the 'esapi' <artifactId>. For release
# candidates, it will be something like this:
# esapi-2.0_RC7-SNAPSHOT-dist.zip
# and inside of it, the ESAPI jar would be named 'esapi-2.0_RC7-SNAPSHOT.jar'.
cd "$esapi_svn_dir"
tmpout=$tmpdir/mvn.out
echo "Running mvn to create intermediate zip file.\nPlease wait; this probably will take awhile..."
rm -f target/esapi-*.zip target/esapi-*.jar
mvn $clean site -Pdist -Dmaven.test.skip=true >$tmpout 2>&1
if [[ $? != 0 ]]
then echo >&2 "$PROG: Maven failed to build distribution zip file"
echo >&2 "\tSee results in: $tmpout"
trap - EXIT # Clear exit trap so stuff not removed.
exit 1
else rm $tmpout
echo "Maven completed successfully."
fi
jarfile=$(ls target/esapi-*.jar 2>&-)
if [[ -n "$jarfile" && -r $jarfile ]]
then jarfile=$PWD/$jarfile
else echo >&2 "$PROG: Can't find ESAPI jar file created by Maven."
exit 1
fi
# OK, now we need to adjust the jar file. We don't want the properties in
# the ESAPI jar as too many people have complained about the ESAPI.properties
# and other stuff there. Also, we want to delete settings.xml and
# owasp-esapi-dev.jks. We might add the latter once we start signing the
# jar.
jartmpdir=$tmpdir/esapi-jar
mkdir $jartmpdir
cd $jartmpdir || exit
jar xf "$jarfile"
rm -fr ${esapiConfig:?}
rm -f properties/* log4j.*
rm -f settings.xml owasp-esapi-dev.jks
# TODO: This part would need some work if we sign or seal the ESAPI jar as
# that creates a special MANIFEST.MF file and other special files and
# it's not clear they will be merely copied by the simply jar command
# below.
jar cf "$jarfile" .
# Now work on the zip file.
cd "$esapi_svn_dir"
zipfile=$(ls target/esapi-*.zip 2>&-)
if [[ -n "$zipfile" && -r $zipfile ]]
then zipfile="$esapi_svn_dir"/$zipfile # 'target/' already included.
else echo >&2 "$PROG: Can't find ESAPI zip file created by Maven."
exit 1
fi
[[ -s $zipfile ]] ||
{ echo 2>&1 "$PROG: zip file $zipfile has 0 size."; exit 1; }
$unzipcmd -q "$zipfile" -d "$esapi_release_dir" || exit 1
cd "$esapi_release_dir" || exit 1
# 1) Combine the two license files into one and make it a DOS .txt
# file so those do don't have real editors (i.e., notepad newbs) can
# read it just by clicking on it. Generally reading DOS text files on *nix
# is never a problem.
( echo "\t\tESAPI Source Code:\n\n"; cat LICENSE; echo "\n\n=========================\n\n\t\tESAPI Documentation:\n\n"; cat LICENSE-CONTENT ) >LICENSE.txt
rm LICENSE LICENSE-CONTENT
unix2dos -q LICENSE.txt
# 2) Patch up the 'configuration' directory. Need to copy owasp-esapi-dev.jks
# here as well as the $esapiConfig directory. Also need to populate the
# properties subdirectory. Not sure where the settings.xml file should
# go, or even if we should leave it here; will copy it to 'configuration'
# directory.
# Note: Not sure why this is now needed. Something must have changed in the
# pom.xml that requires this, but have recently found that even the
# configuration directory does not exist.
if [[ ! -d "$configDir" ]]
then mkdir -p "$configDir"/properties ||
{ echo >&2 "$PROG: Missing '$configDir' directory and cannot create it!"; exit 1; }
fi
cp -p "$esapi_svn_dir"/resources/owasp-esapi-dev.jks configuration/
cp -p "$esapi_svn_dir"/resources/settings.xml configuration/
cp -r -p "$esapi_svn_dir"/"$configDir"/$esapiConfig configuration/$esapiConfig/
cp -p "$esapi_svn_dir"/"$configDir"/properties/* configuration/properties/
# 3) Create the changelog.txt which should be the changes since the
# last release.
##TODO - Not sure how to do this, but their must be a way since the Subclipse
# Eclipse plugin is able to do it somehow. We can use 'svn log' if
# we can figure out the starting and ending SVN revisions. (See
# http://www.bernzilla.com/item.php?id=613 for details.)
echo "$PROG: Skipping creation of changelog.txt in zip file."
echo "\tManually create changelog.txt and add it to the final zip file."
# 4) Copy the pom.xml there. It doesn't get created by the Maven goal.
cp -p "$esapi_svn_dir"/pom.xml .
# 5) Update zip file w/ new, updated ESAPI jar file.
cp -p "$jarfile" .
# 6) Fix up permissions so when zip is extracted, it comes out sane.
chmod -R a+r,go-w .
# Now we take the contents of the ESAPI release directory and re-zip it.
# We can't use the 'freshen' option here because that has to be run
# from the same directory (which would be the ESAPI SVN directory).
rm "$zipfile"
cd "$esapi_release_dir"
$zipcmd -q -r $zipfile .
cd / # In case some weird 'rm' command (from EXIT trap) prevents us from
# removing directory that we are under. I could see something like
# that happen with Cygwin and Windows.
echo "Zip file at: $zipfile\nPlease check it for accuracy before releasing."
exit 0
|
