Skip to content

Your mocking ninja - an add-on tool for centralizing your client side mocking

License

Notifications You must be signed in to change notification settings

outbrain-inc/Leonardo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Feb 28, 2024
b8be368 · Feb 28, 2024
Oct 31, 2021
Oct 17, 2019
Oct 23, 2019
Nov 21, 2022
Mar 21, 2017
Oct 16, 2019
Dec 6, 2016
Jan 22, 2017
Nov 1, 2021
Oct 17, 2019
Feb 15, 2016
Nov 4, 2018
Feb 15, 2016
Feb 28, 2024
Feb 28, 2024
Nov 27, 2022
Feb 28, 2024
May 29, 2022
Feb 28, 2024

Repository files navigation

Mocking and testing made simple and consistent. Developed by Outbrain.

Leonardo

Client side mocking for the server side

travis-ci workflow status NPM version Package Quality

Install

npm

$ npm install leonardojs --save-dev

Example

Full Application Example

Video Example - AngularJS Israel Conference (Hebrew)

Getting Started

1. Add Leonardo script

Require in your code

    // in dev environment
    import 'leonardojs';

Or directly in html

 <!DOCTYPE HTML>
 <html>
 <body>
   //.....
   <script src="[node_modules|other]/leonardo/dist/leonardo.js"></script>
 </body>
 </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

Mocking and testing made simple and consistent. Developed by Outbrain.

4. Turn your mocking on and off as you wish

Mocking and testing made simple and consistent. Developed by Outbrain.

5. Change your responses as you wish

Mocking and testing made simple and consistent. Developed by Outbrain.

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)

 //.....
    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

//.....
    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

//.....
    Leonardo.deactivateState('Update Data');
//.....

Hide/Show Leonardo icon

You can hide Leonardo activator icon by clicking ctrl + shift + l.