(Deprecated) Katalon Studio Samples: Jira API Tests

Katalon Studio is a free and easy-to-use automated functional and regression testing platform. It provides users the ability to implement full automated testing solutions for their application projects with minimal engineering and programming skill requirements.

---

The jira-api-tests perform API automation test on Jira Web Application using Katalon Studio. The examples in this project range from common to advanced test cases.

Companion products

Katalon TestOps

Katalon TestOps is a web-based application that provides dynamic perspectives and an insightful look at your automation testing data. You can leverage your automation testing data by transforming and visualizing your data; analyzing test results; seamlessly integrating with such tools as Katalon Studio and Jira; maximizing the testing capacity with remote execution.

• Read our documentation.
• Ask a question on Forum.
• Request a new feature on GitHub.
• Vote for Popular Feature Requests.
• File a bug in GitHub Issues.

Katalon Studio

Katalon Studio is a free and complete automation testing solution for Web, Mobile, and API testing with modern methodologies (Data-Driven Testing, TDD/BDD, Page Object Model, etc.) as well as advanced integration (JIRA, qTest, Slack, CI, Katalon TestOps, etc.). Learn more about Katalon Studio features.

Getting Started

These instructions will get you a copy of the project up and running on your local machine.

Prerequisites

• Katalon Studio - Installation and Setup
• Permission access to Jira System (provided in the sample code)
• Application Under Test (AUT):
  • Jira cloud: https://katalon.atlassian.net/
  • Account: [email protected]/BAGRyAfuRevu0xrXdrZL6ECD

Setting Up

• Check out the code from this .git
• Open the project from Katalon Studio

Executing a Test Case

1. Expand the Test Cases structure, where all the test cases are stored.
2. Select the test case you want to execute
3. Choose the browser for executing the test case

At the end of this README, you will find additional methods to execute automation test cases.

Test Scenarios

Story: Get issue's information feature

   User story
        As a Jira user, I would like to be able to get issue's information via web service, so that I could get the data without logging in Jira web application.
     
     Feature: Get issue's information 
         Scenario: Get issue's information successfully
          Given The web service is available
          When I send a request to get issue's formation
          Then I could get the issue's information from the response

Story: Create issue with defined information

   User story
        As a Jira user, I would like to be able to create a new issue with defined information via web service, so that I could manage my issues without logging in Jira web application
     
      Feature: Create issue
          Scenario: Create issue with defined information successfully
	    Given The web serice is available
	    When I send a request to create issue with defined information
	    Then The issue is created successfully in the system

Test Cases

- Simple Test Cases
- Advance Test Cases
- Data-driven Test Cases
- Tips and Tricks Test Cases
- BDD Cucumber Test Cases

Simple Test Cases

Test cases at this section will help the users to understand:

• How to create simple API testing with hard coding test data
• How to create a RESTful Web service object at Object Repository with different method:
  • GET
  • POST
  • PUT
  • DELETE
• How to use simple built-in keywords to
  • Send request
  • Verify response code
  • Verify response information

Advanced Test Cases

Additionally, the users can try more advanced test cases and modify as they need. The advanced test cases contained in this project are:

• How to create RESTful Web services object at Object Repository with parameters
• How to pass value from a Web service response to another Web service request
• How to create RESTful API tests with dynamic test data

Data-driven Test cases

Data-driven approach is important to API testing, since it helps users testing a Web service endpoint with different dataset without cloning the test case. Test cases in this section demonstrate:

• How to create test cases with input parameters
• How to use data-file in test suites
• How to execute test cases with data-file as a data-driven approach

Tips & Tricks

Tips & Tricks part contains samples solving common questions from users:

• Parameterize:
  • Parameterize request body
  • Parameterize authentication
  • Parameterize request query
  • Parameterize request path
• RequestObject
• ResponseObject
• Verification
• Authentication

BDD Cucumber Test Cases

From version 5.7, Katalon Studio has supported native BDD Cucumber testing approach. The example in this section show:

• How to create test features
• How to create test scenario, test scenario out-line
• How to implement step definition
• How to execute BDD Cucumber features.

---

Execute a Test Suite with Data-Driven

This example demonstrates how to apply data-driven approach to test execution with Katalon Studio.

1. Select the test suite
2. Select the test case you want to apply data-driven approach
3. Select data file
4. Bind test data and test case's parameters

Execute a Test Suite

This example demonstrates how to execute a test suite collection.

1. Select the Test suite
2. Add test cases into the test suite
3. Execute the test suite

Execute BDD Cucumber test feature

This example demonstrates how to execute a test suite collection.

1. Select the Test feature
2. Execute the Test feature

See Also

Update configurations for integration: Jira, Katalon Analytics

Katalon Documentation: http://docs.katalon.com/, especially some Tips and Tricks to run a successful automation test.

Katalon Forum: https://forum.katalon.com/

Katalon Business Support: https://www.katalon.com/support-service-options/