robotframework-browserpom 0.1.0__tar.gz

robotframework_browserpom-0.1.0/BrowserPOM/__init__.py

@@ -0,0 +1,104 @@
+from __future__ import absolute_import, unicode_literals
+
+from .keywords import BrowserPomKeywords
+from .pageobject import PageObject
+
+
+class BrowserPOM(BrowserPomKeywords):
+    """*PageObjectLibrary* is a lightweight library which supports using
+        the page object pattern with
+        [https://robotframework-browser.org/|BrowserLibrary].
+        This library does not replace BrowserLibrary; rather, it
+        provides a framework around which to use BrowserLibrary and the
+        lower-level [http://selenium-python.readthedocs.org/|Python
+        bindings to Playwright]
+
+        This library provides the following keywords:
+
+        | =Keyword Name=             | =Synopsis= |
+        | Go to page                 | Goes to the given page in the browser |
+        | The current page should be | Assert that the given page is displayed in the browser |
+
+        PageObjectLibrary provides a PageObject class which should be used
+        as the base class for other page objects. By inheriting from this
+        class your keywords have access to the following pre-defined
+        attributes and methods:
+
+        | =Attribute/method=  | =Description=                             |
+        | ``self.browser`` | A reference to the BrowserLibrary Reference  |
+        | ``self.locator`` | A wrapper around the ``_locators`` dictionary        |
+        | ``self.logger``  | A reference to the ``robot.api.logger`` instance     |
+
+        = Using BrowserLibrary Keywords =
+
+        Within your keywords you have access to the full power of
+        BrowserLibrary. You can use ``self.browser`` to access the
+        library keywords. The following example shows how to call the
+        ``Capture Page Screenshot`` keyword:
+
+        | self.browser.take_screenshot()
+
+        = Creating Page Object Classes =
+
+        Page objects should inherit from PageObjectLibrary.PageObject. At a minimum,
+        the class should define the following attributes:
+
+        | =Attribute= | =Description= |
+        | ``PAGE_URL`` | The path to the current page, without the \
+        hostname and port (eg: ``/dashboard.html``) |
+        | ``PAGE_TITLE`` | The web page title. This is used by the \
+        default implementation of ``_is_current_page``. |
+
+        When using the keywords `Go To Page` or `The Current Page Should Be`, the
+        PageObjectLibrary will call the method ``_is_current_page`` of the given page.
+        By default this will compare the current page title to the ``PAGE_TITLE`` attribute
+        of the page. If you are working on a site where the page titles are not unique,
+        you can override this method to do any type of logic you need.
+
+        = Page Objects are Normal Robot Libraries =
+
+        All rules that apply to keyword libraries applies to page objects. For
+        example, the libraries must be on ``PYTHONPATH``. You may also want to define
+        ``ROBOT_LIBRARY_SCOPE``. Also, the filename and the classname must be identical (minus
+        the ``.py`` suffix on the file).
+
+        = Locators =
+
+        When writing multiple keywords for a page, you often use the same locators in
+        many places. PageObject allows you to define your locators in a dictionary,
+        but them use them with a more convenient dot notation.
+
+        To define locators, create a dictionary named ``_locators``. You can then access
+        the locators via dot notation within your keywords as ``self.locator.<name>``. The
+        ``_locators`` dictionary may have nested dictionaries.
+
+        = Waiting for a Page to be Ready =
+
+        One difficulty with writing Selenium tests is knowing when a page has refreshed.
+        PageObject provides a context manager named ``_wait_for_page_refresh()`` which can
+        be used to wrap a command that should result in a page refresh. It will get a
+        reference to the DOM, run the body of the context manager, and then wait for the
+        DOM to change before returning.
+
+        = Example Page Object Definition =
+
+        | from PageObjectLibrary import PageObject
+        | from robot.libraries.BuiltIn import BuiltIn
+        |
+        | class LoginPage(PageObject):
+        |     PAGE_TITLE = "Login - PageObjectLibrary Demo"
+        |     PAGE_URL = "/"
+        |
+        |    _locators = {
+        |        "username": "id=id_username",
+        |        "password": "id=id_password",
+        |        "submit_button": "id=id_submit",
+        |    }
+        |
+        |    @keyword
+        |    def enter_search(self, search):
+        |       self.browser.type_text(self.locator.search_bar, search)
+        |
+        """
+
+    ROBOT_LIBRARY_SCOPE = "TEST SUITE"

robotframework_browserpom-0.1.0/BrowserPOM/keywords.py

@@ -0,0 +1,102 @@
+from urllib.parse import urlparse
+
+import robot
+from robot.libraries.BuiltIn import BuiltIn
+
+
+class BrowserPomKeywords:
+    """
+    BrowserPOM Library's generic keywords
+
+    | =Keyword Name=             |
+    | Go to page                 |
+    | The current page should be |
+    """
+
+    ROBOT_LIBRARY_SCOPE = "TEST SUITE"
+
+    def __init__(self):
+        self.builtin = BuiltIn()
+        self.logger = robot.api.logger
+
+    def the_current_page_should_be(self, page_name):
+        """Fails if the name of the current page is not the given page name
+
+        ``page_name`` is the name you would use to import the page.
+
+        This keyword will import the given page object, put it at the
+        front of the Robot library search order, then call the method
+        ``_is_current_page`` on the library. The default
+        implementation of this method will compare the page title to
+        the ``PAGE_TITLE`` attribute of the page object, but this
+        implementation can be overridden by each page object.
+
+        """
+
+        page = self._get_page_object(page_name)
+
+        # This causes robot to automatically resolve keyword
+        # conflicts by looking in the current page first.
+        if page._is_current_page():  # pylint: disable=protected-access
+            # only way to get the current order is to set a
+            # new order. Once done, if there actually was an
+            # old order, preserve the old but make sure our
+            # page is at the front of the list
+            old_order = self.builtin.set_library_search_order()
+            new_order = ([str(page)],) + old_order
+            self.builtin.set_library_search_order(new_order)
+            return
+
+        # If we get here, we're not on the page we think we're on
+        raise AssertionError(f"Expected page to be {page_name} but it was not")
+
+    def go_to_page(self, page_name, page_root=None):
+        """Go to the url for the given page object.
+
+        Unless explicitly provided, the URL root will be based on the
+        root of the current page. For example, if the current page is
+        http://www.example.com:8080 and the page object URL is
+        ``/login``, the url will be http://www.example.com:8080/login
+
+        == Example ==
+
+        Given a page object named ``ExampleLoginPage`` with the URL
+        ``/login``, and a browser open to ``http://www.example.com``, the
+        following statement will go to ``http://www.example.com/login``,
+        and place ``ExampleLoginPage`` at the front of Robot's library
+        search order.
+
+        | Go to Page    ExampleLoginPage
+
+        The effect is the same as if you had called the following three
+        keywords:
+
+        | SeleniumLibrary.Go To       http://www.example.com/login
+        | Import Library              ExampleLoginPage
+        | Set Library Search Order    ExampleLoginPage
+
+        Tags: selenium, page-object
+
+        """
+
+        page = self._get_page_object(page_name)
+
+        url = page_root if page_root is not None else page.browser.get_url()
+        (scheme, netloc, _, _, _, _) = urlparse(url)
+        url = f"{scheme}://{netloc}{page.PAGE_URL}"
+
+        page.browser.go_to(url)
+
+    def _get_page_object(self, page_name):
+        """Import the page object if necessary, then return the handle to the library
+
+        Note: If the page object has already been imported, it won't be imported again.
+        """
+
+        try:
+            page = self.builtin.get_library_instance(page_name)
+        except RuntimeError:
+            self.builtin.import_library(page_name)
+            page = self.builtin.get_library_instance(page_name)
+
+        return page

robotframework_browserpom-0.1.0/BrowserPOM/locatormap.py

@@ -0,0 +1,42 @@
+# type: ignore
+from __future__ import absolute_import, unicode_literals
+
+
+class LocatorMap(dict):
+    """LocatorMap - a dict-like object that supports dot notation
+
+    This is used to map self._locators to a self.locator attribute,
+    to make dealing with locators a bit more pleasant.
+    """
+
+    def __init__(self, args):
+        super().__init__()  # Call to the parent class' __init__ if applicable
+
+        if isinstance(args, dict):
+            for key, value in args.items():
+                # Validate key
+                if " " in key or "." in key:
+                    raise KeyError("Keys cannot have spaces or periods in them")
+
+                # Assign value or recursively instantiate LocatorMap
+                if not isinstance(value, dict):
+                    self[key] = value
+                else:
+                    self.__setattr__(key, LocatorMap(value))
+
+    def __getattr__(self, attr):
+        return self.get(attr)
+
+    def __setattr__(self, key, value):
+        self.__setitem__(key, value)
+
+    def __setitem__(self, key, value):
+        super().__setitem__(key, value)
+        self.__dict__.update({key: value})
+
+    def __delattr__(self, item):
+        self.__delitem__(item)
+
+    def __delitem__(self, key):
+        super().__delitem__(key)
+        del self.__dict__[key]

robotframework_browserpom-0.1.0/BrowserPOM/pageobject.py

@@ -0,0 +1,68 @@
+from __future__ import absolute_import, unicode_literals
+
+from abc import ABCMeta
+
+import robot.api
+from Browser import Browser
+from robot.libraries.BuiltIn import BuiltIn
+
+from .locatormap import LocatorMap  # type: ignore[attr-defined]
+
+
+class PageObject(metaclass=ABCMeta):
+    """Base class for page objects
+
+    Classes that inherit from this class need to define the
+    following class variables:
+
+    PAGE_TITLE   the title of the page; used by the default
+                 implementation of _is_current_page
+    PAGE_URL     this should be the URL of the page, minus
+                 the hostname and port (eg: /loginpage.html)
+    """
+
+    PAGE_URL: str = ""
+    PAGE_TITLE: str = ""
+
+    def __init__(self):
+        self.logger = robot.api.logger
+        self.locator = LocatorMap(getattr(self, "_locators", {}))
+        self.builtin = BuiltIn()
+
+    @property
+    def browser(self) -> Browser:
+        """
+        Returns the browser instance from robotframework-browser library
+        Browser library has to be imported in robot file to reference
+        """
+        return self.builtin.get_library_instance("Browser")
+
+    def __str__(self):
+        return self.__class__.__name__
+
+    def get_page_name(self):
+        """Return the name of the current page"""
+        return self.__class__.__name__
+
+    def _is_current_page(self):
+        """Determine if this page object represents the current page.
+
+        This works by comparing the current page title to the class
+        variable PAGE_TITLE.
+
+        Unless their page titles are unique, page objects should
+        override this function. For example, a common solution is to
+        look at the url of the current page, or to look for a specific
+        heading or element on the page.
+
+        """
+
+        actual_title = self.browser.get_title()
+        expected_title = self.PAGE_TITLE
+
+        if actual_title.lower() == expected_title.lower():
+            return True
+
+        self.logger.info(f"expected title: '{expected_title}'")
+        self.logger.info(f"  actual title: '{actual_title}'")
+        return False

robotframework_browserpom-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.

robotframework_browserpom-0.1.0/PKG-INFO

@@ -0,0 +1,12 @@
+Metadata-Version: 2.1
+Name: robotframework-browserpom
+Version: 0.1.0
+Summary: robotframework-browser library extension to create Page Objects
+Author: Hasan Alp Zengin
+Author-email: hasanalpzengin@gmail.com
+Requires-Python: >=3.12,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: robotframework (>=7.1.0,<8.0.0)
+Requires-Dist: robotframework-browser (>=18.0.0,<19.0.0)

robotframework_browserpom-0.1.0/pyproject.toml

@@ -0,0 +1,74 @@
+[tool.poetry]
+name = "robotframework-browserpom"
+version = "0.1.0"
+description = "robotframework-browser library extension to create Page Objects"
+authors = ["Hasan Alp Zengin <hasanalpzengin@gmail.com>"]
+packages = [{ include = "BrowserPOM" }]
+
+[tool.poetry.dependencies]
+python = "^3.12"
+robotframework = "^7.1.0"
+robotframework-browser = "^18.0.0"
+
+[tool.poetry.dev-dependencies]
+pytest_robotframework = "^4.3.0"
+black = "^24.0.0"
+isort = "^5.13.0"
+flake8 = "^7.0.0"
+mypy = "^1.13.0"
+pylint = "^3.3.0"
+coverage = "^7.6.0"
+flake8-pyproject = "1.2.3"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.black]
+line-length = 88
+target-version = ['py312']
+skip-string-normalization = false
+
+[tool.isort]
+profile = "black"
+line_length = 100
+include_trailing_comma = true
+
+[tool.flake8]
+max-line-length = 100
+extend-ignore = ["E203", "W503", "F401"]
+exclude = [
+    ".git",
+    "__pycache__",
+    "build",
+    "dist",
+    ".venv",
+    "env"
+]
+
+[tool.mypy]
+python_version = 3.12
+check_untyped_defs = false
+ignore_missing_imports = true
+
+[tool.pylint]
+max-line-length = 100
+disable = [
+    "C0103",
+    "C0114"
+]
+
+[tool.coverage.run]
+branch = true
+omit = [
+    "tests/*",
+    "setup.py",
+    "*/__init__.py"
+]
+
+[tool.coverage.report]
+show_missing = true
+skip_covered = true
+
+[tool.pytest.ini_options]
+pythonpath = "."