with-server
Advanced tools
start server, run command, stop server
Weekly downloads
Readme
Command line utility to start/stop a local server in order to execute end-to-end tests once the server is ready.
The server is started by running an npm script from the project's package.json. By default the start
script is used but you can specify another script using the --run <script>
option.
The server is expected to listen on the local TCP port specified by the $PORT
environment variable. If the var isn't set, with-server will pick a free random port and expose it as $PORT
.
After starting the server with-server tries to connect to $PORT
and waits until it becomes available.
Once the server is listening the given command
is executed. Inside the tests $PORT
or $SERVER_URL
can be used to access the server.
When the test are finished the server is gracefully shut down and with-server will exit with the test command's exit code.
By default the server's stdout is redirected to stderr so it doesn't get mixed up with the actual test output.
You can use the --redirect stdout
option to write it to stdout instead or --redirect null
to silence the output completely.
with-server [options] command
--run
The npm script to run (defaults to start
)--redirect
Redirect the server's output to stdout
, stderr
or null
(defaults to stderr
)Lets say you have the following script in your package.json
:
{
"scripts": {
"start": "react-scripts start",
"test:e2e": "with-server cypress"
}
}
Then npm run test:e2e
will launch a server, expose its URL as $SERVER_URL
and invoke cypress
once the server is listening.
You can also use with-server programmatically:
const withServer = require("with-server");
const exitCode = await withServer("cypress", {
run: "start",
redirect: "stdout",
});
MIT
start server, run command, stop server
The npm package with-server receives a total of 122 weekly downloads. As such, with-server popularity was classified as not popular.
We found that with-server demonstrated a healthy version release cadence and project activity. It has 1 open source maintainer collaborating on the project.