Refactored util functions

Author: open-schnick

.github/workflows/featureRelease.yml

@@ -5,12 +5,6 @@ on:
   push:
     branches:
       - "feature/**"
-    paths:
-      - "src/**"
-      - "src/api/**"
-      - "src/server/**"
-      - "**/Cargo.toml"
-      - "**/Cargo.lock"
 
 jobs:
   Build_Docker_Image_on_Push:

.github/workflows/featureTests.yml

@@ -6,13 +6,6 @@ on:
     branches:
       - "feature/**"
       - "renovate/**"
-    paths:
-      - "src/**"
-      - "src/api/**"
-      - "src/server/**"
-      - "**/Cargo.toml"
-      - "**/Cargo.lock"
-      - ".github/workflows/featureTests.yml"
 
 jobs:
   test:

.github/workflows/latestRelease.yml

@@ -4,13 +4,7 @@ on:
   workflow_dispatch:
   push:
     branches:
-      - master
-    paths:
-      - "src/**"
-      - "src/api/**"
-      - "src/server/**"
-      - "**/Cargo.toml"
-      - "**/Cargo.lock"
+      - "master"
 
 jobs:
   Build_Docker_Image_on_Push:

.github/workflows/masterTests.yml

@@ -5,13 +5,6 @@ on:
   push:
     branches:
       - "master"
-    paths:
-      - "src/**"
-      - "src/api/**"
-      - "src/server/**"
-      - "**/Cargo.toml"
-      - "**/Cargo.lock"
-      - ".github/workflows/masterTests.yml"
 
 jobs:
   test:

Cargo.lock

@@ -9,7 +9,7 @@ members = [".", "server", "api"]
 
 [dependencies]
 # cli parsing
-clap = { version = "4.0.7", features = ["derive", "env"] }
+clap = { version = "4.0.8", features = ["derive", "env"] }
 # ftp lib
 libunftp = "0.18.5"
 # own implementations

Cargo.toml

@@ -3,7 +3,9 @@
 
 A small rust service faking a FTP-server by forwarding the requests to the FileFighter Backend (FileSystemService)
 
-[[https://drone.filefighter.de/api/badges/FileFighter/FTP-Service/status.svg]]
+[[https://github.com/FileFighter/FTP-Service/actions/workflows/masterTests.yml/badge.svg]]
+[[https://github.com/FileFighter/FTP-Service/actions/workflows/stableRelease.yml/badge.svg]]
+[[https://github.com/FileFighter/FTP-Service/actions/workflows/latestRelease.yml/badge.svg]]
 
 * Run in Docker with local fss and fhs
 #+begin_src shell

README.org

@@ -5,7 +5,7 @@ edition = "2021"
 authors = ["open-schnick <[email protected]>", "qvalentin <[email protected]>"]
 
 [dependencies]
-async-trait = "0.1.56"
+async-trait = "0.1.57"
 libunftp = "0.18.5"
 tokio = "1.21.1"
 tracing = "0.1.36"

server/Cargo.toml

@@ -1,21 +1,25 @@
-use super::{metadata::InodeMetaData, utils::validate_and_normalize_path};
+use super::{
+    metadata::InodeMetaData,
+    utils::{
+        get_parent_and_name, path_contains_rclone_modification_date, transform_to_ftp_error,
+        validate_and_normalize_path,
+    },
+};
 use crate::auth::user::FileFighterUser;
 use async_trait::async_trait;
-use chrono::NaiveDateTime;
 use filefighter_api::ffs_api::{
     endpoints::{
         create_directory, delete_inode, download_file, get_contents_of_folder, get_inode,
         move_inode, rename_inode, set_last_modified_of_inode, upload_file,
     },
     ApiConfig,
-    ApiError::{self, ReqwestError, ResponseMalformed},
 };
 use libunftp::storage::{
     Error, ErrorKind, Fileinfo, Metadata, Result, StorageBackend, FEATURE_RESTART,
 };
 use std::{
     fmt::Debug,
-    path::{Component, Path, PathBuf},
+    path::{Path, PathBuf},
 };
 use tokio::io::AsyncRead;
 use tracing::{debug, error, instrument, warn};
@@ -258,110 +262,3 @@ impl StorageBackend<FileFighterUser> for FileFighter {
         }
     }
 }
-
-fn get_parent_and_name(path: &Path) -> Result<(PathBuf, &str)> {
-    match (path.parent(), path.file_name()) {
-        (Some(parent), Some(name)) => Ok((
-            parent.to_path_buf(),
-            name.to_str()
-                .ok_or_else(|| Error::new(ErrorKind::LocalError, "Filename was not valid utf-8"))?,
-        )),
-        (_, _) => Err(Error::new(
-            ErrorKind::FileNameNotAllowedError,
-            "Path for creating a directory must contain a parent and child component",
-        )),
-    }
-}
-
-fn transform_to_ftp_error(error: ApiError) -> Error {
-    match error {
-        ReqwestError(err) => {
-            warn!("Cought reqwest error {}", err);
-            Error::new(ErrorKind::LocalError, "Internal Server Error")
-        }
-        ResponseMalformed(err) => {
-            warn!("Filesystemservice error response: {}", err);
-            Error::new(ErrorKind::PermanentDirectoryNotAvailable, err)
-        }
-    }
-}
-
-// IDEA: check if rclone does try to update the root folder
-fn path_contains_rclone_modification_date(path: &Path) -> Option<(NaiveDateTime, PathBuf)> {
-    let mut components: Vec<Component> = path.components().collect();
-
-    // needs to be at least / and date<whitespace>
-    if components.len() < 2 {
-        return None;
-    }
-
-    // does exist
-    let mut timestamp_component = components[1].as_os_str().to_str()?.to_owned();
-
-    #[allow(clippy::unwrap_used)]
-    // if root path does not end with whitespace
-    if timestamp_component.is_empty() || timestamp_component.pop().unwrap() != ' ' {
-        return None;
-    }
-
-    // the rest of the root folder needs to be in this format
-    // yyyymmddhhmmss
-    let parsed_time = NaiveDateTime::parse_from_str(&timestamp_component, "%Y%m%d%H%M%S").ok()?;
-
-    // remove the timestamp component
-    components.remove(1);
-
-    Some((parsed_time, components.iter().collect()))
-}
-
-#[cfg(test)]
-mod tests {
-    use super::path_contains_rclone_modification_date;
-    use chrono::NaiveDateTime;
-    use std::{path::PathBuf, str::FromStr};
-
-    #[test]
-    fn timestamp_parsing_works() {
-        let result = NaiveDateTime::parse_from_str("20221003093709", "%Y%m%d%H%M%S").unwrap();
-        let resulting_string = result.to_string();
-        assert_eq!("2022-10-03 09:37:09", resulting_string)
-    }
-
-    #[test]
-    fn path_contains_rclone_modification_date_works() {
-        let path = PathBuf::from_str("/20221003093709 /Home/School").unwrap();
-        let option = path_contains_rclone_modification_date(&path);
-
-        match option {
-            Some(result) => {
-                assert_eq!(
-                    NaiveDateTime::parse_from_str("20221003093709", "%Y%m%d%H%M%S").unwrap(),
-                    result.0
-                );
-                assert_eq!(PathBuf::from_str("/Home/School").unwrap(), result.1);
-            }
-            None => panic!("Expected some value here."),
-        }
-    }
-
-    #[test]
-    fn path_contains_rclone_modification_date_fails_without_whitespace() {
-        let path = PathBuf::from_str("/20221003093709/Home/School").unwrap();
-        let option = path_contains_rclone_modification_date(&path);
-        assert!(option.is_none())
-    }
-
-    #[test]
-    fn path_contains_rclone_modification_date_fails_with_wrong_timestamp_format() {
-        let path = PathBuf::from_str("/202210030937 /Home/School").unwrap();
-        let option = path_contains_rclone_modification_date(&path);
-        assert!(option.is_none())
-    }
-
-    #[test]
-    fn path_contains_rclone_modification_date_fails_with_wrong_timestamp() {
-        let path = PathBuf::from_str("/20221003093790 /Home/School").unwrap();
-        let option = path_contains_rclone_modification_date(&path);
-        assert!(option.is_none())
-    }
-}

server/src/backend/storage_backend.rs

@@ -1,6 +1,68 @@
-use libunftp::storage::{Error, ErrorKind::FileNameNotAllowedError, Result};
+use chrono::NaiveDateTime;
+use filefighter_api::ffs_api::ApiError::{self, ReqwestError, ResponseMalformed};
+use libunftp::storage::{
+    Error,
+    ErrorKind::{self, FileNameNotAllowedError},
+    Result,
+};
 use std::path::{Component, Path, PathBuf};
-use tracing::debug;
+use tracing::{debug, warn};
+
+pub fn get_parent_and_name(path: &Path) -> Result<(PathBuf, &str)> {
+    match (path.parent(), path.file_name()) {
+        (Some(parent), Some(name)) => Ok((
+            parent.to_path_buf(),
+            name.to_str()
+                .ok_or_else(|| Error::new(ErrorKind::LocalError, "Filename was not valid utf-8"))?,
+        )),
+        (_, _) => Err(Error::new(
+            ErrorKind::FileNameNotAllowedError,
+            "Path for creating a directory must contain a parent and child component",
+        )),
+    }
+}
+
+pub fn transform_to_ftp_error(error: ApiError) -> Error {
+    match error {
+        ReqwestError(err) => {
+            warn!("Cought reqwest error {}", err);
+            Error::new(ErrorKind::LocalError, "Internal Server Error")
+        }
+        ResponseMalformed(err) => {
+            warn!("Filesystemservice error response: {}", err);
+            Error::new(ErrorKind::PermanentDirectoryNotAvailable, err)
+        }
+    }
+}
+
+// IDEA: check if rclone does try to update the root folder
+pub fn path_contains_rclone_modification_date(path: &Path) -> Option<(NaiveDateTime, PathBuf)> {
+    let mut components: Vec<Component> = path.components().collect();
+
+    // needs to be at least / and date<whitespace>
+    if components.len() < 2 {
+        return None;
+    }
+
+    // does exist
+    #[allow(clippy::unwrap_used)]
+    let mut timestamp_component = components.get(1).unwrap().as_os_str().to_str()?.to_owned();
+
+    #[allow(clippy::unwrap_used)]
+    // if root path does not end with whitespace
+    if timestamp_component.is_empty() || timestamp_component.pop().unwrap() != ' ' {
+        return None;
+    }
+
+    // the rest of the root folder needs to be in this format
+    // yyyymmddhhmmss
+    let parsed_time = NaiveDateTime::parse_from_str(&timestamp_component, "%Y%m%d%H%M%S").ok()?;
+
+    // remove the timestamp component
+    components.remove(1);
+
+    Some((parsed_time, components.iter().collect()))
+}
 
 /// Normalizing (without disk access) and validating Path
 ///