Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Give the README a once-over refresh #196

Merged
merged 1 commit into from
May 6, 2020
Merged

Give the README a once-over refresh #196

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 23 additions & 23 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,19 @@

[![Greenkeeper badge](https://badges.greenkeeper.io/pelias/fuzzy-tester.svg)](https://greenkeeper.io/)

This is the Pelias fuzzy tester library, used for running our
This is the Pelias fuzzy tester library, used for testing the [Pelias Geocoder](https://github.com/pelias/pelias) by running our
[acceptance-tests](https://github.com/pelias/acceptance-tests) and
[fuzzy-tests](https://github.com/pelias/fuzzy-tests).

What are fuzzy tests? See the original [problem statement](https://github.com/pelias/acceptance-tests/issues/109)
that lead to the creation of this library.
Unlike a traditional unit test suite, testing a geocoder requires a bit of flexibility for many reasons:
- data can change
- minor differences in expected output should be handled
- it may not be feasible to fix certain errors at a certain time.
- The number of test cases is extremely large

Most importantly, fuzzy tests deliver more than just a single bit of pass or fail for each test:
they specify a total number of points (a score) for the test, and return how many points out of the
maximum were achieved. The weighting of individual parts of the test can be adjusted.
For more info on the challenges,see the original [problem statement](https://github.com/pelias/acceptance-tests/issues/109)
that lead to the creation of this library.

**Note:** fuzzy-tester requires NPM version 2 or greater. The NPM team
[recommends](http://blog.npmjs.org/post/85484771375/how-to-install-npm) you update NPM using NPM
itself with `sudo npm install -g npm`.
## Example Usage

```
Expand Down Expand Up @@ -103,15 +102,15 @@ AWS account, and that your `pelias-config` file contain the following configurat

```javascript
{
"acceptance-tests": {
"email": {
"ses": {
"accessKeyId": "AWSACCESSKEY",
"secretAccessKey": "AWS/Secret/key",
},
"recipients": ["[email protected]", "[email protected]"], // the list of recipients
}
}
"acceptance-tests": {
"email": {
"ses": {
"accessKeyId": "AWSACCESSKEY",
"secretAccessKey": "AWS/Secret/key",
},
"recipients": ["[email protected]", "[email protected]"], // the list of recipients
}
}
}
```

Expand All @@ -135,17 +134,18 @@ case. This helps detect situations where one expectation is found, but the other
red `0` in that case).

## API URL aliases

The acceptance-tests runner recognizes a number of aliases for Pelias API URLs (eg, `stage` corresponds to
`pelias.stage.mapzen.com`), which can be specified as command-line arguments when running a test suite. You can
override the default aliases and define your own in `pelias-config`:

```javascript
{
"acceptance-tests": {
"endpoints": {
"alias": "http://my.pelias.instance"
}
}
"acceptance-tests": {
"endpoints": {
"alias": "http://my.pelias.instance"
}
}
}
```

Expand Down