Awesome
<!-- Title --> <h1 align="center"> integresql-client </h1> <!-- Description --> <h4 align="center"> <a href="https://github.com/allaboutapps/integresql">IntegreSQL</a> client for managing isolated PostgreSQL databases in integration tests. </h4> <!-- Badges --> <p align="center"> <a href="https://www.npmjs.com/package/@devoxa/integresql-client"> <img src="https://img.shields.io/npm/v/@devoxa/integresql-client?style=flat-square" alt="Package Version" /> </a> <a href="https://github.com/devoxa/integresql-client/actions?query=branch%3Amaster+workflow%3A%22Continuous+Integration%22"> <img src="https://img.shields.io/github/actions/workflow/status/devoxa/integresql-client/push.yml?branch=master&style=flat-square" alt="Build Status" /> </a> <a href="https://codecov.io/github/devoxa/integresql-client"> <img src="https://img.shields.io/codecov/c/github/devoxa/integresql-client/master?style=flat-square" alt="Code Coverage" /> </a> </p> <!-- Quicklinks --> <p align="center"> <a href="#installation">Installation</a> • <a href="#usage">Usage</a> • <a href="#contributors">Contributors</a> • <a href="#license">License</a> </p> <br>Installation
yarn add --dev @devoxa/integresql-client
To install IntegreSQL, please follow their installation instructions.
Usage
Full example
For a full usage example, have a look the integration tests.
Step-by-step guide
- Initialize the IntegreSQL client
import { IntegreSQLClient } from '@devoxa/integresql-client'
const integreSQL = new IntegreSQLClient({ url: 'http://localhost:5000' })
// options.url: The URL of the IntegreSQL instance
- (Once per test runner process) Get a hash of the migrations & fixtures
// The hash can be generated in any way that fits your business logic, the included
// helper creates a SHA1 hash of the file content of all files matching the glob patterns.
const hash = await integreSQL.hashFiles(['./migrations/**/*', './fixtures/**/*'])
- (Once per test runner process) Initialize the template database
await integreSQL.initializeTemplate(hash, async (databaseConfig) => {
await migrateTemplateDatabase(databaseConfig)
await seedTemplateDatabase(databaseConfig)
await disconnectFromDatabase(databaseConfig)
})
- (Before each test) Get a isolated test database
const databaseConfig = await integreSQL.getTestDatabase(hash)
Helpers
integreSQL.databaseConfigToConnectionUrl(databaseConfig)
- Converts the database configuration object into a connection URL
API requests
You can directly send requests to the IntegreSQL instance via the included API client, or optionally
instantiate a new IntegreSQLApiClient
yourself.
await integreSQL.api.reuseTestDatabase(hash, id)
const api = new IntegreSQLApiClient({ url: 'http://localhost:5000' })
await api.reuseTestDatabase(hash, id)
Contributors
Thanks goes to these wonderful people (emoji key):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tr> <td align="center"><a href="https://www.david-reess.de"><img src="https://avatars3.githubusercontent.com/u/4615516?v=4" width="75px;" alt=""/><br /><sub><b>David Reeß</b></sub></a><br /><a href="https://github.com/devoxa/integresql-client/commits?author=queicherius" title="Code">💻</a> <a href="https://github.com/devoxa/integresql-client/commits?author=queicherius" title="Documentation">📖</a> <a href="https://github.com/devoxa/integresql-client/commits?author=queicherius" title="Tests">⚠️</a></td> </tr> </table> <!-- markdownlint-enable --> <!-- prettier-ignore-end --> <!-- ALL-CONTRIBUTORS-LIST:END -->This project follows the all-contributors specification. Contributions of any kind welcome!
License
MIT