Merge pull request #4698 from stacks-network/test/pox-4-unit

PoX-4 unit testing

Author: obycode

contrib/boot-contracts-unit-tests/.gitignore

@@ -0,0 +1,13 @@
+
+**/settings/Mainnet.toml
+**/settings/Testnet.toml
+.cache/**
+history.txt
+
+logs
+*.log
+npm-debug.log*
+coverage
+*.info
+costs-reports.json
+node_modules

contrib/boot-contracts-unit-tests/.vscode/settings.json

@@ -0,0 +1,4 @@
+
+{
+    "files.eol": "\n"
+}

contrib/boot-contracts-unit-tests/.vscode/tasks.json

@@ -0,0 +1,19 @@
+
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "check contracts",
+      "group": "test",
+      "type": "shell",
+      "command": "clarinet check"
+    },
+    {
+      "type": "npm",
+      "script": "test",
+      "group": "test",
+      "problemMatcher": [],
+      "label": "npm test"
+    }
+  ]
+}

contrib/boot-contracts-unit-tests/Clarinet.toml

@@ -0,0 +1,21 @@
+[project]
+name = 'boot-contracts-unit-tests'
+description = ''
+authors = []
+telemetry = false
+cache_dir = './.cache'
+requirements = []
+
+[contracts.indirect]
+path = 'contracts/indirect.clar'
+clarity_version = 2
+epoch = 2.4
+
+[repl.analysis]
+passes = ['check_checker']
+
+[repl.analysis.check_checker]
+strict = false
+trusted_sender = false
+trusted_caller = false
+callee_filter = false

contrib/boot-contracts-unit-tests/README.md

@@ -0,0 +1,24 @@
+# Boot contracts unit tests
+
+Run unit tests with clarinet on boot contracts.
+
+Contracts tests:
+
+- [x] pox-4.clar
+
+
+## About boot contract unit testing with Clarinet
+
+- To really test contracts such as the pox contracts, we need to test the boot contracts embedded
+into Clarinet. For example `ST000000000000000000002AMW42H.pox-4.clar`
+- This mean that calling this contract will interact 
+- Since the boot contracts are embedded into Clarinet, we only test the version of the contract
+that is in Clarinet, and not the ones that actually live in the stacks-core repository.
+
+We are able to get the boot contracts coverage thanks to this settings in `vitest.config.js`:
+```js
+  includeBootContracts: true,
+  bootContractsPath: `${process.cwd()}/boot_contracts`,
+```
+A copy of the tested boot contracts is includedin this directory as well so that we are able to
+compute and render the code coverage.