feature: add test client for sample ecommerce service (metlo-labs#64)

Author: NikhilShahi

sample-service/sample-client/Dockerfile

@@ -0,0 +1,16 @@
+# syntax=docker/dockerfile:1
+
+FROM python:3.8-slim-buster
+
+ENV key=default_key
+ENV backend=default_backend
+ENV rps=15
+
+WORKDIR /app
+
+COPY requirements.txt requirements.txt
+RUN pip3 install -r requirements.txt
+
+COPY . .
+
+CMD python3 main.py -key ${key} -b ${backend} -r ${rps}

sample-service/sample-client/main.py

@@ -0,0 +1,78 @@
+import argparse
+import time
+import os
+import requests
+import concurrent.futures
+from datetime import datetime, timedelta, timezone
+from urllib.parse import urljoin
+from dotenv import load_dotenv
+
+from producers.ecommerce.utils import get_products, get_carts
+
+from producers import PRODUCER_CLS_MAP
+
+
+load_dotenv()
+
+tick_length = timedelta(seconds=1)
+
+
+PRODUCER_MAP = {
+    k: producer_cls(tick_length) for k, producer_cls in PRODUCER_CLS_MAP.items()
+}
+PRODUCERS = PRODUCER_MAP.values()
+
+def execute_request(point, backend, api_key):
+    path = point["path"]
+    url = urljoin(backend, path)
+    headers = {"x-api-key": api_key} if point["header"] else {}
+    try:
+        if point["method"] == "post":
+            print
+            body = point["body"]
+            r = requests.post(
+                url, json=body, headers=headers
+            )
+            r.raise_for_status()
+        elif point["method"] == "get":
+            params = point["params"]
+            r = requests.get(
+                url, params=params, headers=headers
+            )
+            r.raise_for_status()
+    except requests.exceptions.HTTPError as err:
+        pass
+
+def run(backend, api_key, rps):
+    while True:
+        print("Tick")
+
+        current_time = datetime.now(timezone.utc)
+        products = get_products(backend, api_key)
+        carts = get_carts(backend, api_key)
+
+        for k, producer in PRODUCER_MAP.items():
+            if not producer.should_emit(current_time):
+                continue
+            data_points = producer.get_data_points(current_time, products, carts, rps)
+            if data_points:
+                print(f"Producer {k} emitted {len(data_points)} data points.")
+            if not data_points:
+                continue
+            with concurrent.futures.ThreadPoolExecutor() as executor:
+                futures = []
+                for point in data_points:
+                    futures.append(executor.submit(execute_request, point=point, backend=backend, api_key=api_key))
+
+        time.sleep(tick_length.total_seconds())
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser()
+    parser.add_argument("-b", "--metlo_backend", required=True)
+    parser.add_argument("-key", "--api_key", required=True)
+    parser.add_argument("-r", "--rps", required=True)
+    args = parser.parse_args()
+    metlo_backend = args.metlo_backend
+    api_key = args.api_key
+    rps = int(args.rps)
+    run(metlo_backend, api_key, rps)

sample-service/sample-client/producers/__init__.py

@@ -0,0 +1,20 @@
+from producers.ecommerce.get_cart import EcommerceGetCartProducer
+from producers.ecommerce.get_product import EcommerceGetProductProducer
+from producers.ecommerce.login import EcommerceLoginProducer
+from producers.ecommerce.make_purchase import EcommerceMakePurchaseProducer
+from producers.ecommerce.new_product import EcommerceMakeProductProducer
+from producers.ecommerce.new_cart import EcommerceMakeCartProducer
+from producers.ecommerce.add_product_to_cart import EcommerceAddProductToCartProducer
+from producers.ecommerce.register import EcommerceRegisterProducer
+
+
+PRODUCER_CLS_MAP = {
+    "ecommerce_add_product_to_cart": EcommerceAddProductToCartProducer,
+    "ecommerce_make_cart": EcommerceMakeCartProducer,
+    "ecommerce_make_product": EcommerceMakeProductProducer,
+    "ecommerce_make_purchase": EcommerceMakePurchaseProducer,
+    "ecommerce_login": EcommerceLoginProducer,
+    "ecommerce_register": EcommerceRegisterProducer,
+    "ecommerce_get_product": EcommerceGetProductProducer,
+    "ecommerce_get_cart": EcommerceGetCartProducer,
+}

sample-service/sample-client/producers/base.py

@@ -0,0 +1,25 @@
+from typing import List
+from datetime import datetime, timedelta
+from random import random
+from faker import Faker
+from faker.providers import internet
+
+
+class BaseProducer:
+
+    avg_emit_delta = timedelta(minutes=5)
+
+    def __init__(self, tick_length: timedelta):
+        self.tick_length = tick_length
+        self.fake = Faker()
+        self.fake.add_provider(internet)
+
+    def should_emit(self, time: datetime) -> bool:
+        emit_probability = self.tick_length / self.avg_emit_delta
+        return random() < emit_probability
+
+    def get_data_point(self, time: datetime) -> dict:
+        raise NotImplementedError()
+
+    def get_data_points(self, time: datetime) -> List[dict]:
+        return [self.get_data_point(time)]

sample-service/sample-client/producers/ecommerce/add_product_to_cart.py

@@ -0,0 +1,29 @@
+from datetime import datetime, timedelta
+import os
+from typing import List
+from random import choice
+
+from producers.base import BaseProducer
+
+
+class EcommerceAddProductToCartProducer(BaseProducer):
+
+    avg_emit_delta = timedelta(seconds=1)
+
+    def get_data_points_helper(self, products: dict, carts: dict) -> dict:
+        product_uuid = choice(list(products.values()))["uuid"] if len(products) > 0 else None
+        cart_uuid = choice(list(carts.values()))["uuid"] if len(carts) > 0 else None
+        req_body = {
+            "productUuid": product_uuid,
+        }
+        return {
+            "method": "post",
+            "path": f"/cart/{cart_uuid}/add-product",
+            "body": req_body,
+            "header": True
+        }
+
+    def get_data_points(self, time: datetime, products=None, carts=None, rps=15) -> List[dict]:
+        if len(products) <= 1 or len(carts) <= 1:
+            return None
+        return [self.get_data_points_helper(products, carts) for _ in range(rps)]

sample-service/sample-client/producers/ecommerce/get_cart.py

@@ -0,0 +1,25 @@
+from datetime import datetime, timedelta
+import os
+from random import choice
+from typing import List
+
+from producers.base import BaseProducer
+
+
+class EcommerceGetCartProducer(BaseProducer):
+
+    avg_emit_delta = timedelta(seconds=1)
+
+    def get_data_points_helper(self, carts: dict) -> dict:
+        cart_uuid = choice(list(carts.values()))["uuid"] if len(carts) > 0 else ""
+        return {
+            "method": "get",
+            "path": f"/cart/{cart_uuid}",
+            "params": {},
+            "header": True
+        }
+
+    def get_data_points(self, time: datetime, products=None, carts=None, rps=15) -> List[dict]:
+        if len(carts) <= 1:
+            return None
+        return [self.get_data_points_helper(carts) for _ in range(rps)]

sample-service/sample-client/producers/ecommerce/get_product.py

@@ -0,0 +1,23 @@
+from datetime import datetime, timedelta
+import os
+from random import choice
+from typing import List
+
+from producers.base import BaseProducer
+
+
+class EcommerceGetProductProducer(BaseProducer):
+
+    avg_emit_delta = timedelta(seconds=2)
+
+    def get_data_points_helper(self, products: dict) -> dict:
+        product_uuid = choice(list(products.values()))["uuid"] if len(products) > 0 else ""
+        return {
+            "method": "get",
+            "path": f"/product/{product_uuid}",
+            "params": {},
+            "header": False
+        }
+
+    def get_data_points(self, time: datetime, products=None, carts=None, rps=15) -> List[dict]:
+        return [self.get_data_points_helper(products) for _ in range(rps)]

sample-service/sample-client/producers/ecommerce/login.py

@@ -0,0 +1,24 @@
+from datetime import datetime, timedelta
+from typing import List
+
+from producers.base import BaseProducer
+
+
+class EcommerceLoginProducer(BaseProducer):
+
+    avg_emit_delta = timedelta(minutes=5)
+
+    def get_data_points_helper(self) -> dict:
+        req_body = {
+            "email": self.fake.free_email(),
+            "password": self.fake.sentence(nb_words=5),
+        }
+        return {
+            "method": "post",
+            "path": "/login",
+            "body": req_body,
+            "header": False
+        }
+
+    def get_data_points(self, time: datetime, products=None, carts=None, rps=8) -> List[dict]:
+        return [self.get_data_points_helper() for _ in range(8)]

sample-service/sample-client/producers/ecommerce/make_purchase.py

@@ -0,0 +1,34 @@
+from datetime import datetime, timedelta
+import os
+from typing import List
+from random import choice
+
+from producers.base import BaseProducer
+
+
+class EcommerceMakePurchaseProducer(BaseProducer):
+
+    avg_emit_delta = timedelta(seconds=1)
+
+    def get_data_points_helper(self, carts: dict) -> dict:
+        cart_uuid = choice(list(carts.values()))["uuid"] if len(carts) > 0 else ""
+        ccn = self.fake.credit_card_number()
+        req_body = {
+            "firstName": self.fake.first_name(),
+            "lastName": self.fake.first_name(),
+            "ccn": ccn,
+            "expirationDate": self.fake.credit_card_expire(),
+            "code": self.fake.credit_card_security_code(),
+            "address": self.fake.address(),
+        }
+        return {
+            "method": "post",
+            "path": f"/cart/{cart_uuid}/purchase",
+            "body": req_body,
+            "header": True
+        }
+
+    def get_data_points(self, time: datetime, products=None, carts=None, rps=15) -> List[dict]:
+        if len(carts) <= 1:
+            return None
+        return [self.get_data_points_helper(carts) for _ in range(rps)]

sample-service/sample-client/producers/ecommerce/new_cart.py

@@ -0,0 +1,20 @@
+from datetime import datetime, timedelta
+from typing import List
+
+from producers.base import BaseProducer
+
+
+class EcommerceMakeCartProducer(BaseProducer):
+
+    avg_emit_delta = timedelta(seconds=1)
+
+    def get_data_points_helper(self) -> dict:
+        return {
+            "method": "post",
+            "path": "/cart/new",
+            "body": {},
+            "header": True
+        }
+
+    def get_data_points(self, time: datetime, products=None, carts=None, rps=8) -> List[dict]:
+        return [self.get_data_points_helper() for _ in range(8)]

sample-service/sample-client/producers/ecommerce/new_product.py

@@ -0,0 +1,27 @@
+from datetime import datetime, timedelta
+from typing import List
+from random import randint
+
+from producers.base import BaseProducer
+
+
+class EcommerceMakeProductProducer(BaseProducer):
+
+    avg_emit_delta = timedelta(seconds=1)
+
+    def get_data_points_helper(self) -> dict:
+        req_body = {
+            "name": self.fake.word(),
+            "description": self.fake.sentence(),
+            "warehouseAddress": self.fake.address(),
+            "price": randint(100, 1000),
+        }
+        return {
+            "method": "post",
+            "path": "/product/new",
+            "body": req_body,
+            "header": True
+        }
+
+    def get_data_points(self, time: datetime, products=None, carts=None, rps=8) -> List[dict]:
+        return [self.get_data_points_helper() for _ in range(8)]

sample-service/sample-client/producers/ecommerce/register.py

@@ -0,0 +1,29 @@
+from datetime import datetime, timedelta
+from typing import List
+
+from producers.base import BaseProducer
+
+
+class EcommerceRegisterProducer(BaseProducer):
+
+    avg_emit_delta = timedelta(minutes=10)
+
+    def get_data_points_helper(self) -> dict:
+        req_body = {
+            "firstName": self.fake.first_name(),
+            "lastName": self.fake.first_name(),
+            "email": self.fake.free_email(),
+            "address": self.fake.address(),
+            "phoneNumber": self.fake.phone_number(),
+            "dob": self.fake.date_of_birth().isoformat(),
+            "password": self.fake.sentence(nb_words=5),
+        }
+        return {
+            "method": "post",
+            "path": "/register",
+            "body": req_body,
+            "header": False
+        }
+
+    def get_data_points(self, time: datetime, products=None, carts=None, rps=8) -> List[dict]:
+        return [self.get_data_points_helper() for _ in range(8)]

sample-service/sample-client/producers/ecommerce/utils.py

@@ -0,0 +1,27 @@
+from urllib.parse import urljoin
+import requests
+
+def get_products(backend, api_key):
+    try:
+        r = requests.get(
+            urljoin(backend, "/product"), headers={ "x-api-key": api_key }
+        )
+        r.raise_for_status()
+        res = r.json()
+        del res["ok"]
+        return res
+    except requests.exceptions.HTTPError as err:
+        return {}
+
+def get_carts(backend, api_key):
+    try:
+        r = requests.get(
+            urljoin(backend, "/cart"), headers={ "x-api-key": api_key }
+        )
+        r.raise_for_status()
+        res = r.json()
+        del res["ok"]
+        return res
+    except requests.exceptions.HTTPError as err:
+        return {}
+

sample-service/sample-client/requirements.txt

@@ -0,0 +1,3 @@
+faker
+requests
+python-dotenv