-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
Copy pathsmokeTestRelease.py
executable file
·1216 lines (1016 loc) · 45.3 KB
/
smokeTestRelease.py
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
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import argparse
import codecs
import datetime
import filecmp
import glob
import hashlib
import http.client
import os
import platform
import re
import shutil
import subprocess
import sys
import textwrap
import traceback
import urllib.error
import urllib.parse
import urllib.request
import xml.etree.ElementTree as ET
import zipfile
from collections import namedtuple
import scriptutil
BASE_JAVA_VERSION = "23"
# This tool expects to find /lucene off the base URL. You
# must have a working gpg, tar, unzip in your path. This has been
# tested on Linux and on Cygwin under Windows 7.
cygwin = platform.system().lower().startswith("cygwin")
cygwinWindowsRoot = os.popen("cygpath -w /").read().strip().replace("\\", "/") if cygwin else ""
def unshortenURL(url):
parsed = urllib.parse.urlparse(url)
if parsed[0] in ("http", "https"):
h = http.client.HTTPConnection(parsed.netloc)
h.request("HEAD", parsed.path)
response = h.getresponse()
if int(response.status / 100) == 3 and response.getheader("Location"):
return response.getheader("Location")
return url
# TODO
# - make sure jars exist inside bin release
# - make sure docs exist
reHREF = re.compile('<a href="(.*?)">(.*?)</a>')
# Set to False to avoid re-downloading the packages...
FORCE_CLEAN = True
def getHREFs(urlString):
# Deref any redirects
while True:
url = urllib.parse.urlparse(urlString)
if url.scheme == "http":
h = http.client.HTTPConnection(url.netloc)
elif url.scheme == "https":
h = http.client.HTTPSConnection(url.netloc)
else:
raise RuntimeError("Unknown protocol: %s" % url.scheme)
h.request("HEAD", url.path)
r = h.getresponse()
newLoc = r.getheader("location")
if newLoc is not None:
urlString = newLoc
else:
break
links = []
try:
html = load(urlString)
except:
print("\nFAILED to open url %s" % urlString)
traceback.print_exc()
raise
for subUrl, text in reHREF.findall(html):
fullURL = urllib.parse.urljoin(urlString, subUrl)
links.append((text, fullURL))
return links
def load(urlString):
try:
content = urllib.request.urlopen(urlString).read().decode("utf-8")
except Exception as e:
print("Retrying download of url %s after exception: %s" % (urlString, e))
content = urllib.request.urlopen(urlString).read().decode("utf-8")
return content
def noJavaPackageClasses(desc, file):
with zipfile.ZipFile(file) as z2:
for name2 in z2.namelist():
if name2.endswith(".class") and (name2.startswith("java/") or name2.startswith("javax/")):
raise RuntimeError('%s contains sheisty class "%s"' % (desc, name2))
def decodeUTF8(bytes):
return codecs.getdecoder("UTF-8")(bytes)[0]
MANIFEST_FILE_NAME = "META-INF/MANIFEST.MF"
NOTICE_FILE_NAME = "META-INF/NOTICE.txt"
LICENSE_FILE_NAME = "META-INF/LICENSE.txt"
def checkJARMetaData(desc, jarFile, gitRevision, version):
with zipfile.ZipFile(jarFile, "r") as z:
for name in (MANIFEST_FILE_NAME, NOTICE_FILE_NAME, LICENSE_FILE_NAME):
try:
# The Python docs state a KeyError is raised ... so this None
# check is just defensive:
if z.getinfo(name) is None:
raise RuntimeError("%s is missing %s" % (desc, name))
except KeyError:
raise RuntimeError("%s is missing %s" % (desc, name))
s = decodeUTF8(z.read(MANIFEST_FILE_NAME))
for verify in (
"Specification-Vendor: The Apache Software Foundation",
"Implementation-Vendor: The Apache Software Foundation",
"Specification-Title: Lucene Search Engine:",
"Implementation-Title: org.apache.lucene",
"X-Compile-Source-JDK: %s" % BASE_JAVA_VERSION,
"X-Compile-Target-JDK: %s" % BASE_JAVA_VERSION,
"Specification-Version: %s" % version,
"X-Build-JDK: %s." % BASE_JAVA_VERSION,
"Extension-Name: org.apache.lucene",
):
if type(verify) is not tuple:
verify = (verify,)
for x in verify:
if s.find(x) != -1:
break
else:
if len(verify) == 1:
raise RuntimeError('%s is missing "%s" inside its META-INF/MANIFEST.MF: %s' % (desc, verify[0], s))
else:
raise RuntimeError('%s is missing one of "%s" inside its META-INF/MANIFEST.MF: %s' % (desc, verify, s))
if gitRevision != "skip":
# Make sure this matches the version and git revision we think we are releasing:
match = re.search("Implementation-Version: (.+\r\n .+)", s, re.MULTILINE)
if match:
implLine = match.group(1).replace("\r\n ", "")
verifyRevision = "%s %s" % (version, gitRevision)
if implLine.find(verifyRevision) == -1:
raise RuntimeError('%s is missing "%s" inside its META-INF/MANIFEST.MF (wrong git revision?)' % (desc, verifyRevision))
else:
raise RuntimeError("%s is missing Implementation-Version inside its META-INF/MANIFEST.MF" % desc)
notice = decodeUTF8(z.read(NOTICE_FILE_NAME))
lucene_license = decodeUTF8(z.read(LICENSE_FILE_NAME))
if LUCENE_LICENSE is None:
raise RuntimeError("BUG in smokeTestRelease!")
if LUCENE_NOTICE is None:
raise RuntimeError("BUG in smokeTestRelease!")
if notice != LUCENE_NOTICE:
raise RuntimeError("%s: %s contents doesn't match main NOTICE.txt" % (desc, NOTICE_FILE_NAME))
if lucene_license != LUCENE_LICENSE:
raise RuntimeError("%s: %s contents doesn't match main LICENSE.txt" % (desc, LICENSE_FILE_NAME))
def normSlashes(path):
return path.replace(os.sep, "/")
def checkAllJARs(topDir, gitRevision, version):
print(" verify JAR metadata/identity/no javax.* or java.* classes...")
for root, _, files in os.walk(topDir):
normRoot = normSlashes(root)
for file in files:
if file.lower().endswith(".jar"):
if normRoot.endswith("/replicator/lib") and file.startswith("javax.servlet"):
continue
fullPath = "%s/%s" % (root, file)
noJavaPackageClasses('JAR file "%s"' % fullPath, fullPath)
if file.lower().find("lucene") != -1:
checkJARMetaData('JAR file "%s"' % fullPath, fullPath, gitRevision, version)
def checkSigs(urlString, version, tmpDir, isSigned, keysFile):
print(" test basics...")
ents = getDirEntries(urlString)
artifact = None
changesURL = None
mavenURL = None
artifactURL = None
expectedSigs = []
if isSigned:
expectedSigs.append("asc")
expectedSigs.extend(["sha512"])
sigs = []
artifacts = []
for text, subURL in ents:
if text == "KEYS":
raise RuntimeError("lucene: release dir should not contain a KEYS file - only toplevel /dist/lucene/KEYS is used")
elif text == "maven/":
mavenURL = subURL
elif text.startswith("changes"):
if text not in ("changes/", "changes-%s/" % version):
raise RuntimeError("lucene: found %s vs expected changes-%s/" % (text, version))
changesURL = subURL
elif artifact is None:
artifact = text
artifactURL = subURL
expected = "lucene-%s" % version
if not artifact.startswith(expected):
raise RuntimeError("lucene: unknown artifact %s: expected prefix %s" % (text, expected))
sigs = []
elif text.startswith(artifact + "."):
sigs.append(text[len(artifact) + 1 :])
else:
if sigs != expectedSigs:
raise RuntimeError("lucene: artifact %s has wrong sigs: expected %s but got %s" % (artifact, expectedSigs, sigs))
artifacts.append((artifact, artifactURL))
artifact = text
artifactURL = subURL
sigs = []
if sigs != []:
artifacts.append((artifact, artifactURL))
if sigs != expectedSigs:
raise RuntimeError("lucene: artifact %s has wrong sigs: expected %s but got %s" % (artifact, expectedSigs, sigs))
expected = ["lucene-%s-src.tgz" % version, "lucene-%s.tgz" % version]
actual = [x[0] for x in artifacts]
if expected != actual:
raise RuntimeError("lucene: wrong artifacts: expected %s but got %s" % (expected, actual))
# Set up clean gpg world; import keys file:
gpgHomeDir = "%s/lucene.gpg" % tmpDir
if os.path.exists(gpgHomeDir):
shutil.rmtree(gpgHomeDir)
os.makedirs(gpgHomeDir, 0o700)
run("gpg --homedir %s --import %s" % (gpgHomeDir, keysFile), "%s/lucene.gpg.import.log" % tmpDir)
if mavenURL is None:
raise RuntimeError("lucene is missing maven")
if changesURL is None:
raise RuntimeError("lucene is missing changes-%s" % version)
testChanges(version, changesURL)
for artifact, urlString in artifacts:
print(" download %s..." % artifact)
scriptutil.download(artifact, urlString, tmpDir, force_clean=FORCE_CLEAN)
verifyDigests(artifact, urlString, tmpDir)
if isSigned:
print(" verify sig")
# Test sig (this is done with a clean brand-new GPG world)
scriptutil.download(artifact + ".asc", urlString + ".asc", tmpDir, force_clean=FORCE_CLEAN)
sigFile = "%s/%s.asc" % (tmpDir, artifact)
artifactFile = "%s/%s" % (tmpDir, artifact)
logFile = "%s/lucene.%s.gpg.verify.log" % (tmpDir, artifact)
run("gpg --homedir %s --display-charset utf-8 --verify %s %s" % (gpgHomeDir, sigFile, artifactFile), logFile)
# Forward any GPG warnings, except the expected one (since it's a clean world)
with open(logFile) as f:
print("File: %s" % logFile)
for line in f.readlines():
if line.lower().find("warning") != -1 and line.find("WARNING: This key is not certified with a trusted signature") == -1:
print(" GPG: %s" % line.strip())
# Test trust (this is done with the real users config)
run("gpg --import %s" % (keysFile), "%s/lucene.gpg.trust.import.log" % tmpDir)
print(" verify trust")
logFile = "%s/lucene.%s.gpg.trust.log" % (tmpDir, artifact)
run("gpg --display-charset utf-8 --verify %s %s" % (sigFile, artifactFile), logFile)
# Forward any GPG warnings:
with open(logFile) as f:
for line in f.readlines():
if line.lower().find("warning") != -1:
print(" GPG: %s" % line.strip())
def testChanges(version, changesURLString):
print(" check changes HTML...")
changesURL = None
for text, subURL in getDirEntries(changesURLString):
if text == "Changes.html":
changesURL = subURL
if changesURL is None:
raise RuntimeError("did not see Changes.html link from %s" % changesURLString)
s = load(changesURL)
checkChangesContent(s, version, changesURL, True)
def testChangesText(dir, version):
"Checks all CHANGES.txt under this dir."
for root, _, files in os.walk(dir):
# NOTE: O(N) but N should be smallish:
if "CHANGES.txt" in files:
fullPath = "%s/CHANGES.txt" % root
# print 'CHECK %s' % fullPath
checkChangesContent(open(fullPath, encoding="UTF-8").read(), version, fullPath, False)
reChangesSectionHREF = re.compile('<a id="(.*?)".*?>(.*?)</a>', re.IGNORECASE)
reUnderbarNotDashHTML = re.compile(r"<li>(\s*(LUCENE)_\d\d\d\d+)")
reUnderbarNotDashTXT = re.compile(r"\s+((LUCENE)_\d\d\d\d+)", re.MULTILINE)
def checkChangesContent(s, version, name, isHTML):
currentVersionTuple = versionToTuple(version, name)
if isHTML and s.find("Release %s" % version) == -1:
raise RuntimeError('did not see "Release %s" in %s' % (version, name))
if isHTML:
r = reUnderbarNotDashHTML
else:
r = reUnderbarNotDashTXT
m = r.search(s)
if m is not None:
raise RuntimeError("incorrect issue (_ instead of -) in %s: %s" % (name, m.group(1)))
if s.lower().find("not yet released") != -1:
raise RuntimeError('saw "not yet released" in %s' % name)
if not isHTML:
sub = "Lucene %s" % version
if s.find(sub) == -1:
# benchmark never seems to include release info:
if name.find("/benchmark/") == -1:
raise RuntimeError('did not see "%s" in %s' % (sub, name))
if isHTML:
# Make sure that a section only appears once under each release,
# and that each release is not greater than the current version
seenIDs = set()
seenText = set()
release = None
for id, text in reChangesSectionHREF.findall(s):
if text.lower().startswith("release "):
release = text[8:].strip()
seenText.clear()
releaseTuple = versionToTuple(release, name)
if releaseTuple > currentVersionTuple:
raise RuntimeError("Future release %s is greater than %s in %s" % (release, version, name))
if id in seenIDs:
raise RuntimeError('%s has duplicate section "%s" under release "%s"' % (name, text, release))
seenIDs.add(id)
if text in seenText:
raise RuntimeError('%s has duplicate section "%s" under release "%s"' % (name, text, release))
seenText.add(text)
reVersion = re.compile(r"(\d+)\.(\d+)(?:\.(\d+))?\s*(-alpha|-beta|final|RC\d+)?\s*(?:\[.*\])?", re.IGNORECASE)
def versionToTuple(version, name):
versionMatch = reVersion.match(version)
if versionMatch is None:
raise RuntimeError("Version %s in %s cannot be parsed" % (version, name))
versionTuple = versionMatch.groups()
while versionTuple[-1] is None or versionTuple[-1] == "":
versionTuple = versionTuple[:-1]
if versionTuple[-1].lower() == "-alpha":
versionTuple = versionTuple[:-1] + ("0",)
elif versionTuple[-1].lower() == "-beta":
versionTuple = versionTuple[:-1] + ("1",)
elif versionTuple[-1].lower() == "final":
versionTuple = versionTuple[:-2] + ("100",)
elif versionTuple[-1].lower()[:2] == "rc":
versionTuple = versionTuple[:-2] + (versionTuple[-1][2:],)
return tuple(int(x) if x is not None and x.isnumeric() else x for x in versionTuple)
reUnixPath = re.compile(r'\b[a-zA-Z_]+=(?:"(?:\\"|[^"])*"' + "|(?:\\\\.|[^\"'\\s])*" + r"|'(?:\\'|[^'])*')" + r'|(/(?:\\.|[^"\'\s])*)' + r'|("/(?:\\.|[^"])*")' + r"|('/(?:\\.|[^'])*')")
def unix2win(matchobj):
if matchobj.group(1) is not None:
return cygwinWindowsRoot + matchobj.group()
if matchobj.group(2) is not None:
return '"%s%s' % (cygwinWindowsRoot, matchobj.group().lstrip('"'))
if matchobj.group(3) is not None:
return "'%s%s" % (cygwinWindowsRoot, matchobj.group().lstrip("'"))
return matchobj.group()
def cygwinifyPaths(command):
# The problem: Native Windows applications running under Cygwin can't
# handle Cygwin's Unix-style paths. However, environment variable
# values are automatically converted, so only paths outside of
# environment variable values should be converted to Windows paths.
# Assumption: all paths will be absolute.
if "; gradlew " in command:
command = reUnixPath.sub(unix2win, command)
return command
def printFileContents(fileName):
# Assume log file was written in system's default encoding, but
# even if we are wrong, we replace errors ... the ASCII chars
# (which is what we mostly care about eg for the test seed) should
# still survive:
txt = codecs.open(fileName, "r", encoding=sys.getdefaultencoding(), errors="replace").read()
# Encode to our output encoding (likely also system's default
# encoding):
bytes = txt.encode(sys.stdout.encoding, errors="replace")
# Decode back to string and print... we should hit no exception here
# since all errors have been replaced:
print(codecs.getdecoder(sys.stdout.encoding)(bytes)[0])
print()
def run(command, logFile):
if cygwin:
command = cygwinifyPaths(command)
if os.system("%s > %s 2>&1" % (command, logFile)):
logPath = os.path.abspath(logFile)
print('\ncommand "%s" failed:' % command)
printFileContents(logFile)
raise RuntimeError('command "%s" failed; see log file %s' % (command, logPath))
def verifyDigests(artifact, urlString, tmpDir):
print(" verify sha512 digest")
sha512Expected, t = load(urlString + ".sha512").strip().split()
if t != "*" + artifact:
raise RuntimeError("SHA512 %s.sha512 lists artifact %s but expected *%s" % (urlString, t, artifact))
s512 = hashlib.sha512()
f = open("%s/%s" % (tmpDir, artifact), "rb")
while True:
x = f.read(65536)
if len(x) == 0:
break
s512.update(x)
f.close()
sha512Actual = s512.hexdigest()
if sha512Actual != sha512Expected:
raise RuntimeError("SHA512 digest mismatch for %s: expected %s but got %s" % (artifact, sha512Expected, sha512Actual))
def getDirEntries(urlString):
if urlString.startswith("file:/") and not urlString.startswith("file://"):
# stupid bogus ant URI
urlString = "file:///" + urlString[6:]
if urlString.startswith("file://"):
path = urlString[7:]
if path.endswith("/"):
path = path[:-1]
if cygwin: # Convert Windows path to Cygwin path
path = re.sub(r"^/([A-Za-z]):/", r"/cygdrive/\1/", path)
files = []
for ent in os.listdir(path):
entPath = "%s/%s" % (path, ent)
if os.path.isdir(entPath):
entPath += "/"
ent += "/"
files.append((ent, "file://%s" % entPath))
files.sort()
return files
else:
links = getHREFs(urlString)
for i, (text, _) in enumerate(links):
if text == "Parent Directory" or text == "..":
return links[(i + 1) :]
raise RuntimeError("could not enumerate %s" % (urlString))
def unpackAndVerify(java, tmpDir, artifact, gitRevision, version, testArgs):
destDir = "%s/unpack" % tmpDir
if os.path.exists(destDir):
shutil.rmtree(destDir)
os.makedirs(destDir)
os.chdir(destDir)
print(" unpack %s..." % artifact)
unpackLogFile = "%s/lucene-unpack-%s.log" % (tmpDir, artifact)
if artifact.endswith(".tar.gz") or artifact.endswith(".tgz"):
run("tar xzf %s/%s" % (tmpDir, artifact), unpackLogFile)
elif artifact.endswith(".zip"):
run("unzip %s/%s" % (tmpDir, artifact), unpackLogFile)
# make sure it unpacks to proper subdir
files = os.listdir(destDir)
expected = "lucene-%s" % version
if files != [expected]:
raise RuntimeError("unpack produced entries %s; expected only %s" % (files, expected))
unpackPath = "%s/%s" % (destDir, expected)
verifyUnpacked(java, artifact, unpackPath, gitRevision, version, testArgs)
return unpackPath
LUCENE_NOTICE = None
LUCENE_LICENSE = None
def is_in_list(in_folder, files, indent=4):
for fileName in files:
print("%sChecking %s" % (" " * indent, fileName))
found = False
for f in [fileName, fileName + ".txt", fileName + ".md"]:
if f in in_folder:
in_folder.remove(f)
found = True
if not found:
raise RuntimeError('file "%s" is missing' % fileName)
def verifyUnpacked(java, artifact, unpackPath, gitRevision, version, testArgs):
global LUCENE_NOTICE
global LUCENE_LICENSE
os.chdir(unpackPath)
isSrc = artifact.find("-src") != -1
# Check text files in release
print(" %s" % artifact)
in_root_folder = list(filter(lambda x: x[0] != ".", os.listdir(unpackPath)))
in_lucene_folder = []
if isSrc:
in_lucene_folder.extend(os.listdir(os.path.join(unpackPath, "lucene")))
is_in_list(in_root_folder, ["LICENSE", "NOTICE", "README"])
is_in_list(in_lucene_folder, ["JRE_VERSION_MIGRATION", "CHANGES", "MIGRATE", "SYSTEM_REQUIREMENTS"])
else:
is_in_list(in_root_folder, ["LICENSE", "NOTICE", "README", "JRE_VERSION_MIGRATION", "CHANGES", "MIGRATE", "SYSTEM_REQUIREMENTS"])
if LUCENE_NOTICE is None:
LUCENE_NOTICE = open("%s/NOTICE.txt" % unpackPath, encoding="UTF-8").read()
if LUCENE_LICENSE is None:
LUCENE_LICENSE = open("%s/LICENSE.txt" % unpackPath, encoding="UTF-8").read()
# if not isSrc:
# # TODO: we should add verifyModule/verifySubmodule (e.g. analysis) here and recurse through
# expectedJARs = ()
#
# for fileName in expectedJARs:
# fileName += '.jar'
# if fileName not in l:
# raise RuntimeError('lucene: file "%s" is missing from artifact %s' % (fileName, artifact))
# in_root_folder.remove(fileName)
expected_folders = [
"analysis",
"analysis.tests",
"backward-codecs",
"benchmark",
"benchmark-jmh",
"classification",
"codecs",
"core",
"core.tests",
"distribution.tests",
"demo",
"expressions",
"facet",
"grouping",
"highlighter",
"join",
"luke",
"memory",
"misc",
"monitor",
"queries",
"queryparser",
"replicator",
"sandbox",
"spatial-extras",
"spatial-test-fixtures",
"spatial3d",
"suggest",
"test-framework",
"licenses",
]
if isSrc:
expected_src_root_files = [
"build.gradle",
"build-tools",
"CONTRIBUTING.md",
"dev-docs",
"dev-tools",
"gradle",
"gradlew",
"gradlew.bat",
"help",
"lucene",
"settings.gradle",
"versions.lock",
"versions.toml",
]
expected_src_lucene_files = ["build.gradle", "documentation", "distribution", "dev-docs"]
is_in_list(in_root_folder, expected_src_root_files)
is_in_list(in_lucene_folder, expected_folders)
is_in_list(in_lucene_folder, expected_src_lucene_files)
if len(in_lucene_folder) > 0:
raise RuntimeError("lucene: unexpected files/dirs in artifact %s lucene/ folder: %s" % (artifact, in_lucene_folder))
else:
is_in_list(in_root_folder, ["bin", "docs", "licenses", "modules", "modules-thirdparty", "modules-test-framework"])
if len(in_root_folder) > 0:
raise RuntimeError("lucene: unexpected files/dirs in artifact %s: %s" % (artifact, in_root_folder))
if isSrc:
print(" make sure no JARs/WARs in src dist...")
lines = os.popen("find . -name \\*.jar").readlines()
if len(lines) != 0:
print(" FAILED:")
for line in lines:
print(" %s" % line.strip())
raise RuntimeError("source release has JARs...")
lines = os.popen("find . -name \\*.war").readlines()
if len(lines) != 0:
print(" FAILED:")
for line in lines:
print(" %s" % line.strip())
raise RuntimeError("source release has WARs...")
validateCmd = "./gradlew --no-daemon check -p lucene/documentation"
print(' run "%s"' % validateCmd)
java.run_java(validateCmd, "%s/validate.log" % unpackPath)
print(" run tests w/ Java %s and testArgs='%s'..." % (BASE_JAVA_VERSION, testArgs))
java.run_java("./gradlew --no-daemon test %s" % testArgs, "%s/test.log" % unpackPath)
print(" compile jars w/ Java %s" % BASE_JAVA_VERSION)
java.run_java("./gradlew --no-daemon jar -Dversion.release=%s" % version, "%s/compile.log" % unpackPath)
testDemo(java.run_java, isSrc, version, BASE_JAVA_VERSION)
if java.run_alt_javas:
for run_alt_java, alt_java_version in zip(java.run_alt_javas, java.alt_java_versions):
print(" run tests w/ Java %s and testArgs='%s'..." % (alt_java_version, testArgs))
run_alt_java("./gradlew --no-daemon test %s" % testArgs, "%s/test.log" % unpackPath)
print(" compile jars w/ Java %s" % alt_java_version)
run_alt_java("./gradlew --no-daemon jar -Dversion.release=%s" % version, "%s/compile.log" % unpackPath)
testDemo(run_alt_java, isSrc, version, alt_java_version)
print(" confirm all releases have coverage in TestBackwardsCompatibility")
confirmAllReleasesAreTestedForBackCompat(version, unpackPath)
else:
checkAllJARs(os.getcwd(), gitRevision, version)
testDemo(java.run_java, isSrc, version, BASE_JAVA_VERSION)
if java.run_alt_javas:
for run_alt_java, alt_java_version in zip(java.run_alt_javas, java.alt_java_versions):
testDemo(run_alt_java, isSrc, version, alt_java_version)
testChangesText(".", version)
def testDemo(run_java, isSrc, version, jdk):
if os.path.exists("index"):
shutil.rmtree("index") # nuke any index from any previous iteration
print(" test demo with %s..." % jdk)
sep = ";" if cygwin else ":"
if isSrc:
# For source release, use the classpath for each module.
classPath = [
"lucene/core/build/libs/lucene-core-%s.jar" % version,
"lucene/demo/build/libs/lucene-demo-%s.jar" % version,
"lucene/analysis/common/build/libs/lucene-analyzers-common-%s.jar" % version,
"lucene/queryparser/build/libs/lucene-queryparser-%s.jar" % version,
]
cp = sep.join(classPath)
docsDir = "lucene/core/src"
checkIndexCmd = 'java -ea -cp "%s" org.apache.lucene.index.CheckIndex index' % cp
indexFilesCmd = 'java -cp "%s" -Dsmoketester=true org.apache.lucene.demo.IndexFiles -index index -docs %s' % (cp, docsDir)
searchFilesCmd = 'java -cp "%s" org.apache.lucene.demo.SearchFiles -index index -query lucene' % cp
else:
# For binary release, set up module path.
cp = "--module-path %s" % (sep.join(["modules", "modules-thirdparty"]))
docsDir = "docs"
checkIndexCmd = "java -ea %s --module org.apache.lucene.core/org.apache.lucene.index.CheckIndex index" % cp
indexFilesCmd = "java -Dsmoketester=true %s --module org.apache.lucene.demo/org.apache.lucene.demo.IndexFiles -index index -docs %s" % (cp, docsDir)
searchFilesCmd = "java %s --module org.apache.lucene.demo/org.apache.lucene.demo.SearchFiles -index index -query lucene" % cp
run_java(indexFilesCmd, "index.log")
run_java(searchFilesCmd, "search.log")
reMatchingDocs = re.compile(r"(\d+) total matching documents")
m = reMatchingDocs.search(open("search.log", encoding="UTF-8").read())
if m is None:
raise RuntimeError("lucene demo's SearchFiles found no results")
else:
numHits = int(m.group(1))
if numHits < 100:
raise RuntimeError("lucene demo's SearchFiles found too few results: %s" % numHits)
print(' got %d hits for query "lucene"' % numHits)
print(" checkindex with %s..." % jdk)
run_java(checkIndexCmd, "checkindex.log")
s = open("checkindex.log").read()
m = re.search(r"^\s+version=(.*?)$", s, re.MULTILINE)
if m is None:
raise RuntimeError("unable to locate version=NNN output from CheckIndex; see checkindex.log")
actualVersion = m.group(1)
if removeTrailingZeros(actualVersion) != removeTrailingZeros(version):
raise RuntimeError('wrong version from CheckIndex: got "%s" but expected "%s"' % (actualVersion, version))
def removeTrailingZeros(version):
return re.sub(r"(\.0)*$", "", version)
def checkMaven(baseURL, tmpDir, gitRevision, version, isSigned, keysFile):
print(" download artifacts")
artifacts = []
artifactsURL = "%s/lucene/maven/org/apache/lucene/" % baseURL
targetDir = "%s/maven/org/apache/lucene" % tmpDir
if not os.path.exists(targetDir):
os.makedirs(targetDir)
crawl(artifacts, artifactsURL, targetDir)
print()
verifyPOMperBinaryArtifact(artifacts, version)
verifyMavenDigests(artifacts)
checkJavadocAndSourceArtifacts(artifacts, version)
verifyDeployedPOMsCoordinates(artifacts, version)
if isSigned:
verifyMavenSigs(tmpDir, artifacts, keysFile)
distFiles = getBinaryDistFiles(tmpDir, version, baseURL)
checkIdenticalMavenArtifacts(distFiles, artifacts, version)
checkAllJARs("%s/maven/org/apache/lucene" % tmpDir, gitRevision, version)
def getBinaryDistFiles(tmpDir, version, baseURL):
distribution = "lucene-%s.tgz" % version
if not os.path.exists("%s/%s" % (tmpDir, distribution)):
distURL = "%s/lucene/%s" % (baseURL, distribution)
print(" download %s..." % distribution, end=" ")
scriptutil.download(distribution, distURL, tmpDir, force_clean=FORCE_CLEAN)
destDir = "%s/unpack-lucene-getBinaryDistFiles" % tmpDir
if os.path.exists(destDir):
shutil.rmtree(destDir)
os.makedirs(destDir)
os.chdir(destDir)
print(" unpack %s..." % distribution)
unpackLogFile = "%s/unpack-%s-getBinaryDistFiles.log" % (tmpDir, distribution)
run("tar xzf %s/%s" % (tmpDir, distribution), unpackLogFile)
distributionFiles = []
for root, _, files in os.walk(destDir):
distributionFiles.extend([os.path.join(root, file) for file in files])
return distributionFiles
def checkJavadocAndSourceArtifacts(artifacts, version):
print(" check for javadoc and sources artifacts...")
for artifact in artifacts:
if artifact.endswith(version + ".jar"):
javadocJar = artifact[:-4] + "-javadoc.jar"
if javadocJar not in artifacts:
raise RuntimeError("missing: %s" % javadocJar)
sourcesJar = artifact[:-4] + "-sources.jar"
if sourcesJar not in artifacts:
raise RuntimeError("missing: %s" % sourcesJar)
def getZipFileEntries(fileName):
entries = []
with zipfile.ZipFile(fileName) as zf:
for zi in zf.infolist():
entries.append(zi.filename)
# Sort by name:
entries.sort()
return entries
def checkIdenticalMavenArtifacts(distFiles, artifacts, version):
print(" verify that Maven artifacts are same as in the binary distribution...")
reJarWar = re.compile(r"%s\.[wj]ar$" % version) # exclude *-javadoc.jar and *-sources.jar
distFilenames = dict()
for file in distFiles:
baseName = os.path.basename(file)
distFilenames[baseName] = file
for artifact in artifacts:
if reJarWar.search(artifact):
artifactFilename = os.path.basename(artifact)
if artifactFilename not in distFilenames:
raise RuntimeError("Maven artifact %s is not present in lucene binary distribution" % artifact)
else:
identical = filecmp.cmp(artifact, distFilenames[artifactFilename], shallow=False)
if not identical:
raise RuntimeError("Maven artifact %s is not identical to %s in lucene binary distribution" % (artifact, distFilenames[artifactFilename]))
def verifyMavenDigests(artifacts):
print(" verify Maven artifacts' md5/sha1 digests...")
reJarWarPom = re.compile(r"\.(?:[wj]ar|pom)$")
for artifactFile in [a for a in artifacts if reJarWarPom.search(a)]:
if artifactFile + ".md5" not in artifacts:
raise RuntimeError("missing: MD5 digest for %s" % artifactFile)
if artifactFile + ".sha1" not in artifacts:
raise RuntimeError("missing: SHA1 digest for %s" % artifactFile)
with open(artifactFile + ".md5", encoding="UTF-8") as md5File:
md5Expected = md5File.read().strip()
with open(artifactFile + ".sha1", encoding="UTF-8") as sha1File:
sha1Expected = sha1File.read().strip()
md5 = hashlib.md5()
sha1 = hashlib.sha1()
inputFile = open(artifactFile, "rb")
while True:
bytes = inputFile.read(65536)
if len(bytes) == 0:
break
md5.update(bytes)
sha1.update(bytes)
inputFile.close()
md5Actual = md5.hexdigest()
sha1Actual = sha1.hexdigest()
if md5Actual != md5Expected:
raise RuntimeError("MD5 digest mismatch for %s: expected %s but got %s" % (artifactFile, md5Expected, md5Actual))
if sha1Actual != sha1Expected:
raise RuntimeError("SHA1 digest mismatch for %s: expected %s but got %s" % (artifactFile, sha1Expected, sha1Actual))
def getPOMcoordinate(treeRoot):
namespace = "{http://maven.apache.org/POM/4.0.0}"
groupId = treeRoot.find("%sgroupId" % namespace)
if groupId is None:
groupId = treeRoot.find("{0}parent/{0}groupId".format(namespace))
groupId = groupId.text.strip()
artifactId = treeRoot.find("%sartifactId" % namespace).text.strip()
version = treeRoot.find("%sversion" % namespace)
if version is None:
version = treeRoot.find("{0}parent/{0}version".format(namespace))
version = version.text.strip()
packaging = treeRoot.find("%spackaging" % namespace)
packaging = "jar" if packaging is None else packaging.text.strip()
return groupId, artifactId, packaging, version
def verifyMavenSigs(tmpDir, artifacts, keysFile):
print(" verify maven artifact sigs", end=" ")
# Set up clean gpg world; import keys file:
gpgHomeDir = "%s/lucene.gpg" % tmpDir
if os.path.exists(gpgHomeDir):
shutil.rmtree(gpgHomeDir)
os.makedirs(gpgHomeDir, 0o700)
run("gpg --homedir %s --import %s" % (gpgHomeDir, keysFile), "%s/lucene.gpg.import.log" % tmpDir)
reArtifacts = re.compile(r"\.(?:pom|[jw]ar)$")
for artifactFile in [a for a in artifacts if reArtifacts.search(a)]:
artifact = os.path.basename(artifactFile)
sigFile = "%s.asc" % artifactFile
# Test sig (this is done with a clean brand-new GPG world)
logFile = "%s/lucene.%s.gpg.verify.log" % (tmpDir, artifact)
run("gpg --display-charset utf-8 --homedir %s --verify %s %s" % (gpgHomeDir, sigFile, artifactFile), logFile)
# Forward any GPG warnings, except the expected one (since it's a clean world)
print_warnings_in_file(logFile)
# Test trust (this is done with the real users config)
run("gpg --import %s" % keysFile, "%s/lucene.gpg.trust.import.log" % tmpDir)
logFile = "%s/lucene.%s.gpg.trust.log" % (tmpDir, artifact)
run("gpg --display-charset utf-8 --verify %s %s" % (sigFile, artifactFile), logFile)
# Forward any GPG warnings:
print_warnings_in_file(logFile)
sys.stdout.write(".")
print()
def print_warnings_in_file(file):
with open(file) as f:
for line in f.readlines():
if line.lower().find("warning") != -1 and line.find("WARNING: This key is not certified with a trusted signature") == -1 and line.find("WARNING: using insecure memory") == -1:
print(" GPG: %s" % line.strip())
def verifyPOMperBinaryArtifact(artifacts, version):
print(" verify that each binary artifact has a deployed POM...")
reBinaryJarWar = re.compile(r"%s\.[jw]ar$" % re.escape(version))
for artifact in [a for a in artifacts if reBinaryJarWar.search(a)]:
POM = artifact[:-4] + ".pom"
if POM not in artifacts:
raise RuntimeError("missing: POM for %s" % artifact)
def verifyDeployedPOMsCoordinates(artifacts, version):
"""
verify that each POM's coordinate (drawn from its content) matches
its filepath, and verify that the corresponding artifact exists.
"""
print(" verify deployed POMs' coordinates...")
for POM in [a for a in artifacts if a.endswith(".pom")]:
treeRoot = ET.parse(POM).getroot()
groupId, artifactId, packaging, POMversion = getPOMcoordinate(treeRoot)
POMpath = "%s/%s/%s/%s-%s.pom" % (groupId.replace(".", "/"), artifactId, version, artifactId, version)
if not POM.endswith(POMpath):
raise RuntimeError("Mismatch between POM coordinate %s:%s:%s and filepath: %s" % (groupId, artifactId, POMversion, POM))
# Verify that the corresponding artifact exists
artifact = POM[:-3] + packaging
if artifact not in artifacts:
raise RuntimeError("Missing corresponding .%s artifact for POM %s" % (packaging, POM))
def crawl(downloadedFiles, urlString, targetDir, exclusions=set()):
for text, subURL in getDirEntries(urlString):
if text not in exclusions:
path = os.path.join(targetDir, text)
if text.endswith("/"):
if not os.path.exists(path):
os.makedirs(path)
crawl(downloadedFiles, subURL, path, exclusions)
else:
if not os.path.exists(path) or FORCE_CLEAN:
scriptutil.download(text, subURL, targetDir, quiet=True, force_clean=FORCE_CLEAN)
downloadedFiles.append(path)
sys.stdout.write(".")
def make_java_config(parser, alt_java_homes):
def _make_runner(java_home, is_base_version=False):
if cygwin:
java_home = subprocess.check_output('cygpath -u "%s"' % java_home, shell=True).decode("utf-8").strip()
cmd_prefix = 'export JAVA_HOME="%s" PATH="%s/bin:$PATH" JAVACMD="%s/bin/java"' % (java_home, java_home, java_home)
s = subprocess.check_output("%s; java -version" % cmd_prefix, shell=True, stderr=subprocess.STDOUT).decode("utf-8")
match = re.search(r'version "([1-9][0-9]*)', s)
assert match
actual_version = match.group(1)
print("Java %s JAVA_HOME=%s" % (actual_version, java_home))
# validate Java version
if is_base_version:
if BASE_JAVA_VERSION != actual_version:
parser.error("got wrong base version for java %s:\n%s" % (BASE_JAVA_VERSION, s))
else:
if int(actual_version) < int(BASE_JAVA_VERSION):
parser.error("got wrong version for java %s, less than base version %s:\n%s" % (actual_version, BASE_JAVA_VERSION, s))
def run_java(cmd, logfile):
run("%s; %s" % (cmd_prefix, cmd), logfile)
return run_java, actual_version
java_home = os.environ.get("JAVA_HOME")
if java_home is None:
parser.error("JAVA_HOME must be set")
run_java, _ = _make_runner(java_home, True)
run_alt_javas = []
alt_java_versions = []
if alt_java_homes:
for alt_java_home in alt_java_homes:
run_alt_java, version = _make_runner(alt_java_home)
run_alt_javas.append(run_alt_java)
alt_java_versions.append(version)
jc = namedtuple("JavaConfig", "run_java java_home run_alt_javas alt_java_homes alt_java_versions")
return jc(run_java, java_home, run_alt_javas, alt_java_homes, alt_java_versions)
version_re = re.compile(r"(\d+\.\d+\.\d+(-ALPHA|-BETA)?)")
revision_re = re.compile(r"rev-([a-f\d]+)")
def parse_config():
epilogue = textwrap.dedent("""
Example usage:
python3 -u dev-tools/scripts/smokeTestRelease.py https://dist.apache.org/repos/dist/dev/lucene/lucene-9.0.0-RC1-rev-c7510a0...
""")
description = "Utility to test a release."
parser = argparse.ArgumentParser(description=description, epilog=epilogue, formatter_class=argparse.RawDescriptionHelpFormatter)
parser.add_argument("--tmp-dir", metavar="PATH", help="Temporary directory to test inside, defaults to /tmp/smoke_lucene_$version_$revision")
parser.add_argument("--not-signed", dest="is_signed", action="store_false", default=True, help="Indicates the release is not signed")
parser.add_argument("--local-keys", metavar="PATH", help="Uses local KEYS file instead of fetching from https://archive.apache.org/dist/lucene/KEYS")
parser.add_argument("--revision", help="GIT revision number that release was built with, defaults to that in URL")
parser.add_argument("--version", metavar="X.Y.Z(-ALPHA|-BETA)?", help="Version of the release, defaults to that in URL")
parser.add_argument("--test-alternative-java", action="append", help="Path to alternative Java home directory, to run tests with if specified")