What is the difference between `#[cfg(test)]` and `#[cfg(feature = "test")]`? - rust

I would like to understand the difference between #[cfg(test)] and #[cfg(feature = "test")], preferably demonstrated through examples.

#[cfg(test)] marks something to be compiled only when the test config option is enabled, while #[cfg(feature = "test")] marks something to be compiled only when the feature = "test" config option is enabled.
When running cargo test, one of the things that happens is that rustc is passed the --test flag which (among other things) "enables the test cfg option". This is usually used to conditionally compile the test module only when you want to run the tests.
Features are something that cargo uses for general conditional compilation (and optional dependencies).
Try running:
#[cfg(feature="test")]
mod fake_test {
#[test]
fn fake_test() {
panic!("This function is NOT tested");
}
}
#[cfg(test)]
mod test {
#[test]
fn test() {
panic!("This function is tested");
}
}
Output will be:
running 1 test
test test::test ... FAILED
failures:
---- test::test stdout ----
thread 'test::test' panicked at 'This function is tested', src/lib.rs:13:9
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
failures:
test::test
test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
Which shows that the fake test module was not enabled.

Related

rust/cargo read env from shell and reuse them instread of explicity setting them in front of command everytime

I want to run a rust test with some env, like:
use std::env;
#[test]
fn test_case1() {
env::var("ENV1").unwrap();
env::var("ENV2").unwrap();
}
#[test]
fn test_case2() {
env::var("ENV1").unwrap();
env::var("ENV2").unwrap();
}
ENV1=ABC ENV2=123 cargo test test_case1
But I want to only set these env once and I can reuse them in the shell, like:
ENV1=ABC ENV2=123
echo $ENV1 // ABC
echo $ENV2 // 123
cargo test test_case1 // test_case1 will read ENV1, ENV2 then quit,
cargo test test_case2 // test_case2 will read ENV1, ENV2 too
How can I do it?

Tests fail when renaming identifiers, etc

I've got a large repo in which I noticed that some tests started failing after I added a dependency to Cargo.toml, despite the dependency never being referenced. I began to investigate, and was able to reproduce the problem consistently in this repo. I'll reproduce the code of the main file here:
mod test {
pub fn b<T>(db: *mut libsqlite3_sys::sqlite3, _: T) {
let rc = unsafe {
libsqlite3_sys::sqlite3_create_function(
db, // db
"x".as_ptr() as _, // zFunction
0, // nArg
0, // eTextRep
std::ptr::null_mut(), // pApp
None, // xFunc
None, // xStep
None, // xFinal
)
};
match rc {
libsqlite3_sys::SQLITE_MISUSE => (),
x => panic!("Wanted SQLITE_MISUSE, got {:?}", x),
}
}
}
#[test]
#[ignore]
fn z() {
format!("{:?}", &[1, 2, 3, 4]);
panic!("not run");
}
#[test]
fn a() {
const FILENAME: &[u8] = b":memory:\0";
let mut db: *mut libsqlite3_sys::sqlite3 = std::ptr::null_mut();
let rc = unsafe { libsqlite3_sys::sqlite3_open(FILENAME.as_ptr() as _, &mut db) };
assert_eq!(rc, libsqlite3_sys::SQLITE_OK);
test::b(db, 0);
}
On my computer, these tests pass, meaning that sqlite3_create_function is returning SQLITE_MISUSE.
$ cargo test --lib --features=static
Finished test [unoptimized + debuginfo] target(s) in 0.52s
Running unittests src/lib.rs (target/debug/deps/sqlite3_ext-5449511dde1f34ef)
running 2 tests
test z ... ignored
test a ... ok
test result: ok. 1 passed; 0 failed; 1 ignored; 0 measured; 0 filtered out; finished in 0.01s
Now, it shouldn't be returning MISUSE, because as far as I can tell everything about this code is valid. However, here's where it gets weird:
If I don't use --features=static, the test fails. Note that nothing references this feature whatsoever.
If I remove the format! line, the test fails. Note that the code is never called.
If I add or remove any dependencies to Cargo.toml, the test fails. None of the changes are referenced anywhere in the code.
If I rename the feature "static" to anything else, the test fails.
If I rename the module "test" to anything else, the test fails.
If I run this code on Linux, the test fails.
I am able to add [features] joke = [] to Cargo.toml, and then I get this behavior:
cargo test --lib --features=joke fails (no MISUSE)
cargo test --lib --features=static passes (MISUSE)
cargo test --lib --features=static,joke fails (no MISUSE)
I am at my wit's end. I am running macOS 10.14.6 (18G9323), rustc 1.61.0 (fe5b13d68 2022-05-18). Any help would be greatly appreciated. I've also uploaded binaries to GitHub for investigation if it helps.
Thanks to #thomcc who responded on the rusqlite Discord:
you’re not passing a nul-terminated string to c for one
This was the issue. In most cases the only problem this caused was that my application-defined function was never removed, but in this particular case it resulted in an SQLITE_MISUSE being returned. Properly converting my &str to CString resolves the issue.

Lazy once_cell causes stack overflow

The code:
use once_cell::sync::Lazy;
fn main() {
const TEST: Lazy<[[u64; 64]; 512]> = Lazy::new(|| unimplemented!());
TEST[0];
}
Results in the output:
thread 'main' has overflowed its stack
error: process didn't exit successfully: `target\debug\chess_ai.exe` (exit code: 0xc00000fd, STATUS_STACK_OVERFLOW)
Weirdly enough only on windows. On Linux (WSL Debian GNU/Linux 9), the output is the expected:
Finished dev [unoptimized + debuginfo] target(s) in 23.38s
Running `target/debug/chess_ai`
thread 'main' panicked at 'not implemented', src/main.rs:4:56
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
Am I being a banana, lol? I don't understand at all what's going on here. This is also a pretty hard roadblock for me right now, so I really appreciate responses!
Playground version works as expected.
Versions
once_cell: "1.12.0"
rustc (both windows and Linux): "1.61.0"
So after some testing it seems like the stack is just not big enough to contain my variable, since this, plain, piece of code also results in a stackoverflow:
fn main() {
let test: [[u64; 64]; 3000] = [[0; 64]; 3000];
test[0];
}
Given that the const in the question is not really "generated"/"created" (lazy initialization) at compile time, it happens inside a stack-frame and most likely causes the stackoverflow.
Moving the data to the heap fixes the issue:
use once_cell::sync::Lazy;
fn main() {
static TEST: Lazy<Box<[[u64; 64]; 512]>> = Lazy::new(|| unimplemented!());
TEST[0];
}
Seems like windows and Linux versions have different stack sizes, or the code is optimized differently.

Rust playground - provide command line argument

I am using the Rust Playground to test a piece of code, sample:
use std::env;
fn main() {
let args: Vec<String> = env::args().collect();
let query = args.get(1).unwrap();
// do something ...
}
Playground link
How do I provide a command-line argument for running a program in Rust Playground? The sample drop-down next to the run button does not have any link or perhaps I am missing it?
Thanks!
You can't, there is an open issue for this feature
As #Stargateur correctly answered, it's currently impossible to provide input for the playground code itself. However, there's a little trick which can work in relatively simple cases: we can execute std::process::Command, which starts bash, which can execute arbitrary code - including cargo.
Here's how it can look like, for example:
// This is your real `fn main`, which would use the input.
// It can contain everything that's usually possible in the playground.
#[cfg(real_main)]
fn main() {
let args: Vec<String> = std::env::args().collect();
println!("Args: {:?}", args);
}
// This is the wrapper-function, directly executed by the playground.
#[cfg(not(real_main))]
fn main() {
// We're shelling out to `bash`, to execute `cargo run` with additional config.
let _ = std::process::Command::new("/bin/bash")
.args(&[
"-c",
concat!(
r##"{
"##,
// In case we have any kind of error, we want to exit loudly.
r##"
set -euo pipefail
"##,
// `cargo rustc` allows one to pass additional compiler flags.
// It's important that this will recompile the current crate only,
// since, if we had to build the whole dependency tree
// (which is quite large), playground will inevitably timeout.
r##"
cargo rustc -q -- --cfg real_main
"##,
// When building in release mode, replace `target/debug`
// with `target/release`.
r##"
./target/debug/playground arg1 arg2 arg3
"##,
// Finally, we rediirect the stderr of the whole script to stdout,
// to show it in the playground output.
r##"
} 2>&1"##
),
])
// On running `Command::status`, output is piped by default,
// so it will be shown as usual.
.status();
}
Playground link

oxipng throwing RuntimeError: unreachable when called

I'm trying to create a small WASM project for image compression.
After some search in github, I noticed that oxipng 2.2.2 has a target for wasm32-unknown-unknown, hence why I'm using that.
I'm using wasm-pack for creating the wasm file + JS bindings with target -t web
This is the code:
extern crate oxipng;
mod utils;
use std::error::Error;
use wasm_bindgen::prelude::*;
use oxipng::*;
#[wasm_bindgen]
extern "C" {
// Use `js_namespace` here to bind `console.log(..)` instead of just
// `log(..)`
#[wasm_bindgen(js_namespace = console)]
fn log(s: &str);
}
// Next let's define a macro that's like `println!`, only it works for
// `console.log`. Note that `println!` doesn't actually work on the wasm target
// because the standard library currently just eats all output. To get
// `println!`-like behavior in your app you'll likely want a macro like this.
#[macro_export]
macro_rules! console_log {
// Note that this is using the `log` function imported above during
// `bare_bones`
($($t:tt)*) => (crate::log(&format_args!($($t)*).to_string()))
}
// When the `wee_alloc` feature is enabled, use `wee_alloc` as the global
// allocator.
#[cfg(feature = "wee_alloc")]
#[global_allocator]
static ALLOC: wee_alloc::WeeAlloc = wee_alloc::WeeAlloc::INIT;
#[wasm_bindgen]
pub fn compress(data: &[u8]) -> Vec<u8> {
console_log!("{}", data.len());
let opts = Options::from_preset(6);
console_log!("after options");
let res = match optimize_from_memory(data, &&opts) {
Ok(res) => Ok(res),
Err(err) => Err(err),
};
match &res {
Ok(_) => console_log!("Optimized"),
Err(err) => console_log!("Error: {}", err),
}
return res.unwrap();
}
I don't ever get an error message, the last log I have is "after options".
In a nutshell, I'm using a Flutter web application that gets a PNG file, converts it into a Uint8List, and I send it as an integer List to the JS bindings.
When called, the following error happens:
RuntimeError: unreachable
at http://localhost:3000/pkg/rust_png_module_bg.wasm:wasm-function[1019]:0x5c6be
at http://localhost:3000/pkg/rust_png_module_bg.wasm:wasm-function[414]:0x4cd37
at http://localhost:3000/pkg/rust_png_module_bg.wasm:wasm-function[619]:0x54c96
at http://localhost:3000/pkg/rust_png_module_bg.wasm:wasm-function[915]:0x5b4ba
at http://localhost:3000/pkg/rust_png_module_bg.wasm:wasm-function[986]:0x5c139
at http://localhost:3000/pkg/rust_png_module_bg.wasm:wasm-function[645]:0x55885
at http://localhost:3000/pkg/rust_png_module_bg.wasm:wasm-function[569]:0x5324b
at http://localhost:3000/pkg/rust_png_module_bg.wasm:wasm-function[594]:0x53ff1
at http://localhost:3000/pkg/rust_png_module_bg.wasm:wasm-function[2]:0x554f
at http://localhost:3000/pkg/rust_png_module_bg.wasm:wasm-function[84]:0x2cbf2
at http://localhost:3000/pkg/rust_png_module_bg.wasm:wasm-function[73]:0x2a501
at http://localhost:3000/pkg/rust_png_module_bg.wasm:wasm-function[563]:0x52eaa
at compress (http://localhost:3000/pkg/rust_png_module.js:49:14)
at compressImage (http://localhost:3000/packages/rust_wasm/ui/screens/home/home_page.dart.lib.js:568:72)
at compressImage.next (<anonymous>)
at http://localhost:3000/dart_sdk.js:38640:33
at _RootZone.runUnary (http://localhost:3000/dart_sdk.js:38511:59)
at _FutureListener.thenAwait.handleValue (http://localhost:3000/dart_sdk.js:33713:29)
at handleValueCallback (http://localhost:3000/dart_sdk.js:34265:49)
at Function._propagateToListeners (http://localhost:3000/dart_sdk.js:34303:17)
at _Future.new.[_completeWithValue] (http://localhost:3000/dart_sdk.js:34151:23)
at async._AsyncCallbackEntry.new.callback (http://localhost:3000/dart_sdk.js:34172:35)
at Object._microtaskLoop (http://localhost:3000/dart_sdk.js:38778:13)
at _startMicrotaskLoop (http://localhost:3000/dart_sdk.js:38784:13)
at http://localhost:3000/dart_sdk.js:34519:9
Since this version is old, I don't know if I should revert back to an older version of Rust
$ rustup --version
rustup 1.24.3 (ce5817a94 2021-05-31)
info: This is the version for the rustup toolchain manager, not the rustc compiler.
info: The currently active `rustc` version is `rustc 1.55.0 (c8dfcfe04 2021-09-06)`
Thank you in advance
The problem is you're using a very old version of oxipng (v2.2.2) that didn't support wasm yet. I believe wasm support was added in v2.3.0 (link to issue that was fixed). Anyways, you should be able to use the latest version just fine with wasm, just make sure you disable the default features when adding the crate to your Cargo.toml:
[dependencies]
oxipng = { version = "5", default-features = false }

Resources