Service Level Testing

Purpose

• Service level testing encompasses any backend, service, api, and database level testing

• These tests are compromised of: request, response, and verification

• Since these follow the same template, we have opted for using csv file to write the tests

• 1 line 1 complete test

• This allows us to add lots of tests to each csv file, covering large number of permutations

• This falls in line with the pyramid of testing

Format

• The csv files are based on template with the following columns

• TestSuite: The name of the test series

• TestCaseID: Unique test id for each test

• RunFlag: set 'Y' to run the test. Set 'N' to skip.

• Description: Short description of the test.

• InterfaceType: The type of testing. Options: RESTfulAPI, SQL. Additional testing types can be added.

• UriPath: The uri path appended to the based uri in the config folder. Applicable to rest api tests.

• ContentType: Type of request. Applicable to rest api tests.

• Method: For Rest API: type of call made: POST, GET, PUT, DELETE

• Option: Additional options to be added for the interface type. Currently, API and SQL do not make use of it.

• RequestHeaders: For API: headers values are added here. The format is key:value separated by ";". eg. Authorization:somekey

• TemplateFile: template file to be used for requests.

• RequestBody: For API: the request goes here. For sql: the query goes here. We can use values set in api config file through the syntax: <@variable>. eg. <@username>, where username="admin" defined in apiConfig.property file.

• OutputParams: We can store response values into variables defined here. The variables will then be available for other tests. Syntax: <$variable>. eg. userid=<$adminUserId>. the variable "adminUserId" can then be access by <@adminUserId> in subsequent tests

• RespCodeExp: For API: the expected response code. eg. 200

• ExpectedResponse: Verification of the response goes here. More description in the interface sections.

• TcComment: comment for the tests. eg. disable for such and such reasons.

Service Tests Location

• Service tests are located at: apiTestData -> testCases

• We can specify custom location through apiTestData -> apiConfig.property

• apiConfig.properties

  api.parallelTestcasePath = "../apiTestData/testCases/"

• The location is from the root of the project ( where pom.xml file is located )

Writing Service Tests

• Writing service tests involved setting the proper values at the csv column

Restful Api Tests

• Configuration: RestApi base url and other config info can be found at RestApi config section

• See Restful Api section for writing tests

• Third party applications can be used to test out the Rest Api calls before adding them to the csv file, such as Postman.

  • Same values can be copied over from postman to csv test file

Database Tests

• Configuration: Database connection info can be found at the database config section

• See Database testing section for writing tests

RabbitMQ Tests

• Configuration: RMQ connection info configuration can be found at RabbitMQ configuration section

• See RabbitMQ section for writing tests

Kafka

• Configuration: Kafka connection info configuration can be found at Kafka configuration section

• See Kafka section for writing tests

Service Bus

• Configuration: Service Bus connection info configuration can be found at Service Bus configuration section

• See Service Bus section for writing tests

Running Service Tests

• We can run the service tests from apiTestData -> runner -> <os> -> apiRunner file

• We can also run the service test using the test suite