itsallcode / openfasttrace

Open source requirement tracing suite
GNU General Public License v3.0
100 stars 21 forks source link

The traceability report gets corrupted in a specific scenario #396

Closed ayankuma closed 7 months ago

ayankuma commented 7 months ago

Description

When OFT is run using a specific file, the traceability report contains some unexpected characters (See "image" is unexpected in the attached screenshot). Screenshot 2024-02-29 at 10 12 52

Steps to Reproduce

  1. Use the below file. You can save it as test14_nr_spis.rst
    
    Test case for assigning a specific number of SPIs to allocate for dom0less domain                       
    =================================================================================                       

XenValTestCase~arm64_assign_domain_SPIs~1

Covers:

Needs:

Objectives


The script is responsible for:


2. Run the below command
`java -jar /<path_to>/openfasttrace-3.7.1.jar trace -o html -f any.html  /<path_to>/test14_nr_spis.rst`

## Expected behavior
There should be no `image` in `Needs:`

# Environment
- OFT: [3.7.1]
- OS: [Ubuntu 20.04]
- Java Version: [openjdk 11.0.20.1 2023-08-24]
ayankuma commented 7 months ago

Reordering Covers: and Needs: makes this issue go away.

kaklakariada commented 7 months ago

After talking with @redcatbear the behavior of the Markdown importer is intended. The importer expects the description of an item after the ID and before Covers/Needs tags. Sections (either with ### or underlined) should not be used within items.

So the solution of reordering is correct.