Framework Structure

_images/folder_structure.png

Framework Folders and Files

`Data folder - This folder is used to hold all test data files used by the NFR script run. Use can create a test data file and put inside this folder`

`Scripts folder - This folder is used to hold nfr request folder and locust scripts folder.`

`Locust_script Folder - This folder is used to hold all locust files. All flow scenario is imported into the locust file.`

`Nfr_requests Folder - This folder is used to hold all supporting library folders used in the NFR framework.`

`api_requests Folder - This folder is used to hold all API implementation scripts. Which is further imported in the flow scenario script.`

`flow_scenarios Folder - This folder is used to hold all Flow scenarios of the API implementation. Which is further imported in the locust script.`

`config Folder - This folder is used to hold all config scripts like headermanager, commonconfig, etc.`

`CommonConfig.py - This file contains common static config details like host, etc used across the framework.`

`HeaderManager.py - This file contains the Header manager class which generate/manipulate headers used in API request.`

`TestDataProvider.py - This file contains all functions to read data files belonging to the data folder.`

`Utils.py - This file contains all utility functions used in the framework.`

`parser Folder - This folder is used to hold all scripts for request payload serialization and response serialization.`

`request_helpers Folder - This folder is used to hold all request payload generator scripts. Where a user has to update payload data that is going to be used in the framework run.`

`response_helpers Folder - This folder is used to hold all response sterilization scripts.`

`audit_log.log File - This file holds all audit logs of the script generation.`

`MetaConfig.json File - This file holds all data-related swagger specs and function names with file path information. This is used to generate a framework if a new spec is released.`

`CONFIG.md File - This file is used by Flash. It contains python version details only.`