build: improve logging in build_addons

Author: miguelmarcondesf

test/addons/.gitignore

@@ -6,3 +6,4 @@ Makefile
 gyp-mac-tool
 /*/build
 /esm/node_modules/*/build
+/*/logs

test/js-native-api/.gitignore

@@ -5,3 +5,4 @@ Makefile
 *.mk
 gyp-mac-tool
 /*/build
+/*/logs

test/js-native-api/test_warning/binding.cc

@@ -1,7 +1,6 @@
 #include <node_api.h>
 
-static napi_value Method(const napi_env env,
-       const napi_callback_info info) {
+static napi_value Method(const napi_env env, const napi_callback_info info) {
   napi_value result;
   napi_create_string_utf8(env, "world", NAPI_AUTO_LENGTH, &result);
   return result;

test/js-native-api/test_warning/binding2.cc

@@ -1,7 +1,6 @@
 #include <node_api.h>
 
-static napi_value Method(const napi_env env,
-       const napi_callback_info info) {
+static napi_value Method(const napi_env env, const napi_callback_info info) {
   napi_value result;
   napi_create_string_utf8(env, "world", NAPI_AUTO_LENGTH, &result);
   return result;

test/js-native-api/test_warning/build_logs/build_clang.log

@@ -14,21 +14,12 @@ assert.strictEqual(binding2.hello(), 'world');
 {
   const warningMessage = '#warning "NAPI_EXPERIMENTAL is enabled. Experimental features may be unstable."';
 
-  const gccLogFilePath = path.resolve(__dirname, './build_logs/build_gcc.log');
-  const gccLogContent = fs.readFileSync(gccLogFilePath, 'utf8');
+  const logFilePath = path.resolve(__dirname, './logs/build.log');
+  const logContent = fs.readFileSync(logFilePath, 'utf8');
 
-  const gccWarningCount = gccLogContent.split(warningMessage).length - 1;
-  const gccHasWarning = gccLogContent.includes(warningMessage);
+  const warningCount = logContent.split(warningMessage).length - 1;
+  const hasWarning = logContent.includes(warningMessage);
 
-  assert.strictEqual(gccHasWarning, true, `Expected warning not found: "${warningMessage}"`);
-  assert.strictEqual(gccWarningCount, 1, `Expected warning to appear exactly once, but found ${gccWarningCount} occurrences.`);
-
-  const clangLogFilePath = path.resolve(__dirname, './build_logs/build_clang.log');
-  const clangLogContent = fs.readFileSync(clangLogFilePath, 'utf8');
-
-  const clangWarningCount = clangLogContent.split(warningMessage).length - 1;
-  const clangHasWarning = clangLogContent.includes(warningMessage);
-
-  assert.strictEqual(clangHasWarning, true, `Expected warning not found: "${warningMessage}"`);
-  assert.strictEqual(clangWarningCount, 1, `Expected warning to appear exactly once, but found ${gccWarningCount} occurrences.`);
+  assert.strictEqual(hasWarning, true, `Expected warning not found: "${warningMessage}"`);
+  assert.strictEqual(warningCount, 1, `Expected warning to appear exactly once, but found ${warningCount} occurrences.`);
 }

test/js-native-api/test_warning/build_logs/build_gcc.log

@@ -1 +1,2 @@
 build
+/*/logs

test/js-native-api/test_warning/test.js

@@ -1 +1,2 @@
 build
+/*/logs

test/node-api/.gitignore

@@ -47,25 +47,33 @@ def node_gyp_rebuild(test_dir):
     print('Building addon in', test_dir)
     try:
       process = subprocess.Popen([
-          node_bin,
-          node_gyp,
-          'rebuild',
-          '--directory', test_dir,
-          '--nodedir', headers_dir,
-          '--python', sys.executable,
-          '--loglevel', args.loglevel,
-      ], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+            node_bin,
+            node_gyp,
+            'rebuild',
+            '--directory', test_dir,
+            '--nodedir', headers_dir,
+            '--python', sys.executable,
+            '--loglevel', args.loglevel,
+        ], stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)
 
       # We buffer the output and print it out once the process is done in order
       # to avoid interleaved output from multiple builds running at once.
       return_code = process.wait()
       stdout, stderr = process.communicate()
       if return_code != 0:
-        print(f'Failed to build addon in {test_dir}:')
+        print(f'Failed to build addon in {test_dir}. Check build.log for details.')
+
+      build_dir = os.path.join(test_dir, 'logs')
+      os.makedirs(build_dir, exist_ok=True)
+      log_file_path = os.path.join(build_dir, 'build.log')
+      with open(log_file_path, 'w') as log_file:
         if stdout:
-          print(stdout.decode())
+          print(stdout)
+          log_file.write(stdout)
         if stderr:
-          print(stderr.decode())
+          print(stderr)
+          log_file.write(stderr)
+
       return return_code
 
     except Exception as e: