Compare commits
20
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c80ce04963
|
||
|
|
2956e3ffce | ||
|
|
0afe2a231f | ||
|
|
65265e48a4 | ||
|
|
49399deb3d | ||
|
|
9fe4257490 | ||
|
|
0965a45653 | ||
|
|
bfd41c8e0d | ||
|
|
9c30a30754 | ||
|
|
ee8953bd93 | ||
|
|
5bc3167286 | ||
|
|
1a3368e119 | ||
|
|
1ddba883c9 | ||
|
|
da8044d6f2 | ||
|
|
67ba48da1f | ||
|
|
5196609974 | ||
|
|
49e09a6776 | ||
|
|
748016f105 | ||
|
|
6514aaa688 | ||
|
|
3ac47adc21 |
No files matched your search
@@ -135,7 +135,7 @@ jobs:
|
||||
echo "merge_sha=$merge_sha"
|
||||
echo "merged_at=$merged_at"
|
||||
} >> "$GITHUB_OUTPUT"
|
||||
echo "Pushed $branch; CircleCI publish_release_candidate cuts the RC." >> "$GITHUB_STEP_SUMMARY"
|
||||
echo "Pushed $branch; the CircleCI publisher cuts the RC." >> "$GITHUB_STEP_SUMMARY"
|
||||
echo "Release line: $branch. Waiting without a runner for qbit-rc-published." >> "$GITHUB_STEP_SUMMARY"
|
||||
- name: Persist trusted release intent
|
||||
if: steps.merge.outputs.merge_sha != ''
|
||||
@@ -203,7 +203,7 @@ jobs:
|
||||
raise ReleaseFailure("Status response does not identify the exact release merge")
|
||||
# Circle's workflow Check Run is stable even when job statuses receive -1/-2 suffixes.
|
||||
publishers = [x for x in status.get("check_runs", [])
|
||||
if x.get("name") == "publish_release_candidate" and x.get("app", {}).get("id") == 18001]
|
||||
if x.get("name") in ("publish_release_candidate", "verify") and x.get("app", {}).get("id") == 18001]
|
||||
if not publishers:
|
||||
return ""
|
||||
publisher = max(publishers, key=lambda x: x["id"])
|
||||
@@ -265,10 +265,10 @@ jobs:
|
||||
job.get('branch'), str(job.get('build_num'))) != (repo, merge, branch, build):
|
||||
raise ReleaseFailure('Timeout job does not identify the exact cut')
|
||||
workflow = job.get('workflows', {})
|
||||
if workflow.get('workflow_name') != 'publish_release_candidate' or workflow.get('job_name') != 'qqq-orb/mvn_publish':
|
||||
if workflow.get('workflow_name') not in ('publish_release_candidate', 'verify') or workflow.get('job_name') != 'qqq-orb/mvn_publish':
|
||||
raise ReleaseFailure('Unexpected Circle publication workflow/job')
|
||||
if (publisher.get('head_sha') != merge or publisher.get('app', {}).get('id') != 18001
|
||||
or publisher.get('name') != 'publish_release_candidate'
|
||||
or publisher.get('name') != workflow.get('workflow_name')
|
||||
or publisher.get('status') != 'completed' or publisher.get('conclusion') != 'failure'):
|
||||
raise ReleaseFailure('Recovery requires the failed exact Circle publisher')
|
||||
from urllib.parse import urlsplit
|
||||
@@ -335,7 +335,7 @@ jobs:
|
||||
directory = pathlib.Path(directory)
|
||||
status = json.loads((directory / 'status.json').read_text())
|
||||
intent = json.loads((directory / 'intent.json').read_text())
|
||||
publishers = [p for p in status['check_runs'] if p.get('name') == 'publish_release_candidate' and p.get('app', {}).get('id') == 18001]
|
||||
publishers = [p for p in status['check_runs'] if p.get('name') in ('publish_release_candidate', 'verify') and p.get('app', {}).get('id') == 18001]
|
||||
if status.get('sha') != merge or not publishers:
|
||||
raise ReleaseFailure('Exact publisher evidence missing')
|
||||
class NoRedirect(urllib.request.HTTPRedirectHandler):
|
||||
|
||||
@@ -61,11 +61,23 @@ parser is pinned to PyYAML 6.0.3 and uses its safe loader.
|
||||
|
||||
| Event | Workflow | Job contract |
|
||||
| --- | --- | --- |
|
||||
| develop | publish_snapshot | existing mvn_publish, snapshot |
|
||||
| release/* | publish_release_candidate | existing mvn_publish, release_candidate |
|
||||
| vX.Y.Z tag resolving to the checkout | publish_release | existing mvn_publish, release |
|
||||
| main, feature/*, hotfix/*, other/unknown branch | test_only | existing mvn_test_only |
|
||||
| Disabled publication or unrecognized/unproven tag | test_only | full verification, no publication |
|
||||
| develop | verify | existing mvn_publish, snapshot |
|
||||
| release/* | verify | existing mvn_publish, release_candidate |
|
||||
| vX.Y.Z tag resolving to the checkout | verify | existing mvn_publish, release |
|
||||
| main, feature/*, hotfix/*, other/unknown branch | verify | existing mvn_test_only |
|
||||
| Disabled publication or unrecognized/unproven tag | verify | full verification, no publication |
|
||||
|
||||
Generated `qbit`, `core`, `frontend-core`, and `frontend-material` pipelines use
|
||||
the stable workflow name `verify`. All selected jobs, dependencies and filters
|
||||
remain intact; this adds no executor or duplicate build. Other profiles retain
|
||||
their existing workflow names and native checks.
|
||||
|
||||
When upgrading from legacy workflow names, upgrade the immutable RC worker pin
|
||||
alongside the orb so finalization recognizes both names. Confirm the CircleCI
|
||||
app's successful `verify` check on the exact migration commit before replacing
|
||||
legacy required contexts. Require `setup` and `verify` on managed branches,
|
||||
preserving other required checks and controls. Human approval is not required;
|
||||
automated checks authorize the migration.
|
||||
|
||||
The pipeline SHA must match the checkout when Circle supplies it. A tagged release
|
||||
must resolve to that checkout; missing local tags are fetched individually. A main
|
||||
@@ -182,7 +194,7 @@ manifest validation already ran in setup. It adds no new security scanner and
|
||||
makes no security-scanning claim. Keep docs-only disabled if those paths are build
|
||||
inputs or packaged application content.
|
||||
|
||||
The light route keeps workflow `test_only` and names its job
|
||||
The light route keeps workflow `verify` and names its job
|
||||
`qqq-orb/mvn_test_only`. Verify actual CircleCI/GitHub status contexts on the canary
|
||||
before changing any protection rule; workflow/job identity alone is not proof of
|
||||
the hosted context name. Current protections must not be removed speculatively.
|
||||
|
||||
+12
-1
@@ -26,7 +26,8 @@ https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-t
|
||||
- Finalization retrieves the unique unexpired intent artifact and verifies its
|
||||
originating successful `release-rc.yml` run, repository, trigger and attempt.
|
||||
Callback fields must match that immutable intent.
|
||||
- The exact merge SHA must have a successful `publish_release_candidate` Check Run
|
||||
- The exact merge SHA must have a successful `verify` (or legacy
|
||||
`publish_release_candidate`) Check Run
|
||||
from CircleCI app ID `18001`; unrelated job statuses cannot authorize release.
|
||||
Terminal publisher failure stops finalization immediately. Pending/absent publication cannot authorize a tag.
|
||||
The RC bump must have exactly that one parent and the release branch must still
|
||||
@@ -107,3 +108,13 @@ is gone, the completed release needs no recovery dispatch. Ordinary callbacks an
|
||||
scheduled reconciliation retain the requirement for a successful Circle publisher.
|
||||
|
||||
Central status API: https://central.sonatype.org/publish/publish-portal-api/
|
||||
|
||||
### Auditing independent worker revisions
|
||||
|
||||
The estate audit accepts `rc_worker_sha` in a profile or repository policy. For
|
||||
example, set `profiles.qbit.rc_worker_sha` to the approved immutable RC worker
|
||||
commit and keep `--worker-sha` at the approved revision for unchanged native
|
||||
workers. The audit still compares every caller to its exact canonical template
|
||||
and rejects mutable or mismatched pins. This avoids a fleet-wide native caller
|
||||
update when only RC release behavior changes. Required-check policy is separate;
|
||||
omitting it continues to report enforcement as unknown.
|
||||
@@ -441,6 +441,12 @@ def main():
|
||||
if expected and (not re.fullmatch(r"[0-9a-fA-F]{40}", expected) or git("rev-parse", "HEAD") != (expected + "\n").encode()):
|
||||
raise ManifestError("Checkout does not match the pipeline commit")
|
||||
output = PROFILE_TEMPLATES[config["profile"]](config, os.environ.get("CIRCLE_BRANCH", ""), os.environ.get("CIRCLE_TAG", ""))
|
||||
if config["profile"] in ("qbit", "core", "frontend-core", "frontend-material"):
|
||||
# One whole-workflow check follows the same commit from feature to release.
|
||||
# Keep every selected job, dependency and filter; add no runner or duplicate build.
|
||||
if len(output["workflows"]) != 1:
|
||||
raise ManifestError("Stable verification requires exactly one selected workflow")
|
||||
output["workflows"] = {"verify": next(iter(output["workflows"].values()))}
|
||||
parameters = continuation_parameters(config["profile"])
|
||||
if config["profile"] == "core":
|
||||
output["parameters"] = copy.deepcopy(CORE_TEMPLATE["parameters"])
|
||||
|
||||
@@ -441,6 +441,12 @@ def main():
|
||||
if expected and (not re.fullmatch(r"[0-9a-fA-F]{40}", expected) or git("rev-parse", "HEAD") != (expected + "\n").encode()):
|
||||
raise ManifestError("Checkout does not match the pipeline commit")
|
||||
output = PROFILE_TEMPLATES[config["profile"]](config, os.environ.get("CIRCLE_BRANCH", ""), os.environ.get("CIRCLE_TAG", ""))
|
||||
if config["profile"] in ("qbit", "core", "frontend-core", "frontend-material"):
|
||||
# One whole-workflow check follows the same commit from feature to release.
|
||||
# Keep every selected job, dependency and filter; add no runner or duplicate build.
|
||||
if len(output["workflows"]) != 1:
|
||||
raise ManifestError("Stable verification requires exactly one selected workflow")
|
||||
output["workflows"] = {"verify": next(iter(output["workflows"].values()))}
|
||||
parameters = continuation_parameters(config["profile"])
|
||||
if config["profile"] == "core":
|
||||
output["parameters"] = copy.deepcopy(CORE_TEMPLATE["parameters"])
|
||||
|
||||
@@ -116,7 +116,7 @@ def reconcile(api, repo):
|
||||
validate_run(run, intent, repo, merge, run_id)
|
||||
checks = api.request(prefix + 'commits/' + merge + '/check-runs?filter=latest&per_page=100')
|
||||
publishers = [c for c in checks.get('check_runs', [])
|
||||
if c.get('name') == 'publish_release_candidate' and c.get('app', {}).get('id') == 18001]
|
||||
if c.get('name') in ('publish_release_candidate', 'verify') and c.get('app', {}).get('id') == 18001]
|
||||
if not publishers:
|
||||
return 'publisher-running'
|
||||
publisher = max(publishers, key=lambda c: c['id'])
|
||||
|
||||
@@ -74,6 +74,25 @@ class AuditTests(unittest.TestCase):
|
||||
report = audit.audit(entry, Snapshot({'.qqq-ci.yml': audit.generator.yaml.safe_dump(manifest)}), VERSION, SHA, POLICY)
|
||||
self.assertIn('missing_rc_bridge', [f['code'] for f in report['findings']])
|
||||
|
||||
def test_rc_pin_policy_does_not_force_unchanged_auxiliary_worker_updates(self):
|
||||
entry = dict(ENTRY, name='qbit-authentik', nameWithOwner='QRun-IO/qbit-authentik')
|
||||
rc_sha = 'b' * 40
|
||||
definition = audit.auxiliary.BRIDGES['qbit-schema-drift']
|
||||
manifest = {'profile': 'qbit', 'orb_version': VERSION, 'default_branch': 'develop', 'release_completion': True}
|
||||
files = {audit.rc_worker.CALLER_PATH: audit.rc_worker.generate(rc_sha),
|
||||
definition['path']: audit.generator.yaml.safe_dump(audit.auxiliary.canonical('qbit-schema-drift', SHA), sort_keys=False),
|
||||
'.qqq-ci.yml': audit.generator.yaml.safe_dump(manifest),
|
||||
'.circleci/config.yml': audit.generator.yaml.safe_dump(audit.standard.canonical_caller('qbit', VERSION))}
|
||||
policy = dict(POLICY, rc_worker_sha=rc_sha)
|
||||
self.assertEqual('pass', audit.audit(entry, Snapshot(files), VERSION, SHA, policy)['status'])
|
||||
for pin in (SHA, 'main', ''):
|
||||
with self.subTest(pin=pin):
|
||||
report = audit.audit(entry, Snapshot(files), VERSION, SHA, dict(POLICY, rc_worker_sha=pin))
|
||||
self.assertTrue(report['findings'])
|
||||
files[definition['path']] = files[definition['path']].replace(SHA, rc_sha)
|
||||
report = audit.audit(entry, Snapshot(files), VERSION, SHA, policy)
|
||||
self.assertIn('native_maintenance_bridge_drift', [f['code'] for f in report['findings']])
|
||||
|
||||
def test_qbit_rc_bridge_missing_drift_pin_and_duplicate(self):
|
||||
entry = dict(ENTRY, name='qbit-test', nameWithOwner='QRun-IO/qbit-test')
|
||||
path = audit.rc_worker.CALLER_PATH
|
||||
|
||||
@@ -192,10 +192,12 @@ class PipelineTests(unittest.TestCase):
|
||||
return result
|
||||
|
||||
def assert_full(self, result, workflow="test_only"):
|
||||
self.assertEqual(list(result["workflows"]), [workflow])
|
||||
self.assertEqual(list(result["workflows"]), ["verify"])
|
||||
self.assertNotIn("docs_only", result.get("jobs", {}))
|
||||
job, options = next(iter(result["workflows"][workflow]["jobs"][0].items()))
|
||||
job, options = next(iter(result["workflows"]["verify"]["jobs"][0].items()))
|
||||
self.assertEqual(job, "qqq-orb/mvn_test_only" if workflow == "test_only" else "qqq-orb/mvn_publish")
|
||||
if workflow != "test_only":
|
||||
self.assertEqual(options["branch_type"], workflow.removeprefix("publish_"))
|
||||
self.assertEqual(options["context"], ["qqq-maven-registry-credentials"])
|
||||
self.assertFalse(options["compile_before_verify"])
|
||||
return options
|
||||
@@ -298,8 +300,8 @@ class PipelineTests(unittest.TestCase):
|
||||
self.change_docs()
|
||||
for packed in ([False, True] if PACKED else [False]):
|
||||
result = self.render(packed=packed)
|
||||
self.assertEqual(list(result["workflows"]), ["test_only"])
|
||||
options = result["workflows"]["test_only"]["jobs"][0]["docs_only"]
|
||||
self.assertEqual(list(result["workflows"]), ["verify"])
|
||||
options = result["workflows"]["verify"]["jobs"][0]["docs_only"]
|
||||
self.assertEqual(options["name"], "qqq-orb/mvn_test_only")
|
||||
self.assertIn("git diff --check", result["jobs"]["docs_only"]["steps"][1]["run"]["command"])
|
||||
(self.repo / "App.java").write_text("changed\n", encoding="utf-8")
|
||||
@@ -360,8 +362,8 @@ class PipelineTests(unittest.TestCase):
|
||||
for branch, tag, workflow in events:
|
||||
with self.subTest(workflow=workflow):
|
||||
result = self.render(CIRCLE_BRANCH=branch, CIRCLE_TAG=tag)
|
||||
self.assertEqual(list(result["workflows"]), [workflow])
|
||||
actual = result["workflows"][workflow]["jobs"]
|
||||
self.assertEqual(list(result["workflows"]), ["verify"])
|
||||
actual = result["workflows"]["verify"]["jobs"]
|
||||
expected = baseline["workflows"][workflow]["jobs"]
|
||||
self.assertEqual(len(actual), len(expected))
|
||||
for before, after in zip(expected, actual):
|
||||
@@ -422,8 +424,8 @@ class PipelineTests(unittest.TestCase):
|
||||
with self.subTest(branch=branch, enabled=enabled):
|
||||
result = self.render(CIRCLE_BRANCH=branch, QQQ_CI_RUN_PLAYWRIGHT=str(enabled).lower())
|
||||
workflow = base + ("_with_playwright" if enabled else "")
|
||||
self.assertEqual(list(result["workflows"]), [workflow])
|
||||
jobs = result["workflows"][workflow]["jobs"]
|
||||
self.assertEqual(list(result["workflows"]), ["verify"])
|
||||
jobs = result["workflows"]["verify"]["jobs"]
|
||||
self.assertEqual(len(jobs), 2 if enabled else 1)
|
||||
maven = [j for j in jobs if next(iter(j)).startswith("qqq-orb/mvn_frontend_")]
|
||||
self.assertEqual(len(maven), 1)
|
||||
@@ -454,8 +456,10 @@ class PipelineTests(unittest.TestCase):
|
||||
("hotfix/fix", "", "publish_hotfix_release"), ("", "publish-fixture", "publish_feature"),
|
||||
("", "v1.0.0", "publish_release")]:
|
||||
result = self.render(CIRCLE_BRANCH=branch, CIRCLE_TAG=tag)
|
||||
self.assertEqual(list(result["workflows"]), [workflow])
|
||||
options = next(iter(result["workflows"][workflow]["jobs"][0].values()))
|
||||
self.assertEqual(list(result["workflows"]), ["verify"])
|
||||
options = next(iter(result["workflows"]["verify"]["jobs"][0].values()))
|
||||
expected_kind = {"publish_hotfix_release": "hotfix"}.get(workflow, workflow.removeprefix("publish_"))
|
||||
self.assertEqual(options["branch_type"], expected_kind)
|
||||
if profile == "frontend-core":
|
||||
self.assertTrue(options["npm_trusted_publishing"])
|
||||
self.assertEqual(options["node_version"], "24.21")
|
||||
@@ -463,9 +467,9 @@ class PipelineTests(unittest.TestCase):
|
||||
else:
|
||||
self.assertEqual(options["context"], ["qqq-maven-registry-credentials"])
|
||||
main = self.render(CIRCLE_BRANCH="main")
|
||||
self.assertEqual(list(main["workflows"]), ["publish_release" if profile == "frontend-core" else "test_only"])
|
||||
self.assertEqual(list(main["workflows"]), ["verify"])
|
||||
rc_tag = self.render(CIRCLE_BRANCH="", CIRCLE_TAG="v1.0.0-RC.1")
|
||||
self.assertEqual(list(rc_tag["workflows"]), ["publish_release" if profile == "frontend-core" else "test_only"])
|
||||
self.assertEqual(list(rc_tag["workflows"]), ["verify"])
|
||||
|
||||
def test_profile_specific_options_rejected(self):
|
||||
for profile, options in [("qbit", {"node_version": "22"}), ("frontend-core", {"browsers": False}),
|
||||
@@ -532,7 +536,8 @@ class PipelineTests(unittest.TestCase):
|
||||
{"CIRCLE_BRANCH": "integration-example"}):
|
||||
result = self.render(**environment)
|
||||
if environment.get("CIRCLE_BRANCH") != "integration-example":
|
||||
self.assertIn("publish_release", result["workflows"])
|
||||
self.assertEqual(list(result["workflows"]), ["verify"])
|
||||
self.assertEqual(result["workflows"]["verify"]["jobs"][0]["qqq-orb/mvn_publish"]["branch_type"], "release")
|
||||
if PACKED:
|
||||
self.assertEqual(result, self.render(packed=True, **environment))
|
||||
|
||||
|
||||
@@ -58,6 +58,17 @@ class FixtureAPI:
|
||||
|
||||
|
||||
class SweepTests(unittest.TestCase):
|
||||
def test_stable_gate_and_mixed_name_latest_failure(self):
|
||||
api = FixtureAPI()
|
||||
api.status['check_runs'][0]['name'] = 'verify'
|
||||
self.assertEqual('dispatched', sweep.reconcile(api, REPO))
|
||||
api.sent.clear()
|
||||
api.status['check_runs'].append(dict(api.status['check_runs'][0],
|
||||
id=10, name='publish_release_candidate', conclusion='failure'))
|
||||
with self.assertRaises(sweep.InvalidIntent):
|
||||
sweep.reconcile(api, REPO)
|
||||
self.assertEqual([], api.sent)
|
||||
|
||||
def test_idle_never_dispatches_or_reads_artifacts(self):
|
||||
api = FixtureAPI(); api.lock = None
|
||||
self.assertEqual('idle', sweep.reconcile(api, REPO))
|
||||
|
||||
@@ -23,6 +23,17 @@ def bump(parent=SHA, version='1.2.3-RC.4'):
|
||||
|
||||
|
||||
class ReleaseGuardTests(unittest.TestCase):
|
||||
def test_stable_workflow_preserves_exact_source_and_latest_attempt_checks(self):
|
||||
result = status()
|
||||
result['check_runs'][0]['name'] = 'verify'
|
||||
self.assertEqual('1.2.3-RC.4', evaluate(SHA, result, bump()))
|
||||
result['check_runs'].append(dict(result['check_runs'][0], id=10, conclusion='failure'))
|
||||
with self.assertRaisesRegex(Failure, 'CircleCI failed'):
|
||||
evaluate(SHA, result, bump())
|
||||
result['check_runs'] = [dict(result['check_runs'][0], head_sha=OTHER)]
|
||||
with self.assertRaises(Failure):
|
||||
evaluate(SHA, result, bump())
|
||||
|
||||
def test_success_exact_built_source(self):
|
||||
self.assertEqual('1.2.3-RC.4', evaluate(SHA, status(), bump()))
|
||||
|
||||
|
||||
@@ -30,6 +30,15 @@ def validate(job, publisher):
|
||||
|
||||
|
||||
class TimeoutRecoveryTests(unittest.TestCase):
|
||||
def test_stable_gate_must_match_the_actual_publishing_workflow(self):
|
||||
job, publisher = evidence()
|
||||
job['workflows']['workflow_name'] = 'verify'
|
||||
publisher['name'] = 'verify'
|
||||
validate(job, publisher)
|
||||
publisher['name'] = 'publish_release_candidate'
|
||||
with self.assertRaises(Failure):
|
||||
validate(job, publisher)
|
||||
|
||||
def test_exact_upload_timeout_after_successful_verify(self):
|
||||
self.assertEqual((124, 0), validate(*evidence()))
|
||||
|
||||
|
||||
@@ -6,6 +6,8 @@ Example: python tools/audit_estate.py --inventory inventory.json --orb-version 0
|
||||
Policy: {"profiles":{"qbit":{"required_checks":{"main":["observed context"],
|
||||
"develop":["observed context"]}}},"repositories":{"QRun-IO/example":{...}}}.
|
||||
Only use contexts verified on hosted canaries. Absent policy is unknown, not pass.
|
||||
A profile/repository policy may set rc_worker_sha independently of --worker-sha
|
||||
so an RC-only worker change does not require updating unchanged native workers.
|
||||
"""
|
||||
import argparse
|
||||
import base64
|
||||
@@ -209,11 +211,12 @@ def audit(entry, snapshot, version, worker_sha, policy):
|
||||
if profile == 'qbit' and (rc_enabled or existing_rc):
|
||||
path = rc_worker.CALLER_PATH
|
||||
raw = rc_source
|
||||
rc_sha = policy.get("rc_worker_sha", worker_sha)
|
||||
if raw is None:
|
||||
finding('missing_rc_bridge', path)
|
||||
elif not re.fullmatch(r'[0-9a-f]{40}', worker_sha or ''):
|
||||
elif not re.fullmatch(r'[0-9a-f]{40}', rc_sha or ''):
|
||||
finding('native_pin_policy_missing', path)
|
||||
elif raw != rc_worker.generate(worker_sha):
|
||||
elif raw != rc_worker.generate(rc_sha):
|
||||
finding('rc_bridge_drift', path)
|
||||
else:
|
||||
native_paths.add(path)
|
||||
|
||||
Reference in new issue
Block a user