stormchaser-runner-k8s 1.3.2

A robust, distributed workflow engine for event-driven and human-triggered workflows.
Documentation
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
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
use super::{k8s_utils, state, JobMetrics, JobState, K8sJobMachine, StartResult};
use anyhow::{Context, Result};
use chrono::Utc;
use futures::StreamExt;
use k8s_openapi::api::batch::v1::Job;
use k8s_openapi::api::core::v1::Pod;
use kube::api::{
    Api, DeleteParams, ListParams, PostParams, PropagationPolicy, WatchEvent, WatchParams,
};
use serde_json::Value;
use std::collections::HashMap;
use std::time::Duration;
use tokio::time::sleep;
use tracing::{error, info, warn};

impl K8sJobMachine<state::Initialized> {
    /// Adopt.
    pub fn adopt(self, job_name: String) -> K8sJobMachine<state::Running> {
        info!(
            "Adopting orphaned K8s job {} in namespace {}",
            job_name, self.metadata.namespace
        );
        K8sJobMachine {
            client: self.client,
            metadata: self.metadata.clone(),
            state: state::Running {
                job_name,
                dispatched_at: self.metadata.received_at,
            },
        }
    }

    #[allow(dead_code)]
    /// Clean up.
    pub async fn clean_up(self, job_name: &str) -> Result<()> {
        info!(
            "Cleaning up K8s job {} in namespace {}",
            job_name, self.metadata.namespace
        );
        let jobs: Api<Job> = Api::namespaced(self.client.clone(), &self.metadata.namespace);
        let dp = DeleteParams {
            propagation_policy: Some(PropagationPolicy::Background),
            ..Default::default()
        };
        jobs.delete(job_name, &dp).await?;
        Ok(())
    }

    /// Starts the Kubernetes job, transitioning to either Running or Failed state.
    pub async fn start(self) -> Result<StartResult> {
        let job_name = format!(
            "storm-{}-{}",
            self.metadata.step_dsl.name.to_lowercase().replace('_', "-"),
            &self.metadata.step_id.to_string()[..8]
        );

        info!(
            "Starting K8s job {} in namespace {}",
            job_name, self.metadata.namespace
        );

        // Version check if specified
        if self.metadata.step_dsl.r#type == "RunK8sJob" {
            if let Ok(spec) =
                serde_json::from_value::<super::K8sJobSpec>(self.metadata.step_dsl.spec.clone())
            {
                if let Some(min_v) = spec.minimum_version {
                    if let Err(e) = Self::do_check_version(&self.metadata.cluster_version, &min_v) {
                        warn!("Version check failed for {}: {}", job_name, e);
                        return Ok(StartResult::Failed(K8sJobMachine {
                            client: self.client,
                            metadata: self.metadata,
                            state: state::Finished {
                                result: JobState::Failed(
                                    format!("Version mismatch: {}", e),
                                    JobMetrics::default(),
                                ),
                            },
                        }));
                    }
                }
            }
        }

        let agent_image = std::env::var("STORMCHASER_AGENT_IMAGE").ok();
        let sfs_pvc_name = std::env::var("STORMCHASER_SFS_PVC_NAME").ok();
        let job =
            k8s_utils::do_build_job_spec(&job_name, &self.metadata, agent_image, sfs_pvc_name)?;

        let jobs: Api<Job> = Api::namespaced(self.client.clone(), &self.metadata.namespace);

        match jobs.create(&PostParams::default(), &job).await {
            Ok(_) => Ok(StartResult::Running(K8sJobMachine {
                client: self.client,
                metadata: self.metadata,
                state: state::Running {
                    job_name,
                    dispatched_at: Utc::now(),
                },
            })),
            Err(kube::Error::Api(ref err)) if err.code == 409 => {
                tracing::warn!("Job {} already exists, re-attaching", job_name);
                Ok(StartResult::Running(K8sJobMachine {
                    client: self.client,
                    metadata: self.metadata,
                    state: state::Running {
                        job_name,
                        dispatched_at: Utc::now(),
                    },
                }))
            }
            Err(e) => {
                error!("Failed to create K8s job {}: {:?}", job_name, e);
                Ok(StartResult::Failed(K8sJobMachine {
                    client: self.client,
                    metadata: self.metadata,
                    state: state::Finished {
                        result: JobState::Failed(
                            format!("K8s API error: {:?}", e),
                            JobMetrics::default(),
                        ),
                    },
                }))
            }
        }
    }
}

impl K8sJobMachine<state::Running> {
    /// Wait.
    pub async fn wait(self) -> Result<JobState> {
        let job_name = &self.state.job_name;
        let dispatched_at = self.state.dispatched_at;
        let jobs: Api<Job> = Api::namespaced(self.client.clone(), &self.metadata.namespace);

        info!("Watching K8s job {} until completion...", job_name);

        let mut watch_failures = 0;
        let max_watch_failures = 3;

        loop {
            let wp = WatchParams::default()
                .fields(&format!("metadata.name={}", job_name))
                .timeout(60);
            let mut stream = jobs.watch(&wp, "0").await?.boxed();

            while let Some(status) = stream.next().await {
                match status {
                    Ok(event) => {
                        watch_failures = 0;
                        match event {
                            WatchEvent::Modified(job) | WatchEvent::Added(job) => {
                                if let Some(state) = self
                                    .process_job_result(job, job_name, dispatched_at)
                                    .await?
                                {
                                    return Ok(state);
                                }
                            }
                            WatchEvent::Deleted(job) => {
                                return Err(anyhow::anyhow!(
                                    "Job {} was deleted during watch",
                                    job.metadata.name.unwrap_or_default()
                                ));
                            }
                            _ => {}
                        }
                    }
                    Err(e) => {
                        error!("Error from watch stream for {}: {:?}", job_name, e);
                        watch_failures += 1;
                        break; // Exit inner loop to restart or fallback
                    }
                }
            }

            if watch_failures >= max_watch_failures {
                warn!(
                    "Watch stream for {} failed {} times, falling back to polling",
                    job_name, watch_failures
                );
                return self
                    .poll_job_until_completion(jobs, job_name, dispatched_at)
                    .await;
            }

            sleep(Duration::from_secs(2)).await;

            if let Some(job) = jobs.get_opt(job_name).await? {
                if let Some(state) = self
                    .process_job_result(job, job_name, dispatched_at)
                    .await?
                {
                    return Ok(state);
                }
            } else {
                return Err(anyhow::anyhow!(
                    "Job {} vanished during watch reconnection",
                    job_name
                ));
            }
        }
    }

    async fn poll_job_until_completion(
        &self,
        jobs: Api<Job>,
        job_name: &str,
        dispatched_at: chrono::DateTime<chrono::Utc>,
    ) -> Result<JobState> {
        let mut interval = tokio::time::interval(Duration::from_secs(10));
        loop {
            interval.tick().await;
            info!("Polling K8s job {} status...", job_name);

            if let Some(job) = jobs.get_opt(job_name).await? {
                if let Some(state) = self
                    .process_job_result(job, job_name, dispatched_at)
                    .await?
                {
                    return Ok(state);
                }
            } else {
                return Err(anyhow::anyhow!("Job {} vanished during polling", job_name));
            }
        }
    }

    async fn process_job_result(
        &self,
        job: Job,
        job_name: &str,
        dispatched_at: chrono::DateTime<chrono::Utc>,
    ) -> Result<Option<JobState>> {
        if let Some(status) = job.status {
            let latency_ms = (dispatched_at - self.metadata.received_at)
                .num_milliseconds()
                .max(0) as u64;
            let duration_ms = (Utc::now() - dispatched_at).num_milliseconds().max(0) as u64;

            if status.succeeded.unwrap_or(0) > 0 {
                info!("Job {} completed successfully", job_name);
                let (exit_code, attempts, _) =
                    self.get_pod_metrics(job_name)
                        .await
                        .unwrap_or((Some(0), 1, None));
                let storage_hashes = self.get_storage_hashes(job_name).await.unwrap_or(None);
                let artifacts = self.get_artifact_meta(job_name).await.unwrap_or(None);
                let test_reports = self.get_test_reports(job_name).await.unwrap_or(None);

                return Ok(Some(JobState::Succeeded(JobMetrics {
                    exit_code,
                    attempts,
                    duration_ms,
                    latency_ms,
                    storage_hashes,
                    artifacts,
                    test_reports,
                })));
            }
            if status.failed.unwrap_or(0) > 0 {
                let (exit_code, attempts, pod_reason) = self
                    .get_pod_metrics(job_name)
                    .await
                    .unwrap_or((None, 1, None));
                let storage_hashes = self.get_storage_hashes(job_name).await.unwrap_or(None);
                let artifacts = self.get_artifact_meta(job_name).await.unwrap_or(None);
                let test_reports = self.get_test_reports(job_name).await.unwrap_or(None);

                let conditions = status.conditions.unwrap_or_default();
                if conditions.iter().any(|c| c.type_ == "Failed") {
                    let job_reason = conditions
                        .iter()
                        .find(|c| c.type_ == "Failed")
                        .and_then(|c| c.message.clone())
                        .unwrap_or_else(|| "Job failed".to_string());

                    let reason = pod_reason.unwrap_or(job_reason);
                    error!("Job {} failed: {}", job_name, reason);
                    return Ok(Some(JobState::Failed(
                        reason,
                        JobMetrics {
                            exit_code,
                            attempts,
                            duration_ms,
                            latency_ms,
                            storage_hashes,
                            artifacts,
                            test_reports,
                        },
                    )));
                }
            }
        }
        Ok(None)
    }

    async fn get_pod_metrics(&self, job_name: &str) -> Result<(Option<i32>, i32, Option<String>)> {
        let pods: Api<Pod> = Api::namespaced(self.client.clone(), &self.metadata.namespace);
        let lp = ListParams::default().labels(&format!("job-name={}", job_name));
        let pod_list = pods.list(&lp).await?;

        Ok(k8s_utils::do_extract_pod_metrics_with_reason(
            pod_list.items,
        ))
    }

    async fn get_storage_hashes(&self, job_name: &str) -> Result<Option<HashMap<String, String>>> {
        if self.metadata.storage.is_none() {
            return Ok(None);
        }

        let pods: Api<Pod> = Api::namespaced(self.client.clone(), &self.metadata.namespace);
        let lp = ListParams::default().labels(&format!("job-name={}", job_name));
        let pod_list = pods.list(&lp).await?;

        if let Some(pod) = pod_list.items.first() {
            let pod_name = pod.metadata.name.as_ref().context("Pod missing name")?;
            let logs = pods
                .logs(
                    pod_name,
                    &kube::api::LogParams {
                        container: Some("worker".to_string()),
                        ..Default::default()
                    },
                )
                .await?;

            for line in logs.lines() {
                if line.contains("Parked storage hashes:") {
                    if let Some(json_start) = line.find('{') {
                        let json_part = &line[json_start..];
                        if let Ok(hashes) = serde_json::from_str(json_part) {
                            return Ok(Some(hashes));
                        }
                    }
                }
            }
        }
        Ok(None)
    }

    async fn get_artifact_meta(&self, job_name: &str) -> Result<Option<HashMap<String, Value>>> {
        if self.metadata.storage.is_none() {
            return Ok(None);
        }

        let pods: Api<Pod> = Api::namespaced(self.client.clone(), &self.metadata.namespace);
        let lp = ListParams::default().labels(&format!("job-name={}", job_name));
        let pod_list = pods.list(&lp).await?;

        if let Some(pod) = pod_list.items.first() {
            let pod_name = pod.metadata.name.as_ref().context("Pod missing name")?;
            let logs = pods
                .logs(
                    pod_name,
                    &kube::api::LogParams {
                        container: Some("worker".to_string()),
                        ..Default::default()
                    },
                )
                .await?;

            for line in logs.lines() {
                if line.contains("Parked artifacts:") {
                    if let Some(json_start) = line.find('{') {
                        let json_part = &line[json_start..];
                        if let Ok(meta) = serde_json::from_str(json_part) {
                            return Ok(Some(meta));
                        }
                    }
                }
            }
        }
        Ok(None)
    }

    async fn get_test_reports(&self, job_name: &str) -> Result<Option<HashMap<String, Value>>> {
        if self.metadata.step_dsl.reports.is_empty() {
            return Ok(None);
        }

        let pods: Api<Pod> = Api::namespaced(self.client.clone(), &self.metadata.namespace);
        let lp = ListParams::default().labels(&format!("job-name={}", job_name));
        let pod_list = pods.list(&lp).await?;

        if let Some(pod) = pod_list.items.first() {
            let pod_name = pod.metadata.name.as_ref().context("Pod missing name")?;
            let logs = pods
                .logs(
                    pod_name,
                    &kube::api::LogParams {
                        container: Some("worker".to_string()),
                        ..Default::default()
                    },
                )
                .await?;

            for line in logs.lines() {
                if line.contains("Collected test reports JSON:") {
                    if let Some(json_start) = line.find('{') {
                        let json_part = &line[json_start..];
                        if let Ok(reports) = serde_json::from_str(json_part) {
                            return Ok(Some(reports));
                        }
                    }
                }
            }
        }
        Ok(None)
    }
}

impl K8sJobMachine<state::Finished> {
    /// Into result.
    pub fn into_result(self) -> JobState {
        self.state.result
    }
}

impl<S> K8sJobMachine<S> {
    /// Do check version.
    pub fn do_check_version(cluster_version: &str, min_version: &str) -> Result<()> {
        let mut current = Self::do_parse_version(cluster_version)?;
        let mut required = Self::do_parse_version(min_version)?;

        let max_len = current.len().max(required.len());
        while current.len() < max_len {
            current.push(0);
        }
        while required.len() < max_len {
            required.push(0);
        }

        if current < required {
            return Err(anyhow::anyhow!(
                "Cluster version {} is less than required version {}",
                cluster_version,
                min_version
            ));
        }
        Ok(())
    }

    /// Do parse version.
    pub fn do_parse_version(v: &str) -> Result<Vec<i32>> {
        let v = v.trim_start_matches('v').split('-').next().unwrap_or(v);
        v.split('.')
            .map(|s| {
                let s_clean: String = s.chars().take_while(|c| c.is_ascii_digit()).collect();
                s_clean.parse::<i32>().map_err(|e| {
                    anyhow::anyhow!("Failed to parse version component '{}': {}", s, e)
                })
            })
            .collect()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_do_parse_version() {
        assert_eq!(
            K8sJobMachine::<state::Initialized>::do_parse_version("1.2.3").unwrap(),
            vec![1, 2, 3]
        );
        assert_eq!(
            K8sJobMachine::<state::Initialized>::do_parse_version("v1.2.3").unwrap(),
            vec![1, 2, 3]
        );
        assert_eq!(
            K8sJobMachine::<state::Initialized>::do_parse_version("v1.2.3-alpha").unwrap(),
            vec![1, 2, 3]
        );
        assert_eq!(
            K8sJobMachine::<state::Initialized>::do_parse_version("1.25.0+xyz").unwrap(),
            vec![1, 25, 0]
        );
        assert!(K8sJobMachine::<state::Initialized>::do_parse_version("invalid").is_err());
    }

    #[test]
    fn test_do_check_version() {
        assert!(K8sJobMachine::<state::Initialized>::do_check_version("1.25.0", "1.24.0").is_ok());
        assert!(K8sJobMachine::<state::Initialized>::do_check_version("1.25.0", "1.25.0").is_ok());
        assert!(K8sJobMachine::<state::Initialized>::do_check_version("1.25.1", "1.25.0").is_ok());

        let err =
            K8sJobMachine::<state::Initialized>::do_check_version("1.24.0", "1.25.0").unwrap_err();
        assert!(err.to_string().contains("less than required version"));
    }
}