-
Notifications
You must be signed in to change notification settings - Fork 12.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Migrate
run-make/rustdoc-verify-output-files
to rmake.rs
- Loading branch information
1 parent
f0ab814
commit bdf3864
Showing
3 changed files
with
49 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
use std::fs::copy; | ||
use std::path::{Path, PathBuf}; | ||
|
||
use run_make_support::{copy_dir_all, recursive_diff, rustdoc, tmp_dir}; | ||
|
||
#[derive(PartialEq)] | ||
enum JsonOutput { | ||
Yes, | ||
No, | ||
} | ||
|
||
fn generate_docs(out_dir: &Path, json_output: JsonOutput) { | ||
let mut rustdoc = rustdoc(); | ||
rustdoc.input("src/lib.rs").crate_name("foobar").crate_type("lib").out_dir(&out_dir); | ||
if json_output == JsonOutput::Yes { | ||
rustdoc.arg("-Zunstable-options").output_format("json"); | ||
} | ||
rustdoc.run(); | ||
} | ||
|
||
fn main() { | ||
let out_dir = tmp_dir().join("rustdoc"); | ||
let tmp_out_dir = tmp_dir().join("tmp-rustdoc"); | ||
|
||
// Generate HTML docs. | ||
generate_docs(&out_dir, JsonOutput::No); | ||
|
||
// Copy first output for to check if it's exactly same after second compilation. | ||
copy_dir_all(&out_dir, &tmp_out_dir); | ||
|
||
// Generate html docs once again on same output. | ||
generate_docs(&out_dir, JsonOutput::No); | ||
|
||
// Generate json doc on the same output. | ||
generate_docs(&out_dir, JsonOutput::Yes); | ||
|
||
// Check if expected json file is generated. | ||
assert!(out_dir.join("foobar.json").is_file()); | ||
|
||
// Copy first json output to check if it's exactly same after second compilation. | ||
copy(out_dir.join("foobar.json"), tmp_out_dir.join("foobar.json")).unwrap(); | ||
|
||
// Generate json doc on the same output. | ||
generate_docs(&out_dir, JsonOutput::Yes); | ||
|
||
// Check if all docs(including both json and html formats) are still the same after multiple | ||
// compilations. | ||
recursive_diff(&out_dir, &tmp_out_dir); | ||
} |