Address all hlint suggestions

[ivanperez-keera]

Description

As part of our own internal testing and style guides, we recommend the use of different static analysis tools, which are currently reporting a number of suggestions. HLint is suggesting the use of newtype instead of data, and the removal of fmap id in a number of places.

We should address these issues, either by applying hlint's suggestion, or by adding annotations or configuration settings that make hlint ignore those cases.

Type

• Management: conformance with testing / style guide.

Additional context

None.

Requester

• Ivan Perez

Method to check presence of bug

The following bash command will print "Success" if there are no hlint suggestions, and nothing otherwise.

$ (for i in ogma-*; do cd $i; hlint --no-summary src/ ; cd ..; done | [ $(wc -c) -eq 0 ]) && echo Success

Expected result

The command above should print "Success".

Desired result

The command above should print "Success".

Proposed solution

Evaluate each suggestion, and either accept it or make hlint ignore it by modifying the .hlint.yaml file or adding an annotation to the code.

Further notes

None.

[ivanperez-keera]

Change Manager: Confirmed that the hlint suggestions are produced.

[ivanperez-keera]

Technical Lead: Confirmed that the issue should be addressed.

[ivanperez-keera]

Technical Lead: Issue scheduled for fixing in Ogma 1.0.4.

Fix assigned to: @ivanperez-keera .

[ivanperez-keera]

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=5e4949af53ee9286fb6ac8d1c47342e077b19075" -it ogma-test

  • The solution proposed fixes the issues described. Details:
    Executing the script indicated in Address all hlint suggestions #51 :

    $ (for i in ogma-*; do cd $i; hlint --no-summary src/ ; cd ..; done | [ $(wc -c) -eq 0 ]) && echo Success

    prints the word Success.

• Implementation is documented. Details:
  No changes to the documentation needed (changes in config files or not affecting the API).
• Change history is clear.
• Commit messages are clear.
• Changelogs are updated.
• Examples are updated. Details:
  No examples affected.
• Required version bumps are evaluated. Details:
  No bump needed.

[ivanperez-keera]

Change Manager: Implementation ready to be merged.