Merge pull request #1091 from launchableinc/AIENG-204

Validate session flag format in subset command

Author: gayanW

launchable/commands/helper.py

@@ -9,7 +9,7 @@
 
 from ..app import Application
 from ..utils.launchable_client import LaunchableClient
-from ..utils.session import parse_session, read_build, read_session
+from ..utils.session import read_build, read_session, validate_session_format
 
 
 def require_session(
@@ -22,7 +22,7 @@ def require_session(
        See https://github.com/launchableinc/cli/pull/342
     """
     if session:
-        parse_session(session)  # make sure session is in the right format
+        validate_session_format(session)
         return session
 
     session = read_session(require_build())
@@ -89,6 +89,7 @@ def find_or_create_session(
     from .record.session import session as session_command
 
     if session:
+        validate_session_format(session)
         _check_observation_mode_status(session, is_observation, tracking_client=tracking_client, app=context.obj)
         return session
 

launchable/commands/record/attachment.py

@@ -10,7 +10,7 @@
 @click.option(
     '--session',
     'session',
-    help='Test session ID',
+    help='In the format builds/<build-name>/test_sessions/<test-session-id>',
     type=str,
 )
 @click.argument('attachments', nargs=-1)  # type=click.Path(exists=True)

launchable/commands/record/tests.py

@@ -56,7 +56,7 @@ def _validate_group(ctx, param, value):
 @click.option(
     '--session',
     'session',
-    help='Test session ID',
+    help='In the format builds/<build-name>/test_sessions/<test-session-id>',
     type=str,
 )
 @click.option(

launchable/commands/subset.py

@@ -58,7 +58,7 @@
 @click.option(
     '--session',
     'session',
-    help='Test session ID',
+    help='In the format builds/<build-name>/test_sessions/<test-session-id>',
     type=str,
 )
 @click.option(

launchable/utils/session.py

@@ -98,11 +98,15 @@ def clean_session_files(days_ago: int = 0) -> None:
     remove_session()
 
 
-def parse_session(session: str):
+def validate_session_format(session: str):
     # session format:
     # builds/<build name>/test_sessions/<test session id>
     if session.count("/") != 3:
         raise ParseSessionException(session=session)
 
+
+def parse_session(session: str):
+    validate_session_format(session)
+
     _, build_name, _, session_id = session.split("/")
     return build_name, session_id

tests/test_session.py

@@ -3,8 +3,9 @@
 import tempfile
 from unittest import TestCase
 
-from launchable.utils.session import (SESSION_DIR_KEY, clean_session_files, parse_session, read_build,
-                                      read_session, remove_session, write_build, write_session)
+from launchable.utils.exceptions import ParseSessionException
+from launchable.utils.session import (SESSION_DIR_KEY, clean_session_files, parse_session, read_build, read_session,
+                                      remove_session, validate_session_format, write_build, write_session)
 
 
 class SessionTestClass(TestCase):
@@ -44,3 +45,17 @@ def test_parse_session(self):
 
         with self.assertRaises(Exception):
             parse_session("hoge/fuga")
+
+    def test_validate_session_format(self):
+        # Test with a valid session format
+        validate_session_format("builds/build-name/test_sessions/123")
+
+        # Test with invalid session formats
+        invalid_sessions = [
+            "123",                                              # Only id
+            "workspaces/mothership/builds/123/test_sessions/13"  # Too many parts
+        ]
+
+        for invalid_session in invalid_sessions:
+            with self.assertRaises(ParseSessionException):
+                validate_session_format(invalid_session)