launchable 1.87.2__tar.gz → 1.89.0__tar.gz

{launchable-1.87.2 → launchable-1.89.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: launchable
-Version: 1.87.2
+Version: 1.89.0
 Summary: Launchable CLI
 Home-page: https://launchableinc.com/
 Author: Launchable, Inc.

{launchable-1.87.2 → launchable-1.89.0}/launchable/commands/helper.py

@@ -7,7 +7,7 @@ from launchable.utils.tracking import TrackingClient
 
 from ..app import Application
 from ..utils.launchable_client import LaunchableClient
-from ..utils.session import read_build, read_session
+from ..utils.session import parse_session, read_build, read_session
 
 
 def require_session(
@@ -20,6 +20,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
         return session
 
     session = read_session(require_build())

{launchable-1.87.2 → launchable-1.89.0}/launchable/commands/record/build.py

@@ -114,12 +114,17 @@ def build(ctx: click.core.Context, build_name: str, source: List[str], max_days:
         branch: str
         # SHA1 commit hash that's currently checked out
         commit_hash: str
+        # identifier that represents how this workspace info was captured. Temporarily introduced for IB-395
+        # currently using 'source' and 'commit' to represent whether a local workspace was present (source) or
+        # if it was just given as a commit hash (commit)
+        mode: str
 
-        def __init__(self, name, dir=None, branch=None, commit_hash=None):
+        def __init__(self, name, dir=None, branch=None, commit_hash=None, mode=None):
             self.name = name
             self.dir = dir
             self.branch = branch
             self.commit_hash = commit_hash
+            self.mode = mode
 
         def calc_branch_name(self):
             '''
@@ -184,9 +189,9 @@ def build(ctx: click.core.Context, build_name: str, source: List[str], max_days:
         for s in source:
             if pattern.match(s):
                 kv = s.split('=')
-                ws.append(Workspace(name=kv[0], dir=kv[1]))
+                ws.append(Workspace(name=kv[0], dir=kv[1], mode='source'))
             else:
-                ws.append(Workspace(name=s, dir=s))
+                ws.append(Workspace(name=s, dir=s, mode='source'))
             # TODO: if repo_dir is absolute path, warn the user that that's probably
             # not what they want to do
         return ws
@@ -226,7 +231,8 @@ def build(ctx: click.core.Context, build_name: str, source: List[str], max_days:
                         r.append(Workspace(
                             name=w.name + "/" + name,
                             dir=w.dir + "/" + name,
-                            commit_hash=commit_hash))
+                            commit_hash=commit_hash,
+                            mode='source'))
         return r
 
     # figure out the commit hash and branch of those workspaces
@@ -268,7 +274,7 @@ def build(ctx: click.core.Context, build_name: str, source: List[str], max_days:
                     err=True)
                 sys.exit(1)
 
-            ws[name] = Workspace(name=name, commit_hash=hash, branch=branch_name_map.get(name))
+            ws[name] = Workspace(name=name, commit_hash=hash, branch=branch_name_map.get(name), mode='commit')
 
         # make sure no invalid branch name options are given
         for k in branch_name_map:
@@ -304,7 +310,8 @@ def build(ctx: click.core.Context, build_name: str, source: List[str], max_days:
                 "commitHashes": [{
                     'repositoryName': w.name,
                     'commitHash': w.commit_hash,
-                    'branchName': w.branch or ""
+                    'branchName': w.branch or "",
+                    'mode': w.mode
                 } for w in ws],
                 "links": compute_links()
             }

{launchable-1.87.2 → launchable-1.89.0}/launchable/commands/record/session.py

@@ -90,6 +90,14 @@ def _validate_session_name(ctx, param, value):
     type=str,
     metavar='LINEAGE',
 )
+@click.option(
+    '--test-suite',
+    'test_suite',
+    help='Set test suite name. A test suite is a collection of test sessions. Setting a test suite allows you to manage data over test sessions and lineages.',  # noqa: E501
+    required=False,
+    type=str,
+    metavar='TEST_SUITE',
+)
 @click.pass_context
 def session(
     ctx: click.core.Context,
@@ -102,6 +110,7 @@ def session(
     is_no_build: bool = False,
     session_name: Optional[str] = None,
     lineage: Optional[str] = None,
+    test_suite: Optional[str] = None,
 ):
     """
     print_session is for backward compatibility.
@@ -158,6 +167,7 @@ def session(
         "isObservation": is_observation,
         "noBuild": is_no_build,
         "lineage": lineage,
+        "testSuite": test_suite,
     }
 
     _links = capture_link(os.environ)

{launchable-1.87.2 → launchable-1.89.0}/launchable/test_runners/minitest.py

@@ -1,9 +1,8 @@
-import glob
-import os
-from . import launchable
+import click
 from junitparser import TestCase, TestSuite  # type: ignore
+
 from ..testpath import TestPath
-import click
+from . import launchable
 
 subset = launchable.CommonSubsetImpls(__name__).scan_files('*_test.rb')
 split_subset = launchable.CommonSplitSubsetImpls(__name__).split_subset()

{launchable-1.87.2 → launchable-1.89.0}/launchable/test_runners/nunit.py

@@ -1,12 +1,10 @@
-import glob
-import os
 from typing import Callable, Dict, List
 from xml.etree import ElementTree as ET
 
 import click
 
 from launchable.commands.record.case_event import CaseEvent
-from launchable.testpath import TestPath, unparse_test_path, parse_test_path
+from launchable.testpath import TestPath, parse_test_path, unparse_test_path
 
 from . import launchable
 

{launchable-1.87.2 → launchable-1.89.0}/launchable.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: launchable
-Version: 1.87.2
+Version: 1.89.0
 Summary: Launchable CLI
 Home-page: https://launchableinc.com/
 Author: Launchable, Inc.

{launchable-1.87.2 → launchable-1.89.0}/tests/cli_test_case.py

@@ -7,6 +7,7 @@ import tempfile
 import types
 import unittest
 from pathlib import Path
+from typing import Any, Dict, List
 
 import click  # type: ignore
 import responses  # type: ignore
@@ -237,6 +238,7 @@ class CliTestCase(unittest.TestCase):
 
         expected = self.load_json_from_file(self.test_files_dir.joinpath(golden_image_filename))
         self.assert_json_orderless_equal(expected, payload)
+        self.assert_test_path_orderly_equal(expected, payload)
 
     def assert_subset_payload(self, golden_image_filename: str, payload=None):
         '''
@@ -294,3 +296,31 @@ class CliTestCase(unittest.TestCase):
                 return obj
 
         self.assertEqual(tree_sorted(a), tree_sorted(b))
+
+    def assert_test_path_orderly_equal(self, a: Dict[str, Any], b: Dict[str, Any]):
+        """
+        Compare orders of the values associated with the `testPath` key in two dictionaries
+
+        Pre-conditions:
+        - Both 'a' and 'b' should contain 'events' key.
+        - The value associated with the 'events' key should be a list of dictionaries,
+        and each dictionary must include a 'testPath' key.
+
+        Exceptions:
+        - If 'a' or 'b' does not comply with the pre-conditions (e.g., missing keys, wrong data structure),
+        the method may raise KeyError or TypeError before the assertion takes place.
+        """
+        def extract_all_test_paths(obj: Dict[str, Any]) -> List[str]:
+            paths_list = []
+            for event in obj['events']:
+                paths_list.append(event['testPath'])
+            return paths_list
+
+        a_test_paths = extract_all_test_paths(a)
+        b_test_paths = extract_all_test_paths(b)
+
+        # We cannot compare a and b directory such as `a['events']['testPath']==b['events']['testPath']`.
+        # It's because the value associated with the 'events' key is in random order.
+        self.assertCountEqual(a_test_paths, b_test_paths)
+        for test_path in a_test_paths:
+            self.assertIn(test_path, b_test_paths, "Expected to include {}".format(test_path))

{launchable-1.87.2 → launchable-1.89.0}/tests/commands/record/test_build.py

@@ -45,17 +45,20 @@ class BuildTest(CliTestCase):
                     {
                         "repositoryName": ".",
                         "commitHash": "c50f5de0f06fe16afa4fd1dd615e4903e40b42a2",
-                        "branchName": "main"
+                        "branchName": "main",
+                        "mode": "source"
                     },
                     {
                         "repositoryName": "./foo",
                         "commitHash": "491e03096e2234dab9a9533da714fb6eff5dcaa7",
-                        "branchName": ""
+                        "branchName": "",
+                        "mode": "source"
                     },
                     {
                         "repositoryName": "./bar-zot",
                         "commitHash": "8bccab48338219e73c3118ad71c8c98fbd32a4be",
-                        "branchName": ""
+                        "branchName": "",
+                        "mode": "source"
                     },
                 ],
                 "links": []
@@ -88,7 +91,8 @@ class BuildTest(CliTestCase):
                     {
                         "repositoryName": ".",
                         "commitHash": "c50f5de0f06fe16afa4fd1dd615e4903e40b42a2",
-                        "branchName": ""
+                        "branchName": "",
+                        "mode": "source"
                     },
                 ],
                 "links": []
@@ -119,6 +123,7 @@ class BuildTest(CliTestCase):
                             "repositoryName": ".",
                             "commitHash": "c50f5de0f06fe16afa4fd1dd615e4903e40b42a2",
                             "branchName": "",
+                            "mode": "commit"
                         },
                     ],
                     "links": []
@@ -146,7 +151,8 @@ class BuildTest(CliTestCase):
                     {
                         "repositoryName": "A",
                         "commitHash": "abc12",
-                        "branchName": ""
+                        "branchName": "",
+                        "mode": "commit"
                     },
                 ],
                 "links": []
@@ -174,7 +180,8 @@ class BuildTest(CliTestCase):
                     {
                         "repositoryName": "A",
                         "commitHash": "abc12",
-                        "branchName": "feature-xxx"
+                        "branchName": "feature-xxx",
+                        "mode": "commit"
                     },
                 ],
                 "links": []
@@ -202,7 +209,8 @@ class BuildTest(CliTestCase):
                     {
                         "repositoryName": "A",
                         "commitHash": "abc12",
-                        "branchName": ""
+                        "branchName": "",
+                        "mode": "commit"
                     },
                 ],
                 "links": []
@@ -235,12 +243,14 @@ class BuildTest(CliTestCase):
                     {
                         "repositoryName": "A",
                         "commitHash": "abc12",
-                        "branchName": "feature-xxx"
+                        "branchName": "feature-xxx",
+                        "mode": "commit"
                     },
                     {
                         "repositoryName": "B",
                         "commitHash": "56cde",
-                        "branchName": "feature-yyy"
+                        "branchName": "feature-yyy",
+                        "mode": "commit"
                     },
                 ],
                 "links": []

{launchable-1.87.2 → launchable-1.89.0}/tests/commands/record/test_session.py

@@ -27,11 +27,14 @@ class SessionTest(CliTestCase):
         self.assert_success(result)
 
         payload = json.loads(responses.calls[0].request.body.decode())
-        self.assert_json_orderless_equal(
-            {"flavors": {},
-             "isObservation": False, "links": [],
-             "noBuild": False, "lineage": None},
-            payload)
+        self.assert_json_orderless_equal({
+            "flavors": {},
+            "isObservation": False,
+            "links": [],
+            "noBuild": False,
+            "lineage": None,
+            "testSuite": None,
+        }, payload)
 
     @responses.activate
     @mock.patch.dict(os.environ, {
@@ -54,6 +57,7 @@ class SessionTest(CliTestCase):
             "links": [],
             "noBuild": False,
             "lineage": None,
+            "testSuite": None,
         }, payload)
 
         with self.assertRaises(ValueError):
@@ -73,11 +77,14 @@ class SessionTest(CliTestCase):
 
         payload = json.loads(responses.calls[0].request.body.decode())
 
-        self.assert_json_orderless_equal(
-            {"flavors": {},
-             "isObservation": True, "links": [],
-             "noBuild": False, "lineage": None},
-            payload)
+        self.assert_json_orderless_equal({
+            "flavors": {},
+            "isObservation": True,
+            "links": [],
+            "noBuild": False,
+            "lineage": None,
+            "testSuite": None,
+        }, payload)
 
     @responses.activate
     @mock.patch.dict(os.environ, {
@@ -108,11 +115,14 @@ class SessionTest(CliTestCase):
         self.assert_success(result)
 
         payload = json.loads(responses.calls[3].request.body.decode())
-        self.assert_json_orderless_equal(
-            {"flavors": {},
-             "isObservation": False, "links": [],
-             "noBuild": False, "lineage": None},
-            payload)
+        self.assert_json_orderless_equal({
+            "flavors": {},
+            "isObservation": False,
+            "links": [],
+            "noBuild": False,
+            "lineage": None,
+            "testSuite": None,
+        }, payload)
 
     @responses.activate
     @mock.patch.dict(os.environ, {
@@ -131,4 +141,25 @@ class SessionTest(CliTestCase):
             "links": [],
             "noBuild": False,
             "lineage": "example-lineage",
+            "testSuite": None,
+        }, payload)
+
+    @responses.activate
+    @mock.patch.dict(os.environ, {
+        "LAUNCHABLE_TOKEN": CliTestCase.launchable_token,
+        'LANG': 'C.UTF-8',
+    }, clear=True)
+    def test_run_session_with_test_suite(self):
+        result = self.cli("record", "session", "--build", self.build_name,
+                          "--test-suite", "example-test-suite")
+        self.assert_success(result)
+
+        payload = json.loads(responses.calls[0].request.body.decode())
+        self.assert_json_orderless_equal({
+            "flavors": {},
+            "isObservation": False,
+            "links": [],
+            "noBuild": False,
+            "lineage": None,
+            "testSuite": "example-test-suite",
         }, payload)

{launchable-1.87.2 → launchable-1.89.0}/tests/data/minitest/record_test_result.json

@@ -4,13 +4,13 @@
       "type": "case",
       "testPath": [
         { "type": "file", "name": "test/models/user_copy_test.rb" },
-        {
-          "type": "testcase",
-          "name": "test_should_save_user_with_name"
-        },
         {
           "type": "class",
           "name": "UserCopyTest"
+        },
+        {
+          "type": "testcase",
+          "name": "test_should_save_user_with_name"
         }
       ],
       "duration": 1.602778,
@@ -23,13 +23,13 @@
       "type": "case",
       "testPath": [
         { "type": "file", "name": "test/models/user_copy_test.rb" },
-        {
-          "type": "testcase",
-          "name": "test_should_not_save_user_without_name"
-        },
         {
           "type": "class",
           "name": "UserCopyTest"
+        },
+        {
+          "type": "testcase",
+          "name": "test_should_not_save_user_without_name"
         }
       ],
       "duration": 1.606243,
@@ -42,13 +42,13 @@
       "type": "case",
       "testPath": [
         { "type": "file", "name": "test/models/admin/user_test.rb" },
-        {
-          "type": "testcase",
-          "name": "test_should_not_save_user_without_name"
-        },
         {
           "type": "class",
           "name": "Admin::UserTest"
+        },
+        {
+          "type": "testcase",
+          "name": "test_should_not_save_user_without_name"
         }
       ],
       "duration": 1.611738,
@@ -61,13 +61,13 @@
       "type": "case",
       "testPath": [
         { "type": "file", "name": "test/models/admin/user_test.rb" },
-        {
-          "type": "testcase",
-          "name": "test_should_save_user_with_name"
-        },
         {
           "type": "class",
           "name": "Admin::UserTest"
+        },
+        {
+          "type": "testcase",
+          "name": "test_should_save_user_with_name"
         }
       ],
       "duration": 1.607029,
@@ -80,13 +80,13 @@
       "type": "case",
       "testPath": [
         { "type": "file", "name": "test/models/open_class_user_test.rb" },
-        {
-          "type": "testcase",
-          "name": "test_should_not_save_user_without_name_2"
-        },
         {
           "type": "class",
           "name": "UserTest"
+        },
+        {
+          "type": "testcase",
+          "name": "test_should_not_save_user_without_name_2"
         }
       ],
       "duration": 1.614255,
@@ -99,13 +99,13 @@
       "type": "case",
       "testPath": [
         { "type": "file", "name": "test/controllers/user_test.rb" },
-        {
-          "type": "testcase",
-          "name": "test_should_save_user_with_name"
-        },
         {
           "type": "class",
           "name": "UserControllerTest"
+        },
+        {
+          "type": "testcase",
+          "name": "test_should_save_user_with_name"
         }
       ],
       "duration": 1.617726,
@@ -118,11 +118,11 @@
       "type": "case",
       "testPath": [
         { "type": "file", "name": "test/controllers/user_test.rb" },
+        { "type": "class", "name": "UserControllerTest" },
         {
           "type": "testcase",
           "name": "test_should_not_save_user_without_name"
-        },
-        { "type": "class", "name": "UserControllerTest" }
+        }
       ],
       "duration": 1.611985,
       "status": 1,
@@ -134,8 +134,8 @@
       "type": "case",
       "testPath": [
         { "type": "file", "name": "test/models/admin/user_test.rb" },
-        { "type": "testcase", "name": "test_child" },
-        { "type": "class", "name": "Admin::UserTest::ChildlenTest" }
+        { "type": "class", "name": "Admin::UserTest::ChildlenTest" },
+        { "type": "testcase", "name": "test_child" }
       ],
       "duration": 1.599567,
       "status": 1,