Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/davesag/mock-algolia
A mock server for the Algolia search engine allowing integration testing without the need to hit Algolia's actual servers
https://github.com/davesag/mock-algolia
algolia algolia-api mock-server testing-tool
Last synced: about 2 months ago
JSON representation
A mock server for the Algolia search engine allowing integration testing without the need to hit Algolia's actual servers
- Host: GitHub
- URL: https://github.com/davesag/mock-algolia
- Owner: davesag
- License: mit
- Created: 2019-04-24T03:56:21.000Z (almost 6 years ago)
- Default Branch: develop
- Last Pushed: 2024-10-09T07:42:52.000Z (4 months ago)
- Last Synced: 2024-11-11T22:35:34.666Z (2 months ago)
- Topics: algolia, algolia-api, mock-server, testing-tool
- Language: JavaScript
- Homepage:
- Size: 3.46 MB
- Stars: 27
- Watchers: 5
- Forks: 6
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# mock-algolia
A mock server that mimics the [Algolia](https://www.algolia.com) Search and Indexing APIs.
## Docker
- [`davesag/mock-algolia`](https://hub.docker.com/r/davesag/mock-algolia/)
## Links
- [Algolia](https://www.algolia.com)
- [Algolia API Client](https://www.algolia.com/doc/)
### Current Status
This is very much version `0.0.x` and a hack, not a fully fledged system.
- Very minimal support for adding, updating, and removing data from indices.
- No search queries supported yet (coming when I need them/get around to them)
- I've not written unit or integration tests for the main routes.
### To Use
I am going to assume you are using the Algolia Javascript API Client here, but if not then similar patterns will apply.
#### Prep the client
Normally you'd do this
```js
const client = algoliasearch(applicationId, apiKey)
const index = client.initIndex('some-index-name')
await index.addObjects(arrayOfObjects)
```
To fool the `algoliasearch` client into talking to this mock server, do this instead:
```js
const client = algoliasearch(applicationId, apiKey, { protocol: 'http:' })
client.hosts = {
read: ['http://localhost:3000'],
write: ['http://localhost:3000']
}
const index = client.initIndex('some-index-name')
await index.addObjects(arrayOfObjects)
```
Then all the client requests will go to the mock server (assuming it's running on port `3000`)
## Checking what was sent
You can get a quick overview of what has been sent to the mock server via [get `/requests'](http://localhost:3000/requests).
## Resetting the mock server
You can reset the request log by sending [`delete /requests`]
## Configuration
Set the following environment variables
| Variable | Default | Notes |
| -------- | ------- | ------------------------------ |
| `PORT` | `3000` | The port the server listens on |
## Development
### Branches
| Branch | Tests | Code Coverage | Audit | Comments |
| --------- | ----- | ------------- | ----- | -------- |
| `develop` | [](https://circleci.com/gh/davesag/mock-algolia/tree/develop) | [](https://codecov.io/gh/davesag/mock-algolia) | [](https://snyk.io/test/github/davesag/mock-algolia/develop) | Work in progress |
| `main` | [](https://circleci.com/gh/davesag/mock-algolia/tree/main) | [](https://codecov.io/gh/davesag/mock-algolia) | [](https://snyk.io/test/github/davesag/mock-algolia/main) | Latest Production Release |
### Prerequisites
- [NodeJS](htps://nodejs.org). I use [`nvm`](https://github.com/creationix/nvm) to manage Node versions — `brew install nvm`.
- [Docker](https://www.docker.com) if you want to use the Swagger Editor. (Use [Docker for Mac](https://docs.docker.com/docker-for-mac/), not the `homebrew` version)
### To build and run locally
Clone this (or better yet, fork it then clone your fork)
```sh
npm install
npm start
```
Go to [localhost:3000/docs](http://127.0.0.1:3000/docs) to see the docs.
### `.env` file
You can put environment variables in a `.env` file.
### Testing
- `npm test` to run the unit tests
- `npm run test:server` will run the integration tests
- `npm run lint` will lint it
- `npm run prettier` will prettify it
- `npm run test:unit:cov` will run the unit tests with code coverage
## Contributing
Please see the [contributing notes](CONTRIBUTING.md).