What I learned introducing a domain-specific language for configurable traceability analysis

At this years Modelsward conference I had the opportunity to present a paper about "A Domain-specific Language for Configurable Traceability Analysis" that was written in close collaboration with Prof. Dr. Kuchen and Christoph Rieger from [ERCIS] of the University of Muenster.

The Modelsward conference provides a platform for practioners and academics to present their research and development activities in model-driven engineering. Since the paper contributes a domain-specific language build with Xtext that is integrated into Yakindu Traceability, it perfectly fits the purpose of the conference.


The challenge of traceability in practice

Many companies create traceability information models (TIM) for their software development activities either because they are obligated by regulations or because it is prescribed by process maturity models. However, there is a lack of support for the analysis of these models.

Therefore, inherent information that could benefit project managers in terms of tracking project progress and quality, developers in terms of easing maintanance activities, and quality engineers in terms of analysing test coverage remains unused.

On the one hand, research has been done on querying traceability information models, but the raw data can not be aggregated further. On the other hand, research has been done defining relevant metrics for traceability information models, but the data collection process is not configurable.

The introduced Traceability Analysis Language (TAL) closes this gap by introducing domain-specific language to query, aggregate and check traceability information that is well integrated into Yakindu Traceability.


Traceability Analysis Language

The capabilities of the TAL will be exemplified by defining a simple query for the following traceability information model.

Traceability Information Model with different elements such as user documentation, requirements, technical specifications, java classes and junit tests

 

The TIM is an instance of the so called traceability configuration model both are created using Yakindu Traceability. This configuration model consist of five different traceable artifact types User Documentation, Requirement, Technical Specification, Java Class, and JUnit Test that are connected by different trace link types. We take this TIM as basis for computing the metric number of related requirements (NRR).

The NRR metric can be used to evaluate the complexity of each requirement, since it has been shown that with every relation to another requirement, which can be direct or transitive, the complexity of the originated requirement increases. In addition, we will check that the metrics values is smaller than a given threshold.

Code snippet with TAL expressions result, metric and rule


The TAL expression above consists of three main parts: first, the query part introduced by the keyword resultSecond, the metric part that aggregates the raw data returned by the query introduced by the keyword metricFinally, the keyword rule is the beginning of a check that will be performed on the aggregated data.

The query statement is given a name relatedRequirements before in the next line the function tracesFromTo is called. The function encapsulates the graph traversal making the analysis expression very resilient to changes in the traceability configuration model. In addition, the function is parameterized with artifacts defined in that configuration model, so that queries can be written using well known terms.

The last part of the query expression defines the tabular structure of the resulting raw data that in this case consist of one column containing the name of the start artifact and one column containing the name of the target artifact. The metric statement is also given a name before the result of the cnt (count) function is assigned after the equal sign. The count function takes a column of the query result as input and counts all values with the same content.

Finally, the rule statements defining a rule named highNRR is defined that will produce a warning message if the NRR metrics value is greater than three. In addition, to checking metric results the rule expressions can also directly work with query results.

Traceability Information Model showing a sample path between various requirement, technical specification and Java Class elements


For the given example the figure above shows one sample path starting from RQ1 over TS2 and JC1 and TC1 to RQ2This path shows that RQ1 has a relation to RQ2 that can be created since trace links are bidirectional navigable and we are looking for direct and transitive relations.

In addition, the figure also contains the second path that starts with the same four traceable artifacts and than goes through TS4 to RQ3Thereby, the number of related requirements for RQ1 is 2. The following table shows the result of computing the metric for each requiremetn in the given graph.


Table single requirements with the number of related requirements


Evaluating the rule expression in this case shows that all metric values are in the expected range, so that no warning message needs to be produced.


Conclusion

The introduced approach closes the gap between information retrieval, metrics definition, and result evaluation, thus forming a solid foundation for project- or company-specific metrics. Since the analysis language is based on a highly configurable TIM, it allows for a large variety of traceable artifacts, including formerly unused documents such as documentation, test results or even tickets from collaboration tools.

It is well integrated into Yakindu Traceability using Xtext and the Eclipse Modeling Framework. Features such as live validation and error markers detect broken or outdated expressions early and ensure a rich user experience. 

All in all, the Modelsward conference was an interesting and well organized convention for people working in the area of model-driven and language engineering. Talking to other academics and practioners has once again ensured me that model-driven development has a bright future in a variety of areas ranging from embbeded systems over business software to even non software developing areas like catastrophy management.

The Traceability Analysis Language is another example for a DSL that benefits not only developers, but also requirement engineers, project managers, and quality engineers.


Download our  presentation slides

About The Author

Hendrik is an IT consultant at itemis AG in Bonn. He works on projects utilizing Xtext to build integrated toolchains. He is interested in model driven software development, DSLs and software architecture.