Skip to content

[Add] Integration test plan for the REST client against Flexo (#407) - #423

Draft
samatstariongroup wants to merge 11 commits into
developmentfrom
407-feature-verify-rest-api-client-against-compliant-server
Draft

samatstariongroup wants to merge 11 commits into
developmentfrom
407-feature-verify-rest-api-client-against-compliant-server

Conversation

@samatstariongroup

Copy link
Copy Markdown
Member

Refs #407

Adds SySML2.NET.REST.Tests/INTEGRATION_TEST_PLAN.md, the plan for verifying the SysML2.NET REST client against a live, compliant server. It contains no code yet. The plan comes first so it can be reviewed before implementation starts on this branch.

Summary of the plan

  • Under test: the REST client (Session, PsmApiClient, QueryStringBuilder) and the JSON serializer it uses. Flexo (Open-MBEE/flexo-mms-sysmlv2, run locally through Testcontainers) is only the server it talks to; verifying Flexo is a non-goal.
  • One ordered scenario: it starts from an empty server and builds a model step by step through the client, until the model holds an instance of every concrete KerML / SysML v2 metaclass. Along the way it calls all 35 OpenAPI operations: create, read, update and delete for both model elements and API objects (projects, branches, tags, commits, queries, merges, project usages, external data).
  • Coverage target, taken from Hypha (release 2026-07):
    • 167 concrete metaclasses, which match Core/AutoGenDto exactly
    • 97 non-derived attributes
    • 21 enumeration literals
    • 17 PIM types
  • Coverage check: the final step works from what the server returned. It updates itself when the metamodel (DTO classes and [Property] decorators) or the OpenAPI document changes.
  • Expectations follow the specification. A difference caused by Flexo is reported upstream, not counted as a client failure.

Open questions (plan §9)

  1. Delete cascade when only an owner is deleted.
  2. Whether a query by @type must also match subtypes.
  3. Whether Flexo supports ProjectUsage, ExternalData and ExternalRelationship.
  4. Which Flexo image to pin: v0.2.1 or develop-SNAPSHOT.
  5. Whether the integration tests run in CI or only locally.
  6. Whether this fixture may break the TESTING.md §2 rule with one [Test] per scenario step.

🤖 Generated with Claude Code

@samatstariongroup samatstariongroup linked an issue Nov 6, 2026 that may be closed by this pull request
4 of 5 tasks
@zeynepatsoprasteria
zeynepatsoprasteria force-pushed the 407-feature-verify-rest-api-client-against-compliant-server branch from 84cd71f to 614daba Compare November 9, 2026 10:13
@samatstariongroup
samatstariongroup force-pushed the 407-feature-verify-rest-api-client-against-compliant-server branch from 614daba to 84cd71f Compare November 9, 2026 10:21
@samatstariongroup
samatstariongroup force-pushed the 407-feature-verify-rest-api-client-against-compliant-server branch from 02d567a to ab59ac8 Compare November 9, 2026 15:12
@sonarqubecloud

sonarqubecloud Bot commented Nov 9, 2026

Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant