src/test/java/net/pterodactylus/sone/database/memory/MemoryDatabaseTest.java

   1 /*
   2  * Sone - MemoryDatabaseTest.java - Copyright © 2013–2016 David Roden
   3  *
   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.
   8  *
   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.
  13  *
  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/>.
  16  */
  17
  18 package net.pterodactylus.sone.database.memory;
  19
  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;
  41
  42 import java.util.Collection;
  43 import java.util.HashMap;
  44 import java.util.HashSet;
  45 import java.util.List;
  46 import java.util.Map;
  47 import java.util.Set;
  48
  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;
  63
  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;
  70
  71 /**
  72  * Tests for {@link MemoryDatabase}.
  73  *
  74  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  75  */
  76 public class MemoryDatabaseTest {
  77
  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);
  83
  84         @Before
  85         public void setupSone() {
  86                 when(sone.getId()).thenReturn(SONE_ID);
  87         }
  88
  89         @Test
  90         public void storedSoneIsMadeAvailable() {
  91                 Post firstPost = new TestPostBuilder().withId("post1")
  92                                 .from(SONE_ID)
  93                                 .withTime(1000L)
  94                                 .withText("post1")
  95                                 .build();
  96                 Post secondPost = new TestPostBuilder().withId("post2")
  97                                 .from(SONE_ID)
  98                                 .withTime(2000L)
  99                                 .withText("post2")
 100                                 .to(RECIPIENT_ID)
 101                                 .build();
 102                 List<Post> posts = asList(firstPost, secondPost);
 103                 when(sone.getPosts()).thenReturn(posts);
 104                 PostReply firstPostFirstReply =
 105                                 new TestPostReplyBuilder().withId("reply1")
 106                                                 .from(SONE_ID)
 107                                                 .to(firstPost.getId())
 108                                                 .withTime(3000L)
 109                                                 .withText("reply1")
 110                                                 .build();
 111                 PostReply firstPostSecondReply =
 112                                 new TestPostReplyBuilder().withId("reply3")
 113                                                 .from(RECIPIENT_ID)
 114                                                 .to(firstPost.getId())
 115                                                 .withTime(5000L)
 116                                                 .withText("reply3")
 117                                                 .build();
 118                 PostReply secondPostReply =
 119                                 new TestPostReplyBuilder().withId("reply2")
 120                                                 .from(SONE_ID)
 121                                                 .to(secondPost.getId())
 122                                                 .withTime(4000L)
 123                                                 .withText("reply2")
 124                                                 .build();
 125                 Set<PostReply> postReplies = new HashSet<PostReply>(
 126                                 asList(firstPostFirstReply, firstPostSecondReply,
 127                                                 secondPostReply));
 128                 when(sone.getReplies()).thenReturn(postReplies);
 129                 Album firstAlbum = new TestAlbumBuilder().withId("album1")
 130                                 .by(sone)
 131                                 .build()
 132                                 .modify()
 133                                 .setTitle("album1")
 134                                 .setDescription("album-description1")
 135                                 .update();
 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.getAlbums()).thenReturn(
 145                                 asList(firstAlbum, secondAlbum));
 146                 when(sone.getRootAlbum()).thenReturn(rootAlbum);
 147                 Image firstImage = new TestImageBuilder().withId("image1")
 148                                 .build()
 149                                 .modify()
 150                                 .setSone(sone)
 151                                 .setCreationTime(1000L)
 152                                 .setKey("KSK@image1")
 153                                 .setTitle("image1")
 154                                 .setDescription("image-description1")
 155                                 .setWidth(16)
 156                                 .setHeight(9)
 157                                 .update();
 158                 Image secondImage = new TestImageBuilder().withId("image2")
 159                                 .build()
 160                                 .modify()
 161                                 .setSone(sone)
 162                                 .setCreationTime(2000L)
 163                                 .setKey("KSK@image2")
 164                                 .setTitle("image2")
 165                                 .setDescription("image-description2")
 166                                 .setWidth(32)
 167                                 .setHeight(18)
 168                                 .update();
 169                 Image thirdImage = new TestImageBuilder().withId("image3")
 170                                 .build()
 171                                 .modify()
 172                                 .setSone(sone)
 173                                 .setCreationTime(3000L)
 174                                 .setKey("KSK@image3")
 175                                 .setTitle("image3")
 176                                 .setDescription("image-description3")
 177                                 .setWidth(48)
 178                                 .setHeight(27)
 179                                 .update();
 180                 firstAlbum.addImage(firstImage);
 181                 firstAlbum.addImage(thirdImage);
 182                 secondAlbum.addImage(secondImage);
 183                 memoryDatabase.storeSone(sone);
 184                 assertThat(memoryDatabase.getPost("post1"),
 185                                 isPost(firstPost.getId(), 1000L, "post1",
 186                                                 Optional.<String>absent()));
 187                 assertThat(memoryDatabase.getPost("post2"),
 188                                 isPost(secondPost.getId(), 2000L, "post2", of(RECIPIENT_ID)));
 189                 assertThat(memoryDatabase.getPost("post3"), nullValue());
 190                 assertThat(memoryDatabase.getPostReply("reply1"),
 191                                 isPostReply("reply1", "post1", 3000L, "reply1"));
 192                 assertThat(memoryDatabase.getPostReply("reply2"),
 193                                 isPostReply("reply2", "post2", 4000L, "reply2"));
 194                 assertThat(memoryDatabase.getPostReply("reply3"),
 195                                 isPostReply("reply3", "post1", 5000L, "reply3"));
 196                 assertThat(memoryDatabase.getPostReply("reply4"), nullValue());
 197                 assertThat(memoryDatabase.getAlbum("album1"),
 198                                 isAlbum("album1", null, "album1", "album-description1"));
 199                 assertThat(memoryDatabase.getAlbum("album2"),
 200                                 isAlbum("album2", null, "album2", "album-description2"));
 201                 assertThat(memoryDatabase.getAlbum("album3"),
 202                                 isAlbum("album3", "album1", "album3", "album-description3"));
 203                 assertThat(memoryDatabase.getAlbum("album4"), nullValue());
 204                 assertThat(memoryDatabase.getImage("image1"),
 205                                 isImage("image1", 1000L, "KSK@image1", "image1",
 206                                                 "image-description1", 16, 9));
 207                 assertThat(memoryDatabase.getImage("image2"),
 208                                 isImage("image2", 2000L, "KSK@image2", "image2",
 209                                                 "image-description2", 32, 18));
 210                 assertThat(memoryDatabase.getImage("image3"),
 211                                 isImage("image3", 3000L, "KSK@image3", "image3",
 212                                                 "image-description3", 48, 27));
 213                 assertThat(memoryDatabase.getImage("image4"), nullValue());
 214         }
 215
 216         @Test
 217         public void storedAndRemovedSoneIsNotAvailable() {
 218             storedSoneIsMadeAvailable();
 219                 memoryDatabase.removeSone(sone);
 220                 assertThat(memoryDatabase.getSones(), empty());
 221         }
 222
 223         @Test
 224         public void postRecipientsAreDetectedCorrectly() {
 225                 Post postWithRecipient = createPost(of(RECIPIENT_ID));
 226                 memoryDatabase.storePost(postWithRecipient);
 227                 Post postWithoutRecipient = createPost(Optional.<String>absent());
 228                 memoryDatabase.storePost(postWithoutRecipient);
 229                 assertThat(memoryDatabase.getDirectedPosts(RECIPIENT_ID),
 230                                 contains(postWithRecipient));
 231         }
 232
 233         private Post createPost(Optional<String> recipient) {
 234                 Post postWithRecipient = mock(Post.class);
 235                 when(postWithRecipient.getId()).thenReturn(randomUUID().toString());
 236                 when(postWithRecipient.getSone()).thenReturn(sone);
 237                 when(postWithRecipient.getRecipientId()).thenReturn(recipient);
 238                 return postWithRecipient;
 239         }
 240
 241         @Test
 242         public void postRepliesAreManagedCorrectly() {
 243                 Post firstPost = createPost(Optional.<String>absent());
 244                 PostReply firstPostFirstReply = createPostReply(firstPost, 1000L);
 245                 Post secondPost = createPost(Optional.<String>absent());
 246                 PostReply secondPostFirstReply = createPostReply(secondPost, 1000L);
 247                 PostReply secondPostSecondReply = createPostReply(secondPost, 2000L);
 248                 memoryDatabase.storePost(firstPost);
 249                 memoryDatabase.storePost(secondPost);
 250                 memoryDatabase.storePostReply(firstPostFirstReply);
 251                 memoryDatabase.storePostReply(secondPostFirstReply);
 252                 memoryDatabase.storePostReply(secondPostSecondReply);
 253                 assertThat(memoryDatabase.getReplies(firstPost.getId()),
 254                                 contains(firstPostFirstReply));
 255                 assertThat(memoryDatabase.getReplies(secondPost.getId()),
 256                                 contains(secondPostFirstReply, secondPostSecondReply));
 257         }
 258
 259         private PostReply createPostReply(Post post, long time) {
 260                 PostReply postReply = mock(PostReply.class);
 261                 when(postReply.getId()).thenReturn(randomUUID().toString());
 262                 when(postReply.getTime()).thenReturn(time);
 263                 when(postReply.getPost()).thenReturn(of(post));
 264                 final String postId = post.getId();
 265                 when(postReply.getPostId()).thenReturn(postId);
 266                 return postReply;
 267         }
 268
 269         @Test
 270         public void testBasicAlbumFunctionality() {
 271                 Album newAlbum = new AlbumImpl(mock(Sone.class));
 272                 assertThat(memoryDatabase.getAlbum(newAlbum.getId()), nullValue());
 273                 memoryDatabase.storeAlbum(newAlbum);
 274                 assertThat(memoryDatabase.getAlbum(newAlbum.getId()), is(newAlbum));
 275                 memoryDatabase.removeAlbum(newAlbum);
 276                 assertThat(memoryDatabase.getAlbum(newAlbum.getId()), nullValue());
 277         }
 278
 279         private void initializeFriends() {
 280                 when(configuration.getStringValue("Sone/" + SONE_ID + "/Friends/0/ID")).thenReturn(
 281                                 TestValue.from("Friend1"));
 282                 when(configuration.getStringValue("Sone/" + SONE_ID + "/Friends/1/ID")).thenReturn(
 283                                 TestValue.from("Friend2"));
 284                 when(configuration.getStringValue("Sone/" + SONE_ID + "/Friends/2/ID")).thenReturn(
 285                                 TestValue.<String>from(null));
 286         }
 287
 288         @Test
 289         public void friendsAreReturnedCorrectly() {
 290                 initializeFriends();
 291                 when(sone.isLocal()).thenReturn(true);
 292                 Collection<String> friends = memoryDatabase.getFriends(sone);
 293                 assertThat(friends, containsInAnyOrder("Friend1", "Friend2"));
 294         }
 295
 296         @Test
 297         public void friendsAreOnlyLoadedOnceFromConfiguration() {
 298                 friendsAreReturnedCorrectly();
 299                 memoryDatabase.getFriends(sone);
 300                 verify(configuration).getStringValue("Sone/" + SONE_ID + "/Friends/0/ID");
 301         }
 302
 303         @Test
 304         public void friendsAreOnlyReturnedForLocalSones() {
 305                 Collection<String> friends = memoryDatabase.getFriends(sone);
 306                 assertThat(friends, emptyIterable());
 307                 verify(configuration, never()).getStringValue("Sone/" + SONE_ID + "/Friends/0/ID");
 308         }
 309
 310         @Test
 311         public void checkingForAFriendReturnsTrue() {
 312                 initializeFriends();
 313                 when(sone.isLocal()).thenReturn(true);
 314                 assertThat(memoryDatabase.isFriend(sone, "Friend1"), is(true));
 315         }
 316
 317         @Test
 318         public void checkingForAFriendThatIsNotAFriendReturnsFalse() {
 319                 initializeFriends();
 320                 when(sone.isLocal()).thenReturn(true);
 321                 assertThat(memoryDatabase.isFriend(sone, "FriendX"), is(false));
 322         }
 323
 324         @Test
 325         public void checkingForAFriendOfRemoteSoneReturnsFalse() {
 326                 initializeFriends();
 327                 assertThat(memoryDatabase.isFriend(sone, "Friend1"), is(false));
 328         }
 329
 330         private Map<String, Value<?>> prepareConfigurationValues() {
 331                 final Map<String, Value<?>> configurationValues = new HashMap<>();
 332                 when(configuration.getStringValue(anyString())).thenAnswer(new Answer<Value<String>>() {
 333                         @Override
 334                         public Value<String> answer(InvocationOnMock invocation) throws Throwable {
 335                                 Value<?> value = configurationValues.get(invocation.<String>getArgument(0));
 336                                 if (value == null) {
 337                                         value = TestValue.from(null);
 338                                         configurationValues.put(invocation.<String>getArgument(0), value);
 339                                 }
 340                                 return (Value<String>) value;
 341                         }
 342                 });
 343                 when(configuration.getLongValue(anyString())).thenAnswer(new Answer<Value<Long>>() {
 344                         @Override
 345                         public Value<Long> answer(InvocationOnMock invocation) throws Throwable {
 346                                 Value<?> value = configurationValues.get(invocation.<String>getArgument(0));
 347                                 if (value == null) {
 348                                         value = TestValue.from(null);
 349                                         configurationValues.put(invocation.<String>getArgument(0), value);
 350                                 }
 351                                 return (Value<Long>) value;
 352                         }
 353                 });
 354                 return configurationValues;
 355         }
 356
 357         @Test
 358         public void friendIsAddedCorrectlyToLocalSone() {
 359                 Map<String, Value<?>> configurationValues = prepareConfigurationValues();
 360                 when(sone.isLocal()).thenReturn(true);
 361                 memoryDatabase.addFriend(sone, "Friend1");
 362                 assertThat(configurationValues.get("Sone/" + SONE_ID + "/Friends/0/ID"),
 363                                 CoreMatchers.<Value<?>>is(TestValue.from("Friend1")));
 364                 assertThat(configurationValues.get("Sone/" + SONE_ID + "/Friends/1/ID"),
 365                                 CoreMatchers.<Value<?>>is(TestValue.<String>from(null)));
 366         }
 367
 368         @Test
 369         public void friendIsNotAddedToRemoteSone() {
 370                 memoryDatabase.addFriend(sone, "Friend1");
 371                 verify(configuration, never()).getStringValue(anyString());
 372         }
 373
 374         @Test
 375         public void friendIsRemovedCorrectlyFromLocalSone() {
 376                 Map<String, Value<?>> configurationValues = prepareConfigurationValues();
 377                 when(sone.isLocal()).thenReturn(true);
 378                 memoryDatabase.addFriend(sone, "Friend1");
 379                 memoryDatabase.removeFriend(sone, "Friend1");
 380                 assertThat(configurationValues.get("Sone/" + SONE_ID + "/Friends/0/ID"),
 381                                 CoreMatchers.<Value<?>>is(TestValue.<String>from(null)));
 382                 assertThat(configurationValues.get("Sone/" + SONE_ID + "/Friends/1/ID"),
 383                                 CoreMatchers.<Value<?>>is(TestValue.<String>from(null)));
 384         }
 385
 386         @Test
 387         public void configurationIsNotWrittenWhenANonFriendIsRemoved() {
 388                 prepareConfigurationValues();
 389                 when(sone.isLocal()).thenReturn(true);
 390                 memoryDatabase.removeFriend(sone, "Friend1");
 391                 verify(configuration).getStringValue(anyString());
 392         }
 393
 394         @Test
 395         public void soneFollowingTimeIsReturnedCorrectly() throws ConfigurationException {
 396                 prepareConfigurationValues();
 397                 configuration.getStringValue("SoneFollowingTimes/0/Sone").setValue("sone");
 398                 configuration.getLongValue("SoneFollowingTimes/0/Time").setValue(1000L);
 399                 assertThat(memoryDatabase.getFollowingTime("sone"), equalTo(1000L));
 400         }
 401
 402         @Test
 403         public void nullisReturnedWhenSoneIsNotFollowed() throws ConfigurationException {
 404                 prepareConfigurationValues();
 405                 configuration.getStringValue("SoneFollowingTimes/0/Sone").setValue("otherSone");
 406                 configuration.getLongValue("SoneFollowingTimes/0/Time").setValue(1000L);
 407                 assertThat(memoryDatabase.getFollowingTime("sone"), nullValue());
 408         }
 409
 410         @Test
 411         public void timeIsStoredInConfigurationWhenASoneIsFollowed() throws ConfigurationException {
 412                 prepareConfigurationValues();
 413                 when(sone.isLocal()).thenReturn(true);
 414                 memoryDatabase.addFriend(sone, "Friend");
 415                 assertThat(configuration.getStringValue("SoneFollowingTimes/0/Sone").getValue(), equalTo("Friend"));
 416                 assertThat(System.currentTimeMillis() - configuration.getLongValue("SoneFollowingTimes/0/Time").getValue(), lessThan(1000L));
 417                 assertThat(configuration.getStringValue("SoneFollowingTimes/1/Sone").getValue(), nullValue());
 418         }
 419
 420         @Test
 421         public void existingTimeIsNotOverwrittenWhenASoneIsFollowed() throws ConfigurationException {
 422                 prepareConfigurationValues();
 423                 configuration.getStringValue("SoneFollowingTimes/0/Sone").setValue("Friend");
 424                 configuration.getLongValue("SoneFollowingTimes/0/Time").setValue(1000L);
 425                 when(sone.isLocal()).thenReturn(true);
 426                 memoryDatabase.addFriend(sone, "Friend");
 427                 assertThat(configuration.getStringValue("SoneFollowingTimes/0/Sone").getValue(), equalTo("Friend"));
 428                 assertThat(configuration.getLongValue("SoneFollowingTimes/0/Time").getValue(), equalTo(1000L));
 429                 assertThat(configuration.getStringValue("SoneFollowingTimes/1/Sone").getValue(), nullValue());
 430         }
 431
 432 }