ogma-cli: Provide uniform CLI

[ivanperez-keera]

Description

The CLI of Ogma lacks uniformity: some commands are driven by the input format, others by the output format (e.g., ROS, cFS). To make Ogma easier to use, we should provide an interface that is driven by one or the other, but not both.

Type

• Feature: Introduce new command.

Additional context

None.

Requester

• Ivan Perez.

Method to check presence of bug

Not applicable (not a bug).

Expected result

Ogma provides commands for inputs support, or for outputs/targets supported, but not both.

Desired result

Ogma provides commands for inputs support, or for outputs/targets supported, but not both.

Proposed solution

Introduce new command standalone that implements the functionality currently supported by several commands to convert specs to Copilot.

Remove dedicated/redundant commands.

Adjust tests as needed to use the new interface.

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 fixing in Ogma 1.5.

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 and passes all tests. Details:
    • Build logs:
      • https://github.com/nasa/ogma/actions/runs/11975826736/job/33390083222
      • https://github.com/nasa/ogma/actions/runs/11975826740/job/33390083302
    • Build log archives:
      • logs_31222478276.zip
      • logs_31222478280.zip
  • The solution proposed produces the expected result. Details:
    The following dockerfile uses the new standalone command to compile of the prior supported files, after which it prints the message "Success":

    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
    
    CMD git clone $REPO \
        && cd $NAME \
        && git checkout $COMMIT \
        && cd .. \
        && cabal v1-sandbox init \
        && cabal v1-install $NAME/$PAT**/ copilot-4.1 --constraint="aeson>=2.0.3.0" \
        && ./.cabal-sandbox/bin/ogma standalone --file-name $NAME/ogma-cli/examples/fret.json --input-format fcs > Spec.hs \
        && cabal v1-exec -- runhaskell -XPartialTypeSignatures -Wno-partial-type-signatures Spec.hs \
        && echo "Success"

    Command (substitute variables based on new path after merge):

    $ docker run -e "REPO=https://github.com/ivanperez-keera/ogma" -e "NAME=ogma" -e "PAT=ogma"  -e "COMMIT=c7d2dc64561d39adaed9cde0106e0841d11171ca" -it ogma-verify-170
    

• Implementation is documented. Details:
  New modules include documentation. New commands include documentation and help messages.
• Change history is clear.
• Commit messages are clear.
• Changelogs are updated.
• Examples are updated. Details:
  No updates needed.
• Required version bumps are evaluated. Details:
  Bump needed; interface changes.

[ivanperez-keera]

Change Manager: Implementation ready to be merged.