Fix locking DynamoCacheWriter and improve test coverage

derXear · derXear · commit b3be2e03bf5a · 2019-09-09T11:19:30.000+02:00
diff --git a/src/main/java/com/dasburo/spring/cache/dynamo/DefaultDynamoCacheWriter.java b/src/main/java/com/dasburo/spring/cache/dynamo/DefaultDynamoCacheWriter.java
@@ -126,9 +126,7 @@ public void remove(String name, String key) {
     Assert.notNull(key, "Key must not be null!");
 
     execute(name, connection -> {
-      dynamoTemplate.deleteItem(new DeleteItemRequest()
-        .withTableName(name)
-        .withKey(Collections.singletonMap(ATTRIBUTE_KEY, new AttributeValue(key))));
+      removeInternal(name, key);
       return "OK";
     });
   }
@@ -226,19 +224,29 @@ private void putInternal(String name, String key, @Nullable byte[] value, @Nulla
     dynamoTemplate.putItem(putItemRequest);
   }
 
+  private void removeInternal(String name, String key) {
+    dynamoTemplate.deleteItem(new DeleteItemRequest()
+      .withTableName(name)
+      .withKey(Collections.singletonMap(ATTRIBUTE_KEY, new AttributeValue(key))));
+  }
+
   private void doLock(String name) {
     // TODO should a ttl be provided for locking?
-    putInternal(name, createCacheLockKey(name), new byte[0], null);
+    putInternal(name, createCacheLockKey(name), "1".getBytes(), null);
   }
 
   private void doUnlock(String name) {
-    remove(name, createCacheLockKey(name));
+    try {
+      removeInternal(name, createCacheLockKey(name));
+    } catch (ResourceNotFoundException e) {
+      // ignore
+    }
   }
 
   private boolean doCheckLock(String name) {
     try {
       getInternal(name, createCacheLockKey(name));
-    } catch (NoSuchElementException e) {
+    } catch (NoSuchElementException | ResourceNotFoundException e) {
       return false;
     }
     return true;
diff --git a/src/main/java/com/dasburo/spring/cache/dynamo/DynamoCacheBuilder.java b/src/main/java/com/dasburo/spring/cache/dynamo/DynamoCacheBuilder.java
@@ -44,7 +44,7 @@ protected DynamoCacheBuilder(final String cacheName, final AmazonDynamoDB dynamo
     Assert.hasText(cacheName, "'cacheName' must not be null and must contain at least one non-whitespace character.");
 
     this.cacheName = cacheName;
-    this.writer = new DefaultDynamoCacheWriter(dynamoTemplate);
+    this.writer = DynamoCacheWriter.nonLockingDynamoCacheWriter(dynamoTemplate);
     this.cacheConfig = DynamoCacheConfiguration.defaultCacheConfig();
   }
 
@@ -124,4 +124,16 @@ public DynamoCacheBuilder withSerializer(DynamoSerializer serializer) {
     return this;
   }
 
+  /**
+   * Give a {@link DynamoCacheWriter} to the cache to be built.
+   * Defaults to {@link DefaultDynamoCacheWriter}.
+   *
+   * @param writer a writer doing the actual cache operations.
+   * @return this buzilder for chaining.
+   */
+  public DynamoCacheBuilder withWriter(DynamoCacheWriter writer) {
+    this.writer = writer;
+    return this;
+  }
+
 }
diff --git a/src/main/java/com/dasburo/spring/cache/dynamo/autoconfigure/DynamoCacheAutoConfiguration.java b/src/main/java/com/dasburo/spring/cache/dynamo/autoconfigure/DynamoCacheAutoConfiguration.java
@@ -17,6 +17,8 @@
 import com.amazonaws.services.dynamodbv2.AmazonDynamoDB;
 import com.dasburo.spring.cache.dynamo.DynamoCacheBuilder;
 import com.dasburo.spring.cache.dynamo.DynamoCacheManager;
+import com.dasburo.spring.cache.dynamo.DynamoCacheWriter;
+import com.dasburo.spring.cache.dynamo.serializer.StringSerializer;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
@@ -77,6 +79,8 @@ private List<DynamoCacheBuilder> dynamoCacheBuilders() {
             .withFlushOnBoot(dynamoCacheProperties.isFlushOnBoot())
             .withReadCapacityUnit(dynamoCacheProperties.getReadCapacityUnits())
             .withWriteCapacityUnit(dynamoCacheProperties.getWriteCapacityUnits())
+            .withSerializer(new StringSerializer())
+            .withWriter(DynamoCacheWriter.nonLockingDynamoCacheWriter(dynamoTemplate))
         );
       }
     }
diff --git a/src/main/java/com/dasburo/spring/cache/dynamo/serializer/SerializationUtils.java b/src/main/java/com/dasburo/spring/cache/dynamo/serializer/SerializationUtils.java
@@ -18,8 +18,6 @@
 
 public abstract class SerializationUtils {
 
-  static final byte[] EMPTY_ARRAY = new byte[0];
-
   private SerializationUtils() {
     throw new IllegalStateException("Utility class");
   }
diff --git a/src/test/java/com/dasburo/spring/cache/dynamo/DynamoCacheTest.java b/src/test/java/com/dasburo/spring/cache/dynamo/DynamoCacheTest.java
@@ -14,8 +14,8 @@
  */
 package com.dasburo.spring.cache.dynamo;
 
+import com.dasburo.spring.cache.dynamo.helper.Address;
 import com.dasburo.spring.cache.dynamo.serializer.Jackson2JsonSerializer;
-import com.dasburo.spring.cache.dynamo.serializer.StringSerializer;
 import org.junit.Assert;
 import org.junit.Before;
 import org.junit.ClassRule;
@@ -40,7 +40,7 @@
 public class DynamoCacheTest {
 
   private static final String CACHE_NAME = "cache";
-  private static final Duration TTL = Duration.ZERO;
+  private static final Duration TTL = Duration.ofSeconds(10);
 
   @ClassRule
   public static TestDbCreationRule dynamoDB = new TestDbCreationRule();
@@ -55,6 +55,7 @@ public void setup() {
     writer = spy(writer);
 
     DynamoCacheConfiguration config = DynamoCacheConfiguration.defaultCacheConfig();
+    config.setTtl(TTL);
     config.setFlushOnBoot(true);
 
     cache = new DynamoCache(CACHE_NAME, writer, config);
diff --git a/src/test/java/com/dasburo/spring/cache/dynamo/TestConfiguration.java b/src/test/java/com/dasburo/spring/cache/dynamo/TestConfiguration.java
@@ -61,7 +61,7 @@ public AmazonDynamoDB amazonDynamoDB(AWSCredentialsProvider amazonAWSCredentials
 
   @Bean
   public DynamoCacheWriter dynamoCacheWriter(AmazonDynamoDB amazonDynamoDB) {
-    return new DefaultDynamoCacheWriter(amazonDynamoDB);
+    return DynamoCacheWriter.lockingDynamoCacheWriter(amazonDynamoDB);
   }
 
 }
diff --git a/src/test/java/com/dasburo/spring/cache/dynamo/autoconfigure/DynamoCacheAutoConfigurationTest.java b/src/test/java/com/dasburo/spring/cache/dynamo/autoconfigure/DynamoCacheAutoConfigurationTest.java
@@ -37,6 +37,8 @@ public class DynamoCacheAutoConfigurationTest extends UnitTestBase {
   private static final String CACHE_NAME = "cache";
   private static final boolean FLUSH_ON_BOOT = false;
   private static final Duration TTL = Duration.ofSeconds(30);
+  private static final Long READ_CAPACITY_UNITS = 1L;
+  private static final Long WRITE_CAPACITY_UNITS = 1L;
 
   @ClassRule
   public static TestDbCreationRule dynamoDB = new TestDbCreationRule();
@@ -50,7 +52,9 @@ public void load() {
       new Class<?>[]{DynamoCacheAutoConfiguration.class},
       "spring.cache.dynamo.caches[0].ttl:" + TTL,
       "spring.cache.dynamo.caches[0].cacheName:" + CACHE_NAME,
-      "spring.cache.dynamo.caches[0].flushOnBoot:" + FLUSH_ON_BOOT
+      "spring.cache.dynamo.caches[0].flushOnBoot:" + FLUSH_ON_BOOT,
+      "spring.cache.dynamo.caches[0].readCapacityUnits:" + READ_CAPACITY_UNITS,
+      "spring.cache.dynamo.caches[0].writeCapacityUnits:" + WRITE_CAPACITY_UNITS
     );
   }
 
diff --git a/src/test/java/com/dasburo/spring/cache/dynamo/helper/Address.java b/src/test/java/com/dasburo/spring/cache/dynamo/helper/Address.java
@@ -12,7 +12,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.dasburo.spring.cache.dynamo;
+package com.dasburo.spring.cache.dynamo.helper;
 
 import java.io.Serializable;
 
diff --git a/src/test/java/com/dasburo/spring/cache/dynamo/helper/Company.java b/src/test/java/com/dasburo/spring/cache/dynamo/helper/Company.java
@@ -12,7 +12,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.dasburo.spring.cache.dynamo;
+package com.dasburo.spring.cache.dynamo.helper;
 
 import java.io.Serializable;
 
diff --git a/src/test/java/com/dasburo/spring/cache/dynamo/helper/NotSerializeable.java b/src/test/java/com/dasburo/spring/cache/dynamo/helper/NotSerializeable.java
@@ -0,0 +1,18 @@
+/*
+ * Copyright 2019 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
+ *      https://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 com.dasburo.spring.cache.dynamo.helper;
+
+public class NotSerializeable {
+}
diff --git a/src/test/java/com/dasburo/spring/cache/dynamo/serializer/GZipSerializerTest.java b/src/test/java/com/dasburo/spring/cache/dynamo/serializer/GZipSerializerTest.java
@@ -1,3 +1,17 @@
+/*
+ * Copyright 2019 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
+ *      https://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 com.dasburo.spring.cache.dynamo.serializer;
 
 import org.junit.Assert;
diff --git a/src/test/java/com/dasburo/spring/cache/dynamo/serializer/Jackson2JsonSerializerTest.java b/src/test/java/com/dasburo/spring/cache/dynamo/serializer/Jackson2JsonSerializerTest.java
@@ -1,13 +1,35 @@
+/*
+ * Copyright 2019 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
+ *      https://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 com.dasburo.spring.cache.dynamo.serializer;
 
-import com.dasburo.spring.cache.dynamo.Address;
-import com.dasburo.spring.cache.dynamo.Company;
+import com.dasburo.spring.cache.dynamo.helper.Address;
+import com.dasburo.spring.cache.dynamo.helper.Company;
+import com.dasburo.spring.cache.dynamo.helper.NotSerializeable;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
 import org.junit.Assert;
 import org.junit.Before;
 import org.junit.Test;
 
 import java.util.Arrays;
 
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+
 
 public class Jackson2JsonSerializerTest {
 
@@ -34,6 +56,11 @@ public void testJackson2JsonSerializer_ShouldReturnNullWhenDeserializingEmptyByt
     Assert.assertNull(serializer.deserialize(new byte[0]));
   }
 
+  @Test(expected = SerializationException.class)
+  public void testSerializableSerializer_ShouldThrowExceptionWhenSerializingNonSerializableObject() {
+    serializer.serialize(new NotSerializeable());
+  }
+
   @Test(expected = SerializationException.class)
   public void testJackson2JsonSerilizer_ShouldThrowExceptionWhenDeserializingInvalidByteArray() {
     Company company = new Company("company", "IT", 2019, new Address("street", 1));
@@ -48,4 +75,13 @@ public void testJackson2JsonSerializer_ThrowsExceptionWhenSettingNullObjectMappe
     serializer.setObjectMapper(null);
   }
 
+  @Test
+  public void testJackson2JsonSerializer_ShouldUSeCustomObjectMapper() throws JsonProcessingException {
+    ObjectMapper mockObjMapper = mock(ObjectMapper.class);
+    serializer.setObjectMapper(mockObjMapper);
+
+    serializer.serialize(new Address());
+    verify(mockObjMapper, times(1)).writeValueAsBytes(any());
+  }
+
 }
diff --git a/src/test/java/com/dasburo/spring/cache/dynamo/serializer/OxmSerializerTest.java b/src/test/java/com/dasburo/spring/cache/dynamo/serializer/OxmSerializerTest.java
@@ -1,5 +1,60 @@
+/*
+ * Copyright 2019 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
+ *      https://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 com.dasburo.spring.cache.dynamo.serializer;
 
+import com.dasburo.spring.cache.dynamo.helper.Address;
+import org.junit.Assert;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.junit.MockitoJUnitRunner;
+import org.springframework.oxm.Marshaller;
+import org.springframework.oxm.Unmarshaller;
+import org.springframework.oxm.jaxb.Jaxb2Marshaller;
+
+@RunWith(MockitoJUnitRunner.class)
 public class OxmSerializerTest {
 
+  @Mock
+  private Marshaller marshaller;
+
+  @Mock
+  private Unmarshaller unmarshaller;
+
+  OxmSerializer sut;
+
+  @Before
+  public void setup() {
+    Jaxb2Marshaller m = new Jaxb2Marshaller();
+    sut = new OxmSerializer(m, m);
+  }
+
+  @Test
+  public void testOxmSerializer_WithNullValueShouldReturnNullObject() {
+    Assert.assertEquals(null, sut.serialize(null));
+  }
+
+  @Test(expected = SerializationException.class)
+  public void testOxmSerializer_WithWrongValueShouldThrowException() {
+    Address test = new Address();
+    sut.serialize(test);
+  }
+
+  @Test
+  public void testOxmSerializer_WithNullValueShouldReturnNullObjectWhenDeserializing() {
+    Assert.assertEquals(null, sut.deserialize(null));
+  }
 }
diff --git a/src/test/java/com/dasburo/spring/cache/dynamo/serializer/SerializableSerializerTest.java b/src/test/java/com/dasburo/spring/cache/dynamo/serializer/SerializableSerializerTest.java
@@ -1,5 +1,20 @@
+/*
+ * Copyright 2019 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
+ *      https://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 com.dasburo.spring.cache.dynamo.serializer;
 
+import com.dasburo.spring.cache.dynamo.helper.NotSerializeable;
 import org.junit.Assert;
 import org.junit.Before;
 import org.junit.Test;
@@ -18,9 +33,18 @@ public void testSerializableSerializer() {
     Assert.assertEquals("test", serializer.deserialize(serializer.serialize("test")));
   }
 
+  @Test
+  public void testSerializableSerializer_ShouldReturnNullWhenDeSerializingNullObject() {
+    Assert.assertNull(serializer.deserialize(null));
+  }
+
   @Test
   public void testSerializableSerializer_ShouldReturnNullWhenSerializingNull() {
     Assert.assertNull(serializer.deserialize(serializer.serialize(null)));
   }
 
+  @Test(expected = SerializationException.class)
+  public void testSerializableSerializer_ShouldThrowExceptionWhenSerializingNonSerializableObject() {
+    serializer.serialize(new NotSerializeable());
+  }
 }
diff --git a/src/test/java/com/dasburo/spring/cache/dynamo/serializer/SerializationUtilsTest.java b/src/test/java/com/dasburo/spring/cache/dynamo/serializer/SerializationUtilsTest.java
diff --git a/src/test/java/com/dasburo/spring/cache/dynamo/serializer/StringSerializerTest.java b/src/test/java/com/dasburo/spring/cache/dynamo/serializer/StringSerializerTest.java

Original file line number	Diff line number	Diff line change
`@@ -18,8 +18,6 @@`
`18`	`18`
`19`	`19`	`public abstract class SerializationUtils {`
`20`	`20`
`21`		`- static final byte[] EMPTY_ARRAY = new byte[0];`
`22`		`-`
`23`	`21`	`private SerializationUtils() {`
`24`	`22`	`throw new IllegalStateException("Utility class");`
`25`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ public AmazonDynamoDB amazonDynamoDB(AWSCredentialsProvider amazonAWSCredentials`
`61`	`61`
`62`	`62`	`@Bean`
`63`	`63`	`public DynamoCacheWriter dynamoCacheWriter(AmazonDynamoDB amazonDynamoDB) {`
`64`		`- return new DefaultDynamoCacheWriter(amazonDynamoDB);`
	`64`	`+ return DynamoCacheWriter.lockingDynamoCacheWriter(amazonDynamoDB);`
`65`	`65`	`}`
`66`	`66`
`67`	`67`	`}`