Changing the endpoint to be caught from an environment variable.

Check the last commit to more information about the new return interface.

api/anticaptcha/cli.py

@@ -12,7 +12,7 @@ class AntiCaptcha:
     ep: str = ""
 
     def __init__(self) -> None:
-        self.ep = "https://localhost:8443"
+        self.ep = os.environ.get("REPLAY_ADDR")
     
         def __request_json_post__ (self, path: str, object: dict):
             """

api/apiproxy/cli.py

@@ -16,8 +16,24 @@ class API_Proxy:
 
     ep: str = ""
 
+    APIProxyRequest = {
+        "Name": None,
+        "Method": None,
+        "Url": None,
+        "Header": None,
+        "Body": None,
+        "Readonly": None
+    }
+
+    APIProxyResponse = {
+        "Status": None,
+        "StatusCode": None,
+        "Header": None,
+        "Body": None
+    }
+
     def __init__ (self):
-        self.ep = "https://localhost:8443"
+        self.ep = os.environ.get("REPLAY_ADDR")
     
     def __request_json_post__(self, path: str, object: dict):
 
@@ -36,18 +52,12 @@ class API_Proxy:
         headers = {"X-API-KEY": apikey}
         res = requests.post(url, json = object, headers = headers, verify = False)
 
-        response = json.loads(res.text)
+        if res.status_code >= 400:
+            raise Exception(f"HTTP ERROR: {str(res.status_code)} - {res.text}")
 
-        byte_encoded_body = base64.b64decode(response['body'])
-        decoded_body = str(byte_encoded_body, "utf-8")
+        
+        return json.loads(res.text)
 
-        if response['status_code'] >= 400:
-            raise Exception(f"HTTP ERROR: {str(response['status_code'])} - {response['body']}")
-
-        if response['header']['Content-Type'] != None and response['header']['Content-Type'].find('json') != -1:
-            return json.loads(decoded_body)
-        else:
-            return decoded_body
     
     def do (self, request: dict):
         """
@@ -56,7 +66,7 @@ class API_Proxy:
 
         ---
         #### Parâmetros:
-            - request: Estrutura específica da requisição. Veja abaixo como construí-la:
+            - request: Estrutura APIProxyRequest definida nesta mesma classe. Instancie-a e altere os valores das chaves de acordo com sua necessidade, veja abaixo como:
             
             {
                 "Name": "Nome de template da chamada",
@@ -82,8 +92,15 @@ class API_Proxy:
         
         ---
         #### Retorna:
-            -> Resultado da requisição
+            -> Estrutura APIProxyResponse já definida nesta classe.
         """
 
-        return self.__request_json_post__ ("/ipc/apiproxy/do", request)
+        do_response = self.__request_json_post__ ("/ipc/apiproxy/do", request)
+            
+        do_response["body"] = base64.b64decode(do_response["body"])
+        do_response["body"] = str(do_response["body"], "utf-8")
 
+        if do_response["header"]["Content-Type"].find("json") != -1:
+            do_response["body"] = json.loads(do_response["body"])
+        
+        return do_response

api/apiproxy/features/apiproxy.feature

@@ -1,12 +1,14 @@
 Feature: The API Proxy client
     Scenario: A HTTP request with json body response
         Given a API Proxy client
-        When a request is made with GET for the API: https://pokeapi.co/api/v2/pokemon/ditto
-        Then there must be a json response
-        And the pokemon name must be ditto
+        And an APIProxyRequest instance filled with the method GET for the API url: https://pokeapi.co/api/v2/pokemon/ditto
+        When a request is made with the previous instance
+        Then the body of this response must be a python dictionary
+        And the pokemon name, contained in the response body, must be ditto
     
 
     Scenario: A HTTP request with text body response
         Given a API Proxy client
-        When a request is made with GET for the API: https://www.slashdot.org
-        Then the response content type must be string
+        And an APIProxyRequest instance filled with the method GET for the API url: https://www.slashdot.org
+        When a request is made with the previous instance
+        Then the response body content type must be string

api/apiproxy/features/steps/steps.py

@@ -7,35 +7,33 @@ from cli import API_Proxy
 def step_impl(context):
     context.client = API_Proxy ()
 
-@when(u'a request is made with GET for the API: https://pokeapi.co/api/v2/pokemon/ditto')
+@given(u'an APIProxyRequest instance filled with the method GET for the API url: https://pokeapi.co/api/v2/pokemon/ditto')
 def step_impl(context):
-    context.response = context.client.do (
-        {
-            "Method": "GET",
-            "Url":    "https://pokeapi.co/api/v2/pokemon/ditto",
-	    }
-    )
+    context.request = context.client.APIProxyRequest
+    context.request["Method"] = "GET"
+    context.request["Url"] = "https://pokeapi.co/api/v2/pokemon/ditto"
 
-@then(u'there must be a json response')
+@when(u'a request is made with the previous instance')
 def step_impl(context):
-    assert type (context.response) == dict, "Something went wrong calling the pokemon/ditto API."
+    context.response = context.client.do (context.request)
 
-@then(u'the pokemon name must be ditto')
+@then(u'the body of this response must be a python dictionary')
 def step_impl(context):
-    assert context.response["forms"][0]["name"] == "ditto", "This pokemon is not Ditto."
+    assert type (context.response["body"]) == dict, "Something went wrong calling the pokemon/ditto API."
+
+@then(u'the pokemon name, contained in the response body, must be ditto')
+def step_impl(context):
+    assert context.response["body"]["forms"][0]["name"] == "ditto", "This pokemon is not Ditto."
 
 
 
 # =========================== TEXT RESPONSE BODY ===========================
-@when(u'a request is made with GET for the API: https://www.slashdot.org')
+@given(u'an APIProxyRequest instance filled with the method GET for the API url: https://www.slashdot.org')
 def step_impl(context):
-    context.response = context.client.do (
-        {
-            "Method": "GET",
-            "Url":    "https://www.slashdot.org",
-	    }
-    )
+    context.request = context.client.APIProxyRequest
+    context.request["Method"] = "GET"
+    context.request["Url"] = "https://www.slashdot.org"
 
-@then(u'the response content type must be string')
+@then(u'the response body content type must be string')
 def step_impl(context):
-    assert type (context.response) == str, "Something went wrong calling the slashdot API."
+    assert type (context.response["body"]) == str, "Something went wrong calling the slashdot API."

api/autohotkey/cli.py

@@ -16,7 +16,7 @@ class AutoHotKey:
     ep: str = ""
 
     def __init__ (self):
-        self.ep = "https://localhost:8443"
+        self.ep = os.environ.get("REPLAY_ADDR")
     
     def __request_raw_post__ (self, path: str, data: str = ""):
 

api/autoit/cli.py

@@ -16,7 +16,7 @@ class AutoIt:
     ep: str = ""
 
     def __init__ (self):
-        self.ep = "https://localhost:8443"
+        self.ep = os.environ.get("REPLAY_ADDR")
     
     def __request_raw_post__ (self, path: str, data: str = ""):
 

api/chrome/cli.py

@@ -21,7 +21,7 @@ class Chrome:
     ep: str = ""
 
     def __init__(self):
-        self.ep = "https://localhost:8443"
+        self.ep = os.environ.get("REPLAY_ADDR")
 
     def __request_get__(self, data: str):
 

api/excel/cli.py

@@ -13,7 +13,7 @@ class Excel:
     ep: str = ""
 
     def __init__ (self):
-        self.ep = "https://localhost:8443"
+        self.ep = os.environ.get("REPLAY_ADDR")
 
     def __request_json_post__ (self, path: str, object: dict):
 

api/ocr/cli.py

@@ -13,7 +13,7 @@ class Ocr:
     ep: str = ""
 
     def __init__ (self):
-        self.ep = "https://localhost:8443"
+        self.ep = os.environ.get("REPLAY_ADDR")
 
     def __request_json_post__ (self, path: str, object: dict):
 

api/replay/cli.py

@@ -16,7 +16,7 @@ class Replay:
     ep: str = ""
 
     def __init__ (self):
-        self.ep = "https://localhost:8443"
+        self.ep = os.environ.get("REPLAY_ADDR")
 
     def __request_get__ (self, data: str):
 

api/wingui/cli.py

@@ -17,7 +17,7 @@ class Wingui:
     ep: str = ""
 
     def __init__(self):
-        self.ep = "https://localhost:8443"
+        self.ep = os.environ.get("REPLAY_ADDR")
 
     def __requestget__(self, data: str):
 

api/wingui/features/steps/steps.py

@@ -0,0 +1,205 @@
+from time import sleep
+from behave import *
+from cli import Wingui
+
+# =========================== Clip_read & Clip_write ===========================
+@given(u'a winGUI client')
+def step_impl(context):
+    context.client = Wingui ()
+
+@when(u'the clip_write method is called to store the text "There is a light that never goes out"')
+def step_impl(context):
+    context.client.clip_write("There is a light that never goes out")
+
+@then(u'when the clip_read method is called, it must return the same text')
+def step_impl(context):
+    assert context.client.clip_read() == "There is a light that never goes out", "Something went wrong with the clipboard."
+
+
+
+# =========================== Screen_scale & Screen_size ===========================
+@when(u'the screen_scale method is called')
+def step_impl(context):
+    context.scale = context.client.screen_scale()
+
+@when(u'the screen_size method is also called')
+def step_impl(context):
+    context.size = context.client.screen_size()
+
+@then(u'the returns of both must be equal')
+def step_impl(context):
+    assert context.scale == context.size, "Something went wrong while getting the screen dimensions."
+
+# Please note that most of the other screen methods use image recognition and, because of that, it is not possible to test them on every computer, since there is no way to know wich images are being displayed on the screen.
+    # Also, the other methods wich do not use image recognition are simply too difficult to test.
+
+
+
+# =========================== Proc_exec & Proc_all ===========================
+@when(u'the proc_exec method is called with "mspaint"')
+def step_impl(context):
+    context.client.proc_exec("mspaint")
+
+@when(u'the proc_all method is called')
+def step_impl(context):
+    context.procs = context.client.proc_all()
+
+@then(u'there must be a process with the name "mspaint.exe" inside the list')
+def step_impl(context):
+    for proc in context.procs:
+        if "mspaint.exe" in proc["Name"]:
+            context.client.proc_kill(proc["Pid"])
+            assert True
+            return
+    
+    assert False, "Something went wrong executing Microsoft Paint."
+
+
+
+# =========================== Proc_name ===========================
+@given(u'the initialization of Microsoft Paint')
+def step_impl(context):
+    context.client.proc_exec("mspaint")
+
+@given(u'the "Name" and "Pid" infos about this process')
+def step_impl(context):
+    context.procs = context.client.proc_all()
+
+    for proc in context.procs:
+        if "mspaint.exe" in proc["Name"]:
+            context.proc_name = proc["Name"]
+            context.proc_pid = proc["Pid"]
+
+@when(u'the proc_name method is called with the "Pid" collected')
+def step_impl(context):
+    context.name_return = context.client.proc_name(context.proc_pid)
+
+@then(u'the return must be te same as the "Name" collected')
+def step_impl(context):
+    assert context.name_return == context.proc_name, "Something went wrong with some of the proc methods."
+
+    context.client.proc_kill(context.proc_pid)
+
+
+
+# =========================== Proc_pids ===========================
+@when(u'the proc_pids is called')
+def step_impl(context):
+    context.all_pids = context.client.proc_pids()
+
+@then(u'the "Pid" info collected must be inside the array returned')
+def step_impl(context):
+    assert context.proc_pid in context.all_pids, "Something went wrong catching all of the pids."
+    
+    context.client.proc_kill(context.proc_pid)
+
+
+
+# =========================== Window_list and Window_hwnd ===========================
+@when(u'the window_hwnd method is called with the parameter "mspaint.exe"')
+def step_impl(context):
+    sleep(0.5)
+    context.paint_hwnd = context.client.window_hwnd("mspaint.exe")
+
+@when(u'the window_list method is called')
+def step_impl(context):
+    context.windows = context.client.window_list()
+
+@then(u'the return of window_hwnd must be the value of one of the "Hwnd" keys returned in window_list')
+def step_impl(context):
+    for window in context.windows:
+        if context.paint_hwnd[0] == window["Hwnd"]:
+            assert True
+            sleep(0.5)
+            context.client.proc_kill(context.proc_pid)
+
+            return
+
+    assert False, "Something went wrong catching the Paint window."
+
+
+
+# # =================== Window_activate, Window_activetitle and Window_activehwnd ===================
+# @given(u'the window hwnd obtained from the "Name" info')
+# def step_impl(context):
+#     context.paint_hwnd = context.client.window_hwnd(context.proc_name)
+
+# @when(u'the window_activate method is called with the Paint Hwnd obtained')
+# def step_impl(context):
+#     sleep(0.5)
+#     context.client.window_activate (context.paint_hwnd[0])
+#     sleep(0.5)
+
+# @when(u'the methods window_activetitle and window_activehwnd are called')
+# def step_impl(context):
+#     context.paint_title = context.client.window_activetitle()
+#     context.paint_win_hwnd = context.client.window_activehwnd()
+
+#     context.client.window_close(context.paint_hwnd[0])
+
+# @then(u'the returned value from window_activetitle must contain the substring "Paint"')
+# def step_impl(context):
+#     assert "Paint" in context.paint_title, f"The active title obtained is not from Paint.\nActive Title: {context.paint_title}"
+
+#     for window in context.client.window_list():
+#         if context.paint_hwnd == window["Hwnd"]:
+#             print(f"""
+
+#             ---------------------------
+#                 Hwnd associated title: {window["Title"]}
+#             ---------------------------
+
+#             """)
+
+# @then(u'the returned value from window_activehwnd must be equal to the hwnd previously obtained')
+# def step_impl(context):
+#     assert context.paint_win_hwnd == context.paint_hwnd, "The Hwnd obtained is not from Paint"
+
+
+
+# ======================================== Display methods ========================================
+@given(u'the current resolution of the display')
+def step_impl(context):
+    context.sys_info = context.client.display_res()
+
+    context.prev_width = context.sys_info["DmPelsWidth"]
+    context.prev_height = context.sys_info["DmPelsHeight"]
+
+@when(u'the display_setres method is called to set the display resolution in 800x600')
+def step_impl(context):
+    context.new_sys_info = context.sys_info
+    context.new_sys_info["DmPelsWidth"] = 800
+    context.new_sys_info["DmPelsHeight"] = 600
+
+    try:
+        context.client.display_setres(context.new_sys_info)
+        sleep(5)
+    except:
+        raise "Your system configuration does not support 800x600 resolution"
+
+@then(u'the new display resolution must be 800x600')
+def step_impl(context):
+    context.new_sys_info = context.client.display_res()
+
+    assert context.new_sys_info["DmPelsWidth"] == 800 and \
+           context.new_sys_info["DmPelsHeight"] == 600, \
+               \
+           "Something went wrong setting your system resolution to 800x600.\n\nCheck if this resolution is available in your configurations, if so, please disregard this message."
+
+@then(u'the methods must be able to set your resolution to the previous one')
+def step_impl(context):
+    context.new_sys_info["DmPelsWidth"] = context.prev_width
+    context.new_sys_info["DmPelsHeight"] = context.prev_height
+
+    try:
+        context.client.display_setres(context.new_sys_info)
+        sleep(5)
+    except:
+        raise "Error!"
+
+    context.curr_sys_info = context.client.display_res()
+
+    assert context.curr_sys_info["DmPelsWidth"] == context.prev_width and \
+           context.curr_sys_info["DmPelsHeight"] == context.prev_height, \
+               \
+           "Sorry for the inconvenience, but something went wrong resetting your resolution to the previous one.\n\nPlease go to your system configurations to do this step manually."

api/wingui/features/wingui.feature

@@ -0,0 +1,73 @@
+Feature: The winGUI API client
+
+    Scenario: Testing the clip_read and clip_write methods
+        Given a winGUI client
+        When the clip_write method is called to store the text "There is a light that never goes out"
+        Then when the clip_read method is called, it must return the same text
+    
+
+    Scenario: Testing the screen_scale and screen_size methods
+        Given a winGUI client
+        When the screen_scale method is called
+        And the screen_size method is also called
+        Then the returns of both must be equal
+    
+    # Please note that most of the other screen methods use image recognition and, because of that, it is not possible to test them on every computer, since there is no way to know wich images are being displayed on the screen.
+    # Also, the other methods wich do not use image recognition are simply too difficult to test.
+
+
+    Scenario: Testing proc_exec and proc_all methods
+        Given a winGUI client
+        When the proc_exec method is called with "mspaint"
+        And the proc_all method is called
+        Then there must be a process with the name "mspaint.exe" inside the list
+
+
+    Scenario: Testing proc_name method
+        Given a winGUI client
+        And the initialization of Microsoft Paint
+        And the "Name" and "Pid" infos about this process
+        When the proc_name method is called with the "Pid" collected
+        Then the return must be te same as the "Name" collected
+
+
+    Scenario: Testing proc_pids method
+        Given a winGUI client
+        And the initialization of Microsoft Paint
+        And the "Name" and "Pid" infos about this process
+        When the proc_pids is called
+        Then the "Pid" info collected must be inside the array returned
+    
+
+    Scenario: Testing the window_list and window_hwnd methods
+        Given a winGUI client
+        And the initialization of Microsoft Paint
+        And the "Name" and "Pid" infos about this process
+
+        When the window_hwnd method is called with the parameter "mspaint.exe"
+        And the window_list method is called
+
+        Then the return of window_hwnd must be the value of one of the "Hwnd" keys returned in window_list
+    
+
+    # Scenario: Testing window_activate, window_activetitle and window_activehwnd
+    #     Given a winGUI client
+    #     And the initialization of Microsoft Paint
+    #     And the "Name" and "Pid" infos about this process
+    #     And the window hwnd obtained from the "Name" info
+
+    #     When the window_activate method is called with the Paint Hwnd obtained
+    #     And the methods window_activetitle and window_activehwnd are called
+
+    #     Then the returned value from window_activetitle must contain the substring "Paint"
+    #     And the returned value from window_activehwnd must be equal to the hwnd previously obtained
+
+
+    Scenario: Testing the display methods
+        Given a winGUI client
+        And the current resolution of the display
+
+        When the display_setres method is called to set the display resolution in 800x600
+
+        Then the new display resolution must be 800x600
+        And the methods must be able to set your resolution to the previous one