Support XML-based input files

[ivanperez-keera]

Description

There is a need in Ogma to support XML-based input files, since this is produced by many standard tools in the industry. Like with JSON, we want users to be able to customize the input format via a command-line flag, so that users can work with XML-based files whose format is previously unknown to Ogma without having to modify the tool.

Type

• Feature: new capability.

Additional context

None.

Requester

• Ivan Perez.

Method to check presence of bug

Not applicable (not a bug).

Expected result

Ogma is able to process and extract data from an input file in XML, obtaining information from a configuration file provided by the user.

Desired result

Ogma is able to process and extract data from an input file in XML, obtaining information from a configuration file provided by the user.

Proposed solution

Introduce a parsing library for XML files, and use it in ogma-core to parse input files when the user specifies that the format is XML-based.

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/nasa/ogma/actions/runs/12856145455/job/35842484979?pr=203
      • https://github.com/nasa/ogma/actions/runs/12856145464/job/35842484991?pr=203
    • Build log archives:
      • logs_33247562636.zip
      • logs_33247562649.zip
  • The solution proposed produces the expected result. Details:
    The following dockerfile uses the new parser, together with a custom XML format specification, to parse read properties from an input file and generate a Copilot monitor, checking that the produced monitor compiles correctly, after which it prints the message "Success":

    --- Dockerfile-verify-202
    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 --constraint='happy < 2.0'
    RUN apt-get install --yes git
    
    ADD xml-custom-format /tmp/xml-custom-format
    ADD properties.xml /tmp/properties.xml
    
    CMD git clone $REPO && \
        cd $NAME && \
        git checkout $COMMIT && \
        cd .. && \
        cabal v1-install copilot-4.2 $NAME/$PAT**/ && \
        ogma standalone --input-format /tmp/xml-custom-format --file-name /tmp/properties.xml --target-dir output && \
        cabal v1-exec -- runhaskell -XPartialTypeSignatures -Wno-partial-type-signatures output/Copilot.hs && \
        echo "Success"
    
    --- xml-custom-format
    XMLFormat
      { specInternalVars    = Nothing
      , specInternalVarId   = ("//*", Nothing)
      , specInternalVarExpr = ("//*", Nothing)
      , specInternalVarType = Nothing
      , specExternalVars    = Nothing
      , specExternalVarId   = ("//*", Nothing)
      , specExternalVarType = Nothing
      , specRequirements    = ("//Requirement", Nothing)
      , specRequirementId   = ("//Requirement/@Id/text()", Nothing)
      , specRequirementDesc = Just ("//Requirement/@Id/text()", Nothing)
      , specRequirementExpr = ("//Requirement/@Text/text()", Nothing)
      }
    
    --- properties.xml
    <?xml version="1.0" encoding="UTF-8"?>
    <Requirement name="REQ-1" Id="req1" Text="!go_too_fast" />
    

    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=c0af537eba86de2966172112b14fc52a1842202a" -it ogma-verify-202
    

• Implementation is documented. Details:
  All new libraries, modules and top-level functions include documentation. Modifications to ogma-core's top-level definitions also include additional documentation.
• 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 not required (API is backwards compatible).

[ivanperez-keera]

Change Manager: Implementation ready to be merged.