Merge pull request #286 from reportportal/suite-path-fix

Suite path fix

Author: HardNorth

.pre-commit-config.yaml

@@ -12,6 +12,11 @@ repos:
     rev: 6.0.0
     hooks:
     -   id: pydocstyle
+        exclude: |
+            (?x)^(
+                tests/.* |
+                examples/.*
+            )
 -   repo: https://github.com/Lucas-C/pre-commit-hooks-markup
     rev: v1.0.1
     hooks:

README.rst

@@ -113,7 +113,9 @@ The following parameters are optional:
 - :code:`rp_issue_system_url = http://bugzilla.some.com/show_bug.cgi?id={%issue_id}` - issue URL (issue_id will be filled by parameter from pytest mark)
 - :code:`rp_issue_id_marks = True` - Enables adding marks for issue ids (e.g. "issue:123456")
 - :code:`rp_verify_ssl = True` - Verify SSL when connecting to the server
-- :code:`rp_display_suite_test_file = True` In case of True, include the suite's relative file path in the launch name as a convention of "<RELATIVE_FILE_PATH>::<SUITE_NAME>". In case of False, set the launch name to be the suite name only - this flag is relevant only when "rp_hierarchy_module" flag is set to False
+- :code:`rp_display_suite_test_file = True` - In case of True, include the suite's relative file path in the launch name as a convention of "<RELATIVE_FILE_PATH>::<SUITE_NAME>". In case of False, set the launch name to be the suite name only - this flag is relevant only when "rp_hierarchy_module" flag is set to False
+- :code:`rp_mode = DEFAULT` - DEBUG or DEFAULT launch mode. DEBUG launches are displayed in a separate tab and not visible to anyone except owner
+- :code:`rp_hierarchy_dir_path_separator` - Path separator to display directories in test hierarchy. In case of empty value current system path separator will be used
 
 
 If you like to override the above parameters from command line, or from CI environment based on your build, then pass

examples/hierarchy/another_inner/test_another_inner_simple.py

@@ -0,0 +1,6 @@
+"""Simple example test."""
+
+
+def test_simple():
+    """Simple example test."""
+    assert True

examples/hierarchy/inner/test_inner_simple.py

@@ -0,0 +1,6 @@
+"""Simple example test."""
+
+
+def test_simple():
+    """Simple example test."""
+    assert True

examples/hierarchy/test_in_class.py

@@ -0,0 +1,9 @@
+"""A simple example test in a class."""
+
+
+class Tests:
+    def test_in_class(self):
+        """
+        This is my test inside `Tests` class
+        """
+        assert True

examples/hierarchy/test_in_class_in_class.py

@@ -0,0 +1,10 @@
+"""A simple example test in a class in a class."""
+
+
+class Tests:
+    class Test:
+        def test_in_class_in_class(self):
+            """
+            This is my test inside `Test` class
+            """
+            assert True

examples/test_in_class_parameterized.py

@@ -0,0 +1,12 @@
+"""A simple example test in a class with a parameter."""
+import pytest
+
+
+class Tests:
+
+    @pytest.mark.parametrize('param', ['param'])
+    def test_in_class_parameterized(self, param):
+        """
+        This is my test inside `Tests` class with a parameter
+        """
+        assert True

pytest_reportportal/config.py

@@ -19,6 +19,8 @@ def __init__(self, pytest_config):
         self.pconfig = pytest_config
 
         self.rp_endpoint = self.find_option('rp_endpoint')
+        self.rp_hierarchy_dir_path_separator = self.find_option(
+            'rp_hierarchy_dir_path_separator')
         self.rp_ignore_errors = self.find_option('rp_ignore_errors')
         self.rp_ignore_attributes = self.find_option('rp_ignore_attributes')
         self.rp_is_skipped_an_issue = self.find_option(

pytest_reportportal/config.pyi

@@ -5,6 +5,7 @@ class AgentConfig:
     _rp_rerun: Optional[bool] = ...
     pconfig: Config = ...
     rp_endpoint: Text = ...
+    rp_hierarchy_dir_path_separator: Text = ...
     rp_ignore_errors: bool = ...
     rp_ignore_attributes: Optional[List] = ...
     rp_is_skipped_an_issue: bool = ...
@@ -14,13 +15,14 @@ class AgentConfig:
     rp_launch_description: Text = ...
     rp_log_batch_size: int = ...
     rp_log_level: Optional[int] = ...
+    rp_mode: str = ...
     rp_parent_item_id: Optional[Text] = ...
     rp_project: Text = ...
     rp_rerun_of: Optional[Text] = ...
     rp_retries: int = ...
     rp_uuid: Text = ...
     rp_verify_ssl: bool = ...
-    rp_mode: str = ...
+
     def __init__(self, pytest_config: Config) -> None: ...
     @property
     def rp_rerun(self) -> Optional[bool]: ...

pytest_reportportal/plugin.py

@@ -378,3 +378,7 @@ def add_shared_option(name, help, default=None, action='store'):
         'retries',
         default='0',
         help='Amount of retries for performing REST calls to RP server')
+    parser.addini(
+        'rp_hierarchy_dir_path_separator',
+        default='',
+        help='Path separator to display directories in test hierarchy')