Merge pull request #192 from h1alexbel/77

feat(#77): fakehub stop via cli::sys

Author: Aliaksei Bialiauski

README.md

@@ -82,6 +82,12 @@ curl -X POST \
 
 This should generate you an access token to fakehub [API](#supported-api).
 
+To stop a server, run:
+
+```bash
+fakehub stop
+```
+
 ### Supported API
 
 We support the following list of "fake" versions of GitHub endpoints:

cli/src/args.rs

@@ -40,6 +40,8 @@ pub(crate) enum Command {
     /// Start the server
     #[command(about = "Start the server")]
     Start(StartArgs),
+    #[command(about = "Stop the server")]
+    Stop,
 }
 
 #[derive(Parser, Debug)]

cli/src/main.rs

@@ -20,14 +20,21 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 /*!
-Fakehub server and storage.
+Fakehub cli.
  */
 use clap::Parser;
-use log::info;
+use log::{error, info};
+
+/// System calls.
+pub mod sys;
 
 use fakehub_server::Server;
 
 use crate::args::{Args, Command};
+use crate::sys::current_port::current_port;
+use crate::sys::kill_unix::kill_unix;
+use fakehub_server::sys::instance_os::instance_os;
+use fakehub_server::sys::sys_info::sys_info;
 #[cfg(target_os = "windows")]
 use std::os::windows::process::CommandExt;
 
@@ -64,14 +71,15 @@ async fn main() {
                         // Detached windows process flag.
                         command.creation_flags(0x00000008);
                         match command.spawn() {
-                            Ok(_) => println!(
+                            Ok(_) => info!(
                                 "Server is running in detached mode on port {}",
                                 start.port
                             ),
                             Err(err) => {
-                                panic!("Failed to spawn detached process: {}", err)
+                                error!("Failed to spawn detached process: {}", err)
                             }
                         }
+                        sys_info();
                         return;
                     }
                     Err(err) => {
@@ -88,5 +96,29 @@ async fn main() {
                 ),
             }
         }
+        // @todo #77:45min Implement kill_windows_port(id) for windows OS.
+        //  Currently, we don't support port killing on Windows. Check
+        //  <a href="https://github.com/h1alexbel/fakehub/pull/159">this</a> pull
+        //  request for more information.
+        Command::Stop => {
+            tracing_subscriber::fmt::init();
+            info!("Stopping fakehub...");
+            let port = current_port();
+            let result = match instance_os().as_str() {
+                "linux" | "macos" => kill_unix(port),
+                _ => {
+                    error!(
+                        "Cannot stop server on port {}, since we probably don't support {} platform",
+                        port, instance_os()
+                    );
+                    false
+                }
+            };
+            if result {
+                info!("fakehub stopped");
+            } else {
+                error!("Cannot stop fakehub on port: {}", port);
+            }
+        }
     }
 }

cli/src/sys/current_port.rs

@@ -0,0 +1,76 @@
+// The MIT License (MIT)
+//
+// Copyright (c) 2024 Aliaksei Bialiauski
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included
+// in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
+/// Current fakehub port.
+pub fn current_port() -> usize {
+    let output = std::process::Command::new("sh")
+        .arg("-c")
+        .arg("lsof -i -P -n | grep fakehub | awk '{print $9}' | cut -d ':' -f2")
+        .output()
+        .expect("failed to get fakehub current port");
+    let port = String::from_utf8(output.stdout).expect("failed to parse stdout");
+    let trimmed = port.trim();
+    trimmed
+        .parse::<usize>()
+        .expect("failed to convert port to usize")
+}
+
+#[cfg(test)]
+mod tests {
+    #[cfg_attr(target_os = "windows", allow(unused_imports))]
+    use crate::sys::current_port::current_port;
+    #[cfg_attr(target_os = "windows", allow(unused_imports))]
+    use anyhow::Result;
+    #[cfg_attr(target_os = "windows", allow(unused_imports))]
+    use assert_cmd::Command;
+    #[cfg_attr(target_os = "windows", allow(unused_imports))]
+    use defer::defer;
+
+    // @todo #77:35min Enable current_port_from_lsof test in rultor.
+    //  This test fails for some reason during Rultor build, because
+    //  of current_port() panics with: 'failed to convert port to usize:
+    //  ParseIntError { kind: Empty }'. It can be probably due to build in
+    //  Docker.
+    #[ignore]
+    #[cfg(not(target_os = "windows"))]
+    #[test]
+    #[allow(clippy::question_mark_used)]
+    fn returns_current_port_from_lsof() -> Result<()> {
+        let port = 3000;
+        let _defer = defer(|| kill(3000));
+        Command::cargo_bin("fakehub")?
+            .arg("start")
+            .arg("-d")
+            .assert();
+        assert_eq!(current_port(), port);
+        Ok(())
+    }
+
+    #[cfg_attr(target_os = "windows", allow(dead_code))]
+    fn kill(port: usize) {
+        std::process::Command::new("sh")
+            .arg("-c")
+            .arg(format!("killport {}", port))
+            .output()
+            .unwrap_or_else(|_| panic!("Failed to kill process on port {}", port));
+    }
+}

cli/src/sys/kill_unix.rs

@@ -0,0 +1,51 @@
+// The MIT License (MIT)
+//
+// Copyright (c) 2024 Aliaksei Bialiauski
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included
+// in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
+use log::{error, info};
+
+/// Kill UNIX port.
+// @todo #77:60min Investigate why lsof does not work in tests, while
+//  killport tool kills port properly. Due to this problem, we can't create
+//  integration test case with fakehub start -d -> fakehub stop. Don't forget
+//  to remove this puzzle.
+pub fn kill_unix(port: usize) -> bool {
+    let output = std::process::Command::new("sh")
+        .arg("-c")
+        .arg(format!("lsof -ti :{} | xargs kill", port))
+        .output()
+        .expect("failed to kill process");
+    let result;
+    if !output.status.success() {
+        let stderr = String::from_utf8_lossy(&output.stderr);
+        if stderr.is_empty() {
+            error!("No process found running on port {}: unable to kill", port);
+            result = false;
+        } else {
+            error!("Failed to kill process on port {}: {}", port, stderr);
+            result = false;
+        }
+    } else {
+        result = true;
+        info!("Port {} killed", port);
+    }
+    result
+}

cli/src/sys/mod.rs

@@ -0,0 +1,25 @@
+// The MIT License (MIT)
+//
+// Copyright (c) 2024 Aliaksei Bialiauski
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included
+// in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+/// Current fakehub port.
+pub mod current_port;
+/// Kill UNIX port.
+pub mod kill_unix;

server/Cargo.toml

@@ -53,6 +53,7 @@ chrono = "0.4.38"
 rand = "0.8.5"
 regex = "1.10.6"
 parameterized = "2.0.0"
+testing_logger = "0.1.1"
 
 [features]
 mirror_release = []

server/src/lib.rs

@@ -34,13 +34,16 @@ use crate::handlers::register_user::register_user;
 use crate::handlers::user::user;
 use crate::handlers::users::users;
 use crate::objects::fakehub::FakeHub;
+use crate::sys::sys_info::sys_info;
 
 /// Handlers.
 pub mod handlers;
 /// Fakehub objects.
 pub mod objects;
 /// Reports.
 pub mod report;
+/// System information.
+pub mod sys;
 #[allow(unused_imports)]
 #[macro_use]
 extern crate hamcrest;
@@ -84,6 +87,7 @@ impl Server {
     /// Start a server.
     pub async fn start(self) -> Result<()> {
         let addr: String = format!("0.0.0.0:{}", self.port);
+        sys_info();
         let started: io::Result<TcpListener> = TcpListener::bind(addr.clone()).await;
         match started {
             Ok(listener) => axum::serve(

server/src/sys/instance_os.rs

@@ -0,0 +1,54 @@
+// The MIT License (MIT)
+//
+// Copyright (c) 2024 Aliaksei Bialiauski
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included
+// in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+/// Instance OS.
+pub fn instance_os() -> String {
+    String::from(std::env::consts::OS)
+}
+
+#[cfg(test)]
+mod tests {
+
+    use crate::sys::instance_os::instance_os;
+    use anyhow::Result;
+    use hamcrest::{equal_to, is, HamcrestMatcher};
+
+    #[cfg(target_os = "linux")]
+    #[test]
+    fn returns_os_on_linux() -> Result<()> {
+        assert_that!(&instance_os(), is(equal_to("linux")));
+        Ok(())
+    }
+
+    #[cfg(target_os = "macos")]
+    #[test]
+    fn returns_os_on_mac() -> Result<()> {
+        assert_that!(&instance_os(), is(equal_to("macos")));
+        Ok(())
+    }
+
+    #[cfg(target_os = "windows")]
+    #[test]
+    fn returns_os_on_windows() -> Result<()> {
+        assert_that!(&instance_os(), is(equal_to("windows")));
+        Ok(())
+    }
+}

server/src/sys/mod.rs

@@ -0,0 +1,25 @@
+// The MIT License (MIT)
+//
+// Copyright (c) 2024 Aliaksei Bialiauski
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included
+// in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+/// Instance OS.
+pub mod instance_os;
+/// System information.
+pub mod sys_info;