Add source location URL to CI test failures.

[zainab-ali]

This resolves #310 .

Source locations in GitHub Actions are displayed as navigable URLs. This can be configured for other CI providers using the WEAVER_SOURCE_URL environment variable.

Example

You can find an example in our own GitHub Actions logs

Public API changes

While this is a breaking API change, most users aren't affected by it.

• The Test constructor requires an implicit Env. Most users writing custom test functions will be using IO, so will have this already.
• EffectCompat now requires an Env. This affects anyone implementing custom effect types.

[Baccata]

I'm not sure it's necessary for the change to impact these layers of the framework. You could centralise the querying of the environment in the formatter (in an unsafe fashion), and apply the github-specific rendering there.

I appreciate that reading the environment does not fall strictly in the pure-FP paradigm that Typelevel ougth to strive for, but the sbt-test-interface that weaver implements forces some compromise onto us. I'm happy to deviate a little bit out of the CE idioms if it minimises the impact / the amount of things the information needs to be threaded through. Additionally, the set of environment variables is pretty much immutable during the lifetime of a program.

[zainab-ali]

I'd be happy to remove it with querying within the formatter, but it would be good if we could still test the code path.

In particular, our DogFoodTests should render the same message when running locally to in CI. We do this currently by overriding the Env here. It alsp allows us to test the codepath for the WEAVER_SOURCE_URL, as currently done here.

One alternative is to pass the suite's isCI boolean value through to Test and Result. The same information would need to be threaded through, so the code wouldn't necessarily be cleaner.

Another approach, if possible, would be for us to set WEAVER_SOURCE_URL within our own SBT build environment variables. We wouldn't be able to test the WEAVER_SOURCE_URL codepath, but the DogFoodTests would render the same output. I'll experiment with this.

[zainab-ali]

The environment variable in SBT works for running DogFoodTests agnostic to CI.

Note that we need to have a different implementation for JS that uses process.env. @Baccata , what do you think of this approach?

[Baccata]

Yup, that's great imho 👍

[zainab-ali]

This helps with the assertInlineSnapshot tests - updated tests now include stripMargin, but they're not aligned without scalafmt.

EDIT: I've moved it to PR #313 to make this diff easier.

[zainab-ali]

This displays clickable links, so is better than a screenshot:

Unfortunately we can't get correct source locations by running a test, as mdoc doesn't calculate source locations correctly.

[Baccata]

That's absolutely fine

[Baccata]

Great idea, and great work !