jesus/mdbook
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1
mdbook/tests/testsuite/theme.rs

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

179 lines
5.3 KiB
Rust
Raw Permalink Normal View History

Migrate missing theme to BookTest
2025-04-22 11:05:48 -07:00
//! Tests for theme handling.
use crate::prelude::*;
// Checks what happens if the theme directory is missing.
#[test]
fn missing_theme() {
Switch from log to tracing This switches to using the tracing crate instead of log. Tracing provides a lot of nice features which we can take advantage of moving forward. This also adjusts the output fairly significantly. This includes: - Switched the environment variable from RUST_LOG to MDBOOK_LOG. - Dropped the timestamp. I experimented with various different time displays, but ultimately decided to omit it for now. I don't think I've ever found it to be useful, and it takes up a very significant amount of space. It could potentially be useful for basic profiling, but I think there are other, better mechanisms for that. We could consider leveraging tracing itself for doing some basic profiling (like using something like tracing-chrome). - Dropped the target unless MDBOOK_LOG is set. The target tends to be pretty noisy, and doesn't really convey much information unless you are debugging or otherwise trying to adjust the log output. - Added color. - Slightly reworked the way the error cause trace is displayed. - Slightly changed the way html5ever filtering is done, as well as add handlebars to the list since they both are very noisy. You can override this now by explicitly listing them as targets. I still expect that mdbook will eventually change how it displays things to the console, possibly switching away from tracing and printing things itself. However, that is a larger project for the future.
2025-09-12 06:13:45 -07:00
BookTest::from_dir("theme/missing_theme").run("build", |cmd| {
cmd.expect_failure().expect_stderr(str![[r#"
INFO Book building has started
INFO Running the html backend
ERROR Rendering failed
[TAB]Caused by: theme dir [ROOT]/./non-existent-directory does not exist
Migrate missing theme to BookTest
2025-04-22 11:05:48 -07:00
"#]]);
});
}
Migrate empty theme to BookTest
2025-04-22 11:06:48 -07:00
// Checks what happens if the theme directory is empty.
#[test]
fn empty_theme() {
BookTest::from_dir("theme/empty_theme").run("build", |cmd| {
std::fs::create_dir(cmd.dir.join("theme")).unwrap();
cmd.expect_stderr(str![[r#"
Switch from log to tracing This switches to using the tracing crate instead of log. Tracing provides a lot of nice features which we can take advantage of moving forward. This also adjusts the output fairly significantly. This includes: - Switched the environment variable from RUST_LOG to MDBOOK_LOG. - Dropped the timestamp. I experimented with various different time displays, but ultimately decided to omit it for now. I don't think I've ever found it to be useful, and it takes up a very significant amount of space. It could potentially be useful for basic profiling, but I think there are other, better mechanisms for that. We could consider leveraging tracing itself for doing some basic profiling (like using something like tracing-chrome). - Dropped the target unless MDBOOK_LOG is set. The target tends to be pretty noisy, and doesn't really convey much information unless you are debugging or otherwise trying to adjust the log output. - Added color. - Slightly reworked the way the error cause trace is displayed. - Slightly changed the way html5ever filtering is done, as well as add handlebars to the list since they both are very noisy. You can override this now by explicitly listing them as targets. I still expect that mdbook will eventually change how it displays things to the console, possibly switching away from tracing and printing things itself. However, that is a larger project for the future.
2025-09-12 06:13:45 -07:00
INFO Book building has started
INFO Running the html backend
INFO HTML book written to `[ROOT]/book`
Migrate empty theme to BookTest
2025-04-22 11:06:48 -07:00
"#]]);
});
}
Migrate theme_dir_overrides_work_correctly to BookTest
2025-04-22 11:08:23 -07:00
// Checks overriding index.hbs.
#[test]
fn override_index() {
BookTest::from_dir("theme/override_index").check_file(
"book/index.html",
str![[r#"
This is a modified index.hbs!
"#]],
);
}
Migrate (no theme) default fonts to BookTest
2025-04-22 11:09:20 -07:00
// After building, what are the default set of fonts?
#[test]
fn default_fonts() {
BookTest::init(|_| {})
Enable hash-files by default This enables the hash-files setting by default. We have been running it for a while, and it seems most of the issues have been resolved. This should help with more reliably loading content like the toc contents.
2025-08-26 15:58:18 -07:00
.check_file_contains("book/index.html", "fonts/fonts-[..].css")
Migrate (no theme) default fonts to BookTest
2025-04-22 11:09:20 -07:00
.check_file_list(
"book/fonts",
str![[r#"
book/fonts/OPEN-SANS-LICENSE.txt
book/fonts/SOURCE-CODE-PRO-LICENSE.txt
Enable hash-files by default This enables the hash-files setting by default. We have been running it for a while, and it seems most of the issues have been resolved. This should help with more reliably loading content like the toc contents.
2025-08-26 15:58:18 -07:00
book/fonts/fonts-[..].css
book/fonts/open-sans-v17-all-charsets-300-[..].woff2
book/fonts/open-sans-v17-all-charsets-300italic-[..].woff2
book/fonts/open-sans-v17-all-charsets-600-[..].woff2
book/fonts/open-sans-v17-all-charsets-600italic-[..].woff2
book/fonts/open-sans-v17-all-charsets-700-[..].woff2
book/fonts/open-sans-v17-all-charsets-700italic-[..].woff2
book/fonts/open-sans-v17-all-charsets-800-[..].woff2
book/fonts/open-sans-v17-all-charsets-800italic-[..].woff2
book/fonts/open-sans-v17-all-charsets-italic-[..].woff2
book/fonts/open-sans-v17-all-charsets-regular-[..].woff2
book/fonts/source-code-pro-v11-all-charsets-500-[..].woff2
Migrate (no theme) default fonts to BookTest
2025-04-22 11:09:20 -07:00
"#]],
);
}
Migrate copy theme default fonts to BookTest
2025-04-22 11:10:20 -07:00
// When the theme is initialized, what does the fonts list look like?
#[test]
fn theme_fonts_copied() {
BookTest::init(|bb| {
bb.copy_theme(true);
})
Enable hash-files by default This enables the hash-files setting by default. We have been running it for a while, and it seems most of the issues have been resolved. This should help with more reliably loading content like the toc contents.
2025-08-26 15:58:18 -07:00
.check_file_contains("book/index.html", "fonts/fonts-[..].css")
Migrate copy theme default fonts to BookTest
2025-04-22 11:10:20 -07:00
.check_file_list(
"theme/fonts",
str![[r#"
theme/fonts/OPEN-SANS-LICENSE.txt
theme/fonts/SOURCE-CODE-PRO-LICENSE.txt
theme/fonts/fonts.css
theme/fonts/open-sans-v17-all-charsets-300.woff2
theme/fonts/open-sans-v17-all-charsets-300italic.woff2
theme/fonts/open-sans-v17-all-charsets-600.woff2
theme/fonts/open-sans-v17-all-charsets-600italic.woff2
theme/fonts/open-sans-v17-all-charsets-700.woff2
theme/fonts/open-sans-v17-all-charsets-700italic.woff2
theme/fonts/open-sans-v17-all-charsets-800.woff2
theme/fonts/open-sans-v17-all-charsets-800italic.woff2
theme/fonts/open-sans-v17-all-charsets-italic.woff2
theme/fonts/open-sans-v17-all-charsets-regular.woff2
theme/fonts/source-code-pro-v11-all-charsets-500.woff2
"#]],
)
Enable hash-files by default This enables the hash-files setting by default. We have been running it for a while, and it seems most of the issues have been resolved. This should help with more reliably loading content like the toc contents.
2025-08-26 15:58:18 -07:00
// Note that license files get hashed, which is not like the behavior when
// the theme directory is empty. It kinda makes sense, but is weird.
Migrate copy theme default fonts to BookTest
2025-04-22 11:10:20 -07:00
.check_file_list(
"book/fonts",
str![[r#"
Enable hash-files by default This enables the hash-files setting by default. We have been running it for a while, and it seems most of the issues have been resolved. This should help with more reliably loading content like the toc contents.
2025-08-26 15:58:18 -07:00
book/fonts/OPEN-SANS-LICENSE-[..].txt
book/fonts/SOURCE-CODE-PRO-LICENSE-[..].txt
book/fonts/fonts-[..].css
book/fonts/open-sans-v17-all-charsets-300-[..].woff2
book/fonts/open-sans-v17-all-charsets-300italic-[..].woff2
book/fonts/open-sans-v17-all-charsets-600-[..].woff2
book/fonts/open-sans-v17-all-charsets-600italic-[..].woff2
book/fonts/open-sans-v17-all-charsets-700-[..].woff2
book/fonts/open-sans-v17-all-charsets-700italic-[..].woff2
book/fonts/open-sans-v17-all-charsets-800-[..].woff2
book/fonts/open-sans-v17-all-charsets-800italic-[..].woff2
book/fonts/open-sans-v17-all-charsets-italic-[..].woff2
book/fonts/open-sans-v17-all-charsets-regular-[..].woff2
book/fonts/source-code-pro-v11-all-charsets-500-[..].woff2
Migrate copy theme default fonts to BookTest
2025-04-22 11:10:20 -07:00
"#]],
);
}
Migrate custom fonts.css to BookTest
2025-04-22 11:12:01 -07:00
// Custom fonts.css.
#[test]
fn fonts_css() {
BookTest::from_dir("theme/fonts_css")
Enable hash-files by default This enables the hash-files setting by default. We have been running it for a while, and it seems most of the issues have been resolved. This should help with more reliably loading content like the toc contents.
2025-08-26 15:58:18 -07:00
.check_file_contains("book/index.html", "fonts/fonts-[..].css")
Migrate custom fonts.css to BookTest
2025-04-22 11:12:01 -07:00
.check_file(
Enable hash-files by default This enables the hash-files setting by default. We have been running it for a while, and it seems most of the issues have been resolved. This should help with more reliably loading content like the toc contents.
2025-08-26 15:58:18 -07:00
"book/fonts/fonts-*.css",
Migrate custom fonts.css to BookTest
2025-04-22 11:12:01 -07:00
str![[r#"
/*custom*/
"#]],
)
Enable hash-files by default This enables the hash-files setting by default. We have been running it for a while, and it seems most of the issues have been resolved. This should help with more reliably loading content like the toc contents.
2025-08-26 15:58:18 -07:00
.check_file("book/fonts/myfont-*.woff", str![[""]])
Migrate custom fonts.css to BookTest
2025-04-22 11:12:01 -07:00
.check_file_list(
"book/fonts",
str![[r#"
Enable hash-files by default This enables the hash-files setting by default. We have been running it for a while, and it seems most of the issues have been resolved. This should help with more reliably loading content like the toc contents.
2025-08-26 15:58:18 -07:00
book/fonts/fonts-[..].css
book/fonts/myfont-[..].woff
Migrate custom fonts.css to BookTest
2025-04-22 11:12:01 -07:00
"#]],
);
}
Copy copy-fonts=false no theme to BookTest
2025-04-22 11:12:30 -07:00
Remove copy-fonts This removes the deprecated `output.html.copy-fonts` option. This was deprecated in https://github.com/rust-lang/mdBook/pull/1987. The behavior now is that the default fonts are copied over unless there is a custom `theme/fonts/fonts.css` file.
2025-08-12 17:55:41 -07:00
// Empty fonts.css should not copy the default fonts.
Copy copy-fonts=false no theme to BookTest
2025-04-22 11:12:30 -07:00
#[test]
Remove copy-fonts This removes the deprecated `output.html.copy-fonts` option. This was deprecated in https://github.com/rust-lang/mdBook/pull/1987. The behavior now is that the default fonts are copied over unless there is a custom `theme/fonts/fonts.css` file.
2025-08-12 17:55:41 -07:00
fn empty_fonts_css() {
BookTest::from_dir("theme/empty_fonts_css")
Copy copy-fonts=false no theme to BookTest
2025-04-22 11:12:30 -07:00
.run("build", |cmd| {
cmd.expect_stderr(str![[r#"
Switch from log to tracing This switches to using the tracing crate instead of log. Tracing provides a lot of nice features which we can take advantage of moving forward. This also adjusts the output fairly significantly. This includes: - Switched the environment variable from RUST_LOG to MDBOOK_LOG. - Dropped the timestamp. I experimented with various different time displays, but ultimately decided to omit it for now. I don't think I've ever found it to be useful, and it takes up a very significant amount of space. It could potentially be useful for basic profiling, but I think there are other, better mechanisms for that. We could consider leveraging tracing itself for doing some basic profiling (like using something like tracing-chrome). - Dropped the target unless MDBOOK_LOG is set. The target tends to be pretty noisy, and doesn't really convey much information unless you are debugging or otherwise trying to adjust the log output. - Added color. - Slightly reworked the way the error cause trace is displayed. - Slightly changed the way html5ever filtering is done, as well as add handlebars to the list since they both are very noisy. You can override this now by explicitly listing them as targets. I still expect that mdbook will eventually change how it displays things to the console, possibly switching away from tracing and printing things itself. However, that is a larger project for the future.
2025-09-12 06:13:45 -07:00
INFO Book building has started
INFO Running the html backend
INFO HTML book written to `[ROOT]/book`
Copy copy-fonts=false no theme to BookTest
2025-04-22 11:12:30 -07:00
"#]]);
})
Remove copy-fonts This removes the deprecated `output.html.copy-fonts` option. This was deprecated in https://github.com/rust-lang/mdBook/pull/1987. The behavior now is that the default fonts are copied over unless there is a custom `theme/fonts/fonts.css` file.
2025-08-12 17:55:41 -07:00
.check_file_contains("book/index.html", "fonts.css")
Migrate copy-fonts=false empty fonts.css to BookTest
2025-04-22 11:13:03 -07:00
.check_file_list("book/fonts", str![[""]]);
}
Migrate custom fonts with filled fonts.css to BookTest
2025-04-22 11:13:39 -07:00
Remove copy-fonts This removes the deprecated `output.html.copy-fonts` option. This was deprecated in https://github.com/rust-lang/mdBook/pull/1987. The behavior now is that the default fonts are copied over unless there is a custom `theme/fonts/fonts.css` file.
2025-08-12 17:55:41 -07:00
// Custom fonts.css file shouldn't copy default fonts.
Migrate custom fonts with filled fonts.css to BookTest
2025-04-22 11:13:39 -07:00
#[test]
Remove copy-fonts This removes the deprecated `output.html.copy-fonts` option. This was deprecated in https://github.com/rust-lang/mdBook/pull/1987. The behavior now is that the default fonts are copied over unless there is a custom `theme/fonts/fonts.css` file.
2025-08-12 17:55:41 -07:00
fn custom_fonts_css() {
BookTest::from_dir("theme/custom_fonts_css")
Migrate custom fonts with filled fonts.css to BookTest
2025-04-22 11:13:39 -07:00
.run("build", |cmd| {
cmd.expect_stderr(str![[r#"
Switch from log to tracing This switches to using the tracing crate instead of log. Tracing provides a lot of nice features which we can take advantage of moving forward. This also adjusts the output fairly significantly. This includes: - Switched the environment variable from RUST_LOG to MDBOOK_LOG. - Dropped the timestamp. I experimented with various different time displays, but ultimately decided to omit it for now. I don't think I've ever found it to be useful, and it takes up a very significant amount of space. It could potentially be useful for basic profiling, but I think there are other, better mechanisms for that. We could consider leveraging tracing itself for doing some basic profiling (like using something like tracing-chrome). - Dropped the target unless MDBOOK_LOG is set. The target tends to be pretty noisy, and doesn't really convey much information unless you are debugging or otherwise trying to adjust the log output. - Added color. - Slightly reworked the way the error cause trace is displayed. - Slightly changed the way html5ever filtering is done, as well as add handlebars to the list since they both are very noisy. You can override this now by explicitly listing them as targets. I still expect that mdbook will eventually change how it displays things to the console, possibly switching away from tracing and printing things itself. However, that is a larger project for the future.
2025-09-12 06:13:45 -07:00
INFO Book building has started
INFO Running the html backend
INFO HTML book written to `[ROOT]/book`
Migrate custom fonts with filled fonts.css to BookTest
2025-04-22 11:13:39 -07:00
"#]]);
})
Enable hash-files by default This enables the hash-files setting by default. We have been running it for a while, and it seems most of the issues have been resolved. This should help with more reliably loading content like the toc contents.
2025-08-26 15:58:18 -07:00
.check_file_contains("book/index.html", "fonts-[..].css")
Migrate custom fonts with filled fonts.css to BookTest
2025-04-22 11:13:39 -07:00
.check_file_list(
"book/fonts",
str![[r#"
Enable hash-files by default This enables the hash-files setting by default. We have been running it for a while, and it seems most of the issues have been resolved. This should help with more reliably loading content like the toc contents.
2025-08-26 15:58:18 -07:00
book/fonts/fonts-[..].css
book/fonts/myfont-[..].woff
Migrate custom fonts with filled fonts.css to BookTest
2025-04-22 11:13:39 -07:00
"#]],
);
}
Reference in a new issue Copy permalink