forked from longtao.wu/droboticflow
182 lines
7.6 KiB
Python
182 lines
7.6 KiB
Python
import os
|
|
from pathlib import Path
|
|
import stat
|
|
import subprocess
|
|
import tempfile
|
|
import unittest
|
|
|
|
SCRIPT = Path(__file__).resolve().parents[2] / 'scripts/local/branch-freshness.sh'
|
|
|
|
|
|
class BranchFreshness(unittest.TestCase):
|
|
"""The session-start check is read-only, never blocks, and flags stale checkouts."""
|
|
|
|
def setUp(self):
|
|
self.tmp = tempfile.TemporaryDirectory()
|
|
self.root = Path(self.tmp.name)
|
|
self.remote = self.root / 'origin.git'
|
|
subprocess.check_call(['git', 'init', '--bare', '-q', str(self.remote)])
|
|
self.repo = self.root / 'repo'
|
|
self.repo.mkdir()
|
|
self.git('init', '-q', '-b', 'work')
|
|
self.git('config', 'user.name', 'Local test')
|
|
self.git('config', 'user.email', 'test@example.invalid')
|
|
self.git('remote', 'add', 'origin', str(self.remote))
|
|
self.commit('baseline')
|
|
self.git('push', '-q', 'origin', 'HEAD:refs/heads/dev')
|
|
self.git('fetch', '-q', 'origin', 'dev')
|
|
self.calls = self.root / 'kubectl-calls'
|
|
self.kubectl = self.root / 'kubectl'
|
|
self.write_kubectl(exit_code=0)
|
|
(self.root / 'kubeconfig').write_text('fake')
|
|
|
|
def tearDown(self):
|
|
self.tmp.cleanup()
|
|
|
|
def git(self, *args, cwd=None):
|
|
return subprocess.check_output(['git', *args], cwd=cwd or self.repo, text=True, stderr=subprocess.DEVNULL).strip()
|
|
|
|
def commit(self, message):
|
|
(self.repo / 'file').write_text(message)
|
|
self.git('add', '.')
|
|
self.git('commit', '-qm', message)
|
|
return self.git('rev-parse', 'HEAD')
|
|
|
|
def write_kubectl(self, exit_code, commit=''):
|
|
# Prints the build commit for any deployment and counts invocations.
|
|
self.kubectl.write_text(f'#!/bin/bash\necho x >> "{self.calls}"\n'
|
|
f'[ {exit_code} -eq 0 ] || exit {exit_code}\n'
|
|
f'echo -n "${{FAKE_LIVE_COMMIT:-{commit}}}"\n')
|
|
self.kubectl.chmod(self.kubectl.stat().st_mode | stat.S_IEXEC)
|
|
|
|
def run_check(self, live='', cwd=None, cli_args=(), expected_rc=0, **extra):
|
|
env = {**os.environ,
|
|
'FRESHNESS_BASE_REF': 'origin/dev',
|
|
'FRESHNESS_SKIP_FETCH': '0',
|
|
'FRESHNESS_KUBECTL': str(self.kubectl),
|
|
'FRESHNESS_KUBECONFIG': str(self.root / 'kubeconfig'),
|
|
'FRESHNESS_CACHE_FILE': str(self.root / 'cache.txt'),
|
|
'FAKE_LIVE_COMMIT': live,
|
|
**extra}
|
|
result = subprocess.run(
|
|
['bash', str(SCRIPT), *cli_args],
|
|
cwd=cwd or self.repo,
|
|
env=env,
|
|
text=True,
|
|
capture_output=True,
|
|
timeout=10,
|
|
)
|
|
self.assertEqual(result.returncode, expected_rc, result.stderr or result.stdout)
|
|
return result.stdout if expected_rc == 0 else (result.stderr + result.stdout)
|
|
|
|
def kubectl_calls(self):
|
|
return len(self.calls.read_text().splitlines()) if self.calls.exists() else 0
|
|
|
|
def test_current_checkout_reports_up_to_date(self):
|
|
live = self.git('rev-parse', 'HEAD')
|
|
out = self.run_check(live=live)
|
|
self.assertIn('已是最新', out)
|
|
self.assertNotIn('⚠', out)
|
|
|
|
def test_skip_fetch_does_not_claim_up_to_date(self):
|
|
live = self.git('rev-parse', 'HEAD')
|
|
out = self.run_check(live=live, FRESHNESS_SKIP_FETCH='1')
|
|
self.assertIn('未拉取远端引用', out)
|
|
self.assertIn('仅完成本地引用比较', out)
|
|
self.assertNotIn('已是最新', out)
|
|
|
|
def test_cli_flags_disable_fetch_and_cluster(self):
|
|
live = self.git('rev-parse', 'HEAD')
|
|
out = self.run_check(live=live, cli_args=('--no-fetch', '--no-cluster'))
|
|
self.assertEqual(self.kubectl_calls(), 0)
|
|
self.assertIn('未拉取远端引用', out)
|
|
self.assertIn('未查询线上版本', out)
|
|
self.assertIn('仅完成本地引用比较', out)
|
|
self.assertNotIn('已是最新', out)
|
|
|
|
def test_cli_missing_or_empty_base_ref_fails_fast_without_hanging(self):
|
|
for bad_args in (('--base-ref',), ('--base-ref', ''), ('--base-ref', '--no-cluster'), ('--base-ref=',)):
|
|
with self.subTest(bad_args=bad_args):
|
|
out = self.run_check(cli_args=bad_args, expected_rc=2)
|
|
self.assertIn('--base-ref', out)
|
|
self.assertEqual(self.kubectl_calls(), 0)
|
|
|
|
def test_cli_unknown_flag_fails_fast_without_querying_cluster(self):
|
|
out = self.run_check(cli_args=('--no-clustre',), expected_rc=2)
|
|
self.assertIn('未知参数', out)
|
|
self.assertEqual(self.kubectl_calls(), 0)
|
|
|
|
def test_behind_base_branch_is_flagged_with_count(self):
|
|
live = self.git('rev-parse', 'HEAD')
|
|
self.git('checkout', '-q', '-b', 'dev-advance')
|
|
self.commit('dev one')
|
|
self.commit('dev two')
|
|
self.git('push', '-q', 'origin', 'HEAD:refs/heads/dev')
|
|
self.git('checkout', '-q', 'work')
|
|
out = self.run_check(live=live)
|
|
self.assertIn('⚠', out)
|
|
self.assertIn('落后 origin/dev 2 个提交', out)
|
|
|
|
def test_missing_live_commit_is_flagged_per_deployment(self):
|
|
self.git('checkout', '-q', '-b', 'release')
|
|
live = self.commit('live fix')
|
|
self.git('checkout', '-q', 'work')
|
|
out = self.run_check(live=live)
|
|
self.assertIn('⚠', out)
|
|
self.assertIn('不包含线上', out)
|
|
self.assertIn('droboticflow-api', out)
|
|
self.assertIn(live[:8], out)
|
|
|
|
def test_live_commit_not_fetched_locally_is_reported(self):
|
|
out = self.run_check(live='0123456789abcdef0123456789abcdef01234567')
|
|
self.assertIn('本地没有线上提交', out)
|
|
|
|
def test_unreachable_cluster_never_blocks(self):
|
|
self.write_kubectl(exit_code=1)
|
|
out = self.run_check()
|
|
self.assertIn('线上版本未知', out)
|
|
self.assertIn('仅完成本地引用比较', out)
|
|
self.assertNotIn('已是最新', out)
|
|
|
|
def test_failed_fetch_does_not_claim_up_to_date(self):
|
|
live = self.git('rev-parse', 'HEAD')
|
|
self.git('remote', 'set-url', 'origin', str(self.root / 'missing-origin.git'))
|
|
out = self.run_check(live=live)
|
|
self.assertIn('未能联网拉取 origin/dev', out)
|
|
self.assertIn('仅完成本地引用比较', out)
|
|
self.assertNotIn('已是最新', out)
|
|
|
|
def test_missing_local_base_ref_does_not_claim_up_to_date(self):
|
|
out = self.run_check(FRESHNESS_BASE_REF='origin/nonexistent', FRESHNESS_SKIP_CLUSTER='1')
|
|
self.assertIn('未能完成基线与线上版本确认', out)
|
|
self.assertNotIn('已是最新', out)
|
|
|
|
def test_live_commits_are_cached_within_ttl(self):
|
|
live = self.git('rev-parse', 'HEAD')
|
|
self.run_check(live=live)
|
|
first = self.kubectl_calls()
|
|
self.assertEqual(first, 3)
|
|
self.write_kubectl(exit_code=1)
|
|
out = self.run_check(live=live)
|
|
self.assertEqual(self.kubectl_calls(), first, 'cached result must not query the cluster again')
|
|
self.assertIn('已是最新', out)
|
|
self.run_check(live=live, FRESHNESS_CACHE_TTL='0')
|
|
self.assertGreater(self.kubectl_calls(), first, 'expired cache must refresh')
|
|
|
|
def test_cluster_query_can_be_disabled(self):
|
|
out = self.run_check(FRESHNESS_SKIP_CLUSTER='1')
|
|
self.assertEqual(self.kubectl_calls(), 0)
|
|
self.assertIn('未查询线上版本', out)
|
|
self.assertIn('仅完成本地引用比较', out)
|
|
self.assertNotIn('已是最新', out)
|
|
|
|
def test_outside_git_checkout_exits_quietly(self):
|
|
outside = self.root / 'plain'
|
|
outside.mkdir()
|
|
out = self.run_check(cwd=outside)
|
|
self.assertIn('不是 git 仓库', out)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
unittest.main()
|