+ Blog + ⋅ + Docs + ⋅ + Learning Hub + ⋅ + Newsletter + ⋅ + Certifications + ⋅ + YouTube +
+ + + + +*Learn how to run your Python automation testing scripts using Behave on the LambdaTest platform* + +[
](https://accounts.lambdatest.com/register)
+
+
+## Table Of Contents
+
+* [Pre-requisites](#pre-requisites)
+* [Run Your First Test](#run-your-first-test)
+* [Local Testing With Behave](#testing-locally-hosted-or-privately-hosted-projects)
+
+## Prerequisites For Running Robot Selenium Tests
+* * *
+Before you can start performing Python automation testing using Robot, you would need to:
+
+* Install the latest Python build from the [official website](https://www.python.org/downloads/). We recommend using the latest version i.e python 3.
+* Make sure **pip 3** is installed in your system. You can install **pip** from [here](https://pip.pypa.io/en/stable/installation/).
+* Download the latest **Selenium Client** and its **WebDriver bindings** from the [official website](https://www.selenium.dev/downloads/). Latest versions of **Selenium Client** and **WebDriver** are ideal for running your automation script on LambdaTest Selenium cloud grid.
+* Install **virtualenv** which is the recommended way to run your tests. It will isolate the build from other setups you may have running and ensure that the tests run with the specified versions of the modules.
+```bash
+pip install virtualenv
+```
+### Installing Selenium Dependencies And Tutorial Repo
+
+**Step 1:** Clone the LambdaTest’s Python-Behave-Selenium repository and navigate to the code directory as shown below:
+
+```bash
+git clone https://github.com/LambdaTest/Python-Behave-Selenium
+cd Python-Behave-Selenium
+```
+
+**Step 2:** Create a virtual environment in your project folder the environment name is arbitrary.
+
+```bash
+virtualenv venv
+```
+
+**Step 3:** Activate the environment.
+
+```bash
+source venv/bin/activate
+```
+
+**Step 4:** Install the [required packages](https://github.com/LambdaTest/Python-Behave-Selenium/blob/master/requirements.txt) from the cloned project directory:
+
+```bash
+pip install -r requirements.txt
+```
+### Setting Up Your Authentication
+
+Make sure you have your LambdaTest credentials with you to run test automation scripts. You can get these credentials from the [LambdaTest Automation Dashboard](https://automation.lambdatest.com/build) or by your [LambdaTest Profile](https://accounts.lambdatest.com/login).
+
+**Step 5:** Set LambdaTest **Username** and **Access Key** in environment variables.
+
+* For **Linux/macOS**:
+
+ ```bash
+ export LT_USERNAME="YOUR_USERNAME"
+ export LT_ACCESS_KEY="YOUR ACCESS KEY"
+ ```
+ * For **Windows**:
+ ```bash
+ set LT_USERNAME="YOUR_USERNAME"
+ set LT_ACCESS_KEY="YOUR ACCESS KEY"
+ ```
+
+
+## Run Your First Test
+
+>**Test Scenario**: The below Python Behave script tests a simple to-do application with basic functionalities like mark items as done, add items in list, calculate total pending items etc.
+```python
+from selenium import webdriver
+import os
+from configparser import ConfigParser
+
+caps={}
+
+def before_all(context):
+ config = ConfigParser()
+ print ((os.path.join(os.getcwd(), 'config.cfg')))
+ my_file = (os.path.join(os.getcwd(), 'config.cfg'))
+ config.read(my_file)
+
+ if os.getenv('LT_USERNAME', 0) == 0:
+ context.user_name = config.get('Environment', 'UserName')
+ if os.getenv('LT_ACCESS_KEY', 0) == 0:
+ context.access_key = config.get('Environment', 'AccessKey' )
+ if os.getenv('LT_OPERATING_SYSTEM', 0) == 0:
+ context.os = config.get('Environment', 'OS' )
+ if os.getenv('LT_BROWSER', 0) == 0:
+ context.browser = config.get('Environment', 'Browser' )
+ if os.getenv('LT_BROWSER_VERSION', 0) == 0:
+ context.browser_version = config.get('Environment', 'BrowserVersion' )
+
+ remote_url= "https://"+context.user_name+":"+context.app_key+"@hub.lambdatest.com/wd/hub"
+ caps['name'] = "Behave Sample Test"
+ caps['build'] = "Behave Selenium Sample"
+ caps['browserName'] = context.browser
+ caps['version'] = context.browser_version
+ print ( caps )
+ print ( remote_url )
+ context.driver = webdriver.Remote(command_executor=remote_url,desired_capabilities=caps)
+
+@given('I go to sample-todo-app to add item')
+def step(context):
+ before_all(context)
+ context.driver.get('https://lambdatest.github.io/sample-todo-app/')
+
+@then('I Click on first checkbox and second checkbox')
+def click_on_checkbox_one(context):
+ context.driver.find_element_by_name('li1').click()
+ context.driver.find_element_by_name('li2').click()
+
+@when('I enter item to add')
+def enter_item_name(context):
+ context.driver.find_element_by_id('sampletodotext').send_keys("Yey, Let's add it to list")
+
+@when('I click add button')
+def click_on_add_button(context):
+ context.driver.find_element_by_id('addbutton').click()
+
+@then('I should verify the added item')
+def see_login_message(context):
+ context.driver.implicitly_wait(10)
+ added_item = context.driver.find_element_by_xpath("//span[@class='done-false']").text
+ print(added_item)
+ print(added_item)
+ if added_item in "Yey, Let's add it to list":
+ return True
+ else:
+ return False
+
+def after_all(context):
+ context.browser.quit()
+```
+### Configuration Of Your Test Capabilities
+
+**Step 6:** In `config/config.json`, you need to update your test capabilities. In this code, we are passing browser, browser version, and operating system information, along with LambdaTest Selenium grid capabilities via capabilities object. The capabilities object in the above code are defined as:
+```python
+[
+ {
+ "platform": "Windows 10",
+ "browserName": "chrome",
+ "version": "latest",
+ "build": "Behave Selenium Sample",
+ "name": "Behave Sample Test"
+ }
+ ]
+```
+> You can generate capabilities for your test requirements with the help of [Desired Capability Generator](https://www.lambdatest.com/capabilities-generator/).
+
+### Executing The Test
+
+**Step 7:** The tests can be executed in the terminal using the following command.
+```bash
+behave features/test.feature
+```
+
+**Step 8:** The tests can be executed in the terminal parallel using behavex via tags.
+```bash
+behavex -t @Firefox,@Chrome,@Edge --parallel-processes 3
+```
+Your test results would be displayed on the test console (or command-line interface if you are using terminal/cmd) and on LambdaTest automation dashboard. [LambdaTest Automation Dashboard](https://automation.lambdatest.com/build) will help you view all your text logs, screenshots and video recording for your entire automation tests.
+
+## Testing Locally Hosted or Privately Hosted Projects
+***
+You can test your locally hosted or privately hosted projects with [LambdaTest Selenium grid cloud](https://www.lambdatest.com/selenium-automation) using LambdaTest Tunnel app. All you would have to do is set up an SSH tunnel using LambdaTest Tunnel app and pass toggle `tunnel = True` via desired capabilities. LambdaTest Tunnel establishes a secure SSH protocol based tunnel that allows you in testing your locally hosted or privately hosted pages, even before they are made live.
+
+>Refer our [LambdaTest Tunnel documentation](https://www.lambdatest.com/support/docs/testing-locally-hosted-pages/) for more information.
+
+Here’s how you can establish LambdaTest Tunnel.
+
+Download the binary file of:
+
+* [LambdaTest Tunnel for Windows](https://downloads.lambdatest.com/tunnel/v3/windows/64bit/LT_Windows.zip)
+* [LambdaTest Tunnel for Mac](https://downloads.lambdatest.com/tunnel/v3/mac/64bit/LT_Mac.zip)
+* [LambdaTest Tunnel for Linux](https://downloads.lambdatest.com/tunnel/v3/linux/64bit/LT_Linux.zip)
+
+Open command prompt and navigate to the binary folder.
+
+Run the following command:
+```bash
+LT -user {user’s login email} -key {user’s access key}
+```
+So if your user name is lambdatest@example.com and key is 123456, the command would be:
+```bash
+LT -user lambdatest@example.com -key 123456
+```
+Once you are able to connect **LambdaTest Tunnel** successfully, you would just have to pass on tunnel capabilities in the code shown below :
+
+**Tunnel Capability**
+
+```bash
+"tunnel" : true
+```
+
+## Documentation & Resources :books:
+
+
+Visit the following links to learn more about LambdaTest's features, setup and tutorials around test automation, mobile app testing, responsive testing, and manual testing.
+
+* [LambdaTest Documentation](https://www.lambdatest.com/support/docs/?utm_source=github&utm_medium=repo&utm_campaign=python-behave-selenium)
+* [LambdaTest Blog](https://www.lambdatest.com/blog/?utm_source=github&utm_medium=repo&utm_campaign=python-behave-selenium)
+* [LambdaTest Learning Hub](https://www.lambdatest.com/learning-hub/?utm_source=github&utm_medium=repo&utm_campaign=python-behave-selenium)
+
+## LambdaTest Community :busts_in_silhouette:
+
+The [LambdaTest Community](https://community.lambdatest.com/) allows people to interact with tech enthusiasts. Connect, ask questions, and learn from tech-savvy people. Discuss best practises in web development, testing, and DevOps with professionals from across the globe 🌎
+
+## What's New At LambdaTest ❓
+
+To stay updated with the latest features and product add-ons, visit [Changelog](https://changelog.lambdatest.com/)
+
## About LambdaTest
-[LambdaTest](https://www.lambdatest.com/) is a cloud based selenium grid infrastructure that can help you run automated cross browser compatibility tests on 2000+ different browser and operating system environments. LambdaTest supports all programming languages and frameworks that are supported with Selenium, and have easy integrations with all popular CI/CD platforms. It's a perfect solution to bring your [selenium automation testing](https://www.lambdatest.com/selenium-automation) to cloud based infrastructure that not only helps you increase your test coverage over multiple desktop and mobile browsers, but also allows you to cut down your test execution time by running tests on parallel.
+[LambdaTest](https://www.lambdatest.com) is a leading test execution and orchestration platform that is fast, reliable, scalable, and secure. It allows users to run both manual and automated testing of web and mobile apps across 3000+ different browsers, operating systems, and real device combinations. Using LambdaTest, businesses can ensure quicker developer feedback and hence achieve faster go to market. Over 500 enterprises and 1 Million + users across 130+ countries rely on LambdaTest for their testing needs.
+
+### Features
+
+* Run Selenium, Cypress, Puppeteer, Playwright, and Appium automation tests across 3000+ real desktop and mobile environments.
+* Real-time cross browser testing on 3000+ environments.
+* Test on Real device cloud
+* Blazing fast test automation with HyperExecute
+* Accelerate testing, shorten job times and get faster feedback on code changes with Test At Scale.
+* Smart Visual Regression Testing on cloud
+* 120+ third-party integrations with your favorite tool for CI/CD, Project Management, Codeless Automation, and more.
+* Automated Screenshot testing across multiple browsers in a single click.
+* Local testing of web and mobile apps.
+* Online Accessibility Testing across 3000+ desktop and mobile browsers, browser versions, and operating systems.
+* Geolocation testing of web and mobile apps across 53+ countries.
+* LT Browser - for responsive testing across 50+ pre-installed mobile, tablets, desktop, and laptop viewports
+
+
+[](https://accounts.lambdatest.com/register)
+
-### Resources
+
+## We are here to help you :headphones:
-##### [SeleniumHQ Documentation](http://www.seleniumhq.org/docs/)
-##### [Behave Documentation](https://behave.readthedocs.io/en/latest/)
+* Got a query? we are available 24x7 to help. [Contact Us](support@lambdatest.com)
+* For more info, visit - [LambdaTest](https://www.lambdatest.com/?utm_source=github&utm_medium=repo&utm_campaign=python-behave-selenium)
diff --git a/config.cfg b/config.cfg
deleted file mode 100644
index 4203d76..0000000
--- a/config.cfg
+++ /dev/null
@@ -1,6 +0,0 @@
-[Environment]
-UserName=YOUR LAMBDATEST USERNAME
-AppKey=YOUR LAMBDATEST ACCESSKEY
-OS=win10
-Browser=chrome
-BrowserVersion= 63.0
diff --git a/config/config.json b/config/config.json
new file mode 100644
index 0000000..9c58c42
--- /dev/null
+++ b/config/config.json
@@ -0,0 +1,9 @@
+[
+ {
+ "platform": "Windows 10",
+ "browserName": "chrome",
+ "version": "latest",
+ "build": "Behave Selenium Sample",
+ "name": "Behave Sample Test"
+ }
+]
\ No newline at end of file
diff --git a/features/environment.py b/features/environment.py
new file mode 100644
index 0000000..81552e5
--- /dev/null
+++ b/features/environment.py
@@ -0,0 +1,88 @@
+from behave.model_core import Status
+from selenium import webdriver
+from selenium.webdriver.chrome.options import Options as ChromeOptions
+from selenium.webdriver.firefox.options import Options as FirefoxOptions
+from selenium.webdriver.edge.options import Options as EdgeOptions
+import os
+import json
+
+INDEX = int(os.environ['INDEX']) if 'INDEX' in os.environ else 0
+if os.environ.get("env") == "jenkins":
+ desired_cap_dict = os.environ["LT_BROWSERS"]
+ CONFIG = json.loads(desired_cap_dict)
+else:
+ json_file = "config/config.json"
+ with open(json_file) as data_file:
+ CONFIG = json.load(data_file)
+
+username = os.environ["LT_USERNAME"]
+authkey = os.environ["LT_ACCESS_KEY"]
+
+
+
+def before_scenario(context, scenario):
+ try:
+ desired_cap = setup_desired_cap(CONFIG[INDEX])
+
+ if 'Chrome' in scenario.tags:
+ options = ChromeOptions()
+ options.browser_version = desired_cap.get("version", "latest")
+ options.platform_name = "Windows 11"
+ elif 'Firefox' in scenario.tags:
+ options = FirefoxOptions()
+ options.browser_version = desired_cap.get("version", "latest")
+ options.platform_name = "Windows 10"
+ elif 'Edge' in scenario.tags:
+ options = EdgeOptions()
+ options.browser_version = desired_cap.get("version", "latest")
+ options.platform_name = "Windows 8"
+ else:
+ raise ValueError("Unsupported browser tag")
+
+ options.set_capability('build', desired_cap.get('build'))
+ options.set_capability('name', desired_cap.get('name'))
+
+ # Print options for debugging
+ print("Browser Options:", options.to_capabilities())
+
+ context.browser = webdriver.Remote(
+ command_executor=f"https://{username}:{authkey}@hub.lambdatest.com/wd/hub",
+ options=options
+ )
+ except Exception as e:
+ print(f"Error in before_scenario: {str(e)}")
+ context.scenario.skip(reason=f"Failed to initialize browser: {str(e)}")
+
+def after_scenario(context, scenario):
+ if hasattr(context, 'browser'):
+ try:
+ if scenario.status == Status.failed:
+ context.browser.execute_script("lambda-status=failed")
+ else:
+ context.browser.execute_script("lambda-status=passed")
+ except Exception as e:
+ print(f"Error setting lambda status: {str(e)}")
+ finally:
+ context.browser.quit()
+
+
+def setup_desired_cap(desired_cap):
+ """
+ Sets the capability according to LT
+ :param desired_cap:
+ :return:
+ """
+ # Create a new dictionary to avoid modifying the original
+ cleaned_cap = {}
+
+ for key, value in desired_cap.items():
+ if key == 'connect':
+ # Force 'connect' to be None if it's not a valid timeout value
+ if not isinstance(value, (int, float)) or value is None:
+ cleaned_cap[key] = None
+ else:
+ cleaned_cap[key] = value
+ else:
+ cleaned_cap[key] = value
+
+ return cleaned_cap
\ No newline at end of file
diff --git a/features/lambdatest.feature b/features/lambdatest.feature
deleted file mode 100644
index 84410ea..0000000
--- a/features/lambdatest.feature
+++ /dev/null
@@ -1,9 +0,0 @@
-Feature: Test to add item
-
-Scenario: Test Advance boy
- Given I go to 4davanceboy to add item
- Then I Click on first checkbox and second checkbox
- When I enter item to add
- When I click add button
- Then I should verify the added item
-
diff --git a/features/steps/steps.py b/features/steps/steps.py
new file mode 100644
index 0000000..3ede1d6
--- /dev/null
+++ b/features/steps/steps.py
@@ -0,0 +1,43 @@
+"""
+Selenium steps to configure behave test scenarios
+"""
+import time
+from behave import *
+from selenium.webdriver.common.by import By
+from selenium.webdriver.support.ui import WebDriverWait
+from selenium.webdriver.support import expected_conditions as EC
+
+def wait_for_element(context, by, value, timeout=10):
+ return WebDriverWait(context.browser, timeout).until(
+ EC.presence_of_element_located((by, value))
+ )
+
+@when('visit url "{url}"')
+def step(context, url):
+ context.browser.get(url)
+
+@when('check if title is "{title}"')
+def step(context, title):
+ assert context.browser.title == title
+
+@when('field with name "First Item" is present check the box')
+def step(context):
+ element = wait_for_element(context, By.NAME, "li1")
+ element.click()
+
+@when('field with name "Second Item" is present check the box')
+def step(context):
+ element = wait_for_element(context, By.NAME, "li3")
+ element.click()
+
+@when('select the textbox add "{text}" in the box')
+def step(context, text):
+ textbox = wait_for_element(context, By.ID, "sampletodotext")
+ textbox.click()
+ textbox.clear()
+ textbox.send_keys(text)
+
+@then('click the "{button}"')
+def step(context, button):
+ element = wait_for_element(context, By.ID, button)
+ element.click()
\ No newline at end of file
diff --git a/features/steps/steps_definitation.py b/features/steps/steps_definitation.py
deleted file mode 100644
index 003cfbc..0000000
--- a/features/steps/steps_definitation.py
+++ /dev/null
@@ -1,75 +0,0 @@
-from selenium import webdriver
-import os
-from configparser import ConfigParser
-
-caps={}
-
-def before_all(context):
- config = ConfigParser()
- print ((os.path.join(os.getcwd(), 'config.cfg')))
- my_file = (os.path.join(os.getcwd(), 'config.cfg'))
- config.read(my_file)
-
- if os.getenv('LT_USERNAME', 0) == 0:
- context.user_name = config.get('Environment', 'UserName')
- else:
- context.user_name = os.getenv('LT_USERNAME')
- if os.getenv('LT_ACCESS_KEY', 0) == 0:
- context.app_key = config.get('Environment', 'AppKey' )
- else:
- context.app_key = os.getenv('LT_ACCESS_KEY')
- if os.getenv('LT_OPERATING_SYSTEM', 0) == 0:
- context.os = config.get('Environment', 'OS' )
- if os.getenv('LT_BROWSER', 0) == 0:
- context.browser = config.get('Environment', 'Browser' )
- if os.getenv('LT_BROWSER_VERSION', 0) == 0:
- context.browser_version = config.get('Environment', 'BrowserVersion' )
-
- remote_url= "https://"+context.user_name+":"+context.app_key+"@hub.lambdatest.com/wd/hub"
- caps['name'] = "LambdaTesBehaveSample"
- caps['build'] = "LambdaTestSampleApp"
- caps['browserName'] = context.browser
- caps['version'] = context.browser_version
- caps['platform'] = context.os
- caps['network'] = True
- caps['visual']= True
- caps['video']= True
- caps['console']= True
- print ( caps )
- print ( remote_url )
- context.driver = webdriver.Remote(command_executor=remote_url,desired_capabilities=caps)
-
-@given('I go to 4davanceboy to add item')
-def step(context):
- before_all(context)
- context.driver.get('https://lambdatest.github.io/sample-todo-app/')
-
-@then('I Click on first checkbox and second checkbox')
-def click_on_checkbox_one(context):
- context.driver.find_element_by_name('li1').click()
- context.driver.find_element_by_name('li2').click()
-
-@when('I enter item to add')
-def enter_item_name(context):
- context.driver.find_element_by_id('sampletodotext').send_keys("Yey, Let's add it to list")
-
-@when('I click add button')
-def click_on_add_button(context):
- context.driver.find_element_by_id('addbutton').click()
-
-@then('I should verify the added item')
-def see_login_message(context):
- context.driver.implicitly_wait(10)
- added_item = context.driver.find_element_by_xpath("//span[@class='done-false']").text
- print(added_item)
- print(added_item)
- if added_item in "Yey, Let's add it to list":
- return True
- else:
- return False
-
-def after_all(context):
- context.browser.quit()
-
-
-
diff --git a/features/test.feature b/features/test.feature
new file mode 100644
index 0000000..c6a475c
--- /dev/null
+++ b/features/test.feature
@@ -0,0 +1,28 @@
+Feature: Automate a website
+
+ @Chrome
+ Scenario: perform click events with Chrome
+ When visit url "https://lambdatest.github.io/sample-todo-app"
+ When check if title is "Sample page - lambdatest.com"
+ When field with name "First Item" is present check the box
+ When field with name "Second Item" is present check the box
+ When select the textbox add "Let's add new to do item for chrome" in the box
+ Then click the "addbutton"
+
+ @Firefox
+ Scenario: perform click events with Firefox
+ When visit url "https://lambdatest.github.io/sample-todo-app"
+ When check if title is "Sample page - lambdatest.com"
+ When field with name "First Item" is present check the box
+ When field with name "Second Item" is present check the box
+ When select the textbox add "Let's add new to do item for Firefox" in the box
+ Then click the "addbutton"
+
+ @Edge
+ Scenario: perform click events with Edge
+ When visit url "https://lambdatest.github.io/sample-todo-app"
+ When check if title is "Sample page - lambdatest.com"
+ When field with name "First Item" is present check the box
+ When field with name "Second Item" is present check the box
+ When select the textbox add "Let's add new to do item for Edge" in the box
+ Then click the "addbutton"
\ No newline at end of file
diff --git a/pavement.py b/pavement.py
new file mode 100644
index 0000000..797e04b
--- /dev/null
+++ b/pavement.py
@@ -0,0 +1,61 @@
+from paver.easy import *
+from paver.setuputils import setup
+import multiprocessing
+import json
+import os
+
+setup(
+ name="python-behave-todo",
+ packages=['features'],
+ version="1.0.0",
+ url="https://www.lambdatest.com/",
+ author="Lambdatest",
+ description=("Behave Integration with Lambdatest"),
+ license="MIT",
+ author_email="support@lambdatest.com"
+)
+
+
+def run_behave_test(env, index=0):
+ """
+ runs the individual test
+ :param env:
+ :param index:
+ :return:
+ """
+ if env == "jenkins":
+ sh('INDEX=%s env=%s behave features/test.feature ' % (index, env,))
+ else:
+ sh('INDEX=%s env=%s behave features/test.feature ' % (index, env,))
+
+
+@task
+@consume_args
+def run(args):
+ """
+ runs the behave test
+ :return:
+ """
+ env = args[0] if len(args) > 0 else ""
+ jobs = []
+ pool = get_pool_size()
+ for i in range(pool):
+ p = multiprocessing.Process(target=run_behave_test, args=(env, i,))
+ jobs.append(p)
+ p.start()
+
+
+def get_pool_size():
+ """
+ sets the number of parallel test
+ :return:
+ """
+ if "LT_BROWSERS" in os.environ:
+ CONFIG = json.loads(os.environ["LT_BROWSERS"])
+ pool = len(CONFIG)
+ else:
+ json_file = "config/config.json"
+ with open(json_file) as data_file:
+ CONFIG = json.load(data_file)
+ pool = len(CONFIG)
+ return pool
diff --git a/requirements.txt b/requirements.txt
index 73819c0..61e3cf2 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,3 +1,4 @@
-behave
-selenium
-ConfigParser
+Paver==1.3.4
+selenium>4.23.0
+behave==1.2.6
+behavex==1.6.0
\ No newline at end of file