chore: add spec traceability comments across all 17 formal-requirement specs#344
Closed
aaron-zeisler wants to merge 16 commits into
Closed
chore: add spec traceability comments across all 17 formal-requirement specs#344aaron-zeisler wants to merge 16 commits into
aaron-zeisler wants to merge 16 commits into
Conversation
Author
|
TODO: Redo using the latest branch that includes changes to the requirement numbers |
Map test functions in common_tests_hooks.go to their corresponding HOOK spec requirements (1.2.x, 1.3.x, 1.6.x). Normalizes the existing 1.3.7 comment to the new SPEC_ID X.Y.Z format and documents untested requirements (identify series, config handlers, hook interface). Co-Authored-By: Claude <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Map test functions in server_side_migrations.go to their corresponding MIGRATIONS spec requirements (1.1.x, 1.2.x, 1.3.x, 1.5). Documents coverage of MigrationVariation, Migrator read/write, tracking (invoked, latency, errors, consistency), and sampling. Co-Authored-By: Claude <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Add file-level comments to attribute-references.yml (ATREF 1.2.1-1.2.3) and errors-bad-attribute-reference.yml (ATREF 1.1.1) mapping evaluations to their corresponding spec requirements. Co-Authored-By: Claude <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Map test functions in server_side_big_segments.go to their corresponding BIGSEG spec requirements covering evaluation integration (1.9.x), membership caching (1.6.x, 1.9.5.x), status polling (1.8.x), context key hashing (1.3.x), and error handling (1.5.x). Co-Authored-By: Claude <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Normalize existing requirement references in FDv1 fallback tests to the DATASYSTEM X.Y.Z format and add comments to initialization, reconnection, state management, error handling, and update processing functions. Co-Authored-By: Claude <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Co-Authored-By: Claude <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Co-Authored-By: Claude <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
…files Co-Authored-By: Claude <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Co-Authored-By: Claude <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Co-Authored-By: Claude <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Co-Authored-By: Claude <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
…files Co-Authored-By: Claude <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
…-requirements Co-authored-by: Cursor <cursoragent@cursor.com>
aaron-zeisler
force-pushed
the
aaronz/spec-traceability-comments
branch
from
034f4e2 to
e50b854
Compare
aaron-zeisler
changed the title
Co-authored-by: Cursor <cursoragent@cursor.com>
aaron-zeisler
force-pushed
the
aaronz/spec-traceability-comments
branch
from
e50b854 to
145ab1d
Compare
Author
|
Closed because t.Specification() is preferred: #345 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add spec-requirement traceability comments across all SDK specs that have both formal requirements and corresponding tests in the sdk-test-harness. Each test function or YAML fixture gets a compact
// SPEC_ID X.Y.Z: short summary(Go) or# SPEC_ID X.Y.Z: short summary(YAML) annotation linking it to the spec requirement it exercises.Requirement IDs are aligned with the latest
sdk-specsmain (post sdk-summit merge).Specs covered (17 total)
Original 12 specs:
Added in this update (5 new/newly-formalized specs):
Changes
sdktests/(Go) anddata/data-files/(YAML)Follow-up work
Untested spec requirements are tracked in Jira epic SDK-2384 with 23 stories:
Test plan
go build ./...)via LD Research 🤖
Note
Low Risk
Low risk: changes are comment-only annotations in Go tests and YAML fixtures with no functional logic modifications.
Overview
Adds spec requirement traceability annotations across client/server evaluation YAML fixtures and many
sdktests/*functions, linking each test/fixture to specific requirement IDs (e.g.,FLGEA,FLGEDETAIL,CONTEXT,CTXBLD,HOOK,MIGRATIONS,DATASYSTEM,EVENTS, etc.).Also adds a brief header comment block in
common_tests_events_request.godocumenting how EVENTS schema conformance is covered behaviorally versus via JSON Schema validation.Reviewed by Cursor Bugbot for commit 145ab1d. Bugbot is set up for automated code reviews on this repo. Configure here.