Skip to content
🎁 cargo plugin for quickly fetching dependencies πŸ¦€
Rust
Branch: master
Clone or download
Jake-Shadle Refactor to use Backend trait (#11)
Also fixes up s3 url parsing and some other bugs 
in the s3 impl (as far as I can tell without testing)
Latest commit dd0bfbc Oct 28, 2019

README.md

🎁 cargo-fetcher

Build Status Crates.io Docs Contributor Covenant Embark

Alternative to cargo fetch for use in CI or other "clean" environments that you want to quickly bootstrap with the necessary crates to compile/test etc your project(s).

Why?

  • You run CI jobs inside of GCP and you want faster crates.io and git downloads so that your compute resources can be spent on the things that you actually care about.

Why not?

  • You don't run CI inside of GCP. Currently cargo-fetcher only supports storing crates/git snapshots inside of GCS which means they can be located closer to the compute resources your CI is running on. PRs are of course welcome for adding additional storage backends though!
  • cargo-fetcher should not be used in a typical user environment as it completely disregards various safety mechanisms that are built into cargo, such as file-based locking.
  • You project doesn't have a Cargo.lock file. cargo-fetcher only works with Cargo.lock files (due to how cargo fetch works), so library crates without checked in lock files won't be able to use cargo-fetcher.

Features

gcs

The gcs feature enables the use of Google Cloud Storage as a backend.

  • Must provide a url to the -u | --url parameter with the gsutil syntax gs://<bucket_name>(/<prefix>)?
  • Must provide GCP service account credentials either with --credentials or via the GOOGLE_APPLICATION_CREDENTIALS environment variable

s3

The s3 feature enables the use of Amazon S3 as a backend.

  • Must provide a url to the -u | --url parameter, it must of the form http(s)?://<bucket>.s3(-<region>).<host>(/<prefix>)?
  • Must provide AWS credentials by the default mechanism(s) described here

Examples

This is an example from our CI for an internal project.

Dependencies

  • 424 crates.io crates: cached - 38MB, unpacked - 214MB
  • 13 crates source from 10 git repositories: db - 27MB, checked out - 38MB

Scenario

The following CI jobs are run in parallel, each in a Kubernetes Job running on GKE. The container base is roughly the same as the official rust:1.36.0-slim image.

  • Build modules for WASM
  • Build modules for native
  • Build host client for native

~ wait for all jobs to finish ~

  • Run the tests for both the WASM and native modules from the host client

Before

All 3 build jobs take around 1m2s each to do cargo fetch --target x86_64-unknown-linux-gnu

After

All 3 build jobs take 2-3s each to do cargo fetcher --include-index mirror followed by 6s to do cargo fetch --target x86_64-unknown-linux-gnu. The 6s can probably be further reduced.

Contributing

We welcome community contributions to this project.

Please read our Contributor Guide for more information on how to get started.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

You can’t perform that action at this time.