Add version bounds to all dependencies

[ivanperez-keera]

Description

The cabal packages do not currently specify version bounds. This makes hackage complain when we upload packages, and can create stability / installation issues for users.

Type

• Bug: Cabal files are missing useful information.

Additional context

None.

Requester

• Ivan Perez.

Method to check presence of bug

It's not possible to check automatically. The check is done by opening the cabal files and checking whether all dependencies of all components specify version bounds.

Expected result

All dependencies of all components specify version bounds.

Desired result

All dependencies of all components specify version bounds.

Proposed solution

Add version bounds to all dependencies of all components of all packages.

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/12507467244/job/34894042551
      • https://github.com/nasa/ogma/actions/runs/12507467258/job/34894042547
    • Build log archives:
      • logs_32462458224.zip
      • logs_32462458254.zip
  • The solution proposed produces the expected result. Details:
    Carried out by visual inspection, opening each cabal file and checking that all dependencies, for the setup and for all components, have both upper and lower bounds set. To ensure that the bounds set are acceptable, the following two dockerfiles compile Ogma with the oldest version of GHC supported (based on the version bound on base), and the newest (based on other constraints, as well as imports in the code that are only available in modern versions of dependencies of GHC):

   --- Dockerfile-ghc-8.4
   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.4.4 cabal-install-2.4
   RUN apt-get install --yes libz-dev
   
   ENV PATH=/opt/ghc/8.4.4/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 .. \
       && cabal v1-sandbox init \
       && cabal v1-install $NAME/$PAT**/ --constraint="aeson>=2.0.3.0" --enable-tests \
       && echo "Success"
  
   --- Dockerfile-ghc-9.4
   FROM ubuntu:focal
   
   RUN apt-get update
   
   RUN apt-get install --yes libz-dev
   RUN apt-get install --yes git
   
   # RUN curl --proto '=https' --tlsv1.2 -sSf https://get-ghcup.haskell.org | sh
   RUN apt-get install --yes wget
   RUN mkdir -p $HOME/.ghcup/bin
   RUN wget https://downloads.haskell.org/~ghcup/0.1.17.7/x86_64-linux-ghcup-0.1.17.7 -O $HOME/.ghcup/bin/ghcup
   
   RUN chmod a+x $HOME/.ghcup/bin/ghcup
   ENV PATH=$PATH:/root/.ghcup/bin/
   ENV PATH=$PATH:/root/.cabal/bin/
   RUN apt-get install --yes curl
   RUN apt-get install --yes gcc g++ make libgmp3-dev
   RUN ghcup install ghc 9.4
   RUN ghcup install cabal 3.2
   RUN ghcup set ghc 9.4.8
   RUN cabal update
   
   SHELL ["/bin/bash", "-c"]
   CMD git clone $REPO \
       && cd $NAME \
       && git checkout $COMMIT \
       && export PATH=$PATH:$PWD/.cabal-sandbox/bin/ \
       && cabal v1-sandbox init \
       && cabal v1-install alex happy --constraint="happy<2.0" \
       && cabal v1-install BNFC ogma-**/ --constraint="aeson>=2.0.3.0" \
       && cabal v1-install ogma-**/ --constraint="aeson>=2.0.3.0" --enable-tests \
       && echo "Success"

  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=cc38a221e10bf85edde7b54b24720cb048aa8db9" -it ogma-verify-119-ghc-8.4
  $ docker run -e "REPO=https://github.com/ivanperez-keera/ogma" -e "NAME=ogma" -e "PAT=ogma"  -e "COMMIT=cc38a221e10bf85edde7b54b24720cb048aa8db9" -it ogma-verify-119-ghc-9.4
  

• Implementation is documented. Details:
  No updates needed.
• 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; although we are restricting versions of dependencies, the way they are set simply captures the current compatibility of Ogma with other libraries and does not restrict it further.

[ivanperez-keera]

Change Manager: Implementation ready to be merged.