Home

Awesome

<p align="center"> <img witdh="150px" height="150px" alt="clobbr grid logo" src="https://user-images.githubusercontent.com/1515742/80861783-dcfcc400-8c70-11ea-89c6-671dbdff6f33.png" /> <h3 align="center"> Clobbr CI integration examples <br/> <small><a href="https://clobbr.app">clobbr.app</a></small> <br/> <a href="https://www.npmjs.com/package/@clobbr/cli" target="_blank"> <img src="https://img.shields.io/npm/v/@clobbr/cli?label=npm&style=flat" alt="get @clobbr/cli on npm"> </a> </h3> </p>

This repository contains examples on how to integrate @clobbr/cli in various CIs.

In the CI of choice, make sure nodejs is available (recommended version: 14.x) and run checks with clobbr cli, for example:

npx @clobbr/cli run \
  --url "https://api.github.com/zen" \
  --checks mean=200 median=200 stdDev=50 q5=150 q50=200 q95=250 q99=300 pctOfSuccess=95
<img width="450px" alt="Run checks against results" src="https://user-images.githubusercontent.com/1515742/189538796-4d96f78f-0251-41e4-a549-bcb04eab2fb2.png">

If any of the checks fail, the CI will fail.

Go to main documentation to see more ↗️

Tested CIs

CI output example

<a href="https://ci.appveyor.com/project/dandaniel/clobbr-ci"> <img width="200px" alt="AppVeyor CI integration config" src="https://user-images.githubusercontent.com/1515742/189537169-1b6b812a-9830-4573-955d-b25ccec27e08.png"> </a>
circleci
version: 2.1

orbs:
  node: circleci/node@4.7

jobs:
  build:
    working_directory: ~/repo
    docker:
      - image: circleci/node:16.7.0
    steps:
      - checkout
      - run:
          name: Run clobbr
          command: npx @clobbr/cli run -u "https://60698fbde1c2a10017544a73.mockapi.io" --checks mean=200 median=200 stdDev=50 q5=150 q50=200 q95=250 q99=300 pctOfSuccess=95
travis
language: node_js
node_js:
  - "16"
script: npx @clobbr/cli run -u "https://60698fbde1c2a10017544a73.mockapi.io" --checks mean=200 median=200 stdDev=50 q5=150 q50=200 q95=250 q99=300 pctOfSuccess=95
appveyor
image: Ubuntu

environment:
  nodejs_version: "16"

test_script:
  - node --version
  - npm --version
  - npx @clobbr/cli run -u "https://60698fbde1c2a10017544a73.mockapi.io" --checks mean=200 median=200 stdDev=50 q5=150 q50=200 q95=250 q99=300 pctOfSuccess=95

build: off

Clobbr icon

<img width="180px" alt="APIHUSTLE Logo" src="https://user-images.githubusercontent.com/1515742/211200114-a9ed477f-5a61-4c97-915c-0791f09b1648.png"/>

Clobbr is a tool part of the Apihustle suite - a collection of tools to test, improve and get to know your API inside and out.