https://github.com/balazs4/alola

curl -i | alola
https://github.com/balazs4/alola

api-test api-testing assert curl json nodejs

Last synced: 11 days ago
JSON representation

curl -i | alola

• Host: GitHub
• URL: https://github.com/balazs4/alola
• Owner: balazs4
• License: mit
• Created: 2020-03-29T19:21:58.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-05-17T21:45:38.000Z (over 1 year ago)
• Last Synced: 2024-10-04T18:41:50.012Z (about 1 month ago)
• Topics: api-test, api-testing, assert, curl, json, nodejs
• Language: JavaScript
• Homepage:
• Size: 204 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        








# alola

[![npm version: alola](https://img.shields.io/npm/v/alola?color=010101&logo=npm&style=for-the-badge)](https://www.npmjs.com/package/alola) [![zero dependencies](https://img.shields.io/badge/dependencies-zero-010101?logo=npm&style=for-the-badge)](https://www.npmjs.com/package/alola) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-010101.svg?logo=prettier&style=for-the-badge)](https://github.com/prettier/prettier)

```sh

curl -i  | alola | fx .

```

- glue beetween `curl -i` and cli JSON parser tool of your choice like [`jq`](https://github.com/stedolan/jq) or [`fx`](https://github.com/antonmedv/fx)

- it was built with unix-philosophy in the mind

- runs assertions on JSON

- no bail-out: it runs every assertions

- CI-friendly: process exit code is always the number of failed testcases

## usage

```bash

# npm install -g alola

# or

# npx alola (recommended)

curl -i  | npx alola [assertions]

```

## examples

```bash

curl -i https://ewqfsixnkkhp3syjy65heuhkou0dogwr.lambda-url.eu-central-1.on.aws/ \

  | npx alola

# output

{

  "redirects": [],

  "protocol": "HTTP/1.1",

  "status": 200,

  "statusText": "OK",

  "headers": {

    "date": "Sun, 10 Jul 2022 08:30:19 GMT",

    "content-type": "application/json",

    "content-length": "68",

    "connection": "keep-alive",

    "x-amzn-requestid": "6f38be71-8c2a-4106-8bd5-6a2a0726d831",

    "x-amzn-trace-id": "root=1-62ca8e1b-3fa47e01777132441c03e3de;sampled=0"

  },

  "body": {

    "date": 1657441819664,

    "foobar": 42,

    "author": "balazs4",

    "name": "alola"

  }

}

```

```sh

# follows redirections

curl -i https://ewqfsixnkkhp3syjy65heuhkou0dogwr.lambda-url.eu-central-1.on.aws/ --follow \

  | npx alola

# assertion

curl -i https://ewqfsixnkkhp3syjy65heuhkou0dogwr.lambda-url.eu-central-1.on.aws/ \

  | npx alola \

   'status should be 200' \

   'headers.content-type should match json'\

   'body.author should be balazs4'

# silent assertion

curl -i https://ewqfsixnkkhp3syjy65heuhkou0dogwr.lambda-url.eu-central-1.on.aws/ \

  | npx alola 'status should be 200' 2>/dev/null

# assertion only

curl -i https://ewqfsixnkkhp3syjy65heuhkou0dogwr.lambda-url.eu-central-1.on.aws/ \

  | npx alola 'status should be 200' 1>/dev/null

# json assertion output

curl -i https://ewqfsixnkkhp3syjy65heuhkou0dogwr.lambda-url.eu-central-1.on.aws/ \

  | ALOLA_REPORT=json npx alola 'status should be 200' 1>/dev/null

# middleware

curl -i https://ewqfsixnkkhp3syjy65heuhkou0dogwr.lambda-url.eu-central-1.on.aws/ \

  | npx alola 'status should be 200' 'headers.content-type should match json' \

  | fx 'res => res.body.name + " by " + res.body.author'

```

## assertions

```sh

 should be 

 should not be 

 should match 

 should not match 

```

[more details](./.e2e.sh)

## configuration

You can configure `alola` with the following environment variables:

| Environment variable | Description                                  | Default value              | Possible values |

| -------------------- | -------------------------------------------- | -------------------------- | --------------- |

| `ALOLA_REPORT`       | result reporter                              | text                       | text,json       |

| `ALOLA_CUSTOM`       | any resolvable path to the custom assertions | [./.alola.js](./.alola.js) |                 |

## author

balazs4 - https://twitter.com/balazs4