Logging (#92)

* foo-bindings should not be dependent on the library

* add tracing logging to the various build phases!

* tweaks to logging

Author: jadamcrain

Cargo.lock

@@ -11,3 +11,4 @@ dotnet-oo-bindgen = { path = "../generators/dotnet-oo-bindgen" }
 java-oo-bindgen = { path = "../generators/java-oo-bindgen" }
 clap = "3.2.17"
 pathdiff = "0.2"
+tracing = "^0.1"

ci-script/Cargo.toml

@@ -127,13 +127,33 @@ trait BindingBuilder {
 
     /// run the builder
     fn run(&mut self, run_tests: bool, package: bool, generate_doxygen: bool) {
-        self.generate(package, generate_doxygen);
+        let span = tracing::info_span!("generate()", lang = Self::name());
+        span.in_scope(|| {
+            tracing::info!("begin");
+            self.generate(package, generate_doxygen);
+            tracing::info!("end");
+        });
 
         if package {
-            self.package();
+            let span = tracing::info_span!("package()", lang = Self::name());
+            span.in_scope(|| {
+                tracing::info!("begin");
+                self.package();
+                tracing::info!("end");
+            });
         } else if run_tests {
-            self.build();
-            self.test();
+            let span = tracing::info_span!("build()", lang = Self::name());
+            span.in_scope(|| {
+                tracing::info!("begin");
+                self.build();
+                tracing::info!("end");
+            });
+            let span = tracing::info_span!("test()", lang = Self::name());
+            span.in_scope(|| {
+                tracing::info!("begin");
+                self.test();
+                tracing::info!("end");
+            });
         }
     }
 }

ci-script/src/lib.rs

@@ -5,4 +5,5 @@ authors = ["Émile Grégoire <[email protected]>"]
 edition = "2021"
 
 [dependencies]
+tracing = "^0.1"
 oo-bindgen = { path = "../../oo-bindgen" }

generators/c-oo-bindgen/Cargo.toml

@@ -15,7 +15,7 @@ use crate::formatting::print_license;
 
 pub(crate) fn generate_header(lib: &Library, path: &Path) -> FormattingResult<()> {
     // Open the file
-    std::fs::create_dir_all(&path)?;
+    logged::create_dir_all(&path)?;
     let filename = path.join(format!("{}.hpp", lib.settings.name));
     let mut f = FilePrinter::new(filename)?;
 

generators/c-oo-bindgen/src/cpp/header.rs

@@ -9,7 +9,7 @@ use crate::ctype::CType;
 
 pub(crate) fn generate_cpp_file(lib: &Library, path: &Path) -> FormattingResult<()> {
     // Open the file
-    std::fs::create_dir_all(&path)?;
+    logged::create_dir_all(&path)?;
     let filename = path.join(format!("{}.cpp", lib.settings.name));
     let mut f = FilePrinter::new(filename)?;
 

generators/c-oo-bindgen/src/cpp/implementation.rs

@@ -11,7 +11,7 @@ pub(crate) fn generate_c_header(lib: &Library, path: &Path) -> FormattingResult<
     let uppercase_name = lib.settings.c_ffi_prefix.to_uppercase();
 
     // Open file
-    std::fs::create_dir_all(&path)?;
+    logged::create_dir_all(&path)?;
     let filename = path.join(format!("{}.h", lib.settings.name));
     let mut f = FilePrinter::new(filename)?;
 

generators/c-oo-bindgen/src/header.rs

@@ -89,13 +89,13 @@ pub fn generate_c_package(lib: &Library, config: &CBindgenConfig) -> FormattingR
     let lib_path = output_dir
         .join("lib")
         .join(config.platform_location.platform.target_triple);
-    fs::create_dir_all(&lib_path)?;
+    logged::create_dir_all(&lib_path)?;
 
     let lib_filename = config
         .platform_location
         .platform
         .static_lib_filename(&config.ffi_name);
-    fs::copy(
+    logged::copy(
         config.platform_location.location.join(&lib_filename),
         lib_path.join(&lib_filename),
     )?;
@@ -104,7 +104,7 @@ pub fn generate_c_package(lib: &Library, config: &CBindgenConfig) -> FormattingR
         .platform_location
         .platform
         .dyn_lib_filename(&config.ffi_name);
-    fs::copy(
+    logged::copy(
         config.platform_location.location.join(&lib_filename),
         lib_path.join(&lib_filename),
     )?;
@@ -114,7 +114,7 @@ pub fn generate_c_package(lib: &Library, config: &CBindgenConfig) -> FormattingR
         .platform_location
         .platform
         .bin_filename(&config.ffi_name);
-    fs::copy(
+    logged::copy(
         config.platform_location.location.join(&bin_filename),
         lib_path.join(&bin_filename),
     )?;
@@ -125,7 +125,7 @@ pub fn generate_c_package(lib: &Library, config: &CBindgenConfig) -> FormattingR
         output_dir.join(lib.info.license_path.file_name().unwrap()),
     )?;
     for path in &config.extra_files {
-        fs::copy(path, output_dir.join(path.file_name().unwrap()))?;
+        logged::copy(path, output_dir.join(path.file_name().unwrap()))?;
     }
 
     // Generate doxygen (if asked)
@@ -236,7 +236,7 @@ fn generate_cmake_config(
         .output_dir
         .join(platform_location.platform.target_triple)
         .join("cmake");
-    fs::create_dir_all(&cmake_path)?;
+    logged::create_dir_all(&cmake_path)?;
     let filename = cmake_path.join(format!("{}-config.cmake", lib.settings.name));
     let mut f = FilePrinter::new(filename)?;
 

generators/c-oo-bindgen/src/lib.rs

@@ -11,4 +11,5 @@ regex = "1.3"
 lazy_static = "1.4"
 backtrace = "0.3"
 heck = "0.3"
-platforms = "2.0"
+platforms = "2.0"
+tracing = "^0.1"

oo-bindgen/Cargo.toml

@@ -21,6 +21,7 @@ pub struct FilePrinter {
 
 impl FilePrinter {
     pub fn new<T: AsRef<Path>>(filepath: T) -> FormattingResult<Self> {
+        tracing::info!("Create file: {}", filepath.as_ref().display());
         let file = File::create(filepath)?;
         let writer = BufWriter::new(file);
         Ok(Self {