Use env OUT_DIR as the temporary directory for benches and tests

Author: SpriteOvO

spdlog/benches/common/mod.rs

@@ -1,14 +1,15 @@
-use std::{env, fs, path::PathBuf};
+use std::{
+    env, fs,
+    path::{Path, PathBuf},
+};
 
 use once_cell::sync::Lazy;
 
 pub static BENCH_LOGS_PATH: Lazy<PathBuf> = Lazy::new(|| {
-    let path = env::current_exe()
-        .unwrap()
-        .parent()
-        .unwrap()
-        .join("dev/bench_logs");
-    fs::create_dir_all(&path).unwrap();
+    let path = Path::new(env!("OUT_DIR")).join("bench_logs");
+    if !path.exists() {
+        fs::create_dir(&path).unwrap();
+    }
     path
 });
 

spdlog/benches/compare_with_cpp_spdlog.rs

@@ -4,10 +4,9 @@ extern crate test;
 
 mod common;
 
-use std::{env, fs, path::PathBuf, sync::Arc, thread, time::Instant};
+use std::{env, sync::Arc, thread, time::Instant};
 
 use clap::Parser;
-use once_cell::sync::Lazy;
 use spdlog::{
     formatter::{pattern, PatternFormatter},
     info,
@@ -22,12 +21,6 @@ include!(concat!(
 ));
 use test_utils::*;
 
-static LOGS_PATH: Lazy<PathBuf> = Lazy::new(|| {
-    let path = common::BENCH_LOGS_PATH.join("compare_with_cpp_spdlog");
-    fs::create_dir_all(&path).unwrap();
-    path
-});
-
 const FILE_SIZE: u64 = 30 * 1024 * 1024;
 // C++ "spdlog" is `5` here because it does not include the current file,
 // "spdlog-rs" does.
@@ -44,7 +37,7 @@ fn bench_threaded_logging(threads: usize, iters: usize) {
     let logger = build_test_logger(|b| {
         b.sink(Arc::new(
             FileSink::builder()
-                .path(LOGS_PATH.join("FileSink.log"))
+                .path(common::BENCH_LOGS_PATH.join("FileSink.log"))
                 .truncate(true)
                 .build()
                 .unwrap(),
@@ -56,7 +49,7 @@ fn bench_threaded_logging(threads: usize, iters: usize) {
     let logger = build_test_logger(|b| {
         b.sink(Arc::new(
             RotatingFileSink::builder()
-                .base_path(LOGS_PATH.join("RotatingFileSink_FileSize.log"))
+                .base_path(common::BENCH_LOGS_PATH.join("RotatingFileSink_FileSize.log"))
                 .rotation_policy(RotationPolicy::FileSize(FILE_SIZE))
                 .max_files(ROTATING_FILES)
                 .build()
@@ -69,7 +62,7 @@ fn bench_threaded_logging(threads: usize, iters: usize) {
     let logger = build_test_logger(|b| {
         b.sink(Arc::new(
             RotatingFileSink::builder()
-                .base_path(LOGS_PATH.join("RotatingFileSink_Daily.log"))
+                .base_path(common::BENCH_LOGS_PATH.join("RotatingFileSink_Daily.log"))
                 .rotation_policy(RotationPolicy::Daily { hour: 0, minute: 0 })
                 .build()
                 .unwrap(),

spdlog/benches/compare_with_cpp_spdlog_async.rs

@@ -4,10 +4,9 @@ extern crate test;
 
 mod common;
 
-use std::{cmp, env, fs, path::PathBuf, sync::Arc, thread, time::Instant};
+use std::{cmp, env, sync::Arc, thread, time::Instant};
 
 use clap::Parser;
-use once_cell::sync::Lazy;
 use spdlog::{
     error::{Error, SendToChannelError},
     formatter::{pattern, PatternFormatter},
@@ -19,12 +18,6 @@ use test::black_box;
 
 required_multi_thread_feature!();
 
-static LOGS_PATH: Lazy<PathBuf> = Lazy::new(|| {
-    let path = common::BENCH_LOGS_PATH.join("compare_with_cpp_spdlog_async");
-    fs::create_dir_all(&path).unwrap();
-    path
-});
-
 fn bench(
     policy: OverflowPolicy,
     file_name: &str,
@@ -43,7 +36,7 @@ fn bench(
 
         let file_sink = Arc::new(
             FileSink::builder()
-                .path(LOGS_PATH.join(file_name))
+                .path(common::BENCH_LOGS_PATH.join(file_name))
                 .truncate(true)
                 .build()
                 .unwrap(),

spdlog/benches/fern.rs

@@ -4,22 +4,13 @@ extern crate test;
 
 mod common;
 
-use std::{fs, path::PathBuf};
-
 use fern::Dispatch;
 use log::info;
-use once_cell::sync::Lazy;
 use test::Bencher;
 
-static LOGS_PATH: Lazy<PathBuf> = Lazy::new(|| {
-    let path = common::BENCH_LOGS_PATH.join("fern");
-    fs::create_dir_all(&path).unwrap();
-    path
-});
-
 #[bench]
 fn bench_1_file(bencher: &mut Bencher) {
-    let path = LOGS_PATH.join("file.log");
+    let path = common::BENCH_LOGS_PATH.join("file.log");
 
     Dispatch::new()
         .format(|out, message, record| {

spdlog/benches/flexi_logger.rs

@@ -4,7 +4,7 @@ extern crate test;
 
 mod common;
 
-use std::{fs, path::PathBuf, sync::Mutex};
+use std::sync::Mutex;
 
 use flexi_logger::{
     writers::FileLogWriter, Age, Cleanup, Criterion, DeferredNow, FileSpec, LogSpecification,
@@ -14,16 +14,10 @@ use log::{info, Record};
 use once_cell::sync::Lazy;
 use test::Bencher;
 
-static LOGS_PATH: Lazy<PathBuf> = Lazy::new(|| {
-    let path = common::BENCH_LOGS_PATH.join("flexi_logger");
-    fs::create_dir_all(&path).unwrap();
-    path
-});
-
 static HANDLE: Lazy<Mutex<LoggerHandle>> = Lazy::new(|| {
     Mutex::new(
         Logger::with(LogSpecification::off())
-            .log_to_file(FileSpec::try_from(LOGS_PATH.join("empty.log")).unwrap())
+            .log_to_file(FileSpec::try_from(common::BENCH_LOGS_PATH.join("empty.log")).unwrap())
             .write_mode(WriteMode::BufferDontFlush)
             .format(formatter)
             .start()
@@ -47,7 +41,7 @@ pub fn formatter(
 
 #[bench]
 fn bench_1_file(bencher: &mut Bencher) {
-    let path = LOGS_PATH.join("file.log");
+    let path = common::BENCH_LOGS_PATH.join("file.log");
 
     let writer_builder = FileLogWriter::builder(FileSpec::try_from(path).unwrap())
         .write_mode(WriteMode::BufferDontFlush)
@@ -64,7 +58,7 @@ unavailable_bench!(bench_2_file_async);
 
 #[bench]
 fn bench_3_rotating_file_size(bencher: &mut Bencher) {
-    let path = LOGS_PATH.join("rotating_file_size.log");
+    let path = common::BENCH_LOGS_PATH.join("rotating_file_size.log");
 
     let writer_builder = FileLogWriter::builder(FileSpec::try_from(path).unwrap())
         .write_mode(WriteMode::BufferDontFlush)
@@ -84,7 +78,7 @@ fn bench_3_rotating_file_size(bencher: &mut Bencher) {
 
 #[bench]
 fn bench_4_rotating_daily(bencher: &mut Bencher) {
-    let path = LOGS_PATH.join("rotating_daily.log");
+    let path = common::BENCH_LOGS_PATH.join("rotating_daily.log");
 
     let writer_builder = FileLogWriter::builder(FileSpec::try_from(path).unwrap())
         .write_mode(WriteMode::BufferDontFlush)

spdlog/benches/log4rs.rs

@@ -4,8 +4,6 @@ extern crate test;
 
 mod common;
 
-use std::{fs, path::PathBuf};
-
 use log::{info, LevelFilter};
 use log4rs::{
     append::{
@@ -24,12 +22,6 @@ use log4rs::{
 use once_cell::sync::Lazy;
 use test::Bencher;
 
-static LOGS_PATH: Lazy<PathBuf> = Lazy::new(|| {
-    let path = common::BENCH_LOGS_PATH.join("log4rs");
-    fs::create_dir_all(&path).unwrap();
-    path
-});
-
 static HANDLE: Lazy<Handle> = Lazy::new(|| {
     log4rs::init_config(
         Config::builder()
@@ -41,7 +33,7 @@ static HANDLE: Lazy<Handle> = Lazy::new(|| {
 
 #[bench]
 fn bench_1_file(bencher: &mut Bencher) {
-    let path = LOGS_PATH.join("file.log");
+    let path = common::BENCH_LOGS_PATH.join("file.log");
 
     let appender = FileAppender::builder()
         .append(false)
@@ -62,8 +54,8 @@ unavailable_bench!(bench_2_file_async);
 
 #[bench]
 fn bench_3_rotating_file_size(bencher: &mut Bencher) {
-    let pattern_path = LOGS_PATH.join("rotating_file_size_{}.log");
-    let path = LOGS_PATH.join("rotating_file_size.log");
+    let pattern_path = common::BENCH_LOGS_PATH.join("rotating_file_size_{}.log");
+    let path = common::BENCH_LOGS_PATH.join("rotating_file_size.log");
 
     let policy = CompoundPolicy::new(
         Box::new(SizeTrigger::new(common::FILE_SIZE)),

spdlog/benches/slog.rs

@@ -4,24 +4,15 @@ extern crate test;
 
 mod common;
 
-use std::{fs, path::PathBuf};
-
-use once_cell::sync::Lazy;
 use slog::{info, o, Fuse, Logger};
 use sloggers::{file::FileLoggerBuilder, types::SourceLocation, Build};
 use test::Bencher;
 
-static LOGS_PATH: Lazy<PathBuf> = Lazy::new(|| {
-    let path = common::BENCH_LOGS_PATH.join("slog");
-    fs::create_dir_all(&path).unwrap();
-    path
-});
-
 unavailable_bench!(bench_1_file);
 
 #[bench]
 fn bench_2_file_async(bencher: &mut Bencher) {
-    let path = LOGS_PATH.join("file_async.log");
+    let path = common::BENCH_LOGS_PATH.join("file_async.log");
 
     let drain = Fuse(
         FileLoggerBuilder::new(path)
@@ -37,7 +28,7 @@ fn bench_2_file_async(bencher: &mut Bencher) {
 
 #[bench]
 fn bench_3_rotating_file_size_async(bencher: &mut Bencher) {
-    let path = LOGS_PATH.join("rotating_file_size_async.log");
+    let path = common::BENCH_LOGS_PATH.join("rotating_file_size_async.log");
 
     let drain = Fuse(
         FileLoggerBuilder::new(path)

spdlog/benches/spdlog_rs.rs

@@ -4,9 +4,8 @@ extern crate test;
 
 mod common;
 
-use std::{fs, path::PathBuf, sync::Arc};
+use std::{path::PathBuf, sync::Arc};
 
-use once_cell::sync::Lazy;
 use spdlog::{
     error::{Error, ErrorHandler, SendToChannelError},
     prelude::*,
@@ -23,12 +22,6 @@ use test_utils::*;
 
 required_multi_thread_feature!();
 
-static LOGS_PATH: Lazy<PathBuf> = Lazy::new(|| {
-    let path = common::BENCH_LOGS_PATH.join("spdlog_rs");
-    fs::create_dir_all(&path).unwrap();
-    path
-});
-
 enum Mode {
     Sync,
     Async,
@@ -40,7 +33,7 @@ impl Mode {
             Self::Sync => format!("{file_name}.log"),
             Self::Async => format!("{file_name}_async.log"),
         };
-        LOGS_PATH.join(file_name)
+        common::BENCH_LOGS_PATH.join(file_name)
     }
 
     fn final_sink(&self, sink: Arc<dyn Sink>) -> Arc<dyn Sink> {

spdlog/benches/tracing.rs

@@ -4,19 +4,10 @@ extern crate test;
 
 mod common;
 
-use std::{fs, path::PathBuf};
-
-use once_cell::sync::Lazy;
 use test::Bencher;
 use tracing::info;
 use tracing_subscriber::{filter::LevelFilter, fmt::MakeWriter};
 
-static LOGS_PATH: Lazy<PathBuf> = Lazy::new(|| {
-    let path = common::BENCH_LOGS_PATH.join("tracing");
-    fs::create_dir_all(&path).unwrap();
-    path
-});
-
 fn bench_any(
     bencher: &mut Bencher,
     writer: impl for<'writer> MakeWriter<'writer> + 'static + Send + Sync,
@@ -36,13 +27,14 @@ fn bench_any(
 fn bench_1_file(bencher: &mut Bencher) {
     bench_any(
         bencher,
-        tracing_appender::rolling::never(&*LOGS_PATH, "file.log"),
+        tracing_appender::rolling::never(&*common::BENCH_LOGS_PATH, "file.log"),
     );
 }
 
 #[bench]
 fn bench_2_file_async(bencher: &mut Bencher) {
-    let file_appender = tracing_appender::rolling::never(&*LOGS_PATH, "file_async.log");
+    let file_appender =
+        tracing_appender::rolling::never(&*common::BENCH_LOGS_PATH, "file_async.log");
     let (non_blocking, _guard) = tracing_appender::non_blocking(file_appender);
 
     bench_any(bencher, non_blocking);
@@ -54,7 +46,7 @@ unavailable_bench!(bench_3_rotating_file_size);
 fn bench_4_rotating_daily(bencher: &mut Bencher) {
     bench_any(
         bencher,
-        tracing_appender::rolling::daily(&*LOGS_PATH, "rotating_daily.log"),
+        tracing_appender::rolling::daily(&*common::BENCH_LOGS_PATH, "rotating_daily.log"),
     );
 }
 

spdlog/src/sink/rotating_file_sink.rs

@@ -871,7 +871,7 @@ mod tests {
 
     static BASE_LOGS_PATH: Lazy<PathBuf> = Lazy::new(|| {
         let path = TEST_LOGS_PATH.join("rotating_file_sink");
-        fs::create_dir_all(&path).unwrap();
+        fs::create_dir(&path).unwrap();
         path
     });