r3bl_tui 0.7.2

TUI library to build modern apps inspired by React, Elm, with Flexbox, CSS, editor component, emoji support, and more
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

/*
 *   Copyright (c) 2024-2025 R3BL LLC
 *   All rights reserved.
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 */

use miette::IntoDiagnostic;

use crate::{command, ok};

/// Here are some examples of using `dpkg-query` to check if a package is installed:
///
/// ```fish
/// set package_name "openssl"
/// dpkg-query -s $package_name
/// echo $status
/// if test $status -eq 0
///     echo "True if package is installed"
/// else
///     echo "False if package is not installed"
/// end
/// ```
///
/// # Example
///
/// ```no_run
/// use r3bl_tui::script::apt_install::check_if_package_is_installed;
///
/// async fn check() {
///     let package_name = "bash";
///     let is_installed = check_if_package_is_installed(package_name).await.unwrap();
///     assert!(is_installed);
/// }
/// ```
///
/// ```no_run
/// use r3bl_tui::script::apt_install::install_package;
///
/// async fn install() {
///     let package_name = "does_not_exist";
///     assert!(install_package(package_name).await.is_err());
/// }
/// ```
///
/// # Errors
///
/// Returns an error if:
/// - The `dpkg-query` command is not available (not on a Debian-based system)
/// - The command fails to execute
pub async fn check_if_package_is_installed(package_name: &str) -> miette::Result<bool> {
    let output = command!(
        program => "dpkg-query",
        args => "-s", package_name
    )
    .output()
    .await
    .into_diagnostic()?;
    ok!(output.status.success())
}

/// # Errors
///
/// Returns an error if:
/// - The `apt` command is not available (not on a Debian-based system)
/// - The user does not have sudo privileges
/// - The package installation fails
/// - Network issues prevent downloading the package
pub async fn install_package(package_name: &str) -> miette::Result<()> {
    let command = command!(
        program => "sudo",
        args => "apt", "install", "-y", package_name
    )
    .output()
    .await
    .into_diagnostic()?;
    if command.status.success() {
        ok!()
    } else {
        miette::bail!(
            "Failed to install package: {:?} with sudo apt",
            String::from_utf8_lossy(&command.stderr)
        );
    }
}

#[cfg(test)]
mod tests_apt_install {
    use super::*;
    use crate::{return_if_not_interactive_terminal, TTYResult};

    #[tokio::test]
    async fn test_check_if_package_is_installed() {
        return_if_not_interactive_terminal!();

        let package_name = "bash";
        let is_installed = check_if_package_is_installed(package_name).await.unwrap();
        assert!(is_installed);
    }

    #[tokio::test]
    async fn test_install_package() {
        return_if_not_interactive_terminal!();

        let package_name = "does_not_exist";
        assert!(install_package(package_name).await.is_err());
    }
}