Remove dont_skip_tests feature #27
Conversation
danielocfb
force-pushed
the
topic/ignore-test
branch
from
b4aab41
to
7a4b06a
Compare
|
What is the version of the |
It's an option of the test. You can try |
Sorry I wrote it wrong in the description. Will update. But actually stuff is failing now. Will fix it. |
danielocfb
force-pushed
the
topic/ignore-test
branch
from
7a4b06a
to
7565259
Compare
So the problem is that once we try to use ignored tests, the snippets from the README are compiled and they are broken right now. So for the time being I am patching them up quickly, but really we should fix the outdated stuff in there and document the current API. |
|
Some snippets are supposed to be incomplete, and some of them are C code. Should we tag them as text? |
They are actually broken. |
|
What I am saying is that some snippets are supposed to be incomplete. And some of them are C examples. Although some snippets can be compiled, but these codes are not supposed to be tested for lack of the right environment. For example, it symbolizes a random address in an example. A random address is not going to work. So, they are ignored for good reasons. So, what is the solution for these cases? Tag them as text? |
Well, I think you are conflating compiling them and running them. Nobody is talking about running anything. Yes, I can see that some are not meant to be compiled. And yet, they should not reference obviously non-existent symbols, should they? That is confusing at best to anyone trying out the crate based on the README and should be fixed up. C language snippets should be fixed in exactly the way I did fix them: by tagging them as C. |
danielocfb
force-pushed
the
topic/ignore-test
branch
from
7565259
to
80c4063
Compare
|
Okay, I fixed up everything now. Let me know what you think. |
No one said that. I just asked what your plan was. It doesn't work without the changes that you just did. You just need to tell me your plan or just show me the changes. |
danielocfb
force-pushed
the
topic/ignore-test
branch
from
80c4063
to
80e0045
Compare
We don't need a feature if we don't want to skip a test based on a runtime condition. We can just make it an ignored one, in which case it can be run with `cargo test -- --ignored`. Hence, remove the feature and mark the one test using it as ignored instead. Note that currently the README contains broken code snippets. I fixed it up to at least allow running of ignored tests, but it really should be updated to use the up-to-date API. Signed-off-by: Daniel Müller <deso@posteo.net>
The code snippets in the README are outdated. The SymSrcCfg type mentioned there, for example, seems to have been renamed in the library to SymbolSrcCfg eons ago. Update the README accordingly. Also tag Rust code snippets as Rust code and C snippets as C. That has both the effect that it will ensure proper handling of doc tests (C snippets are ignored) while providing correct syntax highlighting. Note that not all snippets can (or are intended to) compile, but those that can are fully fixed up now and checked as part of CI by tagging them with `no_run` instead of `ignore`. Closes: libbpf#32 Signed-off-by: Daniel Müller <deso@posteo.net>
danielocfb
force-pushed
the
topic/ignore-test
branch
from
80e0045
to
49b1826
Compare
We don't need a feature if we don't want to skip a test based on a runtime condition. We can just make it an ignored one, in which case it can be run with
cargo test -- --ignored.Hence, remove the feature and mark the one test using it as ignored instead.
Signed-off-by: Daniel Müller deso@posteo.net