Add test that readme is rendered

Author: jyn514

src/test/fakes.rs

@@ -19,6 +19,8 @@ pub(crate) struct FakeRelease<'a> {
     registry_crate_data: RegistryCrateData,
     has_docs: bool,
     has_examples: bool,
+    /// This stores the content, while `package.readme` stores the filename
+    readme: Option<&'a str>,
 }
 
 impl<'a> FakeRelease<'a> {
@@ -62,6 +64,7 @@ impl<'a> FakeRelease<'a> {
             },
             has_docs: true,
             has_examples: false,
+            readme: None,
         }
     }
 
@@ -92,7 +95,7 @@ impl<'a> FakeRelease<'a> {
         self
     }
 
-    pub fn author(mut self, author: &str) -> Self {
+    pub(crate) fn author(mut self, author: &str) -> Self {
         self.package.authors = vec![author.into()];
         self
     }
@@ -153,6 +156,12 @@ impl<'a> FakeRelease<'a> {
         self
     }
 
+    /// NOTE: this should be markdown. It will be rendered as HTML when served.
+    pub(crate) fn readme(mut self, content: &'a str) -> Self {
+        self.readme = Some(content);
+        self.source_file("README.md", content.as_bytes())
+    }
+
     /// Returns the release_id
     pub(crate) fn create(self) -> Result<i32, Error> {
         use std::collections::HashSet;
@@ -223,10 +232,14 @@ impl<'a> FakeRelease<'a> {
             }
         }
 
+        let crate_dir = tempdir.path();
+        if let Some(markdown) = self.readme {
+            fs::write(crate_dir.join("README.md"), markdown)?;
+        }
         let release_id = crate::db::add_package_into_database(
             &db.conn(),
             &package,
-            tempdir.path(),
+            crate_dir,
             &self.build_result,
             self.default_target.unwrap_or("x86_64-unknown-linux-gnu"),
             source_meta,

src/web/rustdoc.rs

@@ -1445,4 +1445,26 @@ mod test {
             Ok(())
         })
     }
+
+    #[test]
+    fn test_readme_rendered_as_html() {
+        wrapper(|env| {
+            let db = env.db();
+            let readme = "# Overview";
+            db.fake_release()
+                .name("strum")
+                .version("0.18.0")
+                .readme(readme)
+                .create()?;
+            let page = kuchiki::parse_html()
+                .one(env.frontend().get("/crate/strum/0.18.0").send()?.text()?);
+            let rendered = page.select_first("#main").expect("missing readme");
+            println!("{}", rendered.text_contents());
+            rendered
+                .as_node()
+                .select_first("h1")
+                .expect("`# Overview` was not rendered as HTML");
+            Ok(())
+        })
+    }
 }