Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/outbrain/Leonardo
Your mocking ninja - an add-on tool for centralizing your client side mocking
https://github.com/outbrain/Leonardo
e2e-tests front-end-development javascript leonardo mocking typescript ui-tests
Last synced: 18 days ago
JSON representation
Your mocking ninja - an add-on tool for centralizing your client side mocking
- Host: GitHub
- URL: https://github.com/outbrain/Leonardo
- Owner: outbrain
- License: mit
- Created: 2014-07-17T11:16:53.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-03-03T07:55:23.000Z (8 months ago)
- Last Synced: 2024-10-10T07:54:04.932Z (about 1 month ago)
- Topics: e2e-tests, front-end-development, javascript, leonardo, mocking, typescript, ui-tests
- Language: TypeScript
- Homepage:
- Size: 7.83 MB
- Stars: 94
- Watchers: 23
- Forks: 23
- Open Issues: 42
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
Leonardo
Client side mocking for the server side
## Install
### npm
```bash
$ npm install leonardojs --save-dev
```
## Example
[Full Application Example](http://outbrain.github.io/Leonardo/examples/angularIL/)
[Video Example - AngularJS Israel Conference (Hebrew)](http://www.youtube.com/watch?v=zPBmMiJZ5O8)
# Getting Started
## 1. Add Leonardo script
### Require in your code
```javascript
// in dev environment
import 'leonardojs';
```
### Or directly in html
```html
//.....
```
## 2. Run your app
You should now see Leonardo's icon on the bottom right corner. Click It.
## 3. Start mocking your http calls via the recorder tab
## 4. Turn your mocking on and off as you wish
## 5. Change your responses as you wish
## Javascript API
Automate your mocks using Leonardo's API
**State**:
- name: (string) State name, must be unique
- url: (string) request url, treated as regex
- verb: (string) request http verb
- options (StateOption array)
**StateOption**:
- name: (string) option name
- status: (number) http status code
- data: (primitive | Object | Function) the data to be returned in response body.
- Use function to dynamically control the response (first parameter is the request object).
### Add States
`addState(State array)`
```javascript
//.....
Leonardo.addStates([
{
name: 'Get Data',
url: '/api/user/43435',
verb: 'GET',
options: [
{name: 'success', status: 200, data: { name: "Master Splinter" }},
{name: 'error 500', status: 500}
]
},{
name: 'Get Data',
url: '/api/user/43435',
verb: 'GET',
options: [
{name: 'success', status: 200, data: { name: "Master Splinter" }},
{name: 'error 500', status: 500}
]
},
{
name: 'Get Characters',
url: '/api/character',
verb: 'GET',
options: [
{
name: 'success',
status: 200,
data: function(request) {
if (request.url.indexOf('term=Donatello') > 0) {
return { name: "Donatello" };
} else {
return { name: "Raphael" };
}
}
},
]
}
]);
```
### Activate State Option
`activateStateOption(stateName, optionName)`
Activates state option, mocked response will be returned when calling the state url
```javascript
//.....
Leonardo.activateStateOption('Update Data', 'success');
$http.put('/api/user/43435', { name: "Master Splinter" }).success(function(data, status) {
console.log(status); // 200
});
Leonardo.activateStateOption('Update Data', 'error 500');
$http.put('/api/user/43435', { name: "Master Splinter" }).error(function(data, status) {
console.log(status); // 500
});
//.....
```
### Deactivate State
`deactivateState(stateName)`
Deactivates a specific state, when calling the state url request will pass through to the server
```javascript
//.....
Leonardo.deactivateState('Update Data');
//.....
```
### Hide/Show Leonardo icon
You can hide Leonardo activator icon by clicking `ctrl` + `shift` + `l`.