stoobly-agent 0.33.2__py3-none-any.whl → 0.33.4__py3-none-any.whl

stoobly_agent/__init__.py

@@ -1,2 +1,2 @@
 COMMAND = 'stoobly-agent'
-VERSION = '0.33.2'
+VERSION = '0.33.4'

stoobly_agent/app/api/requests_controller.py

@@ -1,5 +1,6 @@
 import json
 import pdb
+import uuid
 
 from datetime import datetime
 from urllib.parse import urlparse
@@ -63,6 +64,7 @@ class RequestsController:
             request, status = request_model.create(**{
                 **create_params,
                 'scenario_id': scenario_id,
+                'uuid': str(uuid.uuid4()),
             })
 
             if context.filter_response(request, status):

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/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/models/factories/resource/local_db/helpers/create_request_columns_service.py

@@ -19,11 +19,14 @@ def build_request_columns(flow: MitmproxyHTTPFlow, joined_request: JoinedRequest
     'control': joined_request.request_string.control,
     'latency': joined_request.response_string.latency,
     'raw': joined_request.request_string.get(),
-    'status': flow.response.status_code,
-    'uuid': joined_request.request_string.request_id.strip(),
+    'status': flow.response.status_code, 
   }
 
-  return { **request_columns, **params }
+  return { 
+    **request_columns, 
+    **params, 
+    **{ 'uuid': params.get('uuid') or joined_request.request_string.request_id.strip() } 
+  }
 
 def build_response_columns(flow: MitmproxyHTTPFlow, joined_request: JoinedRequest):
   response_columns: ResponseColumns = {

stoobly_agent/app/models/factories/resource/local_db/request_adapter.py

@@ -43,9 +43,11 @@ class LocalDBRequestAdapter(LocalDBAdapter):
     flow: MitmproxyHTTPFlow = params['flow']
     joined_request: JoinedRequest = params['joined_request']
     scenario_id = params.get('scenario_id')
+    uuid = params.get('uuid')
+
+    request_columns = build_request_columns(flow, joined_request, is_deleted=False, scenario_id=scenario_id, uuid=uuid)
 
     with ORM.instance().db.transaction():
-      request_columns = build_request_columns(flow, joined_request, is_deleted=False, scenario_id=scenario_id)
       request_record = self.__request_orm.create(**request_columns)
 
       response_columns = {
@@ -53,10 +55,7 @@ class LocalDBRequestAdapter(LocalDBAdapter):
         **build_response_columns(flow, joined_request),
       }
 
-      response_record = self.__response_orm.create(**response_columns)
-      if not response_record:
-        request_record.delete()
-        return self.internal_error('Could not create requeset response')
+      self.__response_orm.create(**response_columns)
 
       return self.success({
         'list': [ORMToStooblyRequestTransformer(request_record, {}).transform()],

stoobly_agent/app/models/types/request.py

@@ -8,6 +8,7 @@ class RequestCreateParams(TypedDict):
   project_id: str
   joined_request: JoinedRequest
   scenario_id: str
+  uuid: str
 
 class RequestDestroyParams(TypedDict):
   force: bool

stoobly_agent/app/models/types/scenario.py

@@ -4,6 +4,7 @@ class ScenarioCreateParams(TypedDict):
   description: str
   name: str
   priority: int
+  uuid: str
   
 class ScenarioDestroyParams(TypedDict):
   force: bool

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
+        expected = test_context.cached_rewritten_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/test/context.py

@@ -54,11 +54,11 @@ class TestContext(TestContextABC):
     return self 
 
   @property
-  def cached_expected_response_content(self) -> Union[bytes, None, str]:
+  def cached_rewritten_expected_response_content(self) -> FuzzyContent:
     if not self.__cached_rewritten_expected_response_content:
       return self.rewritten_expected_response_content
 
-    return encode_response(self.__cached_rewritten_expected_response_content, self.__expected_response.content_type) 
+    return self.__cached_rewritten_expected_response_content
 
   @property
   def endpoint(self) -> EndpointFacade:

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
 
@@ -20,7 +21,7 @@ class TestContextABC(abc.ABC):
 
   @property
   @abc.abstractmethod
-  def cached_expected_response_content(self) -> Union[bytes, None, str]:
+  def cached_rewritten_expected_response_content(self) -> FuzzyContent:
     pass
 
   @property
@@ -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/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/db/migrations/2023_05_15_212505_add_uuid_column_to_requests.py

@@ -13,7 +13,7 @@ class AddUuidColumnToRequests(Migration):
         Run the migrations.
         """
         with self.schema.table('requests') as table:
-            table.string('uuid', 36).default('').index()
+            table.string('uuid', 36).default('').index().unique()
 
         for request in Request.all():
             control = RequestStringControl(request.control)

stoobly_agent/db/migrations/2023_05_15_213119_add_uuid_column_to_scenarios.py

@@ -11,7 +11,7 @@ class AddUuidColumnToScenarios(Migration):
         Run the migrations.
         """
         with self.schema.table('scenarios') as table:
-            table.string('uuid', 36).index().default('')
+            table.string('uuid', 36).default('').index().unique()
 
         for scenario in Scenario.all():
             scenario.update(uuid=str(uuid.uuid4()))

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):