Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ogma-core: Make DB2Copilot backend to use JSON parser #122

Closed
ivanperez-keera opened this issue Jan 22, 2024 · 6 comments
Closed

ogma-core: Make DB2Copilot backend to use JSON parser #122

ivanperez-keera opened this issue Jan 22, 2024 · 6 comments
Assignees
Labels
CR:Status:Closed Admin only: Change request that has been completed CR:Type:Management Admin only: Change request for conformance with policies or procedures
Milestone

Comments

@ivanperez-keera
Copy link
Member

ivanperez-keera commented Jan 22, 2024

Description

The requirements-DB-2-Copilot backend uses an adhoc parser, instead of using the generalized JSON parser. Using the latter would simplify the code, as well as make it more versatile.

Type

  • Management: code factorization.

Additional context

None.

Requester

  • Ivan Perez

Method to check presence of bug

Not applicable (not a bug).

Expected result

The specific library that deals with parsing requirement DBs is removed, and we instead rely on the generic JSON parser.

Desired result

The specific library that deals with parsing requirement DBs is removed, and we instead rely on the generic JSON parser.

Proposed solution

Express the logic of parsing the requirements DB file using the JSON parser. Remove the dedicated library for parsing requirement databases, as well as the file in Language/Trans.

Further notes

None.

@ivanperez-keera ivanperez-keera added CR:Status:Initiated Admin only: Change request that has been initiated CR:Type:Management Admin only: Change request for conformance with policies or procedures labels Jan 24, 2024
@ivanperez-keera
Copy link
Member Author

Change Manager: Confirmed that the issue exists.

@ivanperez-keera ivanperez-keera added CR:Status:Confirmed Admin only: Change request that has been acknowledged by the change manager and removed CR:Status:Initiated Admin only: Change request that has been initiated labels Jan 24, 2024
@ivanperez-keera
Copy link
Member Author

Technical Lead: Confirmed that the issue should be addressed.

@ivanperez-keera ivanperez-keera added CR:Status:Accepted Admin only: Change request accepted by technical lead and removed CR:Status:Confirmed Admin only: Change request that has been acknowledged by the change manager labels Jan 24, 2024
@ivanperez-keera
Copy link
Member Author

Technical Lead: Issue scheduled for fixing in Ogma 1.3.

Fix assigned to: @ivanperez-keera.

@ivanperez-keera ivanperez-keera added CR:Status:Scheduled Admin only: Change requested scheduled and removed CR:Status:Accepted Admin only: Change request accepted by technical lead labels Jan 24, 2024
@ivanperez-keera ivanperez-keera added this to the 1.3.0 milestone Jan 24, 2024
@ivanperez-keera ivanperez-keera self-assigned this Jan 24, 2024
@ivanperez-keera ivanperez-keera added CR:Status:Implementation Admin only: Change request that is currently being implemented and removed CR:Status:Scheduled Admin only: Change requested scheduled labels Jan 24, 2024
ivanperez-keera added a commit that referenced this issue Jan 24, 2024
…. Refs #122.

Not all kinds of input files that use the JSON parsing library will
provide all information. In some, information is implicit or simply not
available, yet we should be able to deal with such files.

This commit modifies the JSON spec parsing library so that some fields
can be optional. In general, we assume we'll still have the essential
fields (requirements, IDs, specs), but not all auxiliary information.
ivanperez-keera added a commit that referenced this issue Jan 24, 2024
A prior commit has modified the JSON Spec parsing library to make some
fields in input JSON files optional. This will make the library more
versatile.

This commit modifies the existing modules that use the JSON parsing
library to use the new interface with optional types for some JSON
Format spec fields.
ivanperez-keera added a commit that referenced this issue Jan 24, 2024
The JSON parsing functions currently used by ogma-core to parse
requirement DBs are very specific to the formats supported.

This commit replaces the existing FRET DB parser and converter by one
that is based on the new generic JSON-based parsing library. The old
module implementing the adhoc converter, as well as the dependency on
the ad hoc parser, are removed.
ivanperez-keera added a commit that referenced this issue Jan 24, 2024
The library ogma-language-fret-reqs is no longer needed, since its
functions have been generalized in other libraries. Therefore, this
library can be completely removed.
ivanperez-keera added a commit that referenced this issue Jan 24, 2024
The JSON parsing functions currently used by ogma-core to parse
requirement DBs are very specific to the formats supported.

This commit replaces the existing FRET DB parser and converter by one
that is based on the new generic JSON-based parsing library. The old
module implementing the adhoc converter, as well as the dependency on
the ad hoc parser, are removed.
ivanperez-keera added a commit that referenced this issue Jan 24, 2024
The library ogma-language-fret-reqs is no longer needed, since its
functions have been generalized in other libraries. Therefore, this
library can be completely removed.
ivanperez-keera added a commit that referenced this issue Jan 24, 2024
The JSON parsing functions currently used by ogma-core to parse
requirement DBs are very specific to the formats supported.

This commit replaces the existing FRET DB parser and converter by one
that is based on the new generic JSON-based parsing library. The old
module implementing the adhoc converter, as well as the dependency on
the ad hoc parser, are removed.
ivanperez-keera added a commit that referenced this issue Jan 24, 2024
The library ogma-language-fret-reqs is no longer needed, since its
functions have been generalized in other libraries. Therefore, this
library can be completely removed.
@ivanperez-keera
Copy link
Member Author

Implementor: Solution implemented, review requested.

@ivanperez-keera ivanperez-keera added CR:Status:Verification Admin only: Change request that is currently being verified and removed CR:Status:Implementation Admin only: Change request that is currently being implemented labels Jan 24, 2024
ivanperez-keera added a commit that referenced this issue Jan 24, 2024
A prior commit has modified the JSON Spec parsing library to make some
fields in input JSON files optional. This will make the library more
versatile.

This commit modifies the existing modules that use the JSON parsing
library to use the new interface with optional types for some JSON
Format spec fields. The extensional behavior of these modules does not
change, compared to their behavior prior to the modification of the JSON
Format Spec definition to make some fields optional.
ivanperez-keera added a commit that referenced this issue Jan 24, 2024
The JSON parsing functions currently used by ogma-core to parse
requirement DBs are very specific to the formats supported.

This commit replaces the existing FRET DB parser and converter by one
that is based on the new generic JSON-based parsing library. The old
module implementing the ad hoc converter, as well as the dependency on
the ad hoc parser, are removed.
ivanperez-keera added a commit that referenced this issue Jan 24, 2024
The library ogma-language-fret-reqs is no longer needed, since its
functions have been generalized in other libraries. Therefore, this
library can be completely removed.
@ivanperez-keera
Copy link
Member Author

Change Manager: Verified that:

  • Solution is implemented:
    • 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:
      $ docker run -e "REPO=https://github.com/NASA/ogma" -e "NAME=ogma" -e PAT="ogma-" -e "COMMIT=a590ae61f83e2a91fbbd4b5212caa228c3c0cf07" -it ogma-test
    • The solution proposed fixes the issues described. Details:
      Not applicable (not a bug). The tests above run the parser modified as part of this PR on a test file.
  • Implementation is documented. Details:
    No changes needed.
  • Change history is clear.
  • Commit messages are clear.
  • Changelogs are updated.
  • Examples are updated. Details:
    No examples affected.
  • Required version bumps are evaluated. Details:
    Bump needed (libraries disappear).

@ivanperez-keera
Copy link
Member Author

Change Manager: Implementation ready to be merged.

@ivanperez-keera ivanperez-keera added CR:Status:Closed Admin only: Change request that has been completed and removed CR:Status:Verification Admin only: Change request that is currently being verified labels Jan 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CR:Status:Closed Admin only: Change request that has been completed CR:Type:Management Admin only: Change request for conformance with policies or procedures
Projects
None yet
Development

No branches or pull requests

1 participant