start-server-and-test

What is start-server-and-test?

The start-server-and-test npm package is designed to simplify the process of starting a server, running tests, and then shutting down the server. It is particularly useful in continuous integration environments where you need to ensure that the server starts successfully before tests are executed and is properly shut down afterward. This package helps automate these steps by providing a single command that handles the entire process.

What are start-server-and-test's main functionalities?

Start server, run tests, and stop server

This feature allows you to start your server using a start command (e.g., 'npm run start'), wait for the server to be accessible on a specified URL (e.g., http://localhost:3000), and then run tests using a test command (e.g., 'npm run test'). After the tests are completed, the server is automatically stopped.

start-server-and-test 'npm run start' http://localhost:3000 'npm run test'

Other packages similar to start-server-and-test

concurrently

Concurrently is a package that allows you to run multiple commands concurrently. Unlike start-server-and-test, it does not specifically manage the lifecycle of starting a server, running tests, and then stopping the server, but it can be used to achieve similar functionality with custom scripts.

forever

Forever is a simple CLI tool for ensuring that a given script runs continuously (i.e., forever). It is different from start-server-and-test as it focuses on keeping a script running rather than managing the start-test-stop cycle, but it can be used in combination with other tools to achieve similar end results.

pm2

PM2 is a powerful, production process manager for Node.js applications with a built-in load balancer. It is more complex and feature-rich compared to start-server-and-test, which is specifically focused on integration testing environments rather than full application management.

README

start-server-and-test

Starts server, waits for URL, then runs test command; when the tests end, shuts down server

Install

Requires Node version 8.9 or above.

npm install --save-dev start-server-and-test

Use

This command is meant to be used with NPM script commands. If you have a "start server", and "test" script names for example, you can start the server, wait for a url to respond, then run tests. When the test process exits, the server is shut down.

{
    "scripts": {
        "start-server": "npm start",
        "test": "mocha e2e-spec.js",
        "ci": "start-server-and-test start-server http://localhost:8080 test"
    }
}

To execute all tests simply run npm run ci

Commands

In addition to using NPM script names, you can pass entire commands (surround them with quotes so it is still a single string) that will be executed "as is". For example, to start globally installed http-server before running and recording Cypress.io tests you can use

start-server-and-test 'http-server -c-1 --silent' 8000 './node_modules/.bin/cypress run --record'

Alias

You can use either start-server-and-test, server-test or start-test commands in your scripts.

You can use : in front of port number like server-test :8080, so all these are equivalent

start-server-and-test start http://localhost:8080 test
server-test start http://localhost:8080 test
server-test http://localhost:8080 test
start-test :8080 test
start-test 8080 test
start-test 8080

Options

If you use convention and name your scripts "start" and "test" you can simply provide URL

{
    "scripts": {
        "start": "npm start",
        "test": "mocha e2e-spec.js",
        "ci": "start-server-and-test http://localhost:8080"
    }
}

You can also shorten local url to just port, the code below is equivalent to checking http://localhost:8080.

{
    "scripts": {
        "start": "npm start",
        "test": "mocha e2e-spec.js",
        "ci": "server-test 8080"
    }
}

You can provide first start command, port (or url) and implicit test command

{
    "scripts": {
        "start-it": "npm start",
        "test": "mocha e2e-spec.js",
        "ci": "server-test start-it 8080"
    }
}

You can provide port number and custom test command, in that case npm start is assumed to start the server.

{
    "scripts": {
        "start": "npm start",
        "test-it": "mocha e2e-spec.js",
        "ci": "server-test :9000 test-it"
    }
}

You can provide multiple resources to wait on, separated by a pipe |. (be sure to wrap in quotes)

{
    "scripts": {
        "start": "npm start",
        "test-it": "mocha e2e-spec.js",
        "ci": "server-test \"8080|http://foo.com\""
    }
}

or for multiple ports simply: server-test '8000|9000' test.

Note for webpack-dev-server users

If you are using webpack-dev-server (directly or via angular/cli or other boilerplates) then please use the following URL form to check

start-server-and-test http-get://localhost:8080

This is because under the hood this module uses wait-on to ping the server. Wait-on uses HEAD by default, but webpack-dev-server does not respond to HEAD only to GET requests. Thus you need to use http-get:// URL format to force wait-on to use GET probe.

You can even wait on the bundle JavaScript url instead of the page url, see discussion in this issue #4

Debugging

To see diagnostic messages, run with environment variable DEBUG=start-server-and-test

Disable HTTPS certificate checks

To see disable HTTPS checks for wait-on, run with environment variable START_SERVER_AND_TEST_INSECURE=1.

Timeout

This utility will wait for maximum of 5 minutes while checking for the server to respond.

Starting two servers

Sometimes you need to start one API server and one webserver in order to test the application. Just have two commands cascade. First command should wait on the webserver script, which in turn uses start-server-and-test to start the API server before running the webserver. Something like this

{
  "scripts": {
    "test": "node src/test",
    "start:api": "node src/api",
    "start:server": "node src/server",
    "start:server-and-api": "start-test start:api 7600 start:server",
    "test:all": "start-test start:server-and-api 5000 test"
  }
}

In the above example you would run npm run test:all to start both servers and run the test. See repo start-two-servers-example for full example

Small print

Author: Gleb Bahmutov <[e-mail]> © 2017

• @bahmutov
• glebbahmutov.com
• blog

License: MIT - do anything with the code, but don't blame me if it does not work.

Support: if you find any problems with this module, email / tweet / open issue on Github

MIT License

Copyright (c) 2017 Gleb Bahmutov <[e-mail]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.