Skip to content

Use default-target to build package #255

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 1, 2018
Merged

Use default-target to build package #255

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ad9a314
Use default_target to build package
onur Oct 24, 2018
0644198
It's winapi not win-api
onur Oct 26, 2018
8030fe1
Use if let when pushing target
onur Nov 1, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 49 additions & 22 deletions src/docbuilder/chroot_builder.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@

use super::DocBuilder;
use super::crates::crates_from_path;
use super::metadata::Metadata;
use utils::{get_package, source_path, copy_dir, copy_doc_dir,
update_sources, parse_rustc_version, command_result};
use db::{connect_db, add_package_into_database, add_build_into_database, add_path_into_database};
Expand Down Expand Up @@ -81,15 +82,19 @@ impl DocBuilder {

// get_package (and cargo) is using semver, add '=' in front of version.
let pkg = try!(get_package(name, Some(&format!("={}", version)[..])));
let res = self.build_package_in_chroot(&pkg);
let metadata = Metadata::from_package(&pkg)?;
let res = self.build_package_in_chroot(&pkg, metadata.default_target.clone());

// copy sources and documentation
let file_list = try!(self.add_sources_into_database(&conn, &pkg));
let successfully_targets = if res.have_doc {
try!(self.copy_documentation(&pkg, &res.rustc_version, None));
try!(self.copy_documentation(&pkg,
&res.rustc_version,
metadata.default_target.as_ref().map(String::as_str),
true));
let successfully_targets = self.build_package_for_all_targets(&pkg);
for target in &successfully_targets {
try!(self.copy_documentation(&pkg, &res.rustc_version, Some(target)));
try!(self.copy_documentation(&pkg, &res.rustc_version, Some(target), false));
}
try!(self.add_documentation_into_database(&conn, &pkg));
successfully_targets
Expand All @@ -115,18 +120,19 @@ impl DocBuilder {


/// Builds documentation of a package with cratesfyi in chroot environment
fn build_package_in_chroot(&self, package: &Package) -> ChrootBuilderResult {
fn build_package_in_chroot(&self, package: &Package, default_target: Option<String>) -> ChrootBuilderResult {
debug!("Building package in chroot");
let (rustc_version, cratesfyi_version) = self.get_versions();
let cmd = format!("cratesfyi doc {} ={}",
let cmd = format!("cratesfyi doc {} ={} {}",
package.manifest().name(),
package.manifest().version());
package.manifest().version(),
default_target.as_ref().unwrap_or(&"".to_string()));
match self.chroot_command(cmd) {
Ok(o) => {
ChrootBuilderResult {
output: o,
build_success: true,
have_doc: self.have_documentation(&package),
have_doc: self.have_documentation(&package, default_target),
have_examples: self.have_examples(&package),
rustc_version: rustc_version,
cratesfyi_version: cratesfyi_version,
Expand Down Expand Up @@ -194,22 +200,38 @@ impl DocBuilder {
fn copy_documentation(&self,
package: &Package,
rustc_version: &str,
target: Option<&str>)
target: Option<&str>,
is_default_target: bool)
-> Result<()> {
let crate_doc_path = PathBuf::from(&self.options.chroot_path)
let mut crate_doc_path = PathBuf::from(&self.options.chroot_path)
.join("home")
.join(&self.options.chroot_user)
.join("cratesfyi")
.join(target.unwrap_or(""));
let destination = PathBuf::from(&self.options.destination)
.join("cratesfyi");

// docs are available in cratesfyi/$TARGET when target is being used
if let Some(target) = target {
crate_doc_path.push(target);
}

let mut destination = PathBuf::from(&self.options.destination)
.join(format!("{}/{}",
package.manifest().name(),
package.manifest().version()))
.join(target.unwrap_or(""));
package.manifest().version()));

// only add target name to destination directory when we are copying a non-default target.
// this is allowing us to host documents in the root of the crate documentation directory.
// for example winapi will be available in docs.rs/winapi/$version/winapi/ for it's
// default target: x86_64-pc-windows-msvc. But since it will be built under
// cratesfyi/x86_64-pc-windows-msvc we still need target in this function.
if !is_default_target {
if let Some(target) = target {
destination.push(target);
}
}

copy_doc_dir(crate_doc_path,
destination,
parse_rustc_version(rustc_version)?.trim(),
target.is_some())
parse_rustc_version(rustc_version)?.trim())
}


Expand Down Expand Up @@ -270,13 +292,18 @@ impl DocBuilder {
///
/// This function is checking first target in targets to see if documentation exists for a
/// crate. Package must be successfully built in chroot environment first.
fn have_documentation(&self, package: &Package) -> bool {
let crate_doc_path = PathBuf::from(&self.options.chroot_path)
fn have_documentation(&self, package: &Package, default_target: Option<String>) -> bool {
let mut crate_doc_path = PathBuf::from(&self.options.chroot_path)
.join("home")
.join(&self.options.chroot_user)
.join("cratesfyi")
.join("doc")
.join(package.targets()[0].name().replace("-", "_").to_string());
.join("cratesfyi");

if let Some(default_doc_path) = default_target {
crate_doc_path.push(default_doc_path);
}

crate_doc_path.push("doc");
crate_doc_path.push(package.targets()[0].name().replace("-", "_").to_string());
crate_doc_path.exists()
}

Expand Down Expand Up @@ -352,7 +379,7 @@ impl DocBuilder {

// acme-client-0.0.0 is an empty library crate and it will always build
let pkg = try!(get_package("acme-client", Some("=0.0.0")));
let res = self.build_package_in_chroot(&pkg);
let res = self.build_package_in_chroot(&pkg, None);
let rustc_version = parse_rustc_version(&res.rustc_version)?;

if !res.build_success {
Expand Down
17 changes: 6 additions & 11 deletions src/utils/copy.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,7 @@ 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,
"",
false)
"")
}


Expand All @@ -27,23 +26,20 @@ pub fn copy_dir<P: AsRef<Path>>(source: P, destination: P) -> Result<()> {
/// 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,
target_platform: bool)
rustc_version: &str)
-> Result<()> {
let source = PathBuf::from(target.as_ref()).join("doc");
copy_files_and_handle_html(source,
destination.as_ref().to_path_buf(),
true,
rustc_version,
target_platform)
rustc_version)
}


fn copy_files_and_handle_html(source: PathBuf,
destination: PathBuf,
handle_html: bool,
rustc_version: &str,
target: bool)
rustc_version: &str)
-> Result<()> {

// FIXME: handle_html is useless since we started using --resource-suffix
Expand Down Expand Up @@ -72,8 +68,7 @@ fn copy_files_and_handle_html(source: PathBuf,
try!(copy_files_and_handle_html(file.path(),
destination_full_path,
handle_html,
&rustc_version,
target));
&rustc_version))
} else if handle_html && dup_regex.is_match(&file.file_name().into_string().unwrap()[..]) {
continue;
} else {
Expand Down Expand Up @@ -118,7 +113,7 @@ mod test {
let pkg_dir = format!("rand-{}", pkg.manifest().version());
let target = Path::new(&pkg_dir);
let destination = tempdir::TempDir::new("cratesfyi").unwrap();
let res = copy_doc_dir(target, destination.path(), "UNKNOWN", false);
let res = copy_doc_dir(target, destination.path(), "UNKNOWN");

// remove build and temp dir
fs::remove_dir_all(target).unwrap();
Expand Down