Giter Club home page Giter Club logo

judge-d-js's Introduction

Judge-d

Judge-d is a JS CLI tool for publishing and validating contracts using judge-d API.

Install

$ npm i judge-d -g

Usage

$ judge-d --help

Help output:

Commands:
  judge-d publish  Publish contracts
  judge-d verify   Verify contracts

Options:
  --version  Show version number                                       [boolean]
  --help     Show help                                                 [boolean]

Commands

$ judge-d publish --help
Publish contracts

Options:
  --url             Url to judge-d instance                  [string] [required]
  --serviceName     Service name                             [string] [required]
  --serviceVersion  Service version                          [string] [required]

  Required one of:
  --pactsDir        Path to directory with pacts             [string]
  --swaggerFile     Path to swagger json file                [string]

$ judge-d verify --help
It verifies contracts and generates HTML report if outFile is provided

Options:
  --url             Url to judge-d instance                  [string] [required]
  --serviceName     Service name                             [string] [required]
  --serviceVersion  Service version                          [string] [required]
  --environment     Environment name                         [string] [required]
  --outFile         Path with HTML report filename, ex. report.html     [string]

judge-d-js's People

Contributors

felipe444 avatar lukaszfiszer avatar pawfa avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

pawfa

judge-d-js's Issues

Should return an error when there are no interactions in pact file

Pact with empty interaction array will successfully pass judge-dredd validation. It is very difficult to realize that such situation happened and might lead to false negative and in consequence to deployment of API with breaking change.

Judge-d-js should exit with an error when there are no interactions in pact file.

The automated release is failing 🚨

🚨 The automated release from the main branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this πŸ’ͺ.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the main branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.


No npm token specified.

An npm token must be created and set in the NPM_TOKEN environment variable on your CI environment.

Please make sure to create an npm token and to set it in the NPM_TOKEN environment variable on your CI environment. The token must allow to publish to the registry https://registry.npmjs.org/.


Good luck with your project ✨

Your semantic-release bot πŸ“¦πŸš€

Publishing contracts of dependencies

Problem: if package B is a dependency of application A, and package B makes a request to a external API service, then we want this interaction to be included in contracts of application A.

Solution proposal:

package B declares contracts for its interactions:

  1. pact file is generated during build process, without consumer field
  2. reference to this pact files is defined via new pacts field in package.json
  3. generated pact file in included in the tarball published to the npm registry (for example using files property)

Example:

// package.json
{
  "name": "package-b",
  "pacts": ["dist/user-settings-pacts.json"],
  "files": ["dist"]
}

application A declares "package B" at its dependency:

// package.json
{
  "name": "application-a",
  "dependencies": {
    "package-b": "1.0.0"
  }
}

judge-d-js command when executed in application A root directory with new --include-dependencies-pacts flag
1. look at application A dependencies list from package.json
2. read each dependency package.json files and check if it contains pacts field
3. if it does, then read those pacts, set consumer field to the one passed as serviceName, a publish with the rest of the contracts

judge-d publish --serviceName application-a --serviceVersion 2.0.0 --include-dependencies-pacts  --pactsDir some/path --url https://example.com

Potential drawback

  • Application A will always publish contracts for all interactions implemented in package B, even if only a subset of functionality and interactions of package B is imported in the application

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.