Overview
In this tutorial, we will create an Java Test class with multiple Test Cases, implemented in Java.
Description
The test case validates a Calculator class and exploits some TestNG features such as the ability of validating the same Test against multiple input values, and also the possibility of linking Tests with requirements in Jira using NUnit's Test attributes.
package com.xpand.java;
public class Calculator
{
// Square function
public static int Square(int num)
{
return num*num;
}
// Add two integers and returns the sum
public static int Add(int num1, int num2 )
{
return num1 + num2;
}
// Add two integers and returns the sum
public static double Add(double num1, double num2 )
{
return num1 + num2;
}
// Multiply two integers and retuns the result
public static int Multiply(int num1, int num2 )
{
return num1 * num2;
}
public static int Divide(int num1, int num2 )
{
return num1 / num2;
}
// Subtracts small number from big number
public static int Subtract(int num1, int num2 )
{
if ( num1 > num2 )
{
return num1 - num2;
}
return num2 - num1;
}
}
Example 1: Using TestNG standard capabilities
This examples uses the standard built-in TestNG capabilities, without making use of TestNG's advanced features such as annotations (which in turn would require specific code to handle them).
The test class provides some methods marked with the @Test annotation and in some of them additional meta-information is added to the results using the ITestResult object.
Xray is able to process TestNG's ITestResult custom attributes named "test", "requirement" and "labels". Whenever specified, they will allow Xray to identify an existing Xray Test issue to report results to, the requirement to link to and additional labels to add to the Test issue, respectively.
package com.xpand.java;
import org.testng.Assert;
import org.testng.annotations.Test;
import org.testng.annotations.BeforeSuite;
import org.testng.annotations.AfterSuite;
import org.testng.annotations.DataProvider;
import org.testng.Reporter;
import org.testng.reporters.XMLReporter;
import org.testng.ITestResult;
import com.xpand.annotations.Xray;
public class CalcTest {
@BeforeSuite
public void setUp() throws Exception {
}
@AfterSuite
public void tearDown() throws Exception {
}
@DataProvider
public Object[][] ValidDataProvider() {
return new Object[][]{
{ 1, 2, 3 },
{ 2, 3, 4 }, // error or the data itself :)
{ -1, 1, 0 }
};
}
@Test(dataProvider = "ValidDataProvider")
public void CanAddNumbersFromGivenData(final int a, final int b, final int c)
{
Assert.assertEquals(Calculator.Add(a, b), c);
ITestResult result = Reporter.getCurrentTestResult();
result.setAttribute("requirement", "CALC-1234");
result.setAttribute("test", "CALC-2");
}
@Test
public void CanAddNumbers()
{
Assert.assertEquals(Calculator.Add(1, 1),2);
Assert.assertEquals(Calculator.Add(-1, 1),0);
ITestResult result = Reporter.getCurrentTestResult();
result.setAttribute("requirement", "CALC-1234");
result.setAttribute("test", "CALC-2");
result.setAttribute("labels", "core addition");
}
@Test
public void CanSubtract()
{
Assert.assertEquals(Calculator.Subtract(1, 1), 0);
Assert.assertEquals(Calculator.Subtract(-1, -1), 0);
Assert.assertEquals(Calculator.Subtract(100, 5), 95);
ITestResult result = Reporter.getCurrentTestResult();
result.setAttribute("requirement", "CALC-1235");
result.setAttribute("labels", "core");
}
@Test
public void CanMultiplyX()
{
Assert.assertEquals(Calculator.Multiply(1, 1), 1);
Assert.assertEquals(Calculator.Multiply(-1, -1), 1);
Assert.assertEquals(Calculator.Multiply(100, 5), 500);
ITestResult result = Reporter.getCurrentTestResult();
result.setAttribute("requirement", "CALC-1236");
}
@Test
public void CanDivide()
{
Assert.assertEquals(Calculator.Divide(1, 1), 1);
Assert.assertEquals(Calculator.Divide(-1, -1), 1);
Assert.assertEquals(Calculator.Divide(100, 5), 20);
ITestResult result = Reporter.getCurrentTestResult();
result.setAttribute("requirement", "CALC-1237");
}
@Test
public void CanDoStuff()
{
Assert.assertNotEquals(true, true);
ITestResult result = Reporter.getCurrentTestResult();
result.setAttribute("test", "CALC-6")
}
}
Example 2: Using TestNG annotation capabilities
This examples uses some of the advanced TestNG capabilities, namely the annotation mechanism.
We'll use a specific "Xray" annotation in order to quickly, and in a more elegant way, provide additional meta-information (i.e. "test", "requirement" and "labels") to the Test result, without having to use the ITestResult object in the Test method's code. Whenever specified, they will allow Xray to identify an existing Xray Test issue to report results to, the requirement to link to and additional labels to add to the Test issue, respectively.
package com.xpand.java;
import org.testng.Assert;
import org.testng.annotations.Test;
import org.testng.annotations.BeforeSuite;
import org.testng.annotations.AfterSuite;
import org.testng.annotations.DataProvider;
import org.testng.Reporter;
import org.testng.reporters.XMLReporter;
import org.testng.ITestResult;
import com.xpand.annotations.Xray;
public class CalcTest {
@BeforeSuite
public void setUp() throws Exception {
}
@AfterSuite
public void tearDown() throws Exception {
}
@DataProvider
public Object[][] ValidDataProvider() {
return new Object[][]{
{ 1, 2, 3 },
{ 2, 3, 4 }, // error or the data itself :)
{ -1, 1, 0 }
};
}
@Test(dataProvider = "ValidDataProvider")
@Xray(requirement = "CALC-1234", test = "CALC-1")
public void CanAddNumbersFromGivenData(final int a, final int b, final int c)
{
Assert.assertEquals(Calculator.Add(a, b), c);
}
@Test
@Xray(requirement = "CALC-1234", test = "CALC-2", labels = "core addition")
public void CanAddNumbers()
{
Assert.assertEquals(Calculator.Add(1, 1),2);
Assert.assertEquals(Calculator.Add(-1, 1),0);
}
@Test
@Xray(requirement = "CALC-1235", labels = "core")
public void CanSubtract()
{
Assert.assertEquals(Calculator.Subtract(1, 1), 0);
Assert.assertEquals(Calculator.Subtract(-1, -1), 0);
Assert.assertEquals(Calculator.Subtract(100, 5), 95);
}
@Test
@Xray(requirement = "CALC-1236")
public void CanMultiplyX()
{
Assert.assertEquals(Calculator.Multiply(1, 1), 1);
Assert.assertEquals(Calculator.Multiply(-1, -1), 1);
Assert.assertEquals(Calculator.Multiply(100, 5), 500);
}
@Test
@Xray(requirement = "CALC-1237")
public void CanDivide()
{
Assert.assertEquals(Calculator.Divide(1, 1), 1);
Assert.assertEquals(Calculator.Divide(-1, -1), 1);
Assert.assertEquals(Calculator.Divide(100, 5), 20);
}
@Test
@Xray(test = "CALC-6")
public void CanDoStuff()
{
Assert.assertNotEquals(true, true);
}
}
{
"version": "1.0.0-*",
"buildOptions": {
"debugType": "portable",
"emitEntryPoint": true
},
"dependencies": {
"NUnit": "3.5.0",
"dotnet-test-nunit": "3.4.0-beta-2"
},
"testRunner": "nunit",
"frameworks": {
"netcoreapp1.1": {
"dependencies": {
"Microsoft.NETCore.App": {
"type": "platform",
"version": "1.1.0"
}
},
"imports": "dnxcore50"
}
}
}
After successfully running the Test Case and generating the NUnit XML report (e.g., TestResult.xml), it can be imported to Xray (either by the REST API or through the Import Execution Results action within the Test Execution).
NUnit's Test Case is mapped to a Generic Test in Jira, and the Generic Test Definition field contains the namespace, the name of the class, and the method name that implements the Test case.
The Execution Details of the Generic Test contains information about the context, which in this case corresponds to the Test case method, along with the different input values that were validated.
It can also be seen that the Test "CanAddNumbers" was automatically linked to the sum requirement (i.e., the user story "CALC-1").