Custom annotations in Selenium Java - Framework Patterns

Framework Mode - Custom annotations

Folder Structure

src/
├── main/
│   └── java/
│       └── com/example/project/
│           ├── annotations/       # Custom annotation definitions
│           ├── pages/             # Page Object classes
│           ├── utils/             # Utility classes (e.g., waits, helpers)
│           └── config/            # Configuration classes
└── test/
    └── java/
        └── com/example/project/
            ├── tests/             # Test classes
            └── listeners/         # TestNG listeners, e.g., for reporting

Test Framework Layers

• Annotations Layer: Contains custom annotation interfaces (e.g., @Retry, @TestInfo) to add metadata or behavior to tests.
• Page Object Layer: Classes representing web pages with locators and methods to interact with UI elements.
• Test Layer: Test classes using TestNG with custom annotations to control test execution or add info.
• Utilities Layer: Helper classes for common tasks like waits, logging, or annotation processing.
• Configuration Layer: Classes managing environment settings, browser setup, and credentials.

Configuration Patterns

• Environment Properties: Use config.properties files for different environments (dev, qa, prod) loaded via a config class.
• Browser Setup: Configure browser type and options in a factory class, selectable via system properties or config files.
• Credentials Management: Store sensitive data securely (e.g., encrypted files or environment variables) accessed by config classes.
• Annotation Parameters: Custom annotations can accept parameters (e.g., retry count) to configure test behavior dynamically.

Test Reporting and CI/CD Integration

• Use TestNG listeners to capture test results and generate detailed HTML reports.
• Custom annotations can trigger listeners or retry logic to improve test reliability and reporting clarity.
• Integrate reports with CI/CD pipelines (e.g., Jenkins, GitHub Actions) to show pass/fail status and logs after each build.
• Use logs and screenshots on test failure, triggered by annotation-driven retry or hooks.

Best Practices for Custom Annotations in Selenium Java Framework

• Keep Annotations Simple: Define clear, single-purpose annotations to avoid complexity.
• Use Retention and Target Properly: Set retention policy to runtime and target to methods or classes as needed.
• Process Annotations via Reflection: Use Java reflection to read annotation values and apply logic (e.g., retries, test metadata).
• Integrate with TestNG: Combine custom annotations with TestNG listeners or transformers for seamless behavior changes.
• Document Annotations: Provide usage examples and expected effects to help team members understand and use them correctly.

Self Check

Where in this framework structure would you add a new custom annotation called @FlakyTest to mark tests that should be retried automatically?

Key Result

Use custom annotations in a dedicated package to add metadata and control test behavior, processed via reflection and integrated with TestNG listeners.

Practice

1. What is the main purpose of creating custom annotations in Selenium Java tests?

easy

A. To automatically generate test reports without any code

B. To replace all Selenium WebDriver methods with custom ones

C. To write test cases without using any Java code

D. To add metadata that can control test behavior or provide extra information

Solution

1. Step 1: Understand what annotations do

   Annotations add metadata to code elements like methods or classes, influencing how tests run or are processed.

2. Step 2: Identify the role of custom annotations

   Custom annotations let testers add their own metadata to control or describe tests beyond built-in annotations.

3. Final Answer:

   To add metadata that can control test behavior or provide extra information -> Option D

4. Quick Check:

   Custom annotations = metadata control [OK]

Hint: Custom annotations add info to tests, not replace code [OK]

Common Mistakes:

• Thinking custom annotations replace WebDriver methods
• Assuming they auto-generate reports without code
• Believing tests can run without Java code

2. Which of the following is the correct syntax to define a custom annotation named TestInfo in Java?

easy

A. public @interface TestInfo { String author(); int priority() default 1; }

B. public class TestInfo { String author(); int priority() default 1; }

C. @interface TestInfo { public String author; public int priority = 1; }

D. annotation TestInfo { String author(); int priority(); }

Solution

1. Step 1: Recall Java annotation syntax

   Annotations use the keyword @interface and define methods without bodies for elements.

2. Step 2: Check public @interface TestInfo { String author(); int priority() default 1; } syntax

   public @interface TestInfo { String author(); int priority() default 1; } correctly uses public @interface TestInfo and defines methods with optional default values.

3. Final Answer:

   public @interface TestInfo { String author(); int priority() default 1; } -> Option A

4. Quick Check:

   Annotation syntax = @interface + methods [OK]

Hint: Annotations use @interface keyword, not class or annotation [OK]

Common Mistakes:

• Using class instead of @interface
• Declaring fields instead of methods inside annotation
• Missing default keyword for optional elements

3. Given the custom annotation and usage below, what will be the output when printTestInfo() is called?

import java.lang.reflect.Method;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

@Retention(RetentionPolicy.RUNTIME)
@interface TestInfo {
  String author();
  int priority() default 1;
}

public class SampleTest {
  @TestInfo(author = "Alice", priority = 3)
  public void testMethod() {}

  public static void printTestInfo() throws Exception {
    Method m = SampleTest.class.getMethod("testMethod");
    TestInfo info = m.getAnnotation(TestInfo.class);
    System.out.println(info.author() + ":" + info.priority());
  }
}

medium

A. Compilation error

B. Alice:1

C. Alice:3

D. null:0

Solution

1. Step 1: Understand annotation retrieval via reflection

   The method getAnnotation(TestInfo.class) fetches the annotation instance on testMethod.

2. Step 2: Check annotation values

   The annotation has author="Alice" and priority=3, so printing them outputs "Alice:3".

3. Final Answer:

   Alice:3 -> Option C

4. Quick Check:

   Reflection reads annotation values correctly [OK]

Hint: Annotation values print as set, defaults overridden [OK]

Common Mistakes:

• Assuming default priority is used instead of 3
• Expecting null because of missing retention policy
• Thinking reflection causes compile error

4. Consider this custom annotation definition:

@interface TestInfo {
  String author();
  int priority() default 1;
}

And this usage:

@TestInfo(author = "Bob")
public void test() {}

Why might the following code throw a NullPointerException when accessing priority()?

TestInfo info = testMethod.getAnnotation(TestInfo.class);
int p = info.priority();

medium

A. The priority method is missing in the annotation definition

B. The annotation is not retained at runtime, so info is null

C. The author value is missing, causing priority to be null

D. Annotations cannot have default values

Solution

1. Step 1: Check annotation retention policy

   If the annotation lacks @Retention(RetentionPolicy.RUNTIME), it is not available at runtime, so getAnnotation returns null.

2. Step 2: Understand NullPointerException cause

   Since info is null, calling info.priority() throws NullPointerException.

3. Final Answer:

   The annotation is not retained at runtime, so info is null -> Option B

4. Quick Check:

   Missing runtime retention = null annotation [OK]

Hint: Always add @Retention(RetentionPolicy.RUNTIME) for runtime use [OK]

Common Mistakes:

• Assuming default values cause null
• Thinking missing author causes error
• Believing annotations can't have defaults

5. You want to create a custom annotation @StepInfo to mark test steps with a description and an optional severity level (default "LOW"). You also want to process these annotations at runtime to print all step descriptions with their severity. Which combination of annotation elements and retention policy is correct to achieve this?

hard

A. @Retention(RetentionPolicy.RUNTIME) public @interface StepInfo { String description(); String severity() default "LOW"; }

B. @Retention(RetentionPolicy.CLASS) public @interface StepInfo { String description(); String severity() default "LOW"; }

C. @Retention(RetentionPolicy.SOURCE) public @interface StepInfo { String description(); String severity(); }

D. public @interface StepInfo { String description(); String severity() default "LOW"; }

Solution

1. Step 1: Choose correct retention for runtime processing

   To access annotations at runtime via reflection, use @Retention(RetentionPolicy.RUNTIME).

2. Step 2: Define annotation elements with default values

   Define description() as required and severity() with default "LOW" for optional use.

3. Final Answer:

   @Retention(RetentionPolicy.RUNTIME) public @interface StepInfo { String description(); String severity() default "LOW"; } -> Option A

4. Quick Check:

   Runtime retention + default value = correct annotation [OK]

Hint: Use RUNTIME retention to read annotations during tests [OK]

Common Mistakes:

• Using CLASS or SOURCE retention prevents runtime access
• Omitting retention causes default CLASS retention
• Not providing default for optional elements