Skip to content

smokeTestRelease.py: fix SNAPSHOT local testing #4556

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dsmiley wants to merge 4 commits into
base: main
Choose a base branch
from
+115 −131
Open

smokeTestRelease.py: fix SNAPSHOT local testing #4556

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c7ed33b
smokeTestRelease: split verifyUnpacked, fix SNAPSHOT local testing
dsmiley Jun 27, 2026
9dfdac3
smokeTestRelease: fix OpenAPI error message and alt-Java testSolrExample
dsmiley Jun 28, 2026
5370c0b
More fixes.
dsmiley Jun 28, 2026
28c78d6
Stop repeating ourself
dsmiley Jun 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
246 changes: 115 additions & 131 deletions dev-tools/scripts/smokeTestRelease.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,8 +156,8 @@ def checkJARMetaData(desc, jarFile, gitRevision, version):
'Implementation-Title: org.apache.solr',
'X-Compile-Source-JDK: %s' % compileJDK,
'X-Compile-Target-JDK: %s' % compileJDK,
'Specification-Version: %s' % version,
'X-Build-JDK: %s.' % BASE_JAVA_VERSION,

@dsmiley dsmiley Jun 27, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that period is weird... shouldn't be there

'Specification-Version: %s' % version.replace('-SNAPSHOT', ''),
'X-Build-JDK: %s' % BASE_JAVA_VERSION,
'Extension-Name: org.apache.solr'):
if type(verify) is not tuple:
verify = (verify,)
Expand Down Expand Up @@ -282,32 +282,37 @@ def checkSigs(urlString, version, tmpDir, isSigned, keysFile):
if expected != actual:
raise RuntimeError('solr: wrong artifacts: expected %s but got %s' % (expected, actual))

# Set up clean gpg world; import keys file:
gpgHomeDir = '%s/solr.gpg' % tmpDir
if os.path.exists(gpgHomeDir):
shutil.rmtree(gpgHomeDir)
os.makedirs(gpgHomeDir, 0o700)
gpgLogFile = '%s/solr.gpg.import.log' % tmpDir
run('gpg --homedir %s --import %s' % (gpgHomeDir, keysFile), gpgLogFile)
if isSigned:
# Set up clean gpg world; import keys file:
if os.path.exists(gpgHomeDir):
shutil.rmtree(gpgHomeDir)
os.makedirs(gpgHomeDir, 0o700)
gpgLogFile = '%s/solr.gpg.import.log' % tmpDir
run('gpg --homedir %s --import %s' % (gpgHomeDir, keysFile), gpgLogFile)

logfile = '%s/solr.assertions.log' % tmpDir

if mavenURL is None:
stopGpgAgent(gpgHomeDir, logfile)
if isSigned:
stopGpgAgent(gpgHomeDir, logfile)
raise RuntimeError('solr is missing maven')

if dockerURL is None:
stopGpgAgent(gpgHomeDir, logfile)
if isSigned:
stopGpgAgent(gpgHomeDir, logfile)
raise RuntimeError('solr is missing docker')

if changesURL is None:
stopGpgAgent(gpgHomeDir, logfile)
if isSigned:
stopGpgAgent(gpgHomeDir, logfile)
raise RuntimeError('solr is missing changes-%s' % version)
testChanges(version, changesURL)

if openApiURL is None:
stopGpgAgent(gpgHomeDir, logfile)
raise RuntimeError('solr is missing OpenAPI specification' % version)
if isSigned:
stopGpgAgent(gpgHomeDir, logfile)
raise RuntimeError('solr is missing OpenAPI specification')
testOpenApi(version, openApiURL)


Expand Down Expand Up @@ -387,7 +392,7 @@ def testChangelogMd(dir, version):
content = f.read()

# Verify that the changelog contains the current version
if 'v%s' % version not in content and version not in content:
if 'SNAPSHOT' not in version and 'v%s' % version not in content and version not in content:
raise RuntimeError('Version %s not found in CHANGELOG.md' % version)

reChangesSectionHREF = re.compile('<a id="(.*?)".*?>(.*?)</a>', re.IGNORECASE)
Expand All @@ -398,7 +403,7 @@ def testChangelogMd(dir, version):
def checkChangesContent(s, version, name, isHTML):
currentVersionTuple = versionToTuple(version, name)

if isHTML and s.find('Release %s' % version) == -1:
if isHTML and 'SNAPSHOT' not in version and s.find('Release %s' % version) == -1:
raise RuntimeError('did not see "Release %s" in %s' % (version, name))

if isHTML:
Expand Down Expand Up @@ -560,7 +565,7 @@ def getDirEntries(urlString):
return None


def unpackAndVerify(java, tmpDir, artifact, gitRevision, version, testArgs):
def unpack(tmpDir, artifact):
destDir = '%s/unpack' % tmpDir
if os.path.exists(destDir):
shutil.rmtree(destDir)
Expand All @@ -579,9 +584,7 @@ def unpackAndVerify(java, tmpDir, artifact, gitRevision, version, testArgs):
if l != [expected]:
raise RuntimeError('unpack produced entries %s; expected only %s' % (l, expected))

unpackPath = '%s/%s' % (destDir, expected)
verifyUnpacked(java, artifact, unpackPath, gitRevision, version, testArgs)
return unpackPath
return '%s/%s' % (destDir, expected)

SOLR_NOTICE = None
SOLR_LICENSE = None
Expand All @@ -598,123 +601,96 @@ def is_in_list(in_folder, files, indent=4):
raise RuntimeError('file "%s" is missing' % file_name)


def verifyUnpacked(java, artifact, unpackPath, gitRevision, version, testArgs):
def verifySrcUnpacked(java, artifact, unpackPath, version, testArgs):
# The source release is everything in source control minus excluded paths, so we don't
# check that it has specific things — the build will fail if something critical is missing.
# Also the binary release checks for presence of things that come from source control, so we're
# covered that way too.
os.chdir(unpackPath)
print(" %s" % artifact)

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 solr/documentation'
print(' run "%s"' % validateCmd)
java.run_java(validateCmd, '%s/validate.log' % unpackPath)

def _run_for_java(run_java, java_home, java_version, clean_first=False):
suffix = '-java%s' % java_version
print(" run tests w/ Java %s and testArgs='%s'..." % (java_version, testArgs))
run_java('./gradlew --no-daemon %stest %s' % ('clean ' if clean_first else '', testArgs), '%s/test%s.log' % (unpackPath, suffix))
print(" run integration tests w/ Java %s" % java_version)
run_java('./gradlew --no-daemon integrationTest -Dversion.release=%s' % version, '%s/itest%s.log' % (unpackPath, suffix))
print(" build binary release w/ Java %s" % java_version)
run_java('./gradlew --no-daemon dev -Dversion.release=%s' % version, '%s/assemble%s.log' % (unpackPath, suffix))
testSolrExample("%s/solr/packaging/build/dev" % unpackPath, java_home, False)

_run_for_java(java.run_java, java.java_home, BASE_JAVA_VERSION)
for run_alt_java, alt_java_home, alt_java_version in zip(java.run_alt_javas, java.alt_java_homes, java.alt_java_versions):
_run_for_java(run_alt_java, alt_java_home, alt_java_version, clean_first=True)

testChangelogMd('.', version)


def verifyBinaryUnpacked(java, artifact, unpackPath, version, gitRevision):
global SOLR_NOTICE
global SOLR_LICENSE

os.chdir(unpackPath)
isSrc = artifact.find('-src') != -1
isSlim = artifact.find('-slim') != -1

# Check text files in release
isSlim = '-slim' in artifact
print(" %s" % artifact)
in_root_folder = list(filter(lambda x: x[0] != '.', os.listdir(unpackPath)))
in_solr_folder = []
if isSrc:
in_solr_folder.extend(os.listdir(os.path.join(unpackPath, 'solr')))
is_in_list(in_root_folder, ['LICENSE.txt', 'NOTICE.txt', 'README.md', 'CONTRIBUTING.md', 'CHANGELOG.md'])
is_in_list(in_solr_folder, ['README.adoc'])
else:
is_in_list(in_root_folder, ['LICENSE.txt', 'NOTICE.txt', 'README.txt', 'CHANGELOG.md'])

if SOLR_NOTICE is None:
SOLR_NOTICE = open('%s/NOTICE.txt' % unpackPath, encoding='UTF-8').read()
if SOLR_LICENSE is None:
SOLR_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('solr: file "%s" is missing from artifact %s' % (fileName, artifact))
# in_root_folder.remove(fileName)
Comment on lines -625 to -633

@dsmiley dsmiley Jun 27, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO not worth doing this TODO so I removed. Testing ought to require the features in those underlying JARs.


if isSrc:
expected_src_root_folders = ['build-tools', 'changelog', 'dev-docs', 'dev-tools', 'gradle', 'solr']
expected_src_root_files = ['build.gradle', 'gradlew', 'gradlew.bat', 'settings.gradle', 'settings-gradle.lockfile', 'versions.lock']
expected_src_solr_files = ['build.gradle']
expected_src_solr_folders = ['benchmark', 'bin', 'modules', 'api', 'core', 'cross-dc-manager', 'docker', 'documentation', 'example', 'licenses', 'packaging', 'distribution', 'server', 'solr-ref-guide', 'solrj', 'solrj-jetty', 'solrj-streaming', 'solrj-zookeeper', 'test-framework', 'webapp', '.gitignore', '.gitattributes']
is_in_list(in_root_folder, expected_src_root_folders)
is_in_list(in_root_folder, expected_src_root_files)
is_in_list(in_solr_folder, expected_src_solr_folders)
is_in_list(in_solr_folder, expected_src_solr_files)
if len(in_solr_folder) > 0:
raise RuntimeError('solr: unexpected files/dirs in artifact %s solr/ folder: %s' % (artifact, in_solr_folder))
Comment on lines -635 to -645

@dsmiley dsmiley Jun 27, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not doing this anymore; an earlier comment justifies why.

elif isSlim:
in_root_folder = list(filter(lambda x: x[0] != '.', os.listdir(unpackPath)))
is_in_list(in_root_folder, ['LICENSE.txt', 'NOTICE.txt', 'README.txt', 'CHANGELOG.md'])

if isSlim:
is_in_list(in_root_folder, ['bin', 'docker', 'docs', 'example', 'licenses', 'server', 'lib'])
else:
is_in_list(in_root_folder, ['bin', 'modules', 'cross-dc-manager', 'docker', 'docs', 'example', 'licenses', 'server', 'lib'])

if len(in_root_folder) > 0:
raise RuntimeError('solr: 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 solr/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(" run integration tests w/ Java %s" % BASE_JAVA_VERSION)
java.run_java('./gradlew --no-daemon integrationTest -Dversion.release=%s' % version, '%s/itest.log' % unpackPath)
print(" build binary release w/ Java %s" % BASE_JAVA_VERSION)
java.run_java('./gradlew --no-daemon dev -Dversion.release=%s' % version, '%s/assemble.log' % unpackPath)
testSolrExample("%s/solr/packaging/build/dev" % unpackPath, java.java_home, False)

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 clean test %s' % testArgs, '%s/test-java%s.log' % (unpackPath, alt_java_version))
print(" run integration tests w/ Java %s" % alt_java_version)
run_alt_java('./gradlew --no-daemon integrationTest -Dversion.release=%s' % version, '%s/itest-java%s.log' % (unpackPath, alt_java_version))
print(" build binary release w/ Java %s" % alt_java_version)
run_alt_java('./gradlew --no-daemon dev -Dversion.release=%s' % version, '%s/assemble-java%s.log' % (unpackPath, alt_java_version))
testSolrExample("%s/solr/packaging/build/dev" % unpackPath, run_alt_java, False)

else:
# Binary tarball
checkAllJARs(os.getcwd(), gitRevision, version)

print(' copying unpacked distribution for Java %s ...' % BASE_JAVA_VERSION)
javaBaseVersionUnpackPath = '%s-java%s' % (unpackPath, BASE_JAVA_VERSION)
if os.path.exists(javaBaseVersionUnpackPath):
shutil.rmtree(javaBaseVersionUnpackPath)
shutil.copytree(unpackPath, javaBaseVersionUnpackPath)
os.chdir(javaBaseVersionUnpackPath)
print(' test solr example w/ Java %s...' % BASE_JAVA_VERSION)
testSolrExample(javaBaseVersionUnpackPath, java.java_home, isSlim)

if java.run_alt_javas:
for run_alt_java, alt_java_version in zip(java.run_alt_javas, java.alt_java_versions):
print("The alt version of java", run_alt_java, alt_java_version)
print(' copying unpacked distribution for Java %s ...' % alt_java_version)
javaAltVersionUnpackPath = '%s-java%s' % (unpackPath, alt_java_version)
if os.path.exists(javaAltVersionUnpackPath):
shutil.rmtree(javaAltVersionUnpackPath)
shutil.copytree(unpackPath, javaAltVersionUnpackPath)
os.chdir(javaAltVersionUnpackPath)
print(' test solr example w/ Java %s...' % alt_java_version)
testSolrExample(javaAltVersionUnpackPath, run_alt_java, isSlim)

os.chdir(unpackPath)
checkAllJARs(os.getcwd(), gitRevision, version)

print(' copying unpacked distribution for Java %s ...' % BASE_JAVA_VERSION)
javaBaseVersionUnpackPath = '%s-java%s' % (unpackPath, BASE_JAVA_VERSION)
if os.path.exists(javaBaseVersionUnpackPath):
shutil.rmtree(javaBaseVersionUnpackPath)
shutil.copytree(unpackPath, javaBaseVersionUnpackPath)
os.chdir(javaBaseVersionUnpackPath)
print(' test solr example w/ Java %s...' % BASE_JAVA_VERSION)
testSolrExample(javaBaseVersionUnpackPath, java.java_home, isSlim)

if java.run_alt_javas:
for run_alt_java, alt_java_home, alt_java_version in zip(java.run_alt_javas, java.alt_java_homes, java.alt_java_versions):
print(' copying unpacked distribution for Java %s ...' % alt_java_version)
javaAltVersionUnpackPath = '%s-java%s' % (unpackPath, alt_java_version)
if os.path.exists(javaAltVersionUnpackPath):
shutil.rmtree(javaAltVersionUnpackPath)
shutil.copytree(unpackPath, javaAltVersionUnpackPath)
os.chdir(javaAltVersionUnpackPath)
print(' test solr example w/ Java %s...' % alt_java_version)
testSolrExample(javaAltVersionUnpackPath, alt_java_home, isSlim)

os.chdir(unpackPath)
testChangelogMd('.', version)


Expand Down Expand Up @@ -771,7 +747,7 @@ def testSolrExample(binaryDistPath, javaPath, isSlim):
if s.find('"numFound":%d,' % (8 if isSlim else 3)) == -1:
print('FAILED: response is:\n%s' % s)
raise RuntimeError('query on solr example instance failed')
s = load('http://localhost:%d/api/cores' % port)
s = load('http://localhost:%d/api/cores?wt=json' % port)
if s.find('"status":0,') == -1:
print('FAILED: response is:\n%s' % s)
raise RuntimeError('query api v2 on solr example instance failed')
Expand Down Expand Up @@ -974,6 +950,9 @@ def verifyDeployedPOMsCoordinates(artifacts, version):
its filepath, and verify that the corresponding artifact exists.
"""
print(" verify deployed POMs' coordinates...")
if 'SNAPSHOT' in version:
print(" (skipping filepath check for SNAPSHOT — timestamp paths differ from coordinate)")
return
for POM in [a for a in artifacts if a.endswith('.pom')]:
treeRoot = ET.parse(POM).getroot()
groupId, artifactId, packaging, POMversion = getPOMcoordinate(treeRoot)
Expand Down Expand Up @@ -1160,24 +1139,29 @@ def smokeTest(java, baseURL, gitRevision, version, tmpDir, isSigned, local_keys,
if solrPath is None:
raise RuntimeError("could not find solr/%s/ subdir" % version)

print()
print('Get KEYS...')
if local_keys is not None:
print(" Using local KEYS file %s" % local_keys)
keysFile = local_keys
else:
keysFileURL = "https://archive.apache.org/dist/solr/KEYS"
print(" Downloading online KEYS file %s" % keysFileURL)
scriptutil.download('KEYS', keysFileURL, tmpDir, force_clean=FORCE_CLEAN)
keysFile = '%s/KEYS' % (tmpDir)
keysFile = None
if isSigned or local_keys is not None:
print()
print('Get KEYS...')
if local_keys is not None:
print(" Using local KEYS file %s" % local_keys)
keysFile = local_keys
else:
keysFileURL = "https://archive.apache.org/dist/solr/KEYS"
print(" Downloading online KEYS file %s" % keysFileURL)
scriptutil.download('KEYS', keysFileURL, tmpDir, force_clean=FORCE_CLEAN)
keysFile = '%s/KEYS' % (tmpDir)

print()
print('Test Solr...')
checkSigs(solrPath, version, tmpDir, isSigned, keysFile)
if not downloadOnly:
unpackAndVerify(java, tmpDir, 'solr-%s.tgz' % version, gitRevision, version, testArgs)
unpackAndVerify(java, tmpDir, 'solr-%s-slim.tgz' % version, gitRevision, version, testArgs)
unpackAndVerify(java, tmpDir, 'solr-%s-src.tgz' % version, gitRevision, version, testArgs)
artifact = 'solr-%s.tgz' % version
verifyBinaryUnpacked(java, artifact, unpack(tmpDir, artifact), version, gitRevision)
artifact = 'solr-%s-slim.tgz' % version
verifyBinaryUnpacked(java, artifact, unpack(tmpDir, artifact), version, gitRevision)
artifact = 'solr-%s-src.tgz' % version
verifySrcUnpacked(java, artifact, unpack(tmpDir, artifact), version, testArgs)
print()
print('Test Maven artifacts...')
checkMaven(solrPath, tmpDir, gitRevision, version, isSigned, keysFile)
Expand Down
Loading