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: Remove trailing spaces from cFS app template. Refs #108. #109

Merged

Conversation

ivanperez-keera
Copy link
Member

Remove trailing spaces from the cFS application template, as prescribed in the solution proposed for #108.

The cFS app template contains trailing spaces. Trailing spaces do not conform
with our own style guide (and are commonly disallowed by style guides), and are
consequently automatically removed by many editors. In turn that will produce
changes to the generated files, which will be overwritten every time the user
re-generates the app.

This commit removes all trailing spaces from the cFS app template.
@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/ivanperez-keera/ogma" -e "NAME=ogma" -e PAT="ogma-" -e "COMMIT=b9753e29f6e0823fa8bf5e639b750528438d7b31" -it ogma-test
    • The solution proposed fixes the issues described. Details:
      The following Dockerfile searches for trailing spaces in all files, printing the word Success if none are found.

      FROM ubuntu:focal
      
      RUN apt-get update
      
      RUN apt-get install --yes git
      
      SHELL ["/bin/bash", "-c"]
      CMD git clone $REPO \
          && cd $NAME \
          && git checkout $COMMIT \
          && ! grep -nIHre ' $' ogma** \
          && echo "Success"

      Command:

      $ docker run -e "REPO=https://github.com/ivanperez-keera/ogma" -e "NAME=ogma" -e PAT="ogma-" -e "COMMIT=b9753e29f6e0823fa8bf5e639b750528438d7b31" -it ogma-verify-108
  • 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:
    No bump needed (change to generated code with no behavioral implications).

@ivanperez-keera ivanperez-keera merged commit 96b9de0 into nasa:develop Nov 22, 2023
@ivanperez-keera ivanperez-keera deleted the develop-cfs-trailingSpaces branch November 22, 2023 06:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant