BDD eMSP Tester via OCPI 2.2.1

eMSP Tester is written to simulate requests from CPO to eMSP according OCPI 2.2.1 specification. Application uses Cucumber testing framework.

Cucumber is a behavior-driven development (BDD) testing framework that uses the Gherkin language to write test cases in a human-readable format. With the CPOs requests simulator on Cucumber, test cases can be written in Gherkin and automated using Cucumber's testing framework.

The simulator provides a set of predefined OCPI REST requests that can be sent and received by CPO. These requests include HTTP requests: GET, POST, PUT, PATCH, DELETE as OCPI specification based on REST API.

Technologies used

• Spring Boot
• Cucumber for Java
• Extrawest-OCPI-2.2.1-CPO-Server
• Rest-assured
• Testcontainers
• Docker

Requirements

• Java 17 or higher
• Maven 3.6 or higher

Features

Requests Initiated by CPO:

• Get Versions

• Get Version Details

• Get Credentials

• Post Credentials

• Put Credentials

• Delete Credentials

• Get Location/EVSE/Connector

• Push Location/EVSE/Connector

• Patch Location/EVSE/Connector

• Get Tokens

• Post Token (for real-time authorization)

• Get Session

• Post Session

• Patch Session

• Post Command (eMSP gets result of command from CPO)

• Get Tariff

• Put Tariff

• Delete Tariff

• Get CDR

• Post CDR (Charge Detail Record)

• Post Charging Profile

• Put Charging Profile

Installation

Install 1/2: Add this to pom.xml:

<dependency>
    <groupId>com.extrawest</groupId>
    <artifactId>bdd_ocpi2.2.1_cpo</artifactId>
</dependency>

Run Docker on machine to be able to use Test DB in docker container.

Install 2/2: Run via command line

mvn install

Setup

You need to set port via application.properties. For example:

server.port=3000

Running Tests

1. You need to create a feature file. The file should be located in 'src/test/resources/features'.
2. You need to write a test scenario.
3. Run the scenario.

Or you can copy scenario script from the folder. Just change data and run

Given

All text in steps is case-sensitive.

Run Docker container and populate Mongo DB for eMSP Server

If your eMSP Server has MongoDB as source of data, you can use Given Step to populate Test Database, e.g.:

Given eMSP has "tariffs" data "db/tariffs.json"

For this step to work correctly you need to run Docker on your machine, otherwise you will see error log "Could not find a valid Docker environment". Put your json scripts with mongo collections or use scripts from the folder

Before all tests TestContainer creates Mongo Docker Container and waits log message "Connection accepted" two times. The first "Connection accepted" means that current BDD application is connected to Mongo BD, the second - eMSP Server, that is under testing, connects to Mongo DB Container. To connect eMSP Server to test Mongo DB Container you need to provide credentials in eMSP Server's properties file.

spring.data.mongodb.host=localhost
spring.data.mongodb.port=27018
spring.data.mongodb.database=test
spring.data.mongodb.auto-index-creation=true

Mongo Container is created based on mongo:6.0.3 Docker image and has exposed container's port 27017 to hosts port 27017.

When

Provided query parameters, headers and path parameter are stored in scope of scenario. So parameters can be provided in first step and omitted in next steps. E.g:

  When CPO with "party_id" "BEC" and "country_code" "DE" removes his "tariff" with "tariff_id" "Green5"
  Then "tariff" is absent

Most OCPI requests has required query parameters "party_id", " country_code", Client Owned Object's id. In case HTTP request required more query or path parameters they can be provided in separate steps, e.g.:

  When "date_from" path param is "2022-01-01T07:15:10"
  And "date_to" path param is "2025-10-24T07:15:10"
  And "limit" query param is "3"
  And CPO checks "tokens" in eMSP system

To provide HTTP body in request:

  Given CPO with "party_id" "BEC" and "country_code" "DE" put "tariff" with "tariff_id" "Green5" in eMSP system with data
    | country_code | DE                  |
    | party_id     | BEC                 |
    | id           | Green5              |
    | currency     | any                 |
    | elements     | any                 |
    | last_updated | 2022-06-05T20:39:09 |

Samples of available steps:

PUT

    When CPO with "party_id" "BEC" and "country_code" "DE" put "tariff" with "tariff_id" "Green5" in eMSP system with data

    When CPO with "party_id" "BEC" and "country_code" "DE" put "tariff" in eMSP system with data

    When CPO with "party_id" "BEC" put "tariff" in eMSP system with data

    When CPO updates "tariff"

POST

    When CPO post "cdr" with "id" "5" in eMSP system with data

    When CPO post "command" in eMSP system with data

DELETE

    When CPO with "party_id" "BEC" and "country_code" "DE" removes his "tariff" with "tariff_id" "Green5"

    When CPO removes his "tariff"

GET

    When CPO with "party_id" "BEC" and "country_code" "DE" checks "tariff" with "tariff_id" "Green5" in eMSP system

    When CPO checks "version details" with "version" "2.2.1" in eMSP system

    When CPO checks "evse" in eMSP system

Then

To check eMSP response next steps can be used:

  Then response is success

  Then eMSP responded with HTTP status 404

  Then eMSP responded with OCPI status 2000

  Then "tariff" is absent

  Then "evse" response is valid and has data
    | uid                | 3256                                                                                                                                                                                    |
    | evse_id            | BE*BEC*E041503001                                                                                                                                                                       |
    | status             | AVAILABLE                                                                                                                                                                               |
    | capabilities       | ["RESERVABLE"]

  Then list of tokens response is valid and is
    | country_code | party_id | uid                      | type | contract_id    | visual_number     | issuer       | group_id        | valid | whitelist | last_updated        |
    | NL           | TNM      | 65383539b7e8d40c369f9931 | RFID | NL8ACC12E46L89 | DF000-2001-8999-1 | TheNewMotion | DF000-2001-8999 | true  | ALWAYS    | 2022-06-05T20:39:09 |
    | BE           | BEC      | 65383539b7e8d40c369f9932 | RFID | NL8ACC12E46L89 | DF000-2001-8999-1 | TheNewMotion | DF000-2001-8999 | true  | ALWAYS    | 2022-06-05T20:39:09 |

Message's parameters

According to OCPI documentation messages can have required and optional parameters.

All required fields must be specified, optional fields - optional.

Validation

A receiving message and the specified parameters will be validated according to OCPI documentation.

Assertion

If parameters are specified then all received data in message will be asserted to these parameters.

Wildcard

Parameters can be specified as wildcard(by default 'any').

      | currentTime | any |

For the receiving message this means that current field must have any value(can't be Null).

For the sending message - current field value will be set to random generated values.