`ogma-core`: Generalize JSON parsing

[ivanperez-keera]

Description

The JSON parsing functions currently included with Ogma are very specific to two formats supported, and cannot be easily generalized. This limits our ability to adapt to changes and to different formats.

Type

• Management: code factorization.

Additional context

None.

Requester

• Ivan Perez

Method to check presence of bug

Not a bug.

Expected result

The parsing functions support any JSON file and can be easily customized to support specific JSON-based formats.

Desired result

The parsing functions support any JSON file and can be easily customized to support specific JSON-based formats.

Proposed solution

Use selectors, similar to XPath, to customize how fields are selected in JSON files.

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.2.

Fix assigned to: @ivanperez-keera.

[ivanperez-keera]

Implementor: Solution implemented, review requested.

[ivanperez-keera]

Change Manager: Verified that:

• Solution is implemented:

  • [X] The code proposed compiles passes the tests. Details: Docker image:

    
    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 RUN apt-get install --yes git

  We install the application first and then test it, in case any tests need to

  run the tool.

  CMD git clone $REPO && \ cd $NAME && \ git checkout $COMMIT && \ cd .. && \ cabal v1-install $NAME/$PAT/ --enable-tests && \ cabal v1-install $NAME/$PAT/ --enable-tests --run-tests -j1

  Command:
  ```sh
  $ docker run -e "REPO=https://github.com/ivanperez-keera/ogma" -e "NAME=ogma" -e PAT="ogma-" -e "COMMIT=95a5a1b61daea2ca08569815fe1327eb897c1c61" -it ogma-test

  • [X] The solution proposed fixes the issues described. Details: Not applicable (not a bug).
• [X] Implementation is documented. Details: No changes needed.
• [X] Change history is clear.
• [X] Commit messages are clear.
• [X] Changelogs are updated.
• [X] Examples are updated. Details: No examples affected.
• [X] Required version bumps are evaluated. Details: Bump needed (libraries disappear).

[ivanperez-keera]

Change Manager: Implementation ready to be merged.