Skip to content

Simplify tests #346

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

Merged
pkwarren merged 1 commit into from
Sep 8, 2025
Merged

Simplify tests #346

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions src/test/java/build/buf/protovalidate/ValidationResultTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class ValidationResultTest {
@Test
void testToStringNoViolations() {

List<Violation> violations = new ArrayList<Violation>();
List<Violation> violations = new ArrayList<>();
ValidationResult result = new ValidationResult(violations);

assertThat(result.toString()).isEqualTo("Validation OK");
Expand All @@ -43,7 +43,7 @@ void testToStringSingleViolation() {
.setMessage("value must equal 42")
.addFirstFieldPathElement(elem)
.build();
List<Violation> violations = new ArrayList<Violation>();
List<Violation> violations = new ArrayList<>();
violations.add(violation);
ValidationResult result = new ValidationResult(violations);

Expand All @@ -69,7 +69,7 @@ void testToStringMultipleViolations() {
.setMessage("value is required")
.addFirstFieldPathElement(elem)
.build();
List<Violation> violations = new ArrayList<Violation>();
List<Violation> violations = new ArrayList<>();
violations.add(violation1);
violations.add(violation2);
ValidationResult result = new ValidationResult(violations);
Expand All @@ -86,7 +86,7 @@ void testToStringSingleViolationMultipleFieldPathElements() {
FieldPathElement elem2 =
FieldPathElement.newBuilder().setFieldNumber(5).setFieldName("nested_name").build();

List<FieldPathElement> elems = new ArrayList<FieldPathElement>();
List<FieldPathElement> elems = new ArrayList<>();
elems.add(elem1);
elems.add(elem2);

Expand All @@ -97,7 +97,7 @@ void testToStringSingleViolationMultipleFieldPathElements() {
.addAllFieldPathElements(elems)
.build();

List<Violation> violations = new ArrayList<Violation>();
List<Violation> violations = new ArrayList<>();
violations.add(violation1);
ValidationResult result = new ValidationResult(violations);

Expand All @@ -113,7 +113,7 @@ void testToStringSingleViolationNoFieldPathElements() {
.setRuleId("int32.const")
.setMessage("value must equal 42")
.build();
List<Violation> violations = new ArrayList<Violation>();
List<Violation> violations = new ArrayList<>();
violations.add(violation);
ValidationResult result = new ValidationResult(violations);

Expand Down
196 changes: 75 additions & 121 deletions src/test/java/build/buf/protovalidate/ValidatorConstructionTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@

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

import build.buf.protovalidate.exceptions.ValidationException;
import com.example.imports.validationtest.ExampleFieldRules;
Expand All @@ -33,52 +32,44 @@ public class ValidatorConstructionTest {

// Tests validation works as planned with default builder.
@Test
public void testDefaultBuilder() {
Map<Integer, Integer> testMap = new HashMap<Integer, Integer>();
public void testDefaultBuilder() throws ValidationException {
Map<Integer, Integer> testMap = new HashMap<>();
testMap.put(42, 42);
FieldExpressionMapInt32 msg = FieldExpressionMapInt32.newBuilder().putAllVal(testMap).build();

Validator validator = ValidatorFactory.newBuilder().build();
try {
ValidationResult result = validator.validate(msg);
assertThat(result.isSuccess()).isFalse();
assertThat(result.getViolations().size()).isEqualTo(1);
assertThat(result.getViolations().get(0).toProto().getMessage())
.isEqualTo("all map values must equal 1");
} catch (ValidationException e) {
fail("unexpected exception thrown", e);
}
ValidationResult result = validator.validate(msg);
assertThat(result.isSuccess()).isFalse();
assertThat(result.getViolations().size()).isEqualTo(1);
assertThat(result.getViolations().get(0).toProto().getMessage())
.isEqualTo("all map values must equal 1");
}

// Tests validation works as planned with default builder and config
@Test
public void testDefaultBuilderWithConfig() {
Map<Integer, Integer> testMap = new HashMap<Integer, Integer>();
public void testDefaultBuilderWithConfig() throws ValidationException {
Map<Integer, Integer> testMap = new HashMap<>();
testMap.put(42, 42);
FieldExpressionMapInt32 msg = FieldExpressionMapInt32.newBuilder().putAllVal(testMap).build();

Config cfg = Config.newBuilder().setFailFast(true).build();
Validator validator = ValidatorFactory.newBuilder().withConfig(cfg).build();
try {
ValidationResult result = validator.validate(msg);
assertThat(result.isSuccess()).isFalse();
assertThat(result.getViolations().size()).isEqualTo(1);
assertThat(result.getViolations().get(0).toProto().getMessage())
.isEqualTo("all map values must equal 1");
} catch (ValidationException e) {
fail("unexpected exception thrown", e);
}
ValidationResult result = validator.validate(msg);
assertThat(result.isSuccess()).isFalse();
assertThat(result.getViolations().size()).isEqualTo(1);
assertThat(result.getViolations().get(0).toProto().getMessage())
.isEqualTo("all map values must equal 1");
}

// Tests that if the correct seed descriptors are provided and lazy is disabled,
// validation works as planned.
@Test
public void testSeedDescriptorsLazyDisabled() {
Map<Integer, Integer> testMap = new HashMap<Integer, Integer>();
public void testSeedDescriptorsLazyDisabled() throws ValidationException {
Map<Integer, Integer> testMap = new HashMap<>();
testMap.put(42, 42);
FieldExpressionMapInt32 msg = FieldExpressionMapInt32.newBuilder().putAllVal(testMap).build();

List<Descriptor> seedDescriptors = new ArrayList<Descriptor>();
List<Descriptor> seedDescriptors = new ArrayList<>();
FieldExpressionMapInt32 reg = FieldExpressionMapInt32.newBuilder().build();
seedDescriptors.add(reg.getDescriptorForType());

Expand All @@ -87,179 +78,142 @@ public void testSeedDescriptorsLazyDisabled() {
// Note that buildWithDescriptors throws the exception so the validator builder
// can be created ahead of time without having to catch an exception.
ValidatorFactory.ValidatorBuilder bldr = ValidatorFactory.newBuilder().withConfig(cfg);
try {
Validator validator = bldr.buildWithDescriptors(seedDescriptors, true);
ValidationResult result = validator.validate(msg);
assertThat(result.isSuccess()).isFalse();
assertThat(result.getViolations().size()).isEqualTo(1);
assertThat(result.getViolations().get(0).toProto().getMessage())
.isEqualTo("all map values must equal 1");
} catch (ValidationException e) {
fail("unexpected exception thrown", e);
}
Validator validator = bldr.buildWithDescriptors(seedDescriptors, true);
ValidationResult result = validator.validate(msg);
assertThat(result.isSuccess()).isFalse();
assertThat(result.getViolations().size()).isEqualTo(1);
assertThat(result.getViolations().get(0).toProto().getMessage())
.isEqualTo("all map values must equal 1");
}

// Tests that the seed descriptor list is immutable inside the validator and that if
// a descriptor is removed after the validator is created, validation still works as planned.
@Test
public void testSeedDescriptorsImmutable() {
Map<Integer, Integer> testMap = new HashMap<Integer, Integer>();
public void testSeedDescriptorsImmutable() throws ValidationException {
Map<Integer, Integer> testMap = new HashMap<>();
testMap.put(42, 42);
FieldExpressionMapInt32 msg = FieldExpressionMapInt32.newBuilder().putAllVal(testMap).build();

List<Descriptor> seedDescriptors = new ArrayList<Descriptor>();
List<Descriptor> seedDescriptors = new ArrayList<>();
seedDescriptors.add(msg.getDescriptorForType());

Config cfg = Config.newBuilder().setFailFast(true).build();
try {
Validator validator =
ValidatorFactory.newBuilder().withConfig(cfg).buildWithDescriptors(seedDescriptors, true);
Validator validator =
ValidatorFactory.newBuilder().withConfig(cfg).buildWithDescriptors(seedDescriptors, true);

// Remove descriptor from list after the validator is created to verify validation still works
seedDescriptors.clear();
// Remove descriptor from list after the validator is created to verify validation still works
seedDescriptors.clear();

ValidationResult result = validator.validate(msg);
assertThat(result.isSuccess()).isFalse();
assertThat(result.getViolations().size()).isEqualTo(1);
assertThat(result.getViolations().get(0).toProto().getMessage())
.isEqualTo("all map values must equal 1");
} catch (ValidationException e) {
fail("unexpected exception thrown", e);
}
ValidationResult result = validator.validate(msg);
assertThat(result.isSuccess()).isFalse();
assertThat(result.getViolations().size()).isEqualTo(1);
assertThat(result.getViolations().get(0).toProto().getMessage())
.isEqualTo("all map values must equal 1");
}

// Tests that if a message is attempted to be validated and it wasn't in the initial
// list of seed descriptors AND lazy is disabled, that a message is returned that
// no evaluator is available.
@Test
public void testSeedDescriptorsWithWrongDescriptorAndLazyDisabled() {
Map<Integer, Integer> testMap = new HashMap<Integer, Integer>();
public void testSeedDescriptorsWithWrongDescriptorAndLazyDisabled() throws ValidationException {
Map<Integer, Integer> testMap = new HashMap<>();
testMap.put(42, 42);
FieldExpressionMapInt32 msg = FieldExpressionMapInt32.newBuilder().putAllVal(testMap).build();

List<Descriptor> seedDescriptors = new ArrayList<Descriptor>();
List<Descriptor> seedDescriptors = new ArrayList<>();
ExampleFieldRules wrong = ExampleFieldRules.newBuilder().build();
seedDescriptors.add(wrong.getDescriptorForType());

Config cfg = Config.newBuilder().setFailFast(true).build();
try {
Validator validator =
ValidatorFactory.newBuilder().withConfig(cfg).buildWithDescriptors(seedDescriptors, true);
ValidationResult result = validator.validate(msg);
assertThat(result.isSuccess()).isFalse();
assertThat(result.getViolations().size()).isEqualTo(1);
assertThat(result.getViolations().get(0).toProto().getMessage())
.isEqualTo("No evaluator available for " + msg.getDescriptorForType().getFullName());
} catch (ValidationException e) {
fail("unexpected exception thrown", e);
}
Validator validator =
ValidatorFactory.newBuilder().withConfig(cfg).buildWithDescriptors(seedDescriptors, true);
ValidationResult result = validator.validate(msg);
assertThat(result.isSuccess()).isFalse();
assertThat(result.getViolations().size()).isEqualTo(1);
assertThat(result.getViolations().get(0).toProto().getMessage())
.isEqualTo("No evaluator available for " + msg.getDescriptorForType().getFullName());
}

// Tests that an IllegalStateException is thrown if an empty descriptor list is given
// and lazy is disabled.
@Test
public void testEmptySeedDescriptorsInvalidState() {
List<Descriptor> seedDescriptors = new ArrayList<Descriptor>();
List<Descriptor> seedDescriptors = new ArrayList<>();
assertThatExceptionOfType(IllegalStateException.class)
.isThrownBy(
() -> {
ValidatorFactory.newBuilder().buildWithDescriptors(seedDescriptors, true);
});
() -> ValidatorFactory.newBuilder().buildWithDescriptors(seedDescriptors, true));
}

// Tests that an IllegalStateException is thrown if a null descriptor list is given
// and lazy is disabled.
@Test
public void testNullSeedDescriptorsInvalidState() {
assertThatExceptionOfType(IllegalStateException.class)
.isThrownBy(
() -> {
ValidatorFactory.newBuilder().buildWithDescriptors(null, true);
});
.isThrownBy(() -> ValidatorFactory.newBuilder().buildWithDescriptors(null, true));
}

// Tests that when an empty list of seed descriptors is provided and lazy is enabled
// that the missing message descriptor is successfully built and validation works as planned.
@Test
public void testEmptySeedDescriptorsLazyEnabled() {
Map<Integer, Integer> testMap = new HashMap<Integer, Integer>();
public void testEmptySeedDescriptorsLazyEnabled() throws ValidationException {
Map<Integer, Integer> testMap = new HashMap<>();
testMap.put(42, 42);
FieldExpressionMapInt32 msg = FieldExpressionMapInt32.newBuilder().putAllVal(testMap).build();

List<Descriptor> seedDescriptors = new ArrayList<Descriptor>();
List<Descriptor> seedDescriptors = new ArrayList<>();
Config cfg = Config.newBuilder().setFailFast(true).build();
try {
Validator validator =
ValidatorFactory.newBuilder()
.withConfig(cfg)
.buildWithDescriptors(seedDescriptors, false);
ValidationResult result = validator.validate(msg);
assertThat(result.isSuccess()).isFalse();
assertThat(result.getViolations().size()).isEqualTo(1);
assertThat(result.getViolations().get(0).toProto().getMessage())
.isEqualTo("all map values must equal 1");
} catch (ValidationException e) {
fail("unexpected exception thrown", e);
}
Validator validator =
ValidatorFactory.newBuilder().withConfig(cfg).buildWithDescriptors(seedDescriptors, false);
ValidationResult result = validator.validate(msg);
assertThat(result.isSuccess()).isFalse();
assertThat(result.getViolations().size()).isEqualTo(1);
assertThat(result.getViolations().get(0).toProto().getMessage())
.isEqualTo("all map values must equal 1");
}

// Tests that when a null list of seed descriptors is provided, a NullPointerException
// is thrown with a message that descriptors cannot be null.
@Test
public void testNullSeedDescriptorsLazyEnabled() {
assertThatExceptionOfType(NullPointerException.class)
.isThrownBy(
() -> {
ValidatorFactory.newBuilder().buildWithDescriptors(null, false);
})
.isThrownBy(() -> ValidatorFactory.newBuilder().buildWithDescriptors(null, false))
.withMessageContaining("descriptors must not be null");
;
}

// Tests that the config is applied when building a validator.
@Test
public void testConfigApplied() {
public void testConfigApplied() throws ValidationException {
// Value must be at most 5 characters and must be lowercase alpha chars or numbers.
FieldExpressionMultiple msg = FieldExpressionMultiple.newBuilder().setVal("INVALID").build();

// Set fail fast to true, so we exit after the first validation failure.
Config cfg = Config.newBuilder().setFailFast(true).build();
try {
Validator validator = ValidatorFactory.newBuilder().withConfig(cfg).build();
ValidationResult result = validator.validate(msg);
assertThat(result.isSuccess()).isFalse();
assertThat(result.getViolations().size()).isEqualTo(1);
assertThat(result.getViolations().get(0).toProto().getMessage())
.isEqualTo("value length must be at most 5 characters");
} catch (ValidationException e) {
fail("unexpected exception thrown", e);
}
Validator validator = ValidatorFactory.newBuilder().withConfig(cfg).build();
ValidationResult result = validator.validate(msg);
assertThat(result.isSuccess()).isFalse();
assertThat(result.getViolations().size()).isEqualTo(1);
assertThat(result.getViolations().get(0).toProto().getMessage())
.isEqualTo("value length must be at most 5 characters");
}

// Tests that the config is applied when building a validator with seed descriptors.
@Test
public void testConfigAppliedWithSeedDescriptors() {
public void testConfigAppliedWithSeedDescriptors() throws ValidationException {
// Value must be at most 5 characters and must be lowercase alpha chars or numbers.
FieldExpressionMultiple msg = FieldExpressionMultiple.newBuilder().setVal("INVALID").build();

FieldExpressionMultiple desc = FieldExpressionMultiple.newBuilder().build();
List<Descriptor> seedDescriptors = new ArrayList<Descriptor>();
List<Descriptor> seedDescriptors = new ArrayList<>();
seedDescriptors.add(desc.getDescriptorForType());

// Set fail fast to true, so we exit after the first validation failure.
Config cfg = Config.newBuilder().setFailFast(true).build();
try {
Validator validator =
ValidatorFactory.newBuilder()
.withConfig(cfg)
.buildWithDescriptors(seedDescriptors, false);
ValidationResult result = validator.validate(msg);
assertThat(result.isSuccess()).isFalse();
assertThat(result.getViolations().size()).isEqualTo(1);
assertThat(result.getViolations().get(0).toProto().getMessage())
.isEqualTo("value length must be at most 5 characters");
} catch (ValidationException e) {
fail("unexpected exception thrown", e);
}
Validator validator =
ValidatorFactory.newBuilder().withConfig(cfg).buildWithDescriptors(seedDescriptors, false);
ValidationResult result = validator.validate(msg);
assertThat(result.isSuccess()).isFalse();
assertThat(result.getViolations().size()).isEqualTo(1);
assertThat(result.getViolations().get(0).toProto().getMessage())
.isEqualTo("value length must be at most 5 characters");
}
}