Improve this page on GitHub

Compile and test a Rust application

Using Codefresh pipelines

Codefresh can work with any Rust application very easily as both rustc and cargo are already offered in Dockerhub.

The example Rust project

You can see the example project at https://github.com/codefresh-contrib/rust-sample-app. The repository contains a Rust starter project with a dummy unit test.

  • cargo build compiles the code.
  • cargo test runs unit tests
  • cargo clean removes artifacts and binaries.

Create a CI pipeline for Rust applications

Creating a CI/CD pipeline for Rust is very easy, because Codefresh can run any Rust image that you wish. Rust docker images already contain the cargo package manager.

Compiling a Rust application in a pipeline

Compiling a Rust application in a pipeline

Here is the full pipeline that compiles the application after checking out the code.

codefresh.yml

version: "1.0"
stages:
  - "clone"
  - "build"
  - "test"
steps:
  clone:
    title: "Cloning repository"
    type: "git-clone"
    repo: "codefresh-contrib/rust-sample-app"
    revision: "master"
    stage: "clone"
  compile:
    title: "Building Code"
    type: "freestyle" 
    image: "rust:1.44-stretch" 
    working_directory: "${{clone}}" 
    environment:
      - CARGO_HOME=/codefresh/volume/cargo
    commands:
      - "cargo build"
    stage: "build"    
  test:
    title: "Running tests"
    type: "freestyle" 
    image: "rust:1.44-stretch" 
    working_directory: "${{clone}}" 
    environment:
      - CARGO_HOME=/codefresh/volume/cargo    
    commands:
      - "cargo test"
    stage: "test"

This pipeline clones the source code, compiles the code and runs unit tests. In all cases we use the public Docker image of Rust that also contains cargo.

We also pass the CARGO_HOME environment variable to place the Cargo cache on the shared Codefresh volume. See the Caching documentation for more details.

Codefresh YAML for pipeline definitions
Steps in pipelines
Creating pipelines
How Codefresh pipelines work