stoobly-agent 1.9.1__tar.gz → 1.9.2__tar.gz

{stoobly_agent-1.9.1 → stoobly_agent-1.9.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: stoobly-agent
-Version: 1.9.1
+Version: 1.9.2
 Summary: Record, mock, and test HTTP(s) requests. CLI agent for Stoobly
 License: Apache-2.0
 Author: Matt Le

{stoobly_agent-1.9.1 → stoobly_agent-1.9.2}/pyproject.toml

@@ -10,7 +10,7 @@ description = "Record, mock, and test HTTP(s) requests. CLI agent for Stoobly"
 license = "Apache License 2.0"
 name = "stoobly-agent"
 readme = "README.md"
-version = "1.9.1"
+version = "1.9.2"
 
 [tool.poetry.dependencies]
 python = "^3.10"

{stoobly_agent-1.9.1 → stoobly_agent-1.9.2}/stoobly_agent/__init__.py

@@ -1,2 +1,2 @@
 COMMAND = 'stoobly-agent'
-VERSION = '1.9.1'
+VERSION = '1.9.2'

{stoobly_agent-1.9.1 → stoobly_agent-1.9.2}/stoobly_agent/app/models/factories/resource/local_db/helpers/log.py

@@ -70,22 +70,7 @@ class Log():
 
   @property
   def scenario_inverted_index(self):
-    index = {}
-
-    def handle_snapshot(snapshot: RequestSnapshot):
-      request_uuid = snapshot.uuid
-      if not request_uuid in index:
-        index[request_uuid] = []
-
-      index[request_uuid].append(event.resource_uuid)
-
-    for event in self.target_events:
-      if not event.is_scenario():
-        continue 
-
-      event.snapshot().iter_request_snapshots(handle_snapshot)
-
-    return index
+    return self.build_scenario_inverted_index(self.target_events)
 
   @property
   def unprocessed_events(self) -> List[LogEvent]:
@@ -153,6 +138,22 @@ class Log():
 
   def build_log_events(self, raw_events) -> List[LogEvent]:
     return list(map(lambda raw_event: LogEvent(raw_event), raw_events))
+  
+  def build_scenario_inverted_index(self, events: List[LogEvent], index = {}):
+    def handle_snapshot(snapshot: RequestSnapshot):
+      request_uuid = snapshot.uuid
+      if not request_uuid in index:
+        index[request_uuid] = []
+
+      index[request_uuid].append(event.resource_uuid)
+
+    for event in events:
+      if not event.is_scenario():
+        continue 
+
+      event.snapshot().iter_request_snapshots(handle_snapshot)
+
+    return index
 
   def next_version(self, last_processed_uuid: str = None):
     uuids = self.uuids()
@@ -169,7 +170,7 @@ class Log():
   def collapse(self, events: List[LogEvent]) -> List[LogEvent]:
     events_count = {}
 
-    # More recent events take precedence over earlier ones, keep only the most recent event 
+    # More recent events take precedence over earlier ones, only the most recent event 
     for event in events:
       event_key = event.key
 
@@ -274,10 +275,10 @@ class Log():
   
   def remove_dangling_events(self, processed_events: List[LogEvent], unprocessed_events: List[LogEvent]):
     '''
-    Remove DELETE events where the last processed event was a PUT
+    Remove DELETE events unless the last processed event was a PUT
     '''
 
-    # Build an index such that if the last event is DELETE_ACTION, then it will NOT exist in the index
+    # Build an index to keep track of the last action that occurred for a resource
     index = {}
     for event in processed_events:
       if event.action == PUT_ACTION:
@@ -286,13 +287,27 @@ class Log():
         if event.resource_uuid in index:
           del index[event.resource_uuid]
 
-    scenario_inverted_index = self.scenario_inverted_index
-
+    scenario_inverted_index = self.build_scenario_inverted_index(processed_events)
+    
     def keep(e: LogEvent):
-      if e.action != DELETE_ACTION:
+      # Keep the event if it's a PUT, it may have been updated
+      if e.action == PUT_ACTION:
         return True
-      
-      return e.action == DELETE_ACTION and e.is_request() and e.resource_uuid in scenario_inverted_index
+
+      if e.action == DELETE_ACTION:
+        if e.is_request():
+          referenced = e.resource_uuid in scenario_inverted_index
+          # Keep the DELETE event if the requests exists in a scenario
+          # or if it doesn't exist in a scenario, there was a previous delete event
+          return referenced or (e.resource_uuid in index and not referenced)
+        elif e.is_scenario():
+          # Update scenario_inverted_index with unprocessed event
+          self.build_scenario_inverted_index([e], scenario_inverted_index)
+
+          # Keep DELETE scenario event only if previous event for the resource was PUT
+          return e.resource_uuid in index
+        else:
+          return True
     
     return list(
       filter(

{stoobly_agent-1.9.1 → stoobly_agent-1.9.2}/stoobly_agent/app/proxy/handle_mock_service.py

@@ -147,15 +147,8 @@ def handle_request_mock(context: MockContext):
 # 2. AFTER_MOCK gets triggered (if mock found)
 #
 def handle_response_mock(context: MockContext):
-    response = context.flow.response
-    request_key = response.headers.get(custom_headers.MOCK_REQUEST_KEY)
-
-    if request_key:
-        request = context.flow.request
-        Logger.instance(LOG_ID).info(f"{bcolors.OKBLUE}Mocked{bcolors.ENDC} {request.url} -> {request_key}")
-
-        __rewrite_response(context)
-        __mock_hook(lifecycle_hooks.AFTER_MOCK, context)
+    __rewrite_response(context)
+    __mock_hook(lifecycle_hooks.AFTER_MOCK, context)
 
 def __handle_mock_failure(context: MockContext) -> None:
     flow = context.flow
@@ -186,6 +179,19 @@ def __handle_found_policy(context: MockContext) -> None:
     reverse_proxy(req, upstream_url, {})
 
 def __handle_mock_success(context: MockContext) -> None:
+    response = context.response
+
+    if response:
+        request = context.flow.request
+
+        request_key = response.headers.get(custom_headers.MOCK_REQUEST_KEY)
+        if request_key:
+            Logger.instance(LOG_ID).info(f"{bcolors.OKBLUE}Mocked{bcolors.ENDC} {request.url} -> {request_key}")
+
+        fixture_path = response.headers.get(custom_headers.MOCK_FIXTURE_PATH)
+        if fixture_path:
+            Logger.instance(LOG_ID).info(f"{bcolors.OKBLUE}Mocked{bcolors.ENDC} {request.url} -> {fixture_path}")
+
     if os.environ.get(env_vars.AGENT_SIMULATE_LATENCY):
         response = context.response
         start_time = context.start_time

{stoobly_agent-1.9.1 → stoobly_agent-1.9.2}/stoobly_agent/app/proxy/mock/eval_fixtures_service.py

@@ -10,6 +10,7 @@ from requests.structures import CaseInsensitiveDict
 from typing import Union
 
 from stoobly_agent.lib.logger import bcolors, Logger
+from stoobly_agent.config.constants.custom_headers import MOCK_FIXTURE_PATH
 
 from .types import Fixtures
 
@@ -20,45 +21,50 @@ class Options():
   response_fixtures: Fixtures
 
 def eval_fixtures(request: MitmproxyRequest, **options: Options) -> Union[Response, None]:
-  fixture_path = None
+  fixture_path = request.headers.get(MOCK_FIXTURE_PATH)
   headers = CaseInsensitiveDict()
   status_code = 200
 
-  response_fixtures = options.get('response_fixtures')
-  fixture: dict = __eval_response_fixtures(request, response_fixtures)
-
-  if not fixture:
-    public_directory_path = options.get('public_directory_path')
-
-    if not public_directory_path:
+  if fixture_path:
+    if not os.path.exists(fixture_path):
       return
+  else:
+    response_fixtures = options.get('response_fixtures')
+    fixture: dict = __eval_response_fixtures(request, response_fixtures)
 
-    request_path = 'index' if request.path == '/' else request.path
-    _fixture_path = os.path.join(public_directory_path, request_path.lstrip('/'))
-    if request.headers.get('accept'):
-      fixture_path = __guess_file_path(_fixture_path, request.headers['accept'])
+    if not fixture:
+      public_directory_path = options.get('public_directory_path')
 
-    if not fixture_path:
-      fixture_path = _fixture_path
+      if not public_directory_path:
+        return
 
-    if not os.path.isfile(fixture_path):
-      return
-  else:
-    fixture_path = fixture.get('path')
-    if not fixture_path or not os.path.isfile(fixture_path):
-      return
+      request_path = 'index' if request.path == '/' else request.path
+      _fixture_path = os.path.join(public_directory_path, request_path.lstrip('/'))
+      if request.headers.get('accept'):
+        fixture_path = __guess_file_path(_fixture_path, request.headers['accept'])
+
+      if not fixture_path:
+        fixture_path = _fixture_path
 
-    _headers = fixture.get('headers')
-    headers = CaseInsensitiveDict(_headers if isinstance(_headers, dict) else {}) 
+      if not os.path.isfile(fixture_path):
+        return
+    else:
+      fixture_path = fixture.get('path')
+      if not fixture_path or not os.path.isfile(fixture_path):
+        return
 
-    if fixture.get('status_code'):
-      status_code = fixture.get('status_code')
+      _headers = fixture.get('headers')
+      headers = CaseInsensitiveDict(_headers if isinstance(_headers, dict) else {}) 
 
+      if fixture.get('status_code'):
+        status_code = fixture.get('status_code')
+    
   with open(fixture_path, 'rb') as fp:
     response = Response()
 
     response.status_code = status_code
     response.raw = BytesIO(fp.read()) 
+    headers[MOCK_FIXTURE_PATH] = fixture_path
     response.headers = headers
 
     if not response.headers.get('content-type'):

{stoobly_agent-1.9.1 → stoobly_agent-1.9.2}/stoobly_agent/config/constants/custom_headers.py

@@ -2,6 +2,7 @@ ALIAS_RESOLVE_STRATEGY = 'X-Stoobly-Alias-Resolve-Strategy'
 CONTENT_TYPE = 'X-Stoobly-Content-Type'
 CONTENT_TYPE_TEST_RESULTS = 'test/results'
 REMOTE_PROJECT_KEY = 'X-Stoobly-Endpoints-Project-Id'
+MOCK_FIXTURE_PATH = 'X-Stoobly-Fixture-Path'
 MOCK_POLICY = 'X-Stoobly-Mock-Policy'
 MOCK_REQUEST_ID = 'X-Stoobly-Request-Id'
 MOCK_REQUEST_ENDPOINT_ID = 'X-Stoobly-Request-Endpoint-Id'

{stoobly_agent-1.9.1 → stoobly_agent-1.9.2}/stoobly_agent/lib/api/keys/uuid_key.py

@@ -28,6 +28,10 @@ class UuidKey(ResourceKey):
     toks = key.split(DELIMITTER)
 
     d = {}
+
+    if len(toks) == 0:
+      return d
+
     for tok in toks:
       d[tok[0]] = tok[1:]
 

{stoobly_agent-1.9.1 → stoobly_agent-1.9.2}/stoobly_agent/test/app/cli/request/request_snapshot_test.py

@@ -1,16 +1,18 @@
 import pdb
 import pytest
+import time
 
 from click.testing import CliRunner
-
-from stoobly_agent.test.test_helper import DETERMINISTIC_GET_REQUEST_URL, reset
+from typing import List
 
 from stoobly_agent.app.models.adapters.orm import JoinedRequestStringAdapter
 from stoobly_agent.app.models.factories.resource.local_db.helpers.log import Log
-from stoobly_agent.app.models.factories.resource.local_db.helpers.log_event import DELETE_ACTION
+from stoobly_agent.app.models.factories.resource.local_db.helpers.log_event import DELETE_ACTION, PUT_ACTION
 from stoobly_agent.app.models.factories.resource.local_db.helpers.request_snapshot import RequestSnapshot
-from stoobly_agent.cli import record, request
+from stoobly_agent.cli import record, request, scenario, snapshot
 from stoobly_agent.lib.orm.request import Request
+from stoobly_agent.lib.orm.scenario import Scenario
+from stoobly_agent.test.test_helper import DETERMINISTIC_GET_REQUEST_URL, NON_DETERMINISTIC_GET_REQUEST_URL, reset
 
 @pytest.fixture(scope='module')
 def runner():
@@ -122,3 +124,51 @@ class TestRequestSnapshot():
 
         event = unprocessed_events[0]
         assert event.resource_uuid == recorded_request_two.uuid
+        assert event.action == PUT_ACTION
+
+    class TestWhenDeleteFirst():
+
+      @pytest.fixture(scope='class')
+      def recorded_request(self, runner: CliRunner):
+        record_result = runner.invoke(record, [DETERMINISTIC_GET_REQUEST_URL])
+        assert record_result.exit_code == 0
+        return Request.last()
+
+      def test_initial_delete(self, runner: CliRunner, recorded_request: Request):
+        snapshot_result = runner.invoke(request, ['snapshot', '--action', DELETE_ACTION, recorded_request.key()])
+        assert snapshot_result.exit_code == 0
+
+        log = Log()
+
+        events = log.raw_events
+        assert len(events) == 1
+
+        unprocessed_events = log.unprocessed_events
+        assert len(unprocessed_events) == 0
+
+      def test_puts(self, runner: CliRunner, recorded_request: Request):
+        snapshot_result = runner.invoke(request, ['snapshot', '--action', PUT_ACTION, recorded_request.key()])
+        assert snapshot_result.exit_code == 0
+
+        log = Log()
+
+        events = log.raw_events
+        assert len(events) == 2
+
+        unprocessed_events = log.unprocessed_events
+        assert len(unprocessed_events) == 1
+        assert unprocessed_events[0].action == PUT_ACTION
+
+      def test_final_delete(self, runner: CliRunner, recorded_request: Request):
+        snapshot_result = runner.invoke(request, ['snapshot', '--action', DELETE_ACTION, recorded_request.key()])
+        assert snapshot_result.exit_code == 0
+
+        log = Log()
+
+        events = log.events
+        assert len(events) == 3
+
+        collapsed_events = log.collapse(events)
+        assert len(collapsed_events) == 1
+        unprocessed_events = log.unprocessed_events
+        assert len(unprocessed_events) == 0

{stoobly_agent-1.9.1 → stoobly_agent-1.9.2}/stoobly_agent/test/app/cli/snapshot/snapshot_apply_test.py

@@ -556,7 +556,7 @@ class TestApply():
         1. Create scenario
         2. Add 2 requests to it
         3. Snapshot scenario
-        4. Snapshot requests with action DELETE_ACTION
+        4. Snapshot second request with action DELETE_ACTION
         5. Apply
         6. Expect scenario to have 1 request
         '''
@@ -689,4 +689,124 @@ class TestApply():
 
           requests = created_scenario_two.requests
 
-          assert_orm_request_equivalent(requests[0], created_scenario_request)
+          assert_orm_request_equivalent(requests[0], created_scenario_request)
+    
+    class TestApply():
+
+      class TestWhenNoApply():
+        '''
+        1. Create scenario
+        2. Add 2 requests to it
+        3. Snapshot scenario
+        4. Apply scenario
+        5. Snapshot second request with action DELETE_ACTION
+        6. Prune
+        7. Apply
+        8. Expect scenario to have 1 request, because scenario depends on the request, should not be able to prune
+        '''
+
+        @pytest.fixture(scope='class')
+        def created_scenario(self, runner: CliRunner):
+          create_result = runner.invoke(scenario, ['create', 'test'])
+          assert create_result.exit_code == 0
+          return Scenario.last()
+
+        @pytest.fixture(scope='class', autouse=True)
+        def created_scenario_requests(self, runner: CliRunner, created_scenario: Scenario):
+          record_result = runner.invoke(record, ['--scenario-key', created_scenario.key(), DETERMINISTIC_GET_REQUEST_URL])
+          assert record_result.exit_code == 0
+
+          record_result = runner.invoke(record, ['--scenario-key', created_scenario.key(), NON_DETERMINISTIC_GET_REQUEST_URL])
+          assert record_result.exit_code == 0
+
+          return created_scenario.requests
+
+        @pytest.fixture(scope='class', autouse=True)
+        def snapshots(self, runner: CliRunner, created_scenario: Scenario, created_scenario_requests: List[Request]):
+          snapshot_result = runner.invoke(scenario, ['snapshot', created_scenario.key()])
+          assert snapshot_result.exit_code == 0
+
+          created_request = created_scenario_requests[1]
+          snapshot_result = runner.invoke(request, ['snapshot', created_request.key(), '--action', DELETE_ACTION])
+          assert snapshot_result.exit_code == 0
+
+        def test_events(self):
+          log = Log()
+
+          events = log.events
+          assert len(events) == 2
+
+        def test_collapsed_events(self):
+          log = Log()
+
+          collapsed_events = log.collapse(log.events)
+          assert len(collapsed_events) == 2
+
+        def test_unprocessed_events(self):
+          log = Log()
+
+          unprocessed_events = log.unprocessed_events
+          assert len(unprocessed_events) == 2
+
+      class TestWhenRemoveScenarioRequest():
+        '''
+        1. Create scenario
+        2. Add 2 requests to it
+        3. Snapshot scenario
+        4. Apply scenario
+        5. Snapshot second request with action DELETE_ACTION
+        6. Prune
+        7. Apply
+        8. Expect scenario to have 1 request, because scenario depends on the request, should not be able to prune
+        '''
+
+        @pytest.fixture(scope='class')
+        def created_scenario(self, runner: CliRunner):
+          create_result = runner.invoke(scenario, ['create', 'test'])
+          assert create_result.exit_code == 0
+          return Scenario.last()
+
+        @pytest.fixture(scope='class', autouse=True)
+        def created_scenario_requests(self, runner: CliRunner, created_scenario: Scenario):
+          record_result = runner.invoke(record, ['--scenario-key', created_scenario.key(), DETERMINISTIC_GET_REQUEST_URL])
+          assert record_result.exit_code == 0
+
+          record_result = runner.invoke(record, ['--scenario-key', created_scenario.key(), NON_DETERMINISTIC_GET_REQUEST_URL])
+          assert record_result.exit_code == 0
+
+          return created_scenario.requests
+
+        @pytest.fixture(scope='class', autouse=True)
+        def apply_result(self, runner: CliRunner, created_scenario: Scenario, created_scenario_requests: List[Request]):
+          snapshot_result = runner.invoke(scenario, ['snapshot', created_scenario.key()])
+          assert snapshot_result.exit_code == 0
+
+          created_scenario = Scenario.find(created_scenario.id)
+          assert created_scenario.requests_count == 2
+          apply_result = runner.invoke(snapshot, ['apply'])
+          assert apply_result.exit_code == 0
+
+          created_request = created_scenario_requests[1]
+          snapshot_result = runner.invoke(request, ['snapshot', created_request.key(), '--action', DELETE_ACTION])
+          assert snapshot_result.exit_code == 0
+
+          return apply_result
+
+        def test_events(self):
+          log = Log()
+
+          events = log.events
+          assert len(events) == 2
+
+        def test_collapsed_events(self):
+          log = Log()
+
+          collapsed_events = log.collapse(log.events)
+          assert len(collapsed_events) == 2
+
+        def test_unprocessed_events(self):
+          log = Log()
+
+          unprocessed_events = log.unprocessed_events
+          assert len(unprocessed_events) == 1
+          assert unprocessed_events[0].action == DELETE_ACTION

{stoobly_agent-1.9.1 → stoobly_agent-1.9.2}/stoobly_agent/test/app/cli/snapshot/snapshot_prune_test.py

@@ -116,10 +116,10 @@ class TestPrune():
       1. Create scenario
       2. Add 2 requests to it
       3. Snapshot scenario
-      4. Snapshot request with action DELETE_ACTION
-      5. Prune, but because scenario depends on the request, should not be able to prune
+      4. Snapshot second request with action DELETE_ACTION
+      5. Prune
       6. Apply
-      7. Expect scenario to have 1 request
+      7. Expect scenario to have 1 request, because scenario depends on the request, should not be able to prune
       '''
 
       @pytest.fixture(scope='class')