feat: configure ruff and format files (#46)

* feat: configure ruff and format files

* use default .env in root folder

Author: rgonalo

.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+name: build
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.13']
+      fail-fast: false
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+        pip install -r requirements_dev.txt
+    - name: Lint and format check with ruff
+      run: |
+        ruff check .
+        ruff format --check .

.gitignore

@@ -7,7 +7,9 @@ target
 .pydevproject
 
 # VSCode IDE
-.vscode
+.vscode/*
+!.vscode/settings.json
+!.vscode/launch.json
 
 # Packages
 *.egg

.vscode/launch.json

@@ -0,0 +1,70 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Scenario (by name)",
+      "type": "debugpy",
+      "request": "launch",
+      "cwd": "${workspaceFolder}",
+      "module": "behave",
+      "env": {
+        "PYTHONPATH": "${workspaceFolder}"
+      },
+      "envFile": "${workspaceFolder}/.env",
+      "args": [
+        "${file}",
+        "-n",
+        "${selectedText}"
+      ],
+      "stopOnEntry": false,
+      "justMyCode": false
+    },
+    {
+      "name": "Pytest: current file",
+      "type": "debugpy",
+      "request": "launch",
+      "cwd": "${workspaceFolder}/web_pytest",
+      "module": "pytest",
+      "args": [
+        "${file}"
+      ],
+      "justMyCode": false
+    },
+    {
+      "name": "Pytest BDD: current file",
+      "type": "debugpy",
+      "request": "launch",
+      "cwd": "${workspaceFolder}/web_pytest_bdd",
+      "module": "pytest",
+      "args": [
+        "${file}"
+      ],
+      "justMyCode": false
+    },
+    {
+      "name": "Playwright: current file",
+      "type": "debugpy",
+      "request": "launch",
+      "cwd": "${workspaceFolder}/web_pytest",
+      "module": "pytest",
+      "args": [
+        "${file}",
+        "--headed",
+        "--browser",
+        "firefox"
+      ],
+      "justMyCode": false
+    },
+    {
+      "name": "Pynose2: current file",
+      "type": "debugpy",
+      "request": "launch",
+      "cwd": "${workspaceFolder}/web_nose2",
+      "module": "pytest",
+      "args": [
+        "${file}"
+      ],
+      "justMyCode": false
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,78 @@
+{
+  "files.exclude": {
+    "**/__pycache__": true,
+    "**/*.pyc": true
+  },
+  "files.autoSave": "onFocusChange",
+  "files.insertFinalNewline": true,
+  "files.trimTrailingWhitespace": true,
+  "editor.formatOnPaste": false,
+  "editor.formatOnSave": true,
+  "editor.rulers": [
+    120
+  ],
+  "[python]": {
+    "editor.formatOnSave": true,
+    "editor.defaultFormatter": "charliermarsh.ruff",
+    "editor.codeActionsOnSave": {
+      "source.organizeImports": "explicit"
+    },
+  },
+  "ruff.organizeImports": true,
+  "cucumberautocomplete.steps": [
+    "**/steps/**/*.py",
+  ],
+  "cucumberautocomplete.customParameters": [
+    {
+      "parameter": "(u'",
+      "value": "('"
+    }
+  ],
+  "cucumberautocomplete.syncfeatures": "**/features/**/*.feature",
+  "cucumberautocomplete.gherkinDefinitionPart": "@(given|when|then|step)\\(",
+  "cucumberautocomplete.strictGherkinCompletion": false,
+  "cucumberautocomplete.strictGherkinValidation": false,
+  "cucumberautocomplete.onTypeFormat": true,
+  "gherkiner.consecutiveBlankLinesToOne": true,
+  "gherkiner.padding.symbol": "space",
+  "gherkiner.padding.table": 10,
+  "gherkiner.formatOnSave": true,
+  "gherkiner.paddings": [
+    {
+      "keyword": "Feature",
+      "padding": 0
+    },
+    {
+      "keyword": "Scenario Outline",
+      "padding": 2
+    },
+    {
+      "keyword": "Scenario",
+      "padding": 2
+    },
+    {
+      "keyword": "Given",
+      "padding": 4
+    },
+    {
+      "keyword": "When",
+      "padding": 5
+    },
+    {
+      "keyword": "Then",
+      "padding": 5
+    },
+    {
+      "keyword": "And",
+      "padding": 6
+    },
+    {
+      "keyword": "Actions",
+      "padding": 2
+    },
+    {
+      "keyword": "Examples",
+      "padding": 4
+    }
+  ]
+}

README.rst

@@ -169,6 +169,14 @@ Contributing
 If you want to collaborate in Toolium-examples development, feel free of `forking it <https://github.com/Telefonica/toolium-examples>`_
 and asking for a pull request.
 
+Before submitting your changes, make sure the code follows the project's style by running Ruff:
+
+.. code:: console
+
+    $ pip install ruff
+    $ ruff check --fix .    # Fix linting issues
+    $ ruff format .         # Format code
+
 Finally, before accepting your contribution, we need you to sign our
 `Contributor License Agreement <https://raw.githubusercontent.com/telefonicaid/Licensing/master/ContributionPolicy.txt>`_
 and send it to ruben.gonzalezalonso@telefonica.com.

android_behave/environment.py

@@ -1,5 +1,4 @@
-# -*- coding: utf-8 -*-
-u"""
+"""
 Copyright 2015 Telefónica Investigación y Desarrollo, S.A.U.
 This file is part of Toolium.
 
@@ -16,10 +15,14 @@
 limitations under the License.
 """
 
-from toolium.behave.environment import (before_all as toolium_before_all, before_feature as toolium_before_feature,
-                                        before_scenario as toolium_before_scenario,
-                                        after_scenario as toolium_after_scenario,
-                                        after_feature as toolium_after_feature, after_all as toolium_after_all)
+from toolium.behave.environment import (
+    after_all as toolium_after_all,
+    after_feature as toolium_after_feature,
+    after_scenario as toolium_after_scenario,
+    before_all as toolium_before_all,
+    before_feature as toolium_before_feature,
+    before_scenario as toolium_before_scenario,
+)
 
 
 def before_all(context):

android_behave/pageobjects/menu.py

@@ -1,5 +1,4 @@
-# -*- coding: utf-8 -*-
-u"""
+"""
 Copyright 2015 Telefónica Investigación y Desarrollo, S.A.U.
 This file is part of Toolium.
 
@@ -17,13 +16,14 @@
 """
 
 from appium.webdriver.common.appiumby import AppiumBy
-
 from toolium.pageobjects.page_object import PageObject
 
 
 class MenuPageObject(PageObject):
-    option_locator = 'new UiScrollable(new UiSelector().scrollable(true).instance(0))' \
-                     '.scrollIntoView(new UiSelector().text("{}").instance(0));'
+    option_locator = (
+        'new UiScrollable(new UiSelector().scrollable(true).instance(0))'
+        '.scrollIntoView(new UiSelector().text("{}").instance(0));'
+    )
 
     def open_option(self, option):
         """Search a menu option and click on it

android_behave/pageobjects/tabs.py

@@ -1,5 +1,4 @@
-# -*- coding: utf-8 -*-
-u"""
+"""
 Copyright 2015 Telefónica Investigación y Desarrollo, S.A.U.
 This file is part of Toolium.
 
@@ -17,9 +16,8 @@
 """
 
 from selenium.webdriver.common.by import By
-
+from toolium.pageelements import Button, PageElement, Text
 from toolium.pageobjects.page_object import PageObject
-from toolium.pageelements import *
 
 
 class TabsPageObject(PageObject):
@@ -30,4 +28,4 @@ class TabsPageObject(PageObject):
     content1 = Text(By.ID, 'io.appium.android.apis:id/view1')
     content2 = Text(By.ID, 'io.appium.android.apis:id/view2')
     content3 = Text(By.ID, 'io.appium.android.apis:id/view3')
-    container = PageElement(By.ID, 'android:id/content')
+    container = PageElement(By.ID, 'android:id/content')

android_behave/steps/tabs.py

@@ -1,5 +1,4 @@
-# -*- coding: utf-8 -*-
-u"""
+"""
 Copyright 2015 Telefónica Investigación y Desarrollo, S.A.U.
 This file is part of Toolium.
 
@@ -16,28 +15,28 @@
 limitations under the License.
 """
 
-from behave import given, when, then
+from behave import given, then, when
 
 from android_behave.pageobjects.menu import MenuPageObject
 from android_behave.pageobjects.tabs import TabsPageObject
 
 
 @given('the menu is open')
-def step_impl(context):
+def menu_is_open(context):
     context.current_page = MenuPageObject()
 
 
 @when('the user goes to the tabs-by-id screen')
-def step_impl(context):
+def go_to_tabs_by_id_screen(context):
     context.current_page.open_option('Views').open_option('Tabs').open_option('1. Content By Id')
     context.current_page = TabsPageObject()
 
 
 @when('the user opens the second tab')
-def step_impl(context):
+def open_second_tab(context):
     context.current_page.tab2.click()
 
 
 @then('the second tab contains "{message}"')
-def step_impl(context, message):
+def second_tab_contains_message(context, message):
     assert message in context.current_page.content2.text

android_nose2/pageobjects/drag_and_drop.py

@@ -1,5 +1,4 @@
-# -*- coding: utf-8 -*-
-u"""
+"""
 Copyright 2015 Telefónica Investigación y Desarrollo, S.A.U.
 This file is part of Toolium.
 
@@ -16,11 +15,10 @@
 limitations under the License.
 """
 
+from selenium.webdriver import ActionChains
 from selenium.webdriver.common.by import By
-from appium.webdriver.common.touch_action import TouchAction
-
+from toolium.pageelements import PageElement, Text
 from toolium.pageobjects.page_object import PageObject
-from toolium.pageelements import *
 
 
 class DragAndDropPageObject(PageObject):
@@ -30,4 +28,4 @@ class DragAndDropPageObject(PageObject):
     result = Text(By.ID, 'io.appium.android.apis:id/drag_result_text')
 
     def drag_and_drop(self):
-        TouchAction(self.driver).long_press(self.dot3.web_element).move_to(self.dot2.web_element).release().perform()
+        ActionChains(self.driver).drag_and_drop(self.dot3.web_element, self.dot2.web_element).perform()