{"id":83805,"date":"2020-09-28T07:10:31","date_gmt":"2020-09-28T07:10:31","guid":{"rendered":"https:\/\/www.baeldung.com\/?p=87768"},"modified":"2020-09-28T07:10:31","modified_gmt":"2020-09-28T07:10:31","slug":"conditionally-run-or-ignore-tests-in-junit-4","status":"publish","type":"post","link":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/2020\/09\/28\/conditionally-run-or-ignore-tests-in-junit-4\/","title":{"rendered":"Conditionally Run or Ignore Tests in JUnit 4"},"content":{"rendered":"

<\/p>\n

1. Overview<\/h2>\n
<\/div>\n

Let’s imagine we have a test for some code that depends on the Operating System and should run only if our test machine is running on Linux. If it’s running on any other OS, we want the test not to fail, but to be ignored at runtime.<\/p>\n

A first approach could be using a couple of if<\/em> statements to check for this condition using System<\/em> class properties. This works, of course, but JUnit has a cleaner, more elegant method.<\/p>\n

In this short tutorial, we’re going to look at how we can conditionally run or ignore tests in JUnit<\/a> 4 using the Assume<\/a>\u00a0<\/em>class<\/strong>.<\/p>\n

2. The Assume<\/em> Class<\/h2>\n
<\/div>\n

This\u00a0class provides a set of methods to support conditional test execution based on certain conditions<\/strong>. Our test will only run if all these conditions are met. If not, JUnit will just skip its execution and mark it as passed in the test report<\/strong>. The latter is the main difference with the Assert<\/em><\/a> class, in which a failing condition leads the test to end as failing<\/em>.<\/p>\n

An important thing to note is that the behavior we described for the Assume<\/em> class is exclusive to the default JUnit runner<\/strong>. With custom runners<\/a>, things may be different.<\/p>\n

Finally, in the same way as with Assert<\/em>, we can call the Assume<\/em> methods either in the @Before<\/em> or\u00a0@BeforeClass<\/em> annotated methods or within the @Test\u00a0<\/em>method itself.<\/p>\n

Let’s now go through the most useful methods of the Assume<\/em> class by showing some examples. For all the following examples, let’s assume getOsName()<\/em> returns Linux.<\/em><\/p>\n

2.1. Using assumeThat<\/em><\/h3>\n
<\/div>\n

The\u00a0assumeThat() <\/em>method checks that the state \u2013 in this case, getOsName()<\/em> \u2013 satisfies the conditions of the matcher passed in:<\/p>\n

@Test\r\npublic void whenAssumeThatAndOSIsLinux_thenRunTest() {\r\n    assumeThat(getOsName(), is(\"Linux\"));\r\n    assertEquals(\"run\", \"RUN\".toLowerCase());\r\n}<\/code><\/pre>\n
In this example, we checked whether getOsName()<\/em> equals to Linux<\/em>. As getOsName()<\/em> returns Linux<\/em>, the test will be run<\/strong>. Note, we’re using the Hamcrest matcher<\/a> method is(T) <\/em>as the matcher here.<\/p>\n
2.2. Using assumeTrue<\/em> <\/strong><\/h3>\n
<\/div>\n
Similarly, we can use the\u00a0assumeTrue()<\/em>\u00a0method to specify a boolean expression that must evaluate to\u00a0true<\/em>\u00a0in order for the test to run. If it evaluates to\u00a0false<\/em>, the test will be ignored:<\/p>\n
private boolean isExpectedOS(String osName) {\r\n    return \"Linux\".equals(osName);\r\n}\r\n@Test \r\npublic void whenAssumeTrueAndOSIsLinux_thenRunTest() {\r\n    assumeTrue(isExpectedOS(getOsName()));\r\n \r\n    assertEquals(\"run\", \"RUN\".toLowerCase());\r\n}\r\n<\/code><\/pre>\n
In this case, isExpectedOs()<\/em> returns true<\/em><\/strong>. Therefore, the<\/strong> conditions for the test to run have been met, and the test will be run<\/strong>.<\/p>\n
2.3. Using assumeFalse<\/em><\/h3>\n
<\/div>\n
Finally, we can use the opposite assumeFalse()<\/em>\u00a0method to specify a boolean expression that must evaluate to false <\/i>in order for the test to run. If it evaluates to\u00a0true<\/em>, the test will be ignored:<\/p>\n
@Test\r\npublic void whenAssumeFalseAndOSIsLinux_thenIgnore() {\r\n    assumeFalse(isExpectedOS(getOsName()));\r\n    assertEquals(\"run\", \"RUN\".toLowerCase());\r\n}<\/code><\/pre>\n
In this case, as isExpectedOs() <\/em>also<\/strong> returns <\/b>true,<\/b>\u00a0<\/em>the<\/strong> conditions for the test to run have not been met, and the test will be ignored<\/strong>.<\/p>\n
2.4. Using assumeNotNull<\/em><\/h3>\n
<\/div>\n
When we want to ignore a test if some expression is null, <\/em>we can use the assumeNotNull()<\/em> method:<\/p>\n
@Test\r\npublic void whenAssumeNotNullAndNotNullOSVersion_thenRun() {\r\n    assumeNotNull(getOsName());\r\n    assertEquals(\"run\", \"RUN\".toLowerCase());\r\n}<\/code><\/pre>\n
As getOsName()<\/em> is returning a non-null value, the condition for the test to run has been satisfied and the test will run.<\/p>\n
2.5. Using assumeNoException<\/em><\/h3>\n
<\/div>\n
Finally, we could want to ignore a test if an exception is thrown. We can use assumeNoException()<\/em> for this purpose:<\/p>\n
@Test\r\npublic void whenAssumeNoExceptionAndExceptionThrown_thenIgnore() {\r\n    assertEquals(\"everything ok\", \"EVERYTHING OK\".toLowerCase());\r\n    String t=null;\r\n    try {\r\n        t.charAt(0);\r\n    } catch(NullPointerException npe){\r\n        assumeNoException(npe);\r\n    }\r\n    assertEquals(\"run\", \"RUN\".toLowerCase());\r\n}<\/code><\/pre>\n
In this example, as t<\/em> is null,<\/em> a NullPointerException<\/em> exception is thrown, therefore <\/strong>the <\/strong>conditions for the test to run have not been met, and the test will be ignored<\/strong>.<\/p>\n
3. Where Should We Put the assumeXXX<\/em> Call?<\/h2>\n
<\/div>\n
It’s important to note that the behavior of the assumeXXX<\/em> methods depends on where we put them in our tests<\/strong>.<\/p>\n
Let’s slightly modify our assumeThat<\/em> example so the assertEquals()<\/em> call goes first. Also, let’s make the assertEquals()<\/em> fail:<\/p>\n
@Test\r\npublic void whenAssumeFalseAndOSIsLinux_thenIgnore() {\r\n    assertEquals(\"run\", \"RUN\");\r\n    assumeFalse(isExpectedOS(getOsName()));\r\n}\r\n<\/code><\/pre>\n
When we run this example, we’ll have:<\/p>\n
org.junit.ComparisonFailure: \r\nExpected :run\r\nActual   :RUN<\/code><\/pre>\n
In this case, our test is not ignored because it has failed before we reached the assumeThat()<\/em> call.<\/strong> The same happens with all of the assumeXXX<\/em> methods. So, we need to make sure we put them in the right place inside our test method<\/strong>.<\/p>\n
4. Conclusion<\/h2>\n
<\/div>\n
In this short tutorial, we’ve seen how we can conditionally decide whether or not a test should run, using the Assume<\/em> class in JUnit 4. In case we are using JUnit 5, it’s also available in version 5.4 or later<\/strong>.<\/p>\n
As always, the source code of the examples we’ve been through can be found over on GitHub<\/a>.<\/p>\n
The post Conditionally Run or Ignore Tests in JUnit 4<\/a> first appeared on Baeldung<\/a>.<\/p>\n
\"\"<\/p>\n
<\/a> <\/a> <\/a> <\/a> <\/a> <\/a> <\/a> <\/a> <\/div>\n\n
\\\"IT\u96fb\u8166\u88dc\u7fd2
\u7acb\u523b\u8a3b\u518a\u53ca\u5831\u540d\u96fb\u8166\u88dc\u7fd2\u8ab2\u7a0b\u5427!<\/figcaption><\/figure>\r\n<\/br>Find A Teacher Form:\r\n<\/br>https:\/\/docs.google.com\/forms\/d\/1vREBnX5n262umf4wU5U2pyTwvk9O-JrAgblA-wH9GFQ\/viewform?edit_requested=true#responses\r\n<\/br><\/br>Email:\r\n<\/br>public1989two@gmail.com






\r\nwww.itsec.hk<\/a>
\r\nwww.itsec.vip<\/a>
\r\nwww.itseceu.uk<\/a>
<\/p>","protected":false},"excerpt":{"rendered":"
Let’s look at how, based on certain conditions, we can run or ignore tests using JUnit.<\/p>\n
The post Conditionally Run or Ignore Tests in JUnit 4<\/a> first appeared on Baeldung<\/a>.<\/p>\n
<\/a> <\/a> <\/a> <\/a> <\/a> <\/a> <\/a> <\/a> <\/div>\n<\/div>","protected":false},"author":919,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"slim_seo":{"title":"Conditionally Run or Ignore Tests in JUnit 4 - ITTeacherITFreelance.hk","description":"Let's look at how, based on certain conditions, we can run or ignore tests using JUnit. The post Conditionally Run or Ignore Tests in JUnit 4 first appeared on"},"footnotes":""},"categories":[6],"tags":[],"_links":{"self":[{"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/posts\/83805"}],"collection":[{"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/users\/919"}],"replies":[{"embeddable":true,"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/comments?post=83805"}],"version-history":[{"count":4,"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/posts\/83805\/revisions"}],"predecessor-version":[{"id":85411,"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/posts\/83805\/revisions\/85411"}],"wp:attachment":[{"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/media?parent=83805"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/categories?post=83805"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/tags?post=83805"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}