ant-protocol 2.4.0

Wire protocol for the Autonomi decentralized network (WithAutonomi fork)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156

#!/usr/bin/env python3
"""Test matrix for check_pr.py — runs the real checker as a subprocess against a
set of PR fields and asserts the pass/fail outcome. No third-party deps; run with
`python3 .github/scripts/test_check_pr.py` (also executed by the pr-checks
workflow's self-test job).

This file is duplicated verbatim across the six crate repos; keep it identical.
"""
import os
import subprocess
import sys

HERE = os.path.dirname(os.path.abspath(__file__))
CHECKER = os.path.join(HERE, "check_pr.py")

VALID_BODY = """\
## Linear issue
- Closes https://linear.app/autonominetwork/issue/V2-719/add-the-standard-pr-template

## Risk tier
- [x] T0 — docs / tooling / CI.

## Compatibility
- Wire: none
- Storage: none
- API: none

## Semver impact
- [x] fix

## Test evidence
Ran the checker test matrix; all cases pass.

## New dependency
none

## ADR
n/a

## Mitigation / rollback
Revert the PR.
"""


def body_without(section_swap):
    """Return VALID_BODY with a section's content replaced (old -> new)."""
    old, new = section_swap
    assert old in VALID_BODY, old
    return VALID_BODY.replace(old, new)


# Unfilled template: the only Linear-looking token is the example in a comment.
UNFILLED = """\
## Linear issue
<!-- REQUIRED. Use the closing form, one line per issue: Closes V2-123 -->
## Risk tier
- [ ] T0
## Semver impact
- [ ] fix
"""

# Linear's closing magic words, from https://linear.app/docs/github. Restated here
# rather than imported from check_pr.py so the matrix is an independent assertion
# about what the checker must accept, not a tautology.
CLOSING_MAGIC_WORDS = (
    "close", "closes", "closed", "closing",
    "fix", "fixes", "fixed", "fixing",
    "resolve", "resolves", "resolved", "resolving",
    "complete", "completes", "completed", "completing",
    "implement", "implements", "implemented", "implementing",
)

# (name, mode, env, expected_exit)
CASES = [
    # --- linear-link: rejections ---
    ("linear: UTF-8 only", "linear", {"PR_TITLE": "fix UTF-8", "PR_BRANCH": "fix/utf8"}, 1),
    ("linear: SHA-256 / RFC-123", "linear", {"PR_TITLE": "SHA-256 RFC-123", "PR_BRANCH": "x"}, 1),
    ("linear: linear.app/changelog", "linear", {"PR_BODY": "see https://linear.app/changelog", "PR_BRANCH": "x"}, 1),
    ("linear: linear.app/not-an-issue", "linear", {"PR_BODY": "https://linear.app/not-an-issue", "PR_BRANCH": "x"}, 1),
    ("linear: unfilled template (example in comment)", "linear", {"PR_BODY": UNFILLED, "PR_BRANCH": "x"}, 1),
    # A bare reference in the body does not link the PR in Linear (V2-1161).
    ("linear: bare key in body only", "linear", {"PR_BODY": "V2-1161", "PR_BRANCH": "x"}, 1),
    ("linear: bare issue URL in body only", "linear", {"PR_BODY": "https://linear.app/autonominetwork/issue/V2-719/foo", "PR_BRANCH": "x"}, 1),
    ("linear: magic word without a key", "linear", {"PR_BODY": "Closes the gap", "PR_BRANCH": "x"}, 1),
    ("linear: magic word on its own line from the key", "linear", {"PR_BODY": "Closes\n\nV2-1161", "PR_BRANCH": "x"}, 1),
    # Linear's linking-only families attach the PR but do not drive the Merged
    # transition, so they are not accepted as the closing form.
    ("linear: 'part of' is linking-only", "linear", {"PR_BODY": "part of V2-1161", "PR_BRANCH": "x"}, 1),
    ("linear: 'ref' is linking-only", "linear", {"PR_BODY": "ref V2-1161", "PR_BRANCH": "x"}, 1),
    ("linear: 'towards' is linking-only", "linear", {"PR_BODY": "towards V2-1161", "PR_BRANCH": "x"}, 1),
    ("linear: 'relates to' is linking-only", "linear", {"PR_BODY": "relates to V2-1161", "PR_BRANCH": "x"}, 1),
    ("linear: magic word as a word prefix", "linear", {"PR_BODY": "prefix V2-1161", "PR_BRANCH": "x"}, 1),
    ("linear: magic word as a word suffix", "linear", {"PR_BODY": "fixture V2-1161", "PR_BRANCH": "x"}, 1),
    # --- linear-link: acceptances (Linear's full closing set, any tense) ---
    ("linear: Closes + key in body", "linear", {"PR_BODY": "Closes V2-1161", "PR_BRANCH": "x"}, 0),
    ("linear: lower-cased magic word", "linear", {"PR_BODY": "closes v2-1161", "PR_BRANCH": "x"}, 0),
    ("linear: Closes + issue URL in body", "linear", {"PR_BODY": "Closes https://linear.app/autonominetwork/issue/V2-719/foo", "PR_BRANCH": "x"}, 0),
    ("linear: closing form inside prose", "linear", {"PR_BODY": "This one closes V2-1161 at last.", "PR_BRANCH": "x"}, 0),
    ("linear: 'linear issue' phrase", "linear", {"PR_BODY": "Linear issue V2-1161", "PR_BRANCH": "x"}, 0),
    ("linear: key in branch (lowercased)", "linear", {"PR_BRANCH": "chrisoneil/v2-720-ci-check"}, 0),
    ("linear: key in title", "linear", {"PR_TITLE": "AUTO-42 do the thing", "PR_BRANCH": "x"}, 0),
] + [
    # One case per closing magic word Linear documents, capitalised as an author
    # would write it — e.g. "Fixed V2-1161" links and closes in Linear, so it must
    # pass here too.
    (f"linear: '{word}'", "linear",
     {"PR_BODY": f"{word.capitalize()} V2-1161", "PR_BRANCH": "x"}, 0)
    for word in CLOSING_MAGIC_WORDS
] + [
    # --- pr-template: acceptances ---
    ("template: valid T0 body", "template", {"PR_BASE": "main", "PR_BODY": VALID_BODY}, 0),
    ("template: rc-* base is a no-op pass", "template", {"PR_BASE": "rc-2025.10", "PR_BODY": "anything"}, 0),
    ("template: T2 with ADR link", "template", {"PR_BASE": "main", "PR_BODY": body_without(
        ("- [x] T0 — docs / tooling / CI.", "- [x] T2 — behavioural.")).replace(
        "n/a", "https://github.com/x/adr/0001.md")}, 0),
    # --- pr-template: rejections ---
    ("template: not the template", "template", {"PR_BASE": "main", "PR_BODY": "freeform text"}, 1),
    ("template: only Wire axis filled", "template", {"PR_BASE": "main", "PR_BODY": body_without(
        ("- Storage: none\n- API: none", "- Storage:\n- API:"))}, 1),
    ("template: empty ADR (T0)", "template", {"PR_BASE": "main", "PR_BODY": body_without(("n/a", ""))}, 1),
    ("template: T2 with ADR n/a (no link)", "template", {"PR_BASE": "main", "PR_BODY": body_without(
        ("- [x] T0 — docs / tooling / CI.", "- [x] T2 — behavioural."))}, 1),
    ("template: no tier checked", "template", {"PR_BASE": "main", "PR_BODY": body_without(
        ("- [x] T0 — docs / tooling / CI.", "- [ ] T0 — docs / tooling / CI."))}, 1),
    ("template: bare key under '## Linear issue'", "template", {"PR_BASE": "main", "PR_BODY": body_without(
        ("- Closes https://linear.app/autonominetwork/issue/V2-719/add-the-standard-pr-template",
         "- V2-719"))}, 1),
    ("template: two tiers checked", "template", {"PR_BASE": "main", "PR_BODY": body_without(
        ("- [x] T0 — docs / tooling / CI.", "- [x] T0 a\n- [x] T2 b"))}, 1),
]


def run(mode, env):
    full = dict(os.environ)
    for k in ("PR_TITLE", "PR_BODY", "PR_BRANCH", "PR_BASE"):
        full.pop(k, None)
    full.update(env)
    return subprocess.run(
        [sys.executable, CHECKER, mode], env=full, capture_output=True, text=True
    ).returncode


def main():
    failures = 0
    for name, mode, env, expected in CASES:
        got = run(mode, env)
        status = "ok" if got == expected else "FAIL"
        if got != expected:
            failures += 1
        print(f"[{status}] {name} (mode={mode}, expected={expected}, got={got})")
    print(f"\n{len(CASES) - failures}/{len(CASES)} cases passed")
    sys.exit(1 if failures else 0)


if __name__ == "__main__":
    main()