wdl-doc 0.2.0

Documentation generator for Workflow Description Language (WDL) documents.
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

//! The wdl-doc tests.
//!
//! This test documents the contents of the `tests/codebase` directory.
//!
//! The built docs are expected to be in the `tests/output_docs` directory.
//!
//! The docs may be automatically generated or updated by
//! setting the `BLESS` environment variable when running this test.

use std::env;
use std::fs;
use std::io;
use std::path::Path;
use std::process::exit;

use wdl_doc::document_workspace;

/// Copied from https://stackoverflow.com/a/65192210
fn copy_dir_all(src: impl AsRef<Path>, dst: impl AsRef<Path>) -> io::Result<()> {
    fs::create_dir_all(&dst)?;
    for entry in fs::read_dir(src)? {
        let entry = entry?;
        let ty = entry.file_type()?;
        if ty.is_dir() {
            copy_dir_all(entry.path(), dst.as_ref().join(entry.file_name()))?;
        } else {
            fs::copy(entry.path(), dst.as_ref().join(entry.file_name()))?;
        }
    }
    Ok(())
}

#[tokio::main]
async fn main() {
    #[cfg(not(windows))]
    let test_dir = Path::new("tests/codebase");
    #[cfg(not(windows))]
    let docs_dir = Path::new("tests/output_docs");

    #[cfg(windows)]
    let test_dir = Path::new("tests\\codebase");
    #[cfg(windows)]
    let docs_dir = Path::new("tests\\output_docs");

    // If `tests/codebase/docs` exists, delete it
    if test_dir.join("docs").exists() {
        fs::remove_dir_all(test_dir.join("docs")).unwrap();
    }

    match document_workspace(test_dir.to_path_buf(), None::<&str>, true).await {
        Ok(_) => {
            println!("Successfully generated docs");
        }
        Err(e) => {
            eprintln!("Failed to generate docs: {}", e);
            exit(1);
        }
    }

    // If the `BLESS` environment variable is set, update the expected output
    // by deleting the contents of the `tests/output_docs` directory and
    // repopulating it with the generated docs (at `tests/codebase/docs/`).
    if env::var("BLESS").is_ok() {
        if docs_dir.exists() {
            fs::remove_dir_all(docs_dir).unwrap();
        }
        fs::create_dir_all(docs_dir).unwrap();
        copy_dir_all(test_dir.join("docs"), docs_dir).unwrap();

        println!("Blessed docs");
        exit(0);
    }

    // Compare the generated docs with the expected output
    // For now, check that the paths exist as expected.
    // TODO: check HTML content.
    let mut success = true;
    for entry in fs::read_dir(docs_dir).unwrap() {
        let entry = entry.unwrap();
        let path = entry.path();
        // Normalize the path to be relative to the `docs` directory
        // regardless of OS path separator.
        let expected_path = test_dir
            .join("docs")
            .join(path.strip_prefix(docs_dir).unwrap());
        if !expected_path.exists() {
            eprintln!("Expected path does not exist: {}", expected_path.display());
            success = false;
        }
    }

    if success {
        println!("Docs are as expected");
        exit(0);
    } else {
        exit(1);
    }
}