[ivanperez-keera]

Adjust Common.VariableDB so that no error is reported if multiple fields of the same message are used by different variables, and adjust cFS backend and template to support multiple fields for one message, as prescribed in the solution proposed for #625.

[ivanperez-keera]

Change Manager: The commit message for the second commit is not clear. It talks about a limitation but that's not the right term.

[ivanperez-keera]

Implementor: Fix 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/42666023547/job/129329762465
      • https://github.com/nasa/ogma/actions/runs/42666023534/job/129329762023
      • https://github.com/nasa/ogma/actions/runs/42666023540/job/129329761957
      • https://github.com/nasa/ogma/actions/runs/42666023532/job/129329761899
      • https://github.com/nasa/ogma/actions/runs/42666023531/job/129329761388
      • https://github.com/nasa/ogma/actions/runs/42666023533/job/129329761931
      • https://github.com/nasa/ogma/actions/runs/42666023538/job/129329761467
    • Build log archives:
      • logs_115558617370.zip
      • logs_115558617382.zip
      • logs_115558617399.zip
      • logs_115558617400.zip
      • logs_115558617404.zip
      • logs_115558617413.zip
      • logs_115558617421.zip
  • The solution proposed produces the expected result. Details:
    The following Dockerfile checks that the cFS backend can generate a cFS app when two variables refer to different sub-fields of the same cFS message, after which it prints the message "Success":

    --- Dockerfile-verify-625
    FROM ubuntu:22.04
    
    ENV DEBIAN_FRONTEND=noninteractive
    
    SHELL ["/bin/bash", "-c"]
    
    RUN apt-get update
    RUN apt-get install --yes --no-install-recommends \
      cabal-install \
      ca-certificates \
      cmake \
      curl \
      g++ \
      ghc \
      git \
      libbz2-dev \
      libexpat1-dev \
      libz-dev \
      make \
      pkg-config
    
    WORKDIR /root/
    
    ENV PATH=/root/.cabal-sandbox/bin:$PATH
    
    RUN cabal update || true
    RUN sed -ie 's;-- secure: True;secure: False;g' /root/.cabal/config
    RUN cabal update
    RUN cabal v1-sandbox init
    RUN cabal v1-install alex happy
    RUN cabal v1-install BNFC
    RUN cabal v1-install copilot-4.8
    
    ARG GIT_COMMIT=HEAD
    ARG NAME=ogma
    ARG REPO=https://github.com/nasa/ogma
    
    RUN git clone ${REPO} ${NAME}
    RUN cd ${NAME} && git checkout ${GIT_COMMIT}
    RUN cabal v1-install \
          --force-reinstall \
          ${NAME}/ogma-**/
    
    ADD expressions2.json /tmp/
    ADD db2.json /tmp/
    
    RUN ogma cfs --target-dir app/ --input-file /tmp/expressions2.json \
          --input-format ${NAME}/ogma-cli/examples/cfs-001-hello-ogma/json-format.cfg \
          --prop-format literal \
          --variable-db /tmp/db2.json \
          --template-vars ${NAME}/ogma-cli/examples/cfs-001-hello-ogma/extra-vars.json
    
    --- expressions2.json
    {
      "CFSExample": {
        "internal_variables": [],
        "external_variables": [
          {"name": "input_value", "type": "Int32", "meaning": "InputI32"}
        , {"name": "input_value2", "type": "Int32", "meaning": "InputI32"}
        ],
        "properties": [
          {
            "id":      "TestOgma",
            "formula": "input_value <= 0",
            "text":    "input_value shall always be lower than or equal to zero"
          }
        , {
            "id":      "TestOgma2",
            "formula": "input_value2 <= 0",
            "text":    "input_value2 shall always be lower than or equal to zero"
          }
        ]
      }
    }
    
    --- db2.json
    { "inputs":
         [ { "name": "input_value"
           , "type": "int32_t"
           , "active": true
           , "connections":
               [ { "scope": "cfs"
                 , "topic": "SAMPLE_MID"
                 , "field": "payload"
                 }
               ]
           }
         , { "name": "input_value2"
           , "type": "int32_t"
           , "active": true
           , "connections":
               [ { "scope": "cfs"
                 , "topic": "SAMPLE_MID"
                 , "field": "payload2"
                 }
               ]
           }
         ]
    , "topics":
         [ { "scope": "cfs"
           , "topic": "SAMPLE_MID"
           , "type":  "sample_msg_t"
           }
         ]
    , "types": [
           { "fromScope": "cfs"
           , "fromType":  "sample_msg_t"
           , "fromField": "payload"
           , "toScope":   "C"
           , "toType":    "int32_t"
           }
         , { "fromScope": "cfs"
           , "fromType":  "sample_msg_t"
           , "fromField": "payload2"
           , "toScope":   "C"
           , "toType":    "int32_t"
           }
         ]
    }
    

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

    $ docker build --build-arg "REPO=https://github.com/ivanperez-keera/ogma" --build-arg "NAME=ogma" --build-arg "GIT_COMMIT=f0f1683bae64f1f14ddd99de471446a1ef9dfff3" -t ogma-verify-625 -f Dockerfile-verify-625 .
    

• Implementation is documented. Details:
  All new top-level functions and data structures have documentation.
• Change history is clear.
• Commit messages are clear.
• Changelogs are updated.
• Examples are updated. Details:
  No updates needed; change does not affect existing examples.
• Author is internal or has provided signed CLA.
• Required version bumps are evaluated. Details:
  Bump needed; change alters public API of ogma-core due to a change in the structure of the result produced by the cFS backend.