ogma-cli: Allow customizing the standalone application template

[ivanperez-keera]

Description

The standalone application generation backend uses a fixed template to generate the standalone 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 standalone 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 standalone application template they want to use instead of relying on the one provided by default.

Desired result

Ogma allows users to pick the custom standalone 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 standalone 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.6.0.

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/12483377107/job/34839074205
      • https://github.com/ivanperez-keera/ogma/actions/runs/12483377108/job/34839074785
    • Build log archives:
      • logs_32415426081.zip
      • logs_32415426084.zip
  • The solution proposed produces the expected result. Details:
    The following dockerfile generates a standalone Copilot monitor 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". Compiling the produced component completes successfully:

    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 .. \
        && cp -r $NAME/ogma-core/templates/standalone custom-template-standalone \
        && 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 --target-dir orig \
        && ./.cabal-sandbox/bin/ogma standalone --file-name $NAME/ogma-cli/examples/fret.json --input-format fcs --target-dir new --template-dir custom-template-standalone \
        && diff -rq orig new \
        && rm -rf new/ \
        && echo "Success" >> custom-template-standalone/README \
        && ./.cabal-sandbox/bin/ogma standalone --file-name $NAME/ogma-cli/examples/fret.json --input-format fcs --target-dir new --template-dir custom-template-standalone \
        && cabal v1-exec -- runhaskell -XPartialTypeSignatures -Wno-partial-type-signatures new/Copilot.hs \
        && cat new/README
    

    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=9c76554ab695e98ed05a01caad099f0347519358" -it ogma-verify-189
    

• Implementation is documented. Details:
  The new code has comments. Changes to old code had their comments adapted.
• 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.