Skip to content

Parsing Feature Needs from MD goes past next field #449

Closed
@James-Baya

Description

@James-Baya

Description

Markdown file contains a feature, with a title then a feature name, then "Needs:" then "Status:" then "Description:".
In the description there is a bulleted list.
When parsing this, OFT takes the last word of each bulleted list entry and adds it to the "Needs:".

Steps to Reproduce

Here is an MD snippet:


Requirement 10100: Bridge Interrupt Outputs
-------------------------------------------------------------------------------------------
`feat~calico.10100.bridge-interrupt-outputs~1`

Needs: arch

Status:
approved

Description:

Calico shall have interrupt outputs.

Uses are all dependent on the underlying features being supported by the Calico version:

* transaction support errors
* security violations
* RAS / parity errors
* PMon threshold crossing

Run OFT and look at the report.html
java -jar /openfasttrace-4.1.0.jar trace -l FINE -o html -f /output/report.html /sources

Image

Expected behavior

Stop adding to "Needs:" after the next field starts (in this case "Status:" is the next field)

Environment

  • OFT 4.1.0
  • OS: Linux running on Docker image eclipse-temurin:23.0.2_7-jre-alpine-3.21
  • Java Version: openjdk 23.0.2 2025-01-21
  • Maven Version (in case of build problems only): n/a, downloaded prebuild jar for OFT

Additional context

Have an easy workaround, just putting the "Needs:" at the end of the Markdown section. But still, this seems like pretty wrong behaviour

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    Projects

    Status

    ✅ Closed

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions