- Install NodeJS in local (https://nodejs.org/en/download/)
- Install protractor globally. Command:
npm install -g protractor - Clone the repo in local
- Open terminal/cmd inside cloned directory (where
package.jsonis present) - Install project dependencies. Command:
npm install - Execute the tests. Command:
npm run e2e
https://docs.google.com/spreadsheets/d/1ZmJACS65--m6QV7Y4I4KCqzUp0AlNDrsNy7kmIwfyjk/edit#gid=0
If you are working on angular app automation then don't forget to remove browser.waitForAngularEnabled(false); e2e\page-objects\pages\base-page.ts Line-10
In case if any of you come across, chrome getting 'no session' or 'chrome not reachable' on docker It's due to low shared memory /dev/shm Please increase shared memory to around 1G as default is only 64MB and might cause issues even with single instance
For integration tests the folder structure should be similar to this as our spec files are going to utilize multiple page objects for completing a test
─e2e
│ tsconfig.e2e.json
│
├───components
│ ├───devfactory
│ │ ├───component-helpers
│ │ │ component-helpers.ts
│ │ │
│ │ └───component-types
│ │ └───(component-name)-component
│ │ breadcrumbs-component-selectors.ts
│ │
│ ├───html
│ │ (type)-helper.ts
│ │
│ ├───misc-utils
│ │ common-label.ts
│ │ constants.ts
│ │ html-helper.ts
│ │
│ └───vendor
│ └───vendor-name
│ vendor-name.ts
│
├───page-objects
│ ├───contracts
│ │ page.ts
│ │
│ └───pages
│ │ base-page.ts
│ │
│ └───(page-name)
│ (page-name)-page.constants.ts
│ (page-name)-page.helper.ts
│ (page-name)-page.validations.ts
│ (page-name).po.ts
│
└───test-suites
├───(test-rail-suite-name)-test-suite
│ └───(testrail-root-after-suite)
│(testrail-root-after-suite).e2e-spec.ts
│
└───helpers
suite-names.ts
e2e\modules\Contracts are basically a kind of interface, like those things which are compulsory to be implemented by every page object file. Right now we have it for Page, so whatever is declared in it is a unified requirement for all the components that should be put in here. So this Page contract has to be inherited by all the page objects
e2e\page-objects\base-page it's basically a utility for all the tricky selectors so this page has to be inherited by all the page objects
We are using default conventions which are suggested by angular team on top of that we are also using some more configuration parameters to produce high quality code. https://github.com/Microsoft/TypeScript/wiki/Coding-guidelines
We must post fix .e2e-spec.ts for all the test files
We have a Dockerfile created in root of the repo for test execution in interactive mode and usage VNC for debugging as well. Documentation here
Allure reporting is integrated. For configuration please visit https://github.com/allure-framework/allure-jasmine
On Team city we have to use Native TeamCity plugin or Third part TeamCity plugin
On Jenkins we have to use Jenkins plugin
https://docs.qameta.io/allure/#_jenkins
on local machine it can be generated via command line
npm install -g allure-commandline --save-dev
allure serve , example
allure serve allure-results
Following keys are defined in default-config-setup.js
multiCapabilities.maxInstances: 5 Default max instances for selenium grid
bsMultiCapabilities.maxInstances: 5 Default max instances for browser stack
3 Ways to pass the max instances
-
Using environment variable MAX_INSTANCES
-
Using command line param --params.maxInstances
-
Default is 5
- Install NodeJS in local (https://nodejs.org/en/download/) v9.10
- Install protractor globally. Command:
npm install -g protractor - Clone the repo in local
- Open terminal/cmd inside cloned directory (where package.json is present)
- Install project dependencies. Command:
npm install - Execute command:
npm run postinstall - Execute command:
npm run lint - Execute command to run the test in headless mode:
npm run e2e-tc -- --params.headlessBrowser=trueTo execute the test UI Execute command -npm run e2e-tc -- --params.appUrls.qaAuthUrl=https://connect.olivesoftware.com --params.appUrls.cseUrl=http://52.86.72.225/ --params.appUrls.connectUrl=http://34.205.230.78/OliveSelfServicePortal_deploy/Default.aspx
Run npm run e2e to execute the end-to-end tests via Protractor.
Almost all the switches are configurable using Environment variable, Check the respective section for more details
NPM scripts can have parameters passed by command line. E.g.:
// Notice extra -- with cmd line args
npm run e2e -- --baseUrl=<URL>
OR
protractor <conf-file> --baseUrl=<URL>
Following sections defines which parameters are accepted by Protractor and TestRail.
We have following various command line options available which can be specified as follows with protractor command
All of them are optional
--params.testrail.projectId = [N] : Testrail project id, it should not be passed via command line and can be specified in params section so all the info is unified
--params.testrail.milestoneName = [Milestone name] : This milestone will be used to create a milestone with a postfix as current week number or it's already created it will not be created
--params.testrail.versionName = [Version name] : This version name is basically a field in test rail test case result field, we might want to specify that which version it should be tagged to then we can specify
--params.testrail.host = [e.g https://testrail.devfactory.com/] This would be common across all the projects but still we have made it configurable
--params.testrail.user = [login id] - It is recommended to always pass it using continuous integration tool so it's secure
--params.testrail.password = [XXXX] - It is recommended to always pass it using continuous integration tool so it's secure it can be either a password or access key
- Test writing instructions - Please make sure that
suite namein test rail and in *-specs.ts is same and test case has an id append to name with bracket, Heresuite nameis defined in describe andtest idis defined as [1]. Example
describe("This should be the suite name", function() {
it("Mind the id at the end of this with bracket - [1]", function() {
expect(true).toBe(true);
});
});If we want to associate bug id with test case in a run then we must append the bug id in test name like [BUG:XXX-00000], Please note that it must be ignored then only it will be associated with test case, This test case will be marked as skipped in test rail
Example
describe("This should be the suite name", function() {
xit("Mind the id at the end of this with bracket - [1] [BUG:SNSGCID-19909]", function() {
expect(true).toBe(true);
});
});Environment variables configuration for test rail-
projectId - process.env.TESTRAIL_PROJECT_ID
milestoneName - process.env.TESTRAIL_MILESTONE_NAME
versionName - process.env.VERSION
host - process.env.TESTRAIL_HOST
user - process.env.TESTRAIL_USER
password - process.env.TESTRAIL_PASSWORD
You might want to have some misc info to be passed from command line that can be specified using an object under param section of object in config For example we have 2 switches right now like --params.login.user = [XXXX] --params.login.password = [XXXX]
--params.testrail.versionName Or process.env.VERSION
Default - as Required
--params.selenium.hub Or process.env.SELENIUM_URL
Default - as Required
Browser stack related configuration can be passed command line and following options are available
--params.browserstack.user='bs-username'
--params.browserstack.key='bs-key'
--params.browserstack.local=[true|false]
Default is true
--params.browserstack.browser=browserName Default is Chrome
Default browser names are available Chrome, Firefox, IE, IE10, Edge, Safari, Safari9
We can also have them using environment variables, Following keys are used for their respective values
'browserstack.user' - process.env.BROWSERSTACK_USERNAME
'browserstack.key' - process.env.BROWSERSTACK_ACCESS_KEY
'browserstack.local' - process.env.BROWSERSTACK_LOCAL
'browserstack.localIdentifier' - process.env.BROWSERSTACK_LOCAL_IDENTIFIER
'build' - process.env.BROWSERSTACK_BUILD
Why Protractor is better than Selenium - Test Team Discussion
Interation with product team - Test Team & PCA Discussion
-
Selectors
-
Web UI Automation test cases
-
Api Automation test cases
*.constant.ts, can have field/objects/properties but not methods*.po.tscan have objects/properties but not methods*.validation.tscan have everything*.helper.tscan only have methods