# gauntlet_unicity

> Run tests, compare output

Latest version **3.0.1** (published 2020-01-21) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install gauntlet_unicity
pnpm add gauntlet_unicity
yarn add gauntlet_unicity
bun add gauntlet_unicity
```

Provides the command `gauntlet`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.1 |
| Published | 2020-01-21 |
| First published | 2019-04-11 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 36.1 KB |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| Author | powerc9000 |
| Maintainers | brendenc00k, lukecfairchild, unicityit |

## Links

- npm: https://www.npmjs.com/package/gauntlet_unicity
- npm.io page: https://npm.io/package/gauntlet_unicity

## Dependencies (8)

- [q](https://npm.io/package/q.md) ^1.4.1
- [knox](https://npm.io/package/knox.md) ^0.9.2
- [chalk](https://npm.io/package/chalk.md) ^3.0.0
- [colors](https://npm.io/package/colors.md) ^1.4.0
- [xml2js](https://npm.io/package/xml2js.md) ^0.4.23
- [request](https://npm.io/package/request.md) ^2.65.0
- [xmllint](https://npm.io/package/xmllint.md) ^0.1.0
- [underscore](https://npm.io/package/underscore.md) ^1.9.2

## Recent versions

- 3.0.1 (latest) — 2020-01-21
- 3.0.0 — 2019-04-11

## README

[![Code Climate](https://codeclimate.com/github/Unicity/Gauntlet/badges/gpa.svg)](https://codeclimate.com/github/Unicity/Gauntlet)
[![Issue Count](https://codeclimate.com/github/Unicity/Gauntlet/badges/issue_count.svg)](https://codeclimate.com/github/Unicity/Gauntlet)
[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/Unicity/Gauntlet.svg)](http://isitmaintained.com/project/Unicity/Gauntlet "Average time to resolve an issue")
[![Percentage of issues still open](http://isitmaintained.com/badge/open/Unicity/Gauntlet.svg)](http://isitmaintained.com/project/Unicity/Gauntlet "Percentage of issues still open")

Usage:

  ```gauntlet [flags] [tests]```

  flags

    -p port

    -h host name

    -f test file path

    -d test files directory path

    -a the base path for the test endpoints (optional)

    -u JSON diff url (optional)

    --shortener path to shortener config js file (optional)

    --aws-secrect AWS secret (optional)

    --aws-key AWS Key (optional)

    --aws-bucket AWS Bucket (optional)

    --verbose Prints out the headers and output from the server for each test. (optional)

Running a specific set of tests.
  `gauntlet <parameters> "testname.subTest" "testname"`

_Test names are automatically URL encoded_


###Using the converter
The format for the test file has changed the converter can convert old format to the new one.

```
./converter filename
```

This command will overwrite the old file. If you want to keep the old file I suggest making a backup.

###Using the shortener
To use the shortener you must specify a js file that looks something like:
```
const request = require('request')

module.exports = (url, callback) => {
  request.post({
    url     : 'https://example.com',
    headers : {
      'content-type' : 'application/json'
    },
    body : JSON.stringify({
      url : url
    })
  }, (error, response, body) => {
    if (error) {
      throw error
    }

    callback(JSON.parse(body).link)
  })
}
```

---
_Source: https://npm.io/package/gauntlet_unicity · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
