Merge pull request #5371 from jdi-testing/5370_add_style_exception

Add new style rule for RuntimeException

Author: pnatashap

config/checkstyle/checkstyle.xml

@@ -352,4 +352,11 @@
     <property name="id" value="MatcherBooleanWithoutMessage_Error" />
     <property name="fileExtensions" value="java"/>
   </module>
+  <module name="RegexpSingleline">
+    <property name="severity" value="error" />
+    <property name="format" value="throw new RuntimeExc" />
+    <property name="message" value="Use `throw runtimeException('Error Message')` or `throw exception('Error message')`" />
+    <property name="id" value="MatcherThrowingExceptions_Error" />
+    <property name="fileExtensions" value="java"/>
+  </module>
 </module>

jdi-light-material-ui/src/main/java/com/epam/jdi/light/material/elements/displaydata/table/MUITable.java

@@ -1,7 +1,6 @@
 package com.epam.jdi.light.material.elements.displaydata.table;
 
 import com.epam.jdi.light.asserts.generic.HasAssert;
-import com.epam.jdi.light.common.Exceptions;
 import com.epam.jdi.light.common.JDIAction;
 import com.epam.jdi.light.elements.base.UIBaseElement;
 import com.epam.jdi.light.elements.common.UIElement;
@@ -21,6 +20,7 @@
 import java.util.*;
 import java.util.stream.Collectors;
 
+import static com.epam.jdi.light.common.Exceptions.runtimeException;
 import static com.epam.jdi.light.driver.WebDriverFactory.jsExecute;
 
 public class MUITable extends UIBaseElement<MUITableAssert> implements HasAssert<MUITableAssert>, ISetup {
@@ -40,7 +40,7 @@ public void setup(Field field) {
         boolean hasUI = FillFromAnnotationRules.fieldHasAnnotation(field, UI.class, MUITable.class);
         if (!FillFromAnnotationRules.fieldHasAnnotation(field, JMUITable.class, MUITable.class)
             && !hasUI) {
-            throw Exceptions.runtimeException(String.format("Table '%s' initialisation failed", core().getName()));
+            throw runtimeException(String.format("Table '%s' initialisation failed", core().getName()));
         }
         if (hasUI) {
             setupFromUI(field);
@@ -62,7 +62,7 @@ private void setupFromUI(Field field) {
             columnFilter =  new MUITableColumnFilter((JMUITableColumnFilter) uiDefaults.getDeclaredMethod("columnFilter").getDefaultValue());
             columnConfig = new MUITableColumnConfig((JMUITableColumnConfig) uiDefaults.getDeclaredMethod("columnConfig").getDefaultValue());
         } catch (NoSuchMethodException e) {
-            throw new RuntimeException(e);
+            throw runtimeException("Error during MUITable initialization", e);
         }
     }
 

jdi-light-material-ui/src/main/java/com/epam/jdi/light/material/elements/feedback/progress/Progress.java

@@ -9,8 +9,8 @@
 import com.epam.jdi.light.material.asserts.feedback.ProgressAssert;
 
 import java.lang.reflect.Field;
-import java.util.NoSuchElementException;
 
+import static com.epam.jdi.light.common.Exceptions.runtimeException;
 import static com.epam.jdi.light.driver.WebDriverByUtils.NAME_TO_LOCATOR;
 import static com.epam.jdi.light.elements.init.UIFactory.$;
 import static com.epam.jdi.light.elements.pageobjects.annotations.objects.FillFromAnnotationRules.fieldHasAnnotation;
@@ -49,15 +49,13 @@ public Label label() {
      * Gets the current value of progress.
      *
      * @return current progress value as {@code int}
-     * @throws NoSuchElementException if 'value' attribute doesn't exist
-     *                                (i.e. the progress is indeterminate)
      */
     @JDIAction("Get '{name}' value now")
     public int getValueNow() {
         if (isDeterminate()) {
             return Integer.parseInt(core().attr("aria-valuenow"));
         }
-        throw new NoSuchElementException("No exist 'value' attribute");
+        throw runtimeException("No exist 'value' attribute");
     }
 
     /**

jdi-light-mobile/src/main/java/com/epam/jdi/light/mobile/MobileUtils.java

@@ -34,7 +34,6 @@
  */
 public final class MobileUtils {
     private MobileUtils() {
-        throw new IllegalStateException("Utility class");
     }
 
     public static <I> void executeDriverMethod(Class<I> clazz, Consumer<I> consumer) {

jdi-light-mobile/src/main/java/com/epam/jdi/light/mobile/elements/common/app/android/RatingBar.java

@@ -1,5 +1,6 @@
 package com.epam.jdi.light.mobile.elements.common.app.android;
 
+import com.epam.jdi.light.common.JDIAction;
 import com.epam.jdi.light.mobile.asserts.RatingBarAssert;
 import com.epam.jdi.light.mobile.elements.base.MobileAppBaseElement;
 import com.epam.jdi.light.mobile.interfaces.HasTouchActions;
@@ -8,21 +9,26 @@
 import io.appium.java_client.touch.offset.PointOption;
 import org.openqa.selenium.Rectangle;
 
+import static com.epam.jdi.light.common.Exceptions.runtimeException;
+
 public class RatingBar extends MobileAppBaseElement implements HasTouchActions {
 
     public double getRating() {
         return Double.parseDouble(core().getText());
     }
 
+    // @todo Check if 1.0 is really the minimum, as typically 0 is minimum
+    @JDIAction("Setup rating value to {0} with the max value as {1} (Value should not greater then max and not less then 1.0)")
     public void setRatingByClick(double value, double fullStars) {
         if (value > fullStars || value < 1.0) {
-            throw new IllegalArgumentException("New value should be in the range [1.0, " + fullStars + "].");
+            throw runtimeException("New value should be in the range [1.0, " + fullStars + "].");
         }
         Rectangle position = core().getRect();
         int stepLength = (int) (position.width / fullStars);
         int offset = (int) (stepLength * (value - 1));
         int newRatingPositionX = position.x + offset + (int) (stepLength * 0.6);
         int newRatingPositionY = position.y + position.height / 2;
+        // @todo Change TouchAction in mobile project, as it is depricated
         TouchAction touchAction = new TouchAction((PerformsTouchActions) core().driver());
         touchAction.tap(PointOption.point(newRatingPositionX, newRatingPositionY)).perform();
     }

jdi-light-mobile/src/main/java/com/epam/jdi/light/mobile/elements/complex/Spinner.java

@@ -14,6 +14,7 @@
 import java.util.List;
 import java.util.NoSuchElementException;
 
+import static com.epam.jdi.light.common.Exceptions.exception;
 import static com.epam.jdi.light.driver.WebDriverFactory.getDriver;
 
 public class Spinner extends MobileAppBaseElement<TextAssert>
@@ -44,7 +45,7 @@ public void hasItems(String[] items) {
         } catch (NoSuchElementException e) {
             StringBuilder builder = new StringBuilder();
             elements.forEach(el -> builder.append(el.getText()).append(", "));
-            throw new NoSuchElementException("One of the expected items is missing in the spinner list. \nExpected:\n" +
+            throw exception(e, "One of the expected items is missing in the spinner list. \nExpected:\n" +
                     Arrays.asList(items) + "\nActual:\n" + builder);
         }
     }

jdi-light-vuetify/src/main/java/com/epam/jdi/light/vuetify/elements/complex/Dialog.java

@@ -8,6 +8,7 @@
 import com.epam.jdi.light.vuetify.elements.common.VuetifyButton;
 import com.epam.jdi.light.vuetify.interfaces.HasTheme;
 
+import static com.epam.jdi.light.common.Exceptions.runtimeException;
 import static org.openqa.selenium.Keys.ESCAPE;
 
 /**
@@ -79,7 +80,7 @@ public void close() {
             dialogWindow().focus();
             press(ESCAPE);
         } else {
-            throw new RuntimeException("Dialog cannot be closed by pressing esc key");
+            throw runtimeException("Dialog cannot be closed by pressing esc key");
         }
     }
 

jdi-light-vuetify/src/main/java/com/epam/jdi/light/vuetify/elements/complex/TreeViewNode.java

@@ -122,7 +122,6 @@ public UIElement iCore() {
     @Override
     @JDIAction("Get '{name}' text value")
     public String getValue() {
-
         return iCore().getText();
     }
 
@@ -140,7 +139,6 @@ public int size() {
 
     @JDIAction("Get '{name}' check list")
     public WebList checkList() {
-
         return new WebList();
     }
 
@@ -352,7 +350,7 @@ public void refresh() {
 
     @Override
     public void clear() {
-        throw new UnsupportedOperationException();
+        throw runtimeException("Clear operation is not supported by TreeViewNode");
     }
 
     protected TreeViewNode create(UIElement base) {

jdi-light-vuetify/src/main/java/com/epam/jdi/light/vuetify/elements/complex/bars/AppBar.java

@@ -5,6 +5,7 @@
 import com.epam.jdi.light.vuetify.asserts.bars.AppBarAssert;
 import com.epam.jdi.light.vuetify.elements.common.Image;
 
+import static com.epam.jdi.light.common.Exceptions.runtimeException;
 import static com.epam.jdi.light.driver.WebDriverFactory.jsExecute;
 
 /**
@@ -33,7 +34,7 @@ public Image backgroundImage() {
         if (hasBackgroundImage()) {
             return new Image().setCore(Image.class, core().find(IMAGE_LOCATOR));
         } else {
-            throw new RuntimeException("Element doesn't have image");
+            throw runtimeException("Element doesn't have image");
         }
     }
 

jdi-light-vuetify/src/main/java/com/epam/jdi/light/vuetify/elements/complex/tables/DataTable.java

@@ -202,7 +202,7 @@ public void groupBy(String colName) {
                 return;
             }
         }
-
+        // @todo add a public method to check if grouping by column is available
         //check if it is already grouped by
         if (groups.isEmpty()) {
             throw runtimeException(String.format("Grouping by column '%s' is not available", colName));