testutils 0.0.12

Offers a range of utility functions, macros, and tools, such as `simple_benchmark()` and `dbg_ref!()`, `os_cmd::Runner`, designed for testing purposes.
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

//! ```ignore, sh
//! cargo open-doc
//! ```
use std::io;

use testutils::{
  get_pkg_name,
  os_cmd::{self, RunnableCommand, Runner, presets::CargoDoc},
  tap::{Pipe, Tap},
};

#[ignore]
#[test]
fn build_doc() -> io::Result<()> {
  let build = |pkg| {
    CargoDoc::default()
      .with_pkg(pkg)
      .with_enable_private_items(false)
      // .with_all_features(false)
      .with_open(false) // Disable to maintain compatibility with remote SSH.
      .into_tinyvec()
      .pipe(os_cmd::run)
  };

  get_pkg_name!().pipe(build)
}

/// Uses `miniserve` instead of `.with_open(true)` on CargoDoc to ensure
/// compatibility with Remote-SSH.
#[ignore]
#[test]
fn serve_doc() -> io::Result<()> {
  build_doc()?;

  let dir = env!("CARGO_MANIFEST_DIR");
  let pkg = get_pkg_name!();

  format!(
    "miniserve
    {dir:?}/target/doc
    --index {pkg}/index.html
    ",
  )
  .pipe_deref(Runner::from)
  .tap(|_| eprintln!("\x1b[35mhttp://127.0.0.1:8080/{pkg}/index.html\x1b[0m"))
  .run()
  .inspect_err(|e| eprintln!("{e:?};\n cargo binstall miniserve"))
}