praetorian-cli 2.2.14__tar.gz → 2.2.16__tar.gz

{praetorian_cli-2.2.14/praetorian_cli.egg-info → praetorian_cli-2.2.16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: praetorian-cli
-Version: 2.2.14
+Version: 2.2.16
 Summary: For interacting with the Chariot API
 Home-page: https://github.com/praetorian-inc/praetorian-cli
 Author: Praetorian

{praetorian_cli-2.2.14 → praetorian_cli-2.2.16}/praetorian_cli/handlers/update.py

@@ -36,7 +36,8 @@ def asset(chariot, key, status, surface):
 @click.argument('key', required=True)
 @click.option('-s', '--status', type=click.Choice([s.value for s in Risk]), help=f'Status of the risk')
 @click.option('-c', '--comment', default='', help='Comment for the risk')
-def risk(chariot, key, status, comment):
+@click.option('-r', '--remove-comment', type=int, default=None, help='Remove comment at index (0, 1, ... or -1 for most recent)')
+def risk(chariot, key, status, comment, remove_comment):
     """ Update the status and comment of a risk
 
     \b
@@ -47,8 +48,13 @@ def risk(chariot, key, status, comment):
     Example usages:
         - praetorian chariot update risk "#risk#www.example.com#CVE-2024-23049" --status OH --comment "Open it as a high severity risk"
         - praetorian chariot update risk "#risk#www.example.com#open-ssh-port" --status RH --comment "John stopped sshd on the server"
+        - praetorian chariot update risk "#risk#www.example.com#CVE-2024-23049" --remove-comment 0
+        - praetorian chariot update risk "#risk#www.example.com#CVE-2024-23049" --remove-comment -1
     """
-    chariot.risks.update(key, status, comment)
+    if comment and remove_comment is not None:
+        raise click.UsageError("Cannot use --comment and --remove-comment together")
+
+    chariot.risks.update(key, status, comment, remove_comment)
 
 
 @update.command()

{praetorian_cli-2.2.14 → praetorian_cli-2.2.16}/praetorian_cli/sdk/entities/risks.py

@@ -44,9 +44,9 @@ class Risks:
             risk['affected_assets'] = self.affected_assets(key)
         return risk
 
-    def update(self, key, status=None, comment=None):
+    def update(self, key, status=None, comment=None, remove_comment=None):
         """
-        Update a risk's status and/or comment.
+        Update a risk's status and/or comment, or remove a comment.
 
         :param key: The key of the risk. If you supply a prefix that matches multiple risks, all of them will be updated
         :type key: str
@@ -54,6 +54,8 @@ class Risks:
         :type status: str or None
         :param comment: Comment for the risk update
         :type comment: str or None
+        :param remove_comment: Index of comment to remove (0, 1, ... or -1 for most recent)
+        :type remove_comment: int or None
         :return: API response containing update results
         :rtype: dict
         """
@@ -62,6 +64,9 @@ class Risks:
             params = params | dict(status=status)
         if comment:
             params = params | dict(comment=comment)
+        if remove_comment is not None:
+            index = self.resolve_comment_entry_index(key, remove_comment)
+            params = params | dict(remove=index)
 
         return self.api.upsert('risk', params)
 
@@ -159,3 +164,41 @@ class Risks:
         assets.extend(indirect_assets)
         assets.extend(web_assets)
         return assets
+
+    def resolve_comment_entry_index(self, key, note_index):
+        """
+        Translate a note index to the actual history array index.
+
+        :param key: The key of the risk
+        :param note_index: Index into note entries (0, 1, ... or -1 for most recent note)
+        :return: The actual index in the history array
+        """
+        risk = self.get(key)
+        history = risk.get('history', [])
+        note_indices = get_note_entry_indices(history)
+
+        if len(note_indices) == 0:
+            raise Exception(f"Risk {key} has no notes to remove")
+
+        # Handle negative indexing (e.g., -1 for last note)
+        if note_index < 0:
+            note_index = len(note_indices) + note_index
+
+        if note_index < 0 or note_index >= len(note_indices):
+            raise Exception(f"Note index {note_index} is out of range (0 to {len(note_indices) - 1})")
+
+        return note_indices[note_index]
+
+
+def get_note_entries(risk):
+    history = risk.get('history', [])
+    return [entry for entry in history if is_note_entry(entry)]
+
+
+def get_note_entry_indices(history):
+    """Return the indices in the history array that are note entries."""
+    return [i for i, entry in enumerate(history) if is_note_entry(entry)]
+
+
+def is_note_entry(entry):
+    return entry.get('comment') is not None

{praetorian_cli-2.2.14 → praetorian_cli-2.2.16}/praetorian_cli/sdk/test/test_risk.py

@@ -1,6 +1,7 @@
 import pytest
 
 from praetorian_cli.sdk.model.globals import Risk, Kind
+from praetorian_cli.sdk.entities.risks import get_note_entries
 from praetorian_cli.sdk.test.utils import make_test_values, clean_test_entities, setup_chariot
 
 
@@ -39,6 +40,33 @@ class TestRisk:
         self.sdk.risks.update(self.risk_key, Risk.OPEN_CRITICAL.value)
         assert self.get_risk()['status'] == Risk.OPEN_CRITICAL.value
 
+    def test_remove_comment(self):
+        self.sdk.risks.update(self.risk_key, comment='First comment')
+        self.sdk.risks.update(self.risk_key, comment='Second comment')
+        self.sdk.risks.update(self.risk_key, comment='Third comment')
+
+        risk = self.get_risk()
+        initial_history_len = len(get_note_entries(risk))
+        assert initial_history_len == 3
+
+        self.sdk.risks.update(self.risk_key, remove_comment=-2)
+
+        risk = self.get_risk()
+        new_history_len = len(get_note_entries(risk))
+        assert new_history_len == 2
+
+        self.sdk.risks.update(self.risk_key, remove_comment=-1)
+
+        risk = self.get_risk()
+        final_history_len = len(get_note_entries(risk))
+        assert final_history_len == 1
+
+        self.sdk.risks.update(self.risk_key, remove_comment=0)
+
+        risk = self.get_risk()
+        final_history_len = len(get_note_entries(risk))
+        assert final_history_len == 0
+
     def test_delete_risk(self):
         self.sdk.risks.delete(self.risk_key, Risk.DELETED_DUPLICATE_CRITICAL.value)
         assert self.get_risk()['status'] == Risk.DELETED_DUPLICATE_CRITICAL.value

{praetorian_cli-2.2.14 → praetorian_cli-2.2.16/praetorian_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: praetorian-cli
-Version: 2.2.14
+Version: 2.2.16
 Summary: For interacting with the Chariot API
 Home-page: https://github.com/praetorian-inc/praetorian-cli
 Author: Praetorian

{praetorian_cli-2.2.14 → praetorian_cli-2.2.16}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = praetorian-cli
-version = 2.2.14
+version = 2.2.16
 author = Praetorian
 author_email = support@praetorian.com
 description = For interacting with the Chariot API