Create separate crate for testutil code

Erika Hunhoff · Erika Hunhoff · commit 980021b96bdf · 2022-11-08T06:48:06.000-08:00
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/kernel/Cargo.toml b/kernel/Cargo.toml
@@ -80,6 +80,7 @@ proptest = "1.0.0"
 hwloc2 = "2.2"
 env_logger = "0.9"
 which = "4"
+testutils = { path = "testutils" }
 
 [build-dependencies]
 cc = "1.0"
diff --git a/kernel/tests/integration-test.rs b/kernel/tests/integration-test.rs
@@ -17,7 +17,8 @@
 //! * `s10_*`: User-space applications benchmarks
 //! * `s11_*`: Rackscale (distributed) benchmarks
 
-pub(crate) mod common;
+extern crate testutils;
+
 pub(crate) mod s00_core_tests;
 pub(crate) mod s01_kernel_low_tests;
 pub(crate) mod s02_kernel_high_tests;
diff --git a/kernel/tests/s00_core_tests.rs b/kernel/tests/s00_core_tests.rs
@@ -12,10 +12,10 @@
 use rexpect::errors::*;
 use rexpect::process::wait::WaitStatus;
 
-use crate::common::builder::BuildArgs;
-use crate::common::helpers::spawn_nrk;
-use crate::common::runner_args::{check_for_exit, check_for_successful_exit, RunnerArgs};
-use crate::common::ExitStatus;
+use testutils::builder::BuildArgs;
+use testutils::helpers::spawn_nrk;
+use testutils::runner_args::{check_for_exit, check_for_successful_exit, RunnerArgs};
+use testutils::ExitStatus;
 
 /// Make sure exiting the kernel works.
 ///
diff --git a/kernel/tests/s01_kernel_low_tests.rs b/kernel/tests/s01_kernel_low_tests.rs
@@ -12,10 +12,10 @@
 use rexpect::errors::*;
 use rexpect::process::wait::WaitStatus;
 
-use crate::common::builder::BuildArgs;
-use crate::common::helpers::spawn_nrk;
-use crate::common::runner_args::{check_for_exit, check_for_successful_exit, RunnerArgs};
-use crate::common::ExitStatus;
+use testutils::builder::BuildArgs;
+use testutils::helpers::spawn_nrk;
+use testutils::runner_args::{check_for_exit, check_for_successful_exit, RunnerArgs};
+use testutils::ExitStatus;
 
 /// Make sure the page-fault handler functions as expected.
 /// In essence a trap should be raised and we should get a backtrace.
diff --git a/kernel/tests/s02_kernel_high_tests.rs b/kernel/tests/s02_kernel_high_tests.rs
@@ -18,9 +18,9 @@ use rexpect::process::wait::WaitStatus;
 use rexpect::session::PtyReplSession;
 use rexpect::spawn;
 
-use crate::common::builder::BuildArgs;
-use crate::common::helpers::spawn_nrk;
-use crate::common::runner_args::{check_for_successful_exit, RunnerArgs};
+use testutils::builder::BuildArgs;
+use testutils::helpers::spawn_nrk;
+use testutils::runner_args::{check_for_successful_exit, RunnerArgs};
 
 /// Test that we can initialize the ACPI subsystem and figure out the machine topology.
 #[cfg(not(feature = "baremetal"))]
diff --git a/kernel/tests/s03_kernel_high_tests.rs b/kernel/tests/s03_kernel_high_tests.rs
@@ -13,9 +13,9 @@ use rexpect::errors::*;
 use rexpect::process::wait::WaitStatus;
 use rexpect::spawn;
 
-use crate::common::builder::BuildArgs;
-use crate::common::helpers::{setup_shmem, spawn_nrk, SHMEM_PATH, SHMEM_SIZE};
-use crate::common::runner_args::{check_for_successful_exit, RunnerArgs};
+use testutils::builder::BuildArgs;
+use testutils::helpers::{setup_shmem, spawn_nrk, SHMEM_PATH, SHMEM_SIZE};
+use testutils::runner_args::{check_for_successful_exit, RunnerArgs};
 
 /// Test that we boot up all cores in the system.
 #[cfg(not(feature = "baremetal"))] // TODO: can be ported to baremetal
diff --git a/kernel/tests/s04_user_runtime_tests.rs b/kernel/tests/s04_user_runtime_tests.rs
@@ -13,11 +13,11 @@ use rexpect::errors::*;
 use rexpect::process::signal::SIGTERM;
 use rexpect::process::wait::WaitStatus;
 
-use crate::common::builder::{BuildArgs, Machine};
-use crate::common::helpers::{
+use testutils::builder::{BuildArgs, Machine};
+use testutils::helpers::{
     setup_network, spawn_dhcpd, spawn_nrk, spawn_ping, spawn_receiver, DHCP_ACK_MATCH,
 };
-use crate::common::runner_args::{check_for_successful_exit, wait_for_sigterm, RunnerArgs};
+use testutils::runner_args::{check_for_successful_exit, wait_for_sigterm, RunnerArgs};
 
 /// Tests the lineup scheduler multi-core ability.
 ///
diff --git a/kernel/tests/s05_user_app_tests.rs b/kernel/tests/s05_user_app_tests.rs
@@ -13,10 +13,10 @@ use rexpect::errors::*;
 use rexpect::process::signal::SIGTERM;
 use rexpect::process::wait::WaitStatus;
 
-use crate::common::builder::BuildArgs;
-use crate::common::helpers::{setup_network, spawn_dhcpd, spawn_nc, spawn_nrk, DHCP_ACK_MATCH};
-use crate::common::redis::{REDIS_BENCHMARK, REDIS_PORT, REDIS_START_MATCH};
-use crate::common::runner_args::{wait_for_sigterm, RunnerArgs};
+use testutils::builder::BuildArgs;
+use testutils::helpers::{setup_network, spawn_dhcpd, spawn_nc, spawn_nrk, DHCP_ACK_MATCH};
+use testutils::redis::{REDIS_BENCHMARK, REDIS_PORT, REDIS_START_MATCH};
+use testutils::runner_args::{wait_for_sigterm, RunnerArgs};
 
 /// Tests that user-space application redis is functional
 /// by spawing it and connecting to it from the network.
diff --git a/kernel/tests/s06_rackscale_tests.rs b/kernel/tests/s06_rackscale_tests.rs
@@ -12,11 +12,11 @@
 use rexpect::errors::*;
 use rexpect::process::wait::WaitStatus;
 
-use crate::common::builder::BuildArgs;
-use crate::common::helpers::{
+use testutils::builder::BuildArgs;
+use testutils::helpers::{
     setup_network, setup_shmem, spawn_dcm, spawn_nrk, SHMEM_PATH, SHMEM_SIZE,
 };
-use crate::common::runner_args::{check_for_successful_exit, RunnerArgs};
+use testutils::runner_args::{check_for_successful_exit, RunnerArgs};
 
 #[cfg(not(feature = "baremetal"))]
 #[test]
diff --git a/kernel/tests/s10_benchmarks.rs b/kernel/tests/s10_benchmarks.rs
@@ -20,10 +20,10 @@ use rexpect::process::wait::WaitStatus;
 use rexpect::spawn;
 use serde::Serialize;
 
-use crate::common::builder::{BuildArgs, Machine};
-use crate::common::helpers::{setup_network, spawn_dhcpd, spawn_nrk, DHCP_ACK_MATCH};
-use crate::common::redis::{redis_benchmark, REDIS_BENCHMARK, REDIS_START_MATCH};
-use crate::common::runner_args::{check_for_successful_exit, wait_for_sigterm, RunnerArgs};
+use testutils::builder::{BuildArgs, Machine};
+use testutils::helpers::{setup_network, spawn_dhcpd, spawn_nrk, DHCP_ACK_MATCH};
+use testutils::redis::{redis_benchmark, REDIS_BENCHMARK, REDIS_START_MATCH};
+use testutils::runner_args::{check_for_successful_exit, wait_for_sigterm, RunnerArgs};
 
 /// Binary of the memcached benchmark program
 const MEMASLAP_BINARY: &str = "memaslap";
diff --git a/kernel/tests/s11_rackscale_benchmarks.rs b/kernel/tests/s11_rackscale_benchmarks.rs
@@ -16,11 +16,11 @@ use std::path::Path;
 use rexpect::errors::*;
 use rexpect::process::wait::WaitStatus;
 
-use crate::common::builder::BuildArgs;
-use crate::common::helpers::{
+use testutils::builder::BuildArgs;
+use testutils::helpers::{
     setup_network, setup_shmem, spawn_dcm, spawn_nrk, SHMEM_PATH, SHMEM_SIZE,
 };
-use crate::common::runner_args::{check_for_successful_exit, RunnerArgs};
+use testutils::runner_args::{check_for_successful_exit, RunnerArgs};
 
 #[test]
 #[cfg(not(feature = "baremetal"))]
diff --git a/kernel/testutils/Cargo.toml b/kernel/testutils/Cargo.toml
@@ -0,0 +1,23 @@
+[package]
+name = "testutils"
+version = "0.0.1"
+authors = [
+  "Gerd Zellweger <mail@gerdzellweger.com>",
+]
+description = "Experimental OS kernel test utility code"
+license = "MIT OR Apache-2.0"
+build = "build.rs"
+edition = "2021"
+resolver = "2"
+
+[build-dependencies]
+cc = "1.0"
+
+[dependencies]
+csv = "1.1"
+env_logger = "0.9"
+hwloc2 = "2.2"
+lazy_static = { version = "1.4", features = ["spin_no_std"] }
+serde = { version = "1" }
+memfile = "0.2.1"
+rexpect = { git = "https://github.com/gz/rexpect.git", branch = "eof-nix" }
diff --git a/kernel/testutils/build.rs b/kernel/testutils/build.rs
@@ -0,0 +1,14 @@
+// Copyright © 2021 VMware, Inc. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0 OR MIT
+extern crate cc;
+
+use std::process::Command;
+
+fn main() {
+    let output = Command::new("git")
+        .args(&["rev-parse", "HEAD"])
+        .output()
+        .expect("Could not determine git hash");
+    let git_hash = String::from_utf8(output.stdout).expect("Could not parse the git hash");
+    println!("cargo:rustc-env=GIT_HASH={}", git_hash);
+}
diff --git a/kernel/testutils/src/builder.rs b/kernel/testutils/src/builder.rs
@@ -14,7 +14,7 @@ const BAREMETAL_MACHINE: &'static str = "BAREMETAL_MACHINE";
 
 /// Different machine types we can run on.
 #[derive(Eq, PartialEq, Debug, Clone)]
-pub(crate) enum Machine {
+pub enum Machine {
     /// A bare-metal machine identified by a string.
     /// The name is described in the corresponding TOML file.
     ///
@@ -25,7 +25,7 @@ pub(crate) enum Machine {
 }
 
 impl Machine {
-    pub(crate) fn determine() -> Self {
+    pub fn determine() -> Self {
         match std::env::var(BAREMETAL_MACHINE) {
             Ok(name) => {
                 if name.is_empty() {
@@ -43,7 +43,7 @@ impl Machine {
         }
     }
 
-    pub(crate) fn name(&self) -> &str {
+    pub fn name(&self) -> &str {
         match self {
             Machine::Qemu => "qemu",
             Machine::Baremetal(s) => s.as_str(),
@@ -52,7 +52,7 @@ impl Machine {
 
     /// Return a set of cores to run benchmark, run fewer total iterations
     /// and instead more with high core counts.
-    pub(crate) fn thread_defaults_low_mid_high(&self) -> Vec<usize> {
+    pub fn thread_defaults_low_mid_high(&self) -> Vec<usize> {
         if cfg!(feature = "smoke") {
             return vec![1, 4];
         }
@@ -81,7 +81,7 @@ impl Machine {
 
     /// Return a set of cores to run benchmark on sampled uniform between
     /// 1..self.max_cores().
-    pub(crate) fn thread_defaults_uniform(&self) -> Vec<usize> {
+    pub fn thread_defaults_uniform(&self) -> Vec<usize> {
         if cfg!(feature = "smoke") {
             return vec![1, 4];
         }
@@ -120,7 +120,7 @@ impl Machine {
         threads
     }
 
-    pub(crate) fn max_cores(&self) -> usize {
+    pub fn max_cores(&self) -> usize {
         if let Machine::Qemu = self {
             let topo = Topology::new().expect("Can't retrieve System topology?");
             topo.objects_with_type(&ObjectType::Core)
@@ -134,7 +134,7 @@ impl Machine {
         }
     }
 
-    pub(crate) fn max_numa_nodes(&self) -> usize {
+    pub fn max_numa_nodes(&self) -> usize {
         if let Machine::Qemu = self {
             let topo = Topology::new().expect("Can't retrieve System topology?");
             // TODO: Should be ObjectType::NUMANode but this fails in the C library?
@@ -159,7 +159,7 @@ impl Machine {
 /// # Note
 /// For the tests, all BuildEnvironment's (with different dir) need to be
 /// singleton instances, protected for example by a Mutex.
-pub(crate) struct BuildEnvironment {
+pub struct BuildEnvironment {
     _dir: &'static str,
 }
 
@@ -172,21 +172,21 @@ lazy_static! {
 /// built with the given BuildArgs.
 ///
 /// Use `BuildArgs::build` to construct (by providing a BuildEnvironment).
-pub(crate) struct Built<'a> {
-    pub(crate) with_args: BuildArgs<'a>,
+pub struct Built<'a> {
+    pub with_args: BuildArgs<'a>,
 }
 
 /// Arguments passed to the run.py script to build a test.
 #[derive(Clone)]
-pub(crate) struct BuildArgs<'a> {
+pub struct BuildArgs<'a> {
     /// Test name of kernel integration test.
     kernel_features: Vec<&'a str>,
     /// Features passed to compiled user-space modules.
     user_features: Vec<&'a str>,
     /// Which user-space modules to include.
     mods: Vec<&'a str>,
     /// Should we compile in release mode?
-    pub(crate) release: bool,
+    pub release: bool,
 }
 
 impl<'a> Default for BuildArgs<'a> {
@@ -201,7 +201,7 @@ impl<'a> Default for BuildArgs<'a> {
 }
 
 impl<'a> BuildArgs<'a> {
-    pub(crate) fn build(self) -> Built<'a> {
+    pub fn build(self) -> Built<'a> {
         let env = match TARGET_DIR.lock() {
             Ok(env) => env,
             // It's fine to get the environment again if another test failed,
@@ -215,7 +215,7 @@ impl<'a> BuildArgs<'a> {
     }
 
     /// Build the kernel/user-space.
-    pub(crate) fn compile(self, _env: MutexGuard<'static, BuildEnvironment>) -> Built<'a> {
+    pub fn compile(self, _env: MutexGuard<'static, BuildEnvironment>) -> Built<'a> {
         let mut compile_args = self.as_cmd();
         compile_args.push("--norun".to_string());
         compile_args.push("net".to_string());
@@ -244,7 +244,7 @@ impl<'a> BuildArgs<'a> {
     }
 
     /// Converts the RunnerArgs to a run.py command line invocation.
-    pub(crate) fn as_cmd(&'a self) -> Vec<String> {
+    pub fn as_cmd(&'a self) -> Vec<String> {
         // Add features for build
         let kernel_features = String::from(self.kernel_features.join(","));
         let user_features = String::from(self.user_features.join(","));
@@ -277,31 +277,31 @@ impl<'a> BuildArgs<'a> {
     }
 
     /// Add a cargo feature to the kernel build.
-    pub(crate) fn kernel_feature(mut self, kernel_feature: &'a str) -> BuildArgs<'a> {
+    pub fn kernel_feature(mut self, kernel_feature: &'a str) -> BuildArgs<'a> {
         self.kernel_features.push(kernel_feature);
         self
     }
 
     /// What cargo features should be passed to the user-space modules build.
-    pub(crate) fn user_features(mut self, user_features: &[&'a str]) -> BuildArgs<'a> {
+    pub fn user_features(mut self, user_features: &[&'a str]) -> BuildArgs<'a> {
         self.user_features.extend_from_slice(user_features);
         self
     }
 
     /// Add a cargo feature to the user-space modules build.
-    pub(crate) fn user_feature(mut self, user_feature: &'a str) -> BuildArgs<'a> {
+    pub fn user_feature(mut self, user_feature: &'a str) -> BuildArgs<'a> {
         self.user_features.push(user_feature);
         self
     }
 
     /// Adds a user-space module to the build and deployment.
-    pub(crate) fn module(mut self, module: &'a str) -> BuildArgs<'a> {
+    pub fn module(mut self, module: &'a str) -> BuildArgs<'a> {
         self.mods.push(module);
         self
     }
 
     /// Do a release build.
-    pub(crate) fn release(mut self) -> BuildArgs<'a> {
+    pub fn release(mut self) -> BuildArgs<'a> {
         self.release = true;
         self
     }
diff --git a/kernel/testutils/src/helpers.rs b/kernel/testutils/src/helpers.rs
diff --git a/kernel/testutils/src/lib.rs b/kernel/testutils/src/lib.rs
diff --git a/kernel/testutils/src/redis.rs b/kernel/testutils/src/redis.rs
diff --git a/kernel/testutils/src/runner_args.rs b/kernel/testutils/src/runner_args.rs
