pytestomatio 2.2.1__tar.gz

pytestomatio-2.2.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 pytest-analyzer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pytestomatio-2.2.1/PKG-INFO

@@ -0,0 +1,225 @@
+Metadata-Version: 2.1
+Name: pytestomatio
+Version: 2.2.1
+Summary: Pytest plugin to sync test with testomat.io
+Author: Oleksii Ostapov, TikoQA
+Project-URL: Testomat.io, https://testomat.io/
+Project-URL: Homepage, https://github.com/tikolakin/pytestomatio
+Project-URL: Bug Tracker, https://github.com/tikolakin/pytestomatio/issues
+Classifier: Framework :: Pytest
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.29.0
+Requires-Dist: pytest<8.0.0,>=7.3.1
+Requires-Dist: boto3>=1.28.28
+Requires-Dist: libcst==1.1.0
+Requires-Dist: commitizen>=3.18.1
+
+[![Support Ukraine Badge](https://bit.ly/support-ukraine-now)](https://github.com/support-ukraine/support-ukraine)
+
+# testomat.io plugin for pytest
+
+## uses testomat.io API:
+
+- https://testomatio.github.io/check-tests/
+- https://testomatio.github.io/reporter/
+
+## Installation
+
+```bash
+pip install git+https://github.com/tikolakin/pytestomatio.git@1.7#egg=pytestomatio
+```
+
+## configuration
+
+Create environment variable `TESTOMATIO` and set your testomat.io API key.
+Linux:
+
+```bash
+export TESTOMATIO=<key>
+```
+
+Windows (cmd):
+
+```bash
+set TESTOMATIO=<key>
+```
+
+### Run groups parameter
+There is environment variable `TESTOMATIO_RUNGROUP_TITLE` that can be used to specify run tests with specific group title.
+
+### pytest.ini
+In case you are using private testomat.io service, create `pytest.ini` file in your project root directory. Specify
+testomat.io url in it
+
+```ini
+[pytest]
+testomatio_url = https://app.testomat.io
+
+```
+
+## Usage
+
+Synchronize tests to testomat.io and get back test id.
+Tests will not be executed
+
+```bash
+pytest --testomatio sync
+```
+
+Remove all test ids from source code. Tests will not be executed
+
+```bash
+pytest --testomatio remove
+```
+
+Run pytest and send test results into testomat.io.  
+Test can be sent to testomat.io without ids in your test code. If testomat.io failed to match tests by title, it will create
+new tests for the run
+
+```bash
+pytest --testomatio report
+```
+
+Run pytest with debug parameter to get test data collected in metadata.json file
+
+```bash
+pytest --testomatio debug
+```
+
+### Submitting Test Run Environment
+
+to configure test environment, you can use additional option:
+
+```bash
+pytest --testomatio report --testRunEnv "windows11,chrome,1920x1080"
+```
+
+Environment values are comma separated, please use double quotation.
+
+
+### Submitting Test Artifacts
+
+testomat.io does not store any screenshots, logs or other artifacts.
+
+In order to manage them it is advised to use S3 Buckets (GCP Storage).
+https://docs.testomat.io/usage/test-artifacts/
+
+Analyser needs to be aware of the cloud storage credentials.
+There are two options:
+1. Enable **Share credentials with testomat.io Reporter** option in testomat.io Settings -> Artifacts.
+2. Use environment variables   `ACCESS_KEY_ID, SECRET_ACCESS_KEY, ENDPOINT, BUCKET`
+
+You would need to decide when you want to upload your test artifacts to cloud storage
+
+1) Upload page screenshot when test fails, using fixtures [reference](https://docs.pytest.org/en/latest/example/simple.html#making-test-result-information-available-in-fixtures)
+
+```python
+# content of conftest.py
+import pytest
+from typing import Dict
+from pytest import StashKey, CollectReport
+from playwright.sync_api import Page
+
+phase_report_key = StashKey[Dict[str, CollectReport]]()
+
+@pytest.hookimpl(wrapper=True, tryfirst=True)
+def pytest_runtest_makereport(item, call):
+    rep = yield
+    item.stash.setdefault(phase_report_key, {})[rep.when] = rep
+    return rep
+
+
+@pytest.fixture(scope="function")
+def handle_artifacts(page: Page, request):
+    yield
+    report = request.node.stash[phase_report_key]
+    if ("call" not in report) or report["setup"].failed or report["call"].failed:
+        random_string = ''.join(random.choices(string.ascii_letters + string.digits, k=8))
+
+        filename = f"{random_string}.png"
+        screenshot_path = os.path.join(artifacts_dir, filename)
+        page.screenshot(path=screenshot_path)
+        # file_path - required, path to file to be uploaded
+        # file_bytes - required, bytes of the file to be uploaded
+        # key - required, file name in the s3 bucket
+        # bucket_name - optional,name of the bucket to upload file to. Default value is taken from testomat.io
+        artifact_url = pytest.testomatio.upload_file(screenshot_path, filename)
+        # or
+        # artifact_url = pytest.testomatio.upload_file_object(file_bytes, key, bucket_name)
+        pytest.testomatio.add_artifacts(request.node, [artifact_url])
+    page.close()
+```
+
+⚠️ Please take into account s3_connector available only after **pytest_collection_modifyitems()** hook is executed.
+
+2) If you prefer to use pytest hooks - add `pytest_runtest_makereport` hook in your `conftest.py` file.
+
+```python
+def pytest_runtest_makereport(item, call):
+    artifact_url = pytest.testomatio.upload_file(screenshot_path, filename)
+    pytest.testomatio.add_artifacts([artifact_url])
+```
+
+### Clarifications
+
+- tests can be synced even without `@patest.mark.testomatio('@T96c700e6')` decorator.
+- test title in testomat.io == test name in pytest
+- test suit title in testomat.io == test file name in pytest
+
+## Example of test
+
+To make the experience more consistent, it uses standard pytest markers.  
+testomat.io test id is a string value that starts with `@T` and has 8 symbols after.
+
+```python
+import pytest
+
+
+@pytest.mark.testomatio('@T96c700e6')
+def test_example():
+    assert 2 + 2 == 4
+```
+
+### Compatibility table with [Testomatio check-tests](https://github.com/testomatio/check-tests)
+
+| Action |  Compatibility | Method |
+|--------|--------|-------|
+| Importing test into testomat.io | complete | `pytest --testomatio sync` |
+| Exclude hook code of a test | N/A | N/A |
+| Include line number code of a test | N/A | N/A |
+| Import Parametrized Tests | complete | default behaviour |
+| Disable Detached Tests | complete | `pytest --testomatio sync --no-detached` |
+| Synchronous Import | complete | default behaviour |
+| Auto-assign Test IDs in Source Code | complete | default behaviour |
+| Keep Test IDs Between Projects | complete | `pytest --testomatio sync --create` |
+| Clean Test IDs | complete | `pytest --testomatio remove` |
+| Import Into a Branch | N/A | N/A |
+| Keep Structure of Source Code | complete | `pytest --testomatio sync --keep-structure` |
+| Delete Empty Suites | complete | `pytest --testomatio sync --no-empty` |
+| Import Into a Specific Folder | complete | `pytest --testomatio --directory "Windows\smoke"` |
+| Debugging | parity | `pytest --testomatio debug` |
+
+
+## Test
+- import into empty project
+- updated test - (resync)
+- test run
+- test run into a folder
+- test run labels, tags
+
+## TODO
+- Fix test duration
+- Require more back references from testomatio
+- pytest.skip should behave as @pytest.mark.skip
+- Refactor test run and make run url available
+
+## Contribution
+1. `pip install -e .`
+2. `cz commit`
+3. `cz bump`
+4. `git push remoteName branchName --tags`

pytestomatio-2.2.1/README.md

@@ -0,0 +1,204 @@
+[![Support Ukraine Badge](https://bit.ly/support-ukraine-now)](https://github.com/support-ukraine/support-ukraine)
+
+# testomat.io plugin for pytest
+
+## uses testomat.io API:
+
+- https://testomatio.github.io/check-tests/
+- https://testomatio.github.io/reporter/
+
+## Installation
+
+```bash
+pip install git+https://github.com/tikolakin/pytestomatio.git@1.7#egg=pytestomatio
+```
+
+## configuration
+
+Create environment variable `TESTOMATIO` and set your testomat.io API key.
+Linux:
+
+```bash
+export TESTOMATIO=<key>
+```
+
+Windows (cmd):
+
+```bash
+set TESTOMATIO=<key>
+```
+
+### Run groups parameter
+There is environment variable `TESTOMATIO_RUNGROUP_TITLE` that can be used to specify run tests with specific group title.
+
+### pytest.ini
+In case you are using private testomat.io service, create `pytest.ini` file in your project root directory. Specify
+testomat.io url in it
+
+```ini
+[pytest]
+testomatio_url = https://app.testomat.io
+
+```
+
+## Usage
+
+Synchronize tests to testomat.io and get back test id.
+Tests will not be executed
+
+```bash
+pytest --testomatio sync
+```
+
+Remove all test ids from source code. Tests will not be executed
+
+```bash
+pytest --testomatio remove
+```
+
+Run pytest and send test results into testomat.io.  
+Test can be sent to testomat.io without ids in your test code. If testomat.io failed to match tests by title, it will create
+new tests for the run
+
+```bash
+pytest --testomatio report
+```
+
+Run pytest with debug parameter to get test data collected in metadata.json file
+
+```bash
+pytest --testomatio debug
+```
+
+### Submitting Test Run Environment
+
+to configure test environment, you can use additional option:
+
+```bash
+pytest --testomatio report --testRunEnv "windows11,chrome,1920x1080"
+```
+
+Environment values are comma separated, please use double quotation.
+
+
+### Submitting Test Artifacts
+
+testomat.io does not store any screenshots, logs or other artifacts.
+
+In order to manage them it is advised to use S3 Buckets (GCP Storage).
+https://docs.testomat.io/usage/test-artifacts/
+
+Analyser needs to be aware of the cloud storage credentials.
+There are two options:
+1. Enable **Share credentials with testomat.io Reporter** option in testomat.io Settings -> Artifacts.
+2. Use environment variables   `ACCESS_KEY_ID, SECRET_ACCESS_KEY, ENDPOINT, BUCKET`
+
+You would need to decide when you want to upload your test artifacts to cloud storage
+
+1) Upload page screenshot when test fails, using fixtures [reference](https://docs.pytest.org/en/latest/example/simple.html#making-test-result-information-available-in-fixtures)
+
+```python
+# content of conftest.py
+import pytest
+from typing import Dict
+from pytest import StashKey, CollectReport
+from playwright.sync_api import Page
+
+phase_report_key = StashKey[Dict[str, CollectReport]]()
+
+@pytest.hookimpl(wrapper=True, tryfirst=True)
+def pytest_runtest_makereport(item, call):
+    rep = yield
+    item.stash.setdefault(phase_report_key, {})[rep.when] = rep
+    return rep
+
+
+@pytest.fixture(scope="function")
+def handle_artifacts(page: Page, request):
+    yield
+    report = request.node.stash[phase_report_key]
+    if ("call" not in report) or report["setup"].failed or report["call"].failed:
+        random_string = ''.join(random.choices(string.ascii_letters + string.digits, k=8))
+
+        filename = f"{random_string}.png"
+        screenshot_path = os.path.join(artifacts_dir, filename)
+        page.screenshot(path=screenshot_path)
+        # file_path - required, path to file to be uploaded
+        # file_bytes - required, bytes of the file to be uploaded
+        # key - required, file name in the s3 bucket
+        # bucket_name - optional,name of the bucket to upload file to. Default value is taken from testomat.io
+        artifact_url = pytest.testomatio.upload_file(screenshot_path, filename)
+        # or
+        # artifact_url = pytest.testomatio.upload_file_object(file_bytes, key, bucket_name)
+        pytest.testomatio.add_artifacts(request.node, [artifact_url])
+    page.close()
+```
+
+⚠️ Please take into account s3_connector available only after **pytest_collection_modifyitems()** hook is executed.
+
+2) If you prefer to use pytest hooks - add `pytest_runtest_makereport` hook in your `conftest.py` file.
+
+```python
+def pytest_runtest_makereport(item, call):
+    artifact_url = pytest.testomatio.upload_file(screenshot_path, filename)
+    pytest.testomatio.add_artifacts([artifact_url])
+```
+
+### Clarifications
+
+- tests can be synced even without `@patest.mark.testomatio('@T96c700e6')` decorator.
+- test title in testomat.io == test name in pytest
+- test suit title in testomat.io == test file name in pytest
+
+## Example of test
+
+To make the experience more consistent, it uses standard pytest markers.  
+testomat.io test id is a string value that starts with `@T` and has 8 symbols after.
+
+```python
+import pytest
+
+
+@pytest.mark.testomatio('@T96c700e6')
+def test_example():
+    assert 2 + 2 == 4
+```
+
+### Compatibility table with [Testomatio check-tests](https://github.com/testomatio/check-tests)
+
+| Action |  Compatibility | Method |
+|--------|--------|-------|
+| Importing test into testomat.io | complete | `pytest --testomatio sync` |
+| Exclude hook code of a test | N/A | N/A |
+| Include line number code of a test | N/A | N/A |
+| Import Parametrized Tests | complete | default behaviour |
+| Disable Detached Tests | complete | `pytest --testomatio sync --no-detached` |
+| Synchronous Import | complete | default behaviour |
+| Auto-assign Test IDs in Source Code | complete | default behaviour |
+| Keep Test IDs Between Projects | complete | `pytest --testomatio sync --create` |
+| Clean Test IDs | complete | `pytest --testomatio remove` |
+| Import Into a Branch | N/A | N/A |
+| Keep Structure of Source Code | complete | `pytest --testomatio sync --keep-structure` |
+| Delete Empty Suites | complete | `pytest --testomatio sync --no-empty` |
+| Import Into a Specific Folder | complete | `pytest --testomatio --directory "Windows\smoke"` |
+| Debugging | parity | `pytest --testomatio debug` |
+
+
+## Test
+- import into empty project
+- updated test - (resync)
+- test run
+- test run into a folder
+- test run labels, tags
+
+## TODO
+- Fix test duration
+- Require more back references from testomatio
+- pytest.skip should behave as @pytest.mark.skip
+- Refactor test run and make run url available
+
+## Contribution
+1. `pip install -e .`
+2. `cz commit`
+3. `cz bump`
+4. `git push remoteName branchName --tags`

pytestomatio-2.2.1/pyproject.toml

@@ -0,0 +1,45 @@
+[build-system]
+requires = ["setuptools>=65.5.1", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+exclude = [".github", "tests"]
+
+[tool.commitizen]
+name = "cz_conventional_commits"
+tag_format = "$version"
+version_scheme = "pep440"
+version_provider = "pep621"
+update_changelog_on_bump = true
+[project]
+name = "pytestomatio"
+version = "2.2.1"
+
+dependencies = [
+    "requests>=2.29.0",
+    "pytest<8.0.0,>=7.3.1",
+    "boto3>=1.28.28",
+    "libcst==1.1.0",
+    "commitizen>=3.18.1"]
+
+authors = [
+    { name = "Oleksii Ostapov" },
+    { name = "TikoQA" },
+]
+description = "Pytest plugin to sync test with testomat.io"
+readme = "README.md"
+requires-python = ">=3.10"
+classifiers = [
+    "Framework :: Pytest",
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+"Testomat.io" = "https://testomat.io/"
+"Homepage" = "https://github.com/tikolakin/pytestomatio"
+"Bug Tracker" = "https://github.com/tikolakin/pytestomatio/issues"
+
+[project.entry-points.pytest11]
+pytestomatio = "pytestomatio.main"

pytestomatio-2.2.1/pytestomatio/code_collector.py

@@ -0,0 +1,15 @@
+import importlib.util
+import inspect
+
+
+def get_functions_source_by_name(abs_file_path: str, all_tests: list[str]):
+    spec = importlib.util.spec_from_file_location('name', abs_file_path)
+    module = importlib.util.module_from_spec(spec)
+    spec.loader.exec_module(module)
+    functions = inspect.getmembers(module, inspect.isfunction)
+    classes = inspect.getmembers(module, inspect.isclass)
+    for class_name, cls in classes:
+        functions += inspect.getmembers(cls, inspect.isfunction)
+    for function_name, function in functions:
+        if function_name in all_tests:
+            yield function_name, inspect.getsource(function)