stoobly-agent 0.33.1__py3-none-any.whl → 0.33.3__py3-none-any.whl

stoobly_agent/__init__.py

@@ -1,2 +1,2 @@
 COMMAND = 'stoobly-agent'
-VERSION = '0.33.1'
+VERSION = '0.33.3'

stoobly_agent/app/api/proxy_controller.py

@@ -1,6 +1,7 @@
 import requests
 
 from http.cookies import SimpleCookie
+from urllib3.exceptions import InsecureRequestWarning
 
 from stoobly_agent.config.constants import headers
 from stoobly_agent.config.mitmproxy import MitmproxyConfig
@@ -51,6 +52,7 @@ class ProxyController:
             _cookies =  self.__get_cookies(context)
             _body = self.__get_body(context)
             _params = context.params
+            _verify = not MitmproxyConfig.instance().get('ssl_insecure')
 
             Logger.instance().debug('Request Headers')
             Logger.instance().debug(_headers)
@@ -61,24 +63,49 @@ class ProxyController:
             Logger.instance().debug('Query Params')
             Logger.instance().debug(_params)
 
-            res = method(
-                url,
-                allow_redirects = True,
-                cookies = _cookies,
-                data = _body,
-                headers = _headers,
-                params = _params,
-                stream = True,
-                verify = not MitmproxyConfig.instance().get('ssl_insecure')
-            )
+            body = None
+            headers = {}
+            status = 0
+
+            if not _verify:
+                # Suppress only the single warning from urllib3 needed.
+                requests.packages.urllib3.disable_warnings(category=InsecureRequestWarning)
+
+            try:
+                res = method(
+                    url,
+                    allow_redirects = True,
+                    cookies = _cookies,
+                    data = _body,
+                    headers = _headers,
+                    params = _params,
+                    stream = True,
+                    verify = _verify
+                )
+                
+                body = res.raw.data
+                headers = res.headers
+                status = res.status_code
+            except requests.exceptions.ConnectTimeout:
+                body = b'Gateway Timeout'
+                status = 504
+            except requests.exceptions.SSLError as e:
+                body = str(e).encode()
+                status = 502
+            except requests.exceptions.ConnectionError:
+                body = b'Bad Gateway'
+                status = 502
+            except Exception:
+                body = b'Unknown Error'
+                status = 0
 
             Logger.instance().debug('Response Headers')
             Logger.instance().debug(res.headers)
 
             context.render(
-                headers = res.headers,
-                data = res.raw.data,
-                status = res.status_code,
+                headers = headers,
+                data = body,
+                status = status,
             )
 
     def __get_headers(self, context):

stoobly_agent/app/cli/endpoint_cli.py

@@ -1,11 +1,7 @@
-import os
-import traceback
-
 import click
 
 from stoobly_agent.app.models.types import OPENAPI_FORMAT
 from stoobly_agent.app.settings import Settings
-from stoobly_agent.config.constants import env_vars
 from stoobly_agent.lib.logger import bcolors
 from stoobly_agent.lib.utils.conditional_decorator import ConditionalDecorator
 

stoobly_agent/app/cli/helpers/handle_replay_service.py

@@ -12,8 +12,6 @@ from stoobly_agent.lib.logger import bcolors
 from stoobly_agent.lib.utils import jmespath
 from stoobly_agent.lib.utils.decode import decode
 
-from .test_replay_context import TestReplayContext
-
 BODY_FORMAT = 'body'
 DEFAULT_FORMAT = 'default'
 JSON_FORMAT = 'json'

stoobly_agent/app/cli/helpers/handle_test_service.py

@@ -23,6 +23,7 @@ class SessionContext(TypedDict):
   passed: int
   output: TestOutput
   project_id: int
+  skipped: int
   test_facade: TestFacade
   total: int
 
@@ -54,6 +55,9 @@ def handle_test_complete(
 
   test = context.test_show_response(session_context['test_facade'])
 
+  if test['skipped']:
+    session_context['skipped'] += 1
+
   passed = bool(test.get('passed')) if isinstance(test, dict) else False
   session_context['passed'] += (1 if passed else 0)
   session_context['total'] += 1
@@ -65,7 +69,7 @@ def exit_on_failure(session_context: SessionContext, **options: ExitOnFailureOpt
   if complete == None:
     complete = True
 
-  if session_context['passed'] != session_context['total']:
+  if session_context['passed'] + session_context['skipped'] != session_context['total']:
     if not complete:
       handle_test_session_complete(session_context, format=options.get('format'))
 
@@ -112,7 +116,10 @@ def __default_test_complete_formatter(context: ReplayContext, session_context: S
     print_with_decoding(format_request(context))
 
     if not res['passed']:
-      passed_message = f"{bcolors.FAIL}failed{bcolors.ENDC}"
+      if res['skipped']:
+        passed_message = f"{bcolors.WARNING}skipped{bcolors.ENDC}"
+      else:
+        passed_message = f"{bcolors.FAIL}failed{bcolors.ENDC}"
     else:
       passed_message = f"{bcolors.OKGREEN}passed{bcolors.ENDC}"
 
@@ -121,7 +128,7 @@ def __default_test_complete_formatter(context: ReplayContext, session_context: S
     if res['log']:
       print(res['log'])
 
-    if not res['passed']:
+    if not res['passed'] and not res['skipped']:
       project_id = session_context['project_id']
       test_facade = session_context['test_facade']
       expected_response = __get_test_expected_response_with_context(context, project_id, test_facade)
@@ -138,21 +145,32 @@ def __default_session_complete_formatter(session_context: SessionContext):
   if 'output' in session_context:
     print(session_context['output'])
 
-  passed = session_context['passed']
   total = session_context['total']
 
   if total > 1:
+    passed = session_context['passed']
+    skipped = session_context['skipped']
+
+    passed_message = f"{passed} / {total} {bcolors.OKGREEN}passed{bcolors.ENDC}"
+
+    skipped_message = ''
+    if skipped:
+      skipped_message = f" {skipped} {bcolors.WARNING}skipped{bcolors.ENDC}"
+
     if passed == total:
-      print(f"\n{passed} / {total} {bcolors.OKGREEN}passed{bcolors.ENDC}")
+      print(f"\n{passed_message}{skipped_message}")
     else:
-      print(f"\n{passed} / {total} {bcolors.OKGREEN}passed{bcolors.ENDC} {total - passed} {bcolors.FAIL}failed{bcolors.ENDC}")
+      failed_message = f"{total - passed - skipped} {bcolors.FAIL}failed{bcolors.ENDC}"
+      print(f"\n{passed_message} {failed_message}{skipped_message}")
 
 def __json_session_complete_formatter(session_context: SessionContext):
   if 'output' not in session_context:
     return
 
   session_context['output']['passed'] = session_context['passed']
+  session_context['output']['skipped'] = session_context['skipped']
   session_context['output']['total'] = session_context['total']
+
   print(json.dumps(session_context['output']))
 
 def __get_test_expected_response_with_context(context: ReplayContext, project_id: str, test_facade: TestFacade) -> Union[requests.Response, str]:

stoobly_agent/app/cli/helpers/openapi_endpoint_adapter.py

@@ -1,13 +1,13 @@
 import copy
-from functools import reduce
 import itertools
-from pprint import pprint
 import re
-from typing import Dict, List, Union
-from urllib.parse import urlparse
+import yaml
 
+from functools import reduce
 from openapi_core import Spec
-import yaml
+from pprint import pprint
+from typing import Dict, List, Union
+from urllib.parse import urlparse
 
 from stoobly_agent.lib.api.interfaces.endpoints import (
   Alias,

stoobly_agent/app/cli/helpers/request_synchronize_handler.py

@@ -1,7 +1,7 @@
 import copy
 import pdb
 
-from typing import TypedDict, Union
+from typing import Union
 
 from stoobly_agent.app.proxy.test.matchers.context import MatchContext
 from stoobly_agent.app.settings.constants import request_component

stoobly_agent/app/cli/helpers/synchronize_request_service.py

@@ -1,6 +1,7 @@
 import copy
-from dataclasses import dataclass
 import pdb
+
+from dataclasses import dataclass
 from typing import List
 from urllib.parse import urlencode
 from urllib.parse import urlparse

stoobly_agent/app/cli/helpers/test_replay_context.py

@@ -73,13 +73,14 @@ class TestReplayContext(ReplayContext):
         'log': self.__build_log(builder),
         'passed': builder.passed,
         'project_id': project_id,
+        'skipped': builder.skipped,
         'strategy': builder.strategy,
       }
 
   def __build_log(self, builder: TestResultsBuilder):
     log = [builder.log]
 
-    if not builder.passed:
+    if not builder.passed and not builder.skipped:
       log.append("\n" + diff(builder.expected_response, builder.received_response))
 
     return "\n".join(log)

stoobly_agent/app/cli/request_cli.py

@@ -131,7 +131,7 @@ def list(**kwargs):
   )(f), not is_remote
 )
 @click.option('--record', is_flag=True, default=False, help='Replay request and record.')
-@ConditionalDecorator(lambda f: click.option('--save', is_flag=True, default=False, help='Replay request and save to history.')(f), is_remote)
+@ConditionalDecorator(lambda f: click.option('--save', is_flag=True, default=False, help='Save results.')(f), is_remote)
 @click.option('--scenario-key', help='Record to scenario.')
 @click.option('--scheme', type=click.Choice(['http', 'https']), help='Rewrite request scheme.')
 @ConditionalDecorator(lambda f: click.option('--trace-id', help='Use existing trace.')(f), is_remote)
@@ -264,6 +264,7 @@ def test(**kwargs):
       'aggregate_failures': kwargs['aggregate_failures'], 
       'passed': 0, 
       'project_id': request_key.project_id, 
+      'skipped': 0,
       'test_facade': TestFacade(settings), 
       'total': 0 
   }

stoobly_agent/app/cli/scenario_cli.py

@@ -274,8 +274,8 @@ if not is_remote:
     '''
 )
 @ConditionalDecorator(lambda f: click.option('--remote-project-key', help='Use remote project for endpoint definitions.')(f), is_remote)
-@ConditionalDecorator(lambda f: click.option('--report-key', help='Save to report.')(f), is_remote)
-@ConditionalDecorator(lambda f: click.option('--save', is_flag=True, default=False, help='Replay request and save to history.')(f), is_remote)
+@ConditionalDecorator(lambda f: click.option('--report-key', help='Save results to report.')(f), is_remote)
+@ConditionalDecorator(lambda f: click.option('--save', is_flag=True, default=False, help='Save results.')(f), is_remote)
 @click.option('--scheme', help='Rewrite request scheme.')
 @click.option(
     '--strategy', 
@@ -298,6 +298,7 @@ def test(**kwargs):
 
     if kwargs.get('report_key'):
         validate_report_key(kwargs['report_key'])
+        kwargs['save'] = True # If report_key is set, then intention is to save results to the report
 
     if len(kwargs['validate']):
         validate_aliases(kwargs['validate'], assign=kwargs['assign'], format=kwargs['format'], trace_id=kwargs['trace_id'])
@@ -315,7 +316,8 @@ def test(**kwargs):
     session_context: SessionContext = { 
         'aggregate_failures': kwargs['aggregate_failures'], 
         'passed': 0, 
-        'project_id': scenario_key.project_id, 
+        'project_id': scenario_key.project_id,
+        'skipped': 0, 
         'test_facade': TestFacade(settings), 
         'total': 0 
     }

stoobly_agent/app/proxy/handle_test_service.py

@@ -17,7 +17,6 @@ from .mock.context import MockContext
 from .test.helpers.test_results_builder import TestResultsBuilder
 from .test.helpers.upload_test_service import inject_upload_test
 from .test.context_abc import TestContextABC as TestContext
-from .test.helpers.diff_service import diff
 from .test.test_service import test
 
 LOG_ID = 'HandleTest'
@@ -54,23 +53,29 @@ def __decorate_test_id(flow: MitmproxyHTTPFlow, test_response: TestShowResponse)
 def __handle_mock_success(test_context: TestContext) -> None:
     flow: MitmproxyHTTPFlow = test_context.flow
     settings = Settings.instance()
+
     test_context.with_endpoints_resource(EndpointsResource(settings.remote.api_url, settings.remote.api_key))
 
     __test_hook(lifecycle_hooks.BEFORE_TEST, test_context)
 
-    # Run test
-    passed, log = test(test_context)
+    intercept_settings = test_context.intercept_settings
+    if intercept_settings.test_skip:
+        passed, log = (False, '')
+        skipped = True
+    else: 
+        # Run test
+        passed, log = test(test_context)
+        skipped = False
 
     request_id = test_context.mock_request_id
     if request_id:
-        intercept_settings = test_context.intercept_settings
-
         expected = test_context.cached_expected_response_content
         upload_test_data = {
             'expected_response': expected,
             'log': log,
             'passed': passed,
             'request_id': request_id,
+            'skipped': skipped,
             'status': flow.response.status_code,
             'strategy': test_context.strategy
         }

stoobly_agent/app/proxy/intercept_settings.py

@@ -215,6 +215,13 @@ class InterceptSettings:
       return not not int(self.__headers[custom_headers.TEST_SAVE_RESULTS])
 
     return False
+
+  @property
+  def test_skip(self):
+    if self.__headers and custom_headers.TEST_SKIP in self.__headers:
+      return True
+    
+    return False
   
   @property
   def test_strategy(self):

stoobly_agent/app/proxy/simulate_intercept_service.py

@@ -4,6 +4,7 @@ import requests
 from io import BytesIO
 from mitmproxy.http import Request as MitmproxyRequest
 from urllib3 import HTTPResponse
+from urllib3.exceptions import InsecureRequestWarning
 
 from stoobly_agent.app.proxy.mitmproxy.flow_mock import MitmproxyFlowMock
 from stoobly_agent.app.models.adapters.mitmproxy import MitmproxyRequestAdapterFactory, MitmproxyResponseAdapterFactory
@@ -23,10 +24,16 @@ def simulate_intercept(request: requests.Request, **config):
 
     res = None 
 
+    if not config.get('verify'):
+      # Suppress only the single warning from urllib3 needed.
+      requests.packages.urllib3.disable_warnings(category=InsecureRequestWarning)
+
     try:
       res = session.send(prepared_request, **{'timeout': 300, **config})
     except requests.exceptions.ConnectTimeout:
       res = __response(b'Gateway Timeout', 504)
+    except requests.exceptions.SSLError as e:
+      res = __response(str(e).encode(), 502)
     except requests.exceptions.ConnectionError:
       res = __response(b'Bad Gateway', 502)
     except Exception:

stoobly_agent/app/proxy/test/context.py

@@ -56,7 +56,7 @@ class TestContext(TestContextABC):
   @property
   def cached_expected_response_content(self) -> Union[bytes, None, str]:
     if not self.__cached_rewritten_expected_response_content:
-      return self.rewritten_expected_response_content
+      return encode_response(self.rewritten_expected_response_content, self.__expected_response.content_type)
 
     return encode_response(self.__cached_rewritten_expected_response_content, self.__expected_response.content_type) 
 

stoobly_agent/app/proxy/test/context_abc.py

@@ -5,6 +5,7 @@ from typing import Union
 
 from stoobly_agent.app.proxy.test.helpers.endpoint_facade import EndpointFacade
 from stoobly_agent.app.proxy.test.helpers.request_component_names_facade import RequestComponentNamesFacade
+from stoobly_agent.app.proxy.intercept_settings import InterceptSettings
 from stoobly_agent.lib.api.interfaces.endpoints import EndpointShowResponse
 from stoobly_agent.lib.orm.trace import Trace
 
@@ -70,7 +71,7 @@ class TestContextABC(abc.ABC):
 
   @property
   @abc.abstractmethod
-  def intercept_settings(self):
+  def intercept_settings(self) -> InterceptSettings:
     pass
 
   @property

stoobly_agent/app/proxy/test/helpers/diff_service.py

@@ -1,19 +1,17 @@
-import difflib
 import json
 import pdb
 
 from typing import Union
+from diff_match_patch import diff_match_patch
 
 green = '\x1b[38;5;16;48;5;2m'
-green = '\x1b[42m'
 red = '\x1b[38;5;16;48;5;1m'
 endgreen = '\x1b[0m'
-endgreen = '\033[0m'
 endred = '\x1b[0m'
 
 error = 'Error: Cannot print diff for binary output'
 
-def diff(a: Union[bytes, str], b: Union[str, bytes]) -> str:
+def diff(a: Union[bytes, str], b: Union[str, bytes], timeout = 30) -> str:
 
   if not __string_like(a):
     a = json.dumps(a, indent=2)
@@ -32,18 +30,25 @@ def diff(a: Union[bytes, str], b: Union[str, bytes]) -> str:
       return error
 
   output = []
-  matcher = difflib.SequenceMatcher(None, a, b)
-
-  for opcode, a0, a1, b0, b1 in matcher.get_opcodes():
-    if opcode == 'equal':
-      output.append(a[a0:a1])
-    elif opcode == 'insert':
-      output.append(f'{green}{b[b0:b1]}{endgreen}')
-    elif opcode == 'delete':
-      output.append(f'{red}{a[a0:a1]}{endred}')
-    elif opcode == 'replace':
-      output.append(f'{green}{b[b0:b1]}{endgreen}')
-      output.append(f'{red}{a[a0:a1]}{endred}')
+  dmp = diff_match_patch()
+  for delta in dmp.diff_lineMode(a, b, timeout):
+    opcode = delta[0]
+    text = delta[1]
+
+    if opcode == 0:
+      output.append(text)
+    elif opcode == 1:
+      length = len(text)
+      if text[length - 1] == "\n":
+        output.append(f'{green}{text[0:length - 1]} {endgreen}\n')
+      else:
+        output.append(f'{green}{text}{endgreen}')
+    elif opcode == -1:
+      length = len(text)
+      if text[length - 1] == "\n":
+        output.append(f'{red}{text[0:length - 1]} {endred}\n')
+      else:
+        output.append(f'{red}{text}{endred}')
 
   return ''.join(output)
 

stoobly_agent/app/proxy/test/helpers/test_results_builder.py

@@ -19,6 +19,7 @@ class TestResultsBuilder():
     self.__passed = test_data.get('passed')
     self.__request_id = test_data.get('request_id')
     self.__received_response = test_data.get('received_response')
+    self.__skipped = test_data.get('skipped')
     self.__status = test_data.get('status')
     self.__strategy = test_data.get('strategy')
 
@@ -42,6 +43,10 @@ class TestResultsBuilder():
   def received_response(self):
     return self.__received_response
 
+  @property
+  def skipped(self):
+    return self.__skipped
+
   @property
   def status(self):
     return self.__status
@@ -83,6 +88,7 @@ class TestResultsBuilder():
       'log': self.__log,
       'passed': self.__passed,
       'request_id': self.__request_id,
+      'skipped': self.__skipped,
       'status': self.__status,
       'strategy': self.__strategy, 
     }
@@ -119,6 +125,7 @@ class TestResultsBuilder():
     self.__log = test_data.get('log')
     self.__passed = test_data.get('passed')
     self.__request_id = test_data.get('request_id')
+    self.__skipped = test_data.get('skipped')
     self.__status = test_data.get('status')
     self.__strategy = test_data.get('strategy')
 

stoobly_agent/app/proxy/test/helpers/upload_test_service.py

@@ -54,8 +54,6 @@ def upload_test(
 
       api.with_report_key(report_key, kwargs)
 
-    res: Response = None
-
     scenario_key = intercept_settings.scenario_key
     if scenario_key:
       return api.from_scenario_key(

stoobly_agent/app/proxy/test/matchers/context.py

@@ -213,7 +213,11 @@ class MatchContext():
 
     def __param_name_matches(self, query, param_names: List[ResponseParamName]) -> bool:
         for param_name in param_names:
-            if param_name['query'] == query:
+            # Not all components will have a query property,
+            # If query property does not exist, then use name property
+            _query = param_name['query'] if 'query' in param_name else param_name['name']
+
+            if _query == query:
                 return True
 
         return False

stoobly_agent/config/constants/custom_headers.py

@@ -20,6 +20,7 @@ SERVICE_URL = 'X-Service-Url'
 TEST_FILTER = 'X-Test-Filter'
 TEST_ID = 'X-Stoobly-Test-Id'
 TEST_SAVE_RESULTS = 'X-Stoobly-Test-Save-Results'
+TEST_SKIP = 'X-Stoobly-Test-Skip'
 TEST_STRATEGY = 'X-Test-Strategy'
 TRACE_ID = 'X-Stoobly-Trace-Id'
 TRACE_REQUEST_ID = 'X-Stoobly-Trace-Request-Id'

stoobly_agent/lib/api/interfaces/tests.py

@@ -10,6 +10,7 @@ class TestShowResponse(TypedDict):
   log: str
   passed: bool
   project_id: str
+  skipped: bool
   strategy: Union[test_strategy.DIFF, test_strategy.CUSTOM, test_strategy.FUZZY] 
 
 class TestsIndexQueryParams(PaginationQueryParams):