Skip to content

component_sequence.md

Latest commit

 

History

History
141 lines (109 loc) · 4.47 KB

component_sequence.md

File metadata and controls

141 lines (109 loc) · 4.47 KB
Raw

Component Sequence Specification

Purpose

This validator enforces consistency across entities in three diagram types:

  • Component diagrams
  • Sequence diagrams
  • Internal API diagrams

It shall make sure that Architectural Elements are consistently named and related to each other.

What is Validated

All comparisons are case-sensitive. Alias and interface-connection checks always run. Method-name and interface-coverage checks run only when an internal API diagram is provided.

Alias Consistency

Unit aliases from the component diagram must exactly match the set of participant aliases used across all sequence diagrams. (Requirement: {requirement:downstream-ref}Tools.ComponentSequenceAliasConsistency)

' component diagram
component "Unit 1" as unit_1 <<unit>>
component "Unit 2" as unit_2 <<unit>>

' sequence diagram
participant "Unit 1" as unit_1
participant "Unit 2" as unit_2

Interface-Connection Consistency

Every pair of units connected through an interface in the component diagram must have at least one corresponding function-call interaction in the sequence diagrams, and every cross-unit function call in a sequence diagram must correspond to an interface connection in the component diagram. The caller shall be the consumer of the shared interface and the callee shall be the provider. Self-calls are excluded from this check. (Requirement: {requirement:downstream-ref}Tools.ComponentSequenceInterfaceConnectionConsistency)

' component diagram
component "Unit 1" as unit_1 <<unit>>
component "Unit 2" as unit_2 <<unit>>
interface "IData" as IData
unit_1 -( IData
unit_2 )- IData

' sequence diagram
participant "Unit 1" as unit_1
participant "Unit 2" as unit_2
unit_1 -> unit_2 : GetData()

Method-Name Consistency

Every function used in a sequence interaction, including self-calls, must be declared in a shared interface of the participating units as defined in the component diagram. (Requirement: {requirement:downstream-ref}Tools.ComponentSequenceMethodNameConsistency)

' component diagram
component "Unit 1" as unit_1 <<unit>>
component "Unit 2" as unit_2 <<unit>>
interface "IData" as IData
unit_1 -( IData
unit_2 )- IData

' sequence diagram
participant "Unit 1" as unit_1
participant "Unit 2" as unit_2
unit_1 -> unit_2 : GetData()

' internal_api diagram
interface "IData" as IData <<interface>> {
  {abstract} GetData(): Data*
}

Interface Coverage

Every function declared in a validated interface must be called in at least one sequence interaction. Self-calls count as valid usage. (Requirement: {requirement:downstream-ref}Tools.ComponentSequenceInterfaceCoverage)

' internal_api diagram
interface "IData" as IData <<interface>> {
  {abstract} GetData(): Data*
  {abstract} SetData(d: Data*): void
}

' sequence diagram
participant "Unit 1" as unit_1
participant "Unit 2" as unit_2
unit_1 -> unit_2 : GetData()
unit_1 -> unit_2 : SetData(d)

Failure Cases

Failure case Validation rule
Missing sequence participant Alias Consistency
Unexpected sequence participant Alias Consistency
Missing sequence interaction for interface-connected units Interface-Connection Consistency
Missing interface connection for sequence-connected units Interface-Connection Consistency
Invalid consumer/provider roles Interface-Connection Consistency
Missing internal API interface Method-Name Consistency
Method not declared in related interface Method-Name Consistency
Interface function not exercised Interface Coverage

Debug Output

The validator emits debug output containing:

  • expected unit aliases
  • observed participants
  • observed sequence calls (caller -> callee : method)
  • unit interface targets derived from the component diagram
  • interface-connected unit pairs derived from the component diagram
  • internal API interfaces found and checked for method validation, when internal API input is present