Skip to content

chore: add template to easily recreate bugs #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
openapi: 3.0.0
info:
title: Example OpenApi 3 spec
description: Has various paths with responses to use in testing
version: 0.1.0
paths:
/test:
get:
responses:
'200':
description: OK
content:
application/json:
schema:
allOf:
- type: object
properties:
expectedProperty1:
type: string
- type: object
properties:
expectedProperty2:
type: string
# additionalProperties: false # Uncommenting this line exposes the bug
52 changes: 52 additions & 0 deletions test/unit/bug-recreation-template.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
/*******************************************************************************
* Copyright 2019 IBM Corp.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*******************************************************************************/

const chai = require('chai');
const path = require('path');

const chaiResponseValidator = require('../..');

const dirContainingApiSpec = path.resolve('test/resources/exampleOpenApiFiles/valid/bugRecreationTemplate');
const { expect } = chai;

describe('Recreate bug (issue #46)', function () {

before(function () {
const pathToApiSpec = path.join(dirContainingApiSpec, 'openapi.yml');
chai.use(chaiResponseValidator(pathToApiSpec));
});

const res = {
status: 200,
req: {
method: 'GET',
path: '/test',
},
body: {
expectedProperty1: 'foo',
expectedProperty2: 'bar',
},
};

it('passes', function () {
expect(res).to.satisfyApiSpec;
});

it('fails when using .not', function () {
const assertion = () => expect(res).to.not.satisfyApiSpec;
expect(assertion).to.throw();
});
});