Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ligurio/molly
Framework for distributed system's verification, with fault injection.
https://github.com/ligurio/molly
consistency correctness fault-injection jepsen linearizability lua serializable
Last synced: 3 months ago
JSON representation
Framework for distributed system's verification, with fault injection.
- Host: GitHub
- URL: https://github.com/ligurio/molly
- Owner: ligurio
- License: isc
- Created: 2021-09-08T07:12:32.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-21T16:33:14.000Z (3 months ago)
- Last Synced: 2024-10-22T03:03:42.373Z (3 months ago)
- Topics: consistency, correctness, fault-injection, jepsen, linearizability, lua, serializable
- Language: Lua
- Homepage: https://ligurio.github.io/molly/
- Size: 409 KB
- Stars: 11
- Watchers: 3
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/ligurio/molly/actions/workflows/check.yaml)
[](https://github.com/ligurio/molly/actions/workflows/test.yaml)
[](https://coveralls.io/github/ligurio/molly)
[](https://luarocks.org/modules/ligurio/molly)
## Molly
is a framework for distributed systems verification, with fault injection.
### Prerequisites
- Lua interpreter: LuaJIT or LuaJIT-based is recommended.
- [luafun](https://luafun.github.io/) - Lua functional library, built-in into
Tarantool.
- [lua-cjson](https://github.com/mpx/lua-cjson) - Lua library for fast JSON
encoding and decoding, built-in into Tarantool.
- (optional) Jepsen-compatible consistency checker. For example
[elle-cli](https://github.com/ligurio/elle-cli), based on Jepsen, Elle and
Knossos.
### Installation
- Download and setup Lua interpreter, [LuaJIT](https://luajit.org/install.html)
or LuaJIT-based is recommended (for example
[Tarantool](https://www.tarantool.io/download/)).
- Install library using LuaRocks:
```sh
$ luarocks install --local molly
```
NOTE: Installation of modules `luafun` and `lua-cjson` is not required when
Tarantool is used, both modules are built-in there. Install them manually in
case of using LuaJIT:
```sh
$ make deps-runtime
```
### Documentation
See documentation in https://ligurio.github.io/molly/.
### Examples
See also an examples in [test/examples/](/test/examples/) for SQLite database
engine:
- `sqlite-rw-register.lua` contains a simple test that concurrently runs `get`
and `set` operations on SQLite DB
- `sqlite-list-append.lua` contains a simple test that concurrently runs `read`
and `append` operations on SQLite DB
For running examples you need installed an SQLite development package and
[LuaRocks](https://github.com/luarocks/luarocks/wiki/Download).
```sh
$ sudo apt install -y sqlite3 libsqlite3-dev
$ make deps
$ make test-example
```
Example produces two files with history: `history.txt` and `history.json`. With
[elle-cli](https://github.com/ligurio/elle-cli#usage) history can be checked
for consistency:
```sh
$ VER=0.1.4
$ curl -O -L https://github.com/ligurio/elle-cli/releases/download/${VER}/elle-cli-bin-${VER}.zip
$ unzip elle-cli-bin-${VER}.zip
$ java -jar ./target/elle-cli-${VER}-standalone.jar -m elle-rw-register history.json
history.json true
```
See tests that uses Molly library in https://github.com/ligurio/molly-tests.
### Hacking
For developing `molly` you need to install: either LuaJIT or LuaJIT-based
and [LuaRocks](https://github.com/luarocks/luarocks/wiki/Download).
```sh
$ make deps
$ export PATH=$PATH:$(luarocks path --lr-bin)
$ make check
$ make test
```
You are ready to make patches!
### License
Copyright © 2021-2024 [Sergey Bronnikov](https://bronevichok.ru/)
Distributed under the ISC License.