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

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