Skip to content

rename ControlPlaneTestContextBuilder to ControlPlaneStarter #9444

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

rename ControlPlaneTestContextBuilder to ControlPlaneStarter #9444

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 29 additions & 22 deletions nexus/test-utils/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -456,7 +456,17 @@ impl RackInitRequestBuilder {
}
}

pub struct ControlPlaneTestContextBuilder<'a, N: NexusServer> {
/// Starts the control plane for tests and tools
///
/// This helper manges the configuration and startup of all the control plane
/// components in a way where:
///
/// - control planes started in this way are isolated from each other (in that
/// they don't know about each other, have separate data/databases, etc.)
/// - components are generally listening on localhost and pointed at each other
/// - most components are the real deal, though a few are simulated (notably
/// sled agent and SPs)
pub struct ControlPlaneStarter<'a, N: NexusServer> {
pub config: &'a mut NexusConfig,
test_name: &'a str,
rack_init_builder: RackInitRequestBuilder,
Expand Down Expand Up @@ -505,12 +515,10 @@ pub struct ControlPlaneTestContextBuilder<'a, N: NexusServer> {
}

type StepInitFn<'a, N> = Box<
dyn for<'b> FnOnce(
&'b mut ControlPlaneTestContextBuilder<'a, N>,
) -> BoxFuture<'b, ()>,
dyn for<'b> FnOnce(&'b mut ControlPlaneStarter<'a, N>) -> BoxFuture<'b, ()>,
>;

impl<'a, N: NexusServer> ControlPlaneTestContextBuilder<'a, N> {
impl<'a, N: NexusServer> ControlPlaneStarter<'a, N> {
pub fn new(test_name: &'a str, config: &'a mut NexusConfig) -> Self {
let start_time = chrono::Utc::now();
let logctx = LogContext::new(test_name, &config.pkg.log);
Expand Down Expand Up @@ -1773,10 +1781,9 @@ pub async fn omicron_dev_setup_with_config<N: NexusServer>(
extra_sled_agents: u16,
gateway_config_file: Utf8PathBuf,
) -> Result<ControlPlaneTestContext<N>> {
let builder =
ControlPlaneTestContextBuilder::<N>::new("omicron-dev", config);
let starter = ControlPlaneStarter::<N>::new("omicron-dev", config);

let log = &builder.logctx.log;
let log = &starter.logctx.log;
debug!(log, "Ensuring seed tarball exists");

// Start up a ControlPlaneTestContext, which tautologically sets up
Expand All @@ -1793,7 +1800,7 @@ pub async fn omicron_dev_setup_with_config<N: NexusServer>(
status.log(log, &seed_tar);

Ok(setup_with_config_impl(
builder,
starter,
PopulateCrdb::FromSeed { input_tar: seed_tar },
sim::SimMode::Auto,
None,
Expand All @@ -1813,9 +1820,9 @@ pub async fn test_setup_with_config<N: NexusServer>(
extra_sled_agents: u16,
gateway_config_file: Utf8PathBuf,
) -> ControlPlaneTestContext<N> {
let builder = ControlPlaneTestContextBuilder::<N>::new(test_name, config);
let starter = ControlPlaneStarter::<N>::new(test_name, config);
setup_with_config_impl(
builder,
starter,
PopulateCrdb::FromEnvironmentSeed,
sim_mode,
initial_cert,
Expand All @@ -1827,7 +1834,7 @@ pub async fn test_setup_with_config<N: NexusServer>(
}

async fn setup_with_config_impl<N: NexusServer>(
mut builder: ControlPlaneTestContextBuilder<'_, N>,
mut starter: ControlPlaneStarter<'_, N>,
populate: PopulateCrdb,
sim_mode: sim::SimMode,
initial_cert: Option<Certificate>,
Expand All @@ -1838,7 +1845,7 @@ async fn setup_with_config_impl<N: NexusServer>(
const STEP_TIMEOUT: Duration = Duration::from_secs(600);

// All setups will start with CRDB and clickhouse
builder
starter
.init_with_steps(
vec![
(
Expand All @@ -1860,7 +1867,7 @@ async fn setup_with_config_impl<N: NexusServer>(
// DNS and Nexus, but we currently don't use SMF to manage the services used in
// the test context so we need to make the Nexus / DNS information available
// to get the switch services working.
builder
starter
.init_with_steps(
vec![
(
Expand All @@ -1886,7 +1893,7 @@ async fn setup_with_config_impl<N: NexusServer>(
.await;

if second_nexus {
builder
starter
.init_with_steps(
vec![(
"configure_second_nexus",
Expand All @@ -1904,7 +1911,7 @@ async fn setup_with_config_impl<N: NexusServer>(
// agent will be for switch1.

let mgs_config = gateway_config_file.clone();
builder
starter
.init_with_steps(
vec![
(
Expand Down Expand Up @@ -1948,7 +1955,7 @@ async fn setup_with_config_impl<N: NexusServer>(
.await;

if extra_sled_agents > 0 {
builder
starter
.init_with_steps(
vec![
(
Expand Down Expand Up @@ -1997,7 +2004,7 @@ async fn setup_with_config_impl<N: NexusServer>(
// The first and second sled agents have special UUIDs, and any extra ones
// after that are random.

builder
starter
.init_with_steps(
vec![(
"start_sled1",
Expand All @@ -2016,7 +2023,7 @@ async fn setup_with_config_impl<N: NexusServer>(
.await;

if extra_sled_agents > 0 {
builder
starter
.init_with_steps(
vec![(
"start_sled2",
Expand All @@ -2036,7 +2043,7 @@ async fn setup_with_config_impl<N: NexusServer>(
}

for index in 1..extra_sled_agents {
builder
starter
.init_with_steps(
vec![(
"add_extra_sled_agent",
Expand All @@ -2059,7 +2066,7 @@ async fn setup_with_config_impl<N: NexusServer>(
// agent. Afterwards, configure the sled agents and start the rest of the
// the required services.

builder
starter
.init_with_steps(
vec![
(
Expand Down Expand Up @@ -2103,7 +2110,7 @@ async fn setup_with_config_impl<N: NexusServer>(
)
.await;

builder.build()
starter.build()
}

/// Starts a simulated sled agent
Expand Down
Loading
Loading