Add a way to use dioxus-i18n in tests

[breard-r]

Hello,

Currently, it seems impossible to use dioxus-i18n in tests. Trying to use use_init_i18n in a test function results in a panic with the following message:

to be in a dioxus runtime

Not initializing it obviously fails too.

It would be nice to have a way to test the translations.

Example use case: An internationalized Dioxus app that need to display an unsigned integer in letters and therefore need to test that, for each supported language, the algorithm converts the integer into the correct words.

[marc2332]

Hey, I missed this issue, can you share some code? It shouldn't be impossible to use in tests

[breard-r]

Sure, here is a minimalist example. The goal is to be able to run cargo test without modifying get_something().

I might do the tests wrong and I'm clearly not sure about init_i18n(). Still, after testing several alternatives, I never found a way to run the tests.

use dioxus::prelude::*;
use dioxus_i18n::prelude::*;
use dioxus_i18n::t;
use dioxus_i18n::unic_langid::langid;

const LOCALE_EN_US: &str = r#"
something = hello
something_else = world
"#;
const LOCALE_FR_FR: &str = r#"
something = bonjour
something_else = monde
"#;

fn main() {
    LaunchBuilder::desktop().launch(App)
}

#[component]
pub fn App() -> Element {
    let _ = use_init_i18n(|| {
        I18nConfig::new(langid!("en-US"))
            .with_locale(Locale::new_static(langid!("en-US"), LOCALE_EN_US))
            .with_locale(Locale::new_static(langid!("fr-FR"), LOCALE_FR_FR))
    });

    rsx! {
        h1 {{ get_something() }}
    }
}

fn get_something() -> String {
    let mut s = t!("something");
    s += " ";
    s += t!("something_else").as_str();
    s
}

#[cfg(test)]
mod tests {
    use super::*;
    use dioxus_i18n::unic_langid::LanguageIdentifier;

    fn init_i18n(lang_id: LanguageIdentifier) {
        let _ = use_init_i18n(|| {
            I18nConfig::new(lang_id)
                .with_locale(Locale::new_static(langid!("en-US"), LOCALE_EN_US))
                .with_locale(Locale::new_static(langid!("fr-FR"), LOCALE_FR_FR))
        });
    }

    #[test]
    fn test_get_something_en_us() {
        init_i18n(langid!("en-US"));
        assert_eq!(get_something(), "hello world".to_string());
    }

    #[test]
    fn test_get_something_fr_fr() {
        init_i18n(langid!("fr-FR"));
        assert_eq!(get_something(), "bonjour monde".to_string());
    }
}

[nigeleke]

@breard-r I've semi-successfully completed tests in this current PR #11. I agree testing is tricky because of the requirement to run within a dioxus context. Within the existing test_hook setup panics panic silently, which isn't ideal.

@marc2332 another proposal ;) - enable signal and non-signal versions of I18n to simplify basic translation testing. Again - happy to take this on if you wish - just assign this issue to me if so...

[marc2332]

Somehow I missed your message @breard-r, sorry about that. Hooks are special functions that need to run inside Dioxus VirtualDOM, therefore you cant just call them like that.

You would need something like test_hook as @nigeleke mentioned. Random idea: Make this test_hook function more powerful and turn it into a crate

@marc2332 another proposal ;) - enable signal and non-signal versions of I18n to simplify basic translation testing. Again - happy to take this on if you wish - just assign this issue to me if so...

I don't quite see how would this work or why is it even needed 👁️

[nigeleke]

I definitely think dioxus requires a test framework of some kind, even if it's single threaded / single use...

Re how to implement this... I don't know either yet... but I do feel the dioxus-i18n lib could be pretty useful outside of dioxus too.

On reflection - time would probably be better spent on a more generic test hook approach. I think I need a crash course on dioxus internals before tackling that one though.