AbstractRepositoryUnitTests.java

/*
 * Copyright 2014-2017 the original author or authors.
 *
 * Licensed 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
 *
 *      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.
 */
package org.springframework.data.map;

import static org.hamcrest.Matchers.*;
import static org.junit.Assert.*;

import java.util.Arrays;
import java.util.List;

import org.hamcrest.collection.IsCollectionWithSize;
import org.junit.Before;
import org.junit.Test;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageRequest;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.domain.Sort.Direction;
import org.springframework.data.keyvalue.Person;
import org.springframework.data.keyvalue.QPerson;
import org.springframework.data.keyvalue.core.KeyValueOperations;
import org.springframework.data.keyvalue.core.KeyValueTemplate;
import org.springframework.data.keyvalue.repository.KeyValueRepository;
import org.springframework.data.keyvalue.repository.support.KeyValueRepositoryFactory;
import org.springframework.data.repository.CrudRepository;

/**
 * Base class for test cases for repository implementations.
 *
 * @author Christoph Strobl
 * @author Oliver Gierke
 * @author Thomas Darimont
 * @author Mark Paluch
 */
public abstract class AbstractRepositoryUnitTests<T extends AbstractRepositoryUnitTests.PersonRepository> {

	protected static final Person CERSEI = new Person("cersei", 19);
	protected static final Person JAIME = new Person("jaime", 19);
	protected static final Person TYRION = new Person("tyrion", 17);

	protected static List<Person> LENNISTERS = Arrays.asList(CERSEI, JAIME, TYRION);

	protected final QPerson person = QPerson.person;

	protected T repository;
	protected KeyValueRepositoryFactory factory;

	@Before
	public void setup() {

		KeyValueOperations operations = new KeyValueTemplate(new MapKeyValueAdapter());
		KeyValueRepositoryFactory keyValueRepositoryFactory = createKeyValueRepositoryFactory(operations);

		this.repository = getRepository(keyValueRepositoryFactory);
	}

	@Test // DATACMNS-525
	public void findBy() {

		repository.saveAll(LENNISTERS);

		assertThat(repository.findByAge(19), hasItems(CERSEI, JAIME));
	}

	@Test // DATAKV-137
	public void findByFirstname() {

		repository.saveAll(LENNISTERS);

		assertThat(repository.findByFirstname(CERSEI.getFirstname()), hasItems(CERSEI));
		assertThat(repository.findByFirstname(JAIME.getFirstname()), hasItems(JAIME));
	}

	@Test // DATACMNS-525, DATAKV-137
	public void combindedFindUsingAnd() {

		repository.saveAll(LENNISTERS);

		assertThat(repository.findByFirstnameAndAge(JAIME.getFirstname(), 19), hasItem(JAIME));
		assertThat(repository.findByFirstnameAndAge(TYRION.getFirstname(), 17), hasItem(TYRION));
	}

	@Test // DATACMNS-525
	public void findPage() {

		repository.saveAll(LENNISTERS);

		Page<Person> page = repository.findByAge(19, PageRequest.of(0, 1));
		assertThat(page.hasNext(), is(true));
		assertThat(page.getTotalElements(), is(2L));
		assertThat(page.getContent(), IsCollectionWithSize.hasSize(1));

		Page<Person> next = repository.findByAge(19, page.nextPageable());
		assertThat(next.hasNext(), is(false));
		assertThat(next.getTotalElements(), is(2L));
		assertThat(next.getContent(), IsCollectionWithSize.hasSize(1));
	}

	@Test // DATACMNS-525
	public void findByConnectingOr() {

		repository.saveAll(LENNISTERS);

		assertThat(repository.findByAgeOrFirstname(19, TYRION.getFirstname()), hasItems(CERSEI, JAIME, TYRION));
	}

	@Test // DATACMNS-525, DATAKV-137
	public void singleEntityExecution() {

		repository.saveAll(LENNISTERS);

		assertThat(repository.findByAgeAndFirstname(TYRION.getAge(), TYRION.getFirstname()), is(TYRION));
		assertThat(repository.findByAgeAndFirstname(CERSEI.getAge(), CERSEI.getFirstname()), is(CERSEI));
	}

	@Test // DATACMNS-525
	public void findAllShouldRespectSort() {

		repository.saveAll(LENNISTERS);

		assertThat(
				repository.findAll(Sort.by(new Sort.Order(Direction.ASC, "age"), new Sort.Order(Direction.DESC, "firstname"))),
				contains(TYRION, JAIME, CERSEI));
	}

	@Test // DATACMNS-525
	public void derivedFinderShouldRespectSort() {

		repository.saveAll(LENNISTERS);

		List<Person> result = repository.findByAgeGreaterThanOrderByAgeAscFirstnameDesc(2);

		assertThat(result, contains(TYRION, JAIME, CERSEI));
	}

	@Test // DATAKV-121
	public void projectsResultToInterface() {

		repository.saveAll(LENNISTERS);

		List<PersonSummary> result = repository.findByAgeGreaterThan(0, Sort.by("firstname"));

		assertThat(result, hasSize(3));
		assertThat(result.get(0).getFirstname(), is(CERSEI.getFirstname()));
	}

	@Test // DATAKV-121
	public void projectsResultToDynamicInterface() {

		repository.saveAll(LENNISTERS);

		List<PersonSummary> result = repository.findByAgeGreaterThan(0, Sort.by("firstname"), PersonSummary.class);

		assertThat(result, hasSize(3));
		assertThat(result.get(0).getFirstname(), is(CERSEI.getFirstname()));
	}

	@Test // DATAKV-169
	public void findsByValueInCollectionCorrectly() {

		repository.saveAll(LENNISTERS);

		List<Person> result = repository.findByFirstnameIn(Arrays.asList(CERSEI.getFirstname(), JAIME.getFirstname()));

		assertThat(result, hasSize(2));
		assertThat(result, is(containsInAnyOrder(CERSEI, JAIME)));
	}

	@Test // DATAKV-169
	public void findsByValueInCollectionCorrectlyWhenTargetPathContainsNullValue() {

		repository.saveAll(LENNISTERS);
		repository.save(new Person(null, 10));

		List<Person> result = repository.findByFirstnameIn(Arrays.asList(CERSEI.getFirstname(), JAIME.getFirstname()));

		assertThat(result, hasSize(2));
		assertThat(result, is(containsInAnyOrder(CERSEI, JAIME)));
	}

	@Test // DATAKV-169
	public void findsByValueInCollectionCorrectlyWhenTargetPathAndCollectionContainNullValue() {

		repository.saveAll(LENNISTERS);

		Person personWithNullAsFirstname = new Person(null, 10);
		repository.save(personWithNullAsFirstname);

		List<Person> result = repository
				.findByFirstnameIn(Arrays.asList(CERSEI.getFirstname(), JAIME.getFirstname(), null));

		assertThat(result, hasSize(3));
		assertThat(result, is(containsInAnyOrder(CERSEI, JAIME, personWithNullAsFirstname)));
	}

	protected KeyValueRepositoryFactory createKeyValueRepositoryFactory(KeyValueOperations operations) {
		return new KeyValueRepositoryFactory(operations);
	}

	protected abstract T getRepository(KeyValueRepositoryFactory factory);

	public interface PersonRepository extends CrudRepository<Person, String>, KeyValueRepository<Person, String> {

		List<Person> findByAge(int age);

		List<Person> findByFirstname(String firstname);

		List<Person> findByFirstnameAndAge(String firstname, int age);

		Page<Person> findByAge(int age, Pageable page);

		List<Person> findByAgeOrFirstname(int age, String firstname);

		Person findByAgeAndFirstname(int age, String firstname);

		List<Person> findByAgeGreaterThanOrderByAgeAscFirstnameDesc(int age);

		List<PersonSummary> findByAgeGreaterThan(int age, Sort sort);

		<T> List<T> findByAgeGreaterThan(int age, Sort sort, Class<T> projectionType);

		List<Person> findByFirstnameIn(List<String> firstname);
	}

	interface PersonSummary {

		String getFirstname();
	}
}