Organize the project structure

Author: douglasdcm

dev-requirements.txt

@@ -0,0 +1,2 @@
+requests
+aiohttp

docs/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributing Guidelines
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance, race,
+religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at {{ email }}. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+

docs/CONTRIBUTING.md

@@ -0,0 +1,17 @@
+To start to contribute, install the dependencies (Python >= 3.6)
+```
+python3 -m venv venv
+pip install -e .
+pip install -r test-requirements.txt
+```
+Fork this repository, make the changes into the forked repository and push a new Merge Request to 'main' branch.
+Open an issue in case of big MRs.
+# Testing
+To run the tests, start a new Driver as server on port `9999`, for example:
+```
+./chromedriver --port=9999
+```
+And execute the tests
+```
+python -m pytest -n auto
+```

samples/sample-appium.py

@@ -0,0 +1,71 @@
+# Simple example of usage of caqui with Android App
+# It opens the app and get the source code
+# Appium configured using docker for simplicity
+# https://hub.docker.com/r/appium/appium/
+# sample app in ./tests/apk folder
+from caqui import synchronous
+
+
+def main():
+    driver_url = "http://127.0.0.1:4723"
+    capabilities = {
+        "capabilities": {
+            "firstMatch": [{}],
+            "alwaysMatch": {
+                "appium:automationName": "UIAutomator2",
+                "platformName": "Android",
+                "appium:udid": "YOUR-APP-UUID",  # replace with your device uuid
+                "appium:app": "/home/androidusr/sample.apk",  # refereces the folder in docker container
+            },
+        }
+    }
+
+    session = synchronous.get_session(driver_url, capabilities)
+    print("session: ", session)
+
+    source = synchronous.get_page_source(driver_url, session)
+    print("source: ", source)
+
+    synchronous.close_session(driver_url, session)
+
+
+if __name__ == "__main__":
+    main()
+
+# output
+# python sample-appium.py
+# session:  8264988f-2c63-4935-a46f-3aa8ccc09004
+# source:  <?xml version='1.0' encoding='UTF-8' standalone='yes' ?>
+# <hierarchy index="0" class="hierarchy" rotation="0" width="720" height="1472">
+#   <android.widget.FrameLayout index="0" package="com.example.sample" class="android.widget.FrameLayout" text="" checkable="false" checked="false" clickable="false" enabled="true" focusable="false" focused="false" long-clickable="false" password="false" scrollable="false" selected="false" bounds="[0,0][720,1472]" displayed="true">
+#     <android.widget.LinearLayout index="0" package="com.example.sample" class="android.widget.LinearLayout" text="" checkable="false" checked="false" clickable="false" enabled="true" focusable="false" focused="false" long-clickable="false" password="false" scrollable="false" selected="false" bounds="[0,0][720,1472]" displayed="true">
+#       <android.widget.FrameLayout index="0" package="com.example.sample" class="android.widget.FrameLayout" text="" checkable="false" checked="false" clickable="false" enabled="true" focusable="false" focused="false" long-clickable="false" password="false" scrollable="false" selected="false" bounds="[0,0][720,1472]" displayed="true">
+#         <android.widget.LinearLayout index="0" package="com.example.sample" class="android.widget.LinearLayout" text="" resource-id="com.example.sample:id/action_bar_root" checkable="false" checked="false" clickable="false" enabled="true" focusable="false" focused="false" long-clickable="false" password="false" scrollable="false" selected="false" bounds="[0,0][720,1472]" displayed="true">
+#           <android.widget.FrameLayout index="0" package="com.example.sample" class="android.widget.FrameLayout" text="" resource-id="android:id/content" checkable="false" checked="false" clickable="false" enabled="true" focusable="false" focused="false" long-clickable="false" password="false" scrollable="false" selected="false" bounds="[0,0][720,1472]" displayed="true">
+#             <android.view.ViewGroup index="0" package="com.example.sample" class="android.view.ViewGroup" text="" checkable="false" checked="false" clickable="false" enabled="true" focusable="false" focused="false" long-clickable="false" password="false" scrollable="false" selected="false" bounds="[0,0][720,1472]" displayed="true">
+#               <android.widget.LinearLayout index="0" package="com.example.sample" class="android.widget.LinearLayout" text="" checkable="false" checked="false" clickable="false" enabled="true" focusable="false" focused="false" long-clickable="false" password="false" scrollable="false" selected="false" bounds="[0,0][720,159]" displayed="true">
+#                 <android.view.ViewGroup index="0" package="com.example.sample" class="android.view.ViewGroup" text="" resource-id="com.example.sample:id/toolbar" checkable="false" checked="false" clickable="false" enabled="true" focusable="false" focused="false" long-clickable="false" password="false" scrollable="false" selected="false" bounds="[0,47][720,159]" displayed="true">
+#                   <android.widget.TextView index="0" package="com.example.sample" class="android.widget.TextView" text="First Fragment" checkable="false" checked="false" clickable="false" enabled="true" focusable="false" focused="false" long-clickable="false" password="false" scrollable="false" selected="false" bounds="[28,76][282,129]" displayed="true" />
+#                   <androidx.appcompat.widget.LinearLayoutCompat index="1" package="com.example.sample" class="androidx.appcompat.widget.LinearLayoutCompat" text="" checkable="false" checked="false" clickable="false" enabled="true" focusable="false" focused="false" long-clickable="false" password="false" scrollable="false" selected="false" bounds="[649,54][720,152]" displayed="true">
+#                     <android.widget.ImageView index="0" package="com.example.sample" class="android.widget.ImageView" text="" content-desc="More options" checkable="false" checked="false" clickable="true" enabled="true" focusable="true" focused="false" long-clickable="true" password="false" scrollable="false" selected="false" bounds="[649,61][720,145]" displayed="true" />
+#                   </androidx.appcompat.widget.LinearLayoutCompat>
+#                 </android.view.ViewGroup>
+#               </android.widget.LinearLayout>
+#               <android.view.ViewGroup index="1" package="com.example.sample" class="android.view.ViewGroup" text="" checkable="false" checked="false" clickable="false" enabled="true" focusable="false" focused="false" long-clickable="false" password="false" scrollable="false" selected="false" bounds="[0,159][720,1472]" displayed="true">
+#                 <android.widget.FrameLayout index="0" package="com.example.sample" class="android.widget.FrameLayout" text="" resource-id="com.example.sample:id/nav_host_fragment_content_main" checkable="false" checked="false" clickable="false" enabled="true" focusable="false" focused="false" long-clickable="false" password="false" scrollable="false" selected="false" bounds="[0,159][720,1472]" displayed="true">
+#                   <android.widget.ScrollView index="0" package="com.example.sample" class="android.widget.ScrollView" text="" checkable="false" checked="false" clickable="false" enabled="true" focusable="true" focused="false" long-clickable="false" password="false" scrollable="true" selected="false" bounds="[0,159][720,1472]" displayed="true">
+#                     <android.view.ViewGroup index="0" package="com.example.sample" class="android.view.ViewGroup" text="" checkable="false" checked="false" clickable="false" enabled="true" focusable="false" focused="false" long-clickable="false" password="false" scrollable="false" selected="false" bounds="[0,159][720,1472]" displayed="true">
+#                       <android.widget.Button index="0" package="com.example.sample" class="android.widget.Button" text="Next" resource-id="com.example.sample:id/button_first" checkable="false" checked="false" clickable="true" enabled="true" focusable="true" focused="false" long-clickable="false" password="false" scrollable="false" selected="false" bounds="[283,187][437,271]" displayed="true" />
+#                       <android.widget.TextView index="1" package="com.example.sample" class="android.widget.TextView" text="Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam in scelerisque sem. Mauris volutpat, dolor id interdum ullamcorper, risus dolor egestas lectus, sit amet mattis purus dui nec risus. Maecenas non sodales nisi, vel dictum dolor. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Suspendisse blandit eleifend diam, vel rutrum tellus vulputate quis. Aliquam eget libero aliquet, imperdiet nisl a, ornare ex. Sed rhoncus est ut libero porta lobortis. Fusce in dictum tellus.&#10;&#10; Suspendisse interdum ornare ante. Aliquam nec cursus lorem. Morbi id magna felis. Vivamus egestas, est a condimentum egestas, turpis nisl iaculis ipsum, in dictum tellus dolor sed neque. Morbi tellus erat, dapibus ut sem a, iaculis tincidunt dui. Interdum et malesuada fames ac ante ipsum primis in faucibus. Curabitur et eros porttitor, ultricies urna vitae, molestie nibh. Phasellus at commodo eros, non aliquet metus. Sed maximus nisl nec dolor bibendum, vel congue leo egestas.&#10;&#10; Sed interdum tortor nibh, in sagittis risus mollis quis. Curabitur mi odio, condimentum sit amet auctor at, mollis non turpis. Nullam pretium libero vestibulum, finibus orci vel, molestie quam. Fusce blandit tincidunt nulla, quis sollicitudin libero facilisis et. Integer interdum nunc ligula, et fermentum metus hendrerit id. Vestibulum lectus felis, dictum at lacinia sit amet, tristique id quam. Cras eu consequat dui. Suspendisse sodales nunc ligula, in lobortis sem porta sed. Integer id ultrices magna, in luctus elit. Sed a pellentesque est.&#10;&#10; Aenean nunc velit, lacinia sed dolor sed, ultrices viverra nulla. Etiam a venenatis nibh. Morbi laoreet, tortor sed facilisis varius, nibh orci rhoncus nulla, id elementum leo dui non lorem. Nam mollis ipsum quis auctor varius. Quisque elementum eu libero sed commodo. In eros nisl, imperdiet vel imperdiet et, scelerisque a mauris. Pellentesque varius ex nunc, quis imperdiet eros placerat ac. Duis finibus orci et est auctor tincidunt. Sed non viverra ipsum. Nunc quis augue egestas, cursus lorem at, molestie sem. Morbi a consectetur ipsum, a placerat diam. Etiam vulputate dignissim convallis. Integer faucibus mauris sit amet finibus convallis.&#10;&#10; Phasellus in aliquet mi. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. In volutpat arcu ut felis sagittis, in finibus massa gravida. Pellentesque id tellus orci. Integer dictum, lorem sed efficitur ullamcorper, libero justo consectetur ipsum, in mollis nisl ex sed nisl. Donec maximus ullamcorper sodales. Praesent bibendum rhoncus tellus nec feugiat. In a ornare nulla. Donec rhoncus libero vel nunc consequat, quis tincidunt nisl eleifend. Cras bibendum enim a justo luctus vestibulum. Fusce dictum libero quis erat maximus, vitae volutpat diam dignissim." resource-id="com.example.sample:id/textview_first" checkable="false" checked="false" clickable="false" enabled="true" focusable="false" focused="false" long-clickable="false" password="false" scrollable="false" selected="false" bounds="[28,299][692,1472]" displayed="true" />
+#                     </android.view.ViewGroup>
+#                   </android.widget.ScrollView>
+#                 </android.widget.FrameLayout>
+#               </android.view.ViewGroup>
+#               <android.widget.ImageButton index="2" package="com.example.sample" class="android.widget.ImageButton" text="" resource-id="com.example.sample:id/fab" checkable="false" checked="false" clickable="true" enabled="true" focusable="true" focused="false" long-clickable="false" password="false" scrollable="false" selected="false" bounds="[594,1390][692,1472]" displayed="true" />
+#             </android.view.ViewGroup>
+#           </android.widget.FrameLayout>
+#         </android.widget.LinearLayout>
+#       </android.widget.FrameLayout>
+#     </android.widget.LinearLayout>
+#   </android.widget.FrameLayout>
+# </hierarchy>

samples/sample-win-app-driver.py

@@ -0,0 +1,29 @@
+# Simple example of usage of caqui with Windows Calculator
+# It opens the Calculator and clicks the number "8"
+# Test works just in Windows environment. Tested with Windows 10
+from caqui import synchronous
+
+
+def main():
+    driver_url = "http://127.0.0.1:4723"
+    capabilities = {
+        "capabilities": {
+            "firstMatch": [{}],
+            "alwaysMatch": {},
+        },
+        "desiredCapabilities": {
+            "debugConnectToRunningApp": "false",
+            "app": "Microsoft.WindowsCalculator_8wekyb3d8bbwe!App",
+        },
+    }
+    session = synchronous.get_session(driver_url, capabilities)
+    element = synchronous.find_element(
+        driver_url, session, locator_type="name", locator_value="Eight"
+    )
+
+    synchronous.click(driver_url, session, element)
+    synchronous.close_session(driver_url, session)
+
+
+if __name__ == "__main__":
+    main()

samples/sample-winium.py

@@ -0,0 +1,26 @@
+# Simple example of usage of caqui with Windows Calculator
+# It opens the Calculator and clicks the number "8"
+# Test works just in Windows environment. Tested with Windows 10
+from caqui import synchronous
+
+
+def main():
+    driver_url = "http://127.0.0.1:9999"
+    capabilities = {
+        "capabilities": {"firstMatch": [{}], "alwaysMatch": {}},
+        "desiredCapabilities": {
+            "debugConnectToRunningApp": "false",
+            "app": "C:/windows/system32/calc.exe",
+        },
+    }
+    session = synchronous.get_session(driver_url, capabilities)
+    element = synchronous.find_element(
+        driver_url, session, locator_type="name", locator_value="Eight"
+    )
+
+    synchronous.click(driver_url, session, element)
+    synchronous.close_session(driver_url, session)
+
+
+if __name__ == "__main__":
+    main()

samples/sample.py

@@ -0,0 +1,75 @@
+# It opens the WebDriver, navigate to a page and get all links
+import asyncio
+import time
+from caqui import synchronous, asynchronous
+from os import getcwd
+from tests.constants import PAGE_URL
+from caqui.easy.capabilities import CapabilitiesBuilder
+
+BASE_DIR = getcwd()
+
+MAX_CONCURRENCY = 5  # number of webdriver instances running
+all_anchors = []
+semaphore = asyncio.Semaphore(MAX_CONCURRENCY)
+
+
+async def get_all_links():
+    async with semaphore:
+        driver_url = "http://127.0.0.1:9999"
+        capabilities = (
+            CapabilitiesBuilder()
+            .browser_name("chrome")
+            .accept_insecure_certs(True)
+            .page_load_strategy("normal")
+            .additional_capability(
+                {"goog:chromeOptions": {"extensions": [], "args": ["--headless"]}}
+            )
+        ).build()
+        session = await asynchronous.get_session(driver_url, capabilities)
+        await asynchronous.go_to_page(
+            driver_url,
+            session,
+            PAGE_URL,
+        )
+
+        all_anchors = []
+        for i in range(4):
+            i += 1
+            locator_value = f"//a[@id='a{i}']"
+            locator_type = "xpath"
+            anchors = []
+
+            anchors = await asynchronous.find_elements(
+                driver_url, session, locator_type, locator_value
+            )
+            all_anchors.extend(anchors)
+
+        texts = []
+        for anchor in all_anchors:
+            text = await asynchronous.get_property(driver_url, session, anchor, "href")
+            texts.append(text)
+
+        for text in texts:
+            print(f"Link found '{text}'")
+
+        synchronous.close_session(driver_url, session)
+
+
+# Reference: https://stackoverflow.com/questions/48483348/how-to-limit-concurrency-with-python-asyncio
+async def main():
+    number_of_websites = range(10)
+    tasks = [asyncio.ensure_future(get_all_links()) for number in number_of_websites]
+    await asyncio.gather(*tasks)
+
+
+if __name__ == "__main__":
+    start = time.time()
+    loop = asyncio.get_event_loop()
+    try:
+        loop.run_until_complete(main())
+    finally:
+        loop.run_until_complete(loop.shutdown_asyncgens())
+        loop.close()
+        end = time.time()
+        print(f"Found 40 links")  # 10 websites with 4 links each
+        print(f"Time: {end-start:.2f} sec")