Is there a way for a package to detect that it's building on hackage?

[ivanperez-keera]

We have a package (https://github.com/Copilot-Language/copilot/tree/master/copilot-bluespec) that cannot be tested on hackage because bsc (bluespec) is not included.

We could disable tests by default, but I'm wondering if there's a way to disable tests on hackage only, and keep them enabled by default otherwise.

[phadej]

Hackage doesn't build tests, or at least doesn't run themm does it?

[gbaz]

Hackage does build and run tests. This can be disabled per-package on hackage: https://hackage.haskell.org/package/copilot-bluespec/maintain

This is however not an ideal situation, as it has to be done for each version. A PR to hackage to allow disabling tests across all versions (including yet-to-be-uploaded) would be welcome.

[Bodigrim]

One can update Hackage configutation to install bluespec by submitting a PR to https://github.com/haskell-infra/hackage-doc-builder-config

[ivanperez-keera]

Tagging @RyanGlScott .

[phadej]

Hackage does build and run tests.

Interesting. I find that somewhat surprising. I'd prefer running tests to be opt-in, I don't find it useful at all.

I don't want my docs building failing because of test issues (mostly missing compile or run time dependencies)

[phadej]

Addition: test runner should use --test-show-details=direct or always. Hiding the test output is no point in CI

Running 1 test suites...
Test suite smoke: RUNNING...
Test suite smoke: PASS

is useless, especially as that suite probably says that it's skipped (because no external runtime dependency is found), but I cannot be sure as output is omitted.

[Bodigrim]

I don't want my docs building failing because of test issues (mostly missing compile or run time dependencies)

I think it's independent: docs will be built just fine even if tests fail.

Addition: test runner should use --test-show-details=direct or always.

I raised this recently in #1397.

[RyanGlScott]

Returning to the original question of how to fix the Hackage tests for copilot-bluespec: I wouldn't mind opening a PR on the hackage-doc-builder-config to add bluespec to the list of packages in build-depends.nix. That being said, I have a question about the scope of build-depends.nix. The top of that file says:

# Packages available to packages built using the Hackage Haddock builder

The key phrase there is "Haddock builder". Is it acceptable to add packages there solely for the sake of running tests? (copilot-bluespec uses bsc in its test suite, but otherwise its Haddocks build without issue.)

[ivanperez-keera]

@RyanGlScott I don't know that the current setting to disable tests would help us otherwise.

Currently copilot-bluespec is set to not run tests:

However, it still shows that building the tests failed:

Apparently, a re-build (which I tried to trigger last week) does not help.