capterqa / cli Goto Github PK

View Code? Open in Web Editor NEW

8.0 4.0 1.0 640 KB

Capter is a lightweight tool for end-to-end API testing.

Home Page: https://docs.capter.io

License: MIT License

Rust 97.06% JavaScript 2.94%

api-testing cli e2e graphql-testing javascript-tests test-automation testing testing-tools

cli's Introduction

Capter CLI

Capter is a lightweight end-to-end testing tool for APIs. It's language agnostic and can test APIs written in any language (Node.js, Go etc).

🧑‍💻 Write tests in YAML
🔎 Run the same tests locally, in CI, or as a cron job to monitor your live APIs
🏃‍♂️ Takes less than a minute to get started

How it works:

Create a workflow file in a .capter folder:

# .capter/products.yml

name: products
steps:
  - name: fetch all products
    id: products
    url: ${{ env.URL }}/api/products
    assertions:
      - !expect status to_equal 200
      - !expect body to_be_array

  - name: fetch first product
    url: ${{ env.URL }}/api/posts/${{ products.response.body.0.id }}
    assertions:
      - !expect body.id to_equal ${{ products.response.body.0.id }}

Then run the CLI:

URL=http://localhost:3000 capter test

Demo

Getting started

Follow the instructions in the documentation to get started:

API

License

The Capter CLI is provided under the MIT License. See LICENSE for details.

cli's People

Contributors

Stargazers

Watchers

Forkers

varobjs

cli's Issues

feat: utility methods inside templates

Support for basic helper functions inside the templates in the yaml files:

created_at: ${{ now() }}

feat: `to_match_object` assertion

This assertion should test if an object or array are the same - even if the location of the properties and values are different.

{
  "first_name": "Steve",
  "last_name": "Jobs"
}
===
{
  "last_name": "Jobs",
  "first_name": "Steve"
}

fix `compile::value::compile_value` return types

Currently this:

// data = { my_string: "5" }
value: ${{ my_string }}

will compile to:

value: 5

because we are guessing the return type in compile::value::compile_value, based on the value.

With #4 we should now be able to return the correct type based on the value from data.

The automated release is failing 🚨

🚨 The automated release from the `alpha` 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 alpha 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.

Missing `package.json` file.

A package.json file at the root of your project is required to release on npm.

Please follow the npm guideline to create a valid package.json file.

Good luck with your project ✨

Your semantic-release bot 📦🚀