Skip to content

Latest commit

 

History

History
144 lines (111 loc) · 6.07 KB

README.md

File metadata and controls

144 lines (111 loc) · 6.07 KB
Raw

SODA Multicloud API Automated E2E Test Suite

Automated E2E tests for SODA Multicloud Project using Postman collection of the Multicloud APIs, global variables and the Newman collection runner.
The newman-reporter-htmlextra is a HTML reporter that has been extended to include the separation of the iteration runs.
This reporter comes with a dashboard style summary landing page and a set of different tabs which contain the detailed request information. There are also a few optional configuration flags available, to tailor the final report in a number of different ways.

Pre-requisites

To run Newman, ensure that you have Node.js >= v10. Install Node.js via package manager.
You can install different versions of NodeJS and maintain different versions using nvm - Node Version Manager. Instructions on how to install nvm can be found here

Installation

  1. Clone the repository

    git clone https://github.com/anvithks/multicloud-automated-e2e-test.git

  2. To Install newman and the reporter newman-reporter-htmlextra run the following:

    npm install

Configuration

Configure newman and newman-reporter-html-extra

We are using Newman as a library to run the collection.

newman.run({
    // Location of the Postman Collection
    collection: require('./SODA_Multicloud_Automation_Test.postman_collection.json'),
    // Location of the Postman Global Variables
    globals: require('./SODA.postman_globals.json'), 
    
    // Location of the Iteration Data to be used to run the tests.
    iterationData: ('./iteration_data.json'), 
    reporters: ['htmlextra','cli'], // Reporters to be enabled
    
    reporter: { // Configuration for the newman-reporter-htmlextra
        htmlextra: {
            logs: true,
            browserTitle: "SODA Multicloud E2E Test report",
            title: "SODA Multicloud E2E Test report",
            //Hide sensitive headers from the request
            skipHeaders: "X-Auth-Token",
            // Hide request body for these requests in the report            
            hideRequestBody: ["Register Backend", "Register Backend Invalid Credentials"],
            // Hide response body for these requests in the report
            hideResponseBody: ["Register Backend", "Register Backend Invalid Credentials"],
            // Hide these global variables from the report
            skipGlobalVars: ["authToken"],
        }
    },
    insecure: true, // allow self-signed certs, required in postman too,
    delayRequest: 2000, // Set the delay between every request
    timeout: 180000  // set time out,
}).on('start', function (err, args) { // on start of run, log to console
    console.log('Running E2E tests for SODA multicloud ...');
}).on('done', function (err, summary) {
    if (err || summary.error) {
        console.error('collection run encountered an error.');
    }
    else {
        console.log('collection run completed.');
    }
});

Configure Iteration Data

To run the E2E tests with different data we use the iteration_data.json file. This file contains an array of objects, each of which holds a set of inputs that can be used per iteration.

//This is a sample. You can populate with actual values.
{
        "name": "backend_aws",
        "type": "aws-s3",
        "region": "ap-south-1",
        "endpoint": "s3.ap-south-1.amazonaws.com",
        "security": "<Enter_Valid_Secret_Key>",
        "access": "<Enter_Valid_Access_Key>",
        "bucketName": "isabelatestawsbucket",
        "folderName":"sample_aws_folder"
},

Note: Please replace the values for security and access keys with the actual Secret Key and Access key provided by the Cloud backend.

Usage

To run the collection :

npm run e2e

OR

node app.js

Import and Edit Requests and Tests

You can import the Postman collection and the global variables JSON file in Postman.
The collection uses global variables, iteration data and the pre-request scripts and post request tests to enable the user to run tests with different inputs and input data.
Tests can be edited and added using the Postman desktop application.

After editing the requests and/or scripts and the variables they can be exported using Postman.

For more information:

Task Link Examples
Writing Scripts in Postman Link
Writing Pre-request Scripts Link
Writing test sripts in Postman Link Examples
Dynamic Variables Link
Postman JavaScript Reference Link
Using Variables Link

View Reports

CLI reporter is enabled by default when Newman is used as a CLI, you do not need to specifically provide the same as part of reporters option. However, enabling one or more of the other reporters will result in no CLI output.

We have enabled the newman-reporter-htmlextra, A Newman HTML reporter that has been extended to include the separation of the iteration runs so these are no longer aggregated together and also some additional handlebars helpers to enable users to create better custom templates.

This reporter comes with a dashboard style summary landing page and a set of different tabs which contain the detailed request information. There are also a few optional configuration flags available, to tailor the final report in a number of different ways.

The reports are generated in the /reports folder.