copilot-bluespec: Disable test suite via newly added manual cabal flag. Refs #673.

[chathhorn-galois]

The copilot-bluespec package requires bsc (the Bluespec compiler) to be installed in order to run its test suite, but the builders that Hackage uses to run uploaded packages' test suites do not have bsc installed, causing Hackage to spuriously claim that copilot-bluespec's tests are failing.

This PR adds a cabal flag test-bluespec intended to enable tests that require the Bluespec compiler (bsc) to run. The default behavior of cabal test (with no flags) is now to not build the testsuite, preventing spurious test failures from appearing in Hackage reports. To enable building the testsuite, use: cabal test -f test-bluespec.

Fixes #673.

[ivanperez-keera]

Change Manager: @chathhorn-galois Can you please make the following changes to keep some entries and messages a bit shorter?

• In the changelog, please reduce the entry to:

        * Disable test suite via newly added manual cabal flag. (#673)

In the commit message for the first commit, can you please modify the summary line to read similarly?

copilot-bluespec: Disable test suite via newly added manual cabal flag. Refs #673.

Please make these changes modifying your existing commits (without adding any more commits on top), and push force to your branch so that the PR is updated automatically.

Thanks!

[chathhorn-galois]

Implementor: Fix implemented, review requested.

[ivanperez-keera]

Change Manager: Verified that:

• Solution is implemented:
  • The code proposed compiles and passes all tests. Details:
    Build log: https://app.travis-ci.com/github/Copilot-Language/copilot/builds/277177872
  • The solution proposed produces the expected result. Details:
    The following Dockerfile checks that the tests can be disabled via a flag, and that they can be re-enabled with the same flag, after which it prints the message "Success":

    FROM ubuntu:focal
    
    ENV DEBIAN_FRONTEND=noninteractive
    RUN apt-get update
    
    RUN apt-get install --yes \
          libz-dev \
          git \
          curl \
          gcc \
          g++ \
          make \
          libgmp3-dev  \
          pkg-config
    
    RUN mkdir -p $HOME/.ghcup/bin
    RUN curl https://downloads.haskell.org/~ghcup/0.1.50.2/x86_64-linux-ghcup-0.1.50.2 -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/
    
    SHELL ["/bin/bash", "-c"]
    
    RUN ghcup install ghc 9.2
    RUN ghcup install cabal 3.2
    RUN ghcup set ghc 9.2.8
    RUN cabal update
    
    SHELL ["/bin/bash", "-c"]
    CMD git clone $REPO \
        && cd $NAME \
        && git checkout $COMMIT \
        && cd copilot-bluespec \
        && cabal v1-install --enable-tests --only-dependencies \
        && cabal v1-configure --enable-tests \
        && (cabal v1-test  | grep -e 'Package has no buildable test suites') \
        && cabal v1-install --enable-tests --only-dependencies -ftest-bluespec \
        && cabal v1-configure --enable-tests -ftest-bluespec \
        && ! cabal v1-test \
        && echo "Success"

    Command (substitute variables based on new path after merge):

    $ docker run -e REPO=https://github.com/GaloisInc/copilot-1 -e NAME=copilot-1 -e COMMIT=03fc7d4059d762641c8fccc9076533dca626aa63 copilot-verify-673
    

• Implementation is documented. Details:
  New flag is documented.
• Change history is clear.
• Commit messages are clear.
• Changelogs are updated.
• Examples are updated. Details:
  No updates needed; change is to the cabal file.
• Required version bumps are evaluated. Details:
  Bump not required; change is to Cabal package affecting tests only.