Make test_timeout configurable

Author: phil-opp

Readme.md

@@ -35,10 +35,15 @@ Configuration is done through a through a `[package.metadata.bootimage]` table i
 
 ```toml
     [package.metadata.bootimage]
-    default-target = ""         # This target is used if no `--target` is passed
+    # This target is used if no `--target` is passed
+    default-target = ""
+
     # The command invoked on `bootimage run`
     # (the "{}" will be replaced with the path to the bootable disk image)
     run-command = ["qemu-system-x86_64", "-drive", "format=raw,file={}"]
+
+    # The timeout for running an integration test in seconds
+    test-timeout = 300
 ```
 
 ## License

src/config.rs

@@ -7,6 +7,7 @@ pub struct Config {
     pub manifest_path: PathBuf,
     pub default_target: Option<String>,
     pub run_command: Vec<String>,
+    pub test_timeout: u64,
 }
 
 pub(crate) fn read_config(manifest_path: PathBuf) -> Result<Config, ErrorString> {
@@ -16,7 +17,7 @@ pub(crate) fn read_config(manifest_path: PathBuf) -> Result<Config, ErrorString>
 }
 
 pub(crate) fn read_config_inner(manifest_path: PathBuf) -> Result<Config, ErrorString> {
-    use std::{fs::File, io::Read};
+    use std::{convert::TryFrom, fs::File, io::Read};
     let cargo_toml: Value = {
         let mut content = String::new();
         File::open(&manifest_path)
@@ -53,6 +54,11 @@ pub(crate) fn read_config_inner(manifest_path: PathBuf) -> Result<Config, ErrorS
     for (key, value) in metadata {
         match (key.as_str(), value.clone()) {
             ("default-target", Value::String(s)) => config.default_target = From::from(s),
+            ("test-timeout", Value::Integer(s)) => {
+                config.test_timeout = u64::try_from(s)
+                    .map_err(|err| format!("test-timeout is not valid: {}", err))?
+                    .into()
+            }
             ("run-command", Value::Array(array)) => {
                 let mut command = Vec::new();
                 for value in array {
@@ -78,6 +84,7 @@ struct ConfigBuilder {
     manifest_path: Option<PathBuf>,
     default_target: Option<String>,
     run_command: Option<Vec<String>>,
+    test_timeout: Option<u64>,
 }
 
 impl Into<Config> for ConfigBuilder {
@@ -90,6 +97,7 @@ impl Into<Config> for ConfigBuilder {
                 "-drive".into(),
                 "format=raw,file={}".into(),
             ]),
+            test_timeout: self.test_timeout.unwrap_or(60 * 5),
         }
     }
 }

src/help/test_help.txt

@@ -15,3 +15,12 @@ USAGE:
 
     (for other forms of usage see `bootimage --help`)
     (for BUILD_OPTS see `bootimage build --help`)
+
+CONFIGURATION:
+    The behavior of `bootimage test` can be configured through a
+    `[package.metadata.bootimage]` table in the `Cargo.toml`. The
+    following options are available to configure test behavior:
+
+    [package.metadata.bootimage]
+    # The timeout for running an integration test in seconds
+    test-timeout = 300

src/subcommand/test.rs

@@ -50,7 +50,7 @@ pub(crate) fn test(mut args: Args) -> Result<(), ErrorString> {
             let mut child = command
                 .spawn()
                 .map_err(|e| format!("Failed to launch QEMU: {:?}\n{}", command, e))?;
-            let timeout = Duration::from_secs(60 * 5);
+            let timeout = Duration::from_secs(config.test_timeout);
             match child
                 .wait_timeout(timeout)
                 .map_err(|e| format!("Failed to wait with timeout: {}", e))?