feat: add base logger (#73)

* feat: add base logger

* test: update according to new logs

* test: change assertion

* test: add test for error with CLI

* feat: prefix warn and err message with labels

* revert: add level into warn and err logger

* feat: add log level with %l

* feat: add patch for lief log level

* chore: remove log level stuff after generating the patch file

* feat: add log level in cpp code via vendorpull

---------

Co-authored-by: Tony Gorez <[email protected]>

Author: tony-go

patches/lief/0001-feat-add-log-level-with-l.patch

@@ -0,0 +1,25 @@
+From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
+From: Tony Gorez <[email protected]>
+Date: Thu, 2 Mar 2023 09:53:36 +0100
+Subject: [PATCH] feat: add log level with %l
+
+---
+ src/logging.cpp | 2 +-
+ 1 file changed, 1 insertion(+), 1 deletion(-)
+
+diff --git a/src/logging.cpp b/src/logging.cpp
+index 63e0e0e..3a4e567 100644
+--- a/src/logging.cpp
++++ b/src/logging.cpp
+@@ -52,7 +52,7 @@ Logger::Logger() {
+ 
+ 
+     sink_->set_level(spdlog::level::warn);
+-    sink_->set_pattern("%v");
++    sink_->set_pattern("%l: %v");
+     sink_->flush_on(spdlog::level::warn);
+   }
+ }
+-- 
+2.37.1 (Apple Git-137.1)
+

src/cli.js

@@ -5,6 +5,12 @@ const { constants, promises: fs } = require("fs");
 const path = require("path");
 const { inject } = require("./api.js");
 
+const logger = {
+  info: (message) => console.log("\x1b[36m%s\x1b[0m", message),
+  success: (message) => console.log("\x1b[32m%s\x1b[0m", message),
+  error: (message) => console.log("\x1b[31mError: %s\x1b[0m", message),
+};
+
 async function main(filename, resourceName, resource, options) {
   if (options.outputApiHeader) {
     // Handles --output-api-header.
@@ -20,18 +26,22 @@ async function main(filename, resourceName, resource, options) {
     await fs.access(resource, constants.R_OK);
     resourceData = await fs.readFile(resource);
   } catch {
-    console.log("Can't read resource file");
+    logger.error("Can't read resource file");
     process.exit(1);
   }
 
   try {
+    logger.info(
+      "Start injection of " + resourceName + " in " + filename + "..."
+    );
     await inject(filename, resourceName, resourceData, {
       machoSegmentName: options.machoSegmentName,
       overwrite: options.overwrite,
       sentinelFuse: options.sentinelFuse,
     });
+    logger.success("💉 Injection done!");
   } catch (err) {
-    console.log(err.message);
+    logger.error(err.message);
     process.exit(1);
   }
 }

test/cli.mjs

@@ -85,9 +85,8 @@ describe("postject CLI", () => {
         ],
         { encoding: "utf-8" }
       );
-      // TODO(dsanders11) - Enable this once we squelch LIEF warnings
-      // expect(stderr).to.be.empty;
-      expect(stdout).to.be.empty;
+      expect(stderr).to.be.empty;
+      expect(stdout).to.have.string("Injection done!");
       expect(status).to.equal(0);
     }
 
@@ -116,6 +115,26 @@ describe("postject CLI", () => {
       expect(stdout).to.have.string(resourceContents);
     }
   }).timeout(3_00_000);
+
+  it("should display an error message when filename doesn't exist", async () => {
+    {
+      const { status, stdout, stderr } = spawnSync(
+        "node",
+        [
+          "./dist/cli.js",
+          "unknown-filename",
+          "foobar",
+          resourceFilename,
+          "--sentinel-fuse",
+          "NODE_JS_FUSE_fce680ab2cc467b6e072b8b5df1996b2",
+        ],
+        { encoding: "utf-8" }
+      );
+      expect(stdout).to.have.string("Error: Can't read and write to target executable");
+      expect(stdout).to.not.have.string("Injection done!");
+      expect(status).to.equal(1);
+    }
+  }).timeout(3_00_000);
 });
 
 describe("postject API", () => {

vendor/lief/src/logging.cpp

@@ -52,7 +52,7 @@ Logger::Logger() {
 
 
     sink_->set_level(spdlog::level::warn);
-    sink_->set_pattern("%v");
+    sink_->set_pattern("%l: %v");
     sink_->flush_on(spdlog::level::warn);
   }
 }