Skip to content

Latest commit

 

History

History
168 lines (144 loc) · 5.18 KB

README.md

File metadata and controls

168 lines (144 loc) · 5.18 KB
Raw

node-testing-server

Actions Status npm version NPM License

Simple node.js server to generate .html, .json, .js, .css, .jpg, .png pages for end-to-end and API testing

Supported versions

Node.js:

  • 10.x
  • 11.x
  • 12.x
  • 13.x
  • 14.x
  • 15.x
  • 16.x
  • 17.x
  • 18.x
  • 19.x
  • 20.x

Installation

npm install node-testing-server --save-dev

Importing and configuring

You can require node-testing-server and configure it like this:

let { nodeTestingServer } = require('node-testing-server');

// Settings for node testing server
nodeTestingServer.config = {
    hostname: 'localhost',
    port: 3001,
    logsEnabled: 0,
    pages: {
        '/test.html': `<ul class="items">
                        <li>First</li>
                        <li>Second</li>
                        <li>Third</li>
                        <li>Fourth</li>
                        <li>Fifth</li>
                        <li>Sixth</li>
                        <li>Seventh</li>
                        <li>Eighth</li>
                        <li>Ninth</li>
                        <li>Tenth</li>
                    </ul>`
    }
};

Also if you want to specify a status code that will be returned by the page:

let { nodeTestingServer } = require('node-testing-server');

// Settings for node testing server
nodeTestingServer.config = {
    hostname: 'localhost',
    port: 3001,
    logsEnabled: 0,
    pages: {
        '/test.html': {
            pageStatusCode: 201,
            pageBody: `<ul class="items">
                        <li>First</li>
                        <li>Second</li>
                        <li>Third</li>
                        <li>Fourth</li>
                        <li>Fifth</li>
                        <li>Sixth</li>
                        <li>Seventh</li>
                        <li>Eighth</li>
                        <li>Ninth</li>
                        <li>Tenth</li>
                    </ul>`
        }
    }
};

By default logs are disabled (logsEnabled is set to 0). You can set logsEnabled config to one of 3 levels:

  • 0 - logs disabled
  • 1 - partial logs are enabled - prints out:
    • incoming request METHOD, URL and outcoming response CODE
    • pages that were generated or served
  • 2 - full logs are enabled - prints out:
    • incoming request METHOD, URL and outcoming response CODE
    • pages that were generated or served
    • incoming request headers
    • response time

Usage

Start and stop server like this:

// Start node testing server
nodeTestingServer.start();

// Stop node testing server
nodeTestingServer.stop();

If you will configure the /test.html server page as described in Importing and configuring section above, and send a GET request to http://localhost:3001/test.html, then the server will return html page with:

<ul class="items">
    <li>First</li>
    <li>Second</li>
    <li>Third</li>
    <li>Fourth</li>
    <li>Fifth</li>
    <li>Sixth</li>
    <li>Seventh</li>
    <li>Eighth</li>
    <li>Ninth</li>
    <li>Tenth</li>
</ul>

There are also 2 default pre-configured pages that you can hit:

  1. Sending GET request to http://localhost:3001/ will return:
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Node testing server - main page</title>
</head>
<body>
    <h1 class="title-main">Main page of node testing server</h1>
    <p>This page was constructed for testing purposes.</p>
    <ul>More info about <strong>node-testing-server</strong>:
        <li><a href="https://github.com/Marketionist/node-testing-server">on Github</a></li>
        <li><a href="https://www.npmjs.com/package/node-testing-server">on npm</a></li>
    </ul>
</body>
</html>

Note: if you want to serve your own page from http://localhost:3001/ - just create it in public/index.html in your root folder - otherwise it will be served from node_modules/node-testing-server/public/index.html

  1. Sending POST request to http://localhost:3001/post with {"test1":1,"test2":"Test text"} in the body will return a string with request headers and body:
`Incoming request headers: {"content-type":"application/json","connection":"close","content-length":"31","host":"localhost:3001"}
Incoming request body: {"test1":1,"test2":"Test text"}`

You can see live examples of node-testing-server usage in page-content-tests.js, in Protractor tests and in TestCafe tests

Thanks

If this package was helpful to you, please give it a ★ Star on GitHub