Andreas Wacknitz
2024-04-05 3ed869342c8a02e8b359df8b8c6bf6e08d0c5d4f
commit | author | age
dc1665 1 #! /usr/bin/ksh
MT 2 #
3 #
4 # This file and its contents are supplied under the terms of the
5 # Common Development and Distribution License ("CDDL"), version 1.0.
6 # You may only use this file in accordance with the terms of version
7 # 1.0 of the CDDL.
8 #
9 # A full copy of the text of the CDDL should have accompanied this
10 # source.  A copy of the CDDL is also available via the Internet at
11 # http://www.illumos.org/license/CDDL.
12 #
13
14 #
15 # Copyright 2022 Marcel Telka
16 #
17
18
ce978f 19 THIS="perl-integrate-module"
MT 20 CONF="$THIS.conf"
21 SNIPPET="$THIS.snippet"
22 APIURL="https://fastapi.metacpan.org/v1"
dc1665 23 CURL="/usr/bin/curl -s"
MT 24
25
26 function usage
27 {
20437a 28     [[ -n "$1" ]] && printf "ERROR: %s\n\n" "$1" >&2
1effb9 29     printf "Usage: %s [-d DIR] [-f] [-l VERSION] [-o OBSOLETE].. [-u] MODULE\n" "$THIS" >&2
dc1665 30     [[ -n "$1" ]] && exit 1
MT 31     exit 0
32 }
33
34
a4e32a 35 OPT_VERSION=
dc1665 36 OBSOLETE=
b8bb9c 37 UPGRADE_ONLY=0
c749e3 38 DIRECTORY=
1effb9 39 FORCE=0
MT 40 while getopts ":hd:fl:o:u" OPT ; do
dc1665 41     case "$OPT" in
MT 42     "?"|"h")    usage ;;
c749e3 43     "d")        DIRECTORY="$OPTARG" ;;
1effb9 44     "f")        FORCE=1 ;;
a4e32a 45     "l")        OPT_VERSION="$OPTARG" ;;
dc1665 46     "o")        OBSOLETE="$OBSOLETE $OPTARG" ;;
b8bb9c 47     "u")        UPGRADE_ONLY=1 ;;
dc1665 48     esac
MT 49 done
50 shift $((OPTIND - 1))
51
52 (($# == 0)) && usage
53 (($# > 1)) && usage "Too many arguments"
54
55 MODULE="$1"
56
57
750673 58 # Prevent user's environment to affect the integration.
MT 59 # Allow one exception only: USERLAND_ARCHIVES
60 GMAKE="env -"
61 [[ -n "$USERLAND_ARCHIVES" ]] && GMAKE="$GMAKE USERLAND_ARCHIVES=$USERLAND_ARCHIVES"
62 GMAKE="$GMAKE gmake"
63
64
dc1665 65 WS_TOP=$(git rev-parse --show-toplevel 2>/dev/null)
MT 66 [[ -z "$WS_TOP" ]] && usage "The script must be run in git repo"
67
c749e3 68 BASE_DIR="$WS_TOP/components"
MT 69 [[ -d "$BASE_DIR" ]] || usage "Directory $BASE_DIR not found"
dc1665 70
MT 71
72 # Get data from metacpan
ce978f 73 METACPAN_MODULE=$($CURL "$APIURL/module/$MODULE")
dc1665 74 if (($? != 0)) || [[ -z "$METACPAN_MODULE" ]] ; then
MT 75     printf "FATAL: Failed to get data from metacpan\n" >&2
76     exit 1
77 fi
78
79 # Detect distribution for module
80 DISTRIBUTION=$(printf "%s" "$METACPAN_MODULE" | /usr/bin/jq -r '.distribution')
81 if (($? != 0)) || [[ -z "$DISTRIBUTION" || "$DISTRIBUTION" == "null" ]] ; then
82     printf "FATAL: Failed to get distribution for module %s from metacpan\n" "$MODULE" >&2
83     exit 1
84 fi
85 if [[ "$DISTRIBUTION" != "${MODULE//::/-}" ]] then
4d9e44 86     NEW_MODULE="${DISTRIBUTION//-/::}"
ce978f 87     NEW_METACPAN_MODULE=$($CURL "$APIURL/module/$NEW_MODULE")
4d9e44 88     NEW_DISTRIBUTION=$(printf "%s" "$NEW_METACPAN_MODULE" | /usr/bin/jq -r '.distribution')
MT 89     if [[ "$NEW_DISTRIBUTION" == "$DISTRIBUTION" ]] ; then
20437a 90         printf "WARNING: Module %s does not match distribution %s\n" "$MODULE" "$DISTRIBUTION" >&2
MT 91         printf "WARNING: Continue with module %s instead of %s\n" "$NEW_MODULE" "$MODULE" >&2
4d9e44 92         MODULE="$NEW_MODULE"
MT 93         METACPAN_MODULE="$NEW_METACPAN_MODULE"
94     fi
dc1665 95 fi
MT 96
a4e32a 97
MT 98 # Prepare the directory
99 [[ -z "$DIRECTORY" ]] && DIRECTORY="perl/$DISTRIBUTION"
100 DIR="$BASE_DIR/$DIRECTORY"
101 mkdir -p "$DIR"
102 cd "$DIR"
103 git restore --staged . > /dev/null 2>&1
104 git checkout . > /dev/null 2>&1
105
106
107 # Following variables could be set by the hook-begin snippet
108 VERSION=
109 DOWNLOAD_URL=
ac0b30 110 LICENSE_FILE=
a4e32a 111
MT 112 # Execute hook-begin snippet
ad0976 113 if [[ -f "$CONF" ]] ; then
MT 114     gsed -e '0,/^%hook-begin%/d' -e '/^%/,$d' < "$CONF" > "$SNIPPET"
115     . "./$SNIPPET"
116     rm -f "$SNIPPET"
117 fi
a4e32a 118
MT 119 # Version specified as option takes precedence
120 [[ -n "$OPT_VERSION" ]] && VERSION="$OPT_VERSION"
121
122 # Find the latest version if not already provided
dc1665 123 if [[ -z "$VERSION" ]] ; then
MT 124     VERSION=$(printf "%s" "$METACPAN_MODULE" | /usr/bin/jq -r '.version')
125     if (($? != 0)) || [[ -z "$VERSION" || "$VERSION" == "null" ]] ; then
126         printf "FATAL: Failed to get version for module %s from metacpan\n" "$MODULE" >&2
127         exit 1
128     fi
e488e6 129     VERSION=${VERSION#v}
dc1665 130 fi
MT 131
132
15e3fb 133 # Is this new module, or just a rebuild?
dc1665 134 NEW=1
MT 135 PREV_VER=
15e3fb 136 PREV_HVER=
dc1665 137 PREV_REV=0
MT 138 if git ls-files --error-unmatch Makefile > /dev/null 2>&1 ; then
139     NEW=0
750673 140     PREV_VER=$($GMAKE print-value-COMPONENT_VERSION 2>/dev/null)
fe90ac 141     (($? != 0)) && printf "FATAL: 'gmake print-value-COMPONENT_VERSION' failed!\n" >&2 && exit 1
750673 142     PREV_REV=$($GMAKE print-value-COMPONENT_REVISION 2>/dev/null)
b8bb9c 143
MT 144     # If we were asked to do version upgrade, but we do not have new
145     # version, then we are done.
750673 146     PREV_HVER=$($GMAKE print-value-HUMAN_VERSION 2>/dev/null)
15e3fb 147     ((UPGRADE_ONLY)) && [[ "$PREV_HVER" == "$VERSION" ]] && exit 0
b8bb9c 148
1effb9 149     # Pre-flight environment checks
942783 150     if ((FORCE == 0)) ; then
1effb9 151         ! $GMAKE env-check > /dev/null 2>&1 && printf "FATAL: Pre-flight 'gmake env-check' failed!\n" >&2 && exit 1
MT 152         ! $GMAKE test-env-check > /dev/null 2>&1 && printf "FATAL: Pre-flight 'gmake test-env-check' failed!\n" >&2 && exit 1
153     fi
154
750673 155     $GMAKE clobber > /dev/null 2>&1
dc1665 156 fi
MT 157
db56d7 158
a4e32a 159 # Get download_url if not already provided
MT 160 if [[ -z "$DOWNLOAD_URL" ]] ; then
161     # Get module author
162     # TODO: here we get author of the latest version, not the specified version
163     AUTHOR=$(printf "%s" "$METACPAN_MODULE" | /usr/bin/jq -r '.author')
164     if (($? != 0)) || [[ -z "$AUTHOR" || "$AUTHOR" == "null" ]] ; then
165         printf "FATAL: Failed to get author for module %s from metacpan\n" "$MODULE" >&2
166         exit 1
167     fi
db56d7 168
a4e32a 169     # Get download_url
MT 170     DOWNLOAD_URL=$($CURL "$APIURL/download_url/$MODULE?version===$VERSION" | /usr/bin/jq -r '.download_url')
171     if (($? != 0)) || [[ -z "$DOWNLOAD_URL" || "$DOWNLOAD_URL" == "null" ]] ; then
172         printf "WARNING: Failed to get download_url for module %s, version %s from metacpan\n" "$MODULE" "$VERSION" >&2
173         DOWNLOAD_URL=
174     fi
db56d7 175 fi
MT 176
177
7f8c64 178 # Remove everything that is not in git
MT 179 rm -rf *
180 git checkout . > /dev/null 2>&1
6477b9 181 # Remove everything from git (except known patches, files, history, and $CONF)
ad0976 182 [[ -f "$CONF" ]] && grep "^%patch%" "$CONF" | while read TAG PATCH ; do rm -f "patches/$PATCH" ; done
6477b9 183 [[ -f "$CONF" ]] && grep "^%file%" "$CONF" | while read TAG FILE ; do rm -f "files/$FILE" ; done
ce978f 184 rm -f history "$CONF"
42c0cd 185 find . -type f | while read f ; do git rm "$f" > /dev/null 2>&1 ; done
7945d9 186 rm -rf "$DIR" 2>/dev/null
dc1665 187 git checkout history > /dev/null 2>&1
ce978f 188 git checkout "$CONF" > /dev/null 2>&1
ad0976 189 [[ -f "$CONF" ]] && grep "^%patch%" "$CONF" | while read TAG PATCH ; do
299a09 190     git checkout "patches/$PATCH" > /dev/null 2>&1
6af61e 191     [[ -f "patches/$PATCH" ]] || printf "WARNING: Patch %s not found\n" "$PATCH" >&2
299a09 192 done
6477b9 193 [[ -f "$CONF" ]] && grep "^%file%" "$CONF" | while read TAG FILE ; do
MT 194     git checkout "files/$FILE" > /dev/null 2>&1
195     [[ -f "files/$FILE" ]] || printf "WARNING: File %s not found\n" "$FILE" >&2
196 done
dc1665 197
MT 198
199 # Makefile template
7a3ac1 200 GENERATE_CMD="\$WS_TOOLS/$THIS"
MT 201 [[ "$DIRECTORY" != "perl/$DISTRIBUTION" ]] && GENERATE_CMD="$GENERATE_CMD -d $DIRECTORY"
202 GENERATE_CMD="$GENERATE_CMD $MODULE"
97c70b 203 (
MT 204 cat $WS_TOP/transforms/copyright-template | sed -e '/^$/,$d'
205 cat <<EOF
dc1665 206
MT 207 #
208 # This file was automatically generated using the following command:
7a3ac1 209 #   $GENERATE_CMD
dc1665 210 #
MT 211
7e592a 212 BUILD_STYLE = makemaker
13776f 213 USE_COMMON_TEST_MASTER = no
97c70b 214 EOF
ad0976 215 [[ -f "$CONF" ]] && gsed -e '0,/^%include-1%/d' -e '/^%/,$d' < "$CONF"
97c70b 216 cat <<EOF
dc1665 217
MT 218 include ../../../make-rules/shared-macros.mk
219
220 COMPONENT_PERL_MODULE =        $MODULE
4d9e44 221 EOF
MT 222 [[ "$DISTRIBUTION" != "${MODULE//::/-}" ]] && printf "COMPONENT_PERL_DISTRIBUTION =\t%s\n" "$DISTRIBUTION"
223 cat <<EOF
dc1665 224 HUMAN_VERSION =            $VERSION
MT 225 COMPONENT_REVISION =        $((PREV_REV + 1))
226 COMPONENT_SUMMARY =        $MODULE - TODO
227 COMPONENT_CPAN_AUTHOR =        $AUTHOR
228 COMPONENT_ARCHIVE_HASH =    \\
229     sha256:TODO
230 COMPONENT_LICENSE =        license:TODO
231 COMPONENT_LICENSE_FILE =    licfile:TODO
232 EOF
ad0976 233 [[ -f "$CONF" ]] && cat "$CONF" | gsed -e '0,/^%include-2%/d' -e '/^%/,$d' | gsed -e '1s/^./\n&/'
97c70b 234 printf "\ninclude \$(WS_MAKE_RULES)/common.mk\n"
ad0976 235 [[ -f "$CONF" ]] && cat "$CONF" | gsed -e '0,/^%include-3%/d' -e '/^%/,$d' | gsed -e '1s/^./\n&/'
97c70b 236 printf "\n"
MT 237 ) > Makefile
238
6866e1 239 # If the automatically constructed COMPONENT_ARCHIVE_URL is not correct then we
MT 240 # do not need COMPONENT_CPAN_AUTHOR.  We need COMPONENT_ARCHIVE_URL instead.
241 if [[ -n "$DOWNLOAD_URL" ]] ; then
750673 242     COMPONENT_ARCHIVE_URL=$($GMAKE print-value-COMPONENT_ARCHIVE_URL)
6866e1 243     [[ "$COMPONENT_ARCHIVE_URL" == "$DOWNLOAD_URL" ]] && DOWNLOAD_URL=
MT 244 fi
defafc 245 [[ -n "$DOWNLOAD_URL" ]] && sed -i -e $'s|^COMPONENT_CPAN_AUTHOR.*|COMPONENT_ARCHIVE_URL =\t\t\\\\\\\n\t'"$DOWNLOAD_URL"'|' Makefile
6866e1 246
dc1665 247 # Remove COMPONENT_REVISION if not needed
750673 248 COMPONENT_VERSION=$($GMAKE print-value-COMPONENT_VERSION)
c0f9e7 249 [[ "$PREV_VER" != "$COMPONENT_VERSION" ]] && sed -i -e '/^COMPONENT_REVISION/d' Makefile
e9cf14 250 git add Makefile
dc1665 251
MT 252 # Calculate sham256 sum for source package
750673 253 $GMAKE fetch > /dev/null 2>&1
MT 254 USERLAND_ARCHIVES=$($GMAKE print-value-USERLAND_ARCHIVES)
255 COMPONENT_ARCHIVE=$($GMAKE print-value-COMPONENT_ARCHIVE)
e9cf14 256 [[ ! -f "$USERLAND_ARCHIVES$COMPONENT_ARCHIVE" ]] && printf "FATAL: 'gmake fetch' failed!\n" >&2 && exit 1
MT 257 SHA256=$(digest -a sha256 "$USERLAND_ARCHIVES$COMPONENT_ARCHIVE")
dc1665 258 sed -i -e 's/sha256:TODO/sha256:'"$SHA256"'/g' Makefile
fc4902 259 git add Makefile
dc1665 260
10ec7b 261 # Unpack sources and apply patches
MT 262 ! $GMAKE patch > /dev/null 2>&1 && printf "FATAL: 'gmake patch' failed!\n" >&2 && exit 1
263
264 # Refresh patches
3ee84e 265 if $GMAKE refresh-patches > /dev/null 2>&1 ; then
MT 266     git add patches 2>/dev/null
267 else
268     printf "ERROR: 'gmake refresh-patches' failed!\n" >&2
269     git checkout patches 2>/dev/null
270 fi
10ec7b 271
MT 272 # Cleanup after patch refresh
273 $GMAKE clobber > /dev/null 2>&1
274
275 # Prepare sources
750673 276 ! $GMAKE prep > /dev/null 2>&1 && printf "FATAL: 'gmake prep' failed!\n" >&2 && exit 1
MT 277 SOURCE_DIR=$($GMAKE print-value-SOURCE_DIR)
e6054a 278 COMPONENT_SUBDIR=$($GMAKE print-value-COMPONENT_SUBDIR)
MT 279 [[ -n "$COMPONENT_SUBDIR" ]] && COMPONENT_SUBDIR="/$COMPONENT_SUBDIR"
dc1665 280
7e592a 281 # Switch to modulebuild if possible
MT 282 [[ -f "$SOURCE_DIR$COMPONENT_SUBDIR/Build.PL" ]] && sed -i -e 's/makemaker/modulebuild/g' Makefile
dc1665 283
78dea9 284 # Get abstract.  Either from metacpan, or directly from sources.
dc1665 285 ABSTRACT=$(printf "%s" "$METACPAN_MODULE" | /usr/bin/jq -r '.abstract')
MT 286 if (($? != 0)) || [[ -z "$ABSTRACT" || "$ABSTRACT" == "null" ]] ; then
287     printf "WARNING: Failed to get abstract for module %s from metacpan\n" "$MODULE" >&2
288     ABSTRACT="TODO"
289 fi
290 if [[ "$ABSTRACT" == "TODO" ]] ; then
e6054a 291     if [[ ! -f "$SOURCE_DIR$COMPONENT_SUBDIR/META.json" ]] ; then
dc1665 292         printf "WARNING: META.json missing\n" >&2
MT 293     else
e6054a 294         ABSTRACT=$(cat "$SOURCE_DIR$COMPONENT_SUBDIR/META.json" | /usr/bin/jq -r '.abstract')
dc1665 295         if (($? != 0)) || [[ -z "$ABSTRACT" || "$ABSTRACT" == "null" ]] ; then
MT 296             printf "WARNING: Failed to get abstract from META.json\n" >&2
78dea9 297             ABSTRACT="TODO"
MT 298         fi
299     fi
300 fi
301 if [[ "$ABSTRACT" == "TODO" ]] ; then
e6054a 302     if [[ ! -f "$SOURCE_DIR$COMPONENT_SUBDIR/META.yml" ]] ; then
78dea9 303         printf "WARNING: META.yml missing\n" >&2
MT 304     else
e6054a 305         ABSTRACT=$(cat "$SOURCE_DIR$COMPONENT_SUBDIR/META.yml" | python -c 'import sys, yaml, json; y=yaml.safe_load(sys.stdin.read()); print(json.dumps(y))' | /usr/bin/jq -r '.abstract')
78dea9 306         if (($? != 0)) || [[ -z "$ABSTRACT" || "$ABSTRACT" == "null" ]] ; then
MT 307             printf "WARNING: Failed to get abstract from META.yml\n" >&2
dc1665 308             ABSTRACT="TODO"
MT 309         fi
310     fi
311 fi
312 # Abstract needs to be sanitized
313 ABSTRACT="${ABSTRACT//\`/\\\\\`}"
314 ABSTRACT="${ABSTRACT//\"/\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}"
315 ABSTRACT="${ABSTRACT//\//\/}"
316 ABSTRACT="${ABSTRACT//\$/\\\\\$\$}"
b3bcb2 317 ABSTRACT="${ABSTRACT//\&/\\&}"
dc1665 318 sed -i -e 's/\(COMPONENT_SUMMARY.*\)TODO$/\1'"$ABSTRACT"'/g' Makefile
MT 319
320
321 # Try to detect license type(s)
322 function detect_license
323 {
324     typeset -n L="$1"
325     typeset F="$2"
326     typeset D
327
1734a6 328     D=$("$WS_TOP/tools/license-detector" "$F")
MT 329     [[ -n "$L" ]] && L="$L OR " ; L="$L$D"
dc1665 330 }
MT 331
332 LICENSE=
333 LICFILE=
bed736 334 COPYRIGHT=
ac0b30 335 for f in $LICENSE_FILE LICENSE LICENCE COPYING COPYRIGHT ; do
e6054a 336     [[ -f "$SOURCE_DIR$COMPONENT_SUBDIR/$f" ]] || continue
MT 337     LICFILE="$SOURCE_DIR$COMPONENT_SUBDIR/$f"
dc1665 338
MT 339     detect_license LICENSE "$LICFILE"
340
341     if [[ -n "$LICENSE" ]] ; then
342         sed -i -e 's|licfile:TODO|'"$f"'|g' Makefile
343         break
344     fi
345
346     printf "WARNING: Failed to detect license type in %s file\n" "$f" >&2
bed736 347
MT 348     # Since the license file does not contain any known license we will use
349     # its content as Copyright notice only
350     COPYRIGHT=$(<"$LICFILE")
dc1665 351 done
MT 352 if [[ -z "$LICFILE" ]] ; then
353     printf "WARNING: No license file found\n" >&2
354 fi
355
356 if [[ -z "$LICENSE" ]] ; then
357     # Since the distibution does not provide own license file (or we failed
358     # to find it) we will use default Perl license with added Copyright
359     # notice from this distribution
360
361     sed -i -e '/^COMPONENT_LICENSE_FILE/d' Makefile
362
bed736 363     # Try to find Copyright notice if we do not have one yet
MT 364     [[ -z "$COPYRIGHT" ]] && for f in README README.md ; do
e6054a 365         f="$SOURCE_DIR$COMPONENT_SUBDIR/$f"
dc1665 366         [[ -f "$f" ]] || continue
MT 367
9c22f5 368         COPYRIGHT=$(gsed -e '0,/^# LICENSE/d' -e '/^#/,$d' -e '/./,$!d' "$f" 2>/dev/null)
dc1665 369         [[ -n "$COPYRIGHT" ]] && break
9c22f5 370         COPYRIGHT=$(gsed -e '0,/^# COPYRIGHT/d' -e '/^#/,$d' -e '/./,$!d' "$f" 2>/dev/null)
dc1665 371         [[ -n "$COPYRIGHT" ]] && break
4b4e4b 372         COPYRIGHT=$(gsed -e '0,/LICENSE/d' -e '/^REPOSITORY/,$d' -e '/^SEE/,$d' -e '/./,$!d' "$f" 2>/dev/null)
dc1665 373         [[ -n "$COPYRIGHT" ]] && break
9c22f5 374         COPYRIGHT=$(gsed -e '0,/COPYING/d' -e '/^BUGS/,$d' -e '/^SEE/,$d' -e '/./,$!d' "$f" 2>/dev/null)
MT 375         [[ -n "$COPYRIGHT" ]] && break
7f8fc8 376         COPYRIGHT=$(gsed -e '0,/COPYRIGHT/d' -e '/^AUTHOR/,$d' -e '/^SEE/,$d' -e '/./,$!d' "$f" 2>/dev/null)
4b4e4b 377         [[ -n "$COPYRIGHT" ]] && break
MT 378         COPYRIGHT=$(gsed -e '0,/^## Copyright/d' -e '/./,$!d' "$f" 2>/dev/null)
dc1665 379         [[ -n "$COPYRIGHT" ]] && break
MT 380     done
381     if [[ -z "$COPYRIGHT" ]] ; then
382         printf "WARNING: No copyright notice found at standard locations\n" >&2
e6054a 383         for f in $(find "$SOURCE_DIR$COMPONENT_SUBDIR" -type f -name "*.pm" | LC_ALL=C sort | while read f ; do egrep -q "^=head1 (LICENSE|LICENCE|COPYRIGHT)" "$f" && echo "$f" ; done) ; do
dc1665 384             COPYRIGHT=$(sed -e '1,/^=head1 LICENSE/d' -e '/^=/,$d' "$f" 2>/dev/null)
MT 385             if [[ -n "$COPYRIGHT" ]] ; then
20437a 386                 printf "WARNING: Using copyright notice from %s\n" "$f" >&2
dc1665 387                 break
MT 388             fi
dbf244 389             COPYRIGHT=$(sed -e '1,/^=head1 LICENCE/d' -e '/^=/,$d' "$f" 2>/dev/null)
MT 390             if [[ -n "$COPYRIGHT" ]] ; then
20437a 391                 printf "WARNING: Using copyright notice from %s\n" "$f" >&2
dbf244 392                 break
MT 393             fi
dc1665 394             COPYRIGHT=$(sed -e '1,/^=head1 COPYRIGHT/d' -e '/^=/,$d' "$f" 2>/dev/null)
MT 395             if [[ -n "$COPYRIGHT" ]] ; then
20437a 396                 printf "WARNING: Using copyright notice from %s\n" "$f" >&2
dc1665 397                 break
MT 398             fi
399         done
400     fi
401     if [[ -z "$COPYRIGHT" ]] ; then
402         printf "WARNING: No copyright notice found\n" >&2
403         > "$DISTRIBUTION.license"
404     else
4b4e4b 405         (printf "%s\n\n" "$COPYRIGHT" | dos2unix -ascii
dc1665 406         i=75 ; while ((i)) ; do printf "=" ; i=$((i-1)) ; done
MT 407         printf "\n\n") > "$DISTRIBUTION.license"
408     fi
409
2a72f0 410     USE_DEFAULT_PERL_LICENSE=1
dc1665 411
2a72f0 412     # Execute hook-no-license snippet
ad0976 413     if [[ -f "$CONF" ]] ; then
MT 414         gsed -e '0,/^%hook-no-license%/d' -e '/^%/,$d' < "$CONF" > "$SNIPPET"
415         . "./$SNIPPET"
416         rm -f "$SNIPPET"
417     fi
dc1665 418
2a72f0 419
MT 420     if ((USE_DEFAULT_PERL_LICENSE)) ; then
421         # Confirm the package is distributed under the same terms as Perl itself
422         D=1
423         ((D)) && (printf "%s\n" "$COPYRIGHT" | grep -q -i "under the same terms as Perl itself") && D=0
e6054a 424         ((D)) && grep -q "license *=> *'http://dev\.perl\.org/licenses/'" "$SOURCE_DIR$COMPONENT_SUBDIR/Makefile.PL" 2>/dev/null && D=0
MT 425         ((D)) && grep -q "LICENSE *=> *'perl'" "$SOURCE_DIR$COMPONENT_SUBDIR/Makefile.PL" 2>/dev/null && D=0
426         ((D)) && [[ -f "$SOURCE_DIR$COMPONENT_SUBDIR/META.json" && "$(/usr/bin/jq -r '.license[]' < "$SOURCE_DIR$COMPONENT_SUBDIR/META.json" 2>/dev/null)" == "perl_5" ]] && D=0
427         ((D)) && [[ -f "$SOURCE_DIR$COMPONENT_SUBDIR/META.yml" && "$(cat "$SOURCE_DIR$COMPONENT_SUBDIR/META.yml" \
78dea9 428             | python -c 'import sys, yaml, json; y=yaml.safe_load(sys.stdin.read()); print(json.dumps(y))' \
MT 429             | /usr/bin/jq -r '.license[]' 2>/dev/null)" == "perl_5" ]] && D=0
2a72f0 430
MT 431         ((D)) && printf "ERROR: Heuristics failed to detect license type, using default Perl license\n" >&2
432
433         # Make a copy of license so we can use it during publish
434         cat "$WS_TOP/tools/perl-license" | grep -v "^#" >> "$DISTRIBUTION.license"
435     fi
dc1665 436     git add "$DISTRIBUTION.license"
MT 437
7f8fc8 438     [[ -z "$LICENSE" ]] && detect_license LICENSE "$DISTRIBUTION.license"
2a72f0 439     [[ -z "$LICENSE" ]] && LICENSE="TODO"
dc1665 440 fi
MT 441
442 # Store the detected license into the Makefile
443 sed -i -e 's/license:TODO/'"$LICENSE"'/g' Makefile
444
445
446 # Create manifests
750673 447 if ! $GMAKE sample-manifest > /dev/null 2>&1 ; then
c638b3 448     printf "ERROR: 'gmake sample-manifest' failed!\n" >&2
dc1665 449 else
864686 450     MANIFEST="$DISTRIBUTION-PERLVER.p5m"
MT 451     [[ "$($GMAKE print-value-SINGLE_PERL_VERSION)" == "yes" ]] && MANIFEST="$DISTRIBUTION.p5m"
dc1665 452     cat manifests/sample-manifest.p5m \
ce978f 453         | sed -e 's/^#.*Copyright.*<contributor>.*$/# This file was automatically generated using '"$THIS"'/g' \
864686 454         > "$MANIFEST"
56e9a5 455
MT 456     # Execute hook-manifest snippet
ad0976 457     if [[ -f "$CONF" ]] ; then
MT 458         gsed -e '0,/^%hook-manifest%/d' -e '/^%/,$d' < "$CONF" > "$SNIPPET"
459         . "./$SNIPPET"
460         rm -f "$SNIPPET"
461     fi
56e9a5 462
864686 463     git add manifests/sample-manifest.p5m $MANIFEST
dc1665 464 fi
56e9a5 465
MT 466
dc1665 467 # Generate REQUIRED_PACKAGES
750673 468 $GMAKE REQUIRED_PACKAGES > /dev/null 2>&1 || printf "ERROR: 'gmake REQUIRED_PACKAGES' failed!\n" >&2
dc1665 469 git add Makefile
MT 470
471
4a6306 472 # Check for Makefile completeness
20437a 473 grep -q "TODO" Makefile && printf "ERROR: Makefile is not complete (TODO found)\n" >&2
4a6306 474
MT 475
dc1665 476 # Make sure the build environment is setup properly and we do have all
MT 477 # requirements installed.  Otherwise we cannot continue.
750673 478 ! $GMAKE env-check > /dev/null 2>&1 && printf "FATAL: 'gmake env-check' failed!\n" >&2 && exit 1
dc1665 479
MT 480
bfc638 481 # Handle history
MT 482 COMPONENT_FMRI=$($GMAKE print-value-COMPONENT_FMRI)
483 PERL_VERSIONS_OBSOLETING=$($GMAKE print-value-PERL_VERSIONS_OBSOLETING)
484 OV=
485 OV_PLURAL=
486 for o in $(echo $OBSOLETE $PERL_VERSIONS_OBSOLETING | LC_ALL=C sort -u) ; do
487     PLV=${o//.}
488     FMRI=$(pkg list -nvH "$COMPONENT_FMRI-$PLV" 2>/dev/null | egrep -v '(o|r)$' | sed -e 's|^.*\('"$COMPONENT_FMRI"'\)|\1|g' -e 's/:[^:]*$//g' -e 's/\(-[^-]*\)$/,5.11\1/g')
489     [[ -n "$FMRI" ]] || continue
490     FMRI_H=${FMRI%.*}
491     FMRI_T=${FMRI##*.}
492     if [[ "$FMRI_H" == "$FMRI" ]] ; then
493         printf "WARNING: Wrong fmri format: %s\n" "$FMRI" >&2
494         continue
495     fi
496     FMRI_T=$((FMRI_T + 1))
497     printf "%s.%s noincorporate\n" "$FMRI_H" "$FMRI_T" >> history
498
a726e3 499     [[ -n "$OV" ]] && OV="${OV/ and /, } and " && OV_PLURAL="s"
bfc638 500     OV="$OV$o"
MT 501 done
502 if [[ -f history ]] ; then
503     LC_ALL=C sort -u history > history.new
504     mv history.new history
505     git add history
8479b5 506
MT 507     awk '$2 == "noincorporate" {printf("WARNING: Unincorporated package: %s\n", $1)}' < history >&2
bfc638 508 fi
MT 509
510
b00750 511 # Cleanup before we try to publish to make sure there are no leftovers from
MT 512 # previous steps
513 $GMAKE clobber > /dev/null 2>&1
514
dc1665 515 # Publish packages and create pkg5 file
750673 516 $GMAKE publish > /dev/null 2>&1 || printf "ERROR: 'gmake publish' failed!\n" >&2
907dde 517 git add pkg5 2>/dev/null
dc1665 518
MT 519
750673 520 PERL_VERSIONS=$($GMAKE print-value-PERL_VERSIONS)
13776f 521
MT 522
523 # Run tests to make sure they pass and to create result snapshots
0a0ee5 524 TESTED_VERSIONS=
13776f 525 for v in $PERL_VERSIONS ; do
b0936c 526     # Check the test environment
MT 527     ! $GMAKE PERL_VERSIONS=$v test-env-check > /dev/null 2>&1 && printf "ERROR: 'gmake test-env-check' failed for %s!\n" "$v" >&2 && continue
528
529     # Run the test
750673 530     ! $GMAKE PERL_VERSIONS=$v test > /dev/null 2>&1 && printf "ERROR: Testing failed for %s!\n" "$v" >&2 && continue
13776f 531
MT 532     # If there is no snapshot produced the component likely does not support tests
750673 533     COMPONENT_TEST_SNAPSHOT=$($GMAKE PERL_VERSION=$v print-value-COMPONENT_TEST_SNAPSHOT)
13776f 534     [[ ! -f "$COMPONENT_TEST_SNAPSHOT" ]] && printf "WARNING: Testing unsupported for %s\n" "$v" >&2 && continue
MT 535
536     # Empty result snapshot is suspicious
537     [[ -s "$COMPONENT_TEST_SNAPSHOT" ]] || printf "WARNING: Empty test results for %s\n" "$v" >&2
0a0ee5 538
MT 539     TESTED_VERSIONS="$TESTED_VERSIONS $v"
13776f 540 done
MT 541
542 # Save result snapshots and detect USE_COMMON_TEST_MASTER value
543 TEST_MASTERS=
544 for common_results in yes no ; do
0a0ee5 545     for v in $TESTED_VERSIONS ; do
750673 546         COMPONENT_TEST_SNAPSHOT=$($GMAKE PERL_VERSION=$v print-value-COMPONENT_TEST_SNAPSHOT)
MT 547         COMPONENT_TEST_MASTER=$($GMAKE PERL_VERSION=$v USE_COMMON_TEST_MASTER=$common_results print-value-COMPONENT_TEST_MASTER)
13776f 548
MT 549         if [[ -f "$COMPONENT_TEST_MASTER" ]] ; then
550             # Switch to 'USE_COMMON_TEST_MASTER = no' if test results differ
551             if ! diff "$COMPONENT_TEST_SNAPSHOT" "$COMPONENT_TEST_MASTER" > /dev/null ; then
e3157e 552                 printf "WARNING: Test results differ so switch to 'USE_COMMON_TEST_MASTER = no'\n" >&2
13776f 553                 rm -f $TEST_MASTERS
MT 554                 TEST_MASTERS=
555                 continue 2
556             fi
557         else
558             mkdir -p $(dirname "$COMPONENT_TEST_MASTER")
559             cp -p "$COMPONENT_TEST_SNAPSHOT" "$COMPONENT_TEST_MASTER"
560             TEST_MASTERS="$TEST_MASTERS $COMPONENT_TEST_MASTER"
561         fi
562     done
563     break
564 done
565 [[ -n "$TEST_MASTERS" ]] && git add $TEST_MASTERS
566
567 # Run tests again to confirm the results are reproducible
0a0ee5 568 for v in $TESTED_VERSIONS ; do
750673 569     $GMAKE PERL_VERSIONS=$v USE_COMMON_TEST_MASTER=$common_results test > /dev/null 2>&1 || printf "ERROR: Testing for %s is not reproducible!\n" "$v" >&2
13776f 570 done
MT 571
572 # Remove USE_COMMON_TEST_MASTER from Makefile if it should be set to (default) 'yes'
573 if [[ "$common_results" == "yes" ]] ; then
574     sed -i -e '/^USE_COMMON_TEST_MASTER/d' Makefile
575     git add Makefile
dc1665 576 fi
MT 577
578
579 # Construct the commit message
580 MSG=
581 if ((NEW)) ; then
ea299f 582     MSG="Add $MODULE Perl module"
dc1665 583 else
c0f9e7 584     [[ "$PREV_VER" != "$COMPONENT_VERSION" ]] && MSG="change version format"
MT 585     [[ "$PREV_HVER" != "$VERSION" ]] && MSG="update to $VERSION"
dc1665 586
MT 587     REBUILDMSG=
864686 588
MT 589     if [[ "$($GMAKE print-value-SINGLE_PERL_VERSION)" == "no" ]] ; then
590         NV=
591         for v in $PERL_VERSIONS ; do
592             PLV=${v//.}
593             pkg list -avH "$COMPONENT_FMRI-$PLV" 2>/dev/null | egrep -q -v '(o|r)$' && continue
594             [[ -n "$NV" ]] && NV="$NV and "
595             NV="$NV$v"
596         done
ea299f 597         [[ -n "$NV" ]] && REBUILDMSG="rebuild for Perl $NV"
864686 598     fi
MT 599
dc1665 600     if [[ -n "$OV" ]] ; then
ea299f 601         [[ -n "$REBUILDMSG" ]] && REBUILDMSG="$REBUILDMSG and "
MT 602         REBUILDMSG="${REBUILDMSG}obsolete package$OV_PLURAL for Perl $OV"
dc1665 603     fi
MT 604
605     if [[ -n "$REBUILDMSG" ]] ; then
606         [[ -n "$MSG" ]] && MSG="$MSG; "
607         MSG="$MSG$REBUILDMSG"
608     fi
609     [[ -z "$MSG" ]] && MSG="rebuild"
610
c749e3 611     MSG="$DIRECTORY: $MSG"
dc1665 612 fi
MT 613
614 # Commit the results
6af61e 615 ! git commit -m "$MSG" > /dev/null 2>&1 && printf "FATAL: 'git commit' failed!\n" >&2 && exit 1