Skip to content

Commit 5f662ce

Browse files
Fix links to the Registry example (#87)
* Fix links to the Registry example * Update quickcheck-dynamic/README.md Co-authored-by: Maximilian Algehed <[email protected]> * Bump actions/upload-artifact * Bump actions/cache * Bump actions/download-artifact --------- Co-authored-by: Maximilian Algehed <[email protected]>
1 parent 071092c commit 5f662ce

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

.github/workflows/ci.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ jobs:
2929
log-lines = 1000
3030
3131
- name: Github cache ~/.cabal/packages, ~/.cabal/store and dist-newstyle
32-
uses: actions/cache@v2.1.5
32+
uses: actions/cache@v4
3333
with:
3434
path: |
3535
~/.cabal/packages
@@ -73,7 +73,7 @@ jobs:
7373
accept-flake-config = true
7474
7575
- name: Github cache ~/.cabal/packages, ~/.cabal/store and dist-newstyle
76-
uses: actions/cache@v2.1.5
76+
uses: actions/cache@v4
7777
with:
7878
path: |
7979
~/.cabal/packages
@@ -87,7 +87,7 @@ jobs:
8787
nix develop --accept-flake-config --command .github/workflows/ci-haddock.sh
8888
8989
- name: Upload build & test artifacts
90-
uses: actions/upload-artifact@v3
90+
uses: actions/upload-artifact@v4
9191
with:
9292
name: haddocks
9393
path: ./docs
@@ -102,7 +102,7 @@ jobs:
102102
repository: input-output-hk/quickcheck-dynamic
103103

104104
- name: Download generated documentation
105-
uses: actions/download-artifact@v3
105+
uses: actions/download-artifact@v4
106106
with:
107107
name: haddocks
108108
path: docs

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This repository hosts:
1414
## Documentation
1515

1616
* The original stateful testing approach is described in John Hughes' research paper: [https://www.cs.tufts.edu/~nr/cs257/archive/john-hughes/quviq-testing.pdf ](https://publications.lib.chalmers.se/records/fulltext/232550/local_232550.pdf)
17-
* The [Registry example](https://github.com/input-output-hk/quickcheck-dynamic/tree/main/quickcheck-io-sim-compat) is a common case study that's been explored in two papers:
17+
* The [Registry example](https://github.com/input-output-hk/quickcheck-dynamic/blob/main/quickcheck-dynamic/test/Spec/DynamicLogic/RegistryModel.hs) is a common case study that's been explored in two papers:
1818
* [How well are your requirements tested?](https://publications.lib.chalmers.se/records/fulltext/232552/local_232552.pdf)
1919
* and [Understanding Formal Specifications through Good Examples](https://mengwangoxf.github.io/Papers/Erlang18.pdf)
2020
* The dynamic logic addition allows you to specify that after a generated test sequence, the system is able to reach a specific required state. In other words, you can specify that some "good" state is reachable from any possible state.

quickcheck-dynamic/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Plutus or Cardano.
1717
comments. Checkout [StateModel](https://hackage.haskell.org/package/quickcheck-dynamic/docs/src/Test.QuickCheck.StateModel.html)
1818
and [DynamicLogic](https://hackage.haskell.org/package/quickcheck-dynamic/docs/Test-QuickCheck-DynamicLogic.html) modules for
1919
some usage instructions.
20-
* For a concrete standalone example, have a look at `Registry` and `RegistryModel` modules from the companion [quickcheck-io-sim-compat](https://github.com/input-output-hk/quickcheck-dynamic/tree/main/quickcheck-io-sim-compat) package (not currently available on hackage), a multithreaded Thread registry inspired by the Erlang version of QuickCheck described in [this article](https://mengwangoxf.github.io/Papers/Erlang18.pdf)
20+
* For a concrete standalone example, have a look at the [`Registry`](https://github.com/input-output-hk/quickcheck-dynamic/blob/main/quickcheck-dynamic/test/Spec/DynamicLogic/Registry.hs) and [`RegistryModel`](https://github.com/input-output-hk/quickcheck-dynamic/blob/main/quickcheck-dynamic/test/Spec/DynamicLogic/RegistryModel.hs) module from the test suite, which respectively implement and model a multithreaded Thread registry inspired by the Erlang version of QuickCheck described in [this article](https://mengwangoxf.github.io/Papers/Erlang18.pdf)
2121
* For more documentation on how to quickcheck-dynamic is used to test
2222
Plutus DApps, check this
2323
[tutorial](https://plutus-apps.readthedocs.io/en/latest/plutus/tutorials/contract-models.html).

0 commit comments

Comments
 (0)