Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
34d0e31ad4
|
No files matched your search
@@ -111,3 +111,23 @@ verification and artifact evidence. The requested version must already be publis
|
||||
```sh
|
||||
python3 -m unittest discover -s tests -p test_rollout_version.py
|
||||
```
|
||||
|
||||
## Live organization discovery
|
||||
|
||||
Use `--organization QRun-IO --live` instead of `--inventory inventory.json` to
|
||||
include newly created repositories on each audit. Discovery uses the existing
|
||||
`gh` authentication and all API pages, retaining archived entries for explicit
|
||||
skip reporting. Unknown repositories receive no automatic exemption. Duplicate,
|
||||
empty, malformed or failed discovery aborts instead of reusing a stale inventory.
|
||||
|
||||
```sh
|
||||
python tools/audit_estate.py --organization QRun-IO --live --orb-version 0.8 \
|
||||
--worker-sha <40SHA> --policy observed-checks.json --output audit.json
|
||||
```
|
||||
|
||||
The organization mode has no fixed repository-count ceiling. Supply
|
||||
`--expected-active N` for an independent count check when needed; saved-inventory
|
||||
mode preserves its default of 68. Reports identify the inventory source and
|
||||
credential visibility limit: inaccessible repositories cannot be certified.
|
||||
This is discovery and audit, not automatic enrollment or branch-rule mutation.
|
||||
Scheduling and authenticated onboarding still need to be configured centrally.
|
||||
@@ -1,4 +1,6 @@
|
||||
import importlib.util
|
||||
import json
|
||||
import io
|
||||
import pathlib
|
||||
import unittest
|
||||
from unittest.mock import patch
|
||||
@@ -25,6 +27,54 @@ class Snapshot:
|
||||
return self.required
|
||||
|
||||
|
||||
class InventoryTests(unittest.TestCase):
|
||||
def repo(self, name, archived=False):
|
||||
return {'name': name, 'full_name': 'QRun-IO/' + name,
|
||||
'archived': archived, 'default_branch': 'main'}
|
||||
|
||||
def test_all_pages_include_new_private_and_archived_repositories(self):
|
||||
new = dict(self.repo('new-product'), private=True)
|
||||
pages = [[self.repo('qbit-existing')], [new, self.repo('retired', True)]]
|
||||
with patch.object(audit, 'command', return_value=json.dumps(pages)) as command:
|
||||
entries = audit.discover_inventory('QRun-IO')
|
||||
self.assertEqual([e['name'] for e in entries], ['new-product', 'qbit-existing', 'retired'])
|
||||
self.assertTrue(entries[-1]['isArchived'])
|
||||
self.assertEqual(command.call_args.args[0], ['gh', 'api', '--method', 'GET',
|
||||
'--paginate', '--slurp', 'orgs/QRun-IO/repos?type=all&per_page=100'])
|
||||
|
||||
def test_empty_duplicate_foreign_and_malformed_inventories_fail_closed(self):
|
||||
repo = self.repo('qbit-example')
|
||||
for pages in ([], [[]], {}, [repo], [[repo], [repo]],
|
||||
[[dict(repo, full_name='Other/qbit-example')]],
|
||||
[[dict(repo, archived='false')]], [[dict(repo, default_branch=None)]]):
|
||||
with self.subTest(pages=pages), patch.object(audit, 'command', return_value=json.dumps(pages)):
|
||||
with self.assertRaises(audit.ReadError):
|
||||
audit.discover_inventory('QRun-IO')
|
||||
with patch.object(audit, 'command') as command:
|
||||
with self.assertRaises(audit.ReadError):
|
||||
audit.discover_inventory('QRun-IO/../../other')
|
||||
command.assert_not_called()
|
||||
|
||||
def test_live_cli_count_is_dynamic_but_explicit_expectation_is_enforced(self):
|
||||
for expected, status in ((None, 0), ('1', 0), ('68', 1)):
|
||||
args = ['audit', '--organization', 'QRun-IO', '--live', '--orb-version', '0.8']
|
||||
if expected:
|
||||
args += ['--expected-active', expected]
|
||||
report = {'active_count': 1, 'unique_repository_count': 1,
|
||||
'inventory_count': 1, 'results': [{'status': 'pass'}]}
|
||||
output = io.StringIO()
|
||||
with patch.object(audit.sys, 'argv', args), patch.object(audit.sys, 'stdout', output), \
|
||||
patch.object(audit, 'discover_inventory', return_value=[ENTRY]), \
|
||||
patch.object(audit, 'run', return_value=report):
|
||||
self.assertEqual(audit.main(), status)
|
||||
self.assertEqual(json.loads(output.getvalue())['inventory_source'], 'organization-api')
|
||||
|
||||
def test_discovery_api_failure_never_falls_back_to_old_inventory(self):
|
||||
with patch.object(audit, 'command', side_effect=audit.ReadError('unavailable')):
|
||||
with self.assertRaises(audit.ReadError):
|
||||
audit.discover_inventory('QRun-IO')
|
||||
|
||||
|
||||
class AuditTests(unittest.TestCase):
|
||||
def test_all_scanner_and_release_requirements_follow_branch_profile(self):
|
||||
entry = dict(ENTRY, name='qqq-all', nameWithOwner='QRun-IO/qqq-all')
|
||||
|
||||
+47
-5
@@ -66,6 +66,38 @@ def gh(path):
|
||||
return json.loads(command(['gh', 'api', '--method', 'GET', path]))
|
||||
|
||||
|
||||
def discover_inventory(organization):
|
||||
"""Discover every repository visible to existing gh authentication, across all pages."""
|
||||
if not re.fullmatch(r'[A-Za-z0-9][A-Za-z0-9-]*', organization):
|
||||
raise ReadError('invalid organization name')
|
||||
pages = json.loads(command(['gh', 'api', '--method', 'GET', '--paginate', '--slurp',
|
||||
f'orgs/{organization}/repos?type=all&per_page=100']))
|
||||
if not isinstance(pages, list) or any(not isinstance(page, list) for page in pages):
|
||||
raise ReadError('invalid organization inventory response')
|
||||
entries, seen = [], set()
|
||||
for page in pages:
|
||||
for repo in page:
|
||||
if not isinstance(repo, dict):
|
||||
raise ReadError('invalid organization repository')
|
||||
name = repo.get('name')
|
||||
full_name = repo.get('full_name')
|
||||
archived = repo.get('archived')
|
||||
branch = repo.get('default_branch')
|
||||
if (not isinstance(name, str) or not re.fullmatch(r'[A-Za-z0-9_.-]+', name)
|
||||
or not isinstance(full_name, str)
|
||||
or full_name.lower() != f'{organization}/{name}'.lower()
|
||||
or type(archived) is not bool
|
||||
or not isinstance(branch, str) or not branch
|
||||
or full_name.lower() in seen):
|
||||
raise ReadError('invalid or duplicate organization repository')
|
||||
seen.add(full_name.lower())
|
||||
entries.append({'name': name, 'nameWithOwner': full_name,
|
||||
'isArchived': archived, 'defaultBranchRef': {'name': branch}})
|
||||
if not entries:
|
||||
raise ReadError('empty organization inventory; coverage is unproven')
|
||||
return sorted(entries, key=lambda entry: entry['nameWithOwner'].lower())
|
||||
|
||||
|
||||
class Snapshot:
|
||||
def __init__(self, entry, live=False):
|
||||
self.repo = entry['nameWithOwner']
|
||||
@@ -374,22 +406,32 @@ def run(entries, version, worker_sha, policies, live=False, snapshot_factory=Sna
|
||||
|
||||
def main():
|
||||
parser = argparse.ArgumentParser(description=__doc__)
|
||||
parser.add_argument('--inventory', type=Path, required=True)
|
||||
inventory = parser.add_mutually_exclusive_group(required=True)
|
||||
inventory.add_argument('--inventory', type=Path)
|
||||
inventory.add_argument('--organization', help='Discover current repositories using existing gh authentication; requires --live')
|
||||
parser.add_argument('--orb-version', required=True)
|
||||
parser.add_argument('--worker-sha')
|
||||
parser.add_argument('--policy', type=Path)
|
||||
parser.add_argument('--live', action='store_true', help='Read current source and branch rules using existing gh authentication')
|
||||
parser.add_argument('--source-branch', help='Inspect this branch instead of the repository default; requires --live')
|
||||
parser.add_argument('--expected-active', type=int, default=68)
|
||||
parser.add_argument('--expected-active', type=int, help='Optional independent coverage check; saved inventories default to 68')
|
||||
parser.add_argument('--output', type=Path)
|
||||
args = parser.parse_args()
|
||||
if args.source_branch is not None and not args.live:
|
||||
parser.error('--source-branch requires --live')
|
||||
entries = json.loads(args.inventory.read_text(encoding='utf-8'))
|
||||
if args.organization and not args.live:
|
||||
parser.error('--organization requires --live')
|
||||
entries = (discover_inventory(args.organization) if args.organization else
|
||||
json.loads(args.inventory.read_text(encoding='utf-8')))
|
||||
expected_active = args.expected_active
|
||||
if expected_active is None and not args.organization:
|
||||
expected_active = 68
|
||||
policies = json.loads(args.policy.read_text(encoding='utf-8')) if args.policy else {}
|
||||
report = run(entries, args.orb_version, args.worker_sha, policies, args.live, source_branch=args.source_branch)
|
||||
report['expected_active_count'] = args.expected_active
|
||||
report['coverage_matches_expected'] = (report['active_count'] == args.expected_active
|
||||
report['inventory_source'] = ('organization-api' if args.organization else 'saved-inventory')
|
||||
report['inventory_visibility'] = 'authenticated repositories; inaccessible repositories cannot be certified'
|
||||
report['expected_active_count'] = expected_active
|
||||
report['coverage_matches_expected'] = ((expected_active is None or report['active_count'] == expected_active)
|
||||
and report['unique_repository_count'] == report['inventory_count'])
|
||||
text = json.dumps(report, indent=2) + '\n'
|
||||
if args.output:
|
||||
|
||||
Reference in new issue
Block a user