File: cron-make-nightly-tarball.pl

package info (click to toggle)
mpich 4.0.2-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 423,384 kB
  • sloc: ansic: 1,088,434; cpp: 71,364; javascript: 40,763; f90: 22,829; sh: 17,463; perl: 14,773; xml: 14,418; python: 10,265; makefile: 9,246; fortran: 8,008; java: 4,355; asm: 324; ruby: 176; lisp: 19; php: 8; sed: 4
file content (293 lines) | stat: -rwxr-xr-x 10,201 bytes parent folder | download | duplicates (6)
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
#!/usr/bin/env perl
#
# Copyright (c) 2016 Cisco Systems, Inc.  All rights reserved.
#
# Script to automate the steps to make pristine nightly tarballs and
# place them in a specified output directory (presumeably where the
# web server can serve them up to the world).  Designed to be invoked
# via cron (i.e., no output unless --verbose is specified).
#
# The specific steps are:
#
# 1. Ensure we have a pristine, clean git tree
# 2. git pull the latest down from upstream
# 3. Use "git describe" to get a unique string to represent this tarball
# 4. If we already have a tarball for this git HEAD in the destination
#    directory, no need to do anything further / quit
# 5. Re-write configure.ac to include the git describe string in the
#    version argument to AC_INIT
# 6. autogen.sh/configure/make distcheck
# 7. Move the resulting tarballs to the destination directory
# 8. Re-create sym links for libfabric-latest.tar.(gz|bz2)
# 9. Re-generate md5 and sh1 hash files
#
# Note that this script intentionally does *not* prune old nightly
# tarballs as result of an OFIWG phone discussion, the conlcusion of
# which was "What the heck; we have lots of disk space.  Keep
# everything."
#

use strict;
use warnings;

use File::Temp qw/ tempdir /;
use File::Basename;
use Getopt::Long;

my $libfabric_dir_arg;
my $download_dir_arg;
my $libfabric_coverity_token_arg;
my $fabtests_coverity_token_arg;
my $logfile_dir_arg;
my $help_arg;
my $verbose_arg;
my $debug_arg;

my $ok = Getopt::Long::GetOptions("libfabric-source-dir=s" => \$libfabric_dir_arg,
                                  "download-dir=s" => \$download_dir_arg,
                                  "libfabric-coverity-token=s" => \$libfabric_coverity_token_arg,
                                  "fabtests-coverity-token=s" => \$fabtests_coverity_token_arg,
                                  "logfile-dir=s" => \$logfile_dir_arg,
                                  "verbose" => \$verbose_arg,
                                  "debug" => \$debug_arg,
                                  "help|h" => \$help_arg,
                                  );

if ($help_arg || !$ok) {
    print "$0 --libfabric-source-dir libfabric_git_tree --download-dir download_tree\n";
    exit($ok);
}

# Sanity checks
die "Must specify --libfabric-source-dir, --download-dir, and --logfile-dir"
    if (!defined($libfabric_dir_arg) || $libfabric_dir_arg eq "" ||
        !defined($download_dir_arg) || $download_dir_arg eq "" ||
        !defined($logfile_dir_arg) || $logfile_dir_arg eq "");
die "$libfabric_dir_arg is not a valid directory"
    if (! -d $libfabric_dir_arg);
die "$libfabric_dir_arg is not libfabric git clone"
    if (! -d "$libfabric_dir_arg/.git" || ! -f "$libfabric_dir_arg/src/fi_tostr.c");
die "$download_dir_arg is not a valid directory"
    if (! -d $download_dir_arg);
die "$logfile_dir_arg is not a valid directory"
    if (! -d $logfile_dir_arg);

$verbose_arg = 1
    if ($debug_arg);

#####################################################################

sub doit {
    my $allowed_to_fail = shift;
    my $cmd = shift;
    my $stdout_file = shift;

    # Redirect stdout if requested
    if (defined $stdout_file) {
        $stdout_file = "$logfile_dir_arg/$stdout_file.log";
        unlink($stdout_file);
        $cmd .= " >$stdout_file";
    } elsif (!$verbose_arg && $cmd !~ />/) {
        $cmd .= " >/dev/null";
    }
    $cmd .= " 2>&1";

    my $rc = system($cmd);
    if (0 != $rc && !$allowed_to_fail) {
        # If we die/fail, ensure to a) restore the git tree to a clean
        # state, and b) change out of the temp tree so that it can be
        # removed upon exit.
        chdir($libfabric_dir_arg);
        system("git clean -dfx 2>&1 > /dev/null");
        system("git reset --hard HEAD 2>&1 > /dev/null");
        chdir("/");

        print "Command $cmd failed: exit status $rc.  Stdout:\n";
        system("cat $stdout_file")
            if (defined($stdout_file) && -f $stdout_file);
        die "Cannot continue";
    }
    system("cat $stdout_file")
        if ($debug_arg && defined($stdout_file) && -f $stdout_file);
}

sub verbose {
    print @_
        if ($verbose_arg);
}

sub git_cleanup {
    verbose("*** Ensuring we have a clean git tree...\n");

    doit(0, "git clean -dfx", "git-clean");
    doit(0, "git reset --hard HEAD", "git-reset");
    doit(0, "git pull", "git-pull");
}

sub get_git_version {
    # Get a git describe id (minus the initial 'v' in the tag name, if any)
    my $version = `git describe --tags --always`;
    chomp($version);

    verbose("*** Git describe: $version\n");
    $version =~ s/^v//;
    $version =~ y/-/./;
    return $version;
}

sub make_tarball {
    my $base_name = shift;
    my $version = shift;
    my $installdir = shift;

    my $configure_args = "CPPFLAGS=-I$installdir/include LDFLAGS=-L$installdir/lib";

    # Read in configure.ac
    verbose("*** Reading version number from configure.ac...\n");
    open(IN, "configure.ac") || die "Can't open configure.ac for reading";
    my $config;
    $config .= $_
    while(<IN>);
    close(IN);

    # Get the original version number
    $config =~ m/AC_INIT\(\[\Q$base_name\E\], \[(.+?)\]/;
    my $orig_version = $1;
    verbose("*** Replacing configure.ac version: $orig_version\n");
    verbose("*** Nightly tarball version: $version\n");

    # Update the version number with the output from "git describe"
    verbose("*** Re-writing configure.ac with git describe results...\n");
    $config =~ s/(AC_INIT\(\[\Q$base_name\E\], \[).+?\]/$1$version]/;
    open(OUT, ">configure.ac");
    print OUT $config;
    close(OUT);

    # Now make the tarball
    verbose("*** Running autogen.sh...\n");
    doit(0, "./autogen.sh", "autogen");
    verbose("*** Running configure...\n");
    doit(0, "./configure $configure_args --prefix=$installdir", "configure");
    verbose("*** Running make install...\n");
    doit(0, "make install", "make-install");

    # Is there already a tarball of this version in the download
    # directory?  If so, just exit now without doing anything.
    if (-f "$download_dir_arg/$base_name-$version.tar.gz") {
        verbose("*** Target tarball already exists: $base_name-$version.tar.gz\n");
        return 0;
    }

    # Note that distscript.pl, invoked by "make dist", checks for a dirty
    # git tree.  We have to tell it that a modified configure.ac is ok.
    # Put the name "configure.ac" in a magic environment variable.
    $ENV{'LIBFABRIC_DISTSCRIPT_DIRTY_FILES'} = "configure.ac";

    verbose("*** Running make distcheck...\n");
    doit(0, "AM_MAKEFLAGS=V=1 DISTCHECK_CONFIGURE_FLAGS=\"$configure_args\" make distcheck", "distcheck");

    delete $ENV{'LIBFABRIC_DISTSCRIPT_DIRTY_FILES'};

    # Restore configure.ac
    verbose("*** Restoring configure.ac...\n");
    doit(0, "git checkout configure.ac");

    # Move the resulting tarballs to the downloads directory
    verbose("*** Placing tarballs in download directory...\n");
    doit(0, "mv $base_name-$version.tar.gz $base_name-$version.tar.bz2 $download_dir_arg");

    return 1;
}

sub write_file {
    my $filename = shift;
    my $str = shift;

    open(OUT, ">$filename") || die "Can't write to $filename";
    print OUT $str;
    close(OUT);
}

sub submit_to_coverity {
    my $project_name = shift;
    my $version = shift;
    my $configure_args = shift;
    my $coverity_token = shift;

    verbose("*** Preparing/submitting to Coverity...\n");

    # The coverity script will be in the same directory as this script
    my $dir = dirname($0);
    my $base_name = $project_name;
    $base_name =~ s/^ofiwg(%2F|-)([a-z]+)$/$2/;
    my $cmd = "$dir/cron-submit-coverity.pl " .
        "--filename $download_dir_arg/$base_name-$version.tar.bz2 " .
        "--coverity-token $coverity_token " .
        "--make-args=-j8 " .
        "--configure-args=\"$configure_args\" " .
        "--project=$project_name ";

    $cmd .= "--verbose "
        if ($verbose_arg);
    $cmd .= "--debug "
        if ($debug_arg);
    $cmd .= "--logfile-dir=$logfile_dir_arg"
        if (defined($logfile_dir_arg));

    # Coverity script will do its own logging
    doit(0, $cmd);
}

#####################################################################

# Create a temporary directory to install into
my $installdir = tempdir(CLEANUP => 1);

verbose("*** Building libfabric...\n");
chdir($libfabric_dir_arg);
git_cleanup();
my $libfabric_version = get_git_version();
my $rebuilt_libfabric = make_tarball("libfabric",
				     $libfabric_version, $installdir);

verbose("\n\n*** Building fabtests...\n");
chdir('fabtests');
my $fabtests_version = get_git_version();
my $rebuilt_fabtests = make_tarball("fabtests",
                                    $fabtests_version, $installdir);

if ($rebuilt_libfabric || $rebuilt_fabtests) {
    # Re-generate hashes
    verbose("*** Re-generating md5/sha1sums...\n");
    chdir($download_dir_arg);
    doit(0, "md5sum libfabric*tar* fabtests*tar* > md5sums.txt");
    doit(0, "sha1sum libfabric*tar* fabtests*tar* > sha1sums.txt");

    # Write latest-snapshot.txt files
    verbose("** Re-writing latest-snapshot.txt file...\n");
    my $str = "libfabric-$libfabric_version\n" .
        "fabtests-$fabtests_version\n";
    write_file("$download_dir_arg/latest-snapshot.txt", $str);

    verbose("** Re-writing latest-snapshot.txt file...\n");
    my $dirname = basename($download_dir_arg);
    $str = "$dirname/libfabric-$libfabric_version\n" .
        "$dirname/fabtests-$fabtests_version\n";
    write_file("$download_dir_arg/../latest-snapshot.txt", $str);
}

# Run the coverity script if requested
if (defined($libfabric_coverity_token_arg) && $rebuilt_libfabric) {
    submit_to_coverity("ofiwg%2Flibfabric", $libfabric_version,
            "--enable-sockets --enable-udp --enable-verbs --enable-usnic",
            $libfabric_coverity_token_arg);
}
if (defined($fabtests_coverity_token_arg) && $rebuilt_fabtests) {
    submit_to_coverity("ofiwg%2Ffabtests", $fabtests_version,
            "CPPFLAGS=-I$installdir/include LDFLAGS=-L$installdir/lib",
            $fabtests_coverity_token_arg);
}

# All done
verbose("*** All done / nightly tarball\n");
exit(0);