Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test: skip SEA tests when SEA generation fails #51887

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions test/common/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1048,11 +1048,13 @@ Application functionality.
Skip the rest of the tests if single executable applications are not supported
in the current configuration.

### `injectAndCodeSign(targetExecutable, resource)`
### `generateSEA(targetExecutable, sourceExecutable, seaBlob, verifyWorkflow)`

Uses Postect to inject the contents of the file at the path `resource` into
the target executable file at the path `targetExecutable` and ultimately code
sign the final binary.
Copy `sourceExecutable` to `targetExecutable`, use postject to inject `seaBlob`
into `targetExecutable` and sign it if necessary.

If `verifyWorkflow` is false (default) and any of the steps fails,
it skips the tests. Otherwise, an error is thrown.

## tick Module

Expand Down
89 changes: 59 additions & 30 deletions test/common/sea.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@
const common = require('../common');
const fixtures = require('../common/fixtures');
const tmpdir = require('../common/tmpdir');
const { inspect } = require('util');

const { readFileSync } = require('fs');
const { readFileSync, copyFileSync } = require('fs');
const {
spawnSyncAndExitWithoutError,
} = require('../common/child_process');
Expand Down Expand Up @@ -54,47 +55,75 @@ function skipIfSingleExecutableIsNotSupported() {
}
}

function injectAndCodeSign(targetExecutable, resource) {
function generateSEA(targetExecutable, sourceExecutable, seaBlob, verifyWorkflow = false) {
try {
copyFileSync(sourceExecutable, targetExecutable);
} catch (e) {
const message = `Cannot copy ${sourceExecutable} to ${targetExecutable}: ${inspect(e)}`;
if (verifyWorkflow) {
throw new Error(message);
}
common.skip(message);
}
console.log(`Copied ${sourceExecutable} to ${targetExecutable}`);

const postjectFile = fixtures.path('postject-copy', 'node_modules', 'postject', 'dist', 'cli.js');
spawnSyncAndExitWithoutError(process.execPath, [
postjectFile,
targetExecutable,
'NODE_SEA_BLOB',
resource,
'--sentinel-fuse', 'NODE_SEA_FUSE_fce680ab2cc467b6e072b8b5df1996b2',
...process.platform === 'darwin' ? [ '--macho-segment-name', 'NODE_SEA' ] : [],
], {});
try {
spawnSyncAndExitWithoutError(process.execPath, [
postjectFile,
targetExecutable,
'NODE_SEA_BLOB',
seaBlob,
'--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)}`;
if (verifyWorkflow) {
throw new Error(message);
}
common.skip(message);
}
console.log(`Injected ${seaBlob} into ${targetExecutable}`);

if (process.platform === 'darwin') {
spawnSyncAndExitWithoutError('codesign', [ '--sign', '-', targetExecutable ], {});
spawnSyncAndExitWithoutError('codesign', [ '--verify', targetExecutable ], {});
try {
spawnSyncAndExitWithoutError('codesign', [ '--sign', '-', targetExecutable ], {});
spawnSyncAndExitWithoutError('codesign', [ '--verify', targetExecutable ], {});
} catch (e) {
const message = `Cannot sign ${targetExecutable}: ${inspect(e)}`;
if (verifyWorkflow) {
throw new Error(message);
}
common.skip(message);
}
console.log(`Signed ${targetExecutable}`);
} else if (process.platform === 'win32') {
let signtoolFound = false;
try {
spawnSyncAndExitWithoutError('where', [ 'signtool' ], {});
signtoolFound = true;
} catch (err) {
console.log(err.message);
}
if (signtoolFound) {
let certificatesFound = false;
let stderr;
try {
({ stderr } = spawnSyncAndExitWithoutError('signtool', [ 'sign', '/fd', 'SHA256', targetExecutable ], {}));
certificatesFound = true;
} catch (err) {
if (!/SignTool Error: No certificates were found that met all the given criteria/.test(stderr)) {
throw err;
}
} catch (e) {
const message = `Cannot find signtool: ${inspect(e)}`;
if (verifyWorkflow) {
throw new Error(message);
}
if (certificatesFound) {
spawnSyncAndExitWithoutError('signtool', 'verify', '/pa', 'SHA256', targetExecutable, {});
common.skip(message);
}
let stderr;
try {
({ stderr } = spawnSyncAndExitWithoutError('signtool', [ 'sign', '/fd', 'SHA256', targetExecutable ], {}));
spawnSyncAndExitWithoutError('signtool', 'verify', '/pa', 'SHA256', targetExecutable, {});
} catch (e) {
const message = `Cannot sign ${targetExecutable}: ${inspect(e)}\n${stderr}`;
if (verifyWorkflow) {
throw new Error(message);
}
common.skip(message);
}
console.log(`Signed ${targetExecutable}`);
}
}

module.exports = {
skipIfSingleExecutableIsNotSupported,
injectAndCodeSign,
generateSEA,
};
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
const common = require('../common');

const {
injectAndCodeSign,
generateSEA,
skipIfSingleExecutableIsNotSupported,
} = require('../common/sea');

Expand Down Expand Up @@ -56,8 +56,7 @@ const outputFile = tmpdir.resolve(process.platform === 'win32' ? 'sea.exe' : 'se

assert(existsSync(seaPrepBlob));

copyFileSync(process.execPath, outputFile);
injectAndCodeSign(outputFile, seaPrepBlob);
generateSEA(outputFile, process.execPath, seaPrepBlob);

spawnSyncAndExitWithoutError(
outputFile,
Expand Down
5 changes: 2 additions & 3 deletions test/sequential/test-single-executable-application-assets.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
const common = require('../common');

const {
injectAndCodeSign,
generateSEA,
skipIfSingleExecutableIsNotSupported,
} = require('../common/sea');

Expand Down Expand Up @@ -109,8 +109,7 @@ const outputFile = tmpdir.resolve(process.platform === 'win32' ? 'sea.exe' : 'se

assert(existsSync(seaPrepBlob));

copyFileSync(process.execPath, outputFile);
injectAndCodeSign(outputFile, seaPrepBlob);
generateSEA(outputFile, process.execPath, seaPrepBlob);

spawnSyncAndExitWithoutError(
outputFile,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
require('../common');

const {
injectAndCodeSign,
generateSEA,
skipIfSingleExecutableIsNotSupported,
} = require('../common/sea');

Expand Down Expand Up @@ -51,8 +51,7 @@ spawnSyncAndExitWithoutError(

assert(existsSync(seaPrepBlob));

copyFileSync(process.execPath, outputFile);
injectAndCodeSign(outputFile, seaPrepBlob);
generateSEA(outputFile, process.execPath, seaPrepBlob);

spawnSyncAndExitWithoutError(
outputFile,
Expand Down
22 changes: 17 additions & 5 deletions test/sequential/test-single-executable-application-empty.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
'use strict';

require('../common');
const common = require('../common');

const {
injectAndCodeSign,
generateSEA,
skipIfSingleExecutableIsNotSupported,
} = require('../common/sea');

Expand All @@ -13,7 +13,7 @@ skipIfSingleExecutableIsNotSupported();
// script.

const tmpdir = require('../common/tmpdir');
const { copyFileSync, writeFileSync, existsSync } = require('fs');
const { writeFileSync, existsSync } = require('fs');
const { spawnSyncAndExitWithoutError } = require('../common/child_process');
const assert = require('assert');

Expand All @@ -38,8 +38,20 @@ spawnSyncAndExitWithoutError(

assert(existsSync(seaPrepBlob));

copyFileSync(process.execPath, outputFile);
injectAndCodeSign(outputFile, seaPrepBlob);
// Verify the workflow.
try {
generateSEA(outputFile, process.execPath, seaPrepBlob, true);
} catch (e) {
if (/Cannot copy/.test(e.message)) {
common.skip(e.message);
} else if (common.isWindows) {
if (/Cannot sign/.test(e.message) || /Cannot find signtool/.test(e.message)) {
common.skip(e.message);
}
}

throw e;
}

spawnSyncAndExitWithoutError(
outputFile,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
require('../common');

const {
injectAndCodeSign,
generateSEA,
skipIfSingleExecutableIsNotSupported,
} = require('../common/sea');

Expand All @@ -12,7 +12,7 @@ skipIfSingleExecutableIsNotSupported();
// This tests "useCodeCache" is ignored when "useSnapshot" is true.

const tmpdir = require('../common/tmpdir');
const { copyFileSync, writeFileSync, existsSync } = require('fs');
const { writeFileSync, existsSync } = require('fs');
const {
spawnSyncAndExitWithoutError
} = require('../common/child_process');
Expand Down Expand Up @@ -62,8 +62,7 @@ const outputFile = join(tmpdir.path, process.platform === 'win32' ? 'sea.exe' :

assert(existsSync(seaPrepBlob));

copyFileSync(process.execPath, outputFile);
injectAndCodeSign(outputFile, seaPrepBlob);
generateSEA(outputFile, process.execPath, seaPrepBlob);

spawnSyncAndExitWithoutError(
outputFile,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
require('../common');

const {
injectAndCodeSign,
generateSEA,
skipIfSingleExecutableIsNotSupported,
} = require('../common/sea');

Expand All @@ -12,7 +12,7 @@ skipIfSingleExecutableIsNotSupported();
// This tests the snapshot support in single executable applications.

const tmpdir = require('../common/tmpdir');
const { copyFileSync, writeFileSync, existsSync } = require('fs');
const { writeFileSync, existsSync } = require('fs');
const {
spawnSyncAndExit,
spawnSyncAndExitWithoutError
Expand Down Expand Up @@ -85,8 +85,7 @@ const outputFile = tmpdir.resolve(process.platform === 'win32' ? 'sea.exe' : 'se

assert(existsSync(seaPrepBlob));

copyFileSync(process.execPath, outputFile);
injectAndCodeSign(outputFile, seaPrepBlob);
generateSEA(outputFile, process.execPath, seaPrepBlob);

spawnSyncAndExitWithoutError(
outputFile,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
require('../common');

const {
injectAndCodeSign,
generateSEA,
skipIfSingleExecutableIsNotSupported,
} = require('../common/sea');

Expand Down Expand Up @@ -56,8 +56,7 @@ spawnSyncAndExitWithoutError(

assert(existsSync(seaPrepBlob));

copyFileSync(process.execPath, outputFile);
injectAndCodeSign(outputFile, seaPrepBlob);
generateSEA(outputFile, process.execPath, seaPrepBlob);

spawnSyncAndExitWithoutError(
outputFile,
Expand Down
5 changes: 2 additions & 3 deletions test/sequential/test-single-executable-application.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
require('../common');

const {
injectAndCodeSign,
generateSEA,
skipIfSingleExecutableIsNotSupported,
} = require('../common/sea');

Expand Down Expand Up @@ -50,8 +50,7 @@ spawnSyncAndExitWithoutError(

assert(existsSync(seaPrepBlob));

copyFileSync(process.execPath, outputFile);
injectAndCodeSign(outputFile, seaPrepBlob);
generateSEA(outputFile, process.execPath, seaPrepBlob);

spawnSyncAndExitWithoutError(
outputFile,
Expand Down