ogma-language-fret-cs: Improve error message reporting upon requirement parsing errors

[ivanperez-keera]

Description

Ogma relies on an existing library for error message reporting of JSON files.

That library, by default, provides very plain error messages and the line and column number of the error cannot be customized or contextualized. This causes error messages to seem to apply to a line and column in the file, when they really apply to the line and column of a specific requirement (which may be hard to indentify).

Type

• Feature: improve error reporting messages in parsing of FRET CS JSON files.

Additional context

None.

Requester

• Ivan Perez

Method to check presence of bug

Not applicable (new feature).

Expected result

An error in a requirement in a FRET CS file indicates which requirement it applies to.

Desired result

An error in a requirement in a FRET CS file indicates which requirement it applies to.

Proposed solution

Modify parser to produce name of requirement on parsing errors.

Further notes

None.

[ivanperez-keera]

Change Manager: Confirmed that the issue exists.

[ivanperez-keera]

Technical Lead: Confirmed that the issue should be addressed.

[ivanperez-keera]

Technical Lead: Issue scheduled for Ogma 1.0.10.

Fix assigned to: @ivanperez-keera.

[ivanperez-keera]

Implementor: Solution implemented, review requested.

[ivanperez-keera]

Change Manager: Verified that:

• Solution is implemented:

  • The code proposed compiles passes the tests. Details:
    Docker image:

    FROM ubuntu:trusty
    
    RUN apt-get update
    
    RUN apt-get install --yes software-properties-common
    RUN add-apt-repository ppa:hvr/ghc
    RUN apt-get update
    
    RUN apt-get install --yes ghc-8.6.5 cabal-install-2.4
    RUN apt-get install --yes libz-dev
    
    ENV PATH=/opt/ghc/8.6.5/bin:/opt/cabal/2.4/bin:$PWD/.cabal-sandbox/bin:$PATH
    
    RUN cabal update
    RUN cabal v1-sandbox init
    RUN cabal v1-install alex happy
    RUN apt-get install --yes git
    
    # We install the application first and then test it, in case any tests need to
    # run the tool.
    CMD git clone $REPO && \
        cd $NAME && \
        git checkout $COMMIT && \
        cd .. && \
        cabal v1-install $NAME/$PAT**/ --enable-tests && \
        cabal v1-install $NAME/$PAT**/ --enable-tests --run-tests -j1

    Command:

    $ docker run -e "REPO=https://github.com/NASA/ogma" -e "NAME=ogma" -e PAT="ogma-" -e "COMMIT=b1e29d0b43f179331ac1998b3f2822c5bb4e43e0" -it ogma-test

  • The solution proposed fixes the issues described. Details:
    The issue is with error messages, so it is hard to automate; it is therefore verified by visual inspection.

• Implementation is documented. Details:
  No changes needed.
• Change history is clear.
• Commit messages are clear.
• Changelogs are updated.
• Examples are updated. Details:
  The implementation is no longer "lazy", which makes examples that contain no expressions for some temporal logic fields in the CS file fail. Those examples are adjusted to contain vacuous properties (true).
• Required version bumps are evaluated. Details:
  Bump not needed (change affects result, but there's no expectation that an incorrect FRET file --one with no value for one of the formula fields-- should parse correctly).

[ivanperez-keera]

Change Manager: Implementation ready to be merged.