Junit good practices: Do I test for runtime error condition? - java

Let's say I have a code that does some DB work and has a happy path and the only unhappy flow, that only occurs when DB connection is down, like this:
public Report createReport(
String reportType, Report reportData, ReportUser reportUser, Timestamp createTs) {
KeyHolder reportIdHolder = new GeneratedKeyHolder();
try {
saveReportDetails(reportType, reportData, reportUser, createTs);
} catch (DataAccessException e) { <-------------- This extends RuntimeException
log.error(
"DataAccessException while trying to insert report with name {}",
reportData.getReportName(),
e);
throw e;
}
...
// More of the happy path code here
}
I've got a test for the happy path, but is it a good practice to test for the Runtime exception flow as well?
The app is a SpringBoot Rest app, so it doesn't die when the exception is rethrown after logging.

Related

How to test exception scenario in junit 5 in spring boot?

I have a void method that does some tasks trying to test exception scenarios but the test case is getting failed.
public void completetask(){
try{
RemoteUser rm = usrRepo.findById(12);
assistenRepo.save(rm);
}catch(Exception e){
log.error("Exception occurred while making changes {}", e,getMessage());
}
}
How can we test the exception scenario here on JUnit 5?
I have tried this but it's not working
#Test
public void completetaskTest(){
RemoteUser rm = getDummyRemoteUsr();
Mockito.when(usrRepo.findById(12)).thenReturn(rm);
Mockito.when(assistenRepo.save(rm)).thenThrow(new Exception("Error Abnormal"));
Exception exception = Assestions.assertThrow(Exception.class, () -> usrService.completetask());
String expectedMessage = "Exception occurred while making changes";
String actualMessage = exception.getMessage();
Assertions.assetTrue(actualMessage.contains(expectedMessage));
}
I am getting an error for this test case - the check exception is invalid for this method
Invalid java.lang.Exception : Error
Can I know what wrong I am doing here ?
You are not throwing your error, you are just writing a log with one log line.
catch(Exception e){
log.error("Exception occurred while making changes {}", e,getMessage());
}
Here is the javadoc on Assertions.assertThrows:
Assert that execution of the supplied executable throws an exception of the expectedType and return the exception.
If no exception is thrown, or if an exception of a different type is thrown, this method will fail.
If you do not want to perform additional checks on the exception instance, ignore the return value.
That's why your assertThrows method will fail under all circumstances.
So either throw an error in your method you want to test, or check the log print in exceptions for testing.
You are expecting your method to thrown an exception but in your code, you're handling and logging the exception and no exception is thrown:
public void completetask(){
try {
RemoteUser rm = usrRepo.findById(12);
assistenRepo.save(rm); // <-- Exception is thrown...
} catch(Exception e){ // <-- Catched here
log.error("Exception occurred while making changes {}", e,getMessage());
}
// <-- Method finishes normally.
}
You should be seeing the following in the output:
Exception occurred while making changes Error Abnormal
But your test will be failing here:
Exception exception = Assestions.assertThrow(Exception.class, () -> usrService.completetask());
Because the exception was never thrown. If you comment out the exception handling try / catch it will pass that point but now it will fail comparing the error messages.
EDIT:
I know this scenario but the problem here is how to solve this issue? How can we write test scenario for this condition –
If you want to verify your exception was handled just remove verification:
#Test
public void completetaskTest(){
RemoteUser rm = getDummyRemoteUsr();
when(usrRepo.findById(12)).thenReturn(rm);
when(assistenRepo.save(rm)).thenThrow(new Exception("Error Abnormal"));
assertTrue(true); // if we reached this line, in means the error has handled.
}
If you really want to go further and check if the message matches (which it might be overkill) you can check the logger, but again, I would't recommend it.
Something like this:
#Auto
Logger log;
...
#Test
public void completetaskTest(){
RemoteUser rm = getDummyRemoteUsr();
when(usrRepo.findById(12)).thenReturn(rm);
when(assistenRepo.save(rm)).thenThrow(new Exception("Error Abnormal"));
// Verify the `log.error` was invoked with exactly those parameters
verify(log, times(1)).error("Exception occurred while making changes {}", "Error Abnormal");
}
That means the exception was thrown, cached and the logger was invoked.

Catch statements are not executed when TestNG listeners are on

I have a ITestListener to note test results. In my locator class if I try to handle something in catch statement, none of the code inside the catch is executed. For ex : I am trying to handle a WebElement that may or may not throw exception. When it throws exceptions, I should handle in the catch statement and locate different element. Since catch statement is not being executed and when the exception occurs, the applications just halts. Is there a way I could run the catch statement even when onTestFailure method is ON from TestNG ? Please suggest a solution.
//Test Script
public boolean loginVerification(String username, String password) {
try {
utilities.click(helloSignInLink, "elementToBeClickable");
reportLog("debug","info","Clicked on SignIn link");
utilities.sendText(loginID, username);
reportLog("debug","info","Username entered");
utilities.sendText(passwordID, password);
reportLog("debug","info","Password entered");
utilities.click(submit, "elementToBeClickable");
reportLog("debug","info","Clicked on submit button");
Thread.sleep(2000);
isTrue = driver.getTitle().contains("Vectors");
}
catch(Exception e) {
reportLog("debug","info","Unable to login with username : "+username+" , error message : "+e);
isTrue = false;
}
return isTrue;
}
I would recommend to catch Throwable - not just an Exception. Another thing is that when you catch something the excepttion does not really go up the stack so TestNG would never know if anything went wrong in your test and test listener would not detect failure. There is the way to push the exception further on after you have cought it. Like:
catch(Throwable e) {
reportLog("debug","info","Unable to login with username : "+username+" , error message : "+e);
isTrue = false;
throw e;
}
Can you correct your approach and let us know if the issue still exists?
P.S. - I also cannot see any assertions in your code. Assert results or Exception define the test result.
That means you are not catching the same error catch block.
Either use the same exception like TimeoutException so this block will only if TimeoutException occur. If you not sure about the error use generic exception block like Exception it will for sure going to execute if any error occur. In this case Exception will not execute for TimeoutException only because you have already specify same
try {
System.out.println("Your code");
}catch(TimeoutException t) {
System.out.println(t.getMessage());
}catch(Exception ex) {
ex.getStackTrace();
}

SAP JCO Environment method isDestinationDataProviderRegistered() fails but does not throw an exception

I have the following simple piece of code to register a DataProvider.
The line "Environment.isDestinationDataProviderRegistered()" fails. The try-catch doesn't catch it. The failure just kills the appication.
Is there a way to find out what is actually happening? There is not exception. The application just fails.
I even wrote some loggers to test the static class. All of the methods that started with Environment.in* print out the appropriate true/false response. But, when I logger out all the Environment.is* methods (also booleans), then each one kills the application.
It surprises me that a simple boolean is*() method would fail.
My code:
try {
destinationName = dbProps.getProperty(JCO_DESTINATION_NAME);
createDestination(destinationName);
if (! Environment.isDestinationDataProviderRegistered()) {
Environment.registerDestinationDataProvider(new SAPJCOUtils());
}
} catch (RuntimeException re) {
re.printStackTrace();
} catch (Exception e) {
e.printStackTrace();
}

Difference between Exception and SQLException

Can someone explain the difference between catching an Exception and catching an SQLException? I know that SQLException will print out more information if you choose to print out the exception errors, but is there anything else?
try {
//code
} catch(Exception ex) {
//code
}
And
try {
//code
} catch(SQLException ex) {
//code
}
What are the benefits and differences of using Exception and SQLException in the catch block?
This is not the only difference.
Catching Exception is dangerous because it also catches all RuntimeExceptions (therefore unchecked exceptions), and that include niceties such as NullPointerException etc which are clear programmer errors. Don't do that!
Also, Exception is a class like any other, so you can subclass it and add constructors/methods of yours. For instance, SQLException has a .getErrorCode() method which Exception does not have. If you only catch Exception, you cannot access this method.
In general, catching the "more precise" exception first is the best. For instance, with the new (in Java 7...) file API, you can easily distinguish between filesystem level errors and other I/O errors, since FileSystemException extends IOException:
try {
something();
} catch (FileSystemException e) {
// fs level error
} catch (IOException e) {
// I/O error
}
It's all about the hierarchy,when you are talking about the catching the exception.
Technically speaking, Exception - is the super class which catches each and every exception.
If you are writing something related to SQL in the try block and you know it may even throw SQL Exception.
Then you may declare it this way as well.
try
{
}catch(SQLException ex)
{
Do this,when SQL Exception is caught.
}
catch(Exception ex)
{
Generic Exception - works for all
}
SQLException inherits from Exception, so SQLException will contain more (and more specific) information than Exception (which is intended to apply generally to all exceptions).
You can also have multiple catch clauses; so you can first try to catch the SQLException, but if it's not a SQLException, then you can just catch the general Exception.
In general, you shouldn't catch exceptions unless you intend to handle them in some way. You can have a top-level exception handler that catches any exceptions that bubble up to the top of the call stack, so that your program doesn't crash on unhandled exceptions.
A - Explanation
SQLException is a subtype of java.lang.Exception and also it is implementing the Iterable<Throwable> class. Programmers prefer throwing different subtypes of Exception class because on some higher level, they want to catch the exact sub-Exception class so that they can be sure that that specific Exception is thrown on some exact scenario. Thus, they can know the exact source of Exception.
B - Example
Consider you have written a method that throws multiple exceptions. Let's say, you take a json String and parse it, then persist it on the database. Consider the following method;
public boolean persistCustomer(String jsonString) throws SQLException, IOException {
Connection conn = getConnection();
PreparedStatement preparedStatement = null;
ObjectMapper objectMapper = new ObjectMapper();
try {
Customer customer = objectMapper.readValue(jsonString, Customer.class);
preparedStatement = conn.prepareStatement(PERSIST_CUSTOMER);
preparedStatement.setString (1, customer.getName());
preparedStatement.setInt (2, customer.getAge());
preparedStatement.setBoolean (3, customer.getIsRegular());
preparedStatement.executeUpdate();
return true;
} catch (IOException e) {
throw e;
} finally {
try {
if (preparedStatement != null)
preparedStatement.close();
if (conn != null)
conn.close();
} catch (SQLException e) {
e.printStackTrace();
}
}
}
In this method, we are converting JSON into a Customer class and also we persist customer class to the database.
The following lines throw SQLException;
preparedStatement = conn.prepareStatement(PERSIST_CUSTOMER);
preparedStatement.setString (1, customer.getName());
preparedStatement.setInt (2, customer.getAge());
preparedStatement.setBoolean (3, customer.getIsRegular());
preparedStatement.executeUpdate();
prepareStatement(), setters and executeUpdate() methods, all of them throwing SQLException's. But also, the line that which we convert JSON in a String into a Customer object, also throws several Exceptions other than SQLException.
Customer customer = objectMapper.readValue(jsonString, Customer.class);
readValue() method throws JsonParseException, JsonMappingException and also IOException. All of them can be catched using an IOException because the JSON related exceptions extend IOException.
I'm going to provide two different examples so that it will be obvious to understand why we need different types of Exceptions.
C - Bad Practice: Using Exception To Catch All Exceptions
public class BadPracticeExample {
public static void main(String[] args) {
MySQLUtil dbUtil = new MySQLUtil();
String jsonString = "{\"name\":\"Levent\",\"age\":31,\"isRegular\":true}";
try {
dbUtil.persistCustomer(jsonString);
} catch (Exception e) {
System.out.println("A problem occured");
}
}
}
As you can see, it catches the Exception but what are we going to do if we need special exception handling for two different sources of problems? persistCustomer can throw either IOException or an SQLException and what if we need to do different set of tasks to handle those problems? I want to send an email to the database admin when an SQLException occurs and I want to continue when a JSON parsing problem occurs, on the case that an IOException is catched?
In this scenario you can't do that. Here is the output of the code snippet above and we are only sure that an Exception occured but we don't have any idea about what is the source of it;
A problem occured
D - Good Practice Example I: SQL Exception catched
public class GoodPracticeExample {
public static void main(String[] args) {
MySQLUtil dbUtil = new MySQLUtil();
String jsonString = "{\"name\":\"Levent\",\"age\":31,\"isRegular\":true}";
try {
dbUtil.persistCustomer(jsonString);
} catch (SQLException e) {
System.out.println("SQL Exception catched, SQL State : " + e.getSQLState());
System.out.println("Error Code : " + e.getErrorCode());
System.out.println("Error Message : " + e.getMessage());
} catch (IOException e) {
System.out.println("Cannot parse JSON : " + jsonString);
System.out.println("Error Message : " + e.getMessage());
}
}
}
As you can see, we catch for both, JSON and SQL problem and in this example, submethod is trying to persist DB where there is no table. The output is as below;
SQL Exception catched, SQL State : 42000
Error Code : 1142
Error Message : INSERT command denied to user 'levent'#'example.com' for table 'CUSTOMER'
So we have catched SQL Exception and we have all parameters we need to send an alarm email. We can add additional handler or utility methods on the SQLException catch block.
D - Good Practice Example II: IOExceptoin catched on Parsing Error
public class GoodPracticeExample {
public static void main(String[] args) {
MySQLUtil dbUtil = new MySQLUtil();
String jsonString = "{\"Zname\":\"Levent\",\"age\":31,\"isRegular\":true}";
try {
dbUtil.persistCustomer(jsonString);
} catch (SQLException e) {
System.out.println("SQL Exception catched, SQL State : " + e.getSQLState());
System.out.println("Error Code : " + e.getErrorCode());
System.out.println("Error Message : " + e.getMessage());
} catch (IOException e) {
System.out.println("Cannot parse JSON : " + jsonString);
System.out.println("Error Message : " + e.getMessage());
}
}
}
If you've noticed, I"ve corrupted the JSON to cause an IOException. Now in the json string, instead of "name", "Zname" is written which will cause Jackson Parser to fail. Let's checkout the output of this code.
Cannot parse JSON : {"Zname":"Levent","age":31,"isRegular":true}
Error Message : Unrecognized field "Zname" (class com.divilioglu.db.utils$Customer), not marked as ignorable (3 known properties: "isRegular", "name", "age"])
at [Source: (String)"{"Zname":"Levent","age":31,"isRegular":true}"; line: 1, column: 11] (through reference chain: com.divilioglu.db.utils.MySQLUtil$Customer["Zname"])
As you can see, we catched the specific scenario and we are sure, this comes from the line in dbUtil.persistCustomer() method which can be seen below;
Customer customer = objectMapper.readValue(jsonString, Customer.class);
E - Conclusion
So as it is a best practice to create new Exceptions by extending existing Exception classes. While writing your code at first, you may think that it is an overkill and you won't need additional Exception classes, but you will need them when you need distinguish the source of the problem and handle them independently.
In this example demonstrated above, I can independently catch IOException and SQLException and the sources of both Exceptions are coming from the same method. I want to distinguish both so that I can handle them independently. You cannot have that flexibility if you just wrap all the Exceptions with the base Exception class.
Exception is a standard class from which every exceptions inherit.
SQLException is a class that inherits from Exception and that is designed specifically for database(SQL) exceptions.
By doing
try {
// Your code here
} catch (Exception e) {
// Catching here
}
You are catching every type of exception possible... But then, you might not be able to know how to react to a specific exception.
but by doing
try {
// Your code here
} catch (SQLException e) {
// Catching here
}
You know that the exception happened while working on a database and it helps you know how to react to the exception.
As you see SQLException extends exception. So that's the only difference really. When you are catching exception then you will catch ALL exceptions (which is bad). But when you are catching SQLException then you catch only that(which is good because that is what you are seeking).
If an exception in between the try and catch blocks is thrown that is not a SQL Exception (these will typically only come from database-related code), for example a Null Pointer Exception, the Exception catch will catch it but the SQLException will not.
SQLException is an Exception so you are just getting a more specific exception.
According to Oracle's javadocs, this specific information you get is:
a string describing the error. This is used as the Java Exception
message, available via the method getMessage.
a "SQLstate" string, which follows either the XOPEN SQLstate
conventions or the SQL:2003 conventions. The values of the SQLState
string are described in the appropriate spec. The DatabaseMetaData
method getSQLStateType can be used to discover whether the driver
returns the XOPEN type or the SQL:2003 type.
an integer error code that is specific to each vendor. Normally this
will be the actual error code returned by the underlying database.
a chain to a next Exception. This can be used to provide additional
error information.
the causal relationship, if any for this SQLException.
SQLException is a specialized exception derived from Exception.
If you catch Exception, all exception shall get caught. Even undesirable exceptions.
If you catch only its specialiazation, the SQLException, only the SQLException itself or its derived shall get caught.
One shall catch only exceptions one can handle or wishes to handle, and let the others bubble up.
For further reference, please take a look at the following:
Exception
SQLException
SQL exception is a frequent error while working in Java Database Connectivity (JDBC).Its related to accessing or setting column in your SQL Query using prepared statement.
SQLException is a derived from Exception and contains more specific information related to accessing or setting column in your SQL query, while exception is usually more general.

How can you tell if a database is down or unavailable?

I am using a Spring DefaultMessageListenerContainer to consume messages from a queue. The messages are then saved to an Oracle database.
When the database goes down, I throw an exception out of the onMessage method and that leaves the message on the queue to be reprocessed. Below you can see that on a DataAccessResourceFailureException and CannotCreateTransactionException exception, I throw the exception out of the method, which puts it back on the queue. The other exceptions do not save the message; they correspond to data problems and such.
public void onMessage(javax.jms.Message mqMessage) {
...get the message blah, blah, blah
try {
this.theService.doMessage(tmaticMessage, theHandler);
} catch (DataAccessResourceFailureException e) {
this.slowDown(mqMessage);
throw e;
} catch (CannotCreateTransactionException e) {
this.slowDown(mqMessage);
throw e;
} catch (DataAccessException e) {
...
} catch (TmUnusableMessageException e) {
...
} catch (Exception e) {
...
}
}
Reading the Spring docs, I discovered that DataAccessResourceFailureException should be thrown "... when a resource fails completely: for example, if we can't connect to a database using JDBC." The problem is that I just did a test where I had the DBA take the database down and got a new exception: CannotCreateTransactionException. So that is one more exception that can be thrown. I am wondering if there are others.
I am using Spring Connections and getHibernateTemplate() to make my calls. Here is the question. How do I know what exceptions can be thrown when a database goes down?
Maybe the complexity is caused by various way you can 'take a database down'. For example:
deleting a table
deleting entire database
disabling a db user account
shutting down the database server
All can be considered as 'taking a database down', but each could cause a different exception being thrown
If you browse through following sections in spring javadoc, there are lists of exceptions that could be thrown:
http://static.springsource.org/spring/docs/2.0.x/api/org/springframework/dao/package-frame.html
http://static.springsource.org/spring/docs/2.0.x/api/org/springframework/transaction/package-frame.html

Categories