Merge pull request #80 from jenkinsci/code-improvements

chore: improve tests and correct equals / hashcode

Author: res0nance

src/main/java/hudson/plugins/validating_string_parameter/ValidatingStringParameterValue.java

@@ -23,6 +23,7 @@
  */
 package hudson.plugins.validating_string_parameter;
 
+import com.google.common.base.Objects;
 import hudson.AbortException;
 import hudson.Launcher;
 import hudson.model.AbstractBuild;
@@ -61,10 +62,6 @@ public void setRegex(String regex) {
         this.regex = regex;
     }
 
-    public String getValue() {
-        return value;
-    }
-
     @Override
     public BuildWrapper createBuildWrapper(AbstractBuild<?, ?> build) {
         if (regex != null && !Pattern.matches(regex, value)) {
@@ -82,10 +79,7 @@ public Environment setUp(AbstractBuild build, Launcher launcher, BuildListener l
 
     @Override
     public int hashCode() {
-        final int prime = 71;
-        int result = super.hashCode();
-        result = prime * result;
-        return result;
+        return Objects.hashCode(super.hashCode(), regex);
     }
 
     @Override
@@ -100,10 +94,10 @@ public boolean equals(Object obj) {
             return false;
         }
         ValidatingStringParameterValue other = (ValidatingStringParameterValue) obj;
-        if (value == null) {
-            return other.value == null;
+        if (regex == null) {
+            return other.regex == null;
         } else {
-            return value.equals(other.value);
+            return regex.equals(other.regex);
         }
     }
 

src/test/java/hudson/plugins/validating_string_parameter/ValidatingStringParameterDefinitionTest.java

@@ -3,6 +3,7 @@
 import hudson.AbortException;
 import hudson.cli.CLICommand;
 import hudson.model.Failure;
+import hudson.util.FormValidation;
 import net.sf.json.JSONObject;
 import org.junit.Test;
 import org.junit.runner.RunWith;
@@ -33,11 +34,12 @@ public void simpleConfiguration() throws Exception {
         assertEquals("Your parameter does not match the regular expression!", d.getFailedValidationMessage());
         assertEquals("Some parameter", d.getDescription());
         Mockito.when(req.getParameterValues("DUMMY")).thenReturn(new String[]{"test"});
-        assertEquals(new ValidatingStringParameterValue("DUMMY", "test"), d.createValue(req));
+        ValidatingStringParameterValue v1 = new ValidatingStringParameterValue("DUMMY", "test", ".+", "");
+        assertEquals(v1, d.createValue(req));
         JSONObject jo = new JSONObject();
-        ValidatingStringParameterValue v = new ValidatingStringParameterValue("DUMMY", "test2");
-        Mockito.when(req.bindJSON(ValidatingStringParameterValue.class, jo)).thenReturn(v);
-        assertEquals(v, d.createValue(req, jo));
+        ValidatingStringParameterValue v2 = new ValidatingStringParameterValue("DUMMY", "test2");
+        Mockito.when(req.bindJSON(ValidatingStringParameterValue.class, jo)).thenReturn(v2);
+        assertEquals(v2, d.createValue(req, jo));
     }
 
     @Test(expected = Failure.class)
@@ -61,7 +63,9 @@ public void cliCommand() throws IOException, InterruptedException {
         ValidatingStringParameterDefinition d = new ValidatingStringParameterDefinition("DUMMY", "foo", "\".+", "Your parameter does not match the regular expression!", "Some parameter");
         assertEquals(d.getDefaultParameterValue(),d.createValue(cliCommand, null));
         Mockito.verifyNoInteractions(cliCommand);
-        assertEquals(new ValidatingStringParameterValue("DUMMY", "\"hello"), d.createValue(cliCommand, "\"hello"));
+        ValidatingStringParameterValue v = new ValidatingStringParameterValue("DUMMY", "\"hello");
+        v.setRegex("\".+");
+        assertEquals(v, d.createValue(cliCommand, "\"hello"));
         Mockito.verifyNoInteractions(cliCommand);
     }
 
@@ -71,4 +75,18 @@ public void cliCommandFailure() throws IOException, InterruptedException {
         d.createValue(cliCommand, "hello");
         Mockito.verifyNoInteractions(cliCommand);
     }
+
+    @Test
+    public void regexCheck() {
+        ValidatingStringParameterDefinition.DescriptorImpl d = new ValidatingStringParameterDefinition.DescriptorImpl();
+        assertEquals(FormValidation.Kind.OK, d.doCheckRegex("abc").kind);
+        assertEquals(FormValidation.Kind.ERROR, d.doCheckRegex("(dddd").kind);
+    }
+
+    @Test
+    public void validationCheck() {
+        ValidatingStringParameterDefinition.DescriptorImpl d = new ValidatingStringParameterDefinition.DescriptorImpl();
+        assertEquals(FormValidation.Kind.OK, d.doValidate("abc", "failed", "abc").kind);
+        assertEquals(FormValidation.Kind.ERROR, d.doValidate("abc", "failed", "").kind);
+    }
 }

src/test/java/hudson/plugins/validating_string_parameter/ValidatingStringParameterValueTest.java

@@ -3,16 +3,40 @@
 import org.junit.Test;
 
 import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertNull;
 
 public class ValidatingStringParameterValueTest {
 
     @Test
     public void equals() {
         ValidatingStringParameterValue v = new ValidatingStringParameterValue("DUMMY", "VALUE");
         assertEquals(v, v);
-        v.setRegex("lol");
         ValidatingStringParameterValue v2 = new ValidatingStringParameterValue("DUMMY", "VALUE");
         assertEquals(v2, v);
         assertEquals(v2.hashCode(), v.hashCode());
+        v.setRegex("fake_regex");
+        assertNotEquals(v2, v);
+        assertNotEquals(v2.hashCode(), v.hashCode());
+        v2.setRegex("fake_regex");
+        assertEquals(v2, v);
+        assertEquals(v2.hashCode(), v.hashCode());
+    }
+
+    @Test
+    public void regex() {
+        ValidatingStringParameterValue v = new ValidatingStringParameterValue("DUMMY", "VALUE");
+        String regex = "FAKE_REGEX";
+        v.setRegex(regex);
+        assertEquals(regex, v.getRegex());
+    }
+
+    @Test
+    public void buildWrapper() {
+        ValidatingStringParameterValue v = new ValidatingStringParameterValue("DUMMY", "VALUE");
+        assertNull(v.createBuildWrapper(null));
+        v.setRegex("abc");
+        assertNotNull(v.createBuildWrapper(null));
     }
 }