highcharts-export-server/tests/http/http_test_runner.js

Convert Highcharts.JS charts into static image files.

/*******************************************************************************

Highcharts Export Server

Copyright (c) 2016-2024, Highsoft

Licenced under the MIT licence.

Additionally a valid Highcharts license is required for use.

See LICENSE file in root for details.

*******************************************************************************/

import {
  createWriteStream,
  existsSync,
  mkdirSync,
  readdirSync,
  readFileSync
} from 'fs';
import http from 'http';
import { join } from 'path';

import 'colors';

import { fetch } from '../../lib/fetch.js';
import { __dirname, clearText } from '../../lib/utils.js';

// Test runner message
console.log(
  'Highcharts Export Server HTTP Requests Test Runner'.yellow.bold.underline,
  '\nThis tool simulates POST requests to Highcharts Export Server.'.green,
  '\nThe server needs to be started before running this test.'.green,
  '\nLoads all JSON files from the ./tests/http folder and runs them'.green,
  '(results are stored in the ./tests/http/_results).\n'.green
);

// Url of Puppeteer export server
const url = 'http://127.0.0.1:7801';

// Perform a health check before continuing
fetch(`${url}/health`)
  .then(() => {
    // Results and scenarios paths
    const resultsPath = join(__dirname, 'tests', 'http', '_results');
    const scenariosPath = join(__dirname, 'tests', 'http', 'scenarios');

    // Create results folder for HTTP exports if it doesn't exist
    !existsSync(resultsPath) && mkdirSync(resultsPath);

    // Get files' names
    const files = readdirSync(scenariosPath);

    // Tests counters
    let testCounter = 0;
    let failsCounter = 0;

    // Disable event listeners limiter
    process.setMaxListeners(0);
    Promise.all(
      files
        .filter((file) => file.endsWith('.json'))
        .map(async (file) => {
          try {
            console.log('[Test runner]'.blue, `Processing test ${file}.`);

            // A file path
            const filePath = join(scenariosPath, file);

            // Read a payload file
            const payload = clearText(
              readFileSync(filePath).toString(),
              /\s\s+/g,
              ''
            );
            const parsedPayload = JSON.parse(payload);

            // Results folder path
            const resultsFile = join(
              resultsPath,
              file.replace(
                '.json',
                `.${parsedPayload.b64 ? 'txt' : parsedPayload.type || 'png'}`
              )
            );

            return new Promise((resolve) => {
              // The start date of a POST request
              const startDate = new Date().getTime();
              const request = http.request(
                url,
                {
                  path: '/',
                  method: 'POST',
                  headers: {
                    'Content-Type': 'application/json'
                  }
                },
                (response) => {
                  const fileStream = createWriteStream(resultsFile);

                  // A chunk of data has been received
                  response.on('data', (chunk) => {
                    fileStream.write(chunk);
                  });

                  // The whole response has been received
                  response.on('end', () => {
                    fileStream.end();

                    const endMessage = `HTTP request with a payload from file: ${file}, took ${
                      new Date().getTime() - startDate
                    }ms.`;

                    // Based on received status code check if requests failed
                    if (response.statusCode >= 400) {
                      failsCounter++;
                      console.log(`[Fail] ${endMessage}`.red);
                    } else {
                      testCounter++;
                      console.log(`[Success] ${endMessage}`.green);
                    }
                    resolve();
                  });
                }
              );
              request.write(payload);
              request.end();
            });
          } catch (error) {
            console.error(error);
          }
        })
    ).then(() => {
      console.log(
        '\n--------------------------------',
        failsCounter
          ? `\n${testCounter} tests done, ${failsCounter} error(s) found!`.red
          : `\n${testCounter} tests done, errors not found!`.green,
        '\n--------------------------------'
      );
    });
  })
  .catch((error) => {
    if (error.code === 'ECONNREFUSED') {
      return console.log(
        `[ERROR] Couldn't connect to ${url}.`.red,
        `Set your server before running tests.`.red
      );
    }
  });