AbstractAuditingViaJavaConfigRepositoriesTests.java

/*
 * Copyright 2013-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.config;

import static org.hamcrest.CoreMatchers.*;
import static org.junit.Assert.*;
import static org.mockito.Mockito.*;

import java.time.LocalDateTime;
import java.time.ZoneId;
import java.util.Date;
import java.util.List;
import java.util.Optional;
import java.util.concurrent.TimeUnit;

import javax.persistence.EntityManager;

import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mockito;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import org.springframework.data.domain.AuditorAware;
import org.springframework.data.jpa.domain.sample.AuditableUser;
import org.springframework.data.jpa.repository.sample.AuditableUserRepository;
import org.springframework.data.jpa.repository.sample.SampleEvaluationContextExtension;
import org.springframework.data.jpa.repository.sample.SampleEvaluationContextExtension.SampleSecurityContextHolder;
import org.springframework.data.jpa.util.FixedDate;
import org.springframework.data.repository.query.spi.EvaluationContextExtension;
import org.springframework.test.annotation.DirtiesContext;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.transaction.annotation.Transactional;

/**
 * Integration tests for auditing via Java config.
 * 
 * @author Thomas Darimont
 * @author Oliver Gierke
 */
@RunWith(SpringJUnit4ClassRunner.class)
@Transactional
@DirtiesContext
public abstract class AbstractAuditingViaJavaConfigRepositoriesTests {

	@Autowired AuditableUserRepository auditableUserRepository;
	@Autowired AuditorAware<AuditableUser> auditorAware;
	AuditableUser auditor;

	@Autowired EntityManager em;

	@Configuration
	@Import(InfrastructureConfig.class)
	@EnableJpaRepositories(basePackageClasses = AuditableUserRepository.class)
	static class TestConfig {
		@Bean
		EvaluationContextExtension sampleEvaluationContextExtension() {
			return new SampleEvaluationContextExtension();
		}
	}

	@Before
	public void setup() {

		AuditableUser auditor = new AuditableUser(null);
		auditor.setFirstname("auditor");

		when(this.auditorAware.getCurrentAuditor()).thenReturn(Optional.empty());
		this.auditor = this.auditableUserRepository.save(auditor);
		when(this.auditorAware.getCurrentAuditor()).thenReturn(Optional.of(this.auditor));
	}

	@After
	public void teardown() {
		Mockito.reset(this.auditorAware);
	}

	@Test
	public void basicAuditing() throws Exception {

		AuditableUser user = new AuditableUser(null);
		user.setFirstname("user");

		AuditableUser savedUser = auditableUserRepository.save(user);
		TimeUnit.MILLISECONDS.sleep(10);

		assertThat(savedUser.getCreatedDate(), is(notNullValue()));
		assertThat(savedUser.getCreatedDate().get().isBefore(LocalDateTime.now()), is(true));

		AuditableUser createdBy = savedUser.getCreatedBy().get();
		assertThat(createdBy, is(notNullValue()));
		assertThat(createdBy.getFirstname(), is(this.auditor.getFirstname()));
	}

	@Test // DATAJPA-382
	public void shouldAllowUseOfDynamicSpelParametersInUpdateQueries() {

		AuditableUser oliver = auditableUserRepository.save(new AuditableUser(null, "oliver"));
		AuditableUser christoph = auditableUserRepository.save(new AuditableUser(null, "christoph"));
		AuditableUser thomas = auditableUserRepository.save(new AuditableUser(null, "thomas"));

		em.detach(oliver);
		em.detach(christoph);
		em.detach(thomas);
		em.detach(auditor);

		FixedDate.INSTANCE.setDate(new Date());

		SampleSecurityContextHolder.getCurrent().setPrincipal(thomas);
		auditableUserRepository.updateAllNamesToUpperCase();

		// DateTime now = new DateTime(FixedDate.INSTANCE.getDate());
		LocalDateTime now = LocalDateTime.ofInstant(FixedDate.INSTANCE.getDate().toInstant(), ZoneId.systemDefault());
		List<AuditableUser> users = auditableUserRepository.findAll();

		for (AuditableUser user : users) {

			assertThat(user.getFirstname(), is(user.getFirstname().toUpperCase()));
			assertThat(user.getLastModifiedBy(), is(Optional.of(thomas)));
			assertThat(user.getLastModifiedDate(), is(Optional.of(now)));
		}
	}
}