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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3c.org/TR/1999/REC-html401-19991224/loose.dtd">
<!-- saved from url=(0066)https://confab.mit.edu/confluence/display/ISDA/lore-bkw-automation --><HTML><HEAD>
<TITLE>lore-bkw-automation - Confluence</TITLE>
<META http-equiv="Content-Type" content="text/html; charset=utf-8">
<META http-equiv="Pragma" content="no-cache">
<META http-equiv="Expires" content="-1">
<LINK href="css/main-action.css" type="text/css" rel="stylesheet">
<LINK href="css\main-action(1).css" type="text/css" rel="stylesheet">
<META content="MSHTML 6.00.2900.3059" name="GENERATOR">
</HEAD>
<BODY>
<DIV style="MARGIN-LEFT: 10px; MARGIN-RIGHT: 10px" align="left">
<DIV class="wiki-content" style="MARGIN-TOP: 5px; MARGIN-BOTTOM: 5px" align="left">The
Kerberos for Windows (KfW) build is automated. A script will fetch the
sources from a repository and then build, sign and package all the KfW
distribution components.
</DIV>
<DIV class="wiki-content" style="MARGIN-TOP: 5px; MARGIN-BOTTOM: 5px" align="left">This
description consists of
</DIV>
<UL>
<LI>
<A href="#Environment">Setting up the build environment</A>
<LI>
<A href="#Running">Running the script</A>
<LI>
<A href="Details">Script internal details</A>
<LI>
<A href="#Remainingwork">Remaining work / bug list</A>
<LI>
<A href="#Troubleshooting">Troubleshooting</A>
</LI>
</UL>
<H2>Setting Up the Build Environment</H2>
<P>KfW is built on a Windows PC, in the default Windows shell (cmd.exe). These
components must be installed:</P>
<UL>
<LI>
Visual Studio 2003<BR>
Versions of Visual Studio before or after 2003 are not supported.
<LI>
A recent release of the
<SPAN class="nobr">
<A href="http://www.microsoft.com/downloads/details.aspx?FamilyId=0BAF2B35-C656-4969-ACE8-E4C0C0716ADB&displaylang=en">
Microsoft Platform SDK</A></SPAN>
<LI>
<SPAN class="nobr">
<A title="Visit page outside Confluence" href="http://www.activestate.com" rel="nofollow">
ActiveState Perl 5.8 or more recent</A></SPAN><BR>
Build 631 is known to work.
<LI>
<SPAN class="nobr">
<A title="Visit page outside Confluence" href="http://www.doxygen.org/" rel="nofollow">
Doxygen</A></SPAN>
<LI>
sed, awk, cat, rm and find<BR>
These can be obtained from the
<SPAN class="nobr">
<A title="Visit page outside Confluence" href="http://cygwin.com/" rel="nofollow">Cygwin
distribution</A></SPAN>.
<BR clear="all">
<BR clear="all">
find must be in C:\tools\cygwin\bin, so install Cygwin in C:\tools\cygwin.
<BR>
<BR>
The cygwin awk is a link and the MS shell doesn't deal well with that. <TT>C</TT>
opy <TT>c:\tools\cygwin\bin\gawk</TT> to <TT>c:\tools\cygwin\bin\awk</TT>.
<LI>
<SPAN class="nobr">
<A title="Visit page outside Confluence" href="http://sourceforge.net/project/showfiles.php?group_id=105970"
rel="nofollow">Wix</A></SPAN>
<LI>
<SPAN class="nobr">
<A title="Visit page outside Confluence" href="http://nsis.sourceforge.net" rel="nofollow">
NSIS</A></SPAN></LI></UL>
<H3>Environment variables</H3>
<P>
All the components above must be in PATH. Installing ActivePerl puts perl in
the PATH. Doxygen, Cygwin, hhc, wix and nsis need to be added.</P>
<P>perl must be installed so that .pl files are automatically executed with perl.
The ActivePerl installation will do this for you.</P>
<P>In the INCLUDE path, the Microsoft Platform SDK must come before the Microsoft
Visual C++ include files. In the PATH path, the Platform SDK bin area must come before the Visual Studio VC\bin area. Using a Platform SDK Build Environment window will
set this up the right way. Make sure to use a Platform SDK Windows XP Build Environment shell. </P>
<P>If you make your path modifications permanent via Control Panel / System /
Advanced / Environment Variables: If you use a Platform SDK Build
Environment window, it appears that you need to put your PATH components in the
System PATH, not the User PATH.</P>
<P>Visual Studio installs hhc in C:\Program Files\HTML Help Workshop.</P>
<P>nmake must be in PATH. If you use a Platform SDK build environment window, it is
already done for you.</P>
<h2>Running the Script<A name="Running"></A></h2>
<P>
The build is a perl script controlled by command line switches and an XML
configuration file. The config file is required. Settings in the config file
can be overridden by optional command line switches. </P>
<P>There are options for controlling most steps of the build process. The
steps are</P>
<UL>
<LI>
Verifying the environment
<LI>
Fetching the sources from repositories
<LI>
Building the sources
<LI>
Setting up the packaging environment
<LI>
Building the installers
<LI>
Building the rest of the components
</LI>
</UL>
<P>The usage message shows the switches that control these steps:</P>
<P><TT>C:\Projects\KfW>perl bkw.pl /?</TT><BR>
<TT>Usage: bkw.pl [options] NMAKE-options</TT></P>
<P><TT> Options are case insensitive. </TT>
</P>
<P><TT> Options:
<BR>
</TT><TT> /help /?
usage information (what you now see).
<BR>
/config /f path Path to config file. Default is
bkwconfig.xml.
<BR>
/src /s dir Source directory to use.
Should contain
<BR>
pismere/athena. If cvstag or svntag is null,
<BR>
the directory should be prepopulated.
<BR>
/out /o dir Directory to be created
where build results will go
<BR>
</TT><TT> /repository checkout | co \ What repository action to take.
<BR>
/r
update | up \ Options are to checkout, update, export<BR>
export
| ex \ or take no action [skip]. <BR>
skip<BR>
/username /u name username used to access svn if checking out.
<BR>
/cvstag /c tag use -r <tag>
<TAG>in cvs
command <BR> /svnbranch /b tag use
/branches/<tag><TAG> instead of /trunk.<BR> /svntag /t tag use
/tags/<tag><TAG> instead of /trunk.<BR> /debug
/d Do debug make instead of
release make. <BR>
/[no]make
Control the make
step. <BR>
/clean Build
clean target. <BR>
/[no]package Control the packaging step. <BR>
/[no]sign Control
signing
of executable files. <BR> /verbose
/v Debug mode - verbose output. <BR> /logfile /l path Where to write output.
Default is bkw.pl.log. <BR>
/nolog Don't
save output. </TT>
</P>
<P><TT> Other:
<BR>
NMAKE-options any options you want to pass to NMAKE, which
can be:
<BR>
(note: /nologo is always used)<BR>
NODEBUG=1</TT></P>
<P><TT>NMAKE-options any options you want to pass to NMAKE, which can be:</TT><BR>
<TT>(note: /nologo is always used)</TT><BR>
<TT>[ nmake options follow ]</TT></P>
<P><BR>
Notes on the script steps:</P>
<P><STRONG>Verifying the environment</STRONG>:
<BR>
The script tests for each program that it needs and warns if the program isn't
found.</P>
<P><STRONG>Fetching sources from repositories</STRONG>:
<BR>
If building from a source distribution kit, this section does not apply.</P>
<P>CVSROOT and SVNURL must be specified in the configuration file.</P>
<P>A source zip file can only be produced if checking out fresh sources from a
repository. </P>
<P>If checking out, the entire pismere directory will be deleted. A warning
message requires that you confirm this action.</P>
<P><STRONG>Building the sources:</STRONG><BR>
/DEBUG controls whether a debug or release build is done. /CLEAN will
build the CLEAN target.</P>
<P><STRONG>Setting up the packaging environment :<BR>
</STRONG>The pre-package steps gathers up build results and puts them in a <FONT face="Courier">
staging</FONT> area.
</P>
<P>If /SIGN is specified, <FONT face="Courier">.exe</FONT>s, <FONT face="Courier">.dll</FONT>s
and <FONT face="Courier">.cpl</FONT>s are signed. The signing command
template is in the configuration file.</P>
<P><STRONG>Building the installers:</STRONG><BR>
The <FONT face="Courier">staging </FONT>area is copied into a fresh area for
each of the installers. The installer results are copied back to the <FONT face="Courier">
staging </FONT>area.</P>
<P><STRONG>Building the rest of the components:</STRONG><BR>
Zip files are built in temporary areas and copied to <FONT face="Courier">outdir</FONT>.
The installers and assorted files are copied from <FONT face="Courier">staging</FONT>
to <FONT face="Courier">outdir</FONT>. If /SIGN is specified, the
installers will be signed.</P>
<P> </P>
<H2><A name="Details"></A>Script Internal Details</H2>
<H3><A name="Copylists"></A>Copy Lists</H3>
<P>CopyLists are used in many places. For example, files to be put into
a .zip are copied to a fresh directory which is then zipped up. There is
an optional Configuration section and a required Files section. </P>
<P>The configuration section defines the roots of the from and to paths and can
optionally define path substitutions.
</P>
<P>The to and from paths are forced by the script rather than being set in the
config file. Comments in the copyfile xml indicate this.</P>
<P>Lengthy copy lists can be kept in separate files and included with the Include
directive. Example:</P>
<P><TT><Include path="sdkfiles.xml" /></TT></P>
<H3>Substitution tags</H3>
<P>Filenames in copylists can contain variable 'tags' that are replaced before the
file is copied. Some configuration files contain substitution tags which
customize the configuration. The supported tags are</P>
<P>
<TABLE id="Table3" height="0" cellSpacing="1" cellPadding="1" border="1">
<TR>
<TD width="136">%VERSION_MAJOR%</TD>
<TD height="21">KfW Version from pismere/athena/include/kerberos.ver.</TD>
</TR>
<TR>
<TD width="136">%VERSION_MINOR%</TD>
<TD height="9">KfW Version from pismere/athena/include/kerberos.ver.</TD>
</TR>
<TR>
<TD width="136">%VERSION_PATCH%</TD>
<TD height="17">KfW Version from pismere/athena/include/kerberos.ver.</TD>
</TR>
<TR>
<TD width="136">%filestem%</TD>
<TD height="17">Defined as kfw-%VERSION_MAJOR%-%VERSION_MINOR%-%VERSION_PATCH%.</TD>
</TR>
<TR>
<TD width="136">%debug%</TD>
<TD>'dbg.' Only substituted during a debug build. </TD>
</TR>
<TR>
<TD width="136">%release%</TD>
<TD>'rel.' Only substituted during a release build.
</TD>
</TR>
<TR>
<TD width="136">%bldtype%</TD>
<TD>Always substituted, to 'dbg' or 'rel,' depending on the type of build.</TD>
</TR>
<TR>
<TD width="136">%-DEBUG%</TD>
<TD>'-DEBUG' during a debug build; otherwise empty.</TD>
</TR>
<TR>
<TD width="136">%BUILDDIR%</TD>
<TD>SRCDIR\pismere. Used in site-local installer configuration files.</TD>
</TR>
<TR>
<TD width="136">%TARGETDIR%</TD>
<TD>SRCDIR\pismere\staging. Used in site-local installer configuration files.</TD>
</TR>
<TR>
<TD width="136">%CONFIGDIR-WIX%</TD>
<TD>SRCDIR\pismere\staging\sample. Used in site-local installer configuration
files.</TD>
</TR>
<TR>
<TD width="136">%CONFIGDIR-NSI%</TD>
<TD>SRCDIR\pismere\staging. Used in site-local installer configuration files.</TD>
</TR>
</TABLE>
</P>
<P>The overall build configuration specifies a debug or release build. Debug
and release results are put in different places. Files whose location
depend on the build type can use %bldtype% in their names. The script
will substitute %bldtype% with either dbg or rel, depending on the build
type. <STRONG></P>
</DIV>
<DIV style="MARGIN-LEFT: 10px; MARGIN-RIGHT: 10px" align="left">
<H3>Example</H3>
</STRONG>
<P>Here is a copylist entry. Each segment of the file's path that comes
from a different place is in a different color.</P>
<P>Release build. Config file:
</P>
<P>
<TABLE id="Table2" cellSpacing="1" cellPadding="1" border="0">
<TR>
<TD colSpan="4"><FONT face="courier"><BKW_Config></FONT></TD>
</TR>
<TR>
<TD width="23"></TD>
<TD colSpan="3"><FONT face="courier"><Config></FONT></TD>
</TR>
<TR>
<TD width="23"></TD>
<TD width="20"></TD>
<TD><FONT face="courier"><src value ="<FONT color="#000099">C:\bkw"</FONT> /></FONT>
</TD>
</TR>
</TABLE>
</P>
<P>Copylist comments:</P>
<P><tt><!-- File from paths are relative to
<src>\<FONT color="#ff00cc">pismere\athena</FONT> --> <BR><!-- File to paths are relative to <src>\<FONT color="#00ff00">
pismere\staging</FONT>
--> </tt>
</P>
<P>When the script processes this copylist, it will force the from and to paths as
indicated.</P>
<P>This line
</P>
<P><tt><File name="<FONT color="#00ffff">comerr32.dll</FONT>" from="<FONT color="#ff9933">..\target\bin\i386</FONT>\<FONT color="#ff0000">%bldtype%</FONT>\"
to="\<FONT color="#9966ff">bin\i386</FONT>" /></tt></P>
<P>will result in <FONT face="Courier"><FONT color="#000099">C:\bkw</FONT>\<FONT color="#ff00cc">pismere\athena</FONT>\<FONT color="#ff9933">..\target\bin\i386</FONT>\<FONT color="#ff0000">rel</FONT>\<FONT color="#00ffff">comerr32.dll</FONT></FONT></P>
<P>being copied to <FONT face="Courier"><FONT color="#000099">C:\bkw</FONT>\<FONT color="#00ff00">pismere\staging</FONT>\<FONT color="#9966ff">bin\i386</FONT>\<FONT color="#00ffff">comerr32.dll</FONT></FONT>.</P>
<P>Other possible attributes in a copylist entry:</P>
<UL>
<LI>
<TT>notrequired</TT>
<LI>
<TT>newname="filename"</TT>
</LI>
</UL>
<P>By default, copylist entries are required and the script will die if they aren't
present. To ignore missing files, add <TT>notrequired</TT>.</P>
<P>To rename the file, set the <TT>newname</TT> attribute.</P>
<H2><FONT face="Verdana"><A name="Remainingwork"></A>Remaining Work / Bug List</FONT></H2>
<P>Implement RETAIL, OFFICIAL, PRERELEASE, PRIVATE, SPECIAL.</P>
<P>Figure out what MIT_ONLY, BUILD_KFW, DEBUG_SYMBOL should be.</P>
<P>TARGET, APPVER.</P>
<P>NODEBUG=1. Set if release build.</P>
<H2><FONT face="Verdana"><A name="Troubleshooting"></A>Troubleshooting</FONT>
</H2>
<P><STRONG>Can't clean directory; can't delete file or directory</STRONG><BR>
Make sure a file in the named directory isn't open in another application.</P>
<P><STRONG>Can't find kerberos.ver</STRONG><BR>
You skipped the repository step and are trying to build in an empty directory.</P>
<P><strong>Directories don't exist or can't be created <br>
</strong>This can be a symptom of the Platform SDK bin area not being before the Visual Studio bin areas, such that the version of nmake running is version 8.x.<strong> <br>
</strong>[This explanation courtesy of Jeff Altman]: <br>
nmake V8 appears to favor executables over shell commands. As a result, using 'mkdir' instead of 'md' in Makefiles, as a command for creating directory trees, fails when the Cygwin mkdir.exe is present in the PATH. Changing the</P>
<P>MKDIR=mkdir<br>
RMDIR=rmdir</P>
<P>macros in the Makefiles to</P>
<P>MKDIR=md<br>
RMDIR=rd</P>
<P>should make the shell versions execute in all cases.</P>
</DIV>
</BODY>
</HTML>
|
