mirror of
https://github.com/wahyd4/go-mocket.git
synced 2026-08-09 04:46:54 +10:00
Alexandre Vallières-Lagacé
a3fc039cfb
* updated refrences to the documentation * centralized all documentation in DOCUMENTATION.md * added warning in some of the examples
55 lines
2.7 KiB
Markdown
55 lines
2.7 KiB
Markdown
[](https://godoc.org/github.com/Selvatico/go-mocket) [](https://travis-ci.org/Selvatico/go-mocket) [](https://goreportcard.com/report/github.com/Selvatico/go-mocket)
|
||
|
||
# Go-Mocket – Go GORM & SQL Mocking Library
|
||
|
||
Go-Mocket is a library inspired by [DATA-DOG/go-sqlmock](https://github.com/DATA-DOG/go-sqlmock).
|
||
|
||
As an inspiration library, it is the implementation of [sql/driver](https://godoc.org/database/sql/driver) interface but at the same time it follows a different approach and only has a similar API.
|
||
This library helps to mock any DB connection with [jinzhu/gorm](https://github.com/jinzhu/gorm), as it was the created to serve this purpose.
|
||
|
||
List of features in the library:
|
||
|
||
* Mock `INSERT`, `UPDATE`, `SELECT`, `DELETE`
|
||
* Support for transactions
|
||
* 2 API's to use - `chaining` and via specifying a whole mock object
|
||
* Matching by prepared statements arguments
|
||
* You don't require to change anything inside your code to start using this library
|
||
* Ability to trigger exceptions
|
||
* Attach callbacks to mocked responses to add an additional check or modify a response
|
||
|
||
**NOTE**, Please be aware that driver catches SQL without DB specifics. Generation of queries is done by *SQL* package
|
||
|
||
## Install
|
||
|
||
```
|
||
go get github.com/Selvatico/go-mocket
|
||
```
|
||
|
||
## Documentation
|
||
|
||
For detailed usage and examples, look at the [Documentation](https://github.com/Selvatico/go-mocket/blob/master/DOCUMENTATION.md)
|
||
|
||
## License
|
||
|
||
MIT License
|
||
|
||
Copyright (c) 2017 Seredenko Dmitry
|
||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||
of this software and associated documentation files (the "Software"), to deal
|
||
in the Software without restriction, including without limitation the rights
|
||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||
copies of the Software, and to permit persons to whom the Software is
|
||
furnished to do so, subject to the following conditions:
|
||
|
||
The above copyright notice and this permission notice shall be included in all
|
||
copies or substantial portions of the Software.
|
||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||
SOFTWARE.
|