Giter Club home page Giter Club logo

rcov's Introduction

rcov - Rust Code Coverage

Building off of the techniques in this paper, I will build a code coverage tool for Rust, in Rust.

Installation

This won't work until this is properly finished, but I anticipate installation will look something like this:

Note: This is currently only supported on Rust nightly because the plugin API is not on the stable channel

Add the crate to your dev-dependencies section in Cargo.toml:

[dev-dependencies]
rcov = "stable"

Add these lines to the top of your executable's main file:

#![feature(plugin)]
#![plugin(rcov)]

#![coverage]

These lines enable the required feature, load the plugin and apply the coverage syntax extension to the entire crate.

Running cargo test for your project should now instrument your code and result in a code coverage file being produced.

TODO: There should be some way to make coverage optionally compile only in the test executable (using cfg(test)?)

Build & Test

Standard cargo commands apply.

Use this to run the example:

cargo run --example sample

Use this to run the tests and the examples too

cargo test

rcov's People

Contributors

sunjay avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.