Closing the Gap between Unit Test Code and Documentation

    Research output: Chapter in Book/Report/Conference proceedingConference contribution

    Abstract

    Test Driven Development as well as the documentation of tests and their architecture are today an important pillar of software quality assurance. The change of requirements during the implementation phase entails a need to change tests as well as the test documentation of the software. Since unit tests are specified in the implementation language, an interdisciplinary readable documentation must be maintained, which is structurally easier to comprehend and also make the test transparent for persons who are not involved into code writing. This leads to additional effort, costs and possibly inconsistencies between the test and its documentation. This gap in the workflow could be closed by Tanni - a domain specific language, which allows the specification of test cases in the form of interdisciplinary readable tables without requiring programming skills. Based on them executable test code for the respective unit test framework is generated. This merges specification and documentation of unit test cases to one step of work. By this the mentioned additional effort, costs and imminent inconsistencies can be reduced. The Language Workbench Meta Programming System from JetBrains serves as a technological base and is enabler for further positive effects which possibly could be gained by using the described language.

    Original languageEnglish
    Title of host publicationProceedings - 10th IEEE International Conference on Software Testing, Verification and Validation Workshops, ICSTW 2017
    PublisherInstitute of Electrical and Electronics Engineers Inc.
    Pages304-308
    Number of pages5
    ISBN (Electronic)9781509066766
    DOIs
    Publication statusPublished - 2017 Apr 13
    Event10th IEEE International Conference on Software Testing, Verification and Validation Workshops, ICSTW 2017 - Tokyo, Japan
    Duration: 2017 Mar 132017 Mar 17

    Other

    Other10th IEEE International Conference on Software Testing, Verification and Validation Workshops, ICSTW 2017
    CountryJapan
    CityTokyo
    Period17/3/1317/3/17

    Fingerprint

    Specifications
    Computer systems programming
    Quality assurance
    Costs

    Keywords

    • Documentation
    • Domain-specific Language
    • Java
    • Meta Programming System
    • Test Case Specification
    • Test Code Generation
    • Unit Test

    ASJC Scopus subject areas

    • Software
    • Safety, Risk, Reliability and Quality

    Cite this

    Stocker, K., Washizaki, H., & Fukazawa, Y. (2017). Closing the Gap between Unit Test Code and Documentation. In Proceedings - 10th IEEE International Conference on Software Testing, Verification and Validation Workshops, ICSTW 2017 (pp. 304-308). [7899073] Institute of Electrical and Electronics Engineers Inc.. https://doi.org/10.1109/ICSTW.2017.56

    Closing the Gap between Unit Test Code and Documentation. / Stocker, Karsten; Washizaki, Hironori; Fukazawa, Yoshiaki.

    Proceedings - 10th IEEE International Conference on Software Testing, Verification and Validation Workshops, ICSTW 2017. Institute of Electrical and Electronics Engineers Inc., 2017. p. 304-308 7899073.

    Research output: Chapter in Book/Report/Conference proceedingConference contribution

    Stocker, K, Washizaki, H & Fukazawa, Y 2017, Closing the Gap between Unit Test Code and Documentation. in Proceedings - 10th IEEE International Conference on Software Testing, Verification and Validation Workshops, ICSTW 2017., 7899073, Institute of Electrical and Electronics Engineers Inc., pp. 304-308, 10th IEEE International Conference on Software Testing, Verification and Validation Workshops, ICSTW 2017, Tokyo, Japan, 17/3/13. https://doi.org/10.1109/ICSTW.2017.56
    Stocker K, Washizaki H, Fukazawa Y. Closing the Gap between Unit Test Code and Documentation. In Proceedings - 10th IEEE International Conference on Software Testing, Verification and Validation Workshops, ICSTW 2017. Institute of Electrical and Electronics Engineers Inc. 2017. p. 304-308. 7899073 https://doi.org/10.1109/ICSTW.2017.56
    Stocker, Karsten ; Washizaki, Hironori ; Fukazawa, Yoshiaki. / Closing the Gap between Unit Test Code and Documentation. Proceedings - 10th IEEE International Conference on Software Testing, Verification and Validation Workshops, ICSTW 2017. Institute of Electrical and Electronics Engineers Inc., 2017. pp. 304-308
    @inproceedings{5988951308a546bb84d136ddfaf2f2b5,
    title = "Closing the Gap between Unit Test Code and Documentation",
    abstract = "Test Driven Development as well as the documentation of tests and their architecture are today an important pillar of software quality assurance. The change of requirements during the implementation phase entails a need to change tests as well as the test documentation of the software. Since unit tests are specified in the implementation language, an interdisciplinary readable documentation must be maintained, which is structurally easier to comprehend and also make the test transparent for persons who are not involved into code writing. This leads to additional effort, costs and possibly inconsistencies between the test and its documentation. This gap in the workflow could be closed by Tanni - a domain specific language, which allows the specification of test cases in the form of interdisciplinary readable tables without requiring programming skills. Based on them executable test code for the respective unit test framework is generated. This merges specification and documentation of unit test cases to one step of work. By this the mentioned additional effort, costs and imminent inconsistencies can be reduced. The Language Workbench Meta Programming System from JetBrains serves as a technological base and is enabler for further positive effects which possibly could be gained by using the described language.",
    keywords = "Documentation, Domain-specific Language, Java, Meta Programming System, Test Case Specification, Test Code Generation, Unit Test",
    author = "Karsten Stocker and Hironori Washizaki and Yoshiaki Fukazawa",
    year = "2017",
    month = "4",
    day = "13",
    doi = "10.1109/ICSTW.2017.56",
    language = "English",
    pages = "304--308",
    booktitle = "Proceedings - 10th IEEE International Conference on Software Testing, Verification and Validation Workshops, ICSTW 2017",
    publisher = "Institute of Electrical and Electronics Engineers Inc.",
    address = "United States",

    }

    TY - GEN

    T1 - Closing the Gap between Unit Test Code and Documentation

    AU - Stocker, Karsten

    AU - Washizaki, Hironori

    AU - Fukazawa, Yoshiaki

    PY - 2017/4/13

    Y1 - 2017/4/13

    N2 - Test Driven Development as well as the documentation of tests and their architecture are today an important pillar of software quality assurance. The change of requirements during the implementation phase entails a need to change tests as well as the test documentation of the software. Since unit tests are specified in the implementation language, an interdisciplinary readable documentation must be maintained, which is structurally easier to comprehend and also make the test transparent for persons who are not involved into code writing. This leads to additional effort, costs and possibly inconsistencies between the test and its documentation. This gap in the workflow could be closed by Tanni - a domain specific language, which allows the specification of test cases in the form of interdisciplinary readable tables without requiring programming skills. Based on them executable test code for the respective unit test framework is generated. This merges specification and documentation of unit test cases to one step of work. By this the mentioned additional effort, costs and imminent inconsistencies can be reduced. The Language Workbench Meta Programming System from JetBrains serves as a technological base and is enabler for further positive effects which possibly could be gained by using the described language.

    AB - Test Driven Development as well as the documentation of tests and their architecture are today an important pillar of software quality assurance. The change of requirements during the implementation phase entails a need to change tests as well as the test documentation of the software. Since unit tests are specified in the implementation language, an interdisciplinary readable documentation must be maintained, which is structurally easier to comprehend and also make the test transparent for persons who are not involved into code writing. This leads to additional effort, costs and possibly inconsistencies between the test and its documentation. This gap in the workflow could be closed by Tanni - a domain specific language, which allows the specification of test cases in the form of interdisciplinary readable tables without requiring programming skills. Based on them executable test code for the respective unit test framework is generated. This merges specification and documentation of unit test cases to one step of work. By this the mentioned additional effort, costs and imminent inconsistencies can be reduced. The Language Workbench Meta Programming System from JetBrains serves as a technological base and is enabler for further positive effects which possibly could be gained by using the described language.

    KW - Documentation

    KW - Domain-specific Language

    KW - Java

    KW - Meta Programming System

    KW - Test Case Specification

    KW - Test Code Generation

    KW - Unit Test

    UR - http://www.scopus.com/inward/record.url?scp=85018400924&partnerID=8YFLogxK

    UR - http://www.scopus.com/inward/citedby.url?scp=85018400924&partnerID=8YFLogxK

    U2 - 10.1109/ICSTW.2017.56

    DO - 10.1109/ICSTW.2017.56

    M3 - Conference contribution

    SP - 304

    EP - 308

    BT - Proceedings - 10th IEEE International Conference on Software Testing, Verification and Validation Workshops, ICSTW 2017

    PB - Institute of Electrical and Electronics Engineers Inc.

    ER -