You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

site.rs 20KB

7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
6 years ago
6 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458
  1. extern crate site;
  2. extern crate tempfile;
  3. use std::collections::HashMap;
  4. use std::env;
  5. use std::path::Path;
  6. use std::fs::File;
  7. use std::io::prelude::*;
  8. use tempfile::tempdir;
  9. use site::Site;
  10. #[test]
  11. fn can_parse_site() {
  12. let mut path = env::current_dir().unwrap().parent().unwrap().parent().unwrap().to_path_buf();
  13. path.push("test_site");
  14. let mut site = Site::new(&path, "config.toml").unwrap();
  15. site.load().unwrap();
  16. // Correct number of pages (sections are pages too)
  17. assert_eq!(site.pages.len(), 15);
  18. let posts_path = path.join("content").join("posts");
  19. // Make sure we remove all the pwd + content from the sections
  20. let basic = &site.pages[&posts_path.join("simple.md")];
  21. assert_eq!(basic.file.components, vec!["posts".to_string()]);
  22. // Make sure the page with a url doesn't have any sections
  23. let url_post = &site.pages[&posts_path.join("fixed-url.md")];
  24. assert_eq!(url_post.path, "a-fixed-url/");
  25. // Make sure the article in a folder with only asset doesn't get counted as a section
  26. let asset_folder_post = &site.pages[&posts_path.join("with-assets").join("index.md")];
  27. assert_eq!(asset_folder_post.file.components, vec!["posts".to_string()]);
  28. // That we have the right number of sections
  29. assert_eq!(site.sections.len(), 7);
  30. // And that the sections are correct
  31. let index_section = &site.sections[&path.join("content").join("_index.md")];
  32. assert_eq!(index_section.subsections.len(), 3);
  33. assert_eq!(index_section.pages.len(), 1);
  34. let posts_section = &site.sections[&posts_path.join("_index.md")];
  35. assert_eq!(posts_section.subsections.len(), 1);
  36. assert_eq!(posts_section.pages.len(), 7);
  37. let tutorials_section = &site.sections[&posts_path.join("tutorials").join("_index.md")];
  38. assert_eq!(tutorials_section.subsections.len(), 2);
  39. assert_eq!(tutorials_section.subsections[0].clone().meta.title.unwrap(), "Programming");
  40. assert_eq!(tutorials_section.subsections[1].clone().meta.title.unwrap(), "DevOps");
  41. assert_eq!(tutorials_section.pages.len(), 0);
  42. let devops_section = &site.sections[&posts_path.join("tutorials").join("devops").join("_index.md")];
  43. assert_eq!(devops_section.subsections.len(), 0);
  44. assert_eq!(devops_section.pages.len(), 2);
  45. let prog_section = &site.sections[&posts_path.join("tutorials").join("programming").join("_index.md")];
  46. assert_eq!(prog_section.subsections.len(), 0);
  47. assert_eq!(prog_section.pages.len(), 2);
  48. }
  49. // 2 helper macros to make all the build testing more bearable
  50. macro_rules! file_exists {
  51. ($root: expr, $path: expr) => {
  52. {
  53. let mut path = $root.clone();
  54. for component in $path.split("/") {
  55. path = path.join(component);
  56. }
  57. Path::new(&path).exists()
  58. }
  59. }
  60. }
  61. macro_rules! file_contains {
  62. ($root: expr, $path: expr, $text: expr) => {
  63. {
  64. let mut path = $root.clone();
  65. for component in $path.split("/") {
  66. path = path.join(component);
  67. }
  68. let mut file = File::open(&path).unwrap();
  69. let mut s = String::new();
  70. file.read_to_string(&mut s).unwrap();
  71. println!("{}", s);
  72. s.contains($text)
  73. }
  74. }
  75. }
  76. #[test]
  77. fn can_build_site_without_live_reload() {
  78. let mut path = env::current_dir().unwrap().parent().unwrap().parent().unwrap().to_path_buf();
  79. path.push("test_site");
  80. let mut site = Site::new(&path, "config.toml").unwrap();
  81. site.load().unwrap();
  82. let tmp_dir = tempdir().expect("create temp dir");
  83. let public = &tmp_dir.path().join("public");
  84. site.set_output_path(&public);
  85. site.build().unwrap();
  86. assert!(&public.exists());
  87. assert!(file_exists!(public, "index.html"));
  88. assert!(file_exists!(public, "sitemap.xml"));
  89. assert!(file_exists!(public, "robots.txt"));
  90. assert!(file_exists!(public, "a-fixed-url/index.html"));
  91. assert!(file_exists!(public, "posts/python/index.html"));
  92. // Shortcodes work
  93. assert!(file_contains!(public, "posts/python/index.html", "Basic shortcode"));
  94. assert!(file_contains!(public, "posts/python/index.html", "Arrrh Bob"));
  95. assert!(file_contains!(public, "posts/python/index.html", "Arrrh Bob_Sponge"));
  96. assert!(file_exists!(public, "posts/tutorials/devops/nix/index.html"));
  97. assert!(file_exists!(public, "posts/with-assets/index.html"));
  98. assert!(file_exists!(public, "posts/no-section/simple/index.html"));
  99. // Sections
  100. assert!(file_exists!(public, "posts/index.html"));
  101. assert!(file_exists!(public, "posts/tutorials/index.html"));
  102. assert!(file_exists!(public, "posts/tutorials/devops/index.html"));
  103. assert!(file_exists!(public, "posts/tutorials/programming/index.html"));
  104. // Ensure subsection pages are correctly filled
  105. assert!(file_contains!(public, "posts/tutorials/index.html", "Sub-pages: 2"));
  106. // TODO: add assertion for syntax highlighting
  107. // aliases work
  108. assert!(file_exists!(public, "an-old-url/old-page/index.html"));
  109. assert!(file_contains!(public, "an-old-url/old-page/index.html", "something-else"));
  110. // html aliases work
  111. assert!(file_exists!(public, "an-old-url/an-old-alias.html"));
  112. assert!(file_contains!(public, "an-old-url/an-old-alias.html", "something-else"));
  113. // redirect_to works
  114. assert!(file_exists!(public, "posts/tutorials/devops/index.html"));
  115. assert!(file_contains!(public, "posts/tutorials/devops/index.html", "docker"));
  116. // No tags or categories
  117. assert_eq!(file_exists!(public, "categories/index.html"), false);
  118. assert_eq!(file_exists!(public, "tags/index.html"), false);
  119. // Theme files are there
  120. assert!(file_exists!(public, "sample.css"));
  121. assert!(file_exists!(public, "some.js"));
  122. // SASS and SCSS files compile correctly
  123. assert!(file_exists!(public, "blog.css"));
  124. assert!(file_contains!(public, "blog.css", "red"));
  125. assert!(file_contains!(public, "blog.css", "blue"));
  126. assert!(!file_contains!(public, "blog.css", "@import \"included\""));
  127. assert!(file_contains!(public, "blog.css", "2rem")); // check include
  128. assert!(!file_exists!(public, "_included.css"));
  129. assert!(file_exists!(public, "scss.css"));
  130. assert!(file_exists!(public, "sass.css"));
  131. assert!(file_exists!(public, "nested_sass/sass.css"));
  132. assert!(file_exists!(public, "nested_sass/scss.css"));
  133. // no live reload code
  134. assert_eq!(file_contains!(public, "index.html", "/livereload.js?port=1112&mindelay=10"), false);
  135. // Both pages and sections are in the sitemap
  136. assert!(file_contains!(public, "sitemap.xml", "<loc>https://replace-this-with-your-url.com/posts/simple/</loc>"));
  137. assert!(file_contains!(public, "sitemap.xml", "<loc>https://replace-this-with-your-url.com/posts/</loc>"));
  138. // Drafts are not in the sitemap
  139. assert!(!file_contains!(public, "sitemap.xml", "draft"));
  140. }
  141. #[test]
  142. fn can_build_site_with_live_reload() {
  143. let mut path = env::current_dir().unwrap().parent().unwrap().parent().unwrap().to_path_buf();
  144. path.push("test_site");
  145. let mut site = Site::new(&path, "config.toml").unwrap();
  146. site.load().unwrap();
  147. let tmp_dir = tempdir().expect("create temp dir");
  148. let public = &tmp_dir.path().join("public");
  149. site.set_output_path(&public);
  150. site.enable_live_reload();
  151. site.build().unwrap();
  152. assert!(Path::new(&public).exists());
  153. assert!(file_exists!(public, "index.html"));
  154. assert!(file_exists!(public, "sitemap.xml"));
  155. assert!(file_exists!(public, "robots.txt"));
  156. assert!(file_exists!(public, "a-fixed-url/index.html"));
  157. assert!(file_exists!(public, "posts/python/index.html"));
  158. assert!(file_exists!(public, "posts/tutorials/devops/nix/index.html"));
  159. assert!(file_exists!(public, "posts/with-assets/index.html"));
  160. // Sections
  161. assert!(file_exists!(public, "posts/index.html"));
  162. assert!(file_exists!(public, "posts/tutorials/index.html"));
  163. assert!(file_exists!(public, "posts/tutorials/devops/index.html"));
  164. assert!(file_exists!(public, "posts/tutorials/programming/index.html"));
  165. // TODO: add assertion for syntax highlighting
  166. // No tags or categories
  167. assert_eq!(file_exists!(public, "categories/index.html"), false);
  168. assert_eq!(file_exists!(public, "tags/index.html"), false);
  169. // no live reload code
  170. assert!(file_contains!(public, "index.html", "/livereload.js"));
  171. // the summary anchor link has been created
  172. assert!(file_contains!(public, "posts/python/index.html", r#"<a name="continue-reading"></a>"#));
  173. assert!(file_contains!(public, "posts/draft/index.html", r#"THEME_SHORTCODE"#));
  174. }
  175. #[test]
  176. fn can_build_site_with_taxonomies() {
  177. let mut path = env::current_dir().unwrap().parent().unwrap().parent().unwrap().to_path_buf();
  178. path.push("test_site");
  179. let mut site = Site::new(&path, "config.toml").unwrap();
  180. site.load().unwrap();
  181. for (i, page) in site.pages.values_mut().enumerate() {
  182. page.meta.taxonomies = {
  183. let mut taxonomies = HashMap::new();
  184. taxonomies.insert("categories".to_string(), vec![if i % 2 == 0 { "A" } else { "B" }.to_string()]);
  185. taxonomies
  186. };
  187. }
  188. site.populate_taxonomies().unwrap();
  189. let tmp_dir = tempdir().expect("create temp dir");
  190. let public = &tmp_dir.path().join("public");
  191. site.set_output_path(&public);
  192. site.build().unwrap();
  193. assert!(Path::new(&public).exists());
  194. assert_eq!(site.taxonomies.len(), 1);
  195. assert!(file_exists!(public, "index.html"));
  196. assert!(file_exists!(public, "sitemap.xml"));
  197. assert!(file_exists!(public, "robots.txt"));
  198. assert!(file_exists!(public, "a-fixed-url/index.html"));
  199. assert!(file_exists!(public, "posts/python/index.html"));
  200. assert!(file_exists!(public, "posts/tutorials/devops/nix/index.html"));
  201. assert!(file_exists!(public, "posts/with-assets/index.html"));
  202. // Sections
  203. assert!(file_exists!(public, "posts/index.html"));
  204. assert!(file_exists!(public, "posts/tutorials/index.html"));
  205. assert!(file_exists!(public, "posts/tutorials/devops/index.html"));
  206. assert!(file_exists!(public, "posts/tutorials/programming/index.html"));
  207. // Categories are there
  208. assert!(file_exists!(public, "categories/index.html"));
  209. assert!(file_exists!(public, "categories/a/index.html"));
  210. assert!(file_exists!(public, "categories/b/index.html"));
  211. assert!(file_exists!(public, "categories/a/rss.xml"));
  212. assert!(file_contains!(public, "categories/a/rss.xml", "https://replace-this-with-your-url.com/categories/a/rss.xml"));
  213. // Extending from a theme works
  214. assert!(file_contains!(public, "categories/a/index.html", "EXTENDED"));
  215. // Tags aren't
  216. assert_eq!(file_exists!(public, "tags/index.html"), false);
  217. // Categories are in the sitemap
  218. assert!(file_contains!(public, "sitemap.xml", "<loc>https://replace-this-with-your-url.com/categories/</loc>"));
  219. assert!(file_contains!(public, "sitemap.xml", "<loc>https://replace-this-with-your-url.com/categories/a/</loc>"));
  220. }
  221. #[test]
  222. fn can_build_site_and_insert_anchor_links() {
  223. let mut path = env::current_dir().unwrap().parent().unwrap().parent().unwrap().to_path_buf();
  224. path.push("test_site");
  225. let mut site = Site::new(&path, "config.toml").unwrap();
  226. site.load().unwrap();
  227. let tmp_dir = tempdir().expect("create temp dir");
  228. let public = &tmp_dir.path().join("public");
  229. site.set_output_path(&public);
  230. site.build().unwrap();
  231. assert!(Path::new(&public).exists());
  232. // anchor link inserted
  233. assert!(file_contains!(public, "posts/something-else/index.html", "<h1 id=\"title\"><a class=\"gutenberg-anchor\" href=\"#title\""));
  234. }
  235. #[test]
  236. fn can_build_site_with_pagination_for_section() {
  237. let mut path = env::current_dir().unwrap().parent().unwrap().parent().unwrap().to_path_buf();
  238. path.push("test_site");
  239. let mut site = Site::new(&path, "config.toml").unwrap();
  240. site.load().unwrap();
  241. for section in site.sections.values_mut(){
  242. if section.is_index() {
  243. continue;
  244. }
  245. section.meta.paginate_by = Some(2);
  246. section.meta.template = Some("section_paginated.html".to_string());
  247. }
  248. let tmp_dir = tempdir().expect("create temp dir");
  249. let public = &tmp_dir.path().join("public");
  250. site.set_output_path(&public);
  251. site.build().unwrap();
  252. assert!(Path::new(&public).exists());
  253. assert!(file_exists!(public, "index.html"));
  254. assert!(file_exists!(public, "sitemap.xml"));
  255. assert!(file_exists!(public, "robots.txt"));
  256. assert!(file_exists!(public, "a-fixed-url/index.html"));
  257. assert!(file_exists!(public, "posts/python/index.html"));
  258. assert!(file_exists!(public, "posts/tutorials/devops/nix/index.html"));
  259. assert!(file_exists!(public, "posts/with-assets/index.html"));
  260. // Sections
  261. assert!(file_exists!(public, "posts/index.html"));
  262. // And pagination!
  263. assert!(file_exists!(public, "posts/page/1/index.html"));
  264. // even if there is no pages, only the section!
  265. assert!(file_exists!(public, "paginated/page/1/index.html"));
  266. assert!(file_exists!(public, "paginated/index.html"));
  267. // should redirect to posts/
  268. assert!(file_contains!(
  269. public,
  270. "posts/page/1/index.html",
  271. "http-equiv=\"refresh\" content=\"0;url=https://replace-this-with-your-url.com/posts/\""
  272. ));
  273. assert!(file_contains!(public, "posts/index.html", "Num pagers: 4"));
  274. assert!(file_contains!(public, "posts/index.html", "Page size: 2"));
  275. assert!(file_contains!(public, "posts/index.html", "Current index: 1"));
  276. assert!(!file_contains!(public, "posts/index.html", "has_prev"));
  277. assert!(file_contains!(public, "posts/index.html", "has_next"));
  278. assert!(file_contains!(public, "posts/index.html", "First: https://replace-this-with-your-url.com/posts/"));
  279. assert!(file_contains!(public, "posts/index.html", "Last: https://replace-this-with-your-url.com/posts/page/4/"));
  280. assert_eq!(file_contains!(public, "posts/index.html", "has_prev"), false);
  281. assert!(file_exists!(public, "posts/page/2/index.html"));
  282. assert!(file_contains!(public, "posts/page/2/index.html", "Num pagers: 4"));
  283. assert!(file_contains!(public, "posts/page/2/index.html", "Page size: 2"));
  284. assert!(file_contains!(public, "posts/page/2/index.html", "Current index: 2"));
  285. assert!(file_contains!(public, "posts/page/2/index.html", "has_prev"));
  286. assert!(file_contains!(public, "posts/page/2/index.html", "has_next"));
  287. assert!(file_contains!(public, "posts/page/2/index.html", "First: https://replace-this-with-your-url.com/posts/"));
  288. assert!(file_contains!(public, "posts/page/2/index.html", "Last: https://replace-this-with-your-url.com/posts/page/4/"));
  289. assert!(file_exists!(public, "posts/page/3/index.html"));
  290. assert!(file_contains!(public, "posts/page/3/index.html", "Num pagers: 4"));
  291. assert!(file_contains!(public, "posts/page/3/index.html", "Page size: 2"));
  292. assert!(file_contains!(public, "posts/page/3/index.html", "Current index: 3"));
  293. assert!(file_contains!(public, "posts/page/3/index.html", "has_prev"));
  294. assert!(file_contains!(public, "posts/page/3/index.html", "has_next"));
  295. assert!(file_contains!(public, "posts/page/3/index.html", "First: https://replace-this-with-your-url.com/posts/"));
  296. assert!(file_contains!(public, "posts/page/3/index.html", "Last: https://replace-this-with-your-url.com/posts/page/4/"));
  297. assert!(file_exists!(public, "posts/page/4/index.html"));
  298. assert!(file_contains!(public, "posts/page/4/index.html", "Num pagers: 4"));
  299. assert!(file_contains!(public, "posts/page/4/index.html", "Page size: 2"));
  300. assert!(file_contains!(public, "posts/page/4/index.html", "Current index: 4"));
  301. assert!(file_contains!(public, "posts/page/4/index.html", "has_prev"));
  302. assert!(!file_contains!(public, "posts/page/4/index.html", "has_next"));
  303. assert!(file_contains!(public, "posts/page/4/index.html", "First: https://replace-this-with-your-url.com/posts/"));
  304. assert!(file_contains!(public, "posts/page/4/index.html", "Last: https://replace-this-with-your-url.com/posts/page/4/"));
  305. }
  306. #[test]
  307. fn can_build_site_with_pagination_for_index() {
  308. let mut path = env::current_dir().unwrap().parent().unwrap().parent().unwrap().to_path_buf();
  309. path.push("test_site");
  310. let mut site = Site::new(&path, "config.toml").unwrap();
  311. site.load().unwrap();
  312. {
  313. let index = site.sections.get_mut(&path.join("content").join("_index.md")).unwrap();
  314. index.meta.paginate_by = Some(2);
  315. index.meta.template = Some("index_paginated.html".to_string());
  316. }
  317. let tmp_dir = tempdir().expect("create temp dir");
  318. let public = &tmp_dir.path().join("public");
  319. site.set_output_path(&public);
  320. site.build().unwrap();
  321. assert!(Path::new(&public).exists());
  322. assert!(file_exists!(public, "index.html"));
  323. assert!(file_exists!(public, "sitemap.xml"));
  324. assert!(file_exists!(public, "robots.txt"));
  325. assert!(file_exists!(public, "a-fixed-url/index.html"));
  326. assert!(file_exists!(public, "posts/python/index.html"));
  327. assert!(file_exists!(public, "posts/tutorials/devops/nix/index.html"));
  328. assert!(file_exists!(public, "posts/with-assets/index.html"));
  329. // And pagination!
  330. assert!(file_exists!(public, "page/1/index.html"));
  331. // even if there is no pages, only the section!
  332. assert!(file_exists!(public, "paginated/page/1/index.html"));
  333. assert!(file_exists!(public, "paginated/index.html"));
  334. // should redirect to index
  335. assert!(file_contains!(
  336. public,
  337. "page/1/index.html",
  338. "http-equiv=\"refresh\" content=\"0;url=https://replace-this-with-your-url.com/\""
  339. ));
  340. assert!(file_contains!(public, "index.html", "Num pages: 1"));
  341. assert!(file_contains!(public, "index.html", "Current index: 1"));
  342. assert!(file_contains!(public, "index.html", "First: https://replace-this-with-your-url.com/"));
  343. assert!(file_contains!(public, "index.html", "Last: https://replace-this-with-your-url.com/"));
  344. assert_eq!(file_contains!(public, "index.html", "has_prev"), false);
  345. assert_eq!(file_contains!(public, "index.html", "has_next"), false);
  346. }
  347. #[test]
  348. fn can_build_rss_feed() {
  349. let mut path = env::current_dir().unwrap().parent().unwrap().parent().unwrap().to_path_buf();
  350. path.push("test_site");
  351. let mut site = Site::new(&path, "config.toml").unwrap();
  352. site.load().unwrap();
  353. let tmp_dir = tempdir().expect("create temp dir");
  354. let public = &tmp_dir.path().join("public");
  355. site.set_output_path(&public);
  356. site.build().unwrap();
  357. assert!(Path::new(&public).exists());
  358. assert!(file_exists!(public, "rss.xml"));
  359. // latest article is posts/extra-syntax.md
  360. assert!(file_contains!(public, "rss.xml", "Extra Syntax"));
  361. // Next is posts/simple.md
  362. assert!(file_contains!(public, "rss.xml", "Simple article with shortcodes"));
  363. }
  364. #[test]
  365. fn can_build_search_index() {
  366. let mut path = env::current_dir().unwrap().parent().unwrap().parent().unwrap().to_path_buf();
  367. path.push("test_site");
  368. let mut site = Site::new(&path, "config.toml").unwrap();
  369. site.load().unwrap();
  370. site.config.build_search_index = true;
  371. let tmp_dir = tempdir().expect("create temp dir");
  372. let public = &tmp_dir.path().join("public");
  373. site.set_output_path(&public);
  374. site.build().unwrap();
  375. assert!(Path::new(&public).exists());
  376. assert!(file_exists!(public, "elasticlunr.min.js"));
  377. assert!(file_exists!(public, "search_index.en.js"));
  378. }
  379. #[test]
  380. fn can_build_with_extra_syntaxes() {
  381. let mut path = env::current_dir().unwrap().parent().unwrap().parent().unwrap().to_path_buf();
  382. path.push("test_site");
  383. let mut site = Site::new(&path, "config.toml").unwrap();
  384. site.load().unwrap();
  385. let tmp_dir = tempdir().expect("create temp dir");
  386. let public = &tmp_dir.path().join("public");
  387. site.set_output_path(&public);
  388. site.build().unwrap();
  389. assert!(&public.exists());
  390. assert!(file_exists!(public, "posts/extra-syntax/index.html"));
  391. assert!(file_contains!(public, "posts/extra-syntax/index.html",
  392. r#"<span style="background-color:#2b303b;color:#d08770;">test</span>"#));
  393. }