RedisAtomicDoubleTests.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.redis.support.atomic;

import static org.hamcrest.CoreMatchers.*;
import static org.junit.Assert.*;
import static org.junit.Assume.*;

import java.util.Collection;
import java.util.Date;
import java.util.concurrent.TimeUnit;

import org.junit.After;
import org.junit.AfterClass;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;
import org.junit.runners.Parameterized.Parameters;
import org.springframework.dao.DataRetrievalFailureException;
import org.springframework.data.redis.ConnectionFactoryTracker;
import org.springframework.data.redis.RedisTestProfileValueSource;
import org.springframework.data.redis.connection.ConnectionUtils;
import org.springframework.data.redis.connection.RedisConnection;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.serializer.GenericToStringSerializer;
import org.springframework.data.redis.serializer.StringRedisSerializer;

/**
 * Integration test of {@link RedisAtomicDouble}
 *
 * @author Jennifer Hickey
 * @author Thomas Darimont
 * @author Christoph Strobl
 * @author Mark Paluch
 */
@RunWith(Parameterized.class)
public class RedisAtomicDoubleTests extends AbstractRedisAtomicsTests {

	private RedisAtomicDouble doubleCounter;
	private RedisConnectionFactory factory;
	private RedisTemplate<String, Double> template;

	public RedisAtomicDoubleTests(RedisConnectionFactory factory) {

		this.doubleCounter = new RedisAtomicDouble(getClass().getSimpleName() + ":double", factory);
		this.factory = factory;

		this.template = new RedisTemplate<String, Double>();
		this.template.setConnectionFactory(factory);
		this.template.setKeySerializer(new StringRedisSerializer());
		this.template.setValueSerializer(new GenericToStringSerializer<Double>(Double.class));
		this.template.afterPropertiesSet();

		ConnectionFactoryTracker.add(factory);
	}

	@Before
	public void setUp() {
		// Most atomic Double ops involve incrByFloat, which is new as of 2.6
		assumeTrue(RedisTestProfileValueSource.matches("redisVersion", "2.6"));
	}

	@After
	public void stop() {
		RedisConnection connection = factory.getConnection();
		connection.flushDb();
		connection.close();
	}

	@AfterClass
	public static void cleanUp() {
		ConnectionFactoryTracker.cleanUp();
	}

	@Parameters
	public static Collection<Object[]> testParams() {
		return AtomicCountersParam.testParams();
	}

	@Test
	public void testCheckAndSet() {

		doubleCounter.set(0);
		assertFalse(doubleCounter.compareAndSet(1.2, 10.6));
		assertTrue(doubleCounter.compareAndSet(0, 10.6));
		assertTrue(doubleCounter.compareAndSet(10.6, 0));
	}

	@Test
	public void testIncrementAndGet() throws Exception {
		assumeTrue(!(ConnectionUtils.isJedis(factory)));
		doubleCounter.set(0);
		assertEquals(1.0, doubleCounter.incrementAndGet(), 0);
	}

	@Test
	public void testAddAndGet() throws Exception {
		assumeTrue(!(ConnectionUtils.isJedis(factory)));
		doubleCounter.set(0);
		double delta = 1.3;
		assertEquals(delta, doubleCounter.addAndGet(delta), .0001);
	}

	@Test
	public void testDecrementAndGet() throws Exception {
		assumeTrue(!(ConnectionUtils.isJedis(factory)));
		doubleCounter.set(1);
		assertEquals(0, doubleCounter.decrementAndGet(), 0);
	}

	@Test
	public void testGetAndSet() {
		doubleCounter.set(3.4);
		assertEquals(3.4, doubleCounter.getAndSet(1.2), 0);
		assertEquals(1.2, doubleCounter.get(), 0);
	}

	@Test
	public void testGetAndIncrement() {
		assumeTrue(!(ConnectionUtils.isJedis(factory)));
		doubleCounter.set(2.3);
		assertEquals(2.3, doubleCounter.getAndIncrement(), 0);
		assertEquals(3.3, doubleCounter.get(), .0001);
	}

	@Test
	public void testGetAndDecrement() {
		assumeTrue(!(ConnectionUtils.isJedis(factory)));
		doubleCounter.set(0.5);
		assertEquals(0.5, doubleCounter.getAndDecrement(), 0);
		assertEquals(-0.5, doubleCounter.get(), .0001);
	}

	@Test
	public void testGetAndAdd() {
		assumeTrue(!(ConnectionUtils.isJedis(factory)));
		doubleCounter.set(0.5);
		assertEquals(0.5, doubleCounter.getAndAdd(0.7), 0);
		assertEquals(1.2, doubleCounter.get(), .0001);
	}

	@Test
	public void testExpire() {
		assertTrue(doubleCounter.expire(1, TimeUnit.SECONDS));
		assertTrue(doubleCounter.getExpire() > 0);
	}

	@Test
	public void testExpireAt() {

		doubleCounter.set(7.8);
		assertTrue(doubleCounter.expireAt(new Date(System.currentTimeMillis() + 10000)));
		assertTrue(doubleCounter.getExpire() > 0);
	}

	@Test
	public void testRename() {
		doubleCounter.set(5.6);
		doubleCounter.rename("foodouble");
		assertEquals("5.6", new String(factory.getConnection().get("foodouble".getBytes())));
		assertNull(factory.getConnection().get((getClass().getSimpleName() + ":double").getBytes()));
	}

	@Test // DATAREDIS-317
	public void testShouldThrowExceptionIfRedisAtomicDoubleIsUsedWithRedisTemplateAndNoKeySerializer() {

		expectedException.expect(IllegalArgumentException.class);
		expectedException.expectMessage("a valid key serializer in template is required");

		new RedisAtomicDouble("foo", new RedisTemplate<String, Double>());
	}

	@Test // DATAREDIS-317
	public void testShouldThrowExceptionIfRedisAtomicDoubleIsUsedWithRedisTemplateAndNoValueSerializer() {

		expectedException.expect(IllegalArgumentException.class);
		expectedException.expectMessage("a valid value serializer in template is required");

		RedisTemplate<String, Double> template = new RedisTemplate<String, Double>();
		template.setKeySerializer(new StringRedisSerializer());
		new RedisAtomicDouble("foo", template);
	}

	@Test // DATAREDIS-317
	public void testShouldBeAbleToUseRedisAtomicDoubleWithProperlyConfiguredRedisTemplate() {

		RedisAtomicDouble ral = new RedisAtomicDouble("DATAREDIS-317.atomicDouble", template);
		ral.set(32.23);

		assertThat(ral.get(), is(32.23));
	}

	@Test // DATAREDIS-469
	public void getThrowsExceptionWhenKeyHasBeenRemoved() {

		expectedException.expect(DataRetrievalFailureException.class);
		expectedException.expectMessage("'test' seems to no longer exist");

		// setup double
		RedisAtomicDouble test = new RedisAtomicDouble("test", factory, 1);
		assertThat(test.get(), equalTo(1D)); // this passes

		template.delete("test");

		test.get();
	}

	@Test // DATAREDIS-469
	public void getAndSetReturnsZeroWhenKeyHasBeenRemoved() {

		// setup double
		RedisAtomicDouble test = new RedisAtomicDouble("test", factory, 1);
		assertThat(test.get(), equalTo(1D)); // this passes

		template.delete("test");

		assertThat(test.getAndSet(2), is(0D));
	}
}