diplodocus 0.15.0

Build coherent documentation websites for polyglot software projects.
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
mod support;

use diplodocus::assembly::assemble_workspace;
use diplodocus::commands::{GenerateOptions, generate};
use diplodocus::ir::ProvenanceActivity;
use diplodocus::snapshots::Snapshot;
use diplodocus::validation::resolve_workspace;
use std::fs;
use std::process::{Command, Output};

fn workspace(language: &str, documentation: &str) -> support::TestWorkspace {
    let root = support::TestWorkspace::new();
    let (metadata, entry, package_name) = if language == "python" {
        ("pyproject.toml", "src/apiex", "apiex")
    } else {
        ("Project.toml", "src/ApiExamples.jl", "ApiExamples")
    };
    root.write("diplodocus.yaml", format!("project:\n  name: \"API examples\"\nrepositories:\n  - id: \"repo\"\n    path: \"repo\"\npackages:\n  - id: \"api\"\n    name: \"API examples\"\n    slug: \"api\"\n    ecosystem: \"{language}\"\n    repository: \"repo\"\n    path: \".\"\n    metadata-path: \"{metadata}\"\n    targets:\n      - id: \"api\"\n        extractor: \"{language}\"\n        path: \"{entry}\"\n        role: \"public-api\"\n"));
    if language == "python" {
        root.write(
            "repo/pyproject.toml",
            "[project]\nname='apiex'\nversion='0.1.0'\n",
        );
        root.write("repo/src/apiex/__init__.py", format!("__all__ = ['answer', 'other']\ndef answer():\n    \"\"\"An answer.\n\n    Examples\n    --------\n{documentation}\n    \"\"\"\n    return 42\ndef other():\n    \"\"\"Another answer.\n\n    Examples\n    --------\n    >>> 'shared' in globals()\n    False\n    \"\"\"\n    return 24\n"));
    } else {
        root.write("repo/Project.toml", format!("name='{package_name}'\nuuid='556f29ba-a5ad-4973-b428-a6fb30b48c51'\nversion='0.1.0'\n"));
        root.write("repo/src/ApiExamples.jl", format!("module ApiExamples\nexport answer, other\n\"\"\"\nAn answer.\n\n{documentation}\n\"\"\"\nanswer() = 42\n\"\"\"\nAnother answer.\n\n```jldoctest\njulia> isdefined(@__MODULE__, :shared)\nfalse\n```\n\"\"\"\nother() = 24\nend\n"));
    }
    root
}

fn command(root: &support::TestWorkspace, operation: &str) -> Output {
    Command::new(env!("CARGO_BIN_EXE_diplodocus"))
        .current_dir(root.path())
        .args([operation, "--config", "diplodocus.yaml"])
        .output()
        .unwrap()
}

fn success(output: Output) {
    assert!(
        output.status.success(),
        "{}",
        String::from_utf8_lossy(&output.stderr)
    );
}

const PYTHON: &str = "    >>> shared = answer()\n    >>> shared + 1\n    43\n    >>> print('a  b')  # doctest: +NORMALIZE_WHITESPACE\n    a b\n    >>> raise ValueError('expected')\n    Traceback (most recent call last):\n    ...\n    ValueError: expected\n    >>> raise RuntimeError('must stay inert')  # doctest: +SKIP\n";

const JULIA: &str = r#"```jldoctest state; setup = :(nothing), teardown = :(nothing), output = false
julia> shared = answer();

julia> shared + 1
43

julia> error("expected")
ERROR: expected
[...]
```

```jldoctest state
julia> shared
42
```

```jldoctest
answer() + 2
# output
44
```

```jldoctest
julia> isdefined(@__MODULE__, :shared)
false
```"#;

#[test]
fn native_doctests_verify_state_expected_errors_and_portable_outcomes() {
    for (language, documentation) in [("python", PYTHON), ("julia", JULIA)] {
        let root = workspace(language, documentation);
        success(command(&root, "check"));
        let sources = assemble_workspace(root.path().join("diplodocus.yaml")).unwrap();
        assert!(
            sources.workspace().packages["api"]
                .items
                .values()
                .filter_map(|item| item.documentation.as_ref())
                .flat_map(|d| &d.provenance)
                .all(|p| !matches!(p.activity, ProvenanceActivity::ApiExamples { .. }))
        );
        success(command(&root, "build"));
        let database = root.path().join(".diplodocus/documentation.sqlite");
        let snapshot = Snapshot::load(&database).unwrap();
        let examples: Vec<_> = snapshot.workspace().packages["api"]
            .items
            .values()
            .filter_map(|item| item.documentation.as_ref())
            .flat_map(|d| &d.provenance)
            .filter_map(|p| match &p.activity {
                ProvenanceActivity::ApiExamples {
                    runtime_version,
                    examples,
                    ..
                } => {
                    assert!(!runtime_version.is_empty());
                    Some(examples)
                }
                _ => None,
            })
            .flatten()
            .collect();
        assert!(examples.iter().any(|e| e.actual.contains("43")));
        assert!(
            examples
                .iter()
                .any(|e| e.outcome == "expected-error" && e.actual.contains("expected"))
        );
        if language == "python" {
            assert!(
                examples
                    .iter()
                    .any(|e| e.outcome == "explicit-skip" && e.reason.is_some())
            );
        }
        assert!(
            !snapshot
                .canonical_export()
                .unwrap()
                .contains(root.path().to_str().unwrap())
        );
        let original = fs::read(root.path().join("site/packages/api/index.html")).unwrap();
        fs::remove_dir_all(root.path().join("repo")).unwrap();
        let output = Command::new(env!("CARGO_BIN_EXE_diplodocus"))
            .current_dir(root.path())
            .env("PATH", "")
            .args([
                "generate",
                "--input",
                database.to_str().unwrap(),
                "--output",
                "regenerated",
            ])
            .output()
            .unwrap();
        success(output);
        assert_eq!(
            original,
            fs::read(root.path().join("regenerated/packages/api/index.html")).unwrap()
        );
    }
}

fn assert_failed_examples_preserve_publications(language: &str, good: &str, bad: &str) {
    let root = workspace(language, good);
    let snapshot = root.path().join(".diplodocus/documentation.sqlite");
    // Native success has its own test; rollback only needs a valid existing publication.
    let sources = assemble_workspace(root.path().join("diplodocus.yaml")).unwrap();
    Snapshot::from_sources(&sources, &resolve_workspace(&sources).unwrap())
        .unwrap()
        .publish(&snapshot)
        .unwrap();
    generate(GenerateOptions {
        input: snapshot.clone(),
        output: root.path().join("site"),
    })
    .unwrap();
    let original = fs::read(&snapshot).unwrap();
    let site = fs::read(root.path().join("site/index.html")).unwrap();
    let path = if language == "python" {
        "repo/src/apiex/__init__.py"
    } else {
        "repo/src/ApiExamples.jl"
    };
    root.write(path, root.read(path).replace(good, bad));
    success(command(&root, "check"));
    let output = command(&root, "build");
    assert!(!output.status.success());
    let message = String::from_utf8_lossy(&output.stderr);
    assert!(message.contains("Expected"), "{message}");
    assert_eq!(original, fs::read(&snapshot).unwrap());
    assert_eq!(site, fs::read(root.path().join("site/index.html")).unwrap());
    let content = root.read(path).replace(bad, good);
    root.write(
        path,
        if language == "python" {
            content.replace("    return 42", "    raise RuntimeError('broken')")
        } else {
            content.replace("answer() = 42", "answer() = error(\"broken\")")
        },
    );
    let output = command(&root, "build");
    assert!(!output.status.success());
    assert!(String::from_utf8_lossy(&output.stderr).contains("broken"));
    assert_eq!(original, fs::read(&snapshot).unwrap());
    assert_eq!(site, fs::read(root.path().join("site/index.html")).unwrap());
}

#[test]
fn python_example_failures_preserve_previous_publications() {
    assert_failed_examples_preserve_publications(
        "python",
        "    >>> answer()\n    42\n",
        "    >>> answer()\n    99\n",
    );
}

#[test]
fn julia_example_failures_preserve_previous_publications() {
    assert_failed_examples_preserve_publications(
        "julia",
        "```jldoctest\nanswer()\n# output\n42\n```",
        "```jldoctest\nanswer()\n# output\n99\n```",
    );
}

#[test]
fn unsupported_julia_executable_options_fail_extraction() {
    let root = workspace(
        "julia",
        "```jldoctest; filter = r\"x\"\nanswer()\n# output\n42\n```",
    );
    let output = command(&root, "extract");
    assert!(!output.status.success());
    assert!(String::from_utf8_lossy(&output.stderr).contains("Unsupported doctest option"));
}

#[test]
fn unavailable_interpreters_and_dependencies_are_errors_instead_of_skips() {
    for (language, documentation) in [("python", PYTHON), ("julia", JULIA)] {
        let root = workspace(language, documentation);
        let output = Command::new(env!("CARGO_BIN_EXE_diplodocus"))
            .current_dir(root.path())
            .env("PATH", "")
            .args(["extract", "--config", "diplodocus.yaml"])
            .output()
            .unwrap();
        assert!(!output.status.success());
        let expected = if language == "julia" {
            "requires Julia"
        } else {
            "requires `python`"
        };
        assert!(String::from_utf8_lossy(&output.stderr).contains(expected));
        assert!(
            !root
                .path()
                .join(".diplodocus/documentation.sqlite")
                .exists()
        );
    }
    let root = workspace("python", PYTHON);
    let path = "repo/src/apiex/__init__.py";
    root.write(
        path,
        format!(
            "import unavailable_documentation_dependency\n{}",
            root.read(path)
        ),
    );
    let checked = command(&root, "check");
    assert!(!checked.status.success());
    assert!(
        String::from_utf8_lossy(&checked.stderr).contains("unavailable_documentation_dependency")
    );
    let output = command(&root, "extract");
    assert!(!output.status.success());
    assert!(
        String::from_utf8_lossy(&output.stderr).contains("unavailable_documentation_dependency")
    );
}

#[test]
fn julia_function_overviews_include_method_prose_and_resolved_references() {
    let root = workspace(
        "julia",
        "Use [the other function](@ref other).\n\n# Details\n\nSee [details](#details).",
    );
    success(command(&root, "build"));
    let site = root.path().join("site");
    let search: serde_json::Value =
        serde_json::from_slice(&fs::read(site.join("assets/search.json")).unwrap()).unwrap();
    let entry = search
        .as_array()
        .unwrap()
        .iter()
        .find(|e| e["title"] == "ApiExamples.answer")
        .unwrap();
    let html = fs::read_to_string(site.join(entry["path"].as_str().unwrap())).unwrap();
    assert!(html.contains("An answer."));
    assert!(html.contains("the other function</a>"));
    assert!(!search.as_array().unwrap().iter().any(|e| {
        e["title"]
            .as_str()
            .is_some_and(|t| t.starts_with("ApiExamples.answer("))
    }));
    let snapshot = Snapshot::load(root.path().join(".diplodocus/documentation.sqlite")).unwrap();
    let (method_id, _) = snapshot.workspace().packages["api"]
        .items
        .iter()
        .find(|(_, item)| item.kind == diplodocus::ir::ItemKind::Method && item.name == "answer")
        .unwrap();
    let anchor = format!(
        "method-{}-details",
        diplodocus::provenance::fingerprint_bytes(method_id.as_bytes()).value
    );
    assert!(html.contains(&format!("href=\"#{anchor}\"")));
    assert!(html.contains(&format!("id=\"{anchor}\"")));
    assert!(
        entry["text"]
            .as_str()
            .unwrap()
            .contains("the other function")
    );
}

#[test]
fn native_timeouts_and_cancellation_stop_before_publication() {
    use diplodocus::commands::{ExtractOptions, extract_with};
    use diplodocus::execution::ExecutionDeadlines;
    let runtime = tokio::runtime::Runtime::new().unwrap();
    for cancel in [false, true] {
        let root = workspace("python", "    >>> while True:\n    ...     pass\n");
        let output = root.path().join("snapshot.sqlite");
        let options = ExtractOptions {
            config: root.path().join("diplodocus.yaml"),
            output: Some(output.clone()),
        };
        let deadlines = ExecutionDeadlines {
            cell: 500,
            termination: 100,
            forced_exit: 100,
            ..ExecutionDeadlines::default()
        };
        let result = runtime.block_on(extract_with(
            options,
            deadlines,
            if cancel {
                Box::pin(async { tokio::time::sleep(std::time::Duration::from_millis(100)).await })
            } else {
                Box::pin(std::future::pending())
            },
        ));
        assert!(result.is_err());
        let message = result.unwrap_err().to_string();
        assert!(
            message.contains(if cancel {
                "canceled"
            } else {
                "source diagnostics"
            }),
            "{message}"
        );
        assert!(!output.exists());
    }
}

#[test]
fn python_field_examples_use_module_globals_and_verify_package_identity() {
    let root = workspace("python", PYTHON);
    let path = "repo/src/apiex/__init__.py";
    let source = root
        .read(path)
        .replace("['answer', 'other']", "['answer', 'other', 'Model']");
    root.write(path, format!("{source}\nclass Model:\n    value: int = 42\n    \"\"\"Examples\n    --------\n    >>> Model.value\n    42\n    \"\"\"\n"));
    success(command(&root, "extract"));
    let snapshot = Snapshot::load(root.path().join(".diplodocus/documentation.sqlite")).unwrap();
    let field = snapshot.workspace().packages["api"]
        .items
        .values()
        .find(|i| i.name == "value")
        .unwrap();
    assert!(field.documentation.as_ref().unwrap().provenance.iter().any(|p|
        matches!(&p.activity, ProvenanceActivity::ApiExamples { examples, .. } if examples[0].actual == "42\n")));
    root.write(
        path,
        format!(
            "__file__ = '/unrelated/checkout/apiex.py'\n{}",
            root.read(path)
        ),
    );
    let output = command(&root, "extract");
    assert!(!output.status.success());
    assert!(
        String::from_utf8_lossy(&output.stderr).contains("does not match the supplied checkout")
    );
}

#[test]
fn python_checkouts_without_doctests_are_loaded_before_publication() {
    for broken in ["interpreter", "dependency", "checkout", "version", "empty"] {
        let root = workspace("python", "    Plain documentation.");
        let path = "repo/src/apiex/__init__.py";
        root.write(path, "__version__ = '0.1.0'\nvalue = 42\n");
        success(command(&root, "build"));
        let snapshot = root.path().join(".diplodocus/documentation.sqlite");
        let original = fs::read(&snapshot).unwrap();
        let site = fs::read(root.path().join("site/index.html")).unwrap();
        let (source, expected) = match broken {
            "dependency" => (
                "import unavailable_documentation_dependency\n",
                "unavailable_documentation_dependency",
            ),
            "checkout" => (
                "__file__ = '/unrelated/checkout/apiex.py'\n",
                "does not match the supplied checkout",
            ),
            "empty" => ("", "requires an importable module"),
            "version" => ("__version__ = '9.9.9'\n", "version conflicts"),
            _ => ("value = 42\n", "requires `python`"),
        };
        root.write(path, source);
        if broken == "empty" {
            fs::remove_file(root.path().join(path)).unwrap();
        }
        let checked = command(&root, "check");
        if broken == "interpreter" {
            success(checked);
        } else {
            assert!(!checked.status.success(), "{broken}: check");
            assert!(String::from_utf8_lossy(&checked.stderr).contains(expected));
        }
        for operation in ["extract", "build"] {
            let mut invocation = Command::new(env!("CARGO_BIN_EXE_diplodocus"));
            invocation
                .current_dir(root.path())
                .args([operation, "--config", "diplodocus.yaml"]);
            if broken == "interpreter" {
                invocation.env("PATH", "");
            }
            let output = invocation.output().unwrap();
            assert!(!output.status.success(), "{broken}: {operation}");
            let message = String::from_utf8_lossy(&output.stderr);
            assert!(message.contains(expected), "{message}");
            assert_eq!(original, fs::read(&snapshot).unwrap());
            assert_eq!(site, fs::read(root.path().join("site/index.html")).unwrap());
        }
    }
}