{"componentChunkName":"component---src-templates-tag-js","path":"/tags/cucumber/","result":{"data":{"site":{"siteMetadata":{"title":"LoginRadius Blog"}},"allMarkdownRemark":{"totalCount":1,"edges":[{"node":{"fields":{"slug":"/engineering/rest-api-cucumber-blog/"},"html":"

What is Rest?

\n

Representational State Transfer in short-form as REST defines a set of constraints for creating Web Services.\nRest API is the most-used web service technology nowadays, and it's an almost meaningless description. A REST API is a way to communicate for two computer systems over HTTP, which is similar to web browsers and servers.

\n

What is BDD?

\n

BDD stands for Behavior Driven Development (BDD). Nowadays, many Organizations, to get a better advantage of testing, are taking a step forward.

\n\n

What is Cucumber?

\n

A cucumber is an approach that supports BDD. It allows you to write tests that anyone can understand, irrespective of their technical knowledge. In BDD, users (business analysts, product owners, developers, etc..). We need to first write scenarios or acceptance tests that describe the system's behavior from the customer's point of view for review and sign-off by the product owners before developers start actual development.

\n

What are the Prerequisites to Test Rest API using Cucumber?

\n\n

Steps to Install Java

\n
http://www.oracle.com/technetwork/java/javase/downloads/index.html
\n

Download JDK from the above link and install it\nSet the Environment Variable on System Properties

\n
Right Click on My PC -> Properties -> Advanced System Settings -> Environment Variables -> Create New -> provide path of JDK
\n

Steps to Install Eclipse

\n\n

Steps to Install Maven

\n\n

Configuring Cucumber with Maven

\n\n

Now we need three Important files.

\n\n

Feature File: It's a entry point to the cucumber. We use Gherkins to write the feature file. This is the file where you will describe your descriptive language(Gherkin uses simple English). A feature file can contains a Scenario or List of Scenario. A sample Feature file is below

\n
Feature: Login Functionality\n@validLogin\nScenario: User Should Login With Valid Credentials \n   Given Post Login API\n   When Provide Valid Credential\n   Then Status_code equals 200    \n   And  response contains IsLogin equals "true"\n@invalidLogin    \nScenario Outline: Email and Password Validation in Login API \n   Given Post Login API\n   When Provide different combinations to "<email>""<password>"\n   Then Status_code equals <statuscode>    \n   And  response contains message equals "<message>"\n   Examples:\n   |email     \t\t|password    | statuscode |  message\n   |          \t\t|            |   401      | Required email and password\n   | abc\t  \t|            |   401      | Email format is incorrect\n   | abc@mail7.io  \t|\t     |   401      | Required password\n   | abc@mail7.io   \t| password   |   401      | Email and Password combination Incorrect
\n

Save the above code as login.feature

\n\n

StepDefinition:\nNow you have your feature file ready with test scenarios defined. However, our job is not done yet. Cucumber doesn't know when should execute which part of code. So StepDefinition acts as an intermediate to your runner and feature file. It stores the mapping between each step of the scenario in the Feature file. So when you run the scenario, it will scan the stepDefination file to check matched glue.

\n

How to write step definition:\nWe have a chrome extension(Tidy Gherkin) to convert your feature into a step definition.
\nCopy your scenario from the feature file and paste it in Tidy Gherkin and click on Java Steps; copy the Java Steps.\nCreate a new file name a StepDefinition.java and paste the Java Steps

\n
package com.loginradius.login\nimport cucumber.api.java.en.Given;\nimport cucumber.api.java.en.When;\nimport cucumber.api.java.en.Then;\nimport cucumber.api.java.en.And;\nimport cucumber.api.junit.Cucumber;\nimport org.junit.runner.RunWith;\nimport static io.restassured.RestAssured.given;\nimport static org.testng.Assert.assertTrue;\nimport io.restassured.http.ContentType;\nimport io.restassured.response.Response;\nimport io.restassured.specification.RequestSpecification;\nimport io.restassured.RestAssured;\n\npublic class StepDefinition {\n\tprivate  static  final  String  BASE_URL  =  "https://www.loginradius.com";\n\tString email = "abcxyz@mail7.io;\n\tString password = "password";\n\tRequestSpecification request;\n\tprivate  static  Response response;\n\tprivate  static  String  jsonString;\n\n    @Given("Post Login API")\n    public void post_login_api() {\n\t    RestAssured.baseURI  =  BASE_URL;\n\t\trequest  =  RestAssured.given();\n\t\trequest.header("Content-Type",  "application/json");    \n    }\n    \n   @When("Provide Valid Credential")\n    public void provide_valid_credential() {\n      response  =  request.body("{ \\"userName\\":\\""  +  email  +  "\\", \\"password\\":\\""  +  password  +  "\\"}")\n\t\t\t\t\t\t  .post("/user/login");\t\n    }\n\n   @Then("Status_code equals {int}")\n    public void statuscode_equals_(int agr) {\n\t    Assert.assertEquals(arg, response.getStatusCode());\n    }\n\t\n\t@And("response contains IsPosted equals {string}")\n    public void response_contains_IsPosted_equals_(String message) {\n\t    Assert.assertEquals(message, getJsonPath(response, "IsPosted"));\n    }\t\n\n   @And("response contains message equals {string}")\n    public void response_contains_equals_(String message) {\n\t    Assert.assertEquals(message, getJsonPath(response, "message"));\n    }\n    \n\t@When("Provide different combinations to {string}, {string}")\n    public void provide_different_combinations_to_somethingsomething(String email, String password){\n\t    response = request.body("{ \\"userName\\":\\"" + email + "\\", \\"password\\":\\"" + password + "\\"}") .post("/user/login");\n    }\n\n\tpublic String getJsonPath(Response response, String key) {\n\t\tString resp = response.asString();\n\t\tJsonPath js = new JsonPath(resp);\n\t\treturn js.get(key).toString();\n\t}\n\t\n}
\n

Now we have Our Feature file and StepDefinition Ready, we need a runner file to run our Test Scenario's

\n

Runner File:\nA runner will help us to run the feature file and acts as an interlink between the feature file and StepDefinition Class\nBelow is the code which will help you to run the tests

\n
package runner;\nimport io.cucumber.testng.CucumberOptions;\n\n@CucumberOptions(\n\t\tfeatures= {"feature_files/login.feature"},\n        glue= {"step_definations/StepDefinitation.java"},\n        tags= "@validLogin",    // based on tags scenarios will run\n        monochrome=true, dryRun=false,\n\t\t)\t\npublic  class  TestRunner  {\n\n}
\n

Now We have Feature, StepDefinition, and runner files ready, We can run the runner file to see the results.

\n

Conclusion

\n

Cucumber is very useful in understanding the overall testing process without having coding knowledge. Since it uses simple English to write the feature file and makes developer, QA and other stakeholders on same page before starting the actual development.

\n","frontmatter":{"date":"November 05, 2020","updated_date":null,"title":"Automating Rest API's using Cucumber and Java","tags":["Automation","Cucumber","Rest API","Java"],"coverImage":{"childImageSharp":{"fluid":{"aspectRatio":1.5037593984962405,"src":"/static/1775ed5790237a2d1ac5fbda108bc357/58556/cucumber_rest_assured.webp","srcSet":"/static/1775ed5790237a2d1ac5fbda108bc357/61e93/cucumber_rest_assured.webp 200w,\n/static/1775ed5790237a2d1ac5fbda108bc357/1f5c5/cucumber_rest_assured.webp 400w,\n/static/1775ed5790237a2d1ac5fbda108bc357/58556/cucumber_rest_assured.webp 800w,\n/static/1775ed5790237a2d1ac5fbda108bc357/99238/cucumber_rest_assured.webp 1200w","sizes":"(max-width: 800px) 100vw, 800px"}}},"author":{"id":"Surendranath Reddy Birudala","github":"reddysuren","avatar":null}}}}]}},"pageContext":{"tag":"Cucumber"}},"staticQueryHashes":["1171199041","1384082988","2100481360","23180105","528864852"]}