Cargo: Allow enabling / disabling doc tests as a CLI flag and a .cargo/config option

Created on 8 Jul 2015 · 10Comments · Source: rust-lang/cargo

It would be nice to be able to enable / disable doc tests as a CLI flag and a local (.cargo/config) option.

A-configuration C-feature-request Command-test

Source

carllerche

Most helpful comment

I have a lot of tests and it takes a long time to recompile them all. So it would be nice to have a flag that runs just the doctests.

I'm aware of cargo test --lib and cargo --test TEST but none of them reach the doctests subset.

bluss on 16 Mar 2016

👍3

All 10 comments

This was motivated because doctests don't work for cross-compiled testing right now, but we should also just fix that.

alexcrichton on 8 Jul 2015

This was motivated because doctests don't work for cross-compiled testing right now, but we should also just fix that.

What is the bug for that? I am hitting this when cross-compiling to i686 from x64_64 on the same OS.

briansmith on 31 Jan 2016

We may not actually have a bug open (I don't recall one off-hand), but if we did it'd be rattling around in rust-lang/rust somewhere

alexcrichton on 31 Jan 2016

I am running into this as well, would be really nice to get a fix here even outside the context of cross compiling (though that is where I am hitting an issue). Sometimes I just don't want to run doctests because they are slow, currently broken, etc. without making it a permanent option.

reem on 27 Feb 2016

I have a lot of tests and it takes a long time to recompile them all. So it would be nice to have a flag that runs just the doctests.

I'm aware of cargo test --lib and cargo --test TEST but none of them reach the doctests subset.

bluss on 16 Mar 2016

👍3

I think @alexcrichton implemented this in #2578.

jooert on 13 Jan 2018

@jooert --doc tests only the doctests but there isn't a way to disable them. (AFAIK)

Oops, looks like that's exactly what --lib does 🤦‍♂️

kbknapp on 3 Feb 2018

Shall we close this ticket?

Running just doc tests is available as cargo test --doc
Running just library tests without doc tests is available as cargo test --lib

The only thing left is disabling doc tests in .cargo/config, but is there much request for that? Do we want to include that?

dwijnand on 17 Nov 2018

👍1

Sounds good to me!

alexcrichton on 18 Nov 2018

~@jooert --doc tests only the doctests but there isn't a way to _disable_ them. (AFAIK)~

Oops, looks like that's exactly what --lib does 🤦‍♂️

Not quite, --lib doesn't seem to run the 'integration' tests from the integ library.

I found my way here because my IDE cannot attach a debugger when multiple binaries are produced. I believe doc tests must be in a separate binary?

So I have no way to run all tests, including the integ tests from the tests directory, and attach my IDE's debugging functionality. What I need is a --no-doc flag.