https://github.com/znsio/specmatic-order-api-grpc-kotlin

Specmatic gRPC Sample
https://github.com/znsio/specmatic-order-api-grpc-kotlin

contract-testing grpc grpc-server specmatic

Last synced: about 1 month ago
JSON representation

Specmatic gRPC Sample

• Host: GitHub
• URL: https://github.com/znsio/specmatic-order-api-grpc-kotlin
• Owner: znsio
• Created: 2024-06-26T11:13:37.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-08-28T09:20:38.000Z (4 months ago)
• Last Synced: 2024-08-28T10:42:04.021Z (4 months ago)
• Topics: contract-testing, grpc, grpc-server, specmatic
• Language: Kotlin
• Homepage: https://specmatic.in
• Size: 2.02 MB
• Stars: 0
• Watchers: 7
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Specmatic Order API gRPC Sample

This sample project demonstrates [Specmatic](https://specmatic.io/) **gRPC support** which allows you to use your **proto files for Contract Testing**.

[Specmatic](https://specmatic.io/) **gRPC support** can also help you use your proto files for service mocking, #nocode backward compatibility testing and more.

The **specmatic-order-api-grpc-kotlin** is a gRPC server application developed according to the following proto files, which can be found in the central contract repository:

* [order.proto](https://github.com/znsio/specmatic-order-contracts/blob/main/io/specmatic/examples/store/grpc/order_api/order.proto)

* [product.proto](https://github.com/znsio/specmatic-order-contracts/blob/main/io/specmatic/examples/store/grpc/order_api/product.proto)

The `ContractTest` class demonstrates how to use Specmatic to test **specmatic-order-api-grpc-kotlin** gRPC server app using the above proto files.

## Requirements

* Java 17 or later

## Project Setup

1. Clone the repository

   ```shell

   git clone https://github.com/znsio/specmatic-order-api-grpc-kotlin

   ```

2. Initialize and update the `specmatic-order-contracts` submodule

   ```shell

   git submodule update --init --recursive --remote

   ```

3. Enable automatic submodule updating when executing `git pull`

   ```shell

   git config submodule.recurse true

   ```

4. To run contract tests, 

   1. Using gradle - `./gradlew clean test`

   2. Using docker -

      - Run the application using `./gradlew bootRun`

      - Run the tests

      ```shell

      docker run --network host -v "$(pwd)/specmatic.yaml:/usr/src/app/specmatic.yaml" -v "$(pwd)/build/reports/specmatic:/usr/src/app/build/reports/specmatic" -v "$PWD/src/test/resources/specmatic:/usr/src/app/examples" -e SPECMATIC_GENERATIVE_TESTS=true znsio/specmatic-grpc-trial test --port=9090 --host=host.docker.internal --examples=examples

      ```

5. In case you want to run just the gRPC server using Gradle you can execute

   ```shell

   ./gradlew bootRun

   ```