opdev 0.7.0a2__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- opdev/__init__.py +1 -0
- opdev/__main__.py +3 -0
- opdev/checks.py +300 -0
- opdev/cli.py +459 -0
- opdev/commands.py +76 -0
- opdev/config.py +278 -0
- opdev/document_catalog.py +107 -0
- opdev/document_review.py +115 -0
- opdev/documents.py +415 -0
- opdev/errors.py +5 -0
- opdev/files.py +82 -0
- opdev/init.py +87 -0
- opdev/junit.py +99 -0
- opdev/output.py +141 -0
- opdev/process.py +145 -0
- opdev/providers/__init__.py +1 -0
- opdev/providers/gitlab.py +374 -0
- opdev/publication.py +209 -0
- opdev/reports.py +512 -0
- opdev/requirements.py +642 -0
- opdev/resources/reports/report.css +158 -0
- opdev/resources/reports/report.html +27 -0
- opdev/resources/reports/report.js +110 -0
- opdev/resources/skills/opdev/SKILL.md +190 -0
- opdev/resources/skills/opdev/references/adoption.md +144 -0
- opdev/resources/skills/opdev/references/design.md +141 -0
- opdev/resources/skills/opdev/references/development.md +294 -0
- opdev/resources/skills/opdev/references/engineering.md +206 -0
- opdev/resources/skills/opdev/references/planning.md +101 -0
- opdev/resources/skills/opdev/references/publication.md +34 -0
- opdev/resources/templates/AGENTS.md +7 -0
- opdev/resources/templates/CLAUDE.md +6 -0
- opdev/resources/templates/guidance.md +36 -0
- opdev/snapshot.py +484 -0
- opdev/tracking.py +224 -0
- opdev/verification.py +234 -0
- opdev/version.py +45 -0
- opdev-0.7.0a2.dist-info/METADATA +99 -0
- opdev-0.7.0a2.dist-info/RECORD +42 -0
- opdev-0.7.0a2.dist-info/WHEEL +4 -0
- opdev-0.7.0a2.dist-info/entry_points.txt +3 -0
- opdev-0.7.0a2.dist-info/licenses/LICENSE +201 -0
opdev/tracking.py
ADDED
|
@@ -0,0 +1,224 @@
|
|
|
1
|
+
"""Provider-neutral work operations; no local mirror or workflow engine."""
|
|
2
|
+
|
|
3
|
+
import re
|
|
4
|
+
from dataclasses import asdict, dataclass
|
|
5
|
+
from typing import Protocol
|
|
6
|
+
|
|
7
|
+
from opdev.errors import OpDevError
|
|
8
|
+
|
|
9
|
+
KINDS = ("phase", "milestone", "issue")
|
|
10
|
+
LIMITATION = (
|
|
11
|
+
"Tracker records only. No checks ran; no decisions were approved and no release was authorized."
|
|
12
|
+
)
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
@dataclass(frozen=True)
|
|
16
|
+
class WorkItem:
|
|
17
|
+
kind: str
|
|
18
|
+
id: str
|
|
19
|
+
native_id: int
|
|
20
|
+
title: str
|
|
21
|
+
description: str
|
|
22
|
+
state: str
|
|
23
|
+
url: str
|
|
24
|
+
revision: str
|
|
25
|
+
milestone: str | None = None
|
|
26
|
+
phase: str | None = None
|
|
27
|
+
requirements: tuple[str, ...] = ()
|
|
28
|
+
key: str | None = None
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
class Tracker(Protocol):
|
|
32
|
+
def get(self, kind: str, item_id: str) -> WorkItem: ...
|
|
33
|
+
def list(self, kind: str) -> list[WorkItem]: ...
|
|
34
|
+
def create(self, kind: str, fields: dict[str, object]) -> WorkItem: ...
|
|
35
|
+
def update(self, item: WorkItem, fields: dict[str, object]) -> WorkItem: ...
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
def result(operation: str, status: str, records: list[dict[str, object]]) -> dict[str, object]:
|
|
39
|
+
return {
|
|
40
|
+
"operation": operation,
|
|
41
|
+
"status": status,
|
|
42
|
+
"scope": "tracking",
|
|
43
|
+
"records": records,
|
|
44
|
+
"detail": LIMITATION,
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
def inspect_work(
|
|
49
|
+
tracker: Tracker,
|
|
50
|
+
kind: str,
|
|
51
|
+
item_id: str | None = None,
|
|
52
|
+
*,
|
|
53
|
+
state: str = "all",
|
|
54
|
+
milestone: str | None = None,
|
|
55
|
+
phase: str | None = None,
|
|
56
|
+
limit: int = 50,
|
|
57
|
+
offset: int = 0,
|
|
58
|
+
) -> dict[str, object]:
|
|
59
|
+
if kind not in KINDS:
|
|
60
|
+
raise OpDevError("Unsupported work kind.")
|
|
61
|
+
if state not in {"all", "open", "closed"} or not 1 <= limit <= 1000 or offset < 0:
|
|
62
|
+
raise OpDevError("Use state all/open/closed, limit 1-1000, and a nonnegative offset.")
|
|
63
|
+
validate_parents(
|
|
64
|
+
tracker,
|
|
65
|
+
kind,
|
|
66
|
+
{k: v for k, v in {"milestone": milestone, "phase": phase}.items() if v is not None},
|
|
67
|
+
)
|
|
68
|
+
items = [tracker.get(kind, item_id)] if item_id is not None else tracker.list(kind)
|
|
69
|
+
items = [
|
|
70
|
+
item
|
|
71
|
+
for item in items
|
|
72
|
+
if (state == "all" or item.state == state)
|
|
73
|
+
and (milestone is None or item.milestone == milestone)
|
|
74
|
+
and (phase is None or item.phase == phase)
|
|
75
|
+
]
|
|
76
|
+
return {
|
|
77
|
+
**result(
|
|
78
|
+
f"{kind} inspect", "read", [asdict(item) for item in items[offset : offset + limit]]
|
|
79
|
+
),
|
|
80
|
+
"total": len(items),
|
|
81
|
+
"next_offset": offset + limit if offset + limit < len(items) else None,
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
def validate_parents(tracker: Tracker, kind: str, fields: dict[str, object]) -> None:
|
|
86
|
+
for field, child_kind in (("milestone", "issue"), ("phase", "milestone")):
|
|
87
|
+
if field in fields:
|
|
88
|
+
value = fields[field]
|
|
89
|
+
if kind != child_kind or not isinstance(value, str):
|
|
90
|
+
raise OpDevError(f"Only {child_kind} records can have a {field} parent.")
|
|
91
|
+
tracker.get(field, value)
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
def validate_fields(tracker: Tracker, kind: str, fields: dict[str, object]) -> None:
|
|
95
|
+
if (
|
|
96
|
+
kind not in KINDS
|
|
97
|
+
or not fields
|
|
98
|
+
or not set(fields)
|
|
99
|
+
<= {"title", "description", "state", "milestone", "phase", "requirements", "key"}
|
|
100
|
+
):
|
|
101
|
+
raise OpDevError("Select supported tracker fields.")
|
|
102
|
+
for name in ("title", "description"):
|
|
103
|
+
value = fields.get(name)
|
|
104
|
+
if name in fields and (not isinstance(value, str) or not value.strip()):
|
|
105
|
+
raise OpDevError(f"Tracker {name} must be nonempty text.")
|
|
106
|
+
if "state" in fields and fields["state"] not in {"open", "closed"}:
|
|
107
|
+
raise OpDevError("Tracker state must be open or closed.")
|
|
108
|
+
if "requirements" in fields and kind != "issue":
|
|
109
|
+
raise OpDevError("Requirement references belong to implementation issues.")
|
|
110
|
+
if "requirements" in fields:
|
|
111
|
+
refs = fields["requirements"]
|
|
112
|
+
if not isinstance(refs, tuple) or any(not isinstance(r, str) or not r for r in refs):
|
|
113
|
+
raise OpDevError("Use a tuple of requirement IDs.")
|
|
114
|
+
if len(refs) != len(set(refs)):
|
|
115
|
+
raise OpDevError("Duplicate requirement references.")
|
|
116
|
+
validate_parents(tracker, kind, fields)
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
def matching_key(tracker: Tracker, kind: str, key: str) -> list[WorkItem]:
|
|
120
|
+
if not re.fullmatch(r"[A-Za-z0-9][A-Za-z0-9_.-]{0,127}", key):
|
|
121
|
+
raise OpDevError(
|
|
122
|
+
"Use a stable create key of 1-128 letters/digits/dots/underscores/hyphens."
|
|
123
|
+
)
|
|
124
|
+
items = [item for item in tracker.list(kind) if item.key == key]
|
|
125
|
+
if len(items) > 1:
|
|
126
|
+
raise OpDevError(
|
|
127
|
+
"Multiple records have this create key; inspect them, do not retry creation."
|
|
128
|
+
)
|
|
129
|
+
return items
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
def reconcile(tracker: Tracker, kind: str, key: str) -> dict[str, object]:
|
|
133
|
+
items = matching_key(tracker, kind, key)
|
|
134
|
+
return {
|
|
135
|
+
**result(
|
|
136
|
+
f"{kind} reconcile", "found" if items else "not_found", [asdict(i) for i in items]
|
|
137
|
+
),
|
|
138
|
+
"detail": "Read-only lookup. Absence does not prove a timed-out write cannot still "
|
|
139
|
+
"complete; no retry performed.",
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
def fields_match(item: WorkItem, fields: dict[str, object]) -> bool:
|
|
144
|
+
"""Description CRLF/LF is equivalent; all other content and fields stay exact."""
|
|
145
|
+
for name, expected in fields.items():
|
|
146
|
+
observed = getattr(item, name)
|
|
147
|
+
if name == "description" and isinstance(expected, str):
|
|
148
|
+
observed = observed.replace("\r\n", "\n")
|
|
149
|
+
expected = expected.replace("\r\n", "\n")
|
|
150
|
+
if observed != expected:
|
|
151
|
+
return False
|
|
152
|
+
return True
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
def create_work(
|
|
156
|
+
tracker: Tracker, kind: str, fields: dict[str, object], *, plan: bool = False
|
|
157
|
+
) -> dict[str, object]:
|
|
158
|
+
validate_fields(tracker, kind, fields)
|
|
159
|
+
if "state" in fields:
|
|
160
|
+
raise OpDevError("Create work open; close it explicitly after inspecting the result.")
|
|
161
|
+
if not {"title", "description", "key"} <= set(fields) or not isinstance(fields["key"], str):
|
|
162
|
+
raise OpDevError("Creation needs title, description and a stable create key.")
|
|
163
|
+
matches = matching_key(tracker, kind, fields["key"])
|
|
164
|
+
if matches:
|
|
165
|
+
item = matches[0]
|
|
166
|
+
if not fields_match(item, fields):
|
|
167
|
+
raise OpDevError(
|
|
168
|
+
"Create key already has different content; inspect it instead of duplicating work."
|
|
169
|
+
)
|
|
170
|
+
status = "reconciled"
|
|
171
|
+
elif plan:
|
|
172
|
+
return result(f"{kind} create", "planned", [fields])
|
|
173
|
+
else:
|
|
174
|
+
item = tracker.create(kind, fields)
|
|
175
|
+
if not fields_match(item, fields):
|
|
176
|
+
raise OpDevError("Create readback differs; reconcile the key before retrying.")
|
|
177
|
+
status = "saved"
|
|
178
|
+
return result(f"{kind} create", status, [asdict(item)])
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
def update_work(
|
|
182
|
+
tracker: Tracker,
|
|
183
|
+
kind: str,
|
|
184
|
+
item_id: str,
|
|
185
|
+
expected: str,
|
|
186
|
+
fields: dict[str, object],
|
|
187
|
+
*,
|
|
188
|
+
plan: bool = False,
|
|
189
|
+
) -> dict[str, object]:
|
|
190
|
+
validate_fields(tracker, kind, fields)
|
|
191
|
+
if "key" in fields:
|
|
192
|
+
raise OpDevError("Create keys are immutable.")
|
|
193
|
+
item = tracker.get(kind, item_id)
|
|
194
|
+
if item.revision != expected:
|
|
195
|
+
raise OpDevError(
|
|
196
|
+
"Tracker revision differs from --if-match; inspect the current item before updating."
|
|
197
|
+
)
|
|
198
|
+
if plan:
|
|
199
|
+
current = {name: getattr(item, name) for name in ("kind", "id", "title", "url", "revision")}
|
|
200
|
+
return result(f"{kind} update", "planned", [{**current, "changes": fields}])
|
|
201
|
+
updated = tracker.update(item, fields)
|
|
202
|
+
if not fields_match(updated, fields):
|
|
203
|
+
raise OpDevError("Update readback differs; inspect the item before retrying.")
|
|
204
|
+
return result(f"{kind} update", "saved", [asdict(updated)])
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
def roadmap(tracker: Tracker) -> dict[str, object]:
|
|
208
|
+
phases, milestones, issues = (tracker.list(kind) for kind in KINDS)
|
|
209
|
+
phase_ids, milestone_ids = {p.id for p in phases}, {m.id for m in milestones}
|
|
210
|
+
if any(m.phase is not None and m.phase not in phase_ids for m in milestones) or any(
|
|
211
|
+
i.milestone is not None and i.milestone not in milestone_ids for i in issues
|
|
212
|
+
):
|
|
213
|
+
raise OpDevError(
|
|
214
|
+
"Roadmap contains a missing parent; inspect the current tracker before continuing."
|
|
215
|
+
)
|
|
216
|
+
return {
|
|
217
|
+
"operation": "roadmap show",
|
|
218
|
+
"status": "read",
|
|
219
|
+
"scope": "tracking",
|
|
220
|
+
"phases": [asdict(p) for p in phases],
|
|
221
|
+
"milestones": [asdict(m) for m in milestones],
|
|
222
|
+
"issues": [asdict(i) for i in issues],
|
|
223
|
+
"detail": LIMITATION + " Not an atomic remote snapshot.",
|
|
224
|
+
}
|
opdev/verification.py
ADDED
|
@@ -0,0 +1,234 @@
|
|
|
1
|
+
"""Match reported identities to mappings, independently of the report format reader."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
from dataclasses import dataclass, field
|
|
6
|
+
|
|
7
|
+
from opdev.junit import Case
|
|
8
|
+
from opdev.requirements import Database, Test
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
@dataclass(frozen=True)
|
|
12
|
+
class MappedTest:
|
|
13
|
+
id: str
|
|
14
|
+
status: str
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
@dataclass
|
|
18
|
+
class TestResults:
|
|
19
|
+
format: str = "junit"
|
|
20
|
+
status: str = "not_run"
|
|
21
|
+
sha256: str | None = None
|
|
22
|
+
cases: list[Case] = field(default_factory=list)
|
|
23
|
+
mappings: list[MappedTest] = field(default_factory=list)
|
|
24
|
+
detail: str = "Reported cases only; assertion adequacy and hidden retries are unverified."
|
|
25
|
+
|
|
26
|
+
def match(self, command: str, database: Database) -> None:
|
|
27
|
+
by_identity = {(case.classname, case.name): case.status for case in self.cases}
|
|
28
|
+
self.mappings = [
|
|
29
|
+
MappedTest(
|
|
30
|
+
key, by_identity.get((test.result["classname"], test.result["name"]), "missing")
|
|
31
|
+
)
|
|
32
|
+
for key, test in sorted(database.tests.items())
|
|
33
|
+
if test.check == command and test.result is not None
|
|
34
|
+
]
|
|
35
|
+
self.status = (
|
|
36
|
+
"passed"
|
|
37
|
+
if (
|
|
38
|
+
any(case.status == "passed" for case in self.cases)
|
|
39
|
+
and all(case.status in {"passed", "skipped"} for case in self.cases)
|
|
40
|
+
and all(test.status == "passed" for test in self.mappings)
|
|
41
|
+
)
|
|
42
|
+
else "failed"
|
|
43
|
+
)
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
@dataclass(frozen=True)
|
|
47
|
+
class RequirementResult:
|
|
48
|
+
id: str
|
|
49
|
+
status: str
|
|
50
|
+
tests: list[MappedTest]
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
def mapped_outcomes(
|
|
54
|
+
database: Database,
|
|
55
|
+
commands: dict[str, tuple[str, TestResults | None]],
|
|
56
|
+
) -> dict[str, str]:
|
|
57
|
+
outcomes: dict[str, str] = {}
|
|
58
|
+
mapped = {
|
|
59
|
+
command: {m.id: m.status for m in results.mappings} if results else {}
|
|
60
|
+
for command, (_, results) in commands.items()
|
|
61
|
+
}
|
|
62
|
+
for key, test in database.tests.items():
|
|
63
|
+
if test.check not in commands:
|
|
64
|
+
outcomes[key] = "not_run"
|
|
65
|
+
continue
|
|
66
|
+
command_status, results = commands[test.check]
|
|
67
|
+
if command_status == "not_run":
|
|
68
|
+
outcomes[key] = "not_run"
|
|
69
|
+
elif results is None or test.result is None:
|
|
70
|
+
outcomes[key] = "unverified"
|
|
71
|
+
elif results.status == "not_run":
|
|
72
|
+
outcomes[key] = "not_run"
|
|
73
|
+
elif results.status == "error":
|
|
74
|
+
outcomes[key] = "unverified"
|
|
75
|
+
else:
|
|
76
|
+
observed = mapped[test.check].get(key, "missing")
|
|
77
|
+
outcomes[key] = (
|
|
78
|
+
"command_failed"
|
|
79
|
+
if observed == "passed" and command_status != "passed"
|
|
80
|
+
else observed
|
|
81
|
+
)
|
|
82
|
+
return outcomes
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
def requirement_results(
|
|
86
|
+
database: Database,
|
|
87
|
+
commands: dict[str, tuple[str, TestResults | None]],
|
|
88
|
+
*,
|
|
89
|
+
include_all: bool = False,
|
|
90
|
+
) -> list[RequirementResult]:
|
|
91
|
+
outcomes = mapped_outcomes(database, commands)
|
|
92
|
+
return [
|
|
93
|
+
RequirementResult(
|
|
94
|
+
key,
|
|
95
|
+
"mapped_tests_passed"
|
|
96
|
+
if req.tests and all(outcomes[t] == "passed" for t in req.tests)
|
|
97
|
+
else "incomplete",
|
|
98
|
+
[MappedTest(t, outcomes[t]) for t in req.tests],
|
|
99
|
+
)
|
|
100
|
+
for key, req in sorted(database.requirements.items())
|
|
101
|
+
if include_all
|
|
102
|
+
or (req.state != "retired" and any(database.tests[t].check in commands for t in req.tests))
|
|
103
|
+
]
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
@dataclass(frozen=True)
|
|
107
|
+
class Finding:
|
|
108
|
+
requirement: str | None
|
|
109
|
+
test: str | None
|
|
110
|
+
command: str | None
|
|
111
|
+
code: str
|
|
112
|
+
detail: str
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
@dataclass(frozen=True)
|
|
116
|
+
class Assessment:
|
|
117
|
+
status: str
|
|
118
|
+
active: int
|
|
119
|
+
passed: int
|
|
120
|
+
incomplete: int
|
|
121
|
+
findings: list[Finding]
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
def assess(
|
|
125
|
+
database: Database,
|
|
126
|
+
commands: dict[str, tuple[str, TestResults | None]],
|
|
127
|
+
*,
|
|
128
|
+
catalog_present: bool = True,
|
|
129
|
+
inputs_unchanged: bool = True,
|
|
130
|
+
) -> Assessment:
|
|
131
|
+
"""One full-catalog verdict, independent of presentation and execution scope.
|
|
132
|
+
|
|
133
|
+
This establishes observed direct-test coverage, never assertion adequacy.
|
|
134
|
+
Proposed/retired records do not qualify active parents or children.
|
|
135
|
+
"""
|
|
136
|
+
active = {key: req for key, req in database.requirements.items() if req.state == "active"}
|
|
137
|
+
findings: list[Finding] = []
|
|
138
|
+
if not inputs_unchanged:
|
|
139
|
+
findings.append(
|
|
140
|
+
Finding(
|
|
141
|
+
None,
|
|
142
|
+
None,
|
|
143
|
+
None,
|
|
144
|
+
"inputs_changed",
|
|
145
|
+
"Configuration or mappings changed; rerun after reviewing them.",
|
|
146
|
+
)
|
|
147
|
+
)
|
|
148
|
+
elif not active:
|
|
149
|
+
findings.append(
|
|
150
|
+
Finding(
|
|
151
|
+
None,
|
|
152
|
+
None,
|
|
153
|
+
None,
|
|
154
|
+
"no_active_requirements" if catalog_present else "catalog_absent",
|
|
155
|
+
"No active requirements assessed. Define and map the actual obligations.",
|
|
156
|
+
)
|
|
157
|
+
)
|
|
158
|
+
outcomes = mapped_outcomes(database, commands)
|
|
159
|
+
passed = 0
|
|
160
|
+
for key, req in sorted(active.items()):
|
|
161
|
+
if not inputs_unchanged:
|
|
162
|
+
continue
|
|
163
|
+
if not req.tests:
|
|
164
|
+
findings.append(
|
|
165
|
+
Finding(
|
|
166
|
+
key,
|
|
167
|
+
None,
|
|
168
|
+
None,
|
|
169
|
+
"no_direct_test_mapping",
|
|
170
|
+
"Add a test that asserts this obligation and link it directly.",
|
|
171
|
+
)
|
|
172
|
+
)
|
|
173
|
+
continue
|
|
174
|
+
complete = True
|
|
175
|
+
for test_id in req.tests:
|
|
176
|
+
test = database.tests[test_id]
|
|
177
|
+
status = outcomes[test_id]
|
|
178
|
+
if status == "passed":
|
|
179
|
+
continue
|
|
180
|
+
complete = False
|
|
181
|
+
code, detail = _test_finding(test, status, commands)
|
|
182
|
+
findings.append(Finding(key, test_id, test.check, code, detail))
|
|
183
|
+
passed += complete
|
|
184
|
+
status = "passed" if active and passed == len(active) and not findings else "incomplete"
|
|
185
|
+
if not active:
|
|
186
|
+
status = "unassessed"
|
|
187
|
+
return Assessment(status, len(active), passed, len(active) - passed, findings)
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
def _test_finding(
|
|
191
|
+
test: Test, status: str, commands: dict[str, tuple[str, TestResults | None]]
|
|
192
|
+
) -> tuple[str, str]:
|
|
193
|
+
"""Explain an unverified mapping without changing the full-catalog verdict."""
|
|
194
|
+
if test.result is None:
|
|
195
|
+
code, detail = (
|
|
196
|
+
"missing_result_selector",
|
|
197
|
+
"No named-test result is selected. Check the command's result-reporting capability "
|
|
198
|
+
"first. If it does not emit JUnit, enable supported reporting before selecting an "
|
|
199
|
+
"identity; rerunning it unchanged cannot help. Otherwise review the assertions "
|
|
200
|
+
"and select an actual emitted identity.",
|
|
201
|
+
)
|
|
202
|
+
if commands.get(test.check) == ("passed", None):
|
|
203
|
+
detail = (
|
|
204
|
+
"This check passed without JUnit results. Configure supported JUnit reporting "
|
|
205
|
+
"before selecting an actual reported case for this test; no case identity is "
|
|
206
|
+
"available from this run. Repeating the unchanged command cannot add those results."
|
|
207
|
+
)
|
|
208
|
+
elif test.check not in commands:
|
|
209
|
+
code, detail = (
|
|
210
|
+
"command_not_selected",
|
|
211
|
+
"This command was not selected; its tests did not run.",
|
|
212
|
+
)
|
|
213
|
+
elif status == "not_run":
|
|
214
|
+
code, detail = (
|
|
215
|
+
"command_not_run",
|
|
216
|
+
"Resolve the earlier blocker and run this command.",
|
|
217
|
+
)
|
|
218
|
+
elif status == "unverified":
|
|
219
|
+
code, detail = (
|
|
220
|
+
"results_unverified",
|
|
221
|
+
"No usable current test results; inspect the command and result configuration.",
|
|
222
|
+
)
|
|
223
|
+
else:
|
|
224
|
+
code = status if status == "command_failed" else f"{status}_case"
|
|
225
|
+
detail = {
|
|
226
|
+
"missing": "Expected case absent; inspect its selector and test selection.",
|
|
227
|
+
"skipped": "Mapped test skipped; run it in a suitable environment.",
|
|
228
|
+
"ambiguous": "Repeated case identity; make reporter identities unique.",
|
|
229
|
+
"failed": "Mapped test failed; inspect its assertion and fix the behavior.",
|
|
230
|
+
"error": "Case error; resolve collection, setup or execution failure.",
|
|
231
|
+
"command_failed": "Case passed but command did not; fix the command failure.",
|
|
232
|
+
}[status]
|
|
233
|
+
|
|
234
|
+
return code, detail
|
opdev/version.py
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
"""Read-only package identity; a guidance digest is not verification evidence."""
|
|
2
|
+
|
|
3
|
+
import hashlib
|
|
4
|
+
from importlib.metadata import version
|
|
5
|
+
from importlib.resources import files
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
def workflow_files() -> dict[str, bytes]:
|
|
9
|
+
root = files("opdev").joinpath("resources/skills/opdev")
|
|
10
|
+
names = [
|
|
11
|
+
"SKILL.md",
|
|
12
|
+
*[
|
|
13
|
+
f"references/{name}.md"
|
|
14
|
+
for name in (
|
|
15
|
+
"adoption",
|
|
16
|
+
"design",
|
|
17
|
+
"planning",
|
|
18
|
+
"development",
|
|
19
|
+
"engineering",
|
|
20
|
+
"publication",
|
|
21
|
+
)
|
|
22
|
+
],
|
|
23
|
+
]
|
|
24
|
+
return {name: root.joinpath(name).read_bytes().replace(b"\r\n", b"\n") for name in names}
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
def identity() -> dict[str, str]:
|
|
28
|
+
digest = hashlib.sha256()
|
|
29
|
+
for name, content in sorted(workflow_files().items()):
|
|
30
|
+
digest.update(name.encode() + b"\0" + content + b"\0")
|
|
31
|
+
return {
|
|
32
|
+
"implementation": "python",
|
|
33
|
+
"version": version("opdev"),
|
|
34
|
+
"workflow_sha256": digest.hexdigest(),
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
def describe() -> dict[str, object]:
|
|
39
|
+
return {
|
|
40
|
+
"operation": "version",
|
|
41
|
+
"status": "read",
|
|
42
|
+
"scope": "installation",
|
|
43
|
+
**identity(),
|
|
44
|
+
"detail": "Package identity only. No project was inspected and no checks ran.",
|
|
45
|
+
}
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: opdev
|
|
3
|
+
Version: 0.7.0a2
|
|
4
|
+
Summary: Configuration-driven software development workflow CLI
|
|
5
|
+
License-Expression: Apache-2.0
|
|
6
|
+
License-File: LICENSE
|
|
7
|
+
Classifier: Development Status :: 3 - Alpha
|
|
8
|
+
Classifier: Programming Language :: Python :: 3
|
|
9
|
+
Requires-Dist: pyyaml>=6.0.2,<7
|
|
10
|
+
Requires-Dist: defusedxml>=0.7.1,<1
|
|
11
|
+
Requires-Dist: markdown-it-py>=4,<5
|
|
12
|
+
Requires-Dist: psutil>=7,<8
|
|
13
|
+
Requires-Python: >=3.12
|
|
14
|
+
Project-URL: Documentation, https://gitlab.com/stolenfootball-tools/opdev/-/blob/main/README.md
|
|
15
|
+
Project-URL: Issues, https://gitlab.com/stolenfootball-tools/opdev/-/issues
|
|
16
|
+
Project-URL: Source, https://gitlab.com/stolenfootball-tools/opdev
|
|
17
|
+
Description-Content-Type: text/markdown
|
|
18
|
+
|
|
19
|
+
# OpDev
|
|
20
|
+
|
|
21
|
+
OpDev gives developers and coding agents one way to run a project's tools, query
|
|
22
|
+
requirements and their tests, and manage work in GitLab. You choose the tools and
|
|
23
|
+
required checks in a configuration file; OpDev runs them and reports what passed,
|
|
24
|
+
failed or never ran.
|
|
25
|
+
|
|
26
|
+
The optional Codex and Claude Code plugin guides discovery, design approval,
|
|
27
|
+
phased planning and implementation. The CLI handles configured operations. Your
|
|
28
|
+
application can use any language; only OpDev itself needs Python.
|
|
29
|
+
|
|
30
|
+
**Alpha:** this is the active Python implementation, licensed under
|
|
31
|
+
[Apache-2.0](https://gitlab.com/stolenfootball-tools/opdev/-/blob/main/LICENSE). Download the matching CLI and plugin from the
|
|
32
|
+
[GitLab releases](https://gitlab.com/stolenfootball-tools/opdev/-/releases).
|
|
33
|
+
The earlier Rust implementation is [archived](https://gitlab.com/stolenfootball-tools/opdev-legacy).
|
|
34
|
+
Use an isolated environment and explicitly
|
|
35
|
+
select this version; existing Rust installations need a reviewed migration.
|
|
36
|
+
Claude Code package validation and behavioral testing are separate: Claude
|
|
37
|
+
behavioral testing remains **unverified**.
|
|
38
|
+
|
|
39
|
+
## Start here
|
|
40
|
+
|
|
41
|
+
To try OpDev on a small project, follow [Getting started](https://gitlab.com/stolenfootball-tools/opdev/-/blob/main/docs/getting-started.md).
|
|
42
|
+
The walkthrough sets up one real test, previews its command and runs it.
|
|
43
|
+
|
|
44
|
+
If you already have this checkout and [uv](https://docs.astral.sh/uv/getting-started/installation/),
|
|
45
|
+
you can inspect OpDev's own configuration first. Python 3.12+ is required; uv can
|
|
46
|
+
provision a compatible interpreter.
|
|
47
|
+
|
|
48
|
+
```console
|
|
49
|
+
uv sync --locked
|
|
50
|
+
uv run --locked opdev commands
|
|
51
|
+
uv run --locked opdev check --plan
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
These last two commands inspect configuration without running project tools.
|
|
55
|
+
After reviewing the configuration, try a focused check or query a requirement:
|
|
56
|
+
|
|
57
|
+
```console
|
|
58
|
+
uv run --locked opdev lint
|
|
59
|
+
uv run --locked opdev requirement show REQ-03 --tree --tests
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## How it fits your project
|
|
63
|
+
|
|
64
|
+
- **Configure once.** Define command arguments, directories and timeouts in
|
|
65
|
+
`.opdev/project.yaml`. Use your existing formatter, linter, test runner and build tools.
|
|
66
|
+
- **Check the right scope.** Use focused checks while iterating and `opdev check`
|
|
67
|
+
for every required check before integration. Native CI enforces remote checks.
|
|
68
|
+
- **Keep requirements concrete.** Store product obligations and direct test links
|
|
69
|
+
in `.opdev/requirements.json`; query the records you need through the CLI.
|
|
70
|
+
- **Track work remotely.** Keep phases, milestones, issues and progress in GitLab.
|
|
71
|
+
Keep current designs and requirements in Git, without a local backlog or evidence ledger.
|
|
72
|
+
- **Publish deliberately.** After explicit authorization, `opdev publish` runs
|
|
73
|
+
fresh checks against fixed inputs before invoking your configured publisher.
|
|
74
|
+
|
|
75
|
+
OpDev reports command outcomes and, with [JUnit validation](https://gitlab.com/stolenfootball-tools/opdev/-/blob/main/docs/checks.md#validate-individual-tests-with-junit),
|
|
76
|
+
individual reported test results matched to explicit requirement mappings. It cannot
|
|
77
|
+
prove assertion adequacy or developer approval, or sandbox untrusted repository
|
|
78
|
+
commands. Those distinctions remain visible in its reports and workflow.
|
|
79
|
+
|
|
80
|
+
## User documentation
|
|
81
|
+
|
|
82
|
+
| I want to… | Read |
|
|
83
|
+
| --- | --- |
|
|
84
|
+
| Set up a project and run a first test | [Getting started](https://gitlab.com/stolenfootball-tools/opdev/-/blob/main/docs/getting-started.md) |
|
|
85
|
+
| Define tools and required checks | [Configuration](https://gitlab.com/stolenfootball-tools/opdev/-/blob/main/docs/configuration.md) |
|
|
86
|
+
| Maintain development decisions and validate their structure | [Development documents](https://gitlab.com/stolenfootball-tools/opdev/-/blob/main/docs/documentation.md) |
|
|
87
|
+
| Build, test, run, lint or format | [Development commands](https://gitlab.com/stolenfootball-tools/opdev/-/blob/main/docs/commands.md) |
|
|
88
|
+
| Preview checks and understand failures | [Checks](https://gitlab.com/stolenfootball-tools/opdev/-/blob/main/docs/checks.md) |
|
|
89
|
+
| Record requirements and link tests | [Requirements](https://gitlab.com/stolenfootball-tools/opdev/-/blob/main/docs/requirements.md) |
|
|
90
|
+
| Export a run for review or audit | [Verification reports](https://gitlab.com/stolenfootball-tools/opdev/-/blob/main/docs/reports.md) |
|
|
91
|
+
| Manage phases, milestones and issues | [Work tracking](https://gitlab.com/stolenfootball-tools/opdev/-/blob/main/docs/work-tracking.md) |
|
|
92
|
+
| Verify inputs before publication | [Publication](https://gitlab.com/stolenfootball-tools/opdev/-/blob/main/docs/publication.md) |
|
|
93
|
+
| Connect Codex, Claude Code or CI | [Integrations](https://gitlab.com/stolenfootball-tools/opdev/-/blob/main/docs/integrations.md) |
|
|
94
|
+
|
|
95
|
+
These guides are OpDev's manual. OpDev does not create, organize or enforce user
|
|
96
|
+
documentation in your project; its content and location are your choice.
|
|
97
|
+
|
|
98
|
+
To contribute to OpDev, start with [.opdev/guidance.md](https://gitlab.com/stolenfootball-tools/opdev/-/blob/main/.opdev/guidance.md).
|
|
99
|
+
Implementation plans and progress belong in [GitLab issues](https://gitlab.com/stolenfootball-tools/opdev/-/issues).
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
opdev/__init__.py,sha256=THCUWDJm64wpZOqtRGl3UEQXq17az1riJQZRqfJzgE0,58
|
|
2
|
+
opdev/__main__.py,sha256=EGCxyjk_QiMqjYvjQgpNKP-dcN6WofMD3dNpGh5gU34,53
|
|
3
|
+
opdev/checks.py,sha256=psx3TQXUuP8EBRe9CMU6VFZdPi6_nInSZi3hBhHDI9o,10971
|
|
4
|
+
opdev/cli.py,sha256=nYO7S59dkoNkc8Z7ZqlOorJuQQFrVXdAp6kOu0gcGVI,20044
|
|
5
|
+
opdev/commands.py,sha256=uR3_ptjkZxM7g56QMwQtE4b5EGwXVzzhlY8Puv4LBfk,2959
|
|
6
|
+
opdev/config.py,sha256=EXGWDh943sCVjFBs6agx-fxMCloUSOxj1dx_2lHVxhk,11330
|
|
7
|
+
opdev/document_catalog.py,sha256=T9eQiLg8IgEfg5ET5Z59WlH69bD75Rv29HmiS45wuVQ,3053
|
|
8
|
+
opdev/document_review.py,sha256=hXbORyBEV794uyj5oYaktsMHyeafQ7O1LZw_bnPpdZ4,4924
|
|
9
|
+
opdev/documents.py,sha256=l0oXt6bbcRNohKBddc6Pf7nXXhK6gNVe7lDGVyeMhMk,15321
|
|
10
|
+
opdev/errors.py,sha256=zSOC96zwHdoot_TTxmICXQnBf3yN5HU8fusvXoAtjdA,146
|
|
11
|
+
opdev/files.py,sha256=-0h7svUbQaorM_VvrtQkJZrH5IAuFIMQabKzRW_kIVU,3088
|
|
12
|
+
opdev/init.py,sha256=JafipAEIVWfWPyNJZTQxzt6VeaSHNmWv1w8xWs80kq4,3614
|
|
13
|
+
opdev/junit.py,sha256=Ew1Soi-PWfXx1q8di5JvA80oUOPIhIU4F6X-3ns0Bek,3936
|
|
14
|
+
opdev/output.py,sha256=Hx5DKlL1RehunkOzoJk5BDOuNEyndg1QS2xZsf3hU6k,5967
|
|
15
|
+
opdev/process.py,sha256=_MDyJkN1DdHqymr8Y8ngk7ZG5-Ou_zyEL6LffTQORaY,4844
|
|
16
|
+
opdev/providers/__init__.py,sha256=V8bCzMHdokr3Bb3EHEf5JRwIpE3FR3DzH1tVdXt_Ex8,74
|
|
17
|
+
opdev/providers/gitlab.py,sha256=sR0yw-tfaCemozdZud4jbgda8kQFfC9E58RmkvPFxsA,15940
|
|
18
|
+
opdev/publication.py,sha256=0_7reYiNhQ43IJ5gVodUTeYh9ExJbIkb-nU2qWoKrKc,8671
|
|
19
|
+
opdev/reports.py,sha256=Fo-jaKX0QD3-kNkERUh_E7e_WHUWUyR8TqqUuRm1Q2w,20304
|
|
20
|
+
opdev/requirements.py,sha256=LkTOcaTMLzor0obG51cFCg4-5RRuCzvtd_gbzBfhJEU,22936
|
|
21
|
+
opdev/resources/reports/report.css,sha256=s4u5otk95RpSQU7VN5jts6Igd8egySs-JkUKgYUvF_s,11091
|
|
22
|
+
opdev/resources/reports/report.html,sha256=XBUbFv6eQoMmzFfQvEd7m7Cu-yc8u9ZVMYIQWSVcPFo,4869
|
|
23
|
+
opdev/resources/reports/report.js,sha256=5wYDqD-gLol24_4NhNqFxhO-9HePQsAtp5s5FXUE5cg,5149
|
|
24
|
+
opdev/resources/skills/opdev/SKILL.md,sha256=Vqp1w6ZSUB01rab4bk73aOFTK3bTbOdQSqeCS9r4e3Q,12873
|
|
25
|
+
opdev/resources/skills/opdev/references/adoption.md,sha256=0Kd4dx-Le1rBh3AHQGSTqxQrICC2w4AOk5O74zuQmJE,9685
|
|
26
|
+
opdev/resources/skills/opdev/references/design.md,sha256=3tHQVIoTY1qKRVVDvylJCKniqltNfcIkYL6cuswyxOE,10126
|
|
27
|
+
opdev/resources/skills/opdev/references/development.md,sha256=1P1Py-I1AvACxdrKTcKsgKER7em0LZSsdfi6IJJD7rM,19537
|
|
28
|
+
opdev/resources/skills/opdev/references/engineering.md,sha256=p2S5-INapXD1DMz3lhrB9QolMw2GSWo8DfLX_uYgYgo,14022
|
|
29
|
+
opdev/resources/skills/opdev/references/planning.md,sha256=z_yw7dDOg_VyisUsw-AlpKLMkcVqRreWpT65Mwm0w24,6910
|
|
30
|
+
opdev/resources/skills/opdev/references/publication.md,sha256=AoIY3vvrC7bMi7BgaaRh7rMNGWL-SJG9JRgRifYjyaM,2259
|
|
31
|
+
opdev/resources/templates/AGENTS.md,sha256=YxAgXcGadR8DiGfU42cocnrNlqs92Tsv4IwRXkyS4nk,418
|
|
32
|
+
opdev/resources/templates/CLAUDE.md,sha256=dYwmWTwC7YE_zDvPdyuCDdNuf0QLFFaOCfFpoywBS5E,223
|
|
33
|
+
opdev/resources/templates/guidance.md,sha256=2XzblcucBfi99P2v8w-2Um1M9hO91StS6m-nXODaSAI,1881
|
|
34
|
+
opdev/snapshot.py,sha256=ZyTrPZUPyL483ozMj2Hdw69zZm9veTZM7HjFeEdobv4,20289
|
|
35
|
+
opdev/tracking.py,sha256=y_LjCQI4Pf2Yfb3O_v-JafXp67FLkeslQFZ-g7VMcqU,8383
|
|
36
|
+
opdev/verification.py,sha256=j9eEnmrj9Do7wlf7Elkl0iGLIcMpcaXbDx7um6vqEeY,8153
|
|
37
|
+
opdev/version.py,sha256=II4EaHCgL9Ihbvf1TxQpejrc-DS9N6LZeRV1eBARZqc,1273
|
|
38
|
+
opdev-0.7.0a2.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
|
|
39
|
+
opdev-0.7.0a2.dist-info/WHEEL,sha256=ZyFSCYkV2BrxH6-HRVRg3R9Fo7MALzer9KiPYqNxSbo,79
|
|
40
|
+
opdev-0.7.0a2.dist-info/entry_points.txt,sha256=ZjShc-TdmiGID_2DNprzhWFMxTgYplgR_hPKM-S6zUo,42
|
|
41
|
+
opdev-0.7.0a2.dist-info/METADATA,sha256=laZfJzOw4O-Upob_SdloNYfSrB1vWnHuvdakyVNqFBM,5751
|
|
42
|
+
opdev-0.7.0a2.dist-info/RECORD,,
|