summaryrefslogtreecommitdiff
path: root/tests/README-DEBUG-TESTS.md
blob: 731012302dae43a554856c3f0f6fab04cba248c6 (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
81
82
# Wttrin Debug Integration Tests

This directory contains comprehensive integration tests with debug logging enabled.

## Running the Tests

```bash
cd /path/to/wttrin
emacs --batch --eval "(progn
  (package-initialize)
  (add-to-list 'load-path \".\")
  (setq wttrin-debug t)
  (load-file \"wttrin.el\")
  (load-file \"tests/test-wttrin-integration-with-debug.el\")
  (ert-run-tests-batch-and-exit))"
```

## What the Tests Show

The integration tests demonstrate:

1. **Debug logging captures all key events**:
   - URL fetch starting
   - Data received (with byte count)
   - Mode-line display updates
   - Emoji extraction
   - Error handling

2. **Example debug output from a successful fetch**:
```
[wttrin-debug 11:51:46.490] mode-line-fetch: Starting fetch for Berkeley, CA
[wttrin-debug 11:51:46.490] mode-line-fetch: URL = https://wttr.in/Berkeley%2C%20CA?m&format=%l:+%c+%t+%C
[wttrin-debug 11:51:46.490] mode-line-fetch: Received data = "Berkeley, CA: ☀️ +62°F Clear"
[wttrin-debug 11:51:46.490] mode-line-display: Updating display with: "Berkeley, CA: ☀️ +62°F Clear"
[wttrin-debug 11:51:46.490] mode-line-display: Extracted emoji = "☀", font = Noto Color Emoji
[wttrin-debug 11:51:46.490] mode-line-display: Complete. mode-line-string set = YES
```

## Using Debug Mode in Your Configuration

### Enable Debug Before Loading

```emacs-lisp
;; In your init.el, BEFORE (require 'wttrin):
(setq wttrin-debug t)
(require 'wttrin)
```

### Or Enable Later

```emacs-lisp
M-x debug-wttrin-enable
```

### View Debug Log

```emacs-lisp
M-x wttrin--debug-show-log
```

This opens a buffer showing all debug events with timestamps.

### Clear Debug Log

```emacs-lisp
M-x wttrin--debug-clear-log
```

## Test Fixtures

- `fixtures/test-init.el` - Minimal init file with debug enabled for manual testing

## Troubleshooting

If wttrin isn't loading in your configuration:

1. **Enable debug mode** (set `wttrin-debug` to `t` before loading)
2. **Check dependencies**: Run `M-x package-list-packages` and ensure `xterm-color` is installed
3. **View debug log**: Run `M-x wttrin--debug-show-log` after trying to use wttrin
4. **Check for errors**: Look in `*Messages*` buffer for any error messages

The debug log will show you exactly where the process stops or fails.