Merge branch 'master' into example/01_setup_python_dependencies

Author: robles-jonathan

.gitignore

@@ -128,3 +128,5 @@ dmypy.json
 # Pyre type checker
 .pyre/
 .idea
+.vscode/
+data/

Pipfile

@@ -8,6 +8,13 @@ verify_ssl = true
 [packages]
 requests = "*"
 pytest = "*"
+assertpy = "*"
+lxml = "*"
+jsonpath-ng = "*"
+cerberus = "*"
+reportportal-client = "*"
+pytest-reportportal = "*"
+pytest-xdist = {extras = ["psutil"], version = "*"}
 
 [requires]
 python_version = "3.10"

Pipfile.lock

@@ -1,2 +1,75 @@
-# course-api-framework-python
-TAU course on Building an API framework with python
+# Building an API test automation framework with Python
+
+## Purpose
+
+Code for TAU (Test automation university) course on building an API framework with Python. Once
+ready this would be published at
+[Test automation university](https://testautomationu.applitools.com/), You can also find a series of
+blogs that I'm writing for this course on my blog
+[https://automationhacks.io/](https://automationhacks.io/tags/) under `Python` tag. However, the
+video courses are going to have much more context and in depth discussions
+
+## Setup
+
+Ensure you have
+[pipenv already installed](https://automationhacks.io/2020/07/12/how-to-manage-your-python-virtualenvs-with-pipenv/):
+
+```zsh
+# Activate virtualenv
+pipenv shell
+# Install all dependencies in your virtualenv
+pipenv install
+```
+
+## How to navigate
+
+Each chapter has its own dedicated branch in `/example/<chapter_no>_<topic>` format. For e.g.
+`example/01_setup_python_dependencies`
+
+You can either use your IDE or terminal to switch to that branch and see the last updated commit.
+
+```zsh
+# Checkout the entire branch
+git checkout example/01_setup_python_dependencies
+# Checkout to a specific commit, here <sha> can be found using `git log` command
+git checkout <sha>
+```
+
+## Application under test
+
+This automated test suite covers features of `people-api`, Please refer the Github repo
+[here](https://github.com/automationhacks/people-api).
+
+Note: These tests expect the `people-api` and `covid-tracker` API to be up. You would find
+instructions in the `people-api` repo
+
+## How to run
+
+```zsh
+# Setup report portal on docker
+# Update rp_uuid in pytest.ini with project token
+docker-compose -f docker-compose.yml -p reportportal up -d
+
+# Launch pipenv
+pipenv shell
+
+# Install all packages
+pipenv install
+
+# Run tests via pytest (single threaded)
+python -m pytest
+
+# Run tests in parallel
+python -m pytest -n auto
+
+# Report results to report portal
+python -m pytest -n auto ./tests --reportportal
+```
+
+## Discuss?
+
+Feel free to use the
+[Github discussions](https://github.com/automationhacks/course-api-framework-python/discussions/1)
+in this repo to ✍🏼 your thoughts or even use the disqus comments section on the blogs.
+
+Happy learning!

README.md

@@ -0,0 +1,6 @@
+class BaseClient:
+    def __init__(self):
+        self.headers = {
+            'Content-Type': 'application/json',
+            'Accept': 'application/json'
+        }

clients/__init__.py

@@ -0,0 +1,45 @@
+from json import dumps
+from uuid import uuid4
+
+from clients.people.base_client import BaseClient
+from config import BASE_URI
+from utils.request import APIRequest
+
+
+class PeopleClient(BaseClient):
+    def __init__(self):
+        super().__init__()
+
+        self.base_url = BASE_URI
+        self.request = APIRequest()
+
+    def create_person(self, body=None):
+        last_name, response = self.__create_person_with_unique_last_name(body)
+        return last_name, response
+
+    def __create_person_with_unique_last_name(self, body=None):
+        if body is None:
+            last_name = f'User {str(uuid4())}'
+            payload = dumps({
+                'fname': 'New',
+                'lname': last_name
+            })
+        else:
+            last_name = body['lname']
+            payload = dumps(body)
+
+        response = self.request.post(self.base_url, payload, self.headers)
+        return last_name, response
+
+    def read_one_person_by_id(self, person_id):
+        pass
+
+    def read_all_persons(self):
+        return self.request.get(self.base_url)
+
+    def update_person(self):
+        pass
+
+    def delete_person(self, person_id):
+        url = f'{BASE_URI}/{person_id}'
+        return self.request.delete(url)

clients/people/__init__.py

@@ -0,0 +1,2 @@
+BASE_URI = 'http://0.0.0.0:5000/api/people'
+COVID_TRACKER_HOST = 'http://127.0.0.1:3000'