Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 10 additions & 6 deletions .fernignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,11 @@
#
# publish-main.yml is hand-written: it releases com.whop.api:whop-java when a merge to main
# lands a gradle.properties version that is not yet published, and it is meant to be the
# only publish path. It has two targets behind one set of guards — GitHub Packages
# (whopio-internal, authenticated with the run's own GITHUB_TOKEN, no namespace to
# register) and the Sonatype Central Portal (public, blocked on DNS verification and a
# signing key). RELEASE_TARGET sets the default, a workflow_dispatch input overrides it,
# and every pull request rehearses both so neither path rots while the other is the live
# one.
# only publish path. Public Maven hosting on GitHub Pages is the default; the same
# verified bundle can also target GitHub Packages or Maven Central. Maven Central
# requires namespace verification and main-only signing/publishing credentials.
# Public release bytes and provenance are retained on the maven branch; reruns reuse
# that version only for the same source commit and verify the stored hashes.
#
# stamp-version.py is that workflow's version stamp: gradle.properties, every source file
# carrying X-Fern-SDK-Version, and .fern/metadata.json. It is a file rather than a script
Expand Down Expand Up @@ -86,3 +85,8 @@ src/test/java/com/whop/api/helpers/
.gitattributes
# Remove when Fern emits and tests equivalent Android consumer rules.
src/main/resources/META-INF/proguard/whop-java.pro

# Remove when Fern provides immutable public Maven hosting and equivalent checks.
.github/public-maven.py
.github/test_public_maven.py
INSTALL.md
40 changes: 40 additions & 0 deletions .github/package-smoke/pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.whop.smoke</groupId>
<artifactId>installed-sdk-consumer</artifactId>
<version>1.0.0</version>
<properties>
<maven.compiler.release>17</maven.compiler.release>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<repositories>
<repository>
<id>whop-sdk</id>
<url>${sdkRepository}</url>
</repository>
</repositories>
<dependencies>
<dependency>
<groupId>com.whop.api</groupId>
<artifactId>whop-java</artifactId>
<version>${sdkVersion}</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.14.1</version>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>exec-maven-plugin</artifactId>
<version>3.6.3</version>
<configuration>
<mainClass>PackageConsumer</mainClass>
</configuration>
</plugin>
</plugins>
</build>
</project>
99 changes: 99 additions & 0 deletions .github/public-maven.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
import datetime
import hashlib
import json
import pathlib
import re
import shutil
import sys
import xml.etree.ElementTree as ET

COORDINATE = pathlib.Path('com/whop/api/whop-java')
VERSION = re.compile(r'(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-([0-9A-Za-z]+(?:[.-][0-9A-Za-z]+)*))?')


def version_key(version):
match = VERSION.fullmatch(version)
if not match:
raise ValueError('invalid public Maven version: ' + version)
prerelease = match[4]
rank = (1,) if prerelease is None else (0, tuple(
(0, int(part)) if part.isdigit() else (1, part)
for part in prerelease.split('.')
))
return tuple(map(int, match.group(1, 2, 3))), rank


def hashes(directory):
result = {}
for file in sorted(directory.iterdir()):
if file.is_symlink() or not file.is_file():
raise ValueError('release entries must be regular files: ' + str(file))
if file.name != 'release.json':
result[file.name] = hashlib.sha256(file.read_bytes()).hexdigest()
return result


def prepare(bundle, site, version, commit):
version_key(version)
if not re.fullmatch(r'[0-9a-f]{40}', commit):
raise ValueError('the source commit must be a full Git SHA')
incoming = bundle / COORDINATE / version
for suffix in ('.jar', '-sources.jar', '-javadoc.jar', '.pom'):
if not (incoming / ('whop-java-' + version + suffix)).is_file():
raise ValueError('incomplete release bundle: ' + str(incoming))
root = ET.parse(incoming / ('whop-java-' + version + '.pom')).getroot()
ns = {'m': 'http://maven.apache.org/POM/4.0.0'}
for key, expected in (('groupId', 'com.whop.api'), ('artifactId', 'whop-java'), ('version', version)):
if root.findtext('m:' + key, namespaces=ns) != expected:
raise ValueError('the release POM has the wrong ' + key)
incoming_hashes = hashes(incoming)
target = site / COORDINATE / version
if target.exists():
record = json.loads((target / 'release.json').read_text())
if record.get('sourceCommit') != commit or record.get('version') != version:
raise ValueError('refusing to replace an immutable release from a different commit')
if record.get('sha256') != hashes(target):
raise ValueError('the stored immutable release does not match its checksums')
if (target / ('whop-java-' + version + '.pom')).read_bytes() != (incoming / ('whop-java-' + version + '.pom')).read_bytes():
raise ValueError('the retry changes the immutable release POM')
else:
existing = [path.name for path in target.parent.iterdir() if path.is_dir()] if target.parent.exists() else []
if any(version_key(other) > version_key(version) for other in existing):
raise ValueError('refusing to publish a version older than an existing release')
target.parent.mkdir(parents=True, exist_ok=True)
shutil.copytree(incoming, target)
(target / 'release.json').write_text(json.dumps({
'coordinate': 'com.whop.api:whop-java:' + version,
'version': version,
'sourceCommit': commit,
'sha256': incoming_hashes,
}, indent=2, sort_keys=True) + '\n')
versions = sorted((path.name for path in target.parent.iterdir() if path.is_dir()), key=version_key)
metadata = ET.Element('metadata')
ET.SubElement(metadata, 'groupId').text = 'com.whop.api'
ET.SubElement(metadata, 'artifactId').text = 'whop-java'
versioning = ET.SubElement(metadata, 'versioning')
ET.SubElement(versioning, 'latest').text = versions[-1]
stable = [value for value in versions if VERSION.fullmatch(value)[4] is None]
if stable:
ET.SubElement(versioning, 'release').text = stable[-1]
entries = ET.SubElement(versioning, 'versions')
for value in versions:
ET.SubElement(entries, 'version').text = value
ET.SubElement(versioning, 'lastUpdated').text = datetime.datetime.now(datetime.timezone.utc).strftime('%Y%m%d%H%M%S')
ET.indent(metadata)
data = ET.tostring(metadata, encoding='utf-8', xml_declaration=True) + b'\n'
path = target.parent / 'maven-metadata.xml'
path.write_bytes(data)
for algorithm in ('md5', 'sha1', 'sha256', 'sha512'):
pathlib.Path(str(path) + '.' + algorithm).write_text(hashlib.new(algorithm, data).hexdigest())
(site / '.nojekyll').touch()
(site / 'index.html').write_text('<!doctype html><title>Whop Java SDK Maven repository</title><h1>Whop Java SDK</h1><p>Public Maven repository for com.whop.api:whop-java.</p><p><a href="https://github.com/whopio/whopsdk-java/blob/main/INSTALL.md">Installation instructions</a></p>\n')
print('Prepared immutable com.whop.api:whop-java:' + version + ' from ' + commit)


if __name__ == '__main__':
try:
prepare(pathlib.Path(sys.argv[1]), pathlib.Path(sys.argv[2]), sys.argv[3], sys.argv[4])
except (ValueError, OSError, KeyError, ET.ParseError) as error:
raise SystemExit('::error::' + str(error))
13 changes: 13 additions & 0 deletions .github/release.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,19 @@ gradle.projectsLoaded {
connection = 'scm:git:https://github.com/whopio/whopsdk-java.git'
developerConnection = 'scm:git:ssh://git@github.com/whopio/whopsdk-java.git'
}
withXml {
def okhttp = root.configurations.api.dependencies.find {
it.group == 'com.squareup.okhttp3' && it.name == 'okhttp'
}
if (okhttp == null || !okhttp.version) {
throw new GradleException('Cannot derive the OkHttp JVM dependency for Maven consumers')
}
def dependency = asNode().dependencies[0].appendNode('dependency')
dependency.appendNode('groupId', okhttp.group)
dependency.appendNode('artifactId', 'okhttp-jvm')
dependency.appendNode('version', okhttp.version)
dependency.appendNode('scope', 'compile')
}
}
}
}
Expand Down
103 changes: 103 additions & 0 deletions .github/test_public_maven.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
import hashlib
import importlib.util
import json
import pathlib
import tempfile
import unittest
import xml.etree.ElementTree as ET

spec = importlib.util.spec_from_file_location('public_maven', pathlib.Path(__file__).with_name('public-maven.py'))
public_maven = importlib.util.module_from_spec(spec)
spec.loader.exec_module(public_maven)


class PublicMavenTest(unittest.TestCase):
def setUp(self):
self.temporary = tempfile.TemporaryDirectory()
self.addCleanup(self.temporary.cleanup)
self.root = pathlib.Path(self.temporary.name)
self.bundle = self.root / 'bundle'
self.site = self.root / 'site'
self.commit = 'a' * 40

def bundle_version(self, version):
directory = self.bundle / public_maven.COORDINATE / version
directory.mkdir(parents=True, exist_ok=True)
for suffix in ('.jar', '-sources.jar', '-javadoc.jar'):
(directory / ('whop-java-' + version + suffix)).write_bytes(b'jar-' + version.encode())
(directory / ('whop-java-' + version + '.pom')).write_text(
'<project xmlns="http://maven.apache.org/POM/4.0.0"><groupId>com.whop.api</groupId><artifactId>whop-java</artifactId><version>' + version + '</version></project>'
)
return directory

def publish(self, version, commit=None):
public_maven.prepare(self.bundle, self.site, version, commit or self.commit)
return self.site / public_maven.COORDINATE / version

def test_preserves_old_versions_and_updates_metadata(self):
self.bundle_version('2.8.1')
first = self.publish('2.8.1')
before = public_maven.hashes(first)
self.bundle_version('2.9.0')
self.publish('2.9.0', 'b' * 40)
self.assertEqual(before, public_maven.hashes(first))
metadata = first.parent / 'maven-metadata.xml'
root = ET.parse(metadata).getroot()
self.assertEqual('2.9.0', root.findtext('versioning/release'))
self.assertEqual(['2.8.1', '2.9.0'], [node.text for node in root.findall('versioning/versions/version')])
self.assertEqual(hashlib.sha256(metadata.read_bytes()).hexdigest(), pathlib.Path(str(metadata) + '.sha256').read_text())

def test_retry_reuses_original_artifact_bytes(self):
incoming = self.bundle_version('2.8.1')
target = self.publish('2.8.1')
(incoming / 'whop-java-2.8.1.jar').write_bytes(b'rebuilt-with-different-zip-times')
self.publish('2.8.1')
self.assertEqual(b'jar-2.8.1', (target / 'whop-java-2.8.1.jar').read_bytes())

def test_rejects_new_commit_for_existing_version(self):
self.bundle_version('2.8.1')
self.publish('2.8.1')
with self.assertRaisesRegex(ValueError, 'different commit'):
self.publish('2.8.1', 'b' * 40)

def test_rejects_corrupt_stored_artifact(self):
self.bundle_version('2.8.1')
target = self.publish('2.8.1')
(target / 'whop-java-2.8.1.jar').write_bytes(b'corrupt')
with self.assertRaisesRegex(ValueError, 'checksums'):
self.publish('2.8.1')

def test_rejects_pom_changes_on_retry(self):
incoming = self.bundle_version('2.8.1')
self.publish('2.8.1')
pom = incoming / 'whop-java-2.8.1.pom'
pom.write_text(pom.read_text().replace('</project>', '<description>changed</description></project>'))
with self.assertRaisesRegex(ValueError, 'POM'):
self.publish('2.8.1')

def test_rejects_version_regression(self):
self.bundle_version('2.9.0')
self.publish('2.9.0')
self.bundle_version('2.8.1')
with self.assertRaisesRegex(ValueError, 'older'):
self.publish('2.8.1')

def test_rejects_incomplete_and_wrong_coordinate_bundles(self):
incoming = self.bundle_version('2.8.1')
(incoming / 'whop-java-2.8.1-sources.jar').unlink()
with self.assertRaisesRegex(ValueError, 'incomplete'):
self.publish('2.8.1')
self.bundle_version('2.8.1')
pom = incoming / 'whop-java-2.8.1.pom'
pom.write_text(pom.read_text().replace('com.whop.api', 'other.group'))
with self.assertRaisesRegex(ValueError, 'groupId'):
self.publish('2.8.1')

def test_rejects_unsafe_version_paths(self):
for version in ('../../other', '2.8.1/other', '02.8.1'):
with self.assertRaisesRegex(ValueError, 'invalid'):
self.publish(version)

def test_semver_precedence(self):
versions = ['2.8.1', '2.8.1-rc.10', '2.8.1-rc.2', '2.8.0', '2.8.1-alpha']
self.assertEqual(['2.8.0', '2.8.1-alpha', '2.8.1-rc.2', '2.8.1-rc.10', '2.8.1'], sorted(versions, key=public_maven.version_key))
Loading
Loading