ogma-cli: Allow customizing the cFS application template

[ivanperez-keera]

Description

The cFS application generation backend has a fixed template that it uses to generate the cFS application. That template does not fit all use cases, so we are finding users heavily modifying the output (which is hard to keep up with when there are changes), and or not using ogma altogether for that reason.

Allowing users to pick their own cFS template would make Ogma more versatile.

Type

• Feature: Enable customizing output produced.

Additional context

None.

Requester

• Ivan Perez.

Method to check presence of bug

Not applicable (not a bug).

Expected result

Ogma allows users to pick the custom cFS application template they want to use instead of relying on the one provided by default.

Desired result

Ogma allows users to pick the custom cFS application template they want to use instead of relying on the one provided by default.

Proposed solution

Modify ogma-core to use variable expansion based on mustache to create the output files.

Modify ogma-core's template to use the variables used by the cFS application generation module.

Modify ogma-core to give users the ability to pick a template directory via an optional input argument.

Modify ogma-cli to give users the ability to pick a template directory via an optional input argument (exposing the corresponding argument from ogma-core).

Modify README to demonstrate new capability.

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/ivanperez-keera/ogma/actions/runs/11844308497/job/33007216677
      • https://github.com/ivanperez-keera/ogma/actions/runs/11844308494/job/33007216684
    • Build log archives:
      • logs_30906288908.zip
      • logs_30906288906.zip
  • The solution proposed produces the expected result. Details:
    The following dockerfile generates the cFS application using the default template and using a copy and the default template and checks that both are the same. It then adds a file to the copy of the template and checks that the file is copied to the target directory when the custom template is used, 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-install $NAME/$PAT**/ --constraint="aeson>=2.0.3.0"                              && \
        cp -r $NAME/ogma-core/templates/copilot-cfs custom-template-cfs                           && \
        find custom-template-cfs -iname '.gitignore' -delete                                      && \
        ./.cabal-sandbox/bin/ogma cfs --variable-file $NAME/ogma-cli/examples/cfs-variables --variable-db $NAME/ogma-cli/examples/cfs-variable-db --app-target-dir original                                   && \
        ./.cabal-sandbox/bin/ogma cfs --variable-file $NAME/ogma-cli/examples/cfs-variables --variable-db $NAME/ogma-cli/examples/cfs-variable-db --app-target-dir new --app-template-dir custom-template-cfs && \
        diff -rq original new                                                                     && \
        rm -rf new                                                                                && \
        echo "Success" >> custom-template-cfs/test                                                && \
        ./.cabal-sandbox/bin/ogma cfs --variable-file $NAME/ogma-cli/examples/cfs-variables --variable-db $NAME/ogma-cli/examples/cfs-variable-db --app-target-dir new --app-template-dir custom-template-cfs && \
        cat new/test

    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=a1a96818e5a60420c233a3a00d4117e95dfbb1b0" -it ogma-verify-157
    

• Implementation is documented. Details:
  The new code has comments.
• Change history is clear.
• Commit messages are clear.
• Changelogs are updated.
• Examples are updated. Details:
  No updates needed.
• Required version bumps are evaluated. Details:
  No bump needed. New feature is backwards compatible.

[ivanperez-keera]

Change Manager: Implementation ready to be merged.