Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
4c52053ee0 | ||
|
|
9b150f769b | ||
|
|
48d648751b |
No files matched your search
@@ -83,7 +83,7 @@ workflows:
|
||||
when: << pipeline.parameters.run_enrollment_reconcile >>
|
||||
jobs:
|
||||
- enrollment-reconcile:
|
||||
context: qqq-maven-registry-credentials
|
||||
context: [qqq-maven-registry-credentials, orb-publishing]
|
||||
filters:
|
||||
branches:
|
||||
only: main
|
||||
|
||||
@@ -66,6 +66,8 @@ jobs:
|
||||
python3 tests/test_discover_enrollment.py
|
||||
python3 tests/test_finish_enrollment.py
|
||||
python3 tests/test_run_enrollment.py
|
||||
python3 tests/test_install_reconcile_gh.py
|
||||
python3 tests/test_circle_project_settings.py
|
||||
python3 tests/test_static_analysis_exit.py
|
||||
python3 tests/test_validate_standard.py
|
||||
python3 tests/test_voyage_profile.py
|
||||
|
||||
@@ -51,3 +51,20 @@ full platform release builds retain their existing shared-worker policy.
|
||||
Existing classic branch protections without a required-status-check section gain
|
||||
an additive shared ruleset. Signing, reviews, history and access restrictions remain
|
||||
unchanged, and a subsequent reconciliation verifies the effective ruleset.
|
||||
|
||||
The same daily pass manages CircleCI's native `autocancel-builds` setting for
|
||||
canonical `repository-policy`, `homebrew-tap`, `application-template`, and
|
||||
`marketing` consumers. Marketing must retain `main` as its default branch;
|
||||
environment deployment remains main-only. CircleCI excludes default-branch,
|
||||
scheduled and rerun workflows from automatic cancellation. This avoids a custom
|
||||
cancellation job and does not add executions to consumer pipelines.
|
||||
|
||||
The pass uses the existing orb-publishing context on the trusted orb main branch.
|
||||
It changes only the cancellation flag, checks for source movement before writing,
|
||||
and verifies preservation of all other flags. Its separate
|
||||
`result.circle-settings.json` artifact records missing credentials/API access,
|
||||
unconverted sources and profiles needing cancellation-policy review explicitly.
|
||||
Publication-heavy profiles are not changed until their non-default release
|
||||
semantics are reviewed; a successful reconciliation pass does not certify them.
|
||||
|
||||
Because cancellation is project-wide, eligibility requires every discovered current main/develop branch to be canonical and use a reviewed profile. An unresolved branch or an unreviewed publishing profile prevents enabling the flag, regardless of branch order. The report lists all observed profiles.
|
||||
@@ -0,0 +1,105 @@
|
||||
"""Cost settings preserve source qualification and unrelated project controls."""
|
||||
from pathlib import Path
|
||||
import sys
|
||||
import unittest
|
||||
from unittest.mock import Mock
|
||||
|
||||
sys.path.insert(0, str(Path(__file__).resolve().parents[1] / 'tools'))
|
||||
import circle_project_settings as settings
|
||||
|
||||
|
||||
class SettingsTests(unittest.TestCase):
|
||||
def setUp(self):
|
||||
self.plan = {'repository': 'QRun-IO/marketing-website', 'profile': 'marketing',
|
||||
'branch': 'main', 'head': 'a' * 40, 'changed': False}
|
||||
self.before = {'autocancel-builds': False, 'setup-workflows': True,
|
||||
'build-fork-prs': False, 'drop-all-build-requests': False}
|
||||
self.source = Mock(side_effect=[{'archived': False, 'default_branch': 'main'},
|
||||
{'commit': {'sha': self.plan['head']}}])
|
||||
|
||||
def test_narrow_update_and_idempotent_readback(self):
|
||||
request = Mock(side_effect=[{'feature_flags': self.before}, {},
|
||||
{'feature_flags': {**self.before, 'autocancel-builds': True}}])
|
||||
result = settings.reconcile(self.plan, self.source, True, request)
|
||||
self.assertEqual({'state': 'enforced', 'changed': True}, result)
|
||||
self.assertEqual({'feature_flags': {'autocancel-builds': True}}, request.call_args_list[1].args[1])
|
||||
request = Mock(return_value={'feature_flags': {**self.before, 'autocancel-builds': True}})
|
||||
source = Mock(return_value={'archived': False, 'default_branch': 'main'})
|
||||
self.assertEqual({'state': 'enforced', 'changed': False},
|
||||
settings.reconcile(self.plan, source, True, request))
|
||||
self.assertEqual(1, request.call_count)
|
||||
|
||||
def test_dry_run_never_writes(self):
|
||||
request = Mock(return_value={'feature_flags': self.before})
|
||||
self.assertEqual({'state': 'inspected', 'changed': True},
|
||||
settings.reconcile(self.plan, self.source, False, request))
|
||||
request.assert_called_once_with(self.plan['repository'])
|
||||
|
||||
def test_unreviewed_profiles_and_unconverted_sources_never_call_api(self):
|
||||
for change, expected in [({'profile': 'qbit'}, 'not-managed'),
|
||||
({'profile': 'native-gitops'}, 'not-managed'),
|
||||
({'changed': True}, 'waiting-source')]:
|
||||
source, request = Mock(), Mock()
|
||||
result = settings.reconcile({**self.plan, **change}, source, True, request)
|
||||
self.assertEqual(expected, result['state'])
|
||||
source.assert_not_called()
|
||||
request.assert_not_called()
|
||||
|
||||
def test_changed_head_or_unexpected_default_branch_prevents_write(self):
|
||||
for responses in [
|
||||
[{'archived': False, 'default_branch': 'main'}, {'commit': {'sha': 'b' * 40}}],
|
||||
[{'archived': False, 'default_branch': 'develop'}],
|
||||
[{'archived': True, 'default_branch': 'main'}],
|
||||
]:
|
||||
request = Mock(return_value={'feature_flags': self.before})
|
||||
result = settings.reconcile(self.plan, Mock(side_effect=responses), True, request)
|
||||
self.assertEqual('unresolved', result['state'])
|
||||
self.assertTrue(all(len(call.args) == 1 for call in request.call_args_list))
|
||||
|
||||
def test_unrelated_setting_drift_and_unavailable_api_are_not_success(self):
|
||||
request = Mock(side_effect=[{'feature_flags': self.before}, {},
|
||||
{'feature_flags': {**self.before, 'autocancel-builds': True,
|
||||
'build-fork-prs': True}}])
|
||||
self.assertEqual('unresolved', settings.reconcile(self.plan, self.source, True, request)['state'])
|
||||
source = Mock(return_value={'archived': False, 'default_branch': 'main'})
|
||||
for response in [Mock(side_effect=ValueError('Central CircleCI credential unavailable')),
|
||||
Mock(return_value={'feature_flags': {}})]:
|
||||
self.assertEqual('unresolved', settings.reconcile(self.plan, source, True, response)['state'])
|
||||
|
||||
def test_repository_policy_requires_every_current_branch(self):
|
||||
main = {**self.plan, 'profile': 'repository-policy'}
|
||||
develop = {**main, 'branch': 'develop', 'profile': 'qbit'}
|
||||
for plans in ([main, develop], [develop, main]):
|
||||
source, request = Mock(), Mock()
|
||||
result = settings.reconcile_repository(plans, [], source, True, request)
|
||||
self.assertEqual('not-managed', result['state'])
|
||||
source.assert_not_called()
|
||||
request.assert_not_called()
|
||||
for plans, findings in [
|
||||
([main, {**main, 'branch': 'develop', 'changed': True}], []),
|
||||
([main], [{'repository': main['repository'], 'branch': 'develop', 'state': 'unresolved'}]),
|
||||
]:
|
||||
request = Mock()
|
||||
self.assertEqual('waiting-source', settings.reconcile_repository(
|
||||
plans, findings, Mock(), True, request)['state'])
|
||||
request.assert_not_called()
|
||||
|
||||
def test_repository_policy_checks_all_heads_and_writes_once(self):
|
||||
plans = [self.plan, {**self.plan, 'branch': 'develop', 'head': 'b' * 40}]
|
||||
def source(path):
|
||||
if '/branches/' in path:
|
||||
return {'commit': {'sha': next(p['head'] for p in plans if path.endswith('/' + p['branch']))}}
|
||||
return {'archived': False, 'default_branch': 'main'}
|
||||
request = Mock(side_effect=[{'feature_flags': self.before}, {},
|
||||
{'feature_flags': {**self.before, 'autocancel-builds': True}}])
|
||||
self.assertEqual({'state': 'enforced', 'changed': True},
|
||||
settings.reconcile_repository(plans, [], source, True, request))
|
||||
self.assertEqual(1, sum(len(call.args) == 2 for call in request.call_args_list))
|
||||
request = Mock()
|
||||
stale = lambda path: {'commit': {'sha': self.plan['head']}}
|
||||
self.assertEqual('unresolved', settings.reconcile_repository(plans, [], stale, True, request)['state'])
|
||||
request.assert_not_called()
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
unittest.main()
|
||||
@@ -0,0 +1,28 @@
|
||||
"""Capability probes must drain help output while still rejecting missing options."""
|
||||
from pathlib import Path
|
||||
import shlex
|
||||
import subprocess
|
||||
import unittest
|
||||
|
||||
|
||||
class InstallerTests(unittest.TestCase):
|
||||
def probe(self, flags):
|
||||
installer = Path(__file__).resolve().parents[1] / 'tools/install_reconcile_gh.sh'
|
||||
checks = '\n'.join(line for line in installer.read_text().splitlines()
|
||||
if line.startswith(('gh api --help', 'gh pr merge --help')))
|
||||
self.assertEqual(2, len(checks.splitlines()))
|
||||
producer = ("import signal,sys; signal.signal(signal.SIGPIPE,signal.SIG_DFL); "
|
||||
f"print({flags!r},flush=True); sys.stdout.write('x'*1048576)")
|
||||
script = 'set -euo pipefail\ngh() { python3 -c ' + shlex.quote(producer) + '; }\n' + checks
|
||||
return subprocess.run(['bash', '-c', script], capture_output=True, timeout=10).returncode
|
||||
|
||||
def test_large_help_output_does_not_kill_producer(self):
|
||||
self.assertEqual(0, self.probe('--slurp --match-head-commit'))
|
||||
|
||||
def test_missing_required_option_fails(self):
|
||||
self.assertNotEqual(0, self.probe('--slurp'))
|
||||
self.assertNotEqual(0, self.probe('--match-head-commit'))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
unittest.main()
|
||||
@@ -30,6 +30,7 @@ class RunnerTests(unittest.TestCase):
|
||||
output = Path(args[args.index('--output') + 1])
|
||||
output.write_text('[{"state":"unresolved"}]')
|
||||
self.assertEqual(1200, kwargs['timeout'])
|
||||
self.assertIn('--circle-settings', args)
|
||||
self.assertEqual('test-only-secret', kwargs['env']['GH_TOKEN'])
|
||||
raise subprocess.TimeoutExpired(args, 1200)
|
||||
self.assertEqual(124, run_enrollment.run(self.environment(), execute, directory))
|
||||
|
||||
@@ -0,0 +1,78 @@
|
||||
"""Manage native cost controls only for profiles with reviewed cancellation semantics."""
|
||||
import json
|
||||
import os
|
||||
import re
|
||||
from urllib.error import URLError
|
||||
from urllib.request import Request, urlopen
|
||||
|
||||
|
||||
AUTOCANCEL_PROFILES = {'repository-policy', 'homebrew-tap', 'application-template', 'marketing'}
|
||||
|
||||
|
||||
def request(repository, payload=None):
|
||||
"""Use existing central credentials; never expose authentication or error bodies."""
|
||||
if not re.fullmatch(r'QRun-IO/[A-Za-z0-9_.-]+', repository):
|
||||
raise ValueError('Only QRun-IO projects can be managed')
|
||||
token = os.environ.get('CIRCLE_TOKEN')
|
||||
if not token:
|
||||
raise ValueError('Central CircleCI credential unavailable')
|
||||
headers = {'Circle-Token': token, 'Accept': 'application/json'}
|
||||
if payload is not None:
|
||||
headers['Content-Type'] = 'application/json'
|
||||
operation = Request('https://circleci.com/api/v1.1/project/github/' + repository + '/settings',
|
||||
headers=headers, method='GET' if payload is None else 'PUT',
|
||||
data=None if payload is None else json.dumps(payload).encode())
|
||||
try:
|
||||
with urlopen(operation, timeout=30) as response:
|
||||
return json.load(response)
|
||||
except (URLError, ValueError):
|
||||
raise ValueError('CircleCI project settings unavailable') from None
|
||||
|
||||
|
||||
def reconcile(plan, source_request, apply=False, settings_request=request):
|
||||
"""Require a current canonical source and preserve every unrelated project flag."""
|
||||
if plan['profile'] not in AUTOCANCEL_PROFILES:
|
||||
return {'state': 'not-managed', 'reason': 'Profile cancellation policy not reviewed'}
|
||||
if plan['changed']:
|
||||
return {'state': 'waiting-source', 'reason': 'Canonical enrollment must land first'}
|
||||
repo = plan['repository']
|
||||
try:
|
||||
info = source_request(f'repos/{repo}')
|
||||
if info['archived'] or (plan['profile'] == 'marketing' and info['default_branch'] != 'main'):
|
||||
raise ValueError('Repository default branch or archive state differs from policy')
|
||||
before = settings_request(repo)['feature_flags']
|
||||
if not isinstance(before, dict) or type(before.get('autocancel-builds')) is not bool:
|
||||
raise ValueError('CircleCI cancellation flag is missing or invalid')
|
||||
changed = not before['autocancel-builds']
|
||||
if apply and changed:
|
||||
if source_request(f'repos/{repo}/branches/{plan["branch"]}')['commit']['sha'] != plan['head']:
|
||||
raise ValueError('Source changed after enrollment inspection')
|
||||
settings_request(repo, {'feature_flags': {'autocancel-builds': True}})
|
||||
after = settings_request(repo)['feature_flags']
|
||||
if after != {**before, 'autocancel-builds': True}:
|
||||
raise ValueError('CircleCI settings readback differs from the narrow update')
|
||||
return {'state': 'enforced' if apply else 'inspected', 'changed': changed}
|
||||
except (ValueError, KeyError, TypeError) as error:
|
||||
return {'state': 'unresolved', 'reason': str(error)}
|
||||
|
||||
|
||||
def reconcile_repository(plans, findings, source_request, apply=False, settings_request=request):
|
||||
"""A project-wide flag requires agreement across all discovered current branches."""
|
||||
repo = plans[0]['repository']
|
||||
if any(plan['repository'] != repo for plan in plans):
|
||||
raise ValueError('Expected one repository')
|
||||
if any(row['repository'] == repo and row.get('state') == 'unresolved' for row in findings):
|
||||
return {'state': 'waiting-source', 'reason': 'A current branch is unresolved'}
|
||||
if any(plan['profile'] not in AUTOCANCEL_PROFILES for plan in plans):
|
||||
return {'state': 'not-managed', 'reason': 'A current branch has an unreviewed cancellation policy'}
|
||||
if any(plan['changed'] for plan in plans):
|
||||
return {'state': 'waiting-source', 'reason': 'All current branches must have canonical enrollment'}
|
||||
try:
|
||||
for plan in plans:
|
||||
if source_request(f'repos/{repo}/branches/{plan["branch"]}')['commit']['sha'] != plan['head']:
|
||||
raise ValueError('Source changed after enrollment inspection')
|
||||
except (ValueError, KeyError, TypeError) as error:
|
||||
return {'state': 'unresolved', 'reason': str(error)}
|
||||
# Preserve the marketing default-branch guard even in mixed eligible profiles.
|
||||
plan = next((p for p in plans if p['profile'] == 'marketing'), plans[0])
|
||||
return reconcile(plan, source_request, apply, settings_request)
|
||||
@@ -14,5 +14,6 @@ printf '%s %s\n' "$checksum" "$archive" | sha256sum --check --status
|
||||
tar -xOzf "$archive" "gh_${version}_linux_amd64/bin/gh" > "$binary"
|
||||
sudo install -m 0755 "$binary" /usr/local/bin/gh
|
||||
gh --version
|
||||
gh api --help | grep -q -- --slurp
|
||||
gh pr merge --help | grep -q -- --match-head-commit
|
||||
# Drain help output: grep -q can SIGPIPE gh under pipefail.
|
||||
gh api --help | grep -- --slurp >/dev/null
|
||||
gh pr merge --help | grep -- --match-head-commit >/dev/null
|
||||
@@ -187,6 +187,7 @@ def main():
|
||||
parser.add_argument('--apply', action='store_true')
|
||||
parser.add_argument('--merge-ready', action='store_true')
|
||||
parser.add_argument('--enforce', action='store_true')
|
||||
parser.add_argument('--circle-settings', action='store_true')
|
||||
parser.add_argument('--output', type=Path, required=True)
|
||||
args = parser.parse_args()
|
||||
if (args.merge_ready or args.enforce) and not args.apply:
|
||||
@@ -219,6 +220,17 @@ def main():
|
||||
if args.enforce:
|
||||
row['enforcement'] = finish_enrollment.enforce_current(plan)
|
||||
args.output.write_text(json.dumps(report, indent=2), encoding='utf-8')
|
||||
if args.circle_settings:
|
||||
import circle_project_settings
|
||||
settings = []
|
||||
for repo in sorted({plan['repository'] for plan in plans}):
|
||||
branches = [plan for plan in plans if plan['repository'] == repo]
|
||||
settings.append({'repository': repo,
|
||||
'profiles': sorted({plan['profile'] for plan in branches}),
|
||||
**circle_project_settings.reconcile_repository(
|
||||
branches, findings, api, apply=args.apply)})
|
||||
args.output.with_suffix('.circle-settings.json').write_text(
|
||||
json.dumps(settings, indent=2), encoding='utf-8')
|
||||
print(json.dumps({'targets': len(plans), 'changed': sum(p['changed'] for p in plans),
|
||||
'unresolved': sum(row['state'] == 'unresolved' for row in findings),
|
||||
'applied': args.apply}))
|
||||
|
||||
@@ -22,7 +22,8 @@ def run(environment=None, execute=subprocess.run, root=None):
|
||||
output.mkdir(parents=True, exist_ok=True)
|
||||
args = [sys.executable, str(root / 'tools/reconcile_enrollment.py'),
|
||||
'--organization', 'QRun-IO', '--orb-version', '0.8',
|
||||
'--output', str(output / 'result.json'), '--apply', '--merge-ready', '--enforce']
|
||||
'--output', str(output / 'result.json'), '--apply', '--merge-ready', '--enforce',
|
||||
'--circle-settings']
|
||||
try:
|
||||
result = execute(args, cwd=root, env=env, timeout=1200, check=False)
|
||||
code = result.returncode
|
||||
|
||||
Reference in new issue
Block a user