MSL

MSL (pronounced 'Missile') stands for Mock Service Layer. Our tools enable quick local deployment of your UI code on Node and mocking of your service layer for fast, targeted testing.

Here is the link to getting started

Releases

We will be having monthly scheduled releases.

Release 1.0 - Scheduled for end of July

Contributing

We encourage contribution from the open source community to help make MSL better. Please refer to the development page for more information on how to contribute to this project including sign off and the DCO agreement.

If you have any questions or discussion topics, please post them on Google Groups.

Installing MSL Server

Local install

npm install msl-server

Global install

npm install -g msl-server

Starting MSL Server

If you installed it locally:

./node_modules/msl-server/bin/msl [options]

If you installed it globally:

msl [options]

Options for MSL Server:

• --port => specify the port that server will be listening on local host, default is 8000.
• --basedir => specify the root directory(absolute path) of the app you want to launch locally, default is the directory where you run the command.
• --debug => specify whether to output log in console or not, default is false.

Example:

msl --basedir=/approot --port=8001 --debug=true

Using MSL Clients

Node Client

Install Node client:

npm install msl-client

Use Node client in scripts

var msl = require('msl-client');

Browser Client

Download mockapi-browser.js

<script src="mockapi-browser.js"></script>

Java Client

Include 'msl-client-java' as maven dependency (snapshot version available in Sonatype)

<dependency>
  <groupId>org.finra.msl</groupId>
  <artifactId>msl-client-java</artifactId>
  <version>1.0-SNAPSHOT</version>
</dependency>

Building

Our project is built automatically on Travis-CI for all pull requests and merge requests.

To build the Java client, please use Maven. You can download Maven here.

# Clone MSL git repo
git clone git://github.com/FINRAOS/MSL.git
cd msl-client-java

# Run package to compile and create jar
mvn package

Running Tests

After you checkout the code, execute E2E tests by running scripts/e2e-run.sh from the root folder. This script will:

1. Install msl-server
2. Start sample app using msl-server
3. Build client
4. Run unit tests

License Type

MSL project is licensed under Apache License Version 2.0