Skip to content

Commit

Permalink
Merge pull request #6 from TrueSparrowSystems/branding-changes
Browse files Browse the repository at this point in the history
Branding changes
  • Loading branch information
sunilkhedar authored Jan 30, 2023
2 parents c2b982e + 65d507f commit 2e273dd
Show file tree
Hide file tree
Showing 7 changed files with 19 additions and 16 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
## Openapi-test-suite v2.0.0
- Republished package under @truesparrow

## Openapi-test-suite v1.0.1
- LICENSE changes.

Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
The MIT License (MIT)
Copyright © 2022 PLG Works
Copyright © 2022 True Sparrow Systems Pvt. Ltd.

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:

Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Openapi Test Suite
![npm version](https://img.shields.io/npm/v/@plgworks/openapi-test-suite.svg?style=flat)
![npm version](https://img.shields.io/npm/v/@truesparrow/openapi-test-suite.svg?style=flat)

## Objective
This package aims to solve the following two problems:
1. Maintenance is a big problem to solve in any test suite. As the APIs evolve at a fast pace, maintenance becomes more difficult.
2. Usually when negative test cases are written, all combinations of parameters are not covered. Writing all the combinations manually is difficult and gets neglected.

We solve point 1, by consuming the openapi.json file to generate test cases in DRY manner.
Openapi.json is auto-generated using a generator script, as described in this [blog](https://plgworks.com/blog/dry-api-docs-and-validations/).
Openapi.json is auto-generated using a generator script, as described in this [blog](https://truesparrow.com/blog/dry-api-docs-and-validations/).

To solve point 2, we use the cartesian product of possible (correct as well as incorrect) sets of values for each parameter to get to the set of all negative test cases.

Expand All @@ -23,15 +23,15 @@ To solve point 2, we use the cartesian product of possible (correct as well as i
## Install
For installing the npm package, run following command in terminal:
```
npm install @plgworks/openapi-test-suite
npm install @truesparrow/openapi-test-suite
```

## Initialize

```node
const openapiObj = require('@plgworks/openapi-test-suite');
const openapiObj = require('@truesparrow/openapi-test-suite');

const ApiTestSuite = require('@plgworks/openapi-test-suite');
const ApiTestSuite = require('@truesparrow/openapi-test-suite');
const serverIndex = 0; // Index of the server (to be hit) from the servers block of openapi.json
const securityScheme = require('./examples/securityScheme.json');
const apiSuiteObj = new ApiTestSuite(openApiObj, serverIndex, securityScheme);
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.0.1
2.0.0
2 changes: 1 addition & 1 deletion lib/formatter/response.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
*
* @module lib/formatter/response
*/
const Base = require('@plgworks/base'),
const Base = require('@truesparrow/base'),
responseHelper = new Base.responseHelper({
module_name: 'openapi-test-suite'
});
Expand Down
2 changes: 1 addition & 1 deletion lib/logger/customConsoleLogger.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
const PkgBase = require('@plgworks/base'),
const PkgBase = require('@truesparrow/base'),
Logger = PkgBase.Logger;

/**
Expand Down
14 changes: 7 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
{
"name": "@plgworks/openapi-test-suite",
"version": "1.0.1",
"name": "@truesparrow/openapi-test-suite",
"version": "2.0.0",
"description": "DRY API test suite using openapi.json",
"main": "index.js",
"scripts": {
"pre-commit": "lint-staged"
},
"repository": {
"type": "git",
"url": "git+https://github.com/PLG-Works/openapi-test-suite.git"
"url": "git+https://github.com/TrueSparrowSystems/openapi-test-suite.git"
},
"keywords": [
"openapi",
"test suite"
],
"author": "PLG Works",
"author": "True Sparrow",
"license": "MIT",
"bugs": {
"url": "https://github.com/PLG-Works/openapi-test-suite/issues"
"url": "https://github.com/TrueSparrowSystems/openapi-test-suite/issues"
},
"homepage": "https://github.com/PLG-Works/openapi-test-suite#readme",
"homepage": "https://github.com/TrueSparrowSystems/openapi-test-suite#readme",
"dependencies": {
"@plgworks/base": "^1.0.0",
"@truesparrow/base": "^2.0.0",
"bignumber.js": "9.0.2",
"html-entities": "2.3.3",
"qs": "6.10.3",
Expand Down

0 comments on commit 2e273dd

Please sign in to comment.