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

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

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

{stoobly_agent-1.9.0 → stoobly_agent-1.9.1}/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.0"
+version = "1.9.1"
 
 [tool.poetry.dependencies]
 python = "^3.10"

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

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

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

@@ -8,6 +8,7 @@ from stoobly_agent.config.data_dir import DataDir
 from stoobly_agent.lib.logger import bcolors, Logger
 
 from .log_event import LogEvent
+from .request_snapshot import RequestSnapshot
 from .snapshot_types import DELETE_ACTION, PUT_ACTION, Resource
 
 EVENT_DELIMITTER = "\n"
@@ -67,6 +68,25 @@ class Log():
     contents = self.read()
     return self.build_raw_events(contents) 
 
+  @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
+
   @property
   def unprocessed_events(self) -> List[LogEvent]:
     events = self.events
@@ -197,12 +217,18 @@ class Log():
 
       resource_index[event.resource_uuid].append(event)
 
+    scenario_inverted_index = self.scenario_inverted_index
+
     pruned_events = self.collapse(events)
     for event in pruned_events:
       snapshot = event.snapshot()
       snapshot_exists = snapshot.exists
 
       if event.action == DELETE_ACTION or not snapshot_exists:
+        if event.is_request() and event.resource_uuid in scenario_inverted_index:
+          # If a request is deleted, only prune if it's not also a part of a scenario
+          continue
+
         Logger.instance(LOG_ID).info(f"{bcolors.OKBLUE}Removing{bcolors.ENDC} {event.resource} {event.resource_uuid}")
 
         resource_events: List[LogEvent] = resource_index[event.resource_uuid]
@@ -218,8 +244,16 @@ class Log():
           removed_events[event.uuid] = True
 
         if event.action == DELETE_ACTION and snapshot_exists: 
-          if not dry_run:
+          if dry_run:
+            continue
+
+          if event.is_scenario():
+            # We still need to check each request in a scenario to make sure another scenario does not depend on it
+            snapshot.remove(lambda snapshot: self.remove_request_snapshot(snapshot, scenario_inverted_index))
+          elif event.is_request():
+            # We have already checked that a scenario does not depend on the request above
             snapshot.remove()
+
           Logger.instance(LOG_ID).info(f"Removing {event.resource} snapshot")
 
   def build_raw_events(self, contents: str) -> List[str]:
@@ -242,6 +276,8 @@ class Log():
     '''
     Remove DELETE events where 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
     index = {}
     for event in processed_events:
       if event.action == PUT_ACTION:
@@ -249,10 +285,18 @@ class Log():
       elif event.action == DELETE_ACTION:
         if event.resource_uuid in index:
           del index[event.resource_uuid]
+
+    scenario_inverted_index = self.scenario_inverted_index
+
+    def keep(e: LogEvent):
+      if e.action != DELETE_ACTION:
+        return True
+      
+      return e.action == DELETE_ACTION and e.is_request() and e.resource_uuid in scenario_inverted_index
     
     return list(
       filter(
-        lambda e: e.action != DELETE_ACTION or (e.action == DELETE_ACTION and e.resource_uuid in index), 
+        keep,
         unprocessed_events
       )
     )
@@ -289,6 +333,12 @@ class Log():
     remaining_events = self.remove_dangling_events(processed_events, unprocessed_events)
     return list(filter(lambda e: e.uuid not in remaining_version_uuids, remaining_events))
 
+  def remove_request_snapshot(self, snapshot: RequestSnapshot, scenario_inverted_index: dict = None):
+    scenario_inverted_index = scenario_inverted_index or self.scenario_inverted_index
+
+    if snapshot.uuid not in scenario_inverted_index:
+      snapshot.remove()
+
   # Rotate log to history
   def rotate(self):
     if not os.path.exists(self.__log_file_path):

{stoobly_agent-1.9.0 → stoobly_agent-1.9.1}/stoobly_agent/app/models/factories/resource/local_db/helpers/request_snapshot.py

@@ -1,5 +1,4 @@
 import os
-import shutil
 
 from stoobly_agent.app.models.adapters.orm import JoinedRequestStringAdapter
 from stoobly_agent.lib.orm.request import Request

{stoobly_agent-1.9.0 → stoobly_agent-1.9.1}/stoobly_agent/app/models/factories/resource/local_db/helpers/scenario_snapshot.py

@@ -1,7 +1,6 @@
 import json
 import os
 import pdb
-import shutil
 
 from typing import Callable, List
 
@@ -128,12 +127,12 @@ class ScenarioSnapshot(Snapshot):
     if os.path.exists(metadata_file_path):
       os.remove(metadata_file_path)
 
-  def remove_requests(self):
+  def remove_requests(self, handle_remove_request_snapshot = None):
     requests_file_path = self.requests_path
 
     if os.path.exists(requests_file_path):
       # A request only every belongs to one scenario
-      self.iter_request_snapshots(self.__handle_remove_requests)
+      self.iter_request_snapshots(handle_remove_request_snapshot or self.__handle_remove_requests)
 
       os.remove(requests_file_path)
 

{stoobly_agent-1.9.0 → stoobly_agent-1.9.1}/stoobly_agent/app/models/factories/resource/local_db/helpers/snapshot_service.py

@@ -14,15 +14,17 @@ def snapshot_request(request: Request, **options: RequestSnapshotOptions):
     return
 
   snapshot = RequestSnapshot(request.uuid)
-
   snapshot.backup()
 
+  log = Log()
+
   if action == PUT_ACTION:
     snapshot.write(request, **options)
   elif action == DELETE_ACTION:
-    snapshot.remove()
+    inverted_scenario_index = log.scenario_inverted_index
 
-  log = Log()
+    # If a scenario currently depends on this request, we can't remove the snapshot until the scenario is also removed
+    log.remove_request_snapshot(snapshot, inverted_scenario_index) 
 
   try:
     if action == PUT_ACTION:
@@ -40,7 +42,6 @@ def snapshot_scenario(scenario: Scenario, **options):
     return
 
   snapshot = ScenarioSnapshot(scenario.uuid)
-
   snapshot.backup_metadata()
 
   if action == PUT_ACTION:
@@ -50,13 +51,13 @@ def snapshot_scenario(scenario: Scenario, **options):
 
   snapshot.backup_requests()
 
+  log = Log()
+  inverted_scenario_index = log.scenario_inverted_index
   if action == PUT_ACTION:
-    snapshot.remove_requests()
+    snapshot.remove_requests(lambda snapshot: log.remove_request_snapshot(snapshot, inverted_scenario_index))
     snapshot.write_requests(scenario, **options)
   elif action == DELETE_ACTION:
-    snapshot.remove_requests()
-
-  log = Log()
+    snapshot.remove_requests(lambda snapshot: log.remove_request_snapshot(snapshot, inverted_scenario_index))
 
   if action == PUT_ACTION:
     log.put(scenario)

{stoobly_agent-1.9.0 → stoobly_agent-1.9.1}/stoobly_agent/app/models/helpers/apply.py

@@ -1,5 +1,7 @@
 import pdb
 
+from typing import List
+
 from stoobly_agent.app.models.factories.resource.local_db.helpers.log import Log
 from stoobly_agent.app.models.factories.resource.local_db.helpers.request_snapshot import RequestSnapshot
 from stoobly_agent.app.models.factories.resource.local_db.helpers.scenario_snapshot import ScenarioSnapshot
@@ -71,6 +73,7 @@ class Apply():
       if results:
         status = results[1]
         if status == 0 or status >= 400:
+          self.__logger(f"{bcolors.FAIL}Error{bcolors.ENDC} {results[0]}")
           completed = False
           break
 
@@ -218,14 +221,16 @@ class Apply():
 
     snapshot_requests = {}
 
-    request_snapshots = snapshot.request_snapshots
+    request_snapshots: List[RequestSnapshot] = snapshot.request_snapshots
     for request_snapshot in request_snapshots:
       raw_request = request_snapshot.request
-      
-      toks = raw_request.split(REQUEST_STRING_CLRF, 1)
 
+      if not raw_request:
+        return f"{request_snapshot.path} is missing", 400
+        
+      toks = raw_request.split(REQUEST_STRING_CLRF, 1)
       if len(toks) != 2:
-        return f"{snapshot.requests_path} contains an invalid request", 400
+        return f"{request_snapshot.path} contains an invalid request", 400
 
       uuid = request_snapshot.uuid
       res, status = self.__put_request(uuid, raw_request, scenario_id=scenario['id'])

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

@@ -547,4 +547,146 @@ class TestApply():
         recreated_scenario = Scenario.find_by(uuid=created_scenario.uuid)
         assert recreated_scenario
 
-        assert len(recreated_scenario.requests) == 0
+        assert len(recreated_scenario.requests) == 0
+
+    class TestWhenDeletingRequestWhileReferenced():
+
+      class TestWhenRemoveScenarioRequest():
+        '''
+        1. Create scenario
+        2. Add 2 requests to it
+        3. Snapshot scenario
+        4. Snapshot requests with action DELETE_ACTION
+        5. Apply
+        6. Expect scenario to have 1 request
+        '''
+
+        @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 delete_event(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
+
+          time.sleep(0.5) # So events do not have the same uuid
+
+          created_request = created_scenario_requests[1]
+          snapshot_result = runner.invoke(request, ['snapshot', created_request.key(), '--action', DELETE_ACTION])
+          assert snapshot_result.exit_code == 0
+
+          log = Log()
+          events = log.events
+          return events[len(events) - 1]
+
+        @pytest.fixture(scope='class')
+        def apply_result(self, runner: CliRunner, created_scenario: Scenario):
+          created_scenario = Scenario.find(created_scenario.id)
+          assert created_scenario.requests_count == 2
+          apply_result = runner.invoke(snapshot, ['apply'])
+
+          return apply_result
+
+        def test_it_updates_scenario(self, created_scenario: Scenario, apply_result):
+          assert apply_result.exit_code == 0
+
+          created_scenario = Scenario.find(created_scenario.id)
+          assert created_scenario.requests_count == 1
+
+        def test_it_maintains_requests(self, created_scenario: Scenario, created_scenario_requests: List[Request]):
+          created_scenario = Scenario.find(created_scenario.id)
+          assert len(created_scenario.requests) == 1
+
+          requests = created_scenario.requests
+
+          assert_orm_request_equivalent(requests[0], created_scenario_requests[0])
+      
+      class TestWhenMovingScenarioRequest():
+        '''
+        1. Create scenario one and scenario two
+        2. Add 1 request to scenario one
+        3. Snapshot scenario one
+        4. Move scenario one request to scenario two
+        5. Snapshot scenario two
+        5. Apply
+        6. Expect scenario one to have 0 requests
+        7. Expect scenario two to have 1 request
+        '''
+
+        @pytest.fixture(scope='class')
+        def created_scenario_one(self, runner: CliRunner):
+          create_result = runner.invoke(scenario, ['create', 'test1'])
+          assert create_result.exit_code == 0
+          return Scenario.last()
+
+        @pytest.fixture(scope='class')
+        def created_scenario_two(self, runner: CliRunner):
+          create_result = runner.invoke(scenario, ['create', 'test2'])
+          assert create_result.exit_code == 0
+          return Scenario.last()
+
+        @pytest.fixture(scope='class', autouse=True)
+        def created_scenario_request(self, runner: CliRunner, created_scenario_one: Scenario):
+          record_result = runner.invoke(record, ['--scenario-key', created_scenario_one.key(), DETERMINISTIC_GET_REQUEST_URL])
+          assert record_result.exit_code == 0
+
+          return created_scenario_one.requests[0]
+
+        @pytest.fixture(scope='class', autouse=True)
+        def put_event_one(self, runner: CliRunner, created_scenario_one: Scenario, created_scenario_request: Request):
+          snapshot_result = runner.invoke(scenario, ['snapshot', created_scenario_one.key()])
+          assert snapshot_result.exit_code == 0
+
+          log = Log()
+          events = log.events
+          return events[len(events) - 1]
+
+        @pytest.fixture(scope='class', autouse=True)
+        def put_event_two(self, runner: CliRunner, created_scenario_two: Scenario, created_scenario_request: Request):
+          created_scenario_request.update(scenario_id=created_scenario_two.id)
+
+          snapshot_result = runner.invoke(scenario, ['snapshot', created_scenario_two.key()])
+          assert snapshot_result.exit_code == 0
+
+          log = Log()
+          events = log.events
+          return events[len(events) - 1]
+
+        @pytest.fixture(scope='class')
+        def apply_result(self, runner: CliRunner):
+          apply_result = runner.invoke(snapshot, ['apply'])
+
+          return apply_result
+
+        def test_it_removes_request_from_scenario_one(self, created_scenario_one: Scenario, apply_result):
+          assert apply_result.exit_code == 0
+
+          created_scenario_one = Scenario.find(created_scenario_one.id)
+          assert created_scenario_one.requests_count == 0
+
+        def test_it_adds_request_to_scenario_two(self, created_scenario_two: Scenario, apply_result):
+          assert apply_result.exit_code == 0
+
+          created_scenario_two = Scenario.find(created_scenario_two.id)
+          assert created_scenario_two.requests_count == 1
+
+        def test_it_maintains_requests(self, created_scenario_two: Scenario, created_scenario_request):
+          created_scenario_two = Scenario.find(created_scenario_two.id)
+          assert len(created_scenario_two.requests) == 1
+
+          requests = created_scenario_two.requests
+
+          assert_orm_request_equivalent(requests[0], created_scenario_request)

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

@@ -3,12 +3,14 @@ import pytest
 import time
 
 from click.testing import CliRunner
+from typing import List
 
 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, LogEvent
-from stoobly_agent.cli import record, request, snapshot
+from stoobly_agent.cli import record, request, scenario, snapshot
 from stoobly_agent.lib.orm.request import Request
-from stoobly_agent.test.test_helper import DETERMINISTIC_GET_REQUEST_URL, reset
+from stoobly_agent.lib.orm.scenario import Scenario
+from stoobly_agent.test.test_helper import assert_orm_request_equivalent, DETERMINISTIC_GET_REQUEST_URL, NON_DETERMINISTIC_GET_REQUEST_URL, reset
 
 @pytest.fixture(scope='module')
 def runner():
@@ -107,4 +109,71 @@ class TestPrune():
 
         apply_result = runner.invoke(snapshot, ['prune'])
         assert apply_result.exit_code == 0
-        assert len(log.events) == 0
+        assert len(log.events) == 0
+
+    class TestWhenRemoveScenarioRequest():
+      '''
+      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
+      6. Apply
+      7. Expect scenario to have 1 request
+      '''
+
+      @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 delete_event(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
+
+        time.sleep(0.5) # So events do not have the same uuid
+
+        created_request = created_scenario_requests[1]
+        snapshot_result = runner.invoke(request, ['snapshot', created_request.key(), '--action', DELETE_ACTION])
+        assert snapshot_result.exit_code == 0
+
+        log = Log()
+        events = log.events
+        return events[len(events) - 1]
+
+      @pytest.fixture(scope='class')
+      def apply_result(self, runner: CliRunner, created_scenario: Scenario):
+        prune_result = runner.invoke(snapshot, ['prune'])
+        assert prune_result.exit_code == 0
+
+        created_scenario = Scenario.find(created_scenario.id)
+        assert created_scenario.requests_count == 2
+        apply_result = runner.invoke(snapshot, ['apply'])
+
+        return apply_result
+
+      def test_it_updates_scenario(self, created_scenario: Scenario, apply_result):
+        assert apply_result.exit_code == 0
+
+        created_scenario = Scenario.find(created_scenario.id)
+        assert created_scenario.requests_count == 1
+
+      def test_it_maintains_requests(self, created_scenario: Scenario, created_scenario_requests: List[Request]):
+        created_scenario = Scenario.find(created_scenario.id)
+        assert len(created_scenario.requests) == 1
+
+        requests = created_scenario.requests
+
+        assert_orm_request_equivalent(requests[0], created_scenario_requests[0])

stoobly_agent-1.9.1/stoobly_agent/test/app/models/schemas/.stoobly/db/VERSION

@@ -0,0 +1 @@
+1.9.0

stoobly_agent-1.9.0/stoobly_agent/test/app/models/schemas/.stoobly/db/VERSION

@@ -1 +0,0 @@
-1.8.5