Checkstyle rule to prevent throwing the generic RuntimeException

This is a frequent cause of sonar breakage.

Change-Id: I54e0044447633a61bab560b020b57ed0a6875ebe

apps/configsync-netconf/src/test/java/org/onosproject/d/config/sync/impl/netconf/NetconfDeviceConfigSynchronizerProviderTest.java

@@ -284,7 +284,7 @@ public class NetconfDeviceConfigSynchronizerProviderTest {
 
             return new DefaultCompositeStream(id, xml);
         } catch (IOException e) {
-            throw new RuntimeException(e);
+            throw new IllegalStateException(e);
         }
     }
 

core/store/primitives/src/test/java/org/onosproject/store/primitives/impl/EventuallyConsistentMapImplTest.java

@@ -804,7 +804,7 @@ public class EventuallyConsistentMapImplTest {
             } else if (subject.equals(UPDATE_REQUEST_SUBJECT)) {
                 requestHandler = (Consumer<Collection<UpdateRequest<String>>>) handler;
             } else {
-                throw new RuntimeException("Unexpected message subject " + subject.toString());
+                throw new IllegalStateException("Unexpected message subject " + subject.toString());
             }
         }
 
@@ -814,7 +814,7 @@ public class EventuallyConsistentMapImplTest {
             if (subject.equals(ANTI_ENTROPY_MESSAGE_SUBJECT)) {
                 antiEntropyHandler = (Function<AntiEntropyAdvertisement<String>, AntiEntropyResponse>) handler;
             } else if (!subject.equals(INITIALIZE_MESSAGE_SUBJECT)) {
-                throw new RuntimeException("Unexpected message subject " + subject.toString());
+                throw new IllegalStateException("Unexpected message subject " + subject.toString());
             }
         }
     }

core/store/primitives/src/test/java/org/onosproject/store/primitives/resources/impl/AtomixConsistentSetMultimapTest.java

@@ -445,7 +445,7 @@ public class AtomixConsistentSetMultimapTest extends AtomixTestBase<AtomixConsis
             AtomixConsistentSetMultimap map = newPrimitive(mapName);
             return map;
         } catch (Throwable e) {
-            throw new RuntimeException(e.toString());
+            throw new IllegalStateException(e.toString());
         }
     }
 

core/store/primitives/src/test/java/org/onosproject/store/primitives/resources/impl/AtomixConsistentTreeMapTest.java

@@ -485,7 +485,7 @@ public class AtomixConsistentTreeMapTest extends AtomixTestBase<AtomixConsistent
             AtomixConsistentTreeMap map = newPrimitive(mapName);
             return map;
         } catch (Throwable e) {
-            throw new RuntimeException(e.toString());
+            throw new IllegalStateException(e.toString());
         }
     }
     private static class TestMapEventListener

core/store/primitives/src/test/java/org/onosproject/store/primitives/resources/impl/AtomixTestBase.java

@@ -211,7 +211,7 @@ public abstract class AtomixTestBase<T extends AbstractRaftPrimitive> {
         try {
             latch.await(30000, TimeUnit.MILLISECONDS);
         } catch (InterruptedException e) {
-            throw new RuntimeException(e);
+            throw new IllegalStateException(e);
         }
 
         return servers;

drivers/bmv2/src/main/java/org/onosproject/drivers/bmv2/ctl/SafeThriftClient.java

@@ -94,7 +94,8 @@ final class SafeThriftClient {
             }
         }
 
-        throw new RuntimeException("Class needs to implement Iface directly. Use wrap(TServiceClient, Class) instead.");
+        throw new IllegalStateException(
+                "Class needs to implement Iface directly. Use wrap(TServiceClient, Class) instead.");
     }
 
     /**
@@ -202,7 +203,7 @@ final class SafeThriftClient {
                             Thread.sleep(timeBetweenRetries);
                         } catch (InterruptedException e2) {
                             Thread.currentThread().interrupt();
-                            throw new RuntimeException(e);
+                            throw new IllegalStateException(e);
                         }
                     }
                 }

drivers/bmv2/src/main/java/org/onosproject/drivers/bmv2/impl/Bmv2PreGroupTranslatorImpl.java

@@ -57,7 +57,7 @@ public final class Bmv2PreGroupTranslatorImpl {
      */
     public static Bmv2PreGroup translate(Group group) {
         if (!group.type().equals(GroupDescription.Type.ALL)) {
-            throw new RuntimeException("Unable to translate the group to BMv2 PRE group." +
+            throw new IllegalStateException("Unable to translate the group to BMv2 PRE group." +
                                                "A BMv2 PRE group is to be of ALL type. GroupId="
                                                + group.id());
         }
@@ -231,11 +231,11 @@ public final class Bmv2PreGroupTranslatorImpl {
     private static void checkOutputInstructions(GroupId groupId,
                                                 Set<Instructions.OutputInstruction> outputInstructions) {
         if (outputInstructions.isEmpty()) {
-            throw new RuntimeException(String.format("Group bucket contains no output instruction. GroupId=%s",
+            throw new IllegalStateException(String.format("Group bucket contains no output instruction. GroupId=%s",
                                                      groupId));
         }
         if (outputInstructions.size() != 1) {
-            throw new RuntimeException(String.format("Group bucket contains more than one output instructions. " +
+            throw new IllegalStateException(String.format("Group bucket contains more than one output instructions. " +
                                                              "Only one is supported. GroupId=%s", groupId));
         }
     }
@@ -249,7 +249,7 @@ public final class Bmv2PreGroupTranslatorImpl {
      */
     private static void validatePort(PortNumber portNumber) {
         if (portNumber.toLong() < 0 || portNumber.toLong() >= BMV2_PORT_MAP_SIZE) {
-            throw new RuntimeException(String.format("Port number %d is not a valid BMv2 physical port number." +
+            throw new IllegalStateException(String.format("Port number %d is not a valid BMv2 physical port number." +
                                                              "Valid port range is [0,255]", portNumber));
         }
     }

drivers/odtn-driver/src/main/java/org/onosproject/drivers/odtn/openconfig/TerminalDeviceDiscovery.java

@@ -213,7 +213,7 @@ public class TerminalDeviceDiscovery
            doc.appendChild(rpc);
            return NetconfRpcParserUtil.toString(doc);
            } catch (Exception e) {
-           throw new RuntimeException(new NetconfException("Exception in getDeviceDetailsBuilder", e));
+           throw new IllegalStateException(new NetconfException("Exception in getDeviceDetailsBuilder", e));
            }
          */
     }

protocols/p4runtime/ctl/src/main/java/org/onosproject/p4runtime/ctl/P4RuntimeClientImpl.java

@@ -172,7 +172,7 @@ final class P4RuntimeClientImpl implements P4RuntimeClient {
             } catch (InterruptedException e) {
                 log.warn("Thread interrupted while waiting for lock (executing {})",
                          opDescription);
-                throw new RuntimeException(e);
+                throw new IllegalStateException(e);
             }
             try {
                 return supplier.get();

tools/build/conf/src/main/resources/onos/checkstyle.xml

@@ -115,6 +115,14 @@
         <property name="message" value="javafx classes are not supported by all JDKs."/>
     </module>
 
+    <!-- Don't allow usage of RuntimeException -->
+    <module name="RegexpSingleline">
+        <property name="format" value="throw[ ]*new[ ]*RuntimeException"/>
+        <property name="minimum" value="0"/>
+        <property name="maximum" value="0"/>
+        <property name="message" value="Don't throw generic exception types"/>
+    </module>
+
     <!-- Checks for Headers                                -->
     <!-- See http://checkstyle.sf.net/config_header.html   -->
     <!-- <module name="Header"> -->

utils/misc/src/test/java/org/onlab/util/ManuallyAdvancingTimer.java

@@ -295,7 +295,7 @@ public class ManuallyAdvancingTimer extends java.util.Timer {
             currExecTime = TestUtils.getField(currTask, "nextExecutionTime");
         } catch (TestUtils.TestUtilsException e) {
             e.printStackTrace();
-            throw new RuntimeException("Could not get nextExecutionTime");
+            throw new IllegalStateException("Could not get nextExecutionTime");
         }
         while (currExecTime <= timerKeeper.currentTimeInMillis()) {
             if (executeTask(queue.pop())) {
@@ -309,7 +309,7 @@ public class ManuallyAdvancingTimer extends java.util.Timer {
                 currExecTime = TestUtils.getField(currTask, "nextExecutionTime");
             } catch (TestUtils.TestUtilsException e) {
                 e.printStackTrace();
-                throw new RuntimeException("Could not get nextExecutionTime");
+                throw new IllegalStateException("Could not get nextExecutionTime");
             }
         }
         return totalRun;
@@ -461,7 +461,7 @@ public class ManuallyAdvancingTimer extends java.util.Timer {
                     executionTimeTwo = TestUtils.getField(o2, "nextExecutionTime");
                 } catch (TestUtils.TestUtilsException e) {
                     e.printStackTrace();
-                    throw new RuntimeException("Could not get next execution time.");
+                    throw new IllegalStateException("Could not get next execution time.");
                 }
                 if (executionTimeOne == executionTimeTwo) {
                     return 0;