EntityGraphRepositoryMethodsIntegrationTests.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.jpa.repository;

import static org.hamcrest.Matchers.*;
import static org.junit.Assert.*;
import static org.springframework.data.jpa.support.EntityManagerTestUtils.*;

import java.util.List;

import javax.persistence.EntityManager;
import javax.persistence.Persistence;
import javax.persistence.PersistenceUtil;

import org.junit.Assume;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageRequest;
import org.springframework.data.jpa.domain.sample.QUser;
import org.springframework.data.jpa.domain.sample.Role;
import org.springframework.data.jpa.domain.sample.User;
import org.springframework.data.jpa.repository.sample.RepositoryMethodsWithEntityGraphConfigRepository;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.transaction.annotation.Transactional;

/**
 * Integration tests for RepositoryMethodsWithEntityGraphConfigJpaRepository.
 * 
 * @author Thomas Darimont
 * @author Oliver Gierke
 * @author Jocelyn Ntakpe
 * @author Christoph Strobl
 */
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration("classpath:config/namespace-autoconfig-context.xml")
@Transactional
public class EntityGraphRepositoryMethodsIntegrationTests {

	@Autowired EntityManager em;
	@Autowired RepositoryMethodsWithEntityGraphConfigRepository repository;

	User tom;
	User ollie;
	User christoph;
	Role role;

	PersistenceUtil util = Persistence.getPersistenceUtil();

	@Before
	public void setup() {

		tom = new User("Thomas", "Darimont", "tdarimont@example.org");
		ollie = new User("Oliver", "Gierke", "ogierke@example.org");
		christoph = new User("Christoph", "Strobl", "cstrobl@example.org");

		role = new Role("Developer");
		em.persist(role);
		tom.getRoles().add(role);
		tom = repository.save(tom);

		ollie = repository.save(ollie);
		tom.getColleagues().add(ollie);

		christoph.addRole(role);
		christoph = repository.save(christoph);

		ollie.getColleagues().add(christoph);
		repository.save(ollie);
	}

	@Test // DATAJPA-612
	public void shouldRespectConfiguredJpaEntityGraph() {

		Assume.assumeTrue(currentEntityManagerIsAJpa21EntityManager(em));
		em.flush();
		em.clear();

		List<User> result = repository.findAll();

		assertThat(result.size(), is(3));
		assertThat(util.isLoaded(result.get(0), "roles"), is(true));
		assertThat(result.get(0), is(tom));
	}

	@Test // DATAJPA-689
	public void shouldRespectConfiguredJpaEntityGraphInFindOne() {

		Assume.assumeTrue(currentEntityManagerIsAJpa21EntityManager(em));
		em.flush();
		em.clear();

		User user = repository.findById(tom.getId()).get();

		assertThat(user, is(notNullValue()));
		assertThat("colleages should be fetched with 'user.detail' fetchgraph", util.isLoaded(user, "colleagues"),
				is(true));
	}

	@Test // DATAJPA-696
	public void shouldRespectInferFetchGraphFromMethodName() {

		Assume.assumeTrue(currentEntityManagerIsAJpa21EntityManager(em));
		em.flush();
		em.clear();

		User user = repository.getOneWithDefinedEntityGraphById(tom.getId());

		assertThat(user, is(notNullValue()));
		assertThat("colleages should be fetched with 'user.detail' fetchgraph", util.isLoaded(user, "colleagues"),
				is(true));
	}

	@Test // DATAJPA-696
	public void shouldRespectDynamicFetchGraphForGetOneWithAttributeNamesById() {

		Assume.assumeTrue(currentEntityManagerIsAJpa21EntityManager(em));
		em.flush();
		em.clear();

		User user = repository.getOneWithAttributeNamesById(tom.getId());

		assertThat(user, is(notNullValue()));

		assertThat("colleages should be fetched with 'user.detail' fetchgraph", util.isLoaded(user, "colleagues"),
				is(true));
		assertThat(util.isLoaded(user, "colleagues"), is(true));

		for (User colleague : user.getColleagues()) {
			assertThat(util.isLoaded(colleague, "roles"), is(true));
		}
	}

	@Test // DATAJPA-790, DATAJPA-1087
	public void shouldRespectConfiguredJpaEntityGraphWithPaginationAndQueryDslPredicates() {

		Assume.assumeTrue(currentEntityManagerIsAJpa21EntityManager(em));
		em.flush();
		em.clear();

		Page<User> page = repository.findAll(QUser.user.firstname.isNotNull(), PageRequest.of(0, 100));
		List<User> result = page.getContent();

		assertThat(result.size(), is(3));
		assertThat(util.isLoaded(result.get(0).getRoles()), is(true));
		assertThat(result.get(0), is(tom));
	}

	@Test // DATAJPA-1041
	public void shouldRespectNamedEntitySubGraph() {

		Assume.assumeTrue(currentEntityManagerIsAJpa21EntityManager(em));

		em.flush();
		em.clear();

		User user = repository.findOneWithMultipleSubGraphsUsingNamedEntityGraphById(tom.getId());

		assertThat(user, is(notNullValue()));

		assertThat("colleagues on root should have been fetched by named 'User.colleagues' subgraph declaration",
				util.isLoaded(user, "colleagues"), is(true));

		for (User colleague : user.getColleagues()) {
			assertThat(util.isLoaded(colleague, "colleagues"), is(true));
			assertThat(util.isLoaded(colleague, "roles"), is(true));
		}
	}

	@Test // DATAJPA-1041
	public void shouldRespectMultipleSubGraphForSameAttributeWithDynamicFetchGraph() {

		Assume.assumeTrue(currentEntityManagerIsAJpa21EntityManager(em));

		em.flush();
		em.clear();

		User user = repository.findOneWithMultipleSubGraphsById(tom.getId());

		assertThat(user, is(notNullValue()));

		assertThat("colleagues on root should have been fetched by dynamic subgraph declaration",
				util.isLoaded(user, "colleagues"), is(true));

		for (User colleague : user.getColleagues()) {
			assertThat(util.isLoaded(colleague, "colleagues"), is(true));
			assertThat(util.isLoaded(colleague, "roles"), is(true));
		}
	}

	@Test // DATAJPA-1041, DATAJPA-1075
	public void shouldCreateDynamicGraphWithMultipleLevelsOfSubgraphs() {

		Assume.assumeTrue(currentEntityManagerIsAJpa21EntityManager(em));
		em.flush();
		em.clear();

		User user = repository.findOneWithDeepGraphById(tom.getId());

		assertThat(user, is(notNullValue()));
		assertThat("Colleagues on root should have been fetched by dynamic subgraph declaration",
				Persistence.getPersistenceUtil().isLoaded(user, "colleagues"), is(true));

		for (User colleague : user.getColleagues()) {

			assertThat(Persistence.getPersistenceUtil().isLoaded(colleague, "colleagues"), is(true));
			assertThat(Persistence.getPersistenceUtil().isLoaded(colleague, "roles"), is(true));

			for (User colleagueOfColleague : colleague.getColleagues()) {

				assertThat(Persistence.getPersistenceUtil().isLoaded(colleagueOfColleague, "roles"), is(true));
				assertThat(Persistence.getPersistenceUtil().isLoaded(colleagueOfColleague, "colleagues"), is(false));
			}
		}
	}
}