ogma-cli: Allow customization of target C filenames

[ivanperez-keera]

Description

Ogma does not allow users to specify the name of the target file that should be used in applications produced from FRET files.

Without that extra facility, it becomes necessary to rename and modify the Copilot/Haskell (or C) files produced, which detracts from a smooth UX process.

This also affects us when we demonstrate Ogma, since to have to modify the files produced (either via a text editor or via a sed command) in the middle of the demo. Users outside of our project do not understand why this is happening, and the extra step distracts from the presentation.

This would be easily solved if we had a way to specify the target filename via a command line flag.

Type

• Feature: new flag added to make use of application smoother.

Additional context

None.

Requester

• Ivan Perez

Method to check presence of bug

Not applicable (not a bug).

Expected result

Ogma provides a CLI argument for all commands producing standalone Copilot files that allows customizing the name of the target C files.

Desired result

Ogma provides a CLI argument for all commands producing standalone Copilot files that allows customizing the name of the target C files.

Proposed solution

Modify the FRET backends to include a new argument for the target filename.

Expose that flag all the way to the CLI.

Set the default value to the existing filename for backwards compatibility.

Document existence of flag (and possibly simplify README if applicable).

Adjust Dockerfiles produced by different backends if needed.

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+X).(8+Y).

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
    
    ENV DEBIAN_FRONTEND=noninteractive
    
    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=62a7b97b865cbb8a63c34ea86d485558377324b2" -it ogma-test

  • The solution proposed fixes the issues described. Details:
    The following docker script prints Success if the fret-component-spec command accepts the new flag, and the C code is generated in files with the custom filenames.

    FROM ubuntu:trusty
    
    ENV DEBIAN_FRONTEND=noninteractive
    
    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 cabal v1-install copilot-3.15
    RUN apt-get install --yes git
    
    CMD git clone $REPO && \
        cd $NAME && \
        git checkout $COMMIT && \
        cd .. && \
        cabal v1-install $NAME/$PAT**/ && \
        ogma fret-component-spec --fret-file-name $NAME/ogma-cli/examples/fret-reqs-small.json --target-file-name smvcs > SMVCS.hs && \
        cabal v1-exec -- runhaskell SMVCS.hs && \
        gcc -c smvcs.c && \
        echo "Success"

    Command:

    $ docker run -e "REPO=https://github.com/NASA/ogma" -e "NAME=ogma" -e PAT="ogma-" -e "COMMIT=62a7b97b865cbb8a63c34ea86d485558377324b2" -it ogma-verify-80

• Implementation is documented. Details:
  The README is updated to document the new flag. An example in the README where the target filenames were being adjusted by hand is also updated.
• Change history is clear.
• Commit messages are clear.
• Changelogs are updated.
• Examples are updated. Details:
  No examples affected.
• Required version bumps are evaluated. Details:
  No bump needed (new feature without affecting pre-existing interface; defaults used by new feature chosen to enable backwards compatibility).

[ivanperez-keera]

Change Manager: Implementation ready to be merged.