Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Custom properties in test model items #25

Closed
jonherrmann opened this issue Aug 21, 2018 · 2 comments
Closed

Custom properties in test model items #25

jonherrmann opened this issue Aug 21, 2018 · 2 comments
Labels
EIP-approved EIP approved by the Steering Group Impl. EIP has been implemented and is ready for the next release. Doc might be incomplete (temp. label)
Milestone

Comments

@jonherrmann
Copy link
Contributor

ETF Improvement Proposal (EIP)

Background and Motivation:

The specification of meta-information are very limited in an ETS. Currently
it is not possible to enrich test model items with additional machine-readable
information in a structured way. These information could be used by:

  • custom reports that show additional meta-information of the test model item
  • other (external) clients that access and parse the ETS

Example: store an alternative name for an test item. The description field
could be used to store additional information but the format would be
unspecified and could not easily processed by a machine.

Proposed change

Support adding a sequence of custom properties to a test model item.

The properties can have a name and value. Both are character strings.
Exampe:

<Properties>
    <property name="Alternative Name">ExecutableTestsuites.X</property>
    <property name="Another custom property name">another custom proeprty value</property>
</Properties>

The properties would be added to all test items, the Executable Testsuites,
TestModules, TestCases, TestSteps and TestAssertions. The Properties Element
would be optional.

<ExecutableTestSuite >
    ...
    <label>Conformance Class: ETS X</label>
    <description>Description of the test suite</description>
    ...
    <Properties>
        <property name="Alternative Name">ExecutableTestsuites.X</property>
        <property name="Another custom property name">another custom proeprty value</property>
    </Properties>        
    ...
</ExecutableTestSuite>

Alternatives

This information could also be stored separately from the test model items in
another structure. The implementation effort would be higher and the processing
of this information would be more time consuming because the information would
have to be retrieve from different sources.

Funding

Full funding available.

Additional information

  • This EIP is backwards compatible with existing ETSs
  • The change would affect the ETF core module and the ETF data storage
@jonherrmann jonherrmann added the EIP Improvement Proposal. Put up for discussion. label Aug 21, 2018
@cportele cportele added EIP-approved EIP approved by the Steering Group and removed EIP Improvement Proposal. Put up for discussion. labels Nov 22, 2018
jonherrmann added a commit to interactive-instruments/etf-core that referenced this issue Jan 30, 2019
Ref etf-validator/governance#25

Signed-off-by: Jon Herrmann <herrmann@interactive-instruments.de>
jonherrmann added a commit to interactive-instruments/etf-bsxds that referenced this issue Jan 30, 2019
Ref etf-validator/governance#25

Signed-off-by: Jon Herrmann <herrmann@interactive-instruments.de>
@jonherrmann
Copy link
Contributor Author

Scheduled for ETF-Webapp release 2.1.0.

Component versions:

  • etf-core 1.2.0
  • etf-bsxds-2.1.0

@jonherrmann jonherrmann added this to the ETF release 2.1.0 milestone Feb 1, 2019
@jonherrmann jonherrmann added the Impl. EIP has been implemented and is ready for the next release. Doc might be incomplete (temp. label) label May 23, 2022
@jonherrmann
Copy link
Contributor Author

Implemented in Version 2.1.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
EIP-approved EIP approved by the Steering Group Impl. EIP has been implemented and is ready for the next release. Doc might be incomplete (temp. label)
Projects
None yet
Development

No branches or pull requests

2 participants