first cut of working code with get response

Author: nareshnavinash

Data/DynamicData/sample.yml

@@ -0,0 +1,3 @@
+created_from: snap mode in pyrest framework
+test_sample_get_request_001:
+  name: Naresh

Library/api.py

@@ -1,34 +1,72 @@
 import allure
 import requests
+import yaml
+import os.path
+
 from Library.variable import Var
 from Library.store import Store
 
 
 class Api:
-    URL = None
-    endpoint = None
-    params = None
-    response = None
-
-    def __init__(self, url):
-        Api.URL = url
-
-    @classmethod
-    def get(cls, **kwargs):
-        response = requests.get(Api.URL + Api.endpoint, Api.params, **kwargs)
-        allure.step("Response for Get with " + Api.endpoint)
-        allure.step("Get request Prams " + str(Api.params))
-        allure.step("Other get Args " + str(**kwargs))
-        allure.attach(response.status_code, name="Response Status Code")
-        allure.attach(response.headers, name="Response Headers")
-        allure.attach(response.text, name="Response Text")
-        allure.attach(response.json(), name="Response JSON")
-        Api.response = response
-
-    @classmethod
-    def set_end_point(cls, endpoint):
-        Api.endpoint = endpoint
-
-    @classmethod
-    def set_params(cls, params):
-        Api.params = params
+
+    @staticmethod
+    def get(endpoint, params=None, **kwargs):
+        url = Var.current("URL")
+        with allure.step("Get request with the url " + url + endpoint):
+            response = requests.get(url + endpoint, params, **kwargs)
+        with allure.step("Response for Get with " + endpoint + " " + str(params)):
+            allure.attach(str(**kwargs), name="Other arguments passed for get request")
+            allure.attach(str(response.status_code), name="Response Status Code")
+            allure.attach(str(response.headers), name="Response Headers")
+            allure.attach(str(response.text), name="Response Text")
+            allure.attach(str(response.json()), name="Response JSON")
+            Store.current_response = response
+            return response
+
+    @staticmethod
+    def verify_response_code(status_code):
+        with allure.step("Validating the status code for the request"):
+            result = Store.current_response.status_code == status_code
+            assert (result is True), "Response status code is not matched, \n" \
+                                     "expected: " + status_code + "\n" \
+                                     "actual: " + Store.current_response.status_code
+
+    @staticmethod
+    def create_file_if_not_present(file_path):
+        if Var.env("snap") == "1":
+            if not os.path.isfile(file_path):
+                with open(file_path, 'w') as file:
+                    documents = yaml.dump({'created_from': 'snap mode in pyrest framework'}, file)
+                    print(documents)
+
+    @staticmethod
+    def dump_in_dynamic_variable_file(file_path, params):
+        if Var.env("snap") == "1":
+            with open(file_path, 'w') as file:
+                documents = yaml.dump(params, file)
+                print(documents)
+
+    @staticmethod
+    def verify_response_json(file_name, key_name):
+        expected_json = {}
+        file_path = Var.root_path() + "/Data/DynamicData/" + file_name
+        Api.create_file_if_not_present(file_path)
+        with open(file_path) as file:
+            yaml_load = yaml.load(file, Loader=yaml.FullLoader)
+        with allure.step("Validating the response json with stored value"):
+            allure.attach.file(file_path, name=file_name, attachment_type=allure.attachment_type.TEXT)
+            allure.attach(str(Store.current_response.json()), name="Response JSON")
+            try:
+                expected_json = yaml_load[key_name]
+                if Var.env("snap") == "1":
+                    yaml_load[key_name] = Store.current_response.json()
+                Api.dump_in_dynamic_variable_file(file_path, yaml_load)
+            except Exception as e:
+                allure.attach(str(e), name="Error while fetching the key from expected yaml file")
+                if Var.env("snap") == "1":
+                    yaml_load[key_name] = Store.current_response.json()
+                Api.dump_in_dynamic_variable_file(file_path, yaml_load)
+            assert (expected_json == Store.current_response.json()), "Expected Json doesn't match with stored json" \
+                                                                     "file \nExpected: " + str(expected_json) + "\n" \
+                                                                     "Actual response: " \
+                                                                     "" + str(Store.current_response.json())

Library/variable.py

@@ -38,6 +38,10 @@ def __init__(self, file_name, file_type):
             except Exception as e:
                 print(e)
 
+    @staticmethod
+    def root_path():
+        return os.path.dirname(os.path.abspath(__file__)).replace("/Library", "")
+
     @staticmethod
     def env(string):
         try:

Tests/conftest.py

@@ -29,7 +29,7 @@ def pytest_configure(config):
     This hook is called for every plugin and initial conftest
     file after command line options have been parsed.
     """
-    print("*-* pytest_configure" + config)
+    print("*-* pytest_configure")
     # Configuring the selpy with data path location
     Store.global_data_path = os.path.dirname(
         os.path.abspath(__file__)).replace("/Tests", "") + '/Data/GlobalData/global_data.yml'
@@ -48,19 +48,19 @@ def pytest_sessionstart(session):
     Called after the Session object has been created and
     before performing collection and entering the run test loop.
     """
-    print("*-* pytest_sessionstart" + session)
+    print("*-* pytest_sessionstart")
 
 
 def pytest_sessionfinish(session, exitstatus):
     """
     Called after whole test run finished, right before
     returning the exit status to the system.
     """
-    print("*-* pytest_sessionfinish" + session + exitstatus)
+    print("*-* pytest_sessionfinish")
 
 
 def pytest_unconfigure(config):
     """
     called before test process is exited.
     """
-    print("*-* pytest_unconfigure" + config)
+    print("*-* pytest_unconfigure")

Tests/sample.py

@@ -0,0 +1,13 @@
+import allure
+import pytest
+from Library.api import Api
+
+
+@allure.feature("Sample get request")
+@allure.severity('Critical')
+@pytest.mark.regression  # Custom pytest marker to run the test cases with ease on demand
+@pytest.mark.snap  # Custom pytest marker to run the test cases with ease on demand
+def test_sample_get_request_001():
+    Api.get("/name")
+    Api.verify_response_code(200)
+    Api.verify_response_json("sample.yml", "test_sample_get_request_001")