Merge pull request #302 from reportportal/5.1

5.1

Author: HardNorth

README.rst

@@ -84,7 +84,6 @@ Example of :code:`pytest.ini`:
     rp_launch = AnyLaunchName
     rp_launch_attributes = 'PyTest' 'Smoke'
     rp_launch_description = 'Smoke test'
-    rp_ignore_errors = True
     rp_ignore_attributes = 'xfail' 'usefixture'
 
 - The :code:`rp_uuid` can also be set with the environment variable `RP_UUID`. This will override the value set for :code:`rp_uuid` in pytest.ini
@@ -101,21 +100,15 @@ The following parameters are optional:
   by pytest --rp-launch-description option, default value is '')
 
 - :code:`rp_log_batch_size = 20` - size of batch log request
-- :code:`rp_ignore_errors = True` - Ignore Report Portal errors (exit otherwise)
 - :code:`rp_ignore_attributes = 'xfail' 'usefixture'` - Ignore specified pytest markers
 - :code:`rp_is_skipped_an_issue = False` - Treat skipped tests as required investigation. Default is True.
-- :code:`rp_hierarchy_dirs = True` - Enables hierarchy for tests directories, default `False`. Doesn't support 'xdist' plugin.
-- :code:`rp_hierarchy_module = True` - Enables hierarchy for module, default `True`. Doesn't support 'xdist' plugin.
-- :code:`rp_hierarchy_class = True` - Enables hierarchy for class, default `True`. Doesn't support 'xdist' plugin.
-- :code:`rp_hierarchy_parametrize = True` - Enables hierarchy parametrized tests, default `False`. Doesn't support 'xdist' plugin.
 - :code:`rp_hierarchy_dirs_level = 0` - Directory starting hierarchy level (from pytest.ini level) (default `0`)
-- :code:`rp_issue_marks = 'xfail' 'issue'` - Pytest marks that could be used to get issue information (id, type, reason)
+- :code:`rp_hierarchy_dirs = True` - Enables hierarchy for tests directories, default `False`. Doesn't support 'xdist' plugin.
+- :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 (os.path.sep)
 - :code:`rp_issue_system_url = https://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_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
@@ -246,23 +239,8 @@ Send attachement (screenshots)
 https://github.com/reportportal/client-Python#send-attachement-screenshots
 
 
-
 Troubleshooting
 ~~~~~~~~~~~~~~~
-
-In case you have connectivity issues (or similar problems) with Report Portal,
-it's possible to ignore exceptions raised by :code:`pytest_reportportal` plugin.
-For this, please, add following option to :code:`pytest.ini` configuration file.
-
-.. code-block:: text
-
-    [pytest]
-    ...
-    rp_ignore_errors = True
-
-With option above all exceptions raised by Report Portal will be printed out to
-`stderr` without causing test failures.
-
 If you would like to temporary disable integrations with Report Portal just
 deactivate :code:`pytest_reportportal` plugin with command like:
 

examples/attributes/test_one_attribute.py

@@ -0,0 +1,23 @@
+#  Copyright (c) 2022 https://reportportal.io .
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#  https://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License
+
+import pytest
+
+
+@pytest.mark.scope("smoke")
+def test_custom_attributes_report():
+    """
+    This is a test with one custom markers which shall appear on
+    ReportPortal on test's item
+    """
+    assert True

examples/attributes/test_two_attributes_with_same_key.py

@@ -0,0 +1,24 @@
+#  Copyright (c) 2022 https://reportportal.io .
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#  https://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License
+
+import pytest
+
+
+@pytest.mark.scope("smoke")
+@pytest.mark.scope("regression")
+def test_custom_attributes_report():
+    """
+    This is a test with multiple custom markers which shall appear on
+    ReportPortal on test's item as different attributes
+    """
+    assert True

examples/empty/README.txt

@@ -0,0 +1 @@
+A placeholder file for git

examples/params/test_different_parameter_types.py

@@ -0,0 +1,12 @@
+"""A simple example test with different parameter types."""
+import pytest
+
+
+@pytest.mark.parametrize(
+    ['integer', 'floating_point', 'boolean', 'none'], [(1, 1.5, True, None)]
+)
+def test_in_class_parameterized(integer, floating_point, boolean, none):
+    """
+    This is my test with different parameter types.
+    """
+    assert True

examples/test_in_class_parameterized.py renamed to examples/params/test_in_class_parameterized.py

@@ -0,0 +1,12 @@
+#  Copyright (c) 2022 https://reportportal.io .
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#  https://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License

examples/skip/__init__.py

@@ -0,0 +1,19 @@
+"""Simple example skipped test."""
+#  Copyright (c) 2022 https://reportportal.io .
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#  https://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License
+import pytest
+
+
+@pytest.mark.skip(reason='no way of currently testing this')
+def test_simple_skip():
+    assert False

examples/skip/test_simple_skip.py

@@ -0,0 +1,24 @@
+"""Simple example skipped test."""
+#  Copyright (c) 2022 https://reportportal.io .
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#  https://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License
+import pytest
+
+ID = 'ABC-1234'
+REASON = 'some_bug'
+TYPE = 'PB'
+
+
+@pytest.mark.issue(issue_id=ID, reason=REASON, issue_type=TYPE)
+@pytest.mark.skip(reason='no way of currently testing this')
+def test_simple_skip():
+    assert False

examples/skip/test_skip_issue.py

@@ -0,0 +1,15 @@
+"""This package contains Test Case ID integration test examples.
+
+Copyright (c) 2022 https://reportportal.io .
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License
+"""