extern crate config; extern crate site; extern crate tempfile; use std::collections::HashMap; use std::env; use std::fs::File; use std::io::prelude::*; use std::path::Path; use config::Taxonomy; use site::Site; use tempfile::tempdir; #[test] fn can_parse_site() { let mut path = env::current_dir().unwrap().parent().unwrap().parent().unwrap().to_path_buf(); path.push("test_site"); let mut site = Site::new(&path, "config.toml").unwrap(); site.load().unwrap(); // Correct number of pages (sections do not count as pages) assert_eq!(site.library.pages().len(), 22); let posts_path = path.join("content").join("posts"); // Make sure the page with a url doesn't have any sections let url_post = site.library.get_page(&posts_path.join("fixed-url.md")).unwrap(); assert_eq!(url_post.path, "a-fixed-url/"); // Make sure the article in a folder with only asset doesn't get counted as a section let asset_folder_post = site.library.get_page(&posts_path.join("with-assets").join("index.md")).unwrap(); assert_eq!(asset_folder_post.file.components, vec!["posts".to_string()]); // That we have the right number of sections assert_eq!(site.library.sections().len(), 11); // And that the sections are correct let index_section = site.library.get_section(&path.join("content").join("_index.md")).unwrap(); assert_eq!(index_section.subsections.len(), 4); assert_eq!(index_section.pages.len(), 1); assert!(index_section.ancestors.is_empty()); let posts_section = site.library.get_section(&posts_path.join("_index.md")).unwrap(); assert_eq!(posts_section.subsections.len(), 2); assert_eq!(posts_section.pages.len(), 10); assert_eq!( posts_section.ancestors, vec![*site.library.get_section_key(&index_section.file.path).unwrap()] ); // Make sure we remove all the pwd + content from the sections let basic = site.library.get_page(&posts_path.join("simple.md")).unwrap(); assert_eq!(basic.file.components, vec!["posts".to_string()]); assert_eq!( basic.ancestors, vec![ *site.library.get_section_key(&index_section.file.path).unwrap(), *site.library.get_section_key(&posts_section.file.path).unwrap(), ] ); let tutorials_section = site.library.get_section(&posts_path.join("tutorials").join("_index.md")).unwrap(); assert_eq!(tutorials_section.subsections.len(), 2); let sub1 = site.library.get_section_by_key(tutorials_section.subsections[0]); let sub2 = site.library.get_section_by_key(tutorials_section.subsections[1]); assert_eq!(sub1.clone().meta.title.unwrap(), "Programming"); assert_eq!(sub2.clone().meta.title.unwrap(), "DevOps"); assert_eq!(tutorials_section.pages.len(), 0); let devops_section = site .library .get_section(&posts_path.join("tutorials").join("devops").join("_index.md")) .unwrap(); assert_eq!(devops_section.subsections.len(), 0); assert_eq!(devops_section.pages.len(), 2); assert_eq!( devops_section.ancestors, vec![ *site.library.get_section_key(&index_section.file.path).unwrap(), *site.library.get_section_key(&posts_section.file.path).unwrap(), *site.library.get_section_key(&tutorials_section.file.path).unwrap(), ] ); let prog_section = site .library .get_section(&posts_path.join("tutorials").join("programming").join("_index.md")) .unwrap(); assert_eq!(prog_section.subsections.len(), 0); assert_eq!(prog_section.pages.len(), 2); } // 2 helper macros to make all the build testing more bearable macro_rules! file_exists { ($root: expr, $path: expr) => {{ let mut path = $root.clone(); for component in $path.split("/") { path = path.join(component); } Path::new(&path).exists() }}; } macro_rules! file_contains { ($root: expr, $path: expr, $text: expr) => {{ let mut path = $root.clone(); for component in $path.split("/") { path = path.join(component); } let mut file = File::open(&path).unwrap(); let mut s = String::new(); file.read_to_string(&mut s).unwrap(); println!("{}", s); s.contains($text) }}; } #[test] fn can_build_site_without_live_reload() { let mut path = env::current_dir().unwrap().parent().unwrap().parent().unwrap().to_path_buf(); path.push("test_site"); let mut site = Site::new(&path, "config.toml").unwrap(); site.load().unwrap(); let tmp_dir = tempdir().expect("create temp dir"); let public = &tmp_dir.path().join("public"); site.set_output_path(&public); site.build().unwrap(); assert!(&public.exists()); assert!(file_exists!(public, "index.html")); assert!(file_exists!(public, "sitemap.xml")); assert!(file_exists!(public, "robots.txt")); assert!(file_exists!(public, "a-fixed-url/index.html")); assert!(file_exists!(public, "posts/python/index.html")); // Shortcodes work assert!(file_contains!(public, "posts/python/index.html", "Basic shortcode")); assert!(file_contains!(public, "posts/python/index.html", "Arrrh Bob")); assert!(file_contains!(public, "posts/python/index.html", "Arrrh Bob_Sponge")); assert!(file_exists!(public, "posts/tutorials/devops/nix/index.html")); assert!(file_exists!(public, "posts/with-assets/index.html")); assert!(file_exists!(public, "posts/no-section/simple/index.html")); // Sections assert!(file_exists!(public, "posts/index.html")); assert!(file_exists!(public, "posts/tutorials/index.html")); assert!(file_exists!(public, "posts/tutorials/devops/index.html")); assert!(file_exists!(public, "posts/tutorials/programming/index.html")); // Ensure subsection pages are correctly filled assert!(file_contains!(public, "posts/tutorials/index.html", "Sub-pages: 2")); // Pages and section get their relative path assert!(file_contains!(public, "posts/tutorials/index.html", "posts/tutorials/_index.md")); assert!(file_contains!( public, "posts/tutorials/devops/nix/index.html", "posts/tutorials/devops/nix.md" )); // aliases work assert!(file_exists!(public, "an-old-url/old-page/index.html")); assert!(file_contains!(public, "an-old-url/old-page/index.html", "something-else")); // html aliases work assert!(file_exists!(public, "an-old-url/an-old-alias.html")); assert!(file_contains!(public, "an-old-url/an-old-alias.html", "something-else")); // redirect_to works assert!(file_exists!(public, "posts/tutorials/devops/index.html")); assert!(file_contains!(public, "posts/tutorials/devops/index.html", "docker")); // We do have categories assert_eq!(file_exists!(public, "categories/index.html"), true); assert_eq!(file_exists!(public, "categories/a-category/index.html"), true); assert_eq!(file_exists!(public, "categories/a-category/rss.xml"), true); // But no tags assert_eq!(file_exists!(public, "tags/index.html"), false); // Theme files are there assert!(file_exists!(public, "sample.css")); assert!(file_exists!(public, "some.js")); // SASS and SCSS files compile correctly assert!(file_exists!(public, "blog.css")); assert!(file_contains!(public, "blog.css", "red")); assert!(file_contains!(public, "blog.css", "blue")); assert!(!file_contains!(public, "blog.css", "@import \"included\"")); assert!(file_contains!(public, "blog.css", "2rem")); // check include assert!(!file_exists!(public, "_included.css")); assert!(file_exists!(public, "scss.css")); assert!(file_exists!(public, "sass.css")); assert!(file_exists!(public, "nested_sass/sass.css")); assert!(file_exists!(public, "nested_sass/scss.css")); // no live reload code assert_eq!(file_contains!(public, "index.html", "/livereload.js?port=1112&mindelay=10"), false); // Both pages and sections are in the sitemap assert!(file_contains!( public, "sitemap.xml", "https://replace-this-with-your-url.com/posts/simple/" )); assert!(file_contains!( public, "sitemap.xml", "https://replace-this-with-your-url.com/posts/" )); // Drafts are not in the sitemap assert!(!file_contains!(public, "sitemap.xml", "draft")); // robots.txt has been rendered from the template assert!(file_contains!(public, "robots.txt", "User-agent: zola")); assert!(file_contains!( public, "robots.txt", "Sitemap: https://replace-this-with-your-url.com/sitemap.xml" )); } #[test] fn can_build_site_with_live_reload() { let mut path = env::current_dir().unwrap().parent().unwrap().parent().unwrap().to_path_buf(); path.push("test_site"); let mut site = Site::new(&path, "config.toml").unwrap(); site.load().unwrap(); let tmp_dir = tempdir().expect("create temp dir"); let public = &tmp_dir.path().join("public"); site.set_output_path(&public); site.enable_live_reload(1000); site.build().unwrap(); assert!(Path::new(&public).exists()); assert!(file_exists!(public, "index.html")); assert!(file_exists!(public, "sitemap.xml")); assert!(file_exists!(public, "robots.txt")); assert!(file_exists!(public, "a-fixed-url/index.html")); assert!(file_exists!(public, "posts/python/index.html")); assert!(file_exists!(public, "posts/tutorials/devops/nix/index.html")); assert!(file_exists!(public, "posts/with-assets/index.html")); // Sections assert!(file_exists!(public, "posts/index.html")); assert!(file_exists!(public, "posts/tutorials/index.html")); assert!(file_exists!(public, "posts/tutorials/devops/index.html")); assert!(file_exists!(public, "posts/tutorials/programming/index.html")); // TODO: add assertion for syntax highlighting // We do have categories assert_eq!(file_exists!(public, "categories/index.html"), true); assert_eq!(file_exists!(public, "categories/a-category/index.html"), true); assert_eq!(file_exists!(public, "categories/a-category/rss.xml"), true); // But no tags assert_eq!(file_exists!(public, "tags/index.html"), false); // no live reload code assert!(file_contains!(public, "index.html", "/livereload.js")); // the summary anchor link has been created assert!(file_contains!( public, "posts/python/index.html", r#""# )); assert!(file_contains!(public, "posts/draft/index.html", r#"THEME_SHORTCODE"#)); } #[test] fn can_build_site_with_taxonomies() { let mut path = env::current_dir().unwrap().parent().unwrap().parent().unwrap().to_path_buf(); path.push("test_site"); let mut site = Site::new(&path, "config.toml").unwrap(); site.load().unwrap(); for (i, (_, page)) in site.library.pages_mut().iter_mut().enumerate() { page.meta.taxonomies = { let mut taxonomies = HashMap::new(); taxonomies.insert( "categories".to_string(), vec![if i % 2 == 0 { "A" } else { "B" }.to_string()], ); taxonomies }; } site.populate_taxonomies().unwrap(); let tmp_dir = tempdir().expect("create temp dir"); let public = &tmp_dir.path().join("public"); site.set_output_path(&public); site.build().unwrap(); assert!(Path::new(&public).exists()); assert_eq!(site.taxonomies.len(), 1); assert!(file_exists!(public, "index.html")); assert!(file_exists!(public, "sitemap.xml")); assert!(file_exists!(public, "robots.txt")); assert!(file_exists!(public, "a-fixed-url/index.html")); assert!(file_exists!(public, "posts/python/index.html")); assert!(file_exists!(public, "posts/tutorials/devops/nix/index.html")); assert!(file_exists!(public, "posts/with-assets/index.html")); // Sections assert!(file_exists!(public, "posts/index.html")); assert!(file_exists!(public, "posts/tutorials/index.html")); assert!(file_exists!(public, "posts/tutorials/devops/index.html")); assert!(file_exists!(public, "posts/tutorials/programming/index.html")); // Categories are there assert!(file_exists!(public, "categories/index.html")); assert!(file_exists!(public, "categories/a/index.html")); assert!(file_exists!(public, "categories/b/index.html")); assert!(file_exists!(public, "categories/a/rss.xml")); assert!(file_contains!( public, "categories/a/rss.xml", "https://replace-this-with-your-url.com/categories/a/rss.xml" )); // Extending from a theme works assert!(file_contains!(public, "categories/a/index.html", "EXTENDED")); // Tags aren't assert_eq!(file_exists!(public, "tags/index.html"), false); // Categories are in the sitemap assert!(file_contains!( public, "sitemap.xml", "https://replace-this-with-your-url.com/categories/" )); assert!(file_contains!( public, "sitemap.xml", "https://replace-this-with-your-url.com/categories/a/" )); } #[test] fn can_build_site_and_insert_anchor_links() { let mut path = env::current_dir().unwrap().parent().unwrap().parent().unwrap().to_path_buf(); path.push("test_site"); let mut site = Site::new(&path, "config.toml").unwrap(); site.load().unwrap(); let tmp_dir = tempdir().expect("create temp dir"); let public = &tmp_dir.path().join("public"); site.set_output_path(&public); site.build().unwrap(); assert!(Path::new(&public).exists()); // anchor link inserted assert!(file_contains!( public, "posts/something-else/index.html", "

https://replace-this-with-your-url.com/posts/page/4/" )); } #[test] fn can_build_site_with_pagination_for_index() { let mut path = env::current_dir().unwrap().parent().unwrap().parent().unwrap().to_path_buf(); path.push("test_site"); let mut site = Site::new(&path, "config.toml").unwrap(); site.load().unwrap(); { let index = site.library.get_section_mut(&path.join("content").join("_index.md")).unwrap(); index.meta.paginate_by = Some(2); index.meta.template = Some("index_paginated.html".to_string()); } let tmp_dir = tempdir().expect("create temp dir"); let public = &tmp_dir.path().join("public"); site.set_output_path(&public); site.build().unwrap(); assert!(Path::new(&public).exists()); assert!(file_exists!(public, "index.html")); assert!(file_exists!(public, "sitemap.xml")); assert!(file_exists!(public, "robots.txt")); assert!(file_exists!(public, "a-fixed-url/index.html")); assert!(file_exists!(public, "posts/python/index.html")); assert!(file_exists!(public, "posts/tutorials/devops/nix/index.html")); assert!(file_exists!(public, "posts/with-assets/index.html")); // And pagination! assert!(file_exists!(public, "page/1/index.html")); // even if there is no pages, only the section! assert!(file_exists!(public, "paginated/page/1/index.html")); assert!(file_exists!(public, "paginated/index.html")); // should redirect to index assert!(file_contains!( public, "page/1/index.html", "http-equiv=\"refresh\" content=\"0;url=https://replace-this-with-your-url.com/\"" )); assert!(file_contains!(public, "index.html", "Num pages: 1")); assert!(file_contains!(public, "index.html", "Current index: 1")); assert!(file_contains!(public, "index.html", "First: https://replace-this-with-your-url.com/")); assert!(file_contains!(public, "index.html", "Last: https://replace-this-with-your-url.com/")); assert_eq!(file_contains!(public, "index.html", "has_prev"), false); assert_eq!(file_contains!(public, "index.html", "has_next"), false); // sitemap contains the pager pages assert!(file_contains!( public, "sitemap.xml", "https://replace-this-with-your-url.com/page/1/" )) } #[test] fn can_build_site_with_pagination_for_taxonomy() { let mut path = env::current_dir().unwrap().parent().unwrap().parent().unwrap().to_path_buf(); path.push("test_site"); let mut site = Site::new(&path, "config.toml").unwrap(); site.config.taxonomies.push(Taxonomy { name: "tags".to_string(), paginate_by: Some(2), paginate_path: None, rss: true, }); site.load().unwrap(); for (i, (_, page)) in site.library.pages_mut().iter_mut().enumerate() { page.meta.taxonomies = { let mut taxonomies = HashMap::new(); taxonomies .insert("tags".to_string(), vec![if i % 2 == 0 { "A" } else { "B" }.to_string()]); taxonomies }; } site.populate_taxonomies().unwrap(); let tmp_dir = tempdir().expect("create temp dir"); let public = &tmp_dir.path().join("public"); site.set_output_path(&public); site.build().unwrap(); assert!(Path::new(&public).exists()); assert!(file_exists!(public, "index.html")); assert!(file_exists!(public, "sitemap.xml")); assert!(file_exists!(public, "robots.txt")); assert!(file_exists!(public, "a-fixed-url/index.html")); assert!(file_exists!(public, "posts/python/index.html")); assert!(file_exists!(public, "posts/tutorials/devops/nix/index.html")); assert!(file_exists!(public, "posts/with-assets/index.html")); // Tags assert!(file_exists!(public, "tags/index.html")); // With RSS assert!(file_exists!(public, "tags/a/rss.xml")); assert!(file_exists!(public, "tags/b/rss.xml")); // And pagination! assert!(file_exists!(public, "tags/a/page/1/index.html")); assert!(file_exists!(public, "tags/b/page/1/index.html")); assert!(file_exists!(public, "tags/a/page/2/index.html")); assert!(file_exists!(public, "tags/b/page/2/index.html")); // should redirect to posts/ assert!(file_contains!( public, "tags/a/page/1/index.html", "http-equiv=\"refresh\" content=\"0;url=https://replace-this-with-your-url.com/tags/a/\"" )); assert!(file_contains!(public, "tags/a/index.html", "Num pagers: 6")); assert!(file_contains!(public, "tags/a/index.html", "Page size: 2")); assert!(file_contains!(public, "tags/a/index.html", "Current index: 1")); assert!(!file_contains!(public, "tags/a/index.html", "has_prev")); assert!(file_contains!(public, "tags/a/index.html", "has_next")); assert!(file_contains!( public, "tags/a/index.html", "First: https://replace-this-with-your-url.com/tags/a/" )); assert!(file_contains!( public, "tags/a/index.html", "Last: https://replace-this-with-your-url.com/tags/a/page/6/" )); assert_eq!(file_contains!(public, "tags/a/index.html", "has_prev"), false); // sitemap contains the pager pages assert!(file_contains!( public, "sitemap.xml", "https://replace-this-with-your-url.com/tags/a/page/6/" )) } #[test] fn can_build_rss_feed() { let mut path = env::current_dir().unwrap().parent().unwrap().parent().unwrap().to_path_buf(); path.push("test_site"); let mut site = Site::new(&path, "config.toml").unwrap(); site.load().unwrap(); let tmp_dir = tempdir().expect("create temp dir"); let public = &tmp_dir.path().join("public"); site.set_output_path(&public); site.build().unwrap(); assert!(Path::new(&public).exists()); assert!(file_exists!(public, "rss.xml")); // latest article is posts/extra-syntax.md assert!(file_contains!(public, "rss.xml", "Extra Syntax")); // Next is posts/simple.md assert!(file_contains!(public, "rss.xml", "Simple article with shortcodes")); } #[test] fn can_build_search_index() { let mut path = env::current_dir().unwrap().parent().unwrap().parent().unwrap().to_path_buf(); path.push("test_site"); let mut site = Site::new(&path, "config.toml").unwrap(); site.load().unwrap(); site.config.build_search_index = true; let tmp_dir = tempdir().expect("create temp dir"); let public = &tmp_dir.path().join("public"); site.set_output_path(&public); site.build().unwrap(); assert!(Path::new(&public).exists()); assert!(file_exists!(public, "elasticlunr.min.js")); assert!(file_exists!(public, "search_index.en.js")); } #[test] fn can_build_with_extra_syntaxes() { let mut path = env::current_dir().unwrap().parent().unwrap().parent().unwrap().to_path_buf(); path.push("test_site"); let mut site = Site::new(&path, "config.toml").unwrap(); site.load().unwrap(); let tmp_dir = tempdir().expect("create temp dir"); let public = &tmp_dir.path().join("public"); site.set_output_path(&public); site.build().unwrap(); assert!(&public.exists()); assert!(file_exists!(public, "posts/extra-syntax/index.html")); assert!(file_contains!( public, "posts/extra-syntax/index.html", r#"test"# )); } #[test] fn can_apply_page_templates() { let mut path = env::current_dir().unwrap().parent().unwrap().parent().unwrap().to_path_buf(); path.push("test_site"); let mut site = Site::new(&path, "config.toml").unwrap(); site.load().unwrap(); let template_path = path.join("content").join("applying_page_template"); let template_section = site.library.get_section(&template_path.join("_index.md")).unwrap(); assert_eq!(template_section.subsections.len(), 2); assert_eq!(template_section.pages.len(), 2); let from_section_config = site.library.get_page_by_key(template_section.pages[0]); assert_eq!(from_section_config.meta.template, Some("page_template.html".into())); assert_eq!(from_section_config.meta.title, Some("From section config".into())); let override_page_template = site.library.get_page_by_key(template_section.pages[1]); assert_eq!(override_page_template.meta.template, Some("page_template_override.html".into())); assert_eq!(override_page_template.meta.title, Some("Override".into())); // It should have applied recursively as well let another_section = site.library.get_section(&template_path.join("another_section").join("_index.md")).unwrap(); assert_eq!(another_section.subsections.len(), 0); assert_eq!(another_section.pages.len(), 1); let changed_recursively = site.library.get_page_by_key(another_section.pages[0]); assert_eq!(changed_recursively.meta.template, Some("page_template.html".into())); assert_eq!(changed_recursively.meta.title, Some("Changed recursively".into())); // But it should not have override a children page_template let yet_another_section = site .library .get_section(&template_path.join("yet_another_section").join("_index.md")) .unwrap(); assert_eq!(yet_another_section.subsections.len(), 0); assert_eq!(yet_another_section.pages.len(), 1); let child = site.library.get_page_by_key(yet_another_section.pages[0]); assert_eq!(child.meta.template, Some("page_template_child.html".into())); assert_eq!(child.meta.title, Some("Local section override".into())); }