Skip to content

Yet another programming solutions log

Sample bits from programming for the future generations.

Technologies Technologies
  • Algorithms and Data Structures
  • Java Tutorials
  • JUnit Tutorial
  • MongoDB Tutorial
  • Quartz Scheduler Tutorial
  • Spock Framework Tutorial
  • Spring Framework
  • Bash Tutorial
  • Clojure Tutorial
  • Design Patterns
  • Developer’s Tools
  • Productivity
  • About
Expand Search Form

Bean Validation Unit Testing

farenda 2017-01-19 1

In this article we present practical Bean Validation Unit Testing using JUnit. Testing this part is very simple, yet often neglected by many developers. Let’s fix that!

Bean for validation

For testing purposes we’ll use the following Player class, which has a few default constraints on name and score:

package com.farenda.javax.validation;

import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.Size;

public class Player {

    // name have to be 3 chars:
    @Size(min = 3, max = 3)
    private String name;

    // possible score in game:
    @Min(0) @Max(100)
    private int score;

    public Player(String name, int score) {
        this.name = name;
        this.score = score;
    }

    // just for logs
    @Override
    public String toString() {
        return "Player{name='" + name + '\'' + ", score=" + score + '}';
    }
}

Create Bean Validator

The first thing we have to do is to create a Bean Validator. To do that we’ll instantiate a ValidatorFactory that will provide us a Validator before all tests:

package com.farenda.javax.validation;

import org.junit.AfterClass;
import org.junit.BeforeClass;

import javax.validation.Validator;
import javax.validation.ValidatorFactory;

public class PlayerValidationTest {
    private static ValidatorFactory validatorFactory;
    private static Validator validator;

    @BeforeClass
    public static void createValidator() {
        validatorFactory = Validation.buildDefaultValidatorFactory();
        validator = validatorFactory.getValidator();
    }

    //...

Both ValidatorFactory and Validator are thread-safe, so can be reused in many tests. You could even create an abstract test class for Bean Validation tests.
Also let’s dispose the ValidatorFactory after all tests to free any resources possibly allocated by the factory:

@AfterClass
public static void close() {
    validatorFactory.close();
}

Bean Validation Unit Test

Test no bean violations

The first test will exercise the simplest path, namely a valid bean:

@Test
public void shouldHaveNoViolations() {
    //given:
    Player player = new Player("ABC", 44);

    //when:
    Set<ConstraintViolation<Player>> violations
        = validator.validate(player);

    //then:
    assertTrue(violations.isEmpty());
}

Validator always returns non-null set of constraint violations.

Test constraint violation

Now we can unit test our constraints on Player’s name:

@Test
public void shouldDetectInvalidName() {
    //given too short name:
    Player player = new Player("a", 44);

    //when:
    Set<ConstraintViolation<Player>> violations
        = validator.validate(player);

    //then:
    assertEquals(violations.size(), 1);

    ConstraintViolation<Player> violation
        = violations.iterator().next();
    assertEquals("size must be between 3 and 3",
                 violation.getMessage());
    assertEquals("name", violation.getPropertyPath().toString());
    assertEquals("a", violation.getInvalidValue());
}

Complete JUnit Test

Here’s the complete test for easy copy-past:

package com.farenda.javax.validation;

import org.junit.AfterClass;
import org.junit.BeforeClass;
import org.junit.Test;

import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;
import java.util.Set;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;

public class PlayerValidationTest {

    private static ValidatorFactory validatorFactory;
    private static Validator validator;

    @BeforeClass
    public static void createValidator() {
        validatorFactory = Validation.buildDefaultValidatorFactory();
        validator = validatorFactory.getValidator();
    }

    @AfterClass
    public static void close() {
        validatorFactory.close();
    }

    @Test
    public void shouldHaveNoViolations() {
        //given:
        Player player = new Player("ABC", 44);

        //when:
        Set<ConstraintViolation<Player>> violations
                = validator.validate(player);

        //then:
        assertTrue(violations.isEmpty());
    }

    @Test
    public void shouldDetectInvalidName() {
        //given too short name:
        Player player = new Player("a", 44);

        //when:
        Set<ConstraintViolation<Player>> violations
                = validator.validate(player);

        //then:
        assertEquals(violations.size(), 1);

        ConstraintViolation<Player> violation
                = violations.iterator().next();
        assertEquals("size must be between 3 and 3",
                     violation.getMessage());
        assertEquals("name", violation.getPropertyPath().toString());
        assertEquals("a", violation.getInvalidValue());
    }
}

My impression is that many developers thing that testing validation is part of integration or even system testing and usually don’t do that. But here you can see that this really can be done on (almost) unit level and Bean Validation Unit Testing can done by developers together with other unit tests. Which is supercool! :-)

References:

  • How to setup Bean Validation in Java project
  • JUnit Tutorial
Share with the World!
Categories Java Tags bean-validation, java, junit, unit-tests
Previous: Java Bean Validation example
Next: Bean Validation Constraints

Recent Posts

  • Java 8 Date Time concepts
  • Maven dependency to local JAR
  • Caesar cipher in Java
  • Java casting trick
  • Java 8 flatMap practical example
  • Linked List – remove element
  • Linked List – insert element at position
  • Linked List add element at the end
  • Create Java Streams
  • Floyd Cycle detection in Java

Pages

  • About Farenda
  • Algorithms and Data Structures
  • Bash Tutorial
  • Bean Validation Tutorial
  • Clojure Tutorial
  • Design Patterns
  • Java 8 Streams and Lambda Expressions Tutorial
  • Java Basics Tutorial
  • Java Collections Tutorial
  • Java Concurrency Tutorial
  • Java IO Tutorial
  • Java Tutorials
  • Java Util Tutorial
  • Java XML Tutorial
  • JUnit Tutorial
  • MongoDB Tutorial
  • Quartz Scheduler Tutorial
  • Software Developer’s Tools
  • Spock Framework Tutorial
  • Spring Framework

Tags

algorithms bash bean-validation books clojure design-patterns embedmongo exercises git gof gradle groovy hateoas hsqldb i18n java java-basics java-collections java-concurrency java-io java-lang java-time java-util java-xml java8 java8-files junit linux lists log4j logging maven mongodb performance quartz refactoring regex rest slf4j solid spring spring-boot spring-core sql unit-tests

Yet another programming solutions log © 2022

sponsored
We use cookies to ensure that we give you the best experience on our website. If you continue to use this site we will assume that you are happy with it.Ok