Mojaloop Functional Testing

This repository holds the test cases for the different business features offered by Mojaloop. The framework chosen to implement this automated testing is Cucumber and using Java as the underlying implementation language. The below section gives a brief overview on how Cucumber is used in this testing.

The 2 main files that you will see across these tests are

• Gherkin Features
• Step Definitions.

Gherkin Features:

This is the first step where the business features that are provided by Mojaloop Application are captured in a language called Gherkin. The recommended approach is to create a separate Gherkin file per feature. Each Gherkin feature file will be further having more scenarios describing different variations of the feature. Each scenario takes the form of a

Given - Provided these conditions exist
When - an action is taken
Then - these results should be expected

Illustrating the usage of a Gherkin scenario using a sample business feature, User lookup, in Mojaloop.

Feature: User Lookup
    As a payer FSP
    I should be able to lookup for a receiver MSISDN
    So that I can proceed further in P2P Money Transfer
    
Scenario: 
    Given the receiver is registered in the central lookup application
    When I do a lookup based on receiver MSISDN
    Then the switch should provide receiver details like name, DOB etc..

Step Definitions:

This is the second step where you provide the test case implementation of the Gherkin Features. For Mojaloop, we are using Cucumber-Java for this implementation. Without going into the finer details of Cucumber implementation, as a tester you will define logic for the Given/When/Then in the StepDefinition file.

Using the above Gherkin scenario example, the below snipped of code from the StepDefinition illustrates the usage:

UserLookupStepDefs.java

@Given("^the receiver is registered in the central lookup application$")
public void receiverIsRegistered() throws Throwable {
    //Logic
}

@When("^I do a lookup based on receiver MSISDN \"([^"]*)\"$")
public void receiverLookup(String fsp, String msisdn, String fullName, String firstName, String lastName, String dob) throws Throwable {
    //Logic
}

@Then("^the switch should provide receiver details like name, DOB etc.$")
public void receiverDetails(String expectedName, String expectedDOB) throws Throwable {
    //Logic
}

Given this brief overview about Gherkin and how it is impleemnted in Cucumber, the following sections talk about Installing the required software to run these tests, Steps to run the tests and an overview of the reports that will be generated.

##Contents:

• Required Software
• Setup Overview
• Running Tests
• Reports

Required Software

1. JDK 1.8 or later

2. Apache Maven

3. Any IDE (Steps are included for Intellij and Eclipse)

   3.1 Intellij Community/Ultimate Edition

   • Please refer to this link Cucumber support in Intellij to Enable Cucumber support in Intellij using Maven.
   • If not enabled by default, go to File -> Settings -> File Types. Select Cucumber Scenario and in Registered Patterns add '.feature".

   3.2 Eclipse

   • Once Eclipse is installed, Cucumber plugin needs to be installed. Click Help -> Install New Software and click "Add" in the "Work With" section.
   • In the next screen to Add Repository, use "http://cucumber.github.com/cucumber-eclipse/update-site" in the Location field.
   • In the next screen, click "Cucumber Eclipse Plugin" to install the plugin.

4. ngrok (Optional. If you plan to run test cases from laptop)

SetupOverview

The below diagram represents the different components that are part of this testing setup.

• PayerFSP Simulator, PayeeFSP Simulator: Mock Simulators that represent Payer and Payee FSPs that are used to receive the callbacks from Mojaloop switch and also to return default payer/payee details and quote responses. These simulators are developed using Spring Boot framework and are provisioned once the tests are started using maven.
• Cucumber: Represents the Cucumber-Java Step Definitions that sends the requests to the Switch and query PayerFSP/PayeeFSP for the callback responses.
• Switch: Represents Mojaloop Switch against which all these test cases are executed.

Folder Structure

• /src/main/java

  • com.mojaloop.fsp - This package contains the classes PayerFsp and PayeeFsp. These are the Spring Boot Applications that simulate the functionality provided by a Payer and a Payee FSP respectively.
  • com.mojaloop.utils - This package contains Utility class. This class contains methods to wrap asynchronous callbacks from Mojaloop Switch into synchronous request-response behavior.

• /test/resources/features - The sub-folders in here each represent different business feature offered by Mojaloop application. These sub-folders in turn contain 1 or more Gherkin feature files.

• /test/java/stepdefs - The sub-folders and the corresponding Classes in here has the code that implement Step Definitions in Cucumber Java.

Running Tests

There are different ways in which these tests can be executed.

• From IDE - Intellij:

  • Doing a Right-Click on the feature files gives you different options to run the entire frature or a specific scenario.

• From IDE - Eclipse:

• From Command Line:

  • Apache maven should be successfully installed to run this command
  • From the command line go to the directory of these tests, type mvn clean verify to trigger the tests.
  • To run specific tags, use this command mvn clean verify -Dcucumber.options=""--tags @<tag-name>"