npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

newman-contract

v1.1.1

Published

A helper for contract testing using newman

Downloads

4

Readme

npm version Build Status

Contract Testing using Newman

With newman-contract you dont need to relly on postman to read or write your contract tests, just write your contract definition like any other file and then use the powerful newman cli to run it!

If you are not familiar with Consumer-Driven contract tests using Postman, I recommend you to read this article.

Features:

  • Creates a boilerplate collection for contract testing
  • Human readable error messages
  • Easy source control over your contracts
  • Able to use process.env to build collections
  • Support for esModules
  • Typescipt definitions

Getting Started

Install:

npm install --save newman
npm install --save newman-contract

Then, create a file exporting your contract definition:

// contract/search.js
const { ContractDefinition } = require("newman-contract")
const baseUrl = "https://my-api.com"

module.exports = ContractDefinition({
  method: "GET",
  endpoint: `${baseUrl}/search`,
  query: { query: 'my term' }
  schema: {
    type: "object",
    properties: {
        // ... Your JSON schema to match response
    }
  }
})

Or, with ES Modules:

import { ContractDefinition } from 'newman-contract'
export default ContractDefinition({ ... })

Now, you need to run newman with a ContractCollection

const newman = require('newman')
const { ContractCollection } = require('newman-contract')

newman.run({
    collection: ContractCollection({ fromPattern: 'contract/*.js' })
    reporters: ['cli'] // You can use any newman reporter
})

API Reference

ContractDefinition(Object contract) -> Object

Parse the given contract object to a contract definition, building a postman test to match the response to the given schema.

contract
  • method: HTTP method
  • endpoint: endpoint to wich the request is made (accepts encoded query)
  • schema: response schema to match
  • name (optional): Name for the especific test
  • query (optinal): JSON Object containing all request query (priority over encoded query)
  • headers (optional): JSON Object containing all request headers
  • body (optional): JSON Object containing request body data

ContractCollection(Object options) -> JSON Object

Finds all Contract Definitions and builds a postman collection out of it.

options
  • fromPattern: Glob pattern to find the contract definitions
  • name (optional): Custom name for collection (Default: 'Contract Collection')
  • exportToPath (optional): File path to which the final collection will be exported to