JUnit - Ignore the test

JUnit - Ignore the test

Sometimes there may be situations where our code is not ready, when the test case fails to test the method or code. @Ignore comments help us in this situation.

• A test method @Ignore a comment will not be executed.
• If a test class has a @Ignore comment, its test method will not be executed.

Now let's use examples to @Ignore.

Create a class

• In Directory C: I n this JUNIT_WORKSPACE create a java class to be tested named MessageUtil .java.

/*
* This class prints the given message on console.
*/
public class MessageUtil {

   private String message;

   //Constructor
   //@param message to be printed
   public MessageUtil(String message){
      this.message = message; 
   }

   // prints the message
   public String printMessage(){
      System.out.println(message);
      return message;
   }   

   // add "Hi!" to the message
   public String salutationMessage(){
      message = "Hi!" + message;
      System.out.println(message);
      return message;
   }   
} 

Create a Test Case class

• Create a java test class named TestJunit .java.
• Add test methods testPrintMessage() and testSalutationMessage() to the class.
• Add a comment to the method testPrintMessage() @Ignore comment.

In Directory C: Create a java JUNIT_WORKSPACE file named TestJunit in this .java

import org.junit.Test;
import org.junit.Ignore;
import static org.junit.Assert.assertEquals;

public class TestJunit {

   String message = "Robert";   
   MessageUtil messageUtil = new MessageUtil(message);

   @Ignore
   @Test
   public void testPrintMessage() {
      System.out.println("Inside testPrintMessage()");
      message = "Robert";
      assertEquals(message,messageUtil.printMessage());
   }

   @Test
   public void testSalutationMessage() {
      System.out.println("Inside testSalutationMessage()");
      message = "Hi!" + "Robert";
      assertEquals(message,messageUtil.salutationMessage());
   }
}

Create a Test Runner class

In Directory C: This is JUNIT_WORKSPACE to create a java class file called TestRunner .java to execute the test case.

import org.junit.runner.JUnitCore;
import org.junit.runner.Result;
import org.junit.runner.notification.Failure;

public class TestRunner {
   public static void main(String[] args) {
      Result result = JUnitCore.runClasses(TestJunit.class);
      for (Failure failure : result.getFailures()) {
         System.out.println(failure.toString());
      }
      System.out.println(result.wasSuccessful());
   }
}  

Use javac commands to compile MessageUtil, Test case, and Test Runner classes.

C:\JUNIT_WORKSPACE>javac MessageUtil.java TestJunit.java TestRunner.java

Now run the Test Runner class, which does not run the TestPrintMessage() test case defined in the Test Case class.

C:\JUNIT_WORKSPACE>java TestRunner

Verify the output. The testPrintMessage() test case was not tested.

Inside testSalutationMessage()
Hi!Robert
true

Now update in Directory C: TestJunit JUNIT_WORKSPACE in the class level uses @Ignore to ignore all test cases

import org.junit.Test;
import org.junit.Ignore;
import static org.junit.Assert.assertEquals;

@Ignore
public class TestJunit {

   String message = "Robert";   
   MessageUtil messageUtil = new MessageUtil(message);

   @Test
   public void testPrintMessage() {
      System.out.println("Inside testPrintMessage()");
      message = "Robert";
      assertEquals(message,messageUtil.printMessage());
   }

   @Test
   public void testSalutationMessage() {
      System.out.println("Inside testSalutationMessage()");
      message = "Hi!" + "Robert";
      assertEquals(message,messageUtil.salutationMessage());
   }
}

Use the javac command to compile Test case

C:\JUNIT_WORKSPACE>javac TestJunit.java

Keep your Test Runner unchanged, as follows:

import org.junit.runner.JUnitCore;
import org.junit.runner.Result;
import org.junit.runner.notification.Failure;

public class TestRunner {
   public static void main(String[] args) {
      Result result = JUnitCore.runClasses(TestJunit.class);
      for (Failure failure : result.getFailures()) {
         System.out.println(failure.toString());
      }
      System.out.println(result.wasSuccessful());
   }
}

Running Test Runner now does not run any of the test samples defined in the Test Case class.

C:\JUNIT_WORKSPACE>java TestRunner

Verify the output. No test cases have been tested.

true