Skip to content

Latest commit

 

History

History
54 lines (33 loc) · 1.84 KB

README.md

File metadata and controls

54 lines (33 loc) · 1.84 KB
Raw

This is a Python implementation of the Specmatic Order BFF Service project.
The implementation is based on the Sanic framework.

The open api contract for the services is defined in the Specmatic Central Contract Repository

The order bff service internally calls the order api service (on port 9090).

The purpose of this project is to demonstrate how specmatic can be used to validate the contract of the bff service while stubbing out the order api service at the same time.

Dev Setup

  • Install Python 3.11 ( use homebrew if you are on mac os)

  • Install JRE 17 or later

  • Install pip

  • Install virtualenv by running:
    pip install virtualenv

  • Clone the git repository

  • Virtual Environment Setup

    • Create a "virtual environment" named 'venv' by running:
      virtualenv venv

      This will create a virtual environment using the default python installation.
      If you wish to provide a specific python installation, run:
      virtualenv venv --python="/opt/homebrew/opt/python@3.8/libexec/bin/python"

    • To activate your virtual environment, execute this from a terminal window in your root folder:
      source venv/bin/activate

  • Install project requirements
    From a terminal window in your root folder, run:
    pip install -r requirements.txt

  • Run Tests
    Download the Specmatic standalone jar from the specmatic website
    Open a terminal window in the root folder and run:
    pytest test -v -s

    If you see any errors regarding missing pcakages, try reloading the virtual env:
    deactivate
    source venv/bin/activate