feat: local install of ProSA for Linux and MacOS

Signed-off-by: Jeremy HERGAULT <[email protected]>

Author: reneca

Cargo.toml

@@ -32,7 +32,7 @@ serde = { version = "1", features = ["derive"] }
 url = { version = "2", features = ["serde"] }
 tokio = { version = "1", features = ["fs", "macros", "net", "parking_lot", "rt", "rt-multi-thread", "signal", "sync", "time"] }
 config = { version = "0.15", default-features = false, features = ["toml", "json", "yaml", "json5", "convert-case", "async"] }
-toml = "0.8"
+toml = "0.9"
 
 # Config Observability
 log = "0.4"

assets/macos_prosa_background.png

@@ -1,6 +1,6 @@
 [package]
 name = "cargo-prosa"
-version = "0.3.1"
+version = "0.3.2"
 authors.workspace = true
 description = "ProSA utility to package and deliver a builded ProSA"
 homepage.workspace = true
@@ -20,7 +20,7 @@ clap = "4"
 clap_complete = "4"
 serde.workspace = true
 toml.workspace = true
-toml_edit = { version = "0.22", features = ["serde"] }
+toml_edit = { version = "0.23", features = ["serde"] }
 serde_json = "1"
 serde_yaml = "0.9"
 config.workspace = true

cargo-prosa/Cargo.toml

@@ -8,14 +8,13 @@ This builder is packaged within cargo as a custom command to be well integrated
 
 ## Install
 
-As you can tell by its name, cargo-prosa, is tool embeded in [Cargo](https://doc.rust-lang.org/book/ch14-05-extending-cargo.html).
-
-Therefore, you can install it via the Cargo command:
+`cargo-prosa` is a [Cargo subcommand](https://doc.rust-lang.org/book/ch14-05-extending-cargo.html), so you need to have [Cargo installed](https://doc.rust-lang.org/cargo/getting-started/installation.html) to use it.
+Install cargo-prosa using the following command:
 ```bash
 cargo install cargo-prosa
 ```
 
-You should have the command installed with its bounch of functions:
+After installation, verify that the command is available and explore its features:
 ```bash
 cargo prosa --help
 ```
@@ -94,6 +93,115 @@ target/debug/my-prosa -n "MyBuiltProSA" -c default_config.yaml
 This builder offer you several possibilities to deploy your ProSA.
 The goal is to use the easiest method of a plateform to run your application.
 
+### Locally
+
+On Linux or MacOS, you can install ProSA directly on your machine:
+```bash
+# Install ProSA
+cargo prosa install
+
+# Uninstall ProSA
+cargo prosa uninstall
+```
+
+To avoid conflicts, specify a unique name during installation:
+```bash
+cargo prosa install --name dummy
+```
+
+Use the same name when uninstalling:
+```bash
+cargo prosa uninstall --name dummy
+```
+
+If the package isn't compiled for debug or release (--release), it will automatically compile during installation.
+
+Simulate an installation with:
+```bash
+cargo prosa install --dry_run -n dummy
+```
+
+#### Linux
+
+When you want to install ProSA with `cargo prosa install`:
+```bash
+$ cargo prosa install -r -n dummy
+Creating service file OK
+Copying binary OK
+Generating configuration OK
+Installed [12183 kB] ProSA `dummy`
+Binary file : $HOME/.local/bin/prosa-dummy
+Config file : $HOME/.config/prosa/dummy/prosa.toml
+Service file: $HOME/.config/systemd/user/dummy.service
+```
+
+And you'll be able to handle it through `systemctl`:
+```bash
+$ systemctl --user status dummy.service
+○ dummy.service - Local ProSA instance
+     Loaded: loaded ($HOME/.config/systemd/user/dummy.service; disabled; preset: enabled)
+     Active: inactive (dead)
+```
+
+To install it for the whole system, you can use the `--system` option:
+```bash
+$ sudo -E $HOME/.cargo/bin/cargo prosa install -r -s -n dummy
+Creating service file OK
+Copying binary OK
+Generating configuration OK
+Installed [12184 kB] ProSA `dummy`
+Binary file : /usr/local/bin/prosa-dummy
+Config file : /etc/prosa/dummy/prosa.toml
+Service file: /etc/systemd/system/dummy.service
+```
+
+By installing ProSA system wide, you are able to see the service:
+```bash
+$ sudo service dummy status       
+○ dummy.service - Local ProSA instance
+     Loaded: loaded (/etc/systemd/system/dummy.service; disabled; preset: enabled)
+     Active: inactive (dead)
+```
+
+#### MacOS
+
+On MacOS it's the same as Linux, but with MacOS specifics.
+
+So you can install it, and if the binary don't exist, it'll compil the project:
+```bash
+$ cargo prosa install -r -n dummy
+Creating service OK
+   Compiling ...
+    Finished `release` profile [optimized] target(s) in 24.58s
+Copying binary OK
+Generating configuration OK
+Installed [10578 kB] ProSA `dummy`
+Binary file : $HOME/.local/bin/prosa-dummy
+Config file : $HOME/.config/prosa/dummy/prosa.toml
+Service file: $HOME/Library/LaunchAgents/com.prosa.dummy.plist
+```
+
+And once cargo-prosa installed the service, MacOS should notify you to indicate the new created service:
+
+![MacOS service creation notification](/assets/macos_prosa_background.png)
+
+You can now load it and run it with:
+```bash
+launchctl load $HOME/Library/LaunchAgents/com.prosa.dummy.plist
+```
+
+and you can uninstall it with:
+```bash
+$ launchctl unload $HOME/Library/LaunchAgents/com.prosa.dummy.plist
+$ cargo prosa uninstall -n dummy
+Remove service OK
+Remove binary OK
+Uninstalled ProSA `dummy`
+Binary file : $HOME/.local/bin/prosa-dummy
+Config file : $HOME/.config/prosa/dummy/prosa.toml
+Service file: $HOME/Library/LaunchAgents/com.prosa.dummy.plist
+```
+
 ### Container
 
 Containerization will allow you to build and load ProSA in an image:

cargo-prosa/README.md

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+  <dict>
+    <key>Label</key>
+    <string>com.prosa.{{ name }}.daemon.plist</string>
+
+    <key>RunAtLoad</key>
+    <true/>
+
+    <key>ProgramArguments</key>
+    <array>
+        <string>{{ bin }}</string>
+        <string>-c</string>
+        <string>{{ config }}</string>
+    </array>
+  </dict>
+</plist>

cargo-prosa/assets/launchd.j2

@@ -231,6 +231,8 @@ pub struct PackageMetadata {
 
     /// Metadata of the package
     metadata: Option<HashMap<String, serde_json::Value>>,
+    /// target of the package
+    targets: Option<Vec<HashMap<String, serde_json::Value>>>,
 }
 
 impl PackageMetadata {
@@ -243,6 +245,30 @@ impl PackageMetadata {
         }
     }
 
+    /// Getter of the targets for a specific `kind` (bin, custom-build)
+    pub fn get_targets(&self, kind: &str) -> Option<Vec<String>> {
+        if let Some(targets) = &self.targets {
+            let kind_tera_value = tera::Value::String(kind.to_string());
+            let mut binary_targets = Vec::new();
+            for target in targets {
+                if let Some(kinds) = target.get("kind").and_then(|k| k.as_array())
+                    && kinds.contains(&kind_tera_value)
+                    && let Some(name) = target.get("name").and_then(|k| k.as_str())
+                {
+                    binary_targets.push(name.to_string());
+                }
+            }
+
+            if binary_targets.is_empty() {
+                None
+            } else {
+                Some(binary_targets)
+            }
+        } else {
+            None
+        }
+    }
+
     /// Know if the package contain ProSA metadata
     pub fn is_prosa(&self) -> bool {
         self.contain_metadata("prosa")