killport 2.0.0

A command-line tool to easily kill processes and containers running on a specified port.
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
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
use crate::container::Container;
use crate::killable::{Killable, KillableType};
#[cfg(target_os = "linux")]
use crate::linux::find_target_processes;
#[cfg(target_os = "macos")]
use crate::macos::find_target_processes;
#[cfg(target_os = "windows")]
use crate::windows::find_target_processes;
use crate::{cli::Mode, signal::KillportSignal};
use std::io::Error;
use tokio::runtime::{Builder, Runtime};

/// Trait for finding native processes on a port (enables mocking in tests).
pub trait ProcessFinder {
    fn find_target_processes(&self, port: u16) -> Result<Vec<Box<dyn Killable>>, Error>;
}

/// Trait for container runtime operations (enables mocking in tests).
pub trait ContainerOps {
    fn is_available(&self) -> Result<bool, Error>;
    fn find_target_containers(&self, port: u16) -> Result<Vec<Container>, Error>;
}

/// Real implementation of ProcessFinder that calls the platform-specific functions.
pub struct NativeProcessFinder;

impl ProcessFinder for NativeProcessFinder {
    fn find_target_processes(&self, port: u16) -> Result<Vec<Box<dyn Killable>>, Error> {
        let processes = find_target_processes(port)?;
        Ok(processes
            .into_iter()
            .map(|p| Box::new(p) as Box<dyn Killable>)
            .collect())
    }
}

/// Real implementation of ContainerOps that calls the container runtime API.
pub struct RealContainerOps {
    rt: Runtime,
}

impl RealContainerOps {
    pub fn new() -> Result<Self, Error> {
        Ok(Self {
            rt: Builder::new_current_thread().enable_all().build()?,
        })
    }
}

impl ContainerOps for RealContainerOps {
    fn is_available(&self) -> Result<bool, Error> {
        Container::is_available(&self.rt)
    }

    fn find_target_containers(&self, port: u16) -> Result<Vec<Container>, Error> {
        Container::find_target_containers(&self.rt, port)
    }
}

/// Killport implementation with injectable dependencies for testability.
pub struct Killport<P: ProcessFinder, D: ContainerOps> {
    process_finder: P,
    container_ops: D,
}

impl Killport<NativeProcessFinder, RealContainerOps> {
    /// Creates a Killport with real (production) dependencies.
    pub fn with_real_deps() -> Result<Self, Error> {
        Ok(Self::new(NativeProcessFinder, RealContainerOps::new()?))
    }
}

impl<P: ProcessFinder, D: ContainerOps> Killport<P, D> {
    pub fn new(process_finder: P, container_ops: D) -> Self {
        Self {
            process_finder,
            container_ops,
        }
    }

    pub fn find_target_killables(
        &self,
        port: u16,
        mode: Mode,
    ) -> Result<Vec<Box<dyn Killable>>, Error> {
        let mut target_killables: Vec<Box<dyn Killable>> = vec![];
        let containers_available = mode != Mode::Process && self.container_ops.is_available()?;

        // Find containers first — if any are found, native processes on the same port
        // are port forwarders (docker-proxy, OrbStack Helper, etc.) and must be skipped.
        let has_containers = if containers_available && mode != Mode::Process {
            let target_containers = self.container_ops.find_target_containers(port)?;
            let found = !target_containers.is_empty();
            for container in target_containers {
                target_killables.push(Box::new(container));
            }
            found
        } else {
            false
        };

        if mode != Mode::Container {
            // Skip native processes when containers own the port — those processes
            // are port forwarders (docker-proxy, OrbStack Helper, Podman, etc.)
            if !has_containers {
                let target_processes = self.process_finder.find_target_processes(port)?;
                for process in target_processes {
                    target_killables.push(process);
                }
            }
        }

        Ok(target_killables)
    }

    pub fn kill_service_by_port(
        &self,
        port: u16,
        signal: KillportSignal,
        mode: Mode,
        dry_run: bool,
    ) -> Result<Vec<(KillableType, String)>, Error> {
        let mut results = Vec::new();
        let target_killables = self.find_target_killables(port, mode)?;

        for killable in target_killables {
            let killed = dry_run || killable.kill(signal.clone())?;
            if killed {
                results.push((killable.get_type(), killable.get_name()));
            }
        }

        Ok(results)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    #[cfg(unix)]
    use nix::sys::signal::Signal;
    use std::cell::RefCell;

    // ─── Mock implementations for testing orchestration logic ────────────

    struct MockKillable {
        kill_result: Result<bool, Error>,
        killable_type: KillableType,
        name: String,
        kill_called: RefCell<bool>,
    }

    impl MockKillable {
        fn process(name: &str) -> Self {
            Self {
                kill_result: Ok(true),
                killable_type: KillableType::Process,
                name: name.to_string(),
                kill_called: RefCell::new(false),
            }
        }

        fn with_kill_result(mut self, result: Result<bool, Error>) -> Self {
            self.kill_result = result;
            self
        }
    }

    impl Killable for MockKillable {
        fn kill(&self, _signal: KillportSignal) -> Result<bool, Error> {
            *self.kill_called.borrow_mut() = true;
            match &self.kill_result {
                Ok(v) => Ok(*v),
                Err(e) => Err(Error::new(e.kind(), e.to_string())),
            }
        }

        fn get_type(&self) -> KillableType {
            self.killable_type.clone()
        }

        fn get_name(&self) -> String {
            self.name.clone()
        }
    }

    struct FnProcessFinder<F: Fn(u16) -> Result<Vec<Box<dyn Killable>>, Error>> {
        finder: F,
    }

    impl<F: Fn(u16) -> Result<Vec<Box<dyn Killable>>, Error>> ProcessFinder for FnProcessFinder<F> {
        fn find_target_processes(&self, port: u16) -> Result<Vec<Box<dyn Killable>>, Error> {
            (self.finder)(port)
        }
    }

    struct FnContainerOps<
        P: Fn() -> Result<bool, Error>,
        C: Fn(u16) -> Result<Vec<Container>, Error>,
    > {
        is_present: P,
        find_containers: C,
    }

    impl<P: Fn() -> Result<bool, Error>, C: Fn(u16) -> Result<Vec<Container>, Error>> ContainerOps
        for FnContainerOps<P, C>
    {
        fn is_available(&self) -> Result<bool, Error> {
            (self.is_present)()
        }

        fn find_target_containers(&self, port: u16) -> Result<Vec<Container>, Error> {
            (self.find_containers)(port)
        }
    }

    #[allow(clippy::type_complexity)]
    fn no_containers() -> FnContainerOps<
        impl Fn() -> Result<bool, Error>,
        impl Fn(u16) -> Result<Vec<Container>, Error>,
    > {
        FnContainerOps {
            is_present: || Ok(false),
            find_containers: |_| Ok(vec![]),
        }
    }

    #[allow(clippy::type_complexity)]
    fn with_containers(
        containers: Vec<String>,
    ) -> FnContainerOps<
        impl Fn() -> Result<bool, Error>,
        impl Fn(u16) -> Result<Vec<Container>, Error>,
    > {
        FnContainerOps {
            is_present: || Ok(true),
            find_containers: move |_| {
                Ok(containers
                    .iter()
                    .map(|n| Container { name: n.clone() })
                    .collect())
            },
        }
    }

    fn signal() -> KillportSignal {
        #[cfg(unix)]
        {
            KillportSignal(Signal::SIGKILL)
        }
        #[cfg(not(unix))]
        {
            KillportSignal("SIGKILL".to_string())
        }
    }

    // ─── Orchestration Tests: find_target_killables ──────────────────────

    #[test]
    fn test_find_killables_mode_auto_no_containers() {
        let finder = FnProcessFinder {
            finder: |_| {
                let p: Box<dyn Killable> = Box::new(MockKillable::process("my_app"));
                Ok(vec![p])
            },
        };
        let kp = Killport::new(finder, no_containers());
        let results = kp.find_target_killables(8080, Mode::Auto).unwrap();
        assert_eq!(results.len(), 1);
        assert_eq!(results[0].get_type(), KillableType::Process);
        assert_eq!(results[0].get_name(), "my_app");
    }

    #[test]
    fn test_find_killables_containers_found_skips_all_processes() {
        // When containers are found on a port, ALL native processes are skipped
        // because they are port forwarders (docker-proxy, OrbStack Helper, etc.)
        let finder = FnProcessFinder {
            finder: |_| {
                let p: Box<dyn Killable> = Box::new(MockKillable::process("OrbStack Helper"));
                Ok(vec![p])
            },
        };
        let ct = with_containers(vec!["nginx".to_string()]);
        let kp = Killport::new(finder, ct);
        let results = kp.find_target_killables(8080, Mode::Auto).unwrap();
        // Only the container — native process is a port forwarder and must be skipped
        assert_eq!(results.len(), 1);
        assert_eq!(results[0].get_type(), KillableType::Container);
        assert_eq!(results[0].get_name(), "nginx");
    }

    #[test]
    fn test_find_killables_no_containers_keeps_all_processes() {
        // When no containers are found, all native processes are returned
        // regardless of their name (docker-proxy, orbstack, etc.)
        let finder = FnProcessFinder {
            finder: |_| {
                let p1: Box<dyn Killable> = Box::new(MockKillable::process("docker-proxy"));
                let p2: Box<dyn Killable> = Box::new(MockKillable::process("my_app"));
                Ok(vec![p1, p2])
            },
        };
        let ct = with_containers(vec![]); // runtime present, no containers
        let kp = Killport::new(finder, ct);
        let results = kp.find_target_killables(8080, Mode::Auto).unwrap();
        // Both returned — no containers means these are real targets
        assert_eq!(results.len(), 2);
        assert_eq!(results[0].get_name(), "docker-proxy");
        assert_eq!(results[1].get_name(), "my_app");
    }

    #[test]
    fn test_find_killables_runtime_absent_returns_all_processes() {
        // When container runtime is NOT present, all processes are returned
        let finder = FnProcessFinder {
            finder: |_| {
                let p1: Box<dyn Killable> = Box::new(MockKillable::process("docker-proxy"));
                let p2: Box<dyn Killable> = Box::new(MockKillable::process("my_app"));
                Ok(vec![p1, p2])
            },
        };
        let kp = Killport::new(finder, no_containers());
        let results = kp.find_target_killables(8080, Mode::Auto).unwrap();
        assert_eq!(results.len(), 2);
        assert_eq!(results[0].get_name(), "docker-proxy");
        assert_eq!(results[1].get_name(), "my_app");
    }

    #[test]
    fn test_find_killables_process_mode_skips_containers() {
        // In Process mode, container runtime is never checked — all processes returned
        let finder = FnProcessFinder {
            finder: |_| {
                let p1: Box<dyn Killable> = Box::new(MockKillable::process("docker-proxy"));
                let p2: Box<dyn Killable> = Box::new(MockKillable::process("my_app"));
                Ok(vec![p1, p2])
            },
        };
        let ct = FnContainerOps {
            is_present: || panic!("Container runtime should not be checked in Process mode"),
            find_containers: |_| panic!("Container runtime should not be checked in Process mode"),
        };
        let kp = Killport::new(finder, ct);
        let results = kp.find_target_killables(8080, Mode::Process).unwrap();
        assert_eq!(results.len(), 2);
        assert_eq!(results[0].get_name(), "docker-proxy");
        assert_eq!(results[1].get_name(), "my_app");
    }

    #[test]
    fn test_find_killables_multiple_containers_skips_processes() {
        // Multiple port forwarder processes should all be skipped
        let finder = FnProcessFinder {
            finder: |_| {
                let p1: Box<dyn Killable> = Box::new(MockKillable::process("docker-proxy"));
                let p2: Box<dyn Killable> = Box::new(MockKillable::process("dockerd"));
                Ok(vec![p1, p2])
            },
        };
        let ct = with_containers(vec!["nginx".to_string()]);
        let kp = Killport::new(finder, ct);
        let results = kp.find_target_killables(8080, Mode::Auto).unwrap();
        assert_eq!(results.len(), 1);
        assert_eq!(results[0].get_type(), KillableType::Container);
        assert_eq!(results[0].get_name(), "nginx");
    }

    #[test]
    fn test_find_killables_mode_process_only() {
        let finder = FnProcessFinder {
            finder: |_| {
                let p: Box<dyn Killable> = Box::new(MockKillable::process("my_app"));
                Ok(vec![p])
            },
        };
        // Container runtime should never be checked in Process mode
        let ct = FnContainerOps {
            is_present: || panic!("Container runtime should not be checked in Process mode"),
            find_containers: |_| panic!("Container runtime should not be checked in Process mode"),
        };
        let kp = Killport::new(finder, ct);
        let results = kp.find_target_killables(8080, Mode::Process).unwrap();
        assert_eq!(results.len(), 1);
        assert_eq!(results[0].get_type(), KillableType::Process);
    }

    #[test]
    fn test_find_killables_mode_container_only() {
        let finder = FnProcessFinder {
            finder: |_| panic!("Process finder should not be called in Container mode"),
        };
        let ct = with_containers(vec!["redis".to_string()]);
        let kp = Killport::new(finder, ct);
        let results = kp.find_target_killables(8080, Mode::Container).unwrap();
        assert_eq!(results.len(), 1);
        assert_eq!(results[0].get_type(), KillableType::Container);
        assert_eq!(results[0].get_name(), "redis");
    }

    #[test]
    fn test_find_killables_empty_results() {
        let finder = FnProcessFinder {
            finder: |_| Ok(vec![]),
        };
        let kp = Killport::new(finder, no_containers());
        let results = kp.find_target_killables(8080, Mode::Auto).unwrap();
        assert!(results.is_empty());
    }

    #[test]
    fn test_find_killables_process_finder_error() {
        let finder = FnProcessFinder {
            finder: |_| {
                Err(Error::new(
                    std::io::ErrorKind::PermissionDenied,
                    "access denied",
                ))
            },
        };
        let kp = Killport::new(finder, no_containers());
        let result = kp.find_target_killables(8080, Mode::Auto);
        assert!(result.is_err());
        let err = result.err().unwrap();
        assert_eq!(err.kind(), std::io::ErrorKind::PermissionDenied);
    }

    #[test]
    fn test_find_killables_container_check_error() {
        let finder = FnProcessFinder {
            finder: |_| Ok(vec![]),
        };
        let ct = FnContainerOps {
            is_present: || Err(Error::other("container runtime error")),
            find_containers: |_| Ok(vec![]),
        };
        let kp = Killport::new(finder, ct);
        let result = kp.find_target_killables(8080, Mode::Auto);
        assert!(result.is_err());
    }

    #[test]
    fn test_find_killables_container_find_error() {
        let finder = FnProcessFinder {
            finder: |_| Ok(vec![]),
        };
        let ct = FnContainerOps {
            is_present: || Ok(true),
            find_containers: |_| Err(Error::other("container error")),
        };
        let kp = Killport::new(finder, ct);
        let result = kp.find_target_killables(8080, Mode::Auto);
        assert!(result.is_err());
    }

    // ─── Orchestration Tests: kill_service_by_port ───────────────────────

    #[test]
    fn test_kill_service_actual_kill_succeeds() {
        let finder = FnProcessFinder {
            finder: |_| {
                let p: Box<dyn Killable> = Box::new(MockKillable::process("my_app"));
                Ok(vec![p])
            },
        };
        let kp = Killport::new(finder, no_containers());
        let results = kp
            .kill_service_by_port(8080, signal(), Mode::Auto, false)
            .unwrap();
        assert_eq!(results.len(), 1);
        assert_eq!(results[0].0, KillableType::Process);
        assert_eq!(results[0].1, "my_app");
    }

    #[test]
    fn test_kill_service_kill_returns_false() {
        let finder = FnProcessFinder {
            finder: |_| {
                let p: Box<dyn Killable> =
                    Box::new(MockKillable::process("my_app").with_kill_result(Ok(false)));
                Ok(vec![p])
            },
        };
        let kp = Killport::new(finder, no_containers());
        let results = kp
            .kill_service_by_port(8080, signal(), Mode::Auto, false)
            .unwrap();
        assert!(
            results.is_empty(),
            "Process that returned false should not be in results"
        );
    }

    #[test]
    fn test_kill_service_kill_error_propagates() {
        let finder =
            FnProcessFinder {
                finder: |_| {
                    let p: Box<dyn Killable> =
                        Box::new(MockKillable::process("my_app").with_kill_result(Err(
                            Error::new(std::io::ErrorKind::PermissionDenied, "EPERM"),
                        )));
                    Ok(vec![p])
                },
            };
        let kp = Killport::new(finder, no_containers());
        let result = kp.kill_service_by_port(8080, signal(), Mode::Auto, false);
        assert!(result.is_err());
    }

    #[test]
    fn test_kill_service_dry_run_collects_without_killing() {
        // We can't directly check kill_called on the mock since it's moved,
        // but we can verify the results are collected and the names match
        let finder = FnProcessFinder {
            finder: |_| {
                let p: Box<dyn Killable> = Box::new(MockKillable::process("my_app"));
                Ok(vec![p])
            },
        };
        let kp = Killport::new(finder, no_containers());
        let results = kp
            .kill_service_by_port(8080, signal(), Mode::Auto, true)
            .unwrap();
        assert_eq!(results.len(), 1);
        assert_eq!(results[0].0, KillableType::Process);
        assert_eq!(results[0].1, "my_app");
    }

    #[test]
    fn test_kill_service_dry_run_empty() {
        let finder = FnProcessFinder {
            finder: |_| Ok(vec![]),
        };
        let kp = Killport::new(finder, no_containers());
        let results = kp
            .kill_service_by_port(8080, signal(), Mode::Auto, true)
            .unwrap();
        assert!(results.is_empty());
    }

    #[test]
    fn test_kill_service_multiple_targets_no_containers() {
        // Multiple processes, no containers — all get killed
        let finder = FnProcessFinder {
            finder: |_| {
                let p1: Box<dyn Killable> = Box::new(MockKillable::process("app1"));
                let p2: Box<dyn Killable> = Box::new(MockKillable::process("app2"));
                Ok(vec![p1, p2])
            },
        };
        let kp = Killport::new(finder, no_containers());
        let results = kp
            .kill_service_by_port(8080, signal(), Mode::Auto, true)
            .unwrap();
        assert_eq!(results.len(), 2);
        assert_eq!(results[0].1, "app1");
        assert_eq!(results[1].1, "app2");
    }

    #[test]
    fn test_kill_service_container_found_skips_processes() {
        // When a container is found, only the container is killed (processes are port forwarders)
        let finder = FnProcessFinder {
            finder: |_| {
                let p: Box<dyn Killable> = Box::new(MockKillable::process("OrbStack Helper"));
                Ok(vec![p])
            },
        };
        let ct = with_containers(vec!["nginx".to_string()]);
        let kp = Killport::new(finder, ct);
        let results = kp
            .kill_service_by_port(8080, signal(), Mode::Auto, true)
            .unwrap();
        assert_eq!(results.len(), 1);
        assert_eq!(results[0].0, KillableType::Container);
        assert_eq!(results[0].1, "nginx");
    }
}