Revert "Remove unused code (#558)"

jyn514 · jyn514 · commit f29b56239479 · 2020-02-06T16:37:22.000-05:00
This reverts commit 3809f94. This caused all builds to fail in the last step when copying documentation into the database.
diff --git a/src/bin/cratesfyi.rs b/src/bin/cratesfyi.rs
@@ -239,7 +239,7 @@ pub fn main() {
             let mut count = 1;
             let mut total = 0;
             while count != 0 {
-                count = db::move_to_s3(&conn, 5_000).expect("Failed to upload batch to S3");
+                count = db::file::move_to_s3(&conn, 5_000).expect("Failed to upload batch to S3");
                 total += count;
                 eprintln!(
                     "moved {} rows to s3 in this batch, total moved so far: {}",
diff --git a/src/db/file.rs b/src/db/file.rs
@@ -42,7 +42,7 @@ fn get_file_list_from_dir<P: AsRef<Path>>(path: P,
 }
 
 
-fn get_file_list<P: AsRef<Path>>(path: P) -> Result<Vec<PathBuf>> {
+pub fn get_file_list<P: AsRef<Path>>(path: P) -> Result<Vec<PathBuf>> {
     let path = path.as_ref();
     let mut files = Vec::new();
 
diff --git a/src/db/migrate.rs b/src/db/migrate.rs
@@ -10,7 +10,6 @@ use std::borrow::Cow;
 #[derive(Copy, Clone)]
 enum ApplyMode {
     Permanent,
-    #[cfg(test)]
     Temporary,
 }
 
@@ -23,7 +22,6 @@ impl MigrationContext {
     fn format_query<'a>(&self, query: &'a str) -> Cow<'a, str> {
         match self.apply_mode {
             ApplyMode::Permanent => Cow::Borrowed(query),
-            #[cfg(test)]
             ApplyMode::Temporary => {
                 Cow::Owned(query.replace("CREATE TABLE", "CREATE TEMPORARY TABLE"))
             }
@@ -75,7 +73,6 @@ pub fn migrate(version: Option<Version>, conn: &Connection) -> CratesfyiResult<(
     migrate_inner(version, conn, ApplyMode::Permanent)
 }
 
-#[cfg(test)]
 pub fn migrate_temporary(version: Option<Version>, conn: &Connection) -> CratesfyiResult<()> {
     migrate_inner(version, conn, ApplyMode::Temporary)
 }
diff --git a/src/db/mod.rs b/src/db/mod.rs
@@ -3,10 +3,8 @@
 pub(crate) use self::add_package::add_package_into_database;
 pub(crate) use self::add_package::add_build_into_database;
 pub(crate) use self::add_package::CratesIoData;
-pub use self::file::{add_path_into_database, move_to_s3};
-pub use self::migrate::migrate;
-#[cfg(test)]
-pub(crate) use self::migrate::migrate_temporary;
+pub use self::file::add_path_into_database;
+pub use self::migrate::{migrate, migrate_temporary};
 pub use self::delete_crate::delete_crate;
 
 use postgres::{Connection, TlsMode};
@@ -16,7 +14,7 @@ use r2d2;
 use r2d2_postgres;
 
 mod add_package;
-pub(crate) mod file;
+pub mod file;
 mod migrate;
 mod delete_crate;
 pub mod blacklist;
@@ -31,7 +29,7 @@ pub fn connect_db() -> Result<Connection, Error> {
 }
 
 
-pub(crate) fn create_pool() -> r2d2::Pool<r2d2_postgres::PostgresConnectionManager> {
+pub fn create_pool() -> r2d2::Pool<r2d2_postgres::PostgresConnectionManager> {
     let db_url = env::var("CRATESFYI_DATABASE_URL")
         .expect("CRATESFYI_DATABASE_URL environment variable is not exists");
     let manager = r2d2_postgres::PostgresConnectionManager::new(&db_url[..],
diff --git a/src/docbuilder/metadata.rs b/src/docbuilder/metadata.rs
@@ -22,6 +22,7 @@ use failure::err_msg;
 /// default-target = "x86_64-unknown-linux-gnu"
 /// rustc-args = [ "--example-rustc-arg" ]
 /// rustdoc-args = [ "--example-rustdoc-arg" ]
+/// dependencies = [ "example-system-dependency" ]
 /// ```
 ///
 /// You can define one or more fields in your `Cargo.toml`.
@@ -48,6 +49,11 @@ pub struct Metadata {
 
     /// List of command line arguments for `rustdoc`.
     pub rustdoc_args: Option<Vec<String>>,
+
+    /// System dependencies.
+    ///
+    /// Docs.rs is running on a Debian jessie.
+    pub dependencies: Option<Vec<String>>,
 }
 
 
@@ -63,7 +69,7 @@ impl Metadata {
         Err(err_msg("Manifest not found"))
     }
 
-    fn from_manifest<P: AsRef<Path>>(path: P) -> Metadata {
+    pub fn from_manifest<P: AsRef<Path>>(path: P) -> Metadata {
         use std::fs::File;
         use std::io::Read;
         let mut f = match File::open(path) {
@@ -87,6 +93,7 @@ impl Metadata {
             default_target: None,
             rustc_args: None,
             rustdoc_args: None,
+            dependencies: None,
         }
     }
 
@@ -115,6 +122,8 @@ impl Metadata {
                         .and_then(|f| f.iter().map(|v| v.as_str().map(|v| v.to_owned())).collect());
                     metadata.rustdoc_args = table.get("rustdoc-args").and_then(|f| f.as_array())
                         .and_then(|f| f.iter().map(|v| v.as_str().map(|v| v.to_owned())).collect());
+                    metadata.dependencies = table.get("dependencies").and_then(|f| f.as_array())
+                        .and_then(|f| f.iter().map(|v| v.as_str().map(|v| v.to_owned())).collect());
                 }
 
         metadata
@@ -142,6 +151,7 @@ mod test {
             default-target = "x86_64-unknown-linux-gnu"
             rustc-args = [ "--example-rustc-arg" ]
             rustdoc-args = [ "--example-rustdoc-arg" ]
+            dependencies = [ "example-system-dependency" ]
         "#;
 
         let metadata = Metadata::from_str(manifest);
@@ -166,5 +176,9 @@ mod test {
         let rustdoc_args = metadata.rustdoc_args.unwrap();
         assert_eq!(rustdoc_args.len(), 1);
         assert_eq!(rustdoc_args[0], "--example-rustdoc-arg".to_owned());
+
+        let dependencies = metadata.dependencies.unwrap();
+        assert_eq!(dependencies.len(), 1);
+        assert_eq!(dependencies[0], "example-system-dependency".to_owned());
     }
 }
diff --git a/src/docbuilder/mod.rs b/src/docbuilder/mod.rs
@@ -1,6 +1,6 @@
 
-pub(crate) mod options;
-mod metadata;
+pub mod options;
+pub mod metadata;
 mod limits;
 mod rustwide_builder;
 mod crates;
@@ -9,7 +9,6 @@ mod queue;
 pub use self::rustwide_builder::RustwideBuilder;
 pub(crate) use self::rustwide_builder::BuildResult;
 pub(crate) use self::limits::Limits;
-pub(self) use self::metadata::Metadata;
 
 
 use std::fs;
diff --git a/src/docbuilder/rustwide_builder.rs b/src/docbuilder/rustwide_builder.rs
@@ -16,7 +16,7 @@ use std::borrow::Cow;
 use std::collections::HashSet;
 use std::path::Path;
 use utils::{copy_doc_dir, parse_rustc_version, CargoMetadata};
-use super::Metadata;
+use Metadata;
 
 const USER_AGENT: &str = "docs.rs builder (https://github.com/rust-lang/docs.rs)";
 const DEFAULT_RUSTWIDE_WORKSPACE: &str = ".rustwide";
@@ -522,7 +522,8 @@ impl RustwideBuilder {
         }
 
         info!("{} {}", source.display(), dest.display());
-        copy_doc_dir(source, dest)
+        copy_doc_dir(source, dest, self.rustc_version.trim())?;
+        Ok(())
     }
 
     fn upload_docs(
diff --git a/src/error.rs b/src/error.rs
@@ -2,6 +2,6 @@
 
 use std::result::Result as StdResult;
 
-pub(crate) use failure::Error;
+pub use failure::{Error, ResultExt};
 
 pub type Result<T> = StdResult<T, Error>;
diff --git a/src/lib.rs b/src/lib.rs
@@ -47,9 +47,10 @@ extern crate once_cell;
 pub use self::docbuilder::RustwideBuilder;
 pub use self::docbuilder::DocBuilder;
 pub use self::docbuilder::options::DocBuilderOptions;
+pub use self::docbuilder::metadata::Metadata;
 pub use self::web::Server;
 
-mod error;
+pub mod error;
 pub mod db;
 pub mod utils;
 mod docbuilder;
diff --git a/src/utils/copy.rs b/src/utils/copy.rs
@@ -8,16 +8,44 @@ use error::Result;
 
 use regex::Regex;
 
+
+/// Copies files from source directory to destination directory.
+pub fn copy_dir<P: AsRef<Path>>(source: P, destination: P) -> Result<()> {
+    copy_files_and_handle_html(source.as_ref().to_path_buf(),
+                               destination.as_ref().to_path_buf(),
+                               false,
+                               "")
+}
+
+
 /// Copies documentation from a crate's target directory to destination.
 ///
 /// Target directory must have doc directory.
 ///
-/// This function is designed to avoid file duplications.
-pub fn copy_doc_dir<P: AsRef<Path>>(target: P, destination: P) -> Result<()> {
+/// This function is designed to avoid file duplications. It is using rustc version string
+/// to rename common files (css files, jquery.js, playpen.js, main.js etc.) in a standard rustdoc.
+pub fn copy_doc_dir<P: AsRef<Path>>(target: P,
+                                    destination: P,
+                                    rustc_version: &str)
+                                    -> Result<()> {
     let source = PathBuf::from(target.as_ref()).join("doc");
-    let destination = destination.as_ref().to_path_buf();
+    copy_files_and_handle_html(source,
+                               destination.as_ref().to_path_buf(),
+                               true,
+                               rustc_version)
+}
 
-    // Make sure destination directory exists
+
+fn copy_files_and_handle_html(source: PathBuf,
+                              destination: PathBuf,
+                              handle_html: bool,
+                              rustc_version: &str)
+                              -> Result<()> {
+
+    // FIXME: handle_html is useless since we started using --resource-suffix
+    //        argument with rustdoc
+
+    // Make sure destination directory is exists
     if !destination.exists() {
         fs::create_dir_all(&destination)?;
     }
@@ -37,8 +65,11 @@ pub fn copy_doc_dir<P: AsRef<Path>>(target: P, destination: P) -> Result<()> {
 
         if metadata.is_dir() {
             fs::create_dir_all(&destination_full_path)?;
-            copy_doc_dir(file.path(), destination_full_path)?
-        } else if dup_regex.is_match(&file.file_name().into_string().unwrap()[..]) {
+            copy_files_and_handle_html(file.path(),
+                                            destination_full_path,
+                                            handle_html,
+                                            &rustc_version)?
+        } else if handle_html && dup_regex.is_match(&file.file_name().into_string().unwrap()[..]) {
             continue;
         } else {
             fs::copy(&file.path(), &destination_full_path)?;
@@ -54,21 +85,19 @@ pub fn copy_doc_dir<P: AsRef<Path>>(target: P, destination: P) -> Result<()> {
 mod test {
     extern crate env_logger;
     use std::fs;
+    use std::path::Path;
     use super::*;
 
     #[test]
-    fn test_copy_doc_dir() {
-        let source = tempdir::TempDir::new("cratesfyi-src").unwrap();
-        let destination = tempdir::TempDir::new("cratesfyi-dst").unwrap();
-        let doc = source.path().join("doc");
-        fs::create_dir(&doc).unwrap();
-
-        fs::write(doc.join("index.html"), "<html>spooky</html>").unwrap();
-        fs::write(doc.join("index.txt"), "spooky").unwrap();
+    #[ignore]
+    fn test_copy_dir() {
+        let destination = tempdir::TempDir::new("cratesfyi").unwrap();
 
         // lets try to copy a src directory to tempdir
-        copy_doc_dir(source.path(), destination.path()).unwrap();
-        assert!(destination.path().join("index.html").exists());
-        assert!(!destination.path().join("index.txt").exists());
+        let res = copy_dir(Path::new("src"), destination.path());
+        // remove temp dir
+        fs::remove_dir_all(destination.path()).unwrap();
+
+        assert!(res.is_ok());
     }
 }
diff --git a/src/utils/github_updater.rs b/src/utils/github_updater.rs
@@ -9,11 +9,11 @@ use failure::err_msg;
 /// Fields we need use in cratesfyi
 #[derive(Debug)]
 struct GitHubFields {
-    description: String,
-    stars: i64,
-    forks: i64,
-    issues: i64,
-    last_commit: time::Timespec,
+    pub description: String,
+    pub stars: i64,
+    pub forks: i64,
+    pub issues: i64,
+    pub last_commit: time::Timespec,
 }
 
 
diff --git a/src/utils/mod.rs b/src/utils/mod.rs
@@ -1,12 +1,12 @@
 //! Various utilities for cratesfyi
 
 
-pub(crate) use self::copy::copy_doc_dir;
+pub use self::copy::{copy_dir, copy_doc_dir};
 pub use self::github_updater::github_updater;
 pub use self::release_activity_updater::update_release_activity;
 pub use self::daemon::start_daemon;
-pub(crate) use self::rustc_version::parse_rustc_version;
-pub(crate) use self::html::extract_head_and_body;
+pub use self::rustc_version::{parse_rustc_version, get_current_versions, command_result};
+pub use self::html::extract_head_and_body;
 pub use self::queue::add_crate_to_queue;
 pub(crate) use self::cargo_metadata::{CargoMetadata, Package as MetadataPackage};
 
diff --git a/src/utils/rustc_version.rs b/src/utils/rustc_version.rs
@@ -1,4 +1,5 @@
 
+use std::process::{Command, Output};
 use regex::Regex;
 use error::Result;
 use failure::err_msg;
@@ -17,6 +18,26 @@ pub fn parse_rustc_version<S: AsRef<str>>(version: S) -> Result<String> {
             captures.get(2).unwrap().as_str()))
 }
 
+
+/// Returns current version of rustc and cratesfyi
+pub fn get_current_versions() -> Result<(String, String)> {
+    let rustc_version = command_result(Command::new("rustc").arg("--version").output()?)?;
+    let cratesfyi_version = command_result(Command::new("rustc").arg("--version").output()?)?;
+
+    Ok((rustc_version, cratesfyi_version))
+}
+
+
+pub fn command_result(output: Output) -> Result<String> {
+    let mut command_out = String::from_utf8_lossy(&output.stdout).into_owned();
+    command_out.push_str(&String::from_utf8_lossy(&output.stderr).into_owned()[..]);
+    match output.status.success() {
+        true => Ok(command_out),
+        false => Err(err_msg(command_out)),
+    }
+}
+
+
 #[test]
 fn test_parse_rustc_version() {
     assert_eq!(parse_rustc_version("rustc 1.10.0-nightly (57ef01513 2016-05-23)").unwrap(),
diff --git a/src/web/crate_details.rs b/src/web/crate_details.rs
@@ -43,7 +43,7 @@ pub struct CrateDetails {
     github_stars: Option<i32>,
     github_forks: Option<i32>,
     github_issues: Option<i32>,
-    pub(crate) metadata: MetaData,
+    pub metadata: MetaData,
     is_library: bool,
     doc_targets: Option<Json>,
     license: Option<String>,
diff --git a/src/web/mod.rs b/src/web/mod.rs
diff --git a/src/web/releases.rs b/src/web/releases.rs
diff --git a/src/web/rustdoc.rs b/src/web/rustdoc.rs
diff --git a/src/web/source.rs b/src/web/source.rs

Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ fn get_file_list_from_dir<P: AsRef<Path>>(path: P,`
`42`	`42`	`}`
`43`	`43`
`44`	`44`
`45`		`-fn get_file_list<P: AsRef<Path>>(path: P) -> Result<Vec<PathBuf>> {`
	`45`	`+pub fn get_file_list<P: AsRef<Path>>(path: P) -> Result<Vec<PathBuf>> {`
`46`	`46`	`let path = path.as_ref();`
`47`	`47`	`let mut files = Vec::new();`
`48`	`48`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,6 @@ use std::borrow::Cow;`
`10`	`10`	`#[derive(Copy, Clone)]`
`11`	`11`	`enum ApplyMode {`
`12`	`12`	`Permanent,`
`13`		`- #[cfg(test)]`
`14`	`13`	`Temporary,`
`15`	`14`	`}`
`16`	`15`
`@@ -23,7 +22,6 @@ impl MigrationContext {`
`23`	`22`	`fn format_query<'a>(&self, query: &'a str) -> Cow<'a, str> {`
`24`	`23`	`match self.apply_mode {`
`25`	`24`	`ApplyMode::Permanent => Cow::Borrowed(query),`
`26`		`- #[cfg(test)]`
`27`	`25`	`ApplyMode::Temporary => {`
`28`	`26`	`Cow::Owned(query.replace("CREATE TABLE", "CREATE TEMPORARY TABLE"))`
`29`	`27`	`}`
`@@ -75,7 +73,6 @@ pub fn migrate(version: Option<Version>, conn: &Connection) -> CratesfyiResult<(`
`75`	`73`	`migrate_inner(version, conn, ApplyMode::Permanent)`
`76`	`74`	`}`
`77`	`75`
`78`		`-#[cfg(test)]`
`79`	`76`	`pub fn migrate_temporary(version: Option<Version>, conn: &Connection) -> CratesfyiResult<()> {`
`80`	`77`	`migrate_inner(version, conn, ApplyMode::Temporary)`
`81`	`78`	`}`