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.

Sign up for GitHub

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

doc,test: extend the list of platforms supported by single-executables #47026

Merged
merged 3 commits into from
Mar 11, 2023
Merged

doc,test: extend the list of platforms supported by single-executables #47026

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f37132b
doc,test: extend the list of platforms supported by single-executables
RaisinTen Mar 9, 2023
39eeeea
doc: be more specific about supported platforms
RaisinTen Mar 9, 2023
a2e0758
test: improve readability
RaisinTen Mar 9, 2023
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
4 changes: 3 additions & 1 deletion doc/api/single-executable-applications.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,8 @@ platforms:

* Windows
* macOS
* Linux (AMD64 only)
* Linux (all distributions [supported by Node.js][] except Alpine and all
architectures [supported by Node.js][] except s390x and ppc64)

This is due to a lack of better tools to generate single-executables that can be
used to test this feature on other platforms.
Expand All @@ -174,3 +175,4 @@ to help us document them.
[postject]: https://github.com/nodejs/postject
[signtool]: https://learn.microsoft.com/en-us/windows/win32/seccrypto/signtool
[single executable applications]: https://github.com/nodejs/single-executable
[supported by Node.js]: https://github.com/nodejs/node/blob/main/BUILDING.md#platform-list
4 changes: 3 additions & 1 deletion doc/contributing/maintaining-single-executable-application-support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,9 @@ for the following features are in the list of work we'd like to get to:
* Running an archive of multiple files.
* Embedding [Node.js CLI options][] into the binary.
* [XCOFF][] executable format.
* Run tests on Linux architectures/distributions other than AMD64 Ubuntu.
* Run tests on Alpine Linux.
* Run tests on s390x Linux.
* Run tests on ppc64 Linux.

## Disabling single executable application support

Expand Down
24 changes: 13 additions & 11 deletions test/parallel/test-single-executable-application.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,10 @@ if (!process.config.variables.single_executable_application)
if (!['darwin', 'win32', 'linux'].includes(process.platform))
common.skip(`Unsupported platform ${process.platform}.`);

if (process.platform === 'linux' && process.config.variables.asan)
common.skip('Running the resultant binary fails with `Segmentation fault (core dumped)`.');
if (process.platform === 'linux' && process.config.variables.asan) {
// Source of the memory leak - https://github.com/nodejs/node/blob/da0bc6db98cef98686122ea1e2cd2dbd2f52d123/src/node_sea.cc#L94.
common.skip('Running the resultant binary fails because of a memory leak ASAN error.');
}

if (process.platform === 'linux' && process.config.variables.is_debug === 1)
common.skip('Running the resultant binary fails with `Couldn\'t read target executable"`.');
Expand All @@ -39,17 +41,17 @@ if (process.config.variables.want_separate_host_toolset !== 0)
common.skip('Running the resultant binary fails with `Segmentation fault (core dumped)`.');

if (process.platform === 'linux') {
try {
const osReleaseText = readFileSync('/etc/os-release', { encoding: 'utf-8' });
if (!/^NAME="Ubuntu"/m.test(osReleaseText)) {
throw new Error('Not Ubuntu.');
}
} catch {
common.skip('Only supported Linux distribution is Ubuntu.');
const osReleaseText = readFileSync('/etc/os-release', { encoding: 'utf-8' });
if (/^NAME="Alpine Linux"/m.test(osReleaseText)) {
common.skip('Alpine Linux is not supported.');
}
RaisinTen marked this conversation as resolved.
Show resolved Hide resolved

if (process.arch === 's390x') {
common.skip('On s390x, postject fails with `memory access out of bounds`.');
}

if (process.arch !== 'x64') {
common.skip(`Unsupported architecture for Linux - ${process.arch}.`);
if (process.arch === 'ppc64') {
common.skip('On ppc64, this test times out.');
}
}

Expand Down