CustomValidationsTest.java

/**
 * Licensed to Apereo under one or more contributor license
 * agreements. See the NOTICE file distributed with this work
 * for additional information regarding copyright ownership.
 * Apereo licenses this file to you under the Apache License,
 * Version 2.0 (the "License"); you may not use this file
 * except in compliance with the License.  You may obtain a
 * copy of the License at the following location:
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
/**
 * @author Brad Leege <leege@doit.wisc.edu>
 * Created on 4/25/13 at 3:31 PM
 */
package org.jasig.portlet.blackboardvcportlet.validations.test;

import org.jasig.portlet.blackboardvcportlet.service.SessionForm;
import org.jasig.portlet.blackboardvcportlet.validations.validators.PhoneNumberValidator;
import org.joda.time.DateMidnight;
import org.joda.time.DateTime;
import org.joda.time.LocalTime;
import org.junit.Before;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;

import java.util.Set;

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

public class CustomValidationsTest
{
	private static Logger logger = LoggerFactory.getLogger(CustomValidationsTest.class);
	private static Validator validator;

	@Before
	public void setUp() throws Exception
	{
		validator = Validation.buildDefaultValidatorFactory().getValidator();
	}

	/**
	 * Tests the QuarterHourCheck
	 * The StartMinute should pass, while the EndMinute should trigger a violation.
	 */
	@Test
	public void testQuarterHourCheck()
	{
		logger.info("testQuarterHourCheck() started....");
		SessionForm sessionForm = new SessionForm();
		sessionForm.setSessionName("Test Session");
		sessionForm.setBoundaryTime(15);
		sessionForm.setStartTime(DateTime.now().plusDays(7).withHourOfDay(5).withMinuteOfHour(15).withSecondOfMinute(0).withMillisOfSecond(0));
		sessionForm.setEndTime(sessionForm.getStartTime().withHourOfDay(6).withMinuteOfHour(35).withSecondOfMinute(0).withMillisOfSecond(0));

		Set<ConstraintViolation<SessionForm>> constraintViolations = validator.validate(sessionForm);
		assertEquals(1, constraintViolations.size());
		assertEquals("endMinute", constraintViolations.iterator().next().getPropertyPath().toString());
		logger.info("testQuarterHourCheck() finished.");
	}

	@Test
	public void testSessionStartTimeRangeCheck() throws Exception
	{
		logger.info("testSessionStartTimeRangeCheck() started....");
		SessionForm sessionForm = new SessionForm();
		sessionForm.setSessionName("Test Session");
		sessionForm.setBoundaryTime(15);
		sessionForm.setStartTime(DateTime.now().plusDays(7).withHourOfDay(20).withMinuteOfHour(15).withSecondOfMinute(0).withMillisOfSecond(0));
		sessionForm.setEndTime(sessionForm.getStartTime().withHourOfDay(20).withMinuteOfHour(15).withSecondOfMinute(0).withMillisOfSecond(0));

		Set<ConstraintViolation<SessionForm>> constraintViolations = validator.validate(sessionForm);
		assertEquals(1, constraintViolations.size());

		// Test All Good Scenario
		sessionForm.setEndTime(sessionForm.getStartTime().withHourOfDay(21).withMinuteOfHour(45).withSecondOfMinute(0).withMillisOfSecond(0));
		constraintViolations = validator.validate(sessionForm);
		assertEquals(0, constraintViolations.size());

		logger.info("testSessionStartTimeRangeCheck() finished.");
	}

	/**
	 * Tests theq SessionEndTimeRangeCheck
	 * The first attempt should pass all constraint checks, while the second attempt
	 * should trigger an out of range violation.
	 * @throws Exception
	 */
	@Test
	public void testSessionEndTimeRangeCheck() throws Exception
	{
		logger.info("testSessionEndTimeRangeCheck() started....");
		SessionForm sessionForm = new SessionForm();
		sessionForm.setSessionName("Test Session");
		sessionForm.setBoundaryTime(15);
		sessionForm.setStartTime(DateTime.now().plusDays(7).withHourOfDay(20).withMinuteOfHour(15).withSecondOfMinute(0).withMillisOfSecond(0));
		sessionForm.setEndTime(sessionForm.getStartTime().withHourOfDay(21).withMinuteOfHour(45).withSecondOfMinute(0).withMillisOfSecond(0));

		Set<ConstraintViolation<SessionForm>> constraintViolations = validator.validate(sessionForm);
		assertEquals(0, constraintViolations.size());

		sessionForm.setEndDate(DateMidnight.now().plusDays(2));
		constraintViolations = validator.validate(sessionForm);
		assertEquals(1, constraintViolations.size());

		logger.info("testSessionEndTimeRangeCheck() finished.");
	}

	@Test
	public void testSessionNameCheck() throws Exception
	{
		logger.info("testSessionNameCheck() started....");
		SessionForm sessionForm = new SessionForm();
		sessionForm.setBoundaryTime(15);
		sessionForm.setStartTime(DateTime.now().plusDays(7).withHourOfDay(20).withMinuteOfHour(15).withSecondOfMinute(0).withMillisOfSecond(0));
		sessionForm.setEndTime(sessionForm.getStartTime().withHourOfDay(21).withMinuteOfHour(45).withSecondOfMinute(0).withMillisOfSecond(0));

		// Test The Length Flag
		sessionForm.setSessionName("Test Session Name That Will Be Longer Than Two Hundred And Fifty Five Characters So That It'll Trigger The Validation Error.  Test Session Name That Will Be Longer Than Two Hundred And Fifty Five Characters So That It'll Trigger The Validation Error.  Test Session Name That Will Be Longer Than Two Hundred And Fifty Five Characters So That It'll Trigger The Validation Error.  Test Session Name That Will Be Longer Than Two Hundred And Fifty Five Characters So That It'll Trigger The Validation Error.  Test Session Name That Will Be Longer Than Two Hundred And Fifty Five Characters So That It'll Trigger The Validation Error.  Test Session Name That Will Be Longer Than Two Hundred And Fifty Five Characters So That It'll Trigger The Validation Error.  Test Session Name That Will Be Longer Than Two Hundred And Fifty Five Characters So That It'll Trigger The Validation Error.  Test Session Name That Will Be Longer Than Two Hundred And Fifty Five Characters So That It'll Trigger The Validation Error.");
		Set<ConstraintViolation<SessionForm>> constraintViolations = validator.validate(sessionForm);
		assertEquals(1, constraintViolations.size());
		assertEquals("sessionName", constraintViolations.iterator().next().getPropertyPath().toString());

		// Test the illegal charachters
		sessionForm.setSessionName("Dortmund < Bayern");
		constraintViolations = validator.validate(sessionForm);
		assertEquals(1, constraintViolations.size());
		assertEquals("sessionName", constraintViolations.iterator().next().getPropertyPath().toString());

		// Acceptable Name
		sessionForm.setSessionName("Mia San Mia");
		constraintViolations = validator.validate(sessionForm);
		assertEquals(0, constraintViolations.size());

		logger.info("testSessionNameCheck() finished.");
	}
	
	/**
     * From Blackboard, here are valid values:
     * 1-xxx-xxx-xxxx
     * 1 xxx xxx xxxx
     * 1 (xxx) xxx xxxx
     * 1 (xxx) xxx-xxxx
     * xxx-xxx-xxxx
     * xxx xxx xxxx
     * (xxx) xxx-xxxx
     * xxx.xxx.xxxx
     */
	@Test
	public void testPhoneNumberValidator() throws Exception {
	    PhoneNumberValidator validator = new PhoneNumberValidator();
	    assertTrue(validator.isValid("1-123-123-1232",null));
	    assertTrue(validator.isValid("1 123 123 1232",null));
	    assertTrue(validator.isValid("1 (123) 123 1232",null));
	    assertTrue(validator.isValid("1 (123) 123-1232",null));
	    assertTrue(validator.isValid("123-123-1232",null));
	    assertTrue(validator.isValid("123 123 1232",null));
	    assertTrue(validator.isValid("(123) 123-1232",null));
	    assertTrue(validator.isValid("123.123.1232",null));
	    assertTrue(validator.isValid(null, null));//null is null and not a number
	    
	    assertFalse(validator.isValid("1234567897", null));//noformat
	    assertFalse(validator.isValid("asd asd uiop", null));//letters?
	    
	    assertFalse(validator.isValid("123 456 789", null));//missing last letter
	    assertFalse(validator.isValid("2-123-123-4567", null));//wrong country code, yes, they error on this
	}
}