Properties file for configuration in Selenium Java - Framework Patterns

Framework Mode - Properties file for configuration

Folder Structure

project-root/
├── pom.xml                        # Maven build file
├── testng.xml                    # TestNG suite configuration
└── src/
    ├── main/
    │   └── java/
    │       └── com/example/app/
    │           └── pages/          # Page Object classes
    └── test/
        ├── java/
        │   └── com/example/
        │       ├── tests/          # Test classes
        │       └── utils/
        │           └── ConfigReader.java            # Utility to read properties
        └── resources/
            └── config.properties            # Properties file for configuration
  

Test Framework Layers

• Configuration Layer: Reads config.properties using ConfigReader utility.
• Page Object Layer: Classes representing UI pages, using config values if needed.
• Test Layer: Test classes that use page objects and config data.
• Utility Layer: Helpers like ConfigReader to load properties, WebDriver setup, waits.
• Resource Layer: Stores properties files and test data files.

Configuration Patterns

Use a config.properties file in src/test/resources to store environment variables like URLs, browser types, timeouts, and credentials.

Example config.properties:

baseUrl=https://example.com
browser=chrome
timeout=10
username=testuser
password=testpass
  

Create a ConfigReader utility class to load these properties once and provide getters.

Use Maven profiles or system properties to switch environments by loading different properties files or overriding values.

Test Reporting and CI/CD Integration

• Use TestNG reports for test execution results.
• Integrate with CI tools like Jenkins or GitHub Actions to run tests automatically on code changes.
• Pass environment or browser parameters via CI build parameters to control config values dynamically.
• Generate HTML or XML reports for easy review.

Best Practices

• Keep sensitive data like passwords out of version control by using environment variables or encrypted files.
• Load properties once per test run to improve performance.
• Use descriptive keys in properties files for clarity.
• Use fallback default values in code if a property is missing.
• Separate environment-specific properties (dev, test, prod) into different files.

Self Check

Where in this folder structure would you add a new property for the test environment URL?

Key Result

Use a properties file in src/test/resources with a ConfigReader utility to manage test configuration cleanly.

Practice

1. What is the main purpose of using a .properties file in Selenium Java tests?

easy

A. To compile Java source files automatically

B. To write the test cases in a different programming language

C. To store configuration data like URLs and credentials outside the test code

D. To store screenshots taken during test execution

Solution

1. Step 1: Understand the role of properties files

   Properties files are used to keep configuration data separate from code, such as URLs, usernames, and passwords.

2. Step 2: Identify the correct purpose in Selenium tests

   Using properties files makes tests flexible and easier to maintain by avoiding hard-coded values.

3. Final Answer:

   To store configuration data like URLs and credentials outside the test code -> Option C

4. Quick Check:

   Properties file = external config storage [OK]

Hint: Properties files hold config, not code or screenshots [OK]

Common Mistakes:

• Thinking properties files contain test scripts
• Confusing properties files with logs or reports
• Assuming properties files compile code

2. Which Java class is commonly used to load a .properties file in Selenium tests?

easy

A. Properties

B. FileReader

C. BufferedReader

D. FileInputStream

Solution

1. Step 1: Identify the class for properties handling

   The Properties class in Java is designed to load and read key-value pairs from .properties files.

2. Step 2: Differentiate from other classes

   While FileReader and FileInputStream help read files, Properties specifically loads and manages properties data.

3. Final Answer:

   Properties -> Option A

4. Quick Check:

   Java Properties class loads config files [OK]

Hint: Use Properties class to load .properties files [OK]

Common Mistakes:

• Using FileReader alone without Properties
• Confusing BufferedReader with Properties
• Trying to load properties without Properties class

3. Given the following code snippet, what will be the output if the config.properties file contains url=https://example.com?

Properties prop = new Properties();
FileInputStream fis = new FileInputStream("config.properties");
prop.load(fis);
System.out.println(prop.getProperty("url"));

medium

A. null

B. https://example.com

C. url=https://example.com

D. FileNotFoundException

Solution

1. Step 1: Load properties from file

   The Properties object loads key-value pairs from the file using load().

2. Step 2: Retrieve the value for key 'url'

   Calling getProperty("url") returns the value associated with 'url', which is 'https://example.com'.

3. Final Answer:

   https://example.com -> Option B

4. Quick Check:

   getProperty('url') = 'https://example.com' [OK]

Hint: getProperty(key) returns the value for that key [OK]

Common Mistakes:

• Expecting the whole line instead of just the value
• Confusing key with value in output
• Not loading the file before getting property

4. Identify the error in the following code snippet that tries to load a properties file:

Properties prop = new Properties();
FileInputStream fis = new FileInputStream("config.properties");
prop.load();
System.out.println(prop.getProperty("browser"));

medium

A. Missing argument in prop.load() method

B. FileInputStream path is incorrect

C. Properties object not instantiated

D. getProperty method is misspelled

Solution

1. Step 1: Check method usage for loading properties

   The load() method requires an InputStream argument, but here it is called without any argument.

2. Step 2: Verify other parts of the code

   The FileInputStream is correctly created, Properties is instantiated, and getProperty is spelled correctly.

3. Final Answer:

   Missing argument in prop.load() method -> Option A

4. Quick Check:

   load() needs InputStream argument [OK]

Hint: Always pass InputStream to load() method [OK]

Common Mistakes:

• Calling load() without argument
• Assuming load() reads file automatically
• Ignoring exceptions from FileInputStream

5. You want to switch browsers in your Selenium tests by changing only the browser value in a config.properties file. Which approach correctly reads this value and uses it to launch Chrome or Firefox browsers?

hard

A. Use getProperty('browser') but always launch ChromeDriver regardless of value

B. Hardcode browser choice in test code and ignore properties file

C. Load properties but never read 'browser' key, just launch FirefoxDriver

D. Load properties, get 'browser' value, then use if-else to create ChromeDriver or FirefoxDriver accordingly

Solution

1. Step 1: Load the properties file and read the 'browser' key

   Use Properties class to load the file and get the value of 'browser' key.

2. Step 2: Use conditional logic to launch the correct browser driver

   If the value is 'chrome', create a ChromeDriver instance; if 'firefox', create a FirefoxDriver instance.

3. Final Answer:

   Load properties, get 'browser' value, then use if-else to create ChromeDriver or FirefoxDriver accordingly -> Option D

4. Quick Check:

   Config-driven browser choice = if-else on getProperty('browser') [OK]

Hint: Use if-else on property value to pick browser driver [OK]

Common Mistakes:

• Ignoring properties file and hardcoding browser
• Not using conditional logic for browser selection
• Loading properties but not reading the key