🗣️ReadFile Annotation for Custom Code

The ReadFile annotation is an integral part of the Precision Test Automation framework, crafted exclusively for enhancing file handling capabilities within custom code sections. This annotation is tailored to specify file reading parameters for methods that are explicitly designed to interact with files — such as downloading or reading from a specified path — as part of the automation of web applications, especially when involving file downloads through WebDriver.

Overview

Designed for use exclusively within the framework's custom code feature, @ReadFile allows developers to declaratively specify how and which files should be interacted with in their custom code methods. This approach facilitates streamlined file manipulation tasks, ensuring a more organized and maintainable codebase.

Annotation Parameters

directoryPath

• Type: String

• Default: "" (empty string)

• Description: The filesystem path to the directory from where the file should be accessed. If unspecified, a default directory may be assumed based on the context of the custom code.

fileNameStartsWith

• Type: String

• Default: "" (empty string)

• Description: A filter applying to file names, targeting files that begin with the specified prefix. This parameter aids in narrowing down the files to be processed by the custom code.

fileType

• Type: FileTypes

• Required: Yes

• Description: The type of file the custom code method will handle. It must be one of the predefined FileTypes enum values, guiding the method in processing the correct file format.

timeOut

• Type: int

• Default: 10

• Description: The maximum duration, in seconds, the custom code will wait for a file download to complete when initiated through ChromeDriver. This parameter is crucial for ensuring that the method does not proceed before the file is fully downloaded.

Supported File Types

The framework currently supports two file types:

• CSV: Used for files containing comma-separated values, ideal for data-driven testing scenarios.

• TXT: Plain text files, often used for configuration or data that does not require a specific structure.

Applying @ReadFile to Custom Code

The annotation is intended for use with methods that perform file operations, such as reading from files or managing file downloads, enhancing the efficiency and reliability of tests involving file operations.

Example Usage

CSV File Interaction

javaCopy code@ReadFile(
    directoryPath = "test_data/web/test_case_flows/testdirectory",
    fileNameStartsWith = "KeyBoardDown_Sanity",
    fileType = FileTypes.CSV
)
public void getCsvFile(Hashtable<String, List<String>> table, Set<String> set){
    // Custom code to handle CSV file
}

In this example, the getCsvFile method is configured to interact with CSV files in the specified directory that begin with "KeyBoardDown_Sanity".

TXT File Interaction

javaCopy code@ReadFile(
    directoryPath = "test_data/web/page_object_locators",
    fileNameStartsWith = "sample",
    fileType = FileTypes.TXT
)
public void getTxtFile(List<String> table){
    // Custom code to handle TXT file
}

Here, the getTxtFile method is set up to read TXT files starting with "sample" from a specific directory path.

Conclusion

The ReadFile annotation significantly enhances file operation integration within the custom code sections of automation scripts. By clearly defining file interaction parameters, it improves code readability, maintainability, and project reliability, particularly in test automation frameworks where file handling is a routine task.