IntelliJ IDEA 2021.3 Help

Selenium

Selenium is a framework for automating tests in web applications.

Selenium support allows you to create a dedicated project for automated tests in Java, Kotlin, or Groovy. You can choose Maven or Gradle for dependency management. For managing test cases, you can select TestNG or JUnit.

Selenium UI Testing plugin provides code highlighting, inspections and code completion in tests, validation for various configuration files, and icons in the gutter for easier navigation. For a full description of features, refer to Introducing Selenium Support in IntelliJ IDEA.

Install the Selenium UI Testing plugin

  1. In the Settings/Preferences dialog (Ctrl+Alt+S), select Plugins.

  2. Switch to the Marketplace tab, type Selenium UI Testing, and click Install.

  3. Apply the changes and close the dialog. Restart the IDE if prompted.

Installing the Selenium UI Testing plugin plugin

Create a new Selenium project

  1. From the main menu, select File | New | Project.

    Otherwise, if you're on the Welcome screen, click New Project.

  2. From the list on the left, select Selenium.

  3. From the Project SDK list, select the JDK version that you want to use in this project.

    If the JDK is installed on your computer, but not defined in the IDE, select Add JDK and specify the path to the JDK home directory (for example, /Library/Java/JavaVirtualMachines/jdk-14.jdk).

    If you don't have the necessary JDK on your computer, select Download JDK.

    Configuring a JDK for a new Selenium project
  4. Select the build tool that you want to use in the project (Maven or Gradle) and the testing framework (JUnit or TestNG).

  5. From the Languages list, select which programming languages you want to use in the project apart from Java.

    Click Next.

    Creating a new Selenium project
  6. Select other frameworks and libraries that you want to install.

    This step is optional. You will be able to add the necessary libraries any time later.

  7. On the next step of the wizard, specify the project name and location. If necessary, change the artifact coordinates and click Finish.

A new project is created with a predefined folder structure according to the options that you have selected and adds a source and a test file.

A new Selenium project

Coding assistance for CSS and XPath

Selenium UI Testing plugin provides coding assistance for XPath and CSS, which are used in Selenium API as well as in many other libraries for UI testing. This includes syntax error highlighting in selectors as you type and code completion for standard CSS/HTML elements.

Code completion in Selenium XPath file

Selenium UI Testing plugin also provides coding assistance for JavaScript fragments, HTML tags and CSS properties, Selenium Grid 3 configuration files, Selenoid configuration files, and Allure Framework annotations. For more information, refer to Introducing Selenium Support in IntelliJ IDEA.

Generate Selenium Page Object

The Selenium UI Testing plugin provides a Chromium-based tool that lets you open web pages and generate code compliant with the page object pattern right in the IDE. This reduces the amount of time spent on boilerplate code and allows you to focus on the testing logic.

Open a web page

  1. Make sure that the Selenium library is added to your project.

  2. From the main menu, select Tools | Generate Selenium Page Object. The Page Object editor tab opens.

  3. In the address bar, enter the URL of the website you are going to test. Press EditorEnter. The web page opens in the browser just below the address bar.

    Selenium pog url

After you have opened a web page, proceed to picking the page elements that you are going to test.

Add web elements

  1. Select the required elements in one of the following ways:

    • For single elements: click the Select Element in Page button or press F3, then select an element in the browser. The element gets highlighted in the page structure to the left. The highlighing also works in the opposite direction – if you select an element in the page structure, it gets highlighted in the browser window.

    • For one or more elements: select one or more elements in the page structure to the left of the browser window.

    Selenium pog select
  2. Press Ctrl+Enter. Alternatively, right-click the selected elements and click Add To Page.

Generate code

  1. Make sure the elements you are going to use in your tests are added to the page object. For each element, you can configure which type of selector to use. For example, the same element can be located using a data-* attribute, which is considered a preferred way, a CSS selector, XPath, and so on.

    Selenium pog elements
  2. Select the required language and framework.

    Selenium pog language framework
  3. After you have specified the elements and template, the generated code appears in the editor window. You can copy and paste it to your page object class or export the code to a file Ctrl+O.

    Selenium pog code

Advanced options

Selenium Page Object generator provides several options that let you handle special cases. You can access them on the browser window toolbar:

Selenium pog advanced

The following options are available:

  • Clear Browser Cookies – clears the browser cookies cache for the current session.

  • Enable/disable Popup Windows – toggles the visibility of popup windows.

  • Open Developer Tools – Chromium developer tools. This option is helpful when extra functionality or a workaround is needed.

    Create custom templates

    You can tailor the output for a specific project or workflows by creating custom templates.

    1. Select the required language and framework.

      Selenium pog language framework
    2. Click Customize Template.

      Selenium pog template
    3. The File and Code Templates dialog opens, where you can customize the generated boilerplate code. For details on how to create a template, refer to File templates.

    Run your tests

    Place the caret at the test class to run all tests in that class, or at the test method, and press Ctrl+Shift+F10. Alternatively, click the the Run button gutter icon next to the test class or test method. For more information, refer to Run tests.

    Running a test

    When the tests finish running, the results are displayed on the Test Runner tab of the Run tool window. On this tab, you can rerun tests, export and import test results, see how much time it took to run each test, and so on. For more information, refer to Explore test results.

    Use Selenoid for cross-browser testing

    Selenoid is an implementation of the Selenium hub for Docker, which allows you to execute automated tests on web browsers running in Docker containers. For each test, Selenoid creates a container with the specified web browser, environment, and settings.

    Run Selenoid on Docker

    1. Open the browsers.json file in the editor.

    2. On the panel above the editor, click Launch.

      Running Selenoid on Docker

    The IDE will pull all the required containers with the browsers, and run the main Selenoid container to manage them.

    Running Selenoid on Docker

    There are additional options available in the Selenoid run configuration settings, such as output destination folders for logs and videos. To access these options, click Configure on the pane above the editor when the browsers.json file is opened. For the detailed description of the options, refer to Docker run configurations.

    Selenium run/debug configuration
    Last modified: 25 November 2021