sk-ctrl 2.5.0

Kubernetes controller for replaying traces in a simulated cluster
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
use std::env;

use clockabilly::prelude::*;
use httpmock::prelude::*;
use k8s_openapi::ByteString;
use kube::runtime::controller::Action;
use serde_json::json;
use sk_api::prometheus::*;
use sk_api::v1::SimulationState;
use sk_core::k8s::build_lease;
use tracing_test::traced_test;

use super::*;
use crate::controller::*;
use crate::errors::SkControllerError;
use crate::objects::*;

#[fixture]
fn opts() -> Options {
    Options {
        use_cert_manager: false,
        cert_manager_issuer: "".into(),
        verbosity: "info".into(),
    }
}

enum WebhookState {
    NotCreated,
    CaBundleNone,
    CaBundleEmpty,
    ReadyWithCaBundle,
}

#[rstest(tokio::test)]
async fn test_fetch_driver_state_no_driver(test_sim: Simulation, test_sim_root: SimulationRoot, opts: Options) {
    let (mut fake_apiserver, client) = make_fake_apiserver();
    let ctx = Arc::new(SimulationContext::new(client, opts)).with_sim(&test_sim);
    let lease_obj = build_lease(&test_sim, &test_sim_root, TEST_CTRL_NAMESPACE, UtcClock.now());

    let driver_name = ctx.driver_name.clone();
    fake_apiserver.handle_not_found(format!("/apis/batch/v1/namespaces/{TEST_NAMESPACE}/jobs/{driver_name}"));
    fake_apiserver.handle(move |when, then| {
        when.method(GET)
            .path(format!("/apis/coordination.k8s.io/v1/namespaces/{TEST_CTRL_NAMESPACE}/leases/{SK_LEASE_NAME}"));
        then.json_body_obj(&lease_obj);
    });
    let sim_state = fetch_driver_state(&ctx, &test_sim, &test_sim_root, TEST_CTRL_NAMESPACE)
        .await
        .unwrap()
        .0;
    assert_eq!(SimulationState::Initializing, sim_state);
    fake_apiserver.assert();
}

#[rstest(tokio::test)]
async fn test_fetch_driver_state_driver_no_status(test_sim: Simulation, test_sim_root: SimulationRoot, opts: Options) {
    let (mut fake_apiserver, client) = make_fake_apiserver();
    let ctx = Arc::new(SimulationContext::new(client, opts)).with_sim(&test_sim);
    let lease_obj = build_lease(&test_sim, &test_sim_root, TEST_CTRL_NAMESPACE, UtcClock.now());

    let driver_name = ctx.driver_name.clone();
    fake_apiserver.handle(move |when, then| {
        when.path(format!("/apis/batch/v1/namespaces/{TEST_NAMESPACE}/jobs/{driver_name}"));
        then.json_body(json!({}));
    });
    fake_apiserver.handle(move |when, then| {
        when.method(GET)
            .path(format!("/apis/coordination.k8s.io/v1/namespaces/{TEST_CTRL_NAMESPACE}/leases/{SK_LEASE_NAME}"));
        then.json_body_obj(&lease_obj);
    });
    let sim_state = fetch_driver_state(&ctx, &test_sim, &test_sim_root, TEST_CTRL_NAMESPACE)
        .await
        .unwrap()
        .0;
    assert_eq!(SimulationState::Running, sim_state);
    fake_apiserver.assert();
}

#[rstest(tokio::test)]
async fn test_fetch_driver_state_driver_running(test_sim: Simulation, test_sim_root: SimulationRoot, opts: Options) {
    let (mut fake_apiserver, client) = make_fake_apiserver();
    let ctx = Arc::new(SimulationContext::new(client, opts)).with_sim(&test_sim);
    let lease_obj = build_lease(&test_sim, &test_sim_root, TEST_CTRL_NAMESPACE, UtcClock.now());

    let driver_name = ctx.driver_name.clone();
    fake_apiserver.handle(move |when, then| {
        when.path(format!("/apis/batch/v1/namespaces/{TEST_NAMESPACE}/jobs/{driver_name}"));
        then.json_body(json!({
            "status": {
                "conditions": [{ "type": "Running" }],
            },
        }));
    });
    fake_apiserver.handle(move |when, then| {
        when.method(GET)
            .path(format!("/apis/coordination.k8s.io/v1/namespaces/{TEST_CTRL_NAMESPACE}/leases/{SK_LEASE_NAME}"));
        then.json_body_obj(&lease_obj);
    });
    let sim_state = fetch_driver_state(&ctx, &test_sim, &test_sim_root, TEST_CTRL_NAMESPACE)
        .await
        .unwrap()
        .0;
    assert_eq!(SimulationState::Running, sim_state);
    fake_apiserver.assert();
}

#[rstest(tokio::test)]
#[case::complete(JOB_STATUS_CONDITION_COMPLETE)]
#[case::failed(JOB_STATUS_CONDITION_FAILED)]
async fn test_fetch_driver_state_driver_finished(
    test_sim: Simulation,
    test_sim_root: SimulationRoot,
    opts: Options,
    #[case] status: &'static str,
) {
    let expected_state = if status == JOB_STATUS_CONDITION_COMPLETE {
        SimulationState::Finished
    } else {
        SimulationState::Failed
    };

    let (mut fake_apiserver, client) = make_fake_apiserver();
    let ctx = Arc::new(SimulationContext::new(client, opts)).with_sim(&test_sim);

    let driver_name = ctx.driver_name.clone();
    // No lease handler because we don't claim the lease if we're done
    fake_apiserver.handle(move |when, then| {
        when.path(format!("/apis/batch/v1/namespaces/{TEST_NAMESPACE}/jobs/{driver_name}"));
        then.json_body(json!({
            "status": {
                "conditions": [{"type": "Running"}, { "type": status }],
            },
        }));
    });
    let sim_state = fetch_driver_state(&ctx, &test_sim, &test_sim_root, TEST_CTRL_NAMESPACE)
        .await
        .unwrap()
        .0;
    assert_eq!(expected_state, sim_state);
    fake_apiserver.assert();
}

#[rstest(tokio::test)]
async fn test_fetch_driver_state_lease_waiting(test_sim: Simulation, test_sim_root: SimulationRoot, opts: Options) {
    let (mut fake_apiserver, client) = make_fake_apiserver();
    let ctx = Arc::new(SimulationContext::new(client, opts)).with_sim(&test_sim);
    let mut other_sim = test_sim.clone();
    other_sim.metadata.name = Some("blocking-sim".into());
    let other_lease_obj = build_lease(&other_sim, &test_sim_root, TEST_CTRL_NAMESPACE, UtcClock.now());

    let driver_name = ctx.driver_name.clone();
    fake_apiserver.handle_not_found(format!("/apis/batch/v1/namespaces/{TEST_NAMESPACE}/jobs/{driver_name}"));
    fake_apiserver.handle(move |when, then| {
        when.method(GET)
            .path(format!("/apis/coordination.k8s.io/v1/namespaces/{TEST_CTRL_NAMESPACE}/leases/{SK_LEASE_NAME}"));
        then.json_body_obj(&other_lease_obj);
    });

    let sim_state = fetch_driver_state(&ctx, &test_sim, &test_sim_root, TEST_CTRL_NAMESPACE)
        .await
        .unwrap()
        .0;
    assert_eq!(SimulationState::Blocked, sim_state);
    fake_apiserver.assert();
}

#[rstest(tokio::test)]
async fn test_fetch_driver_state_lease_claim_fails(test_sim: Simulation, test_sim_root: SimulationRoot, opts: Options) {
    let (mut fake_apiserver, client) = make_fake_apiserver();
    let ctx = Arc::new(SimulationContext::new(client, opts)).with_sim(&test_sim);

    let driver_name = ctx.driver_name.clone();
    fake_apiserver.handle_not_found(format!("/apis/batch/v1/namespaces/{TEST_NAMESPACE}/jobs/{driver_name}"));
    fake_apiserver.handle_not_found(format!(
        "/apis/coordination.k8s.io/v1/namespaces/{TEST_CTRL_NAMESPACE}/leases/{SK_LEASE_NAME}"
    ));
    fake_apiserver.handle(move |when, then| {
        when.method(POST)
            .path(format!("/apis/coordination.k8s.io/v1/namespaces/{TEST_CTRL_NAMESPACE}/leases"));
        then.status(409).json_body(json!({
          "kind": "Status",
          "apiVersion": "v1",
          "metadata": {},
          "message": "the object has been modified; please apply your changes to the latest version and try again",
          "status": "Failure",
          "reason": "Conflict",
          "code": 409
        }));
    });

    let err = fetch_driver_state(&ctx, &test_sim, &test_sim_root, TEST_CTRL_NAMESPACE)
        .await
        .unwrap_err()
        .downcast::<kube::api::entry::CommitError>()
        .unwrap();
    assert!(matches!(err, kube::api::entry::CommitError::Save(..)));
    fake_apiserver.assert();
}

#[rstest(tokio::test)]
async fn test_setup_simulation_no_ns(test_sim: Simulation, test_sim_root: SimulationRoot, opts: Options) {
    let (mut fake_apiserver, client) = make_fake_apiserver();
    let ctx = Arc::new(SimulationContext::new(client, opts)).with_sim(&test_sim);
    fake_apiserver.handle_not_found(format!("/api/v1/namespaces/{DEFAULT_METRICS_NS}"));

    assert!(matches!(
        setup_simulation(&ctx, &test_sim, &test_sim_root, TEST_CTRL_NAMESPACE)
            .await
            .unwrap_err()
            .downcast::<SkControllerError>()
            .unwrap(),
        SkControllerError::NamespaceNotFound(_)
    ));
    fake_apiserver.assert();
}

#[rstest(tokio::test)]
async fn test_setup_simulation_create_prom(test_sim: Simulation, test_sim_root: SimulationRoot, opts: Options) {
    let (mut fake_apiserver, client) = make_fake_apiserver();
    let ctx = Arc::new(SimulationContext::new(client, opts)).with_sim(&test_sim);

    let prom_name = ctx.prometheus_name.clone();
    let driver_ns_obj = build_driver_namespace(&ctx, &test_sim);
    let prom_obj =
        build_prometheus(&ctx.prometheus_name, &test_sim, &test_sim_root, &test_sim.spec.metrics.clone().unwrap());

    fake_apiserver.handle(|when, then| {
        when.method(GET).path(format!("/api/v1/namespaces/{DEFAULT_METRICS_NS}"));
        then.json_body(json!({
            "kind": "Namespace",
        }));
    });
    fake_apiserver.handle_not_found(format!("/api/v1/namespaces/{TEST_NAMESPACE}"));
    fake_apiserver.handle(move |when, then| {
        when.method(POST).path("/api/v1/namespaces");
        then.json_body_obj(&driver_ns_obj);
    });
    fake_apiserver
        .handle_not_found(format!("/apis/monitoring.coreos.com/v1/namespaces/monitoring/prometheuses/{prom_name}"));
    fake_apiserver.handle(move |when, then| {
        when.method(POST)
            .path("/apis/monitoring.coreos.com/v1/namespaces/monitoring/prometheuses");
        then.json_body_obj(&prom_obj);
    });
    assert_eq!(
        setup_simulation(&ctx, &test_sim, &test_sim_root, TEST_CTRL_NAMESPACE)
            .await
            .unwrap(),
        Action::requeue(REQUEUE_DURATION)
    );
    fake_apiserver.assert();
}

#[rstest(tokio::test)]
#[case::ready(true, false, WebhookState::ReadyWithCaBundle)]
#[case::not_ready(false, false, WebhookState::ReadyWithCaBundle)]
#[case::disabled(true, true, WebhookState::ReadyWithCaBundle)]
#[case::webhook_not_created(true, false, WebhookState::NotCreated)]
#[case::webhook_ca_bundle_none(true, false, WebhookState::CaBundleNone)]
#[case::webhook_ca_bundle_empty(true, false, WebhookState::CaBundleEmpty)]
async fn test_setup_simulation_wait_prom(
    mut test_sim: Simulation,
    test_sim_root: SimulationRoot,
    opts: Options,
    #[case] ready_to_create_webhook: bool,
    #[case] disabled: bool,
    #[case] initial_webhook_state: WebhookState,
) {
    // SAFETY: it's fine it's a test
    unsafe { env::set_var("POD_SVC_ACCOUNT", "asdf") };
    let (mut fake_apiserver, client) = make_fake_apiserver();
    let ctx = Arc::new(SimulationContext::new(client, opts)).with_sim(&test_sim);

    let prom_name = ctx.prometheus_name.clone();
    let driver_svc_name = ctx.driver_svc.clone();
    let webhook_name = ctx.webhook_name.clone();
    let driver_name = ctx.driver_name.clone();

    let driver_ns_obj = build_driver_namespace(&ctx, &test_sim);
    let driver_svc_obj = build_driver_service(&ctx, &test_sim, &test_sim_root);
    let webhook_obj = build_mutating_webhook(&ctx, &test_sim, &test_sim_root);
    let driver_obj = build_driver_job(&ctx, &test_sim, "".into(), TEST_CTRL_NAMESPACE).unwrap();

    fake_apiserver.handle(|when, then| {
        when.method(GET).path(format!("/api/v1/namespaces/{DEFAULT_METRICS_NS}"));
        then.json_body(json!({
            "kind": "Namespace",
        }));
    });
    fake_apiserver.handle(move |when, then| {
        when.method(GET).path(format!("/api/v1/namespaces/{TEST_NAMESPACE}"));
        then.json_body_obj(&driver_ns_obj);
    });

    if disabled {
        test_sim.spec.metrics = None;
    } else {
        let prom_obj =
            build_prometheus(&ctx.prometheus_name, &test_sim, &test_sim_root, &test_sim.spec.metrics.clone().unwrap());
        fake_apiserver.handle(move |when, then| {
            when.method(GET)
                .path(format!("/apis/monitoring.coreos.com/v1/namespaces/monitoring/prometheuses/{prom_name}"));
            let mut prom_obj = prom_obj.clone();
            if ready_to_create_webhook {
                prom_obj.status = Some(PrometheusStatus { available_replicas: 1, ..Default::default() });
            }
            then.json_body_obj(&prom_obj);
        });
    }

    if ready_to_create_webhook {
        fake_apiserver.handle_not_found(format!("/api/v1/namespaces/{TEST_NAMESPACE}/services/{driver_svc_name}"));
        fake_apiserver.handle(move |when, then| {
            when.method(POST).path(format!("/api/v1/namespaces/{TEST_NAMESPACE}/services"));
            then.json_body_obj(&driver_svc_obj);
        });
        fake_apiserver.handle(move |when, then| {
            when.method(GET).path(format!("/api/v1/namespaces/{TEST_NAMESPACE}/secrets"));
            then.json_body(json!({
                "kind": "SecretList",
                "metadata": {},
                "items": [{
                    "kind": "Secret"
                }],
            }));
        });

        match initial_webhook_state {
            WebhookState::NotCreated => {
                fake_apiserver.handle_not_found(format!(
                    "/apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{webhook_name}"
                ));
                fake_apiserver.handle(move |when, then| {
                    when.method(POST)
                        .path("/apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations");
                    then.json_body_obj(&webhook_obj);
                });
            },
            WebhookState::CaBundleNone => {
                let mut webhook_obj_no_ca = webhook_obj.clone();
                webhook_obj_no_ca.webhooks.as_mut().unwrap()[0].client_config.ca_bundle = None;
                fake_apiserver.handle(move |when, then| {
                    when.method(GET).path(format!(
                        "/apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{webhook_name}"
                    ));
                    then.json_body_obj(&webhook_obj_no_ca);
                });
            },
            WebhookState::CaBundleEmpty => {
                let mut webhook_obj_empty_ca = webhook_obj.clone();
                webhook_obj_empty_ca.webhooks.as_mut().unwrap()[0].client_config.ca_bundle = Some(ByteString(vec![]));
                fake_apiserver.handle(move |when, then| {
                    when.method(GET).path(format!(
                        "/apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{webhook_name}"
                    ));
                    then.json_body_obj(&webhook_obj_empty_ca);
                });
            },
            WebhookState::ReadyWithCaBundle => {
                let mut webhook_obj_with_ca = webhook_obj.clone();
                webhook_obj_with_ca.webhooks.as_mut().unwrap()[0].client_config.ca_bundle =
                    Some(ByteString(b"test-ca-bundle".to_vec()));
                fake_apiserver.handle(move |when, then| {
                    when.method(GET).path(format!(
                        "/apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{webhook_name}"
                    ));
                    then.json_body_obj(&webhook_obj_with_ca);
                });
            },
        }

        if matches!(initial_webhook_state, WebhookState::ReadyWithCaBundle) {
            fake_apiserver.handle_not_found(format!("/apis/batch/v1/namespaces/{TEST_NAMESPACE}/jobs/{driver_name}"));
            fake_apiserver.handle(move |when, then| {
                when.method(POST)
                    .path(format!("/apis/batch/v1/namespaces/{TEST_NAMESPACE}/jobs"));
                then.json_body_obj(&driver_obj);
            });
        }
    }
    let res = setup_simulation(&ctx, &test_sim, &test_sim_root, TEST_CTRL_NAMESPACE)
        .await
        .unwrap();
    if !ready_to_create_webhook || !matches!(initial_webhook_state, WebhookState::ReadyWithCaBundle) {
        assert_eq!(res, Action::requeue(REQUEUE_DURATION));
    } else {
        assert_eq!(res, Action::await_change());
    };

    fake_apiserver.assert();
}


#[rstest(tokio::test)]
#[traced_test]
async fn test_cleanup_simulation(test_sim: Simulation, opts: Options) {
    let (mut fake_apiserver, client) = make_fake_apiserver();
    let ctx = Arc::new(SimulationContext::new(client, opts)).with_sim(&test_sim);

    let root = ctx.metaroot_name.clone();

    fake_apiserver.handle(move |when, then| {
        when.path(format!("/apis/simkube.io/v1/simulationroots/{root}"));
        then.json_body(status_ok());
    });
    cleanup_simulation(&ctx, &test_sim).await;

    assert!(!logs_contain("ERROR"));
    fake_apiserver.assert();
}