kill_tree 0.1.5

🌳 Kill Tree is a library designed to terminate a specified process and all its child processes recursively, operating independently of other commands like kill or taskkill.
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

use crate::{
    common::{
        self,
        single::{self},
        tree, Impl,
    },
    ProcessId,
};
use nix::{
    errno::Errno,
    sys::signal::{self, Signal},
    unistd::Pid,
};
use tracing::instrument;

const KERNEL_PROCESS_ID: u32 = 0;
const INIT_PROCESS_ID: u32 = 1;

pub(crate) fn validate_process_id(
    process_id: ProcessId,
    available_max: ProcessId,
) -> common::Result<()> {
    match process_id {
        KERNEL_PROCESS_ID => {
            Err(format!("Not allowed to kill kernel process. process id: {process_id}").into())
        }
        INIT_PROCESS_ID => {
            Err(format!("Not allowed to kill init process. process id: {process_id}").into())
        }
        _ => {
            if process_id <= available_max {
                Ok(())
            } else {
                Err(format!(
                    "Process id is too large. process id: {process_id}, available max process id: {available_max}"
                )
                .into())
            }
        }
    }
}

#[instrument]
fn kill(process_id: ProcessId, signal: Signal) -> common::Result<single::Output> {
    let process_id_sign = i32::try_from(process_id)?;
    let result = signal::kill(Pid::from_raw(process_id_sign), signal);
    match result {
        Ok(()) => Ok(single::Output::Killed { process_id }),
        Err(e) => {
            // ESRCH: No such process.
            // This happens when the process has already terminated.
            // This treat as success.
            if e == Errno::ESRCH {
                return Ok(single::Output::MaybeAlreadyTerminated {
                    process_id,
                    reason: e.into(),
                });
            }

            Err(e.into())
        }
    }
}

impl Impl {
    pub(crate) async fn kill_tree(&self) -> common::Result<tree::Outputs> {
        let signal = self.signal.parse::<Signal>()?;
        self.kill_tree_impl(|_| false, move |process_id| kill(process_id, signal))
            .await
    }
}

#[cfg(test)]
mod tests {
    use std::process::Command;

    use crate::{kill_tree, kill_tree_with_signal};

    #[tokio::test]
    async fn process_id_0() {
        let result = kill_tree(0).await;
        assert!(result.is_err());
        assert_eq!(
            result.unwrap_err().to_string(),
            "Not allowed to kill kernel process. process id: 0"
        );
    }

    #[tokio::test]
    async fn process_id_1() {
        let result = kill_tree(1).await;
        assert!(result.is_err());
        assert_eq!(
            result.unwrap_err().to_string(),
            "Not allowed to kill init process. process id: 1"
        );
    }

    #[tokio::test]
    async fn hello_world_with_invalid_signal() {
        let process = Command::new("node")
            .arg("../../../tests/resources/hello_world.mjs")
            .spawn()
            .unwrap();
        let process_id = process.id();
        let result = kill_tree_with_signal(process_id, "SIGINVALID").await;
        assert!(result.is_err());
        assert_eq!(result.unwrap_err().to_string(), "EINVAL: Invalid argument");
    }
}