how to make a utility class and test class using Java

[Arya Ramanujan]

Hello,

I have the following class, our requirement is to divide this class to Utility and test Classes.
Our test code is getting optimized and wanted to make it more Utility and config driven.
Any thoughts, please ?

import static io.restassured.RestAssured.given;
import org.testng.annotations.Test;

import com.codoid.products.exception.FilloException;
import com.codoid.products.fillo.Connection;
import com.codoid.products.fillo.Fillo;
import com.codoid.products.fillo.Recordset;

import io.restassured.response.Response;


public class mapDataDriven {
	
	public Response myResponse;
    public String baseURL = "http://52.100.20.255/api/v1.0";
    public String TestdataPath = "C:\\TestData.xlsx"; 
    
    
    public Recordset getdata(String excelpath,String Query) throws FilloException{
    	Fillo fillo=new Fillo();
        Connection connection =null;
        Recordset recordset =null;
        connection=fillo.getConnection(excelpath);
        recordset =connection.executeQuery(Query);
        return recordset;
    }

	@SuppressWarnings("null")
	public void closeExcelConection()
	{
		Connection connection =null;
        Recordset recordset =null;
		recordset.close();
		connection.close();
		
	}
    
	@Test
	public void honeyPotTest() throws FilloException
	{
		String strQuery="Select * from ips";
		
	        System.out.println("--------- Sending IPs --------------------");
	        
	Recordset  data = getdata(TestdataPath,strQuery);
	while(data.next()){
	String Json = buildJson(data.getField("ips"),data.getField("time"),data.getField("portNumber"));
	myResponse = given().contentType("application/json").body(Json).when().put(baseURL);
	        //Print Response
	        System.out.println("Request :" + Json);
	        System.out.println("Response Body : "+myResponse.getBody().asString());		
	        System.out.println("Response Code : "+myResponse.getStatusCode());
	}
	closeExcelConection();
	}

    String buildJson(String src_ip, String occurred, String description){
        return "{\n" +
                "  \"newsie_group\": \"party\",\n" +
                "  \"newsie_desc\": \"map\",\n" +
                "  \"ip\": 3495398208,\n" +
                "  \"timestamp\": 1487012353,\n" +
                "  \"episode\": [\n" +
                "    {\n" +
                "      \"src_ip\": "+src_ip+",\n" +
                "      \"occurred\": "+occurred+",\n" +
                "      \"description\": \""+description+"\",\n" +
                "      \"order_id\": 9136\n" +
                "    }\n" +
                " ]\n" +
                "} ";
    }

}

[Campbell Ritchie]

I suggest you start from scratch with your testing class. I can see all sorts of problems with the current code. Some style and some logic problems:-

Always start ClassNames with CapitalLetters.

Class Names should be nouns; if you are using adjectives as class names, it suggests to me your class doesn't represent nor constitute an entity in the object‑oriented sense of the word.

Don&apo;t risk returning null in line 25: if you have a null throw an exception instead.

Only use @SuppressWarnings if you are sure the code it applies to is correct. The following method contains at least four significant errors..

Don't make your class do several things. You have methods to open the connection, to print a JSON and claiming to test something.

As you know, a utility class contains only static members, only private constructors to prevent instantiation, and no variables. Usually they contain only methods, one private constructor, and public or private constants. A utility class is intended to be used by other code rather than having an existence as an object in its own right.
For unit testing you test every method available with “normal” and “incorrect” arguments. I would have thought you would be using a framework like JUnit.

[Arya Ramanujan]

Campbell Ritchie wrote:I suggest you start from scratch with your testing class. I can see all sorts of problems with the current code. Some style and some logic problems:-

Always start ClassNames with CapitalLetters.

Class Names should be nouns; if you are using adjectives as class names, it suggests to me your class doesn't represent nor constitute an entity in the object‑oriented sense of the word.

Don&apo;t risk returning null in line 25: if you have a null throw an exception instead.

Only use @SuppressWarnings if you are sure the code it applies to is correct. The following method contains at least four significant errors..

Don't make your class do several things. You have methods to open the connection, to print a JSON and claiming to test something.

As you know, a utility class contains only static members, only private constructors to prevent instantiation, and no variables. Usually they contain only methods, one private constructor, and public or private constants. A utility class is intended to be used by other code rather than having an existence as an object in its own right.
For unit testing you test every method available with “normal” and “incorrect” arguments. I would have thought you would be using a framework like JUnit.

We are using TestNG in our framework. I have formed a utils class the following way :

import com.codoid.products.exception.FilloException;
import com.codoid.products.fillo.Connection;
import com.codoid.products.fillo.Fillo;
import com.codoid.products.fillo.Recordset;

public class Utils {
	
	private static Connection connection =null;
	private static Recordset recordset =null;
	
	public static Recordset getdata(String excelpath,String Query) throws FilloException{
    	Fillo fillo=new Fillo();
        connection=fillo.getConnection(excelpath);
        recordset =connection.executeQuery(Query);
        return recordset;
    }
	
	
	public static void closeExcelConection()
	{
		recordset.close();
		connection.close();
		
	}

}

Test Class and tried the Test Class the following way :

import com.codoid.products.fillo.Fillo;
import com.codoid.products.exception.*;
import com.codoid.products.fillo.Recordset;
import com.root.com.Utils;
import org.testng.annotations.BeforeTest;
import org.testng.annotations.Test;

public class ZmDdTest extends Utils {
	
	@BeforeTest
	Utils utils = new Utils();
	
	

}

Using the utils object, why cannot I access the methods from the base class. Where am I going wrong ?

[Campbell Ritchie]

Why have you got two methods for opening and closing connections? I am not sure about Excel connections,  but if they are like database connections, they must be definitely closed before you close your app. That would usually be done with the try‑with‑resources construct. When you close the connection depends on how difficult it is to open a new connection, but I can envisage that method being used repeatedly and leaving unused connection objects lying around the heap until GC occurs.
You have forgotten the private constructor.

[Knute Snortum]

Have you removed the package statements?  Please include them.  Is Utils in com\root\com?

[Zach Rode]

I know you asked about testing but your formatting is all over the place too.

import com.codoid.products.exception.FilloException;
import com.codoid.products.fillo.Connection;
import com.codoid.products.fillo.Fillo;
import com.codoid.products.fillo.Recordset;
 
public class Utils {
     
    private static Connection connection =null;
    private static Recordset recordset =null;
     
    public static Recordset getdata(String excelpath,String Query) throws FilloException{
     Fillo fillo=new Fillo();
        connection=fillo.getConnection(excelpath);
        recordset =connection.executeQuery(Query);
        return recordset;
    }
     
     
    public static void closeExcelConection()
    {
        recordset.close();
        connection.close();
         
    }
 
}

That block has all kinds of weird stuff going on. I know it might seem insignificant but when you are having others review your code, it matters for readability purposes and impressions (it's the same as mixing up they're, their, and there when you're inconsistent like that). CTRL+SHIFT+F is your friend if you're using Eclipse.

Just for instance you have 3 different whitespace formats going on with your class/method names

public class Utils {

public static Recordset getdata(String excelpath,String Query) throws FilloException{

    public static void closeExcelConection()
    {

As far as tests code, You've already made this class, so unless you start from scratch you can't exactly implement TDD. Download a code coverage tool (never used that framework so I'm not sure if it comes with one), write logical tests for edge cases and normal cases for each method, run coverage tool, right tests to test what you haven't covered; logical ones, coverage for coverage's sake is bad. Rinse and repeat.

-Zach

[Arya Ramanujan]

Knute Snortum wrote:Have you removed the package statements?  Please include them.  Is Utils in com\root\com?

I did not remove them but just while pasting, I deleted them, thought it may not be necessary.

[Arya Ramanujan]

Zach Rode wrote:I know you asked about testing but your formatting is all over the place too.

import com.codoid.products.exception.FilloException;
import com.codoid.products.fillo.Connection;
import com.codoid.products.fillo.Fillo;
import com.codoid.products.fillo.Recordset;
 
public class Utils {
     
    private static Connection connection =null;
    private static Recordset recordset =null;
     
    public static Recordset getdata(String excelpath,String Query) throws FilloException{
     Fillo fillo=new Fillo();
        connection=fillo.getConnection(excelpath);
        recordset =connection.executeQuery(Query);
        return recordset;
    }
     
     
    public static void closeExcelConection()
    {
        recordset.close();
        connection.close();
         
    }
 
}

That block has all kinds of weird stuff going on. I know it might seem insignificant but when you are having others review your code, it matters for readability purposes and impressions (it's the same as mixing up they're, their, and there when you're inconsistent like that). CTRL+SHIFT+F is your friend if you're using Eclipse.

Just for instance you have 3 different whitespace formats going on with your class/method names

public class Utils {

public static Recordset getdata(String excelpath,String Query) throws FilloException{

    public static void closeExcelConection()
    {

As far as tests code, You've already made this class, so unless you start from scratch you can't exactly implement TDD. Download a code coverage tool (never used that framework so I'm not sure if it comes with one), write logical tests for edge cases and normal cases for each method, run coverage tool, right tests to test what you haven't covered; logical ones, coverage for coverage's sake is bad. Rinse and repeat.

-Zach

Thank you - Crtl + Shift + F was very useful.

"As far as tests code, You've already made this class, so unless you start from scratch you can't exactly implement TDD."
I do not know how to start over, so I started with the Utils class, which is what was suggested. I will try using the coverage tool, any suggestions which tool works best for Eclipse.

[Arya Ramanujan]

Knute Snortum wrote:Have you removed the package statements?  Please include them.  Is Utils in com\root\com?

It is still "com.root.com".

[Knute Snortum]

Arya Ramanujan wrote:

Knute Snortum wrote:Have you removed the package statements?  Please include them.  Is Utils in com\root\com?

I did not remove them but just while pasting, I deleted them, thought it may not be necessary.

That's what I mean: in the future, please do include them when copying and pasting.  It helps us diagnose the problem.