test: use fixture directories for sea tests

Instead of copying and writing files on the fly for SEA tests,
put the fixtures into a directory and copy them into tmpdir
for testing. This allows easier reproduction and debugging
when they do fail - we can just copy the entire fixture directory
and test directly from there.

PR-URL: #61167
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>

test/common/sea.js

@@ -4,6 +4,9 @@ const common = require('../common');
 const fixtures = require('../common/fixtures');
 const tmpdir = require('../common/tmpdir');
 const { inspect } = require('util');
+const fs = require('fs');
+const path = require('path');
+const assert = require('assert');
 
 const { readFileSync, copyFileSync, statSync } = require('fs');
 const {
@@ -70,37 +73,76 @@ function skipIfSingleExecutableIsNotSupported() {
   }
 }
 
-function generateSEA(targetExecutable, sourceExecutable, seaBlob, verifyWorkflow = false) {
+function generateSEA(fixtureDir, options = {}) {
+  const {
+    workingDir = tmpdir.path,
+    configPath = 'sea-config.json',
+    verifyWorkflow = false,
+  } = options;
+  // Copy fixture files to working directory if they are different.
+  if (fixtureDir !== workingDir) {
+    fs.cpSync(fixtureDir, workingDir, { recursive: true });
+  }
+
+  // Determine the output executable path.
+  const outputFile = path.resolve(workingDir, process.platform === 'win32' ? 'sea.exe' : 'sea');
+
   try {
-    copyFileSync(sourceExecutable, targetExecutable);
+    // Copy the executable.
+    copyFileSync(process.execPath, outputFile);
+    console.log(`Copied ${process.execPath} to ${outputFile}`);
   } catch (e) {
-    const message = `Cannot copy ${sourceExecutable} to ${targetExecutable}: ${inspect(e)}`;
+    const message = `Cannot copy ${process.execPath} to ${outputFile}: ${inspect(e)}`;
     if (verifyWorkflow) {
       throw new Error(message);
     }
     common.skip(message);
   }
-  console.log(`Copied ${sourceExecutable} to ${targetExecutable}`);
 
+  // Generate the blob using --experimental-sea-config.
+  spawnSyncAndExitWithoutError(
+    process.execPath,
+    ['--experimental-sea-config', configPath],
+    {
+      cwd: workingDir,
+      env: {
+        NODE_DEBUG_NATIVE: 'SEA',
+        ...process.env,
+      },
+    },
+  );
+
+  // Parse the config to get the output file path.
+  const config = JSON.parse(fs.readFileSync(path.resolve(workingDir, configPath)));
+  assert.strictEqual(typeof config.output, 'string');
+  const seaPrepBlob = path.resolve(workingDir, config.output);
+  assert(fs.existsSync(seaPrepBlob), `Expected SEA blob ${seaPrepBlob} to exist`);
+
+  // Use postject to inject the blob.
   const postjectFile = fixtures.path('postject-copy', 'node_modules', 'postject', 'dist', 'cli.js');
   try {
     spawnSyncAndExitWithoutError(process.execPath, [
       postjectFile,
-      targetExecutable,
+      outputFile,
       'NODE_SEA_BLOB',
-      seaBlob,
+      seaPrepBlob,
       '--sentinel-fuse', 'NODE_SEA_FUSE_fce680ab2cc467b6e072b8b5df1996b2',
       ...process.platform === 'darwin' ? [ '--macho-segment-name', 'NODE_SEA' ] : [],
     ]);
   } catch (e) {
-    const message = `Cannot inject ${seaBlob} into ${targetExecutable}: ${inspect(e)}`;
+    const message = `Cannot inject ${seaPrepBlob} into ${outputFile}: ${inspect(e)}`;
     if (verifyWorkflow) {
       throw new Error(message);
     }
     common.skip(message);
   }
-  console.log(`Injected ${seaBlob} into ${targetExecutable}`);
+  console.log(`Injected ${seaPrepBlob} into ${outputFile}`);
+
+  signSEA(outputFile, verifyWorkflow);
+  return outputFile;
+}
 
+function signSEA(targetExecutable, verifyWorkflow = false) {
   if (process.platform === 'darwin') {
     try {
       spawnSyncAndExitWithoutError('codesign', [ '--sign', '-', targetExecutable ]);

test/fixtures/sea/addon/sea-config.json

@@ -0,0 +1,8 @@
+{
+  "main": "sea.js",
+  "output": "sea-prep.blob",
+  "disableExperimentalSEAWarning": true,
+  "assets": {
+    "hello.node": "binding.node"
+  }
+}

test/fixtures/sea/addon/sea.js

@@ -0,0 +1,9 @@
+const sea = require('node:sea');
+const fs = require('fs');
+const path = require('path');
+
+const addonPath = path.join(process.cwd(), 'hello.node');
+fs.writeFileSync(addonPath, new Uint8Array(sea.getRawAsset('hello.node')));
+const mod = {exports: {}};
+process.dlopen(mod, addonPath);
+console.log('hello,', mod.exports.hello());

test/fixtures/sea/asset-keys-empty/sea-config.json

@@ -0,0 +1,4 @@
+{
+  "main": "sea.js",
+  "output": "sea-prep.blob"
+}

test/fixtures/sea/asset-keys/asset-1.txt

@@ -0,0 +1 @@
+This is asset 1

test/fixtures/sea/asset-keys/asset-2.txt

@@ -0,0 +1 @@
+This is asset 2

test/fixtures/sea/asset-keys/asset-3.txt

@@ -0,0 +1 @@
+This is asset 3

test/fixtures/sea/asset-keys/sea-config.json

@@ -0,0 +1,9 @@
+{
+  "main": "sea.js",
+  "output": "sea-prep.blob",
+  "assets": {
+    "asset-1.txt": "asset-1.txt",
+    "asset-2.txt": "asset-2.txt",
+    "asset-3.txt": "asset-3.txt"
+  }
+}

test/fixtures/sea/asset-keys/sea.js

@@ -0,0 +1,9 @@
+'use strict';
+
+const { isSea, getAssetKeys } = require('node:sea');
+const assert = require('node:assert');
+
+assert(isSea());
+
+const keys = getAssetKeys();
+console.log('Asset keys:', JSON.stringify(keys.sort()));

test/fixtures/sea/assets-invalid-type/sea-config.json

@@ -0,0 +1,5 @@
+{
+  "main": "sea.js",
+  "output": "sea-prep.blob",
+  "assets": "invalid"
+}

test/fixtures/sea/assets-invalid-type/sea.js

@@ -0,0 +1,3 @@
+'use strict';
+// This file is used for testing invalid "assets" configuration.
+// It should not be executed because the configuration should fail.

test/fixtures/sea/assets-nonexistent-file/sea-config.json

@@ -0,0 +1,7 @@
+{
+  "main": "sea.js",
+  "output": "sea-prep.blob",
+  "assets": {
+    "nonexistent": "nonexistent.txt"
+  }
+}

test/fixtures/sea/assets-nonexistent-file/sea.js

@@ -0,0 +1,3 @@
+'use strict';
+// This file is used for testing nonexistent asset file.
+// It should not be executed because the configuration should fail.

test/fixtures/sea/assets-raw/sea-config.json

@@ -0,0 +1,7 @@
+{
+  "main": "sea.js",
+  "output": "sea-prep.blob",
+  "assets": {
+    "person.jpg": "person.jpg"
+  }
+}

test/fixtures/sea/assets/sea-config.json

@@ -0,0 +1,8 @@
+{
+  "main": "sea.js",
+  "output": "sea-prep.blob",
+  "assets": {
+    "utf8_test_text.txt": "utf8_test_text.txt",
+    "person.jpg": "person.jpg"
+  }
+}

test/fixtures/sea/assets/utf8_test_text.txt

@@ -0,0 +1 @@
+永和九年，嵗在癸丑，暮春之初，會於會稽山隂之蘭亭，脩稧事也。羣賢畢至，少長咸集。此地有崇山峻領，茂林脩竹；又有清流激湍，暎帶左右。引以為流觴曲水，列坐其次。雖無絲竹管弦之盛，一觴一詠，亦足以暢敘幽情。是日也，天朗氣清，恵風和暢；仰觀宇宙之大，俯察品類之盛；所以遊目騁懐，足以極視聽之娛，信可樂也。夫人之相與，俯仰一世，或取諸懐抱，悟言一室之內，或因寄所託，放浪形骸之外。雖趣舎萬殊，靜躁��同，當其欣扵所遇，暫得扵己，怏然自足，不知老之將至。及其所之既惓，情隨事遷，感慨係之矣。向之所欣，俛仰之閒以為陳跡，猶不能不以之興懐；況脩短隨化，終期扵盡。古人云：「死生亦大矣。」豈不痛哉！每攬昔人興感之由，若合一契，未嘗不臨文嗟悼，不能喻之扵懐。固知一死生為虛誕，齊彭殤為妄作。後之視今，亦由今之視昔，悲夫！故列敘時人，錄其所述，雖世殊事異，所以興懐，其致一也。後之攬者，亦將有感扵斯文。

test/fixtures/sea/disable-experimental-warning/requirable.js

@@ -0,0 +1,3 @@
+module.exports = {
+  hello: 'world',
+};

test/fixtures/sea/disable-experimental-warning/sea-config.json

@@ -0,0 +1,5 @@
+{
+  "main": "sea.js",
+  "output": "sea-prep.blob",
+  "disableExperimentalSEAWarning": true
+}

test/fixtures/sea/disable-experimental-warning/sea.js

@@ -0,0 +1,64 @@
+const { Module: { createRequire } } = require('module');
+const createdRequire = createRequire(__filename);
+
+// Although, require('../common') works locally, that couldn't be used here
+// because we set NODE_TEST_DIR=/Users/iojs/node-tmp on Jenkins CI.
+const { expectWarning, mustNotCall } = createdRequire(process.env.COMMON_DIRECTORY);
+
+const builtinWarning =
+`Currently the require() provided to the main script embedded into single-executable applications only supports loading built-in modules.
+To load a module from disk after the single executable application is launched, use require("module").createRequire().
+Support for bundled module loading or virtual file systems are under discussions in https://github.com/nodejs/single-executable`;
+
+// This additionally makes sure that no unexpected warnings are emitted.
+if (!createdRequire('./sea-config.json').disableExperimentalSEAWarning) {
+  expectWarning('Warning', builtinWarning); // Triggered by require() calls below.
+  expectWarning('ExperimentalWarning',
+                'Single executable application is an experimental feature and ' +
+                'might change at any time');
+  // Any unexpected warning would throw this error:
+  // https://github.com/nodejs/node/blob/c301404105a7256b79a0b8c4522ce47af96dfa17/test/common/index.js#L697-L700.
+}
+
+// Should be possible to require core modules that optionally require the
+// "node:" scheme.
+const { deepStrictEqual, strictEqual, throws } = require('assert');
+const { dirname } = require('node:path');
+
+// Checks that the source filename is used in the error stack trace.
+strictEqual(new Error('lol').stack.split('\n')[1], '    at sea.js:29:13');
+
+// Should be possible to require a core module that requires using the "node:"
+// scheme.
+{
+  const { test } = require('node:test');
+  strictEqual(typeof test, 'function');
+}
+
+// Should not be possible to require a core module without the "node:" scheme if
+// it requires using the "node:" scheme.
+throws(() => require('test'), {
+  code: 'ERR_UNKNOWN_BUILTIN_MODULE',
+});
+
+deepStrictEqual(process.argv, [process.execPath, process.execPath, '-a', '--b=c', 'd']);
+
+strictEqual(require.cache, undefined);
+strictEqual(require.extensions, undefined);
+strictEqual(require.main, module);
+strictEqual(require.resolve, undefined);
+
+strictEqual(__filename, process.execPath);
+strictEqual(__dirname, dirname(process.execPath));
+strictEqual(module.exports, exports);
+
+throws(() => require('./requirable.js'), {
+  code: 'ERR_UNKNOWN_BUILTIN_MODULE',
+});
+
+const requirable = createdRequire('./requirable.js');
+deepStrictEqual(requirable, {
+  hello: 'world',
+});
+
+console.log('Hello, world! 😊');

test/fixtures/sea/empty/sea-config.json

@@ -0,0 +1,4 @@
+{
+  "main": "empty.js",
+  "output": "sea-prep.blob"
+}

test/fixtures/sea/exec-argv-empty/sea-config.json

@@ -0,0 +1,6 @@
+{
+  "main": "sea.js",
+  "output": "sea-prep.blob",
+  "disableExperimentalSEAWarning": true,
+  "execArgv": []
+}

test/fixtures/sea/exec-argv-empty/sea.js

@@ -0,0 +1,6 @@
+const assert = require('assert');
+
+console.log('process.argv:', JSON.stringify(process.argv));
+assert.strictEqual(process.argv[2], 'user-arg');
+assert.deepStrictEqual(process.execArgv, []);
+console.log('empty execArgv test passed');

test/fixtures/sea/exec-argv-extension-cli/sea-config.json

@@ -0,0 +1,7 @@
+{
+  "main": "sea.js",
+  "output": "sea-prep.blob",
+  "disableExperimentalSEAWarning": true,
+  "execArgv": ["--no-warnings"],
+  "execArgvExtension": "cli"
+}

test/fixtures/sea/exec-argv-extension-cli/sea.js

@@ -0,0 +1,14 @@
+const assert = require('assert');
+
+console.log('process.argv:', JSON.stringify(process.argv));
+console.log('process.execArgv:', JSON.stringify(process.execArgv));
+
+// Should have execArgv from SEA config + CLI --node-options
+assert.deepStrictEqual(process.execArgv, ['--no-warnings', '--max-old-space-size=1024']);
+
+assert.deepStrictEqual(process.argv.slice(2), [
+  'user-arg1',
+  'user-arg2'
+]);
+
+console.log('execArgvExtension cli test passed');

test/fixtures/sea/exec-argv-extension-env/sea-config.json

@@ -0,0 +1,7 @@
+{
+  "main": "sea.js",
+  "output": "sea-prep.blob",
+  "disableExperimentalSEAWarning": true,
+  "execArgv": ["--no-warnings"],
+  "execArgvExtension": "env"
+}

test/fixtures/sea/exec-argv-extension-env/sea.js

@@ -0,0 +1,19 @@
+const assert = require('assert');
+
+process.emitWarning('This warning should not be shown in the output', 'TestWarning');
+
+console.log('process.argv:', JSON.stringify(process.argv));
+console.log('process.execArgv:', JSON.stringify(process.execArgv));
+
+// Should have execArgv from SEA config.
+// Note that flags from NODE_OPTIONS are not included in process.execArgv no matter it's
+// an SEA or not, but we can test whether it works by checking that the warning emitted
+// above was silenced.
+assert.deepStrictEqual(process.execArgv, ['--no-warnings']);
+
+assert.deepStrictEqual(process.argv.slice(2), [
+  'user-arg1', 
+  'user-arg2'
+]);
+
+console.log('execArgvExtension env test passed');

test/fixtures/sea/exec-argv-extension-none/sea-config.json

@@ -0,0 +1,7 @@
+{
+  "main": "sea.js",
+  "output": "sea-prep.blob",
+  "disableExperimentalSEAWarning": true,
+  "execArgv": ["--no-warnings"],
+  "execArgvExtension": "none"
+}

test/fixtures/sea/exec-argv-extension-none/sea.js

@@ -0,0 +1,14 @@
+const assert = require('assert');
+
+console.log('process.argv:', JSON.stringify(process.argv));
+console.log('process.execArgv:', JSON.stringify(process.execArgv));
+
+// Should only have execArgv from SEA config, no NODE_OPTIONS
+assert.deepStrictEqual(process.execArgv, ['--no-warnings']);
+
+assert.deepStrictEqual(process.argv.slice(2), [
+  'user-arg1',
+  'user-arg2'
+]);
+
+console.log('execArgvExtension none test passed');

test/fixtures/sea/exec-argv/sea-config.json

@@ -0,0 +1,6 @@
+{
+  "main": "sea.js",
+  "output": "sea-prep.blob",
+  "disableExperimentalSEAWarning": true,
+  "execArgv": ["--no-warnings", "--max-old-space-size=2048"]
+}

test/fixtures/sea/exec-argv/sea.js

@@ -0,0 +1,18 @@
+const assert = require('assert');
+
+process.emitWarning('This warning should not be shown in the output', 'TestWarning');
+
+console.log('process.argv:', JSON.stringify(process.argv));
+console.log('process.execArgv:', JSON.stringify(process.execArgv));
+
+assert.deepStrictEqual(process.execArgv, [ '--no-warnings', '--max-old-space-size=2048' ]);
+
+// We start from 2, because in SEA, the index 1 would be the same as the execPath
+// to accommodate the general expectation that index 1 is the path to script for
+// applications.
+assert.deepStrictEqual(process.argv.slice(2), [
+  'user-arg1',
+  'user-arg2'
+]);
+
+console.log('multiple execArgv test passed');

test/fixtures/sea/inspect-in-sea-flags/sea-config.json

@@ -0,0 +1,4 @@
+{
+  "main": "sea.js",
+  "output": "sea-prep.blob"
+}

test/fixtures/sea/inspect-in-sea-flags/sea.js

@@ -0,0 +1 @@
+console.log(process.argv);

test/fixtures/sea/inspect/hello.js

@@ -0,0 +1 @@
+console.log('Hello, world!');

test/fixtures/sea/inspect/sea-config.json

@@ -0,0 +1,4 @@
+{
+  "main": "hello.js",
+  "output": "sea-prep.blob"
+}

test/fixtures/sea/simple/requirable.js

@@ -0,0 +1,3 @@
+module.exports = {
+  hello: 'world',
+};