Issue 29: Consistent number of arguments across OSes

- take `Option<OpenOptions>` in `FileRotate::new`

Author: Ploppz

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "file-rotate"
-version = "0.7.6"
+version = "0.8.0"
 authors = ["Kevin Robert Stravers <kevin@stravers.net>", "Erlend Langseth <3rlendhl@gmail.com>"]
 edition = "2018"
 description = "Log rotation for files"

src/lib.rs

@@ -29,7 +29,6 @@
 //!     AppendCount::new(2),
 //!     ContentLimit::Lines(3),
 //!     Compression::None,
-//!     #[cfg(unix)]
 //!     None,
 //! );
 //!
@@ -62,7 +61,6 @@
 //!     AppendCount::new(2),
 //!     ContentLimit::Bytes(5),
 //!     Compression::None,
-//!     #[cfg(unix)]
 //!     None,
 //! );
 //!
@@ -99,7 +97,6 @@
 //!     AppendCount::new(3),
 //!     ContentLimit::Bytes(1),
 //!     Compression::None,
-//!     #[cfg(unix)]
 //!     None,
 //! );
 //!
@@ -158,7 +155,6 @@
 //!     AppendTimestamp::default(FileLimit::MaxFiles(2)),
 //!     ContentLimit::Bytes(1),
 //!     Compression::None,
-//!     #[cfg(unix)]
 //!     None,
 //! );
 //!
@@ -204,7 +200,6 @@
 //!     AppendTimestamp::default(FileLimit::MaxFiles(4)),
 //!     ContentLimit::Bytes(1),
 //!     Compression::OnRotate(2),
-//!     #[cfg(unix)]
 //!     None,
 //! );
 //!
@@ -303,9 +298,6 @@ use std::{
 };
 use suffix::*;
 
-#[cfg(unix)]
-use std::os::unix::fs::OpenOptionsExt;
-
 pub mod compression;
 pub mod suffix;
 #[cfg(test)]
@@ -392,8 +384,7 @@ pub struct FileRotate<S: SuffixScheme> {
     suffix_scheme: S,
     /// The bool is whether or not there's a .gz suffix to the filename
     suffixes: BTreeSet<SuffixInfo<S::Repr>>,
-    #[cfg(unix)]
-    mode: Option<u32>,
+    open_options: Option<OpenOptions>,
 }
 
 impl<S: SuffixScheme> FileRotate<S> {
@@ -404,6 +395,8 @@ impl<S: SuffixScheme> FileRotate<S> {
     ///
     /// `content_limit` specifies the limits for rotating a file.
     ///
+    /// `open_options`: If provided, you must set `.read(true).create(true).append(true)`!
+    ///
     /// # Panics
     ///
     /// Panics if `bytes == 0` or `lines == 0`.
@@ -412,7 +405,7 @@ impl<S: SuffixScheme> FileRotate<S> {
         suffix_scheme: S,
         content_limit: ContentLimit,
         compression: Compression,
-        #[cfg(unix)] mode: Option<u32>,
+        open_options: Option<OpenOptions>,
     ) -> Self {
         match content_limit {
             ContentLimit::Bytes(bytes) => {
@@ -440,8 +433,7 @@ impl<S: SuffixScheme> FileRotate<S> {
             compression,
             suffixes: BTreeSet::new(),
             suffix_scheme,
-            #[cfg(unix)]
-            mode,
+            open_options,
         };
         s.ensure_log_directory_exists();
         s.scan_suffixes();
@@ -484,14 +476,11 @@ impl<S: SuffixScheme> FileRotate<S> {
     }
 
     fn open_file(&mut self) {
-        let mut open_options = OpenOptions::new();
-
-        open_options.read(true).create(true).append(true);
-
-        #[cfg(unix)]
-        if let Some(mode) = self.mode {
-            open_options.mode(mode);
-        }
+        let open_options = self.open_options.clone().unwrap_or_else(|| {
+            let mut o = OpenOptions::new();
+            o.read(true).create(true).append(true);
+            o
+        });
 
         self.file = open_options.open(&self.basepath).ok();
     }
@@ -772,10 +761,12 @@ pub mod mock_time {
         static MOCK_TIME: RefCell<Option<DateTime<Local>>> = RefCell::new(None);
     }
 
+    /// Get current _mocked_ time
     pub fn now() -> DateTime<Local> {
         MOCK_TIME.with(|cell| cell.borrow().as_ref().cloned().unwrap_or_else(Local::now))
     }
 
+    /// Set mocked time
     pub fn set_mock_time(time: DateTime<Local>) {
         MOCK_TIME.with(|cell| *cell.borrow_mut() = Some(time));
     }

src/tests.rs

@@ -65,7 +65,6 @@ fn timestamp_max_files_rotation() {
     assert_eq!("m\n", fs::read_to_string(&log_path).unwrap());
 }
 #[test]
-#[cfg(feature = "chrono04")]
 fn timestamp_max_age_deletion() {
     // In order not to have to sleep, and keep it deterministic, let's already create the log files and see how FileRotate
     // cleans up the old ones.
@@ -74,9 +73,7 @@ fn timestamp_max_age_deletion() {
     let log_path = dir.join("log");
 
     // One recent file:
-    let recent_file = chrono::offset::Local::now()
-        .format("log.%Y%m%dT%H%M%S")
-        .to_string();
+    let recent_file = Local::now().format("log.%Y%m%dT%H%M%S").to_string();
     File::create(dir.join(&recent_file)).unwrap();
     // Two very old files:
     File::create(dir.join("log.20200825T151133")).unwrap();
@@ -339,19 +336,27 @@ fn line_count_recalculation() {
 #[cfg(unix)]
 #[test]
 fn unix_file_permissions() {
+    use std::os::unix::fs::OpenOptionsExt;
     let permissions = &[0o600, 0o644];
 
     for permission in permissions {
         let tmp_dir = TempDir::new().unwrap();
         let parent = tmp_dir.path();
         let log_path = parent.join("log");
 
+        let mut options = OpenOptions::new();
+        options
+            .read(true)
+            .create(true)
+            .append(true)
+            .mode(*permission);
+
         let mut file_rotate = FileRotate::new(
             &*log_path.to_string_lossy(),
             AppendCount::new(3),
             ContentLimit::Lines(2),
             Compression::None,
-            Some(*permission),
+            Some(options),
         );
 
         // Trigger a rotation by writing three lines