mumu-test 0.1.2

Test suite plugin for the Lava language
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

# mumu-test

**Test suite plugin for the Lava language**  
[![MIT OR Apache-2.0 licensed](https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue.svg)](LICENSE)

---

## Overview

`mumu-test` is a native plugin for the Lava/MuMu scripting language providing a full-featured test suite runner, test description framework (`describe`/`it`), file assertions, error checks, and test helpers for robust automated testing of Lava plugins, scripts, and applications.

- Write tests in Lava/MuMu using familiar constructs
- Get pretty console reports (with color and clipboard debugging)
- Assert deep equality, error conditions, and file state
- Create test files and temp data easily from Lava/MuMu code

---

## Features

- **`describe` / `it`**: Organize tests in suites
- **Expectations**: `expect_equal`, `expect_not_equal`, `prop_equals`, `has_key`, `test:expect_error`
- **File assertions**: `file_contents_equal`, `file_contents_not_equal`, `file_contents_length_equal`
- **Helpers**: `test:lorem_file` (create lorem test files), `test:unique_filename`
- **Batch runner**: Run all `tests/*.mu` files and see summaries
- **Clipboard debugging**: Output of failing test files copied for quick pasting
- **JSON output**: Suite/test results as JSON lines (for CI/automation)

---

## Installation

Build the plugin as a shared library (`.so`):

```sh
make
make install
```

This copies `libmumutest.so` to `/usr/local/lib/`, as expected by the Lava/MuMu runtime.

---

## Usage

1. **Enable the plugin in Lava/MuMu:**
    ```lava
    > extend("test")
    ```

2. **Write a test file (e.g., `tests/hello_test.mu`):**
    ```lava
    describe("Sample suite", fn() {
      it("should add numbers", fn() {
        expect_equal(1 + 1, 2)
      })

      it("should fail gracefully", fn() {
        expect_not_equal("a", "b")
      })

      it("should throw error", fn() {
        test:expect_error(fn() {
          error("bad wolf")
        }, "wolf")
      })
    })
    ```

3. **Run all tests from CLI:**
    ```sh
    lava -e 'test:all(fn(pass) { log(pass) })'
    ```

    - **Or run a single file:**
      ```sh
      lava tests/hello_test.mu
      ```

---

## API

- **describe(suite_name: string, fn)**
- **it(test_name: string, fn)**
- **expect_equal(actual, expected)**
- **expect_not_equal(actual, expected)**
- **has_key(keyed_array, key)**
- **prop_equals(keyed_array, key, expected_value)**
- **test:expect_error(fn, [optional substring])**
- **file_contents_equal(filename, expected_string)**
- **file_contents_not_equal(filename, unexpected_string)**
- **file_contents_length_equal(filename, expected_len)**
- **test:lorem_file(n_chars)**
- **test:unique_filename()**
- **test:all([opts], callback)**
- **test:run(filename, callback)**

See the source for full parameter details and advanced options.

---

## License

Dual-licensed under **MIT** or **Apache-2.0** (see [LICENSE](LICENSE)).

© 2025 Tom Fotheringham and contributors

---

## Links

- [Lava language website](https://lava.nu11.uk)
- [Plugin repository](https://gitlab.com/tofo/mumu-test)