Split integration test into multiple files

[KSXGitHub]

Fix #85

An additional issue arises: cargo test warns me of unused items in helper module. This happens because the items are only used by test functions in test-only context. I don't know how to fix this other than #[allow(dead_code)].

[svenstaro]

Can't you properly fix the warnings using cfg(test)? This way, the helper stuff will only be compiled in test mode.

…

On Sun, Apr 28, 2019, 20:13 Khải ***@***.***> wrote: Fix #85 <#85> *An additional issue arises:* Warnings of unused items in helper module: This happens because the items are only used by test functions in test-only context. I don't know how to fix this other than #[allow(dead_code)]. ------------------------------ You can view, comment on, or merge this pull request online at: #91 Commit Summary - Split integration test into multiple files File Changes - *A* tests/auth.rs <https://github.com/svenstaro/miniserve/pull/91/files#diff-0> (50) - *M* tests/cli.rs <https://github.com/svenstaro/miniserve/pull/91/files#diff-1> (176) - *A* tests/helpers.rs <https://github.com/svenstaro/miniserve/pull/91/files#diff-2> (37) - *A* tests/serve_request.rs <https://github.com/svenstaro/miniserve/pull/91/files#diff-3> (44) - *A* tests/upload_files.rs <https://github.com/svenstaro/miniserve/pull/91/files#diff-4> (51) Patch Links: - https://github.com/svenstaro/miniserve/pull/91.patch - https://github.com/svenstaro/miniserve/pull/91.diff — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#91>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAAANAF4XAHTBN3BDH32N3TPSXSNZANCNFSM4HI7B5IA> .

[KSXGitHub]

Can't you properly fix the warnings using cfg(test)?

How exactly am I going to do this? I mean, if they are all in a single file, I can wrap them in a #[cfg(test)] mod, but they're scattered in multiple files.

[ghost]

You could move the files into a subfolder of tests, call it integration or whatever you think is a good name. It should solve the unused code warnings.

[KSXGitHub]

@boastful-squirrel Your suggestion also hides dead code warnings, are you sure it is not #[allow(dead_code) with extra steps?

For reference: Here's what I did

[svenstaro]

According to the official guide, you're supposed to make it tests/helpers/mod.rs instead of tests/helpers.rs.

[svenstaro]

Also please call it fixtures.rs as rstest mimicks pytest and there it's common to call this sort of thing fixtures.

[KSXGitHub]

@svenstaro Is this what you suggested?

Warnings didn't go anywhere:

[svenstaro]

Looks exactly like rust-lang/rust#46379

Putting it under tests/fixtures/mod.rs does have one benefit though: It makes cargo stop trying to run it as a test.

[svenstaro]

The workaround mentioned in the issue works btw but it does hide real dead code. Overall I'm not happy with this and I'm not sure what the best solution would be.

[KSXGitHub]

Putting it under tests/fixtures/mod.rs does have one benefit though: It makes cargo stop trying to run it as a test.

I believe not marking a function #[test] (or #[rstest]) makes cargo stop trying to run it as a test.

[KSXGitHub]

I'm not sure what the best solution would be.

The best solution at the moment in my opinion is to #[allow(dead_code)]

[svenstaro]

Putting it under tests/fixtures/mod.rs does have one benefit though: It makes cargo stop trying to run it as a test.

I believe not marking a function #[test] (or #[rstest]) makes cargo stop trying to run it as a test.

True, but sadly it doesn't make cargo stop compiling the file. For that, you'll need to do the mod.rs trick.

I agree, for now, using #[allow(dead_code)] is the best choice. But please document why you use that somewhere in the file and maybe link the cargo bug report.

[KSXGitHub]

True, but sadly it doesn't make cargo stop compiling the file. For that, you'll need to do the mod.rs trick.

Would writing a #[test] function in mod.rs disproves your claim? (I haven't try it yet)

[svenstaro]

True, but sadly it doesn't make cargo stop compiling the file. For that, you'll need to do the mod.rs trick.

Would writing a #[test] function in mod.rs disproves your claim? (I haven't try it yet)

Well, it's not my claim, it's what's written in the docs. You can try, though. Let's get this merged.

[KSXGitHub]

Let's get this merged.

Not yet.

[KSXGitHub]

I have moved helpers.rs to fixtures/mod.rs for organizational purpose only, not for cargo test to ignore the file (it does not, I just tested it).

@svenstaro Please review

[svenstaro]

Actually putting stuff into fixtures/mod.rs does work exactly as expected. Compare the output of cargo test.

cargo test with tests/fixtures.rs:

test result: ok. 15 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out

     Running target/debug/deps/auth-f85dbcb4ad30be17

running 3 tests
test auth_works::case_3 ... ok
test auth_works::case_1 ... ok
test auth_works::case_2 ... ok

test result: ok. 3 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out

     Running target/debug/deps/cli-13adc5119dab8f54

running 2 tests
test version_shows ... ok
test help_shows ... ok

test result: ok. 2 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out

     Running target/debug/deps/fixtures-a0fdb7b285082d65

running 0 tests

test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out

     Running target/debug/deps/serve_request-86b061418b6f5951

running 2 tests
test serves_requests_with_no_options ... ok
test serves_requests_with_non_default_port ... ok

test result: ok. 2 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out

     Running target/debug/deps/upload_files-b935706e952a427b

running 1 test
test uploading_files_works ... ok

test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out

cargo test with tests/fixtures/mod.rs:

test result: ok. 15 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out

     Running target/debug/deps/auth-f85dbcb4ad30be17

running 3 tests
test auth_works::case_2 ... ok
test auth_works::case_1 ... ok
test auth_works::case_3 ... ok

test result: ok. 3 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out

     Running target/debug/deps/cli-13adc5119dab8f54

running 2 tests
test version_shows ... ok
test help_shows ... ok

test result: ok. 2 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out

     Running target/debug/deps/serve_request-86b061418b6f5951

running 2 tests
test serves_requests_with_no_options ... ok
test serves_requests_with_non_default_port ... ok

test result: ok. 2 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out

     Running target/debug/deps/upload_files-b935706e952a427b

running 1 test
test uploading_files_works ... ok

test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out

Since you're saying that you cannot reproduce this, what cargo version are you using? It might be worth reporting this upstream if this is a regression.