Source code
Revision control
Copy as Markdown
Other Tools
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// #[allow(dead_code)] is required on this module as a workaround for
#![allow(dead_code)]
use std::{panic, process};
use glean::{ClientInfoMetrics, Configuration};
/// Initialize the env logger for a test environment.
///
/// When testing we want all logs to go to stdout/stderr by default.
pub fn enable_test_logging() {
let _ = env_logger::builder().is_test(true).try_init();
}
/// Install a panic handler that exits the whole process when a panic occurs.
///
/// This causes the process to exit even if a thread panics.
/// This is similar to the `panic=abort` configuration, but works in the default configuration
/// (as used by `cargo test`).
fn install_panic_handler() {
let orig_hook = panic::take_hook();
panic::set_hook(Box::new(move |panic_info| {
// invoke the default handler and exit the process
orig_hook(panic_info);
process::exit(1);
}));
}
/// Create a new instance of Glean.
pub fn initialize(cfg: Configuration) {
// Ensure panics in threads, such as the init thread or the dispatcher, cause the process to
// exit.
//
// Otherwise in case of a panic in a thread the integration test will just hang.
// CI will terminate it after a timeout, but why stick around if we know nothing is happening?
install_panic_handler();
// Use some default values to make our life easier a bit.
let client_info = ClientInfoMetrics {
app_build: "1.0.0".to_string(),
app_display_version: "1.0.0".to_string(),
channel: Some("testing".to_string()),
locale: Some("xx-XX".to_string()),
};
glean::initialize(cfg, client_info);
}