Automation Framework Knowledge Base
Problem Statement
Provide an approach on how Consumer and Producer APIs will be tested
POC on below core services to showcase all automation principles and guide
Localisation- Upsert and search call
FileStore- Search File
Property Tax- Create Property
Solution
Design & Implement a Robust Automation Framework.
Build a modular Framework so any future changes are limited to a specific area and do not impact the entire framework.
Goal
Implement a framework that is robust enough to function with minimal changes
The framework handles multi-tenant with only properties update
The framework can switch environments with no manual update
A new environment can be integrated with updates to framework properties
Plan and Outcomes
Automation Framework: High-Level Architecture
Description
Global Properties:
Configuration The only rule is that on start-up Karate expects a file called karate-config.js to exist on the classpath and contain a JavaScript function. The function is expected to return a JSON object and all keys and values in that JSON object will be made available as script variables. And that's all there is to Karate configuration! You can easily get the value of the current 'environment' or 'profile', and then set up 'global' variables using some simple JavaScript.
Global Variables: Non-JSON values such as Java object references or JS functions are supported only if they are at the "root" of the JSON returned from karate-config.js.
Multiple Environment: Karate is flexible and allows users to overwrite the configuration variables within each test script - which is very convenient when in development mode or for rapid prototyping. This also takes care of environment-specific configuration. The external configuration file contains the hostname, credentials, stateCode, cityCode, etc.
Test Properties: Contains all properties related to test cases like feature files, HTTP requests, responses, test data etc.
Framework Properties: Contains all properties related to the Karate framework like pom.xml, YAML files, .md files etc.
Reports: We can generate default BDD cucumber reports and integrate reporting plugins.
Tests: Contains test scenarios feature files with execution tags, assertions etc.
MDMS call: Fetching the test data from MDMS and using it in tests.
Technologies Used
Java
JavaScript
Gherkin
BDD framework - Behavior Driven Development is a software development approach.
Automation Test Tags
Tag Name
BUSINESS SERVICES
@apportionService
apportion-service
@billingServiceDemand
billing-service/demand
@collectionServices
Collection Services
@dashboardAnalytics
Dashboard Analytics
@egfMaster
EGF Master
@egfInstrument
EGF Instrument
@dashboardIngest
Dashboard Ingest
@hrms
HRMS
@billingServiceBill
Billing Service
Tag Name
CORE SERVICES
@accessControl
Access Control
@egovWorkflowBusniessService
Egov Workflow Business Service
@encService
Enc Service
@fileStore
Filestore
@idGenerate
Id Generate
@localization
Localization Service
@location
Location Service
@mdmsService
MDMS
@eGovUser
eGov User
@eGovPdf
eGov PDF
@pgservices
PG Service
@reports
Reports
@searcher
Searcher
@url_Shorterning_Invalid
URL Shortening
@userAccountAfterLock
User Account Lock
@userOtp
User OTP
@zuul
Zuul
Tag Name
Municipal SERVICES
@propertyServices
Property Tax
@bpaCalculator
BPA Calculator
@bpaService
BPA Service
@dcrService
DCR Service
@eGovUserEvent
eGov User Event
@fireNOCBillingFeature
FireNOC Billing Slab
@fireNocService
FireNOC
@landService
Land Service
@NOCService
NOC Service
@PGRService
PGR Service
@propertyCalculator
Property Tax Calculator
@fsmService
FSM
@fsmBillingSlab
FSM Calculator
Tag Name
Service Type
@coreServices
Core Services
@businessServices
Business Services
@municipalServices
Municipal Services
@e2eServices
End To End Services
Tag Name
Test Type
@regression
Regression Tests
Tag Name
E2E Service
@propertyTaxEndToEnd
Property Tax and mCollect
@tradeLicenseEndToEnd
Trade License
@wsEndToEnd
Water and Sewerage Connection
@fsmEndToEnd
FSM
@pgrEndToEndFlow
PGR
@firenocEndToEnd
FireNOC
@bpae2eservice
BPA
__All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.
Automation Test Reporting
Executed test results and reports of all tests can be viewed in the target folder.
Pre-requisite: karate Runner plugin installation in VS code editor as specified in Readme.md
If not done during setup, then please install karate runner plugin as shown below.
Target folder generates test results folders as per time stamp of test suite runs.
When we run TestRunner file (ex: @regression), all the features under classpath would run and feature wise reports would be generated and placed under target/surefire-reports.
Post execution of test runs, the framework will automatically generate: surefire-reports
karate-summary.html
cucumber-html-reports folder
A folder will automatically create under ./target/ folder along with timestamp which will contain cucumber-html-reports.
Select the karate runner tab and click on overview-features.html to view the reports as shown in image.
Summary of service features and test status can be seen in details with Pass / Fail / run time stamp
****
Now, observe below Feature Report, you can see lots of verbose logging in the console and the actual output whether the features/scenarios are passed/ failed are skipped.
karate-summary.html:
