summaryrefslogtreecommitdiff
path: root/archived/projt-launcher/docs/handbook/bzip2-tests.md
blob: a81fee0449695eabd2b084cfecee2b98f941607f (plain)
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
# Bzip2 Tests

> **Directory**: `bzip2/`  
> **Test Suites**: Quick (default), Large
> **Latest Version**: 0.0.5-1

---

## Overview

Bzip2 has two test suites for validating compression and decompression functionality.

---

## Test Suites

| Suite | Files | Speed | Valgrind |
|-------|-------|-------|----------|
| **Quick** | Small set | Fast (~seconds) | ✅ Enabled |
| **Large** | Many files | Slow (~minutes) | ❌ Disabled |

---

## Quick Test Suite

The default test suite validates basic functionality:

### What It Tests

1. **Compression** — Compress reference files, decompress, verify match
2. **Decompression** — Decompress `.bz2` files, verify against reference
3. **Multiple modes** — Tests various compression levels

### Running

```bash
# CMake
cd bzip2/build
ctest -V

# Meson
meson test -C builddir --print-errorlogs
```

---

## Large Test Suite

Comprehensive test with files from various sources:

### Contents

- ✅ Good `.bz2` files — Should decompress correctly
- ❌ Bad `.bz2.bad` files — Should fail gracefully

### Running

Integrated with the build system test commands.

---

## Valgrind Integration

The quick tests run under Valgrind if available:

```bash
# Check if Valgrind is detected
cmake .. -DCMAKE_BUILD_TYPE=Debug
# Valgrind runs automatically during ctest
```

The large tests have Valgrind disabled (would take 35+ minutes).

---

## Related Documentation

- [Bzip2 Overview](./bzip2.md) — Main documentation
- [Compiling](./bzip2-compiling.md) — Build instructions
- [Test Files](./bzip2-testfiles.md) — Test file collection