ui-coverage-tool 0.1.0__tar.gz

ui_coverage_tool-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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
+
+       http://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.

ui_coverage_tool-0.1.0/MANIFEST.in

@@ -0,0 +1,3 @@
+include swagger_coverage_tool/config.py
+recursive-include swagger_coverage_tool/cli/*
+recursive-include swagger_coverage_tool/src *

ui_coverage_tool-0.1.0/PKG-INFO

@@ -0,0 +1,31 @@
+Metadata-Version: 2.4
+Name: ui-coverage-tool
+Version: 0.1.0
+Summary: TODO
+Home-page: https://github.com/Nikita-Filonov/ui-coverage-tool
+Author: Nikita Filonov
+Author-email: filonov.nikitkaa@gmail.com
+Project-URL: Bug Tracker, https://github.com/Nikita-Filonov/ui-coverage-tool/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: pydantic-settings>=2.8.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+TODO

ui_coverage_tool-0.1.0/README.md

@@ -0,0 +1 @@
+TODO

ui_coverage_tool-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

ui_coverage_tool-0.1.0/setup.py

@@ -0,0 +1,34 @@
+from setuptools import setup, find_packages
+
+setup(
+    name="ui-coverage-tool",
+    version="0.1.0",
+    packages=find_packages(),
+    include_package_data=True,
+    install_requires=[
+        "click",
+        "pyyaml>=6.0.2",
+        "pydantic>=2.0.0",
+        "pydantic-settings>=2.8.0",
+    ],
+    entry_points={
+        'console_scripts': [
+            'ui-coverage-tool = ui_coverage_tool.cli.main:cli',
+        ],
+    },
+    author="Nikita Filonov",
+    author_email="filonov.nikitkaa@gmail.com",
+    description="TODO",
+    long_description=open('README.md').read(),
+    long_description_content_type="text/markdown",
+    url="https://github.com/Nikita-Filonov/ui-coverage-tool",
+    project_urls={
+        "Bug Tracker": "https://github.com/Nikita-Filonov/ui-coverage-tool/issues",
+    },
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    python_requires='>=3.11',
+)

ui_coverage_tool-0.1.0/ui_coverage_tool/cli/commands/save_report.py

@@ -0,0 +1,41 @@
+from ui_coverage_tool.config import get_settings
+from ui_coverage_tool.src.coverage.builder import UICoverageBuilder
+from ui_coverage_tool.src.history.builder import UICoverageHistoryBuilder
+from ui_coverage_tool.src.history.storage import UICoverageHistoryStorage
+from ui_coverage_tool.src.reports.models import CoverageReportState
+from ui_coverage_tool.src.reports.storage import UIReportsStorage
+from ui_coverage_tool.src.tools.logger import get_logger
+from ui_coverage_tool.src.tracker.storage import UICoverageTrackerStorage
+
+logger = get_logger("SAVE_REPORT")
+
+
+def save_report_command():
+    logger.info("Starting to save the report")
+
+    settings = get_settings()
+
+    reports_storage = UIReportsStorage(settings=settings)
+    tracker_storage = UICoverageTrackerStorage(settings=settings)
+    history_storage = UICoverageHistoryStorage(settings=settings)
+
+    report_state = CoverageReportState.init(settings)
+    history_state = history_storage.load()
+    tracker_state = tracker_storage.load()
+    for app in settings.apps:
+        results_list = tracker_state.filter(app=app.key)
+
+        coverage_builder = UICoverageBuilder(
+            results_list=results_list,
+            history_builder=UICoverageHistoryBuilder(
+                history=history_state.apps[app.key],
+                settings=settings
+            )
+        )
+        report_state.services_coverage[app.key] = coverage_builder.build()
+
+    history_storage.save_from_report(report_state)
+    reports_storage.save_json_report(report_state)
+    reports_storage.save_html_report(report_state)
+
+    logger.info("Report saving process completed")

ui_coverage_tool-0.1.0/ui_coverage_tool/cli/main.py

@@ -0,0 +1,22 @@
+import click
+
+from ui_coverage_tool.cli.commands.save_report import save_report_command
+
+
+@click.command(
+    name="save-report",
+    help="Generate a coverage report based on collected result files."
+)
+def save_report():
+    save_report_command()
+
+
+@click.group()
+def cli():
+    pass
+
+
+cli.add_command(save_report)
+
+if __name__ == '__main__':
+    cli()

ui_coverage_tool-0.1.0/ui_coverage_tool/config.py

@@ -0,0 +1,80 @@
+import importlib.metadata
+import importlib.resources
+import os
+from functools import lru_cache
+from pathlib import Path
+
+from pydantic import BaseModel, HttpUrl
+from pydantic_settings import (
+    BaseSettings,
+    SettingsConfigDict,
+    YamlConfigSettingsSource,
+    JsonConfigSettingsSource,
+    PydanticBaseSettingsSource,
+)
+
+from ui_coverage_tool.src.tools.types import AppKey, AppName
+
+
+class AppConfig(BaseModel):
+    key: AppKey
+    url: HttpUrl
+    name: AppName
+    tags: list[str] | None = None
+    repository: HttpUrl | None = None
+
+
+class Settings(BaseSettings):
+    model_config = SettingsConfigDict(
+        extra='allow',
+
+        env_file=os.path.join(os.getcwd(), ".env"),
+        env_prefix="UI_COVERAGE_",
+        env_file_encoding="utf-8",
+        env_nested_delimiter=".",
+
+        yaml_file=os.path.join(os.getcwd(), "ui_coverage_config.yaml"),
+        yaml_file_encoding="utf-8",
+
+        json_file=os.path.join(os.getcwd(), "ui_coverage_config.json"),
+        json_file_encoding="utf-8"
+    )
+
+    apps: list[AppConfig]
+
+    results_dir: Path = Path(os.path.join(os.getcwd(), "coverage-results"))
+
+    history_file: Path | None = Path(os.path.join(os.getcwd(), "coverage-history.json"))
+    history_retention_limit: int = 30
+
+    html_report_file: Path | None = Path(os.path.join(os.getcwd(), "index.html"))
+    json_report_file: Path | None = Path(os.path.join(os.getcwd(), "coverage-report.json"))
+
+    @property
+    def html_report_template_file(self):
+        try:
+            return importlib.resources.files("swagger_coverage_tool.src.reports.templates") / "index.html"
+        except importlib.metadata.PackageNotFoundError:
+            return Path(os.path.join(os.getcwd(), "swagger_coverage_tool/src/reports/templates/index.html"))
+
+    @classmethod
+    def settings_customise_sources(
+            cls,
+            settings_cls: type[BaseSettings],
+            init_settings: PydanticBaseSettingsSource,
+            env_settings: PydanticBaseSettingsSource,
+            dotenv_settings: PydanticBaseSettingsSource,
+            file_secret_settings: PydanticBaseSettingsSource,
+    ) -> tuple[PydanticBaseSettingsSource, ...]:
+        return (
+            YamlConfigSettingsSource(cls),
+            JsonConfigSettingsSource(cls),
+            env_settings,
+            dotenv_settings,
+            init_settings,
+        )
+
+
+@lru_cache(maxsize=None)
+def get_settings() -> Settings:
+    return Settings()

ui_coverage_tool-0.1.0/ui_coverage_tool/src/coverage/builder.py

@@ -0,0 +1,53 @@
+from ui_coverage_tool.src.coverage.models import AppCoverage, ElementCoverage, ActionCoverage
+from ui_coverage_tool.src.history.builder import UICoverageHistoryBuilder
+from ui_coverage_tool.src.history.models import ActionHistory
+from ui_coverage_tool.src.tools.actions import ActionType
+from ui_coverage_tool.src.tools.selector import SelectorType
+from ui_coverage_tool.src.tools.types import Selector
+from ui_coverage_tool.src.tracker.models import CoverageResultList
+
+
+class UICoverageBuilder:
+    def __init__(self, results_list: CoverageResultList, history_builder: UICoverageHistoryBuilder):
+        self.results_list = results_list
+        self.history_builder = history_builder
+
+    def build_element_coverage(
+            self,
+            results: CoverageResultList,
+            selector: Selector,
+            selector_type: SelectorType
+    ) -> ElementCoverage:
+        actions = [
+            ActionCoverage(type=action, count=results.count_action(action))
+            for action in ActionType.to_list()
+            if results.count_action(action) > 0
+        ]
+
+        return ElementCoverage(
+            history=self.history_builder.get_element_history(
+                actions=[ActionHistory(type=action.type, count=action.count) for action in actions],
+                selector=selector,
+                selector_type=selector_type
+            ),
+            actions=actions,
+            selector=selector,
+            selector_type=selector_type,
+        )
+
+    def build(self) -> AppCoverage:
+        return AppCoverage(
+            history=self.history_builder.get_total_app_history(
+                actions=[
+                    ActionHistory(type=action, count=results.total_actions)
+                    for action, results in self.results_list.grouped_by_action.items()
+                    if results.total_actions > 0
+                ],
+                total_actions=self.results_list.total_actions,
+                total_elements=self.results_list.total_selectors
+            ),
+            elements=[
+                self.build_element_coverage(results, selector, selector_type)
+                for (selector, selector_type), results in self.results_list.grouped_by_selector.items()
+            ],
+        )

ui_coverage_tool-0.1.0/ui_coverage_tool/src/coverage/models.py

@@ -0,0 +1,25 @@
+from pydantic import BaseModel, Field, ConfigDict
+
+from ui_coverage_tool.src.history.models import ElementHistory, TotalAppHistory
+from ui_coverage_tool.src.tools.actions import ActionType
+from ui_coverage_tool.src.tools.selector import SelectorType
+from ui_coverage_tool.src.tools.types import Selector
+
+
+class ActionCoverage(BaseModel):
+    type: ActionType
+    count: int
+
+
+class ElementCoverage(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+
+    history: list[ElementHistory]
+    actions: list[ActionCoverage]
+    selector: Selector
+    selector_type: SelectorType = Field(alias="selectorType")
+
+
+class AppCoverage(BaseModel):
+    history: list[TotalAppHistory]
+    elements: list[ElementCoverage]

ui_coverage_tool-0.1.0/ui_coverage_tool/src/history/builder.py

@@ -0,0 +1,71 @@
+from dataclasses import dataclass
+from datetime import datetime
+from typing import TypeVar, Callable
+
+from ui_coverage_tool.config import Settings
+from ui_coverage_tool.src.history.models import ElementHistory, TotalAppHistory, AppHistory, ActionHistory
+from ui_coverage_tool.src.history.selector import build_selector_key
+from ui_coverage_tool.src.tools.selector import SelectorType
+from ui_coverage_tool.src.tools.types import Selector
+
+T = TypeVar('T')
+
+
+class UICoverageHistoryBuilder:
+    def __init__(self, history: AppHistory, settings: Settings):
+        self.history = history
+        self.settings = settings
+        self.created_at = datetime.now()
+
+    def build_element_history(self, actions: list[ActionHistory]) -> ElementHistory:
+        return ElementHistory(created_at=self.created_at, actions=actions)
+
+    def build_total_app_history(
+            self,
+            actions: list[ActionHistory],
+            total_actions: int,
+            total_elements: int
+    ) -> TotalAppHistory:
+        return TotalAppHistory(
+            actions=actions,
+            created_at=self.created_at,
+            total_actions=total_actions,
+            total_elements=total_elements
+        )
+
+    def append_history(self, history: list[T], build_func: Callable[[], T]) -> list[T]:
+        if not self.settings.history_file:
+            return []
+
+        new_item = build_func()
+        if not new_item.actions:
+            return history
+
+        combined = [*history, new_item]
+        combined.sort(key=lambda r: r.created_at)
+        return combined[-self.settings.history_retention_limit:]
+
+    def get_element_history(
+            self,
+            actions: list[ActionHistory],
+            selector: Selector,
+            selector_type: SelectorType
+    ) -> list[ElementHistory]:
+        key = build_selector_key(selector, selector_type)
+        history = self.history.elements.get(key, [])
+        return self.append_history(history, lambda: self.build_element_history(actions))
+
+    def get_total_app_history(
+            self,
+            actions: list[ActionHistory],
+            total_actions: int,
+            total_elements: int
+    ) -> list[TotalAppHistory]:
+        return self.append_history(
+            self.history.total,
+            lambda: self.build_total_app_history(
+                actions=actions,
+                total_actions=total_actions,
+                total_elements=total_elements
+            )
+        )

ui_coverage_tool-0.1.0/ui_coverage_tool/src/history/models.py

@@ -0,0 +1,36 @@
+from datetime import datetime
+
+from pydantic import BaseModel, Field, ConfigDict
+
+from ui_coverage_tool.src.tools.actions import ActionType
+from ui_coverage_tool.src.tools.types import AppKey
+
+
+class ActionHistory(BaseModel):
+    type: ActionType
+    count: int
+
+
+class ElementHistory(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+
+    actions: list[ActionHistory]
+    created_at: datetime = Field(alias="createdAt")
+
+
+class TotalAppHistory(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+
+    actions: list[ActionHistory]
+    created_at: datetime = Field(alias="createdAt")
+    total_actions: int = Field(alias="totalActions")
+    total_elements: int = Field(alias="totalElements")
+
+
+class AppHistory(BaseModel):
+    total: list[TotalAppHistory]
+    elements: dict[str, list[ElementHistory]]
+
+
+class CoverageHistoryState(BaseModel):
+    apps: dict[AppKey, AppHistory] = Field(default_factory=dict)

ui_coverage_tool-0.1.0/ui_coverage_tool/src/history/selector.py

@@ -0,0 +1,6 @@
+from ui_coverage_tool.src.tools.selector import SelectorType
+from ui_coverage_tool.src.tools.types import Selector, SelectorKey
+
+
+def build_selector_key(selector: Selector, selector_type: SelectorType) -> SelectorKey:
+    return SelectorKey(f'{selector_type}_{selector}')

ui_coverage_tool-0.1.0/ui_coverage_tool/src/history/storage.py

@@ -0,0 +1,55 @@
+from ui_coverage_tool.config import Settings
+from ui_coverage_tool.src.history.models import CoverageHistoryState, AppHistory
+from ui_coverage_tool.src.history.selector import build_selector_key
+from ui_coverage_tool.src.reports.models import CoverageReportState
+from ui_coverage_tool.src.tools.logger import get_logger
+
+logger = get_logger("UI_COVERAGE_HISTORY_STORAGE")
+
+
+class UICoverageHistoryStorage:
+    def __init__(self, settings: Settings):
+        self.settings = settings
+
+    def load(self):
+        history_file = self.settings.history_file
+
+        if not history_file:
+            logger.debug("No history file path provided, returning empty history state")
+            return CoverageHistoryState()
+
+        if not history_file.exists():
+            logger.debug("History file not found, returning empty history state")
+            return CoverageHistoryState()
+
+        try:
+            logger.info(f"Loading history from file: {history_file}")
+            return CoverageHistoryState.model_validate_json(history_file.read_text())
+        except Exception as error:
+            logger.error(f"Error loading history from file {history_file}: {error}")
+            return CoverageHistoryState()
+
+    def save(self, state: CoverageHistoryState):
+        history_file = self.settings.history_file
+
+        try:
+            history_file.touch(exist_ok=True)
+            history_file.write_text(state.model_dump_json(by_alias=True))
+            logger.info(f"History state saved to file: {history_file}")
+        except Exception as error:
+            logger.error(f"Error saving history to file {history_file}: {error}")
+
+    def save_from_report(self, report: CoverageReportState):
+        state = CoverageHistoryState(
+            apps={
+                app.key: AppHistory(
+                    total=report.apps_coverage[app.key].history,
+                    elements={
+                        build_selector_key(element.selector, element.selector_type): element.history
+                        for element in report.apps_coverage[app.key].elements
+                    }
+                )
+                for app in self.settings.apps
+            }
+        )
+        self.save(state)

ui_coverage_tool-0.1.0/ui_coverage_tool/src/reports/models.py

@@ -0,0 +1,33 @@
+from datetime import datetime
+
+from pydantic import BaseModel, Field, ConfigDict, FilePath, HttpUrl
+from swagger_coverage_tool.config import ServiceConfig, Settings
+
+from ui_coverage_tool.config import AppConfig
+from ui_coverage_tool.src.coverage.models import AppCoverage
+from ui_coverage_tool.src.tools.types import AppKey
+
+
+class CoverageReportServiceConfig(ServiceConfig):
+    model_config = ConfigDict(populate_by_name=True)
+
+    swagger_url: HttpUrl | None = Field(alias="swaggerUrl", default=None)
+    swagger_file: FilePath | None = Field(alias="swaggerFile", default=None)
+
+
+class CoverageReportConfig(BaseModel):
+    apps: list[AppConfig]
+
+
+class CoverageReportState(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+
+    config: CoverageReportConfig
+    created_at: datetime = Field(alias="createdAt", default_factory=datetime.now)
+    apps_coverage: dict[AppKey, AppCoverage] = Field(alias="appsCoverage", default_factory=dict)
+
+    @classmethod
+    def init(cls, settings: Settings):
+        return CoverageReportState(
+            config=CoverageReportConfig(apps=settings.apps)
+        )

ui_coverage_tool-0.1.0/ui_coverage_tool/src/reports/storage.py

@@ -0,0 +1,52 @@
+import re
+
+from ui_coverage_tool.config import Settings
+from ui_coverage_tool.src.reports.models import CoverageReportState
+from ui_coverage_tool.src.tools.logger import get_logger
+
+logger = get_logger("UI_REPORTS_STORAGE")
+
+
+class UIReportsStorage:
+    def __init__(self, settings: Settings):
+        self.settings = settings
+
+    def inject_state_into_html(self, state: CoverageReportState) -> str:
+        state_json = state.model_dump_json(by_alias=True)
+        html_report_template_file = self.settings.html_report_template_file
+
+        script_regex = re.compile(
+            r'<script id="state" type="application/json">[\s\S]*?</script>',
+            re.IGNORECASE
+        )
+        script_tag = f'<script id="state" type="application/json">{state_json}</script>'
+
+        return script_regex.sub(script_tag, html_report_template_file.read_text(encoding='utf-8'))
+
+    def save_json_report(self, state: CoverageReportState):
+        json_report_file = self.settings.json_report_file
+
+        if not json_report_file:
+            logger.info("JSON report file is not configured — skipping JSON report generation.")
+            return
+
+        try:
+            json_report_file.touch(exist_ok=True)
+            json_report_file.write_text(state.model_dump_json(by_alias=True))
+            logger.info(f'JSON report saved to {json_report_file}')
+        except Exception as error:
+            logger.error(f'Failed to write JSON report: {error}')
+
+    def save_html_report(self, state: CoverageReportState):
+        html_report_file = self.settings.html_report_file
+
+        if not html_report_file:
+            logger.info("HTML report file is not configured — skipping HTML report generation.")
+            return
+
+        try:
+            html_report_file.touch(exist_ok=True)
+            html_report_file.write_text(self.inject_state_into_html(state), encoding='utf-8')
+            logger.info(f'HTML report saved to {html_report_file}')
+        except Exception as error:
+            logger.error(f'Failed to write HTML report: {error}')

ui_coverage_tool-0.1.0/ui_coverage_tool/src/tools/actions.py

@@ -0,0 +1,13 @@
+from enum import Enum
+from typing import Self
+
+
+class ActionType(str, Enum):
+    FILL = "FILL"
+    CLICK = "CLICK"
+    ASSERT_VISIBLE = "ASSERT_VISIBLE"
+    ASSERT_HAVE_TEXT = "ASSERT_HAVE_TEXT"
+
+    @classmethod
+    def to_list(cls) -> list[Self]:
+        return list(cls)

ui_coverage_tool-0.1.0/ui_coverage_tool/src/tools/logger.py

@@ -0,0 +1,16 @@
+import logging
+
+
+def get_logger(name: str) -> logging.Logger:
+    logger = logging.getLogger(name)
+    logger.setLevel(logging.DEBUG)
+
+    handler = logging.StreamHandler()
+    handler.setLevel(logging.DEBUG)
+
+    formatter = logging.Formatter('%(asctime)s | %(name)s | %(levelname)s | %(message)s')
+    handler.setFormatter(formatter)
+
+    logger.addHandler(handler)
+
+    return logger

ui_coverage_tool-0.1.0/ui_coverage_tool/src/tools/selector.py

@@ -0,0 +1,9 @@
+from enum import Enum
+
+
+class SelectorType(str, Enum):
+    CSS = "CSS"
+    XPATH = "XPATH"
+
+    def __str__(self) -> str:
+        return str(self.value)

ui_coverage_tool-0.1.0/ui_coverage_tool/src/tools/types.py

@@ -0,0 +1,7 @@
+from typing import NewType
+
+AppKey = NewType('AppKey', str)
+AppName = NewType('AppName', str)
+
+Selector = NewType('Selector', str)
+SelectorKey = NewType('SelectorKey', str)

ui_coverage_tool-0.1.0/ui_coverage_tool/src/tracker/core.py

@@ -0,0 +1,30 @@
+from ui_coverage_tool.config import Settings, get_settings
+from ui_coverage_tool.src.tools.logger import get_logger
+from ui_coverage_tool.src.tools.types import Selector, AppKey
+from ui_coverage_tool.src.tracker.models import SelectorType, ActionType, CoverageResult
+from ui_coverage_tool.src.tracker.storage import UICoverageTrackerStorage
+
+logger = get_logger("UI_COVERAGE_TRACKER_STORAGE")
+
+
+class UICoverageTracker:
+    def __init__(self, app: AppKey, settings: Settings | None = None):
+        self.app = app
+        self.settings = settings or get_settings()
+
+        self.storage = UICoverageTrackerStorage(self.settings)
+
+    def track_coverage(
+            self,
+            selector: str,
+            action_type: ActionType,
+            selector_type: SelectorType,
+    ):
+        self.storage.save(
+            CoverageResult(
+                app=self.app,
+                selector=Selector(selector),
+                action_type=action_type,
+                selector_type=selector_type
+            )
+        )

ui_coverage_tool-0.1.0/ui_coverage_tool/src/tracker/models.py

@@ -0,0 +1,71 @@
+from collections import Counter
+from functools import cached_property
+from itertools import groupby
+from typing import Self
+
+from pydantic import BaseModel, RootModel
+
+from ui_coverage_tool.src.tools.actions import ActionType
+from ui_coverage_tool.src.tools.selector import SelectorType
+from ui_coverage_tool.src.tools.types import Selector, AppKey
+
+SelectorGroupKey = tuple[Selector, SelectorType]
+
+
+class CoverageResult(BaseModel):
+    app: AppKey
+    selector: Selector
+    action_type: ActionType
+    selector_type: SelectorType
+
+
+class CoverageResultList(RootModel):
+    root: list[CoverageResult]
+
+    def filter(self, app: AppKey | None = None) -> Self:
+        results = [
+            coverage
+            for coverage in self.root
+            if (app is None or coverage.app.lower() == app.lower())
+        ]
+        return CoverageResultList(root=results)
+
+    @cached_property
+    def grouped_by_action(self) -> dict[ActionType, Self]:
+        results = sorted(self.root, key=lambda r: r.action_type)
+        return {
+            grouper: CoverageResultList(root=results)
+            for grouper, results in groupby(results, key=lambda r: r.action_type)
+        }
+
+    @cached_property
+    def grouped_by_selector(self) -> dict[SelectorGroupKey, Self]:
+        results = sorted(self.root, key=lambda r: (r.selector, r.selector_type))
+        return {
+            grouper: CoverageResultList(root=results)
+            for grouper, results in groupby(results, key=lambda r: (r.selector, r.selector_type))
+        }
+
+    @property
+    def total_actions(self) -> int:
+        return len(self.root)
+
+    @property
+    def total_selectors(self) -> int:
+        return len(self.grouped_by_selector)
+
+    def count_action(self, action_type: ActionType) -> int:
+        counter = Counter(r.action_type for r in self.root)
+        return counter.get(action_type, 0)
+
+
+r = CoverageResultList(
+    root=[
+        CoverageResult(selector="#user", selector_type=SelectorType.CSS, action_type=ActionType.FILL),
+        CoverageResult(selector="#user", selector_type=SelectorType.XPATH, action_type=ActionType.FILL),
+        CoverageResult(selector="#user", selector_type=SelectorType.CSS, action_type=ActionType.FILL),
+        CoverageResult(selector="#user", selector_type=SelectorType.XPATH, action_type=ActionType.CLICK),
+        CoverageResult(selector="#user", selector_type=SelectorType.CSS, action_type=ActionType.FILL)
+    ]
+)
+print(r.grouped_by_action)

ui_coverage_tool-0.1.0/ui_coverage_tool/src/tracker/storage.py

@@ -0,0 +1,42 @@
+import uuid
+
+from ui_coverage_tool.config import Settings
+from ui_coverage_tool.src.tools.logger import get_logger
+from ui_coverage_tool.src.tracker.models import CoverageResult, CoverageResultList
+
+logger = get_logger("UI_COVERAGE_TRACKER_STORAGE")
+
+
+class UICoverageTrackerStorage:
+    def __init__(self, settings: Settings):
+        self.settings = settings
+
+    def load(self) -> CoverageResultList:
+        results_dir = self.settings.results_dir
+        logger.info(f"Loading coverage results from directory: {results_dir}")
+
+        if not results_dir.exists():
+            logger.warning(f"Results directory does not exist: {results_dir}")
+            return CoverageResultList(root=[])
+
+        results = [
+            CoverageResultList.model_validate_json(file.read_text())
+            for file in results_dir.glob("*.json") if file.is_file()
+        ]
+
+        logger.info(f"Loaded {len(results)} coverage files from directory: {results_dir}")
+        return CoverageResultList(root=results)
+
+    def save(self, coverage: CoverageResult):
+        results_dir = self.settings.results_dir
+
+        if not results_dir.exists():
+            logger.info(f"Results directory does not exist, creating: {results_dir}")
+            results_dir.mkdir(exist_ok=True)
+
+        result_file = results_dir.joinpath(f'{uuid.uuid4()}.json')
+
+        try:
+            result_file.write_text(coverage.model_dump_json())
+        except Exception as error:
+            logger.error(f"Error saving coverage data to file {result_file}: {error}")

ui_coverage_tool-0.1.0/ui_coverage_tool.egg-info/PKG-INFO

@@ -0,0 +1,31 @@
+Metadata-Version: 2.4
+Name: ui-coverage-tool
+Version: 0.1.0
+Summary: TODO
+Home-page: https://github.com/Nikita-Filonov/ui-coverage-tool
+Author: Nikita Filonov
+Author-email: filonov.nikitkaa@gmail.com
+Project-URL: Bug Tracker, https://github.com/Nikita-Filonov/ui-coverage-tool/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: pydantic-settings>=2.8.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+TODO

ui_coverage_tool-0.1.0/ui_coverage_tool.egg-info/SOURCES.txt

@@ -0,0 +1,37 @@
+LICENSE
+MANIFEST.in
+README.md
+setup.py
+ui_coverage_tool/__init__.py
+ui_coverage_tool/config.py
+ui_coverage_tool.egg-info/PKG-INFO
+ui_coverage_tool.egg-info/SOURCES.txt
+ui_coverage_tool.egg-info/dependency_links.txt
+ui_coverage_tool.egg-info/entry_points.txt
+ui_coverage_tool.egg-info/requires.txt
+ui_coverage_tool.egg-info/top_level.txt
+ui_coverage_tool/cli/__init__.py
+ui_coverage_tool/cli/main.py
+ui_coverage_tool/cli/commands/__init__.py
+ui_coverage_tool/cli/commands/save_report.py
+ui_coverage_tool/src/__init__.py
+ui_coverage_tool/src/coverage/__init__.py
+ui_coverage_tool/src/coverage/builder.py
+ui_coverage_tool/src/coverage/models.py
+ui_coverage_tool/src/history/__init__.py
+ui_coverage_tool/src/history/builder.py
+ui_coverage_tool/src/history/models.py
+ui_coverage_tool/src/history/selector.py
+ui_coverage_tool/src/history/storage.py
+ui_coverage_tool/src/reports/__init__.py
+ui_coverage_tool/src/reports/models.py
+ui_coverage_tool/src/reports/storage.py
+ui_coverage_tool/src/tools/__init__.py
+ui_coverage_tool/src/tools/actions.py
+ui_coverage_tool/src/tools/logger.py
+ui_coverage_tool/src/tools/selector.py
+ui_coverage_tool/src/tools/types.py
+ui_coverage_tool/src/tracker/__init__.py
+ui_coverage_tool/src/tracker/core.py
+ui_coverage_tool/src/tracker/models.py
+ui_coverage_tool/src/tracker/storage.py

ui_coverage_tool-0.1.0/ui_coverage_tool.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ui_coverage_tool-0.1.0/ui_coverage_tool.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+ui-coverage-tool = ui_coverage_tool.cli.main:cli

ui_coverage_tool-0.1.0/ui_coverage_tool.egg-info/requires.txt

@@ -0,0 +1,4 @@
+click
+pyyaml>=6.0.2
+pydantic>=2.0.0
+pydantic-settings>=2.8.0

ui_coverage_tool-0.1.0/ui_coverage_tool.egg-info/top_level.txt

@@ -0,0 +1 @@
+ui_coverage_tool