Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor: use apache email validation instead of Regex #1

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Refactor: use apache email validation instead of Regex #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7f06087
chore: remove redundant condition
jdftapi Jul 7, 2021
b6a8385
refactor: use apache EmailValidator instead of Regex and refactor logic
jdftapi Jul 7, 2021
85f9aa2
refactor: use EmailValidator in Test case
jdftapi Jul 7, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,11 @@
<version>3.13.2</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>commons-validator</groupId>
<artifactId>commons-validator</artifactId>
<version>1.7</version>
</dependency>
</dependencies>

<repositories>
Expand Down
2 changes: 0 additions & 2 deletions src/main/java/io/jenkins/plugins/constant/ErrorCode.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

public abstract class ErrorCode
{

public static final int GENERIC_ERROR = 0;

public static final int INVALID_EMAIL = 101;
}
2 changes: 0 additions & 2 deletions src/main/java/io/jenkins/plugins/constant/PluginInfo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

public class PluginInfo
{

public static final String DISPLAY_NAME = "Validating Email Parameter";

public static final String HELP_FILE = "/plugin/validating-email-parameter/help.html";
}
17 changes: 0 additions & 17 deletions src/main/java/io/jenkins/plugins/constant/Regex.java
View file
Open in desktop

This file was deleted.

144 changes: 37 additions & 107 deletions src/main/java/io/jenkins/plugins/util/ValidationUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
package io.jenkins.plugins.util;

import hudson.util.FormValidation;
import io.jenkins.plugins.constant.Regex;
import net.sf.json.JSONObject;
import org.apache.commons.validator.routines.EmailValidator;

import java.util.Arrays;
import java.util.List;
import java.util.regex.Pattern;

public abstract class ValidationUtils {

Expand All @@ -15,27 +14,25 @@ public abstract class ValidationUtils {
private static List<String> params;
/*private static Map<String,String> paramMap;*/

private static final EmailValidator emailValidator = EmailValidator.getInstance();

private static boolean isMailAddressInDomain(String emailAddress, String domain) {
String[] addressParts = emailAddress.split("@");
return addressParts[addressParts.length - 1].equals(domain);
}

public static JSONObject buildParameter(String domain, Boolean externalEmail,
JSONObject jsonObject) {

builder = new StringBuilder();

normalizeSpace = jsonObject.getString(Key.VALUE.getValue()).trim();

params = Arrays.asList(normalizeSpace.split(" "));

String domainRegEx = Regex.Domain.DOMAIN_PATTERN
.replace(Regex.Domain.DOMAIN_NAME, domain);

if (!params.isEmpty()) {
for (String s : params) {

if (Pattern.matches(Regex.EMAIL_PATTERN, s)) {
if (emailValidator.isValid(s)) {
if (!externalEmail) {

if (Pattern.matches(domainRegEx, s)
&& Pattern.matches(Regex.EMAIL_PATTERN, s)) {
if (isMailAddressInDomain(s, domain)) {
builder.append(s).append(" ");
} else {
jsonObject.put(Key.IS_VALID.getValue(), false);
Expand All @@ -45,169 +42,102 @@ public static JSONObject buildParameter(String domain, Boolean externalEmail,
return jsonObject;
}
} else {

builder.append(s).append(" ");
}
} else if (!s.isEmpty()) {
if (!externalEmail) {

if (Pattern.matches(domainRegEx, (s + "@" + domain))) {

builder.append(s).append("@").append(domain).append(" ");

} else {
jsonObject.put(Key.IS_VALID.getValue(), false);
jsonObject.put(Key.ERROR.getValue(),
"Invalid email for parameter [" + jsonObject.getString("name")
+ "] expected domain : @" + domain + " specified: " + s);
return jsonObject;
}
if (emailValidator.isValid(s + "@" + domain)) {
builder.append(s).append("@").append(domain).append(" ");
} else {

if (Pattern.matches(Regex.EMAIL_PATTERN, (s + "@" + domain))) {

builder.append(s).append("@").append(domain).append(" ");

jsonObject.put(Key.IS_VALID.getValue(), false);
if(!externalEmail) {
jsonObject.put(Key.ERROR.getValue(),
"Invalid email for parameter [" + jsonObject.getString("name")
+ "] expected domain : @" + domain + " specified: " + s);
} else {
jsonObject.put(Key.IS_VALID.getValue(), false);
jsonObject.put(Key.ERROR.getValue(),
"Invalid email for parameter [" + jsonObject.getString("name")
+ "] Value entered does not match "
+ "email pattern; specified: " + s);
return jsonObject;
"Invalid email for parameter [" + jsonObject.getString("name")
+ "] Value entered does not match "
+ "email pattern; specified: " + s);
}
return jsonObject;
}
} else if (s.isEmpty()) {

jsonObject.put(Key.IS_VALID.getValue(), false);
jsonObject.put(Key.ERROR.getValue(),
"Invalid email for parameter [ " + jsonObject.getString("name")
+ " ] Expected domain : @" + domain + " Specified: [ Email is Empty! ]");
return jsonObject;
} else {
jsonObject.put(Key.IS_VALID.getValue(), false);
jsonObject.put(Key.ERROR.getValue(),
"Value entered does not match email pattern; Expected domain : @" + domain
+ " Specified: " + s);
"Invalid email for parameter [ " + jsonObject.getString("name")
+ " ] Expected domain : @" + domain
+ " Specified: [ Email is Empty! ]");
return jsonObject;
}

}

jsonObject.replace(Key.VALUE.getValue(), String.valueOf(builder).trim());
jsonObject.put(Key.IS_VALID.getValue(), true);

return jsonObject;
} else {
jsonObject.put(Key.IS_VALID.getValue(), true);
return jsonObject;
}

jsonObject.put(Key.IS_VALID.getValue(), true);
return jsonObject;
}

public static String definitionParameter(String defaultValue, String domain) {

builder = new StringBuilder();

normalizeSpace = defaultValue.trim();

params = Arrays.asList(normalizeSpace.split(" "));

if (!params.isEmpty()) {
for (String value : params) {

if (Pattern.matches(Regex.EMAIL_PATTERN, value)) {
if (emailValidator.isValid(value)) {
builder.append(value).append(" ");
} else if (!value.isEmpty()) {

builder.append(value).append("@").append(domain).append(" ");
} else {
return defaultValue;
}

}

return String.valueOf(builder).trim();
} else {

return defaultValue;

}

}

public static FormValidation formParameter(String domain, String value, Boolean externalEmail) {

builder = new StringBuilder();

normalizeSpace = value.trim();

params = Arrays.asList(normalizeSpace.split(" "));

String domainRegEx = Regex.Domain.DOMAIN_PATTERN
.replace(Regex.Domain.DOMAIN_NAME, domain);

if (!params.isEmpty()) {
for (String s : params) {

if (Pattern.matches(Regex.EMAIL_PATTERN, s)) {

if (emailValidator.isValid(s)) {
if (!externalEmail) {

if (Pattern.matches(domainRegEx, s)
&& Pattern.matches(Regex.EMAIL_PATTERN, s)) {
if (isMailAddressInDomain(s, domain)) {
builder.append(s).append(" ");
} else {
return FormValidation
.error("Value entered does not match domain : " + s);
return FormValidation.error("Value entered does not match domain : " + s);
}
} else {

builder.append(s).append(" ");
}
} else if (!s.isEmpty()) {
if (!externalEmail) {

if (Pattern.matches(domainRegEx, (s + "@" + domain))) {

builder.append(s).append("@").append(domain).append(" ");

} else {
return FormValidation
.error("Value entered does not match domain : " + s);
}
if (emailValidator.isValid(s + "@" + domain)) {
builder.append(s).append("@").append(domain).append(" ");
} else {

if (Pattern.matches(Regex.EMAIL_PATTERN, (s + "@" + domain))) {

builder.append(s).append("@").append(domain).append(" ");

if (!externalEmail) {
return FormValidation.error("Value entered does not match domain : " + s);
} else {
return FormValidation
.error("Value entered does not match email address pattern : " + s);
return FormValidation.error(
"Value entered does not match email address pattern : " + s);
}
}

} else if (s.isEmpty()) {
return FormValidation.warning("Email address is empty.");
} else {
return FormValidation.error("Value entered does not match email pattern : " + s);
return FormValidation.warning("Email address is empty.");
}

}

return FormValidation.respond(FormValidation.Kind.OK,
"<div class='ok' style='color:green;'><span>&#9989;</span><b> Valid Email : </b>"
+ builder + "</div>");

} else {

return FormValidation.respond(FormValidation.Kind.OK,
"<div class='ok' style='color:green;'><span>&#9989;</span><b> Valid Email : </b>" + value
+ "</div>");

}

}

public enum Key {
Expand All @@ -217,7 +147,7 @@ public enum Key {

private final String value;

private Key(String value) {
Key(String value) {
this.value = value;
}

Expand Down
5 changes: 2 additions & 3 deletions src/test/java/io/jenkins/plugins/validation/emailparameter/EmailValidationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
package io.jenkins.plugins.validation.emailparameter;

import io.jenkins.plugins.constant.Regex;
import io.jenkins.plugins.util.MockData;
import io.jenkins.plugins.util.ValidationUtils;
import lombok.extern.slf4j.Slf4j;
import org.junit.Before;
import org.junit.Test;
import org.apache.commons.validator.routines.EmailValidator;

import java.util.Arrays;
import java.util.regex.Pattern;

import static org.assertj.core.api.Assertions.assertThat;

Expand Down Expand Up @@ -43,7 +42,7 @@ public void emailValidationTest() {

private boolean accept(String param) {

return Pattern.matches(Regex.EMAIL_PATTERN, param);
return EmailValidator.getInstance().isValid(param);

}

Expand Down