PoX-4 Clarunit Setup & Initial Tests

[setzeus]

Description

This PR introduces the new @stacks/clarunit to allow for writing boot contract unit tests in Clarity. Clarunit is uses Clarinet SDK so all the goodness that comes with Clarinet is preserved.

Only some basic tests are introduced in this PR. Increasing code coverage will be done in follow-up PRs.

Applicable issues

Issue wasn't created but this is a continuation of the work done in #4100.

[codecov]

Codecov Report

Attention: Patch coverage is 78.48101% with 17 lines in your changes are missing coverage. Please review.

Project coverage is 83.19%. Comparing base (d063a74) to head (a9ef3ba).
Report is 10 commits behind head on next.

Additional details and impacted files

@@            Coverage Diff             @@
##             next    #4231      +/-   ##
==========================================
- Coverage   83.46%   83.19%   -0.27%     
==========================================
  Files         448      453       +5     
  Lines      323930   325191    +1261     
  Branches        0      316     +316     
==========================================
+ Hits       270352   270530     +178     
- Misses      53578    54653    +1075     
- Partials        0        8       +8     

Files	Coverage Δ
contrib/core-contract-tests/tests/bns_test.clar	80.00% <80.00%> (ø)
contrib/core-contract-tests/tests/pox_4_test.clar	78.37% <78.37%> (ø)

... and 27 files with indirect coverage changes

---

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d063a74...a9ef3ba. Read the comment docs.

[friedger]

Some comments

[MarvinJanssen]

@setzeus package @stacks/clarunit has been published by @wileyj. https://www.npmjs.com/package/@stacks/clarunit

The package can be replaced and pinned. I assume we can move the PR out of draft after that?

[setzeus]

Yeap @MarvinJanssen will do! Though atm this is on pause until at least EOM / Argon completion.*

[setzeus]

Note: per the ClarityWG discussion on 2/27, this PR does NOT include a generated coverage file. There were a few issues in how & where it's generated so we're creating an issue as a placeholder to ensure we deal with it next.

[MarvinJanssen]

I understood we want to merge this sooner rather than later and work on code coverage in the next PR.

[MarvinJanssen]

Codecov now picks up the Clarinet coverage report. Up until now it was silently failing because the path was incorrect. I added fail_ci_if_error (-Z) to make sure the Codecov action exits with a non-zero code when it fails.

See #4434 for more.

[obycode]

lgtm!

[wileyj]

shipit

[blockstack-devops]

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.