2 * Sone - MemoryDatabaseTest.java - Copyright © 2013–2016 David Roden
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 package net.pterodactylus.sone.database.memory;
20 import static com.google.common.base.Optional.of;
21 import static java.util.Arrays.asList;
22 import static java.util.UUID.randomUUID;
23 import static net.pterodactylus.sone.test.Matchers.isAlbum;
24 import static net.pterodactylus.sone.test.Matchers.isImage;
25 import static net.pterodactylus.sone.test.Matchers.isPost;
26 import static net.pterodactylus.sone.test.Matchers.isPostReply;
27 import static org.hamcrest.CoreMatchers.is;
28 import static org.hamcrest.MatcherAssert.assertThat;
29 import static org.hamcrest.Matchers.contains;
30 import static org.hamcrest.Matchers.containsInAnyOrder;
31 import static org.hamcrest.Matchers.empty;
32 import static org.hamcrest.Matchers.emptyIterable;
33 import static org.hamcrest.Matchers.equalTo;
34 import static org.hamcrest.Matchers.lessThan;
35 import static org.hamcrest.Matchers.nullValue;
36 import static org.mockito.ArgumentMatchers.anyString;
37 import static org.mockito.Mockito.mock;
38 import static org.mockito.Mockito.never;
39 import static org.mockito.Mockito.verify;
40 import static org.mockito.Mockito.when;
42 import java.util.Collection;
43 import java.util.HashMap;
44 import java.util.HashSet;
45 import java.util.List;
49 import net.pterodactylus.sone.data.Album;
50 import net.pterodactylus.sone.data.Image;
51 import net.pterodactylus.sone.data.Post;
52 import net.pterodactylus.sone.data.PostReply;
53 import net.pterodactylus.sone.data.Sone;
54 import net.pterodactylus.sone.data.impl.AlbumImpl;
55 import net.pterodactylus.sone.test.TestAlbumBuilder;
56 import net.pterodactylus.sone.test.TestImageBuilder;
57 import net.pterodactylus.sone.test.TestPostBuilder;
58 import net.pterodactylus.sone.test.TestPostReplyBuilder;
59 import net.pterodactylus.sone.test.TestValue;
60 import net.pterodactylus.util.config.Configuration;
61 import net.pterodactylus.util.config.ConfigurationException;
62 import net.pterodactylus.util.config.Value;
64 import com.google.common.base.Optional;
65 import org.hamcrest.CoreMatchers;
66 import org.junit.Before;
67 import org.junit.Test;
68 import org.mockito.invocation.InvocationOnMock;
69 import org.mockito.stubbing.Answer;
72 * Tests for {@link MemoryDatabase}.
74 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
76 public class MemoryDatabaseTest {
78 private static final String SONE_ID = "sone";
79 private static final String RECIPIENT_ID = "recipient";
80 private final Configuration configuration = mock(Configuration.class);
81 private final MemoryDatabase memoryDatabase = new MemoryDatabase(configuration);
82 private final Sone sone = mock(Sone.class);
85 public void setupSone() {
86 when(sone.getId()).thenReturn(SONE_ID);
90 public void storedSoneIsMadeAvailable() {
91 Post firstPost = new TestPostBuilder().withId("post1")
96 Post secondPost = new TestPostBuilder().withId("post2")
102 List<Post> posts = asList(firstPost, secondPost);
103 when(sone.getPosts()).thenReturn(posts);
104 PostReply firstPostFirstReply =
105 new TestPostReplyBuilder().withId("reply1")
107 .to(firstPost.getId())
111 PostReply firstPostSecondReply =
112 new TestPostReplyBuilder().withId("reply3")
114 .to(firstPost.getId())
118 PostReply secondPostReply =
119 new TestPostReplyBuilder().withId("reply2")
121 .to(secondPost.getId())
125 Set<PostReply> postReplies = new HashSet<PostReply>(
126 asList(firstPostFirstReply, firstPostSecondReply,
128 when(sone.getReplies()).thenReturn(postReplies);
129 Album firstAlbum = new TestAlbumBuilder().withId("album1")
134 .setDescription("album-description1")
136 Album secondAlbum = new TestAlbumBuilder().withId("album2").by(
137 sone).build().modify().setTitle("album2").setDescription(
138 "album-description2").update();
139 Album thirdAlbum = new TestAlbumBuilder().withId("album3").by(
140 sone).build().modify().setTitle("album3").setDescription(
141 "album-description3").update();
142 firstAlbum.addAlbum(thirdAlbum);
143 Album rootAlbum = mock(Album.class);
144 when(rootAlbum.getId()).thenReturn("root");
145 when(rootAlbum.getAlbums()).thenReturn(
146 asList(firstAlbum, secondAlbum));
147 when(sone.getRootAlbum()).thenReturn(rootAlbum);
148 Image firstImage = new TestImageBuilder().withId("image1")
152 .setCreationTime(1000L)
153 .setKey("KSK@image1")
155 .setDescription("image-description1")
159 Image secondImage = new TestImageBuilder().withId("image2")
163 .setCreationTime(2000L)
164 .setKey("KSK@image2")
166 .setDescription("image-description2")
170 Image thirdImage = new TestImageBuilder().withId("image3")
174 .setCreationTime(3000L)
175 .setKey("KSK@image3")
177 .setDescription("image-description3")
181 firstAlbum.addImage(firstImage);
182 firstAlbum.addImage(thirdImage);
183 secondAlbum.addImage(secondImage);
184 memoryDatabase.storeSone(sone);
185 assertThat(memoryDatabase.getPost("post1"),
186 isPost(firstPost.getId(), 1000L, "post1",
187 Optional.<String>absent()));
188 assertThat(memoryDatabase.getPost("post2"),
189 isPost(secondPost.getId(), 2000L, "post2", of(RECIPIENT_ID)));
190 assertThat(memoryDatabase.getPost("post3"), nullValue());
191 assertThat(memoryDatabase.getPostReply("reply1"),
192 isPostReply("reply1", "post1", 3000L, "reply1"));
193 assertThat(memoryDatabase.getPostReply("reply2"),
194 isPostReply("reply2", "post2", 4000L, "reply2"));
195 assertThat(memoryDatabase.getPostReply("reply3"),
196 isPostReply("reply3", "post1", 5000L, "reply3"));
197 assertThat(memoryDatabase.getPostReply("reply4"), nullValue());
198 assertThat(memoryDatabase.getAlbum("album1"),
199 isAlbum("album1", null, "album1", "album-description1"));
200 assertThat(memoryDatabase.getAlbum("album2"),
201 isAlbum("album2", null, "album2", "album-description2"));
202 assertThat(memoryDatabase.getAlbum("album3"),
203 isAlbum("album3", "album1", "album3", "album-description3"));
204 assertThat(memoryDatabase.getAlbum("album4"), nullValue());
205 assertThat(memoryDatabase.getImage("image1"),
206 isImage("image1", 1000L, "KSK@image1", "image1",
207 "image-description1", 16, 9));
208 assertThat(memoryDatabase.getImage("image2"),
209 isImage("image2", 2000L, "KSK@image2", "image2",
210 "image-description2", 32, 18));
211 assertThat(memoryDatabase.getImage("image3"),
212 isImage("image3", 3000L, "KSK@image3", "image3",
213 "image-description3", 48, 27));
214 assertThat(memoryDatabase.getImage("image4"), nullValue());
218 public void storedAndRemovedSoneIsNotAvailable() {
219 storedSoneIsMadeAvailable();
220 memoryDatabase.removeSone(sone);
221 assertThat(memoryDatabase.getSones(), empty());
225 public void postRecipientsAreDetectedCorrectly() {
226 Post postWithRecipient = createPost(of(RECIPIENT_ID));
227 memoryDatabase.storePost(postWithRecipient);
228 Post postWithoutRecipient = createPost(Optional.<String>absent());
229 memoryDatabase.storePost(postWithoutRecipient);
230 assertThat(memoryDatabase.getDirectedPosts(RECIPIENT_ID),
231 contains(postWithRecipient));
234 private Post createPost(Optional<String> recipient) {
235 Post postWithRecipient = mock(Post.class);
236 when(postWithRecipient.getId()).thenReturn(randomUUID().toString());
237 when(postWithRecipient.getSone()).thenReturn(sone);
238 when(postWithRecipient.getRecipientId()).thenReturn(recipient);
239 return postWithRecipient;
243 public void postRepliesAreManagedCorrectly() {
244 Post firstPost = createPost(Optional.<String>absent());
245 PostReply firstPostFirstReply = createPostReply(firstPost, 1000L);
246 Post secondPost = createPost(Optional.<String>absent());
247 PostReply secondPostFirstReply = createPostReply(secondPost, 1000L);
248 PostReply secondPostSecondReply = createPostReply(secondPost, 2000L);
249 memoryDatabase.storePost(firstPost);
250 memoryDatabase.storePost(secondPost);
251 memoryDatabase.storePostReply(firstPostFirstReply);
252 memoryDatabase.storePostReply(secondPostFirstReply);
253 memoryDatabase.storePostReply(secondPostSecondReply);
254 assertThat(memoryDatabase.getReplies(firstPost.getId()),
255 contains(firstPostFirstReply));
256 assertThat(memoryDatabase.getReplies(secondPost.getId()),
257 contains(secondPostFirstReply, secondPostSecondReply));
260 private PostReply createPostReply(Post post, long time) {
261 PostReply postReply = mock(PostReply.class);
262 when(postReply.getId()).thenReturn(randomUUID().toString());
263 when(postReply.getTime()).thenReturn(time);
264 when(postReply.getPost()).thenReturn(of(post));
265 final String postId = post.getId();
266 when(postReply.getPostId()).thenReturn(postId);
271 public void testBasicAlbumFunctionality() {
272 Album newAlbum = new AlbumImpl(mock(Sone.class));
273 assertThat(memoryDatabase.getAlbum(newAlbum.getId()), nullValue());
274 memoryDatabase.storeAlbum(newAlbum);
275 assertThat(memoryDatabase.getAlbum(newAlbum.getId()), is(newAlbum));
276 memoryDatabase.removeAlbum(newAlbum);
277 assertThat(memoryDatabase.getAlbum(newAlbum.getId()), nullValue());
280 private void initializeFriends() {
281 when(configuration.getStringValue("Sone/" + SONE_ID + "/Friends/0/ID")).thenReturn(
282 TestValue.from("Friend1"));
283 when(configuration.getStringValue("Sone/" + SONE_ID + "/Friends/1/ID")).thenReturn(
284 TestValue.from("Friend2"));
285 when(configuration.getStringValue("Sone/" + SONE_ID + "/Friends/2/ID")).thenReturn(
286 TestValue.<String>from(null));
290 public void friendsAreReturnedCorrectly() {
292 when(sone.isLocal()).thenReturn(true);
293 Collection<String> friends = memoryDatabase.getFriends(sone);
294 assertThat(friends, containsInAnyOrder("Friend1", "Friend2"));
298 public void friendsAreOnlyLoadedOnceFromConfiguration() {
299 friendsAreReturnedCorrectly();
300 memoryDatabase.getFriends(sone);
301 verify(configuration).getStringValue("Sone/" + SONE_ID + "/Friends/0/ID");
305 public void friendsAreOnlyReturnedForLocalSones() {
306 Collection<String> friends = memoryDatabase.getFriends(sone);
307 assertThat(friends, emptyIterable());
308 verify(configuration, never()).getStringValue("Sone/" + SONE_ID + "/Friends/0/ID");
312 public void checkingForAFriendReturnsTrue() {
314 when(sone.isLocal()).thenReturn(true);
315 assertThat(memoryDatabase.isFriend(sone, "Friend1"), is(true));
319 public void checkingForAFriendThatIsNotAFriendReturnsFalse() {
321 when(sone.isLocal()).thenReturn(true);
322 assertThat(memoryDatabase.isFriend(sone, "FriendX"), is(false));
326 public void checkingForAFriendOfRemoteSoneReturnsFalse() {
328 assertThat(memoryDatabase.isFriend(sone, "Friend1"), is(false));
331 private Map<String, Value<?>> prepareConfigurationValues() {
332 final Map<String, Value<?>> configurationValues = new HashMap<>();
333 when(configuration.getStringValue(anyString())).thenAnswer(new Answer<Value<String>>() {
335 public Value<String> answer(InvocationOnMock invocation) throws Throwable {
336 Value<?> value = configurationValues.get(invocation.<String>getArgument(0));
338 value = TestValue.from(null);
339 configurationValues.put(invocation.<String>getArgument(0), value);
341 return (Value<String>) value;
344 when(configuration.getLongValue(anyString())).thenAnswer(new Answer<Value<Long>>() {
346 public Value<Long> answer(InvocationOnMock invocation) throws Throwable {
347 Value<?> value = configurationValues.get(invocation.<String>getArgument(0));
349 value = TestValue.from(null);
350 configurationValues.put(invocation.<String>getArgument(0), value);
352 return (Value<Long>) value;
355 return configurationValues;
359 public void friendIsAddedCorrectlyToLocalSone() {
360 Map<String, Value<?>> configurationValues = prepareConfigurationValues();
361 when(sone.isLocal()).thenReturn(true);
362 memoryDatabase.addFriend(sone, "Friend1");
363 assertThat(configurationValues.get("Sone/" + SONE_ID + "/Friends/0/ID"),
364 CoreMatchers.<Value<?>>is(TestValue.from("Friend1")));
365 assertThat(configurationValues.get("Sone/" + SONE_ID + "/Friends/1/ID"),
366 CoreMatchers.<Value<?>>is(TestValue.<String>from(null)));
370 public void friendIsNotAddedToRemoteSone() {
371 memoryDatabase.addFriend(sone, "Friend1");
372 verify(configuration, never()).getStringValue(anyString());
376 public void friendIsRemovedCorrectlyFromLocalSone() {
377 Map<String, Value<?>> configurationValues = prepareConfigurationValues();
378 when(sone.isLocal()).thenReturn(true);
379 memoryDatabase.addFriend(sone, "Friend1");
380 memoryDatabase.removeFriend(sone, "Friend1");
381 assertThat(configurationValues.get("Sone/" + SONE_ID + "/Friends/0/ID"),
382 CoreMatchers.<Value<?>>is(TestValue.<String>from(null)));
383 assertThat(configurationValues.get("Sone/" + SONE_ID + "/Friends/1/ID"),
384 CoreMatchers.<Value<?>>is(TestValue.<String>from(null)));
388 public void configurationIsNotWrittenWhenANonFriendIsRemoved() {
389 prepareConfigurationValues();
390 when(sone.isLocal()).thenReturn(true);
391 memoryDatabase.removeFriend(sone, "Friend1");
392 verify(configuration).getStringValue(anyString());
396 public void soneFollowingTimeIsReturnedCorrectly() throws ConfigurationException {
397 prepareConfigurationValues();
398 configuration.getStringValue("SoneFollowingTimes/0/Sone").setValue("sone");
399 configuration.getLongValue("SoneFollowingTimes/0/Time").setValue(1000L);
400 assertThat(memoryDatabase.getFollowingTime("sone"), equalTo(1000L));
404 public void nullisReturnedWhenSoneIsNotFollowed() throws ConfigurationException {
405 prepareConfigurationValues();
406 configuration.getStringValue("SoneFollowingTimes/0/Sone").setValue("otherSone");
407 configuration.getLongValue("SoneFollowingTimes/0/Time").setValue(1000L);
408 assertThat(memoryDatabase.getFollowingTime("sone"), nullValue());
412 public void timeIsStoredInConfigurationWhenASoneIsFollowed() throws ConfigurationException {
413 prepareConfigurationValues();
414 when(sone.isLocal()).thenReturn(true);
415 memoryDatabase.addFriend(sone, "Friend");
416 assertThat(configuration.getStringValue("SoneFollowingTimes/0/Sone").getValue(), equalTo("Friend"));
417 assertThat(System.currentTimeMillis() - configuration.getLongValue("SoneFollowingTimes/0/Time").getValue(), lessThan(1000L));
418 assertThat(configuration.getStringValue("SoneFollowingTimes/1/Sone").getValue(), nullValue());
422 public void existingTimeIsNotOverwrittenWhenASoneIsFollowed() throws ConfigurationException {
423 prepareConfigurationValues();
424 configuration.getStringValue("SoneFollowingTimes/0/Sone").setValue("Friend");
425 configuration.getLongValue("SoneFollowingTimes/0/Time").setValue(1000L);
426 when(sone.isLocal()).thenReturn(true);
427 memoryDatabase.addFriend(sone, "Friend");
428 assertThat(configuration.getStringValue("SoneFollowingTimes/0/Sone").getValue(), equalTo("Friend"));
429 assertThat(configuration.getLongValue("SoneFollowingTimes/0/Time").getValue(), equalTo(1000L));
430 assertThat(configuration.getStringValue("SoneFollowingTimes/1/Sone").getValue(), nullValue());
434 public void unfollowingASoneRemovesTheFollowingTime() throws ConfigurationException {
435 prepareConfigurationValues();
436 configuration.getStringValue("Sone/sone/Friends/0/ID").setValue("Friend");
437 configuration.getStringValue("SoneFollowingTimes/0/Sone").setValue("Friend");
438 configuration.getLongValue("SoneFollowingTimes/0/Time").setValue(1000L);
439 when(sone.isLocal()).thenReturn(true);
440 memoryDatabase.removeFriend(sone, "Friend");
441 assertThat(configuration.getStringValue("SoneFollowingTimes/0/Sone").getValue(), nullValue());
445 public void unfollowingASoneDoesNotRemoveTheFollowingTimeIfAnotherLocalSoneFollowsIt() throws ConfigurationException {
446 prepareConfigurationValues();
447 configuration.getStringValue("Sone/sone/Friends/0/ID").setValue("Friend");
448 configuration.getStringValue("Sone/other-sone/Friends/0/ID").setValue("Friend");
449 configuration.getStringValue("SoneFollowingTimes/0/Sone").setValue("Friend");
450 configuration.getLongValue("SoneFollowingTimes/0/Time").setValue(1000L);
451 Sone otherSone = mock(Sone.class);
452 when(otherSone.isLocal()).thenReturn(true);
453 when(otherSone.getId()).thenReturn("other-sone");
454 memoryDatabase.getFriends(otherSone);
455 when(sone.isLocal()).thenReturn(true);
456 memoryDatabase.removeFriend(sone, "Friend");
457 assertThat(configuration.getStringValue("SoneFollowingTimes/0/Sone").getValue(), equalTo("Friend"));
458 assertThat(configuration.getLongValue("SoneFollowingTimes/0/Time").getValue(), equalTo(1000L));