feat: configure ruff and format files

rgonalo · rgonalo · commit 171becbf232a · 2026-02-13T12:49:12.000+01:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
diff --git a/.gitignore b/.gitignore
@@ -7,7 +7,9 @@ target
 .pydevproject
 
 # VSCode IDE
-.vscode
+.vscode/*
+!.vscode/settings.json
+!.vscode/launch.json
 
 # Packages
 *.egg
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -0,0 +1,23 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Scenario (by name)",
+      "type": "debugpy",
+      "request": "launch",
+      "cwd": "${workspaceFolder}",
+      "module": "behave",
+      "env": {
+        "PYTHONPATH": "${workspaceFolder}"
+      },
+      "envFile": "${workspaceFolder}/.vscode/.env",
+      "args": [
+        "${file}",
+        "-n",
+        "${selectedText}"
+      ],
+      "stopOnEntry": false,
+      "justMyCode": false
+    }
+  ]
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,86 @@
+{
+  "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"
+    },
+  },
+  "python.envFile": "${workspaceFolder}/.vscode/.env",
+  "python-envs.pythonProjects": [
+    {
+      "path": "",
+      "envManager": "ms-python.python:venv",
+      "packageManager": "ms-python.python:pip"
+    }
+  ],
+  "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
+    }
+  ]
+}
diff --git a/environment.py b/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):
diff --git a/pageobjects/login.py b/pageobjects/login.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,9 @@
 """
 
 from selenium.webdriver.common.by import By
-
+from toolium.pageelements import Button, InputText
 from toolium.pageobjects.page_object import PageObject
-from toolium.pageelements import *
+
 from pageobjects.message import MessagePageObject
 from pageobjects.secure_area import SecureAreaPageObject
 
@@ -32,23 +31,23 @@ def init_page_elements(self):
         self.message = MessagePageObject()
 
     def open(self):
-        """ Open login url in browser
+        """Open login url in browser
 
         :returns: this page object instance
         """
         self.driver.get('{}/login'.format(self.config.get('Test', 'url')))
         return self
 
     def wait_until_loaded(self):
-        """ Wait until login page is loaded
+        """Wait until login page is loaded
 
         :returns: this page object instance
         """
         self.username.wait_until_visible()
         return self
 
     def login(self, user):
-        """ Fill login form and submit it
+        """Fill login form and submit it
 
         :param user: dict with username and password values
         :returns: secure area page object instance
diff --git a/pageobjects/message.py b/pageobjects/message.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,17 +16,16 @@
 """
 
 from selenium.webdriver.common.by import By
-
+from toolium.pageelements import Text
 from toolium.pageobjects.page_object import PageObject
-from toolium.pageelements import *
 
 
 class MessagePageObject(PageObject):
     def init_page_elements(self):
         self.message = Text(By.ID, 'flash')
 
     def get_message(self):
-        """ Get first line of actual message
+        """Get first line of actual message
 
         :returns: str with message
         """
diff --git a/pageobjects/secure_area.py b/pageobjects/secure_area.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,9 @@
 """
 
 from selenium.webdriver.common.by import By
-
+from toolium.pageelements import Button
 from toolium.pageobjects.page_object import PageObject
-from toolium.pageelements import *
+
 from pageobjects.message import MessagePageObject
 
 
@@ -29,7 +28,7 @@ def init_page_elements(self):
         self.logout_button = Button(By.XPATH, "//div[@id='content']//i[contains(@class,'icon-signout')]")
 
     def logout(self):
-        """ Log out of secure area
+        """Log out of secure area
 
         :returns: login page object instance
         """
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,59 @@
+[project]
+name = "toolium-template"
+dynamic = ["dependencies"]
+authors = [
+    {name = "Rubén González Alonso", email = "ruben.gonzalezalonso@telefonica.com"},
+]
+description = "Base project to start using toolium"
+readme = "README.rst"
+license = {text = "Apache 2.0"}
+requires-python = ">=3.10"
+
+[tool.setuptools.dynamic]
+dependencies = {file = ["requirements.txt"]}
+
+[tool.ruff]
+line-length = 120
+target-version = "py310"
+
+[tool.ruff.lint]
+# Rules to enforce
+select = [
+    "E",   # pycodestyle errors
+    "W",   # pycodestyle warnings
+    "F",   # pyflakes
+    "I",   # isort
+    "UP",  # pyupgrade
+    "N",   # pep8-naming
+    "A",   # flake8-builtins
+    "B",   # flake8-bugbear
+    "G",   # flake8-logging-format
+    "ARG", # flake8-unused-arguments
+    "COM", # flake8-commas
+    "C4",  # flake8-comprehensions
+    "PT",  # flake8-pytest-style
+    "T20", # flake8-print
+    "RUF", # Ruff-specific rules
+]
+# Rules to ignore
+ignore = [
+    "COM812",  # flake8-missing-trailing-comas (conflict with ruff format)
+]
+
+[tool.ruff.lint.isort]
+combine-as-imports = true
+split-on-trailing-comma = true
+known-first-party = ["acceptance"]
+section-order = [
+    "future",
+    "standard-library",
+    "third-party",
+    "first-party",
+    "local-folder"
+]
+
+[tool.ruff.format]
+quote-style = "single"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
diff --git a/steps/login.py b/steps/login.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 pageobjects.login import LoginPageObject
 
 
 @given('the home page is open')
-def step_impl(context):
+def home_page_is_open(context):
     context.current_page = LoginPageObject()
     context.current_page.open()
 
 
 @when('the user logs in with username "{username}" and password "{password}"')
-def step_impl(context, username, password):
+def user_logs_in(context, username, password):
     user = {'username': username, 'password': password}
     context.current_page = context.current_page.login(user)
 
 
 @when('the user logs out')
-def step_impl(context):
+def user_logs_out(context):
     context.current_page = context.current_page.logout()
 
 
 @then('the message "{message}" is shown')
-def step_impl(context, message):
+def message_is_shown(context, message):
     assert message in context.current_page.message.get_message()
