Follow below steps:
- Install NodeJS and NPM
- Unzip the framework code
- Go to root directory of framework code. Lets call this root as
<projectRoot> - On command line:
npm install - Install Gulp command line
- Install Gauge .While installation, dont select any runners.
- Install Javascript runner for gauge using command line:
gauge --install js - Verify that runner is installed using:
gauge -v - Install Gauge html-report plugin using:
gauge --install html-report - if Mobile Automation is required then Install Appium
Additional installation steps for Oracle client to work:
- Do a step by step installation provided on link till step “IV Set Environment Variables”
- Unzip your folder
- Run npm install (this will install oracle dependencies as well)
- Add DB credentials in env/qa/qa.properties
- Run “gauge –verbose –env QA –tags db specs/
Gulp is being used as task runner along with NPM as package manager. As of now there are no tasks in npm like transpile, build, lint etc. However, users can feel free to configure/develop and integrate such tasks in package.json. Most of tasks are handled through Gulp. Various tasks added are:
- Installation and Start of selenium : if selenium is installed, this will not install it
- Transpilation: Existing scripts are written in es2015 and hence es2015 preset is used for Babel transpilation
- Test: Various test tasks(uiTest, restTest, mobileTest) are built in to represent how different automation can be executed directly from single tool
Logger : There is winston logger integrated in gulp to log all the build activity information.
Follow below steps for executing template tests already built in framework:
- For executing UI tests:
gulp uiTest - For executing REST tests:
gulp restTest - Start Appium via command-line before executing Mobile tests:
appium - For executing Mobile tests:
gulp mobileTest
Agnes is built on top of Gauge and follows Page Object pattern for all types of representations (web pages, db tables, rest api, mobile screens) for better reusability, readability and organization of object repository and tests. Tests are usually built on top of page objects
Common functions/Utility functions(DB Client, Rest Client, Loggers, Data Readers) can be added here <projectRoot>/src/common
Before you start writing tests, it would be prudent build required page objects. Depending on type of page object need to be built, they can developed at following locations: <projectRoot>/src/db_query_objects
<projectRoot>/src/mobile_page_objects
<projectRoot>/src/rest_service_objects
<projectRoot>/src/ui_page_objects
Specs are developed in <projectRoot>/specs folder. There are already few specs written in markdown format. They are organized in different folders as per type of testing(db, rest, ui, mobile). Guide on writing specs is present here. Features added in specs examples:
- Tags - You will notice different tags present in specs to distinguish different types of testing during execution.
- Tables - There are various inline and external table references present in various specs
- Parameterization - Almost all specs have data parameterization in-built.
Tests are developed in <projectRoot>/src/tests
There are two forms non-code resources present in framework. These resources are picked up and read from different locations based on env parameter. This parameter is provided to framework/project via command line. Refer various gulp test tasks, you will see command line with environment provided - 'gauge --env qa --verbose --tags ui specs/'
- Config - Present at
<projectRoot>/env/<env>/<env>.properties. For example,/env/qa/qa.propertiescan be referred. There are various values that can be set here which are specific environment. For example - Db credentials, Web Urls, TestData path - Test Data - Present at
<projectRoot>/resources<env>