src/test/java/net/pterodactylus/sone/data/Mocks.java

   1 /*
   2  * Sone - Mocks.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.data;
  19
  20 import static com.google.common.base.Optional.absent;
  21 import static com.google.common.base.Optional.fromNullable;
  22 import static com.google.common.base.Optional.of;
  23 import static com.google.common.collect.ArrayListMultimap.create;
  24 import static com.google.common.collect.Maps.newHashMap;
  25 import static com.google.common.collect.Ordering.from;
  26 import static java.util.Collections.emptySet;
  27 import static org.mockito.Matchers.anyString;
  28 import static org.mockito.Matchers.eq;
  29 import static org.mockito.Mockito.doAnswer;
  30 import static org.mockito.Mockito.mock;
  31 import static org.mockito.Mockito.when;
  32
  33 import java.net.URI;
  34 import java.net.URISyntaxException;
  35 import java.util.Collection;
  36 import java.util.List;
  37 import java.util.Map;
  38 import java.util.Set;
  39
  40 import net.pterodactylus.sone.core.Core;
  41 import net.pterodactylus.sone.core.Options;
  42 import net.pterodactylus.sone.core.Options.DefaultOption;
  43 import net.pterodactylus.sone.core.Options.Option;
  44 import net.pterodactylus.sone.core.Options.OptionWatcher;
  45 import net.pterodactylus.sone.core.Preferences;
  46 import net.pterodactylus.sone.core.SoneInserter;
  47 import net.pterodactylus.sone.data.impl.DefaultPostBuilder;
  48 import net.pterodactylus.sone.data.impl.DefaultPostReplyBuilder;
  49 import net.pterodactylus.sone.database.Database;
  50 import net.pterodactylus.sone.database.PostReplyBuilder;
  51 import net.pterodactylus.sone.fcp.FcpInterface.FullAccessRequired;
  52 import net.pterodactylus.sone.utils.IntegerRangePredicate;
  53 import net.pterodactylus.sone.web.WebInterface;
  54 import net.pterodactylus.sone.web.page.FreenetRequest;
  55
  56 import freenet.clients.http.HTTPRequestImpl;
  57 import freenet.support.api.HTTPRequest;
  58
  59 import com.google.common.base.Function;
  60 import com.google.common.base.Optional;
  61 import com.google.common.base.Predicates;
  62 import com.google.common.collect.FluentIterable;
  63 import com.google.common.collect.HashMultimap;
  64 import com.google.common.collect.Multimap;
  65 import com.google.common.collect.Ordering;
  66 import com.google.common.collect.SetMultimap;
  67 import org.mockito.Matchers;
  68 import org.mockito.invocation.InvocationOnMock;
  69 import org.mockito.stubbing.Answer;
  70
  71 /**
  72  * Mocks reusable in multiple tests.
  73  *
  74  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  75  */
  76 public class Mocks {
  77
  78         private final Multimap<Sone, Post> sonePosts = create();
  79         private final Map<String, Sone> sones = newHashMap();
  80         private final Multimap<Post, PostReply> postReplies = create();
  81         private final Multimap<String, Post> directedPosts = create();
  82         private final SetMultimap<Post, Sone> postLikingSones = HashMultimap.create();
  83         private final SetMultimap<PostReply, Sone> postReplyLikingSones = HashMultimap.create();
  84         public final Database database;
  85         public final Core core;
  86         public final WebInterface webInterface;
  87
  88         public Mocks() {
  89                 database = mockDatabase();
  90                 core = mockCore(database);
  91                 webInterface = mockWebInterface(core);
  92                 when(database.getSone()).thenReturn(new Function<String, Optional<Sone>>() {
  93                         @Override
  94                         public Optional<Sone> apply(String soneId) {
  95                                 return (soneId == null) ? Optional.<Sone>absent() : fromNullable(sones.get(soneId));
  96                         }
  97                 });
  98                 when(core.getSones()).then(new Answer<Collection<Sone>>() {
  99                         @Override
 100                         public Collection<Sone> answer(InvocationOnMock invocation) throws Throwable {
 101                                 return sones.values();
 102                         }
 103                 });
 104                 when(core.getLocalSones()).then(new Answer<Collection<Sone>>() {
 105                         @Override
 106                         public Collection<Sone> answer(InvocationOnMock invocation) throws Throwable {
 107                                 return FluentIterable.from(sones.values()).filter(Sone.LOCAL_SONE_FILTER).toList();
 108                         }
 109                 });
 110                 Options options = createOptions();
 111                 when(core.getPreferences()).thenReturn(new Preferences(options));
 112                 when(database.getDirectedPosts(anyString())).then(new Answer<Collection<Post>>() {
 113                         @Override
 114                         public Collection<Post> answer(InvocationOnMock invocation) throws Throwable {
 115                                 return directedPosts.get((String) invocation.getArguments()[0]);
 116                         }
 117                 });
 118         }
 119
 120         private Options createOptions() {
 121                 Options options = new Options();
 122                 options.addIntegerOption("InsertionDelay", new DefaultOption<Integer>(60, new IntegerRangePredicate(0, Integer.MAX_VALUE)));
 123                 options.addIntegerOption("PostsPerPage", new DefaultOption<Integer>(10, new IntegerRangePredicate(1, Integer.MAX_VALUE)));
 124                 options.addIntegerOption("ImagesPerPage", new DefaultOption<Integer>(9, new IntegerRangePredicate(1, Integer.MAX_VALUE)));
 125                 options.addIntegerOption("CharactersPerPost", new DefaultOption<Integer>(400, Predicates.<Integer>or(new IntegerRangePredicate(50, Integer.MAX_VALUE), Predicates.equalTo(-1))));
 126                 options.addIntegerOption("PostCutOffLength", new DefaultOption<Integer>(200, Predicates.<Integer>or(new IntegerRangePredicate(50, Integer.MAX_VALUE), Predicates.equalTo(-1))));
 127                 options.addBooleanOption("RequireFullAccess", new DefaultOption<Boolean>(false));
 128                 options.addIntegerOption("PositiveTrust", new DefaultOption<Integer>(75, new IntegerRangePredicate(0, 100)));
 129                 options.addIntegerOption("NegativeTrust", new DefaultOption<Integer>(-25, new IntegerRangePredicate(-100, 100)));
 130                 options.addStringOption("TrustComment", new DefaultOption<String>("Set from Sone Web Interface"));
 131                 options.addBooleanOption("ActivateFcpInterface", new DefaultOption<Boolean>(false));
 132                 options.addIntegerOption("FcpFullAccessRequired", new DefaultOption<Integer>(2));
 133                 return options;
 134         }
 135
 136         private static Core mockCore(Database database) {
 137                 Core core = mock(Core.class);
 138                 when(core.getDatabase()).thenReturn(database);
 139                 when(core.getSone(anyString())).thenReturn(Optional.<Sone>absent());
 140                 return core;
 141         }
 142
 143         private static Database mockDatabase() {
 144                 Database database = mock(Database.class);
 145                 when(database.getSone(anyString())).thenReturn(Optional.<Sone>absent());
 146                 when(database.getPost(anyString())).thenReturn(Optional.<Post>absent());
 147                 when(database.getPostReply(anyString())).thenReturn(Optional.<PostReply>absent());
 148                 return database;
 149         }
 150
 151         private static WebInterface mockWebInterface(Core core) {
 152                 WebInterface webInterface = mock(WebInterface.class);
 153                 when(webInterface.getCore()).thenReturn(core);
 154                 return webInterface;
 155         }
 156
 157         public SoneMocker mockSone(String id) {
 158                 return new SoneMocker(id);
 159         }
 160
 161         public PostMocker mockPost(Sone sone, String postId) {
 162                 return new PostMocker(postId, sone);
 163         }
 164
 165         public PostReplyMocker mockPostReply(Sone sone, String replyId) {
 166                 return new PostReplyMocker(replyId, sone);
 167         }
 168
 169         public FreenetRequest mockRequest(String path) throws URISyntaxException {
 170                 HTTPRequest httpRequest = new HTTPRequestImpl(new URI(path), "GET");
 171                 FreenetRequest request = mock(FreenetRequest.class);
 172                 when(request.getHttpRequest()).thenReturn(httpRequest);
 173                 return request;
 174         }
 175
 176         public class SoneMocker {
 177
 178                 private final Sone mockedSone = mock(Sone.class);
 179                 private final String id;
 180                 private boolean local;
 181                 private Optional<String> name = absent();
 182                 private long time;
 183                 private Profile profile = new Profile(mockedSone);
 184                 private Collection<String> friends = emptySet();
 185
 186                 private SoneMocker(String id) {
 187                         this.id = id;
 188                 }
 189
 190                 public SoneMocker local() {
 191                         local = true;
 192                         return this;
 193                 }
 194
 195                 public SoneMocker withName(String name) {
 196                         this.name = fromNullable(name);
 197                         return this;
 198                 }
 199
 200                 public SoneMocker withTime(long time) {
 201                         this.time = time;
 202                         return this;
 203                 }
 204
 205                 public SoneMocker withProfileName(String firstName, String middleName, String lastName) {
 206                         profile.modify().setFirstName(firstName).setMiddleName(middleName).setLastName(lastName).update();
 207                         return this;
 208                 }
 209
 210                 public SoneMocker addProfileField(String fieldName, String fieldValue) {
 211                         profile.setField(profile.addField(fieldName), fieldValue);
 212                         return this;
 213                 }
 214
 215                 public SoneMocker withFriends(Collection<String> friends) {
 216                         this.friends = friends;
 217                         return this;
 218                 }
 219
 220                 public Sone create() {
 221                         when(mockedSone.getId()).thenReturn(id);
 222                         when(mockedSone.isLocal()).thenReturn(local);
 223                         if (name.isPresent()) {
 224                                 when(mockedSone.getName()).thenReturn(name.get());
 225                         }
 226                         when(mockedSone.getTime()).thenReturn(time);
 227                         when(mockedSone.getProfile()).thenReturn(profile);
 228                         if (local) {
 229                                 when(mockedSone.newPostBuilder()).thenReturn(new DefaultPostBuilder(database, id));
 230                                 when(mockedSone.newPostReplyBuilder(anyString())).then(new Answer<PostReplyBuilder>() {
 231                                         @Override
 232                                         public PostReplyBuilder answer(InvocationOnMock invocation) throws Throwable {
 233                                                 return new DefaultPostReplyBuilder(database, id, (String) invocation.getArguments()[0]);
 234                                         }
 235                                 });
 236                                 when(mockedSone.hasFriend(anyString())).thenReturn(false);
 237                                 when(mockedSone.getFriends()).thenReturn(friends);
 238                                 when(mockedSone.hasFriend(anyString())).then(new Answer<Boolean>() {
 239                                         @Override
 240                                         public Boolean answer(InvocationOnMock invocation) throws Throwable {
 241                                                 return friends.contains(invocation.getArguments()[0]);
 242                                         }
 243                                 });
 244                         } else {
 245                                 when(mockedSone.newPostBuilder()).thenThrow(IllegalStateException.class);
 246                                 when(mockedSone.newPostReplyBuilder(anyString())).thenThrow(IllegalStateException.class);
 247                         }
 248                         when(core.getSone(eq(id))).thenReturn(of(mockedSone));
 249                         when(database.getSone(eq(id))).thenReturn(of(mockedSone));
 250                         when(mockedSone.getPosts()).then(new Answer<List<Post>>() {
 251                                 @Override
 252                                 public List<Post> answer(InvocationOnMock invocationOnMock) throws Throwable {
 253                                         return from(Post.TIME_COMPARATOR).sortedCopy(sonePosts.get(mockedSone));
 254                                 }
 255                         });
 256                         when(mockedSone.toString()).thenReturn(String.format("Sone[%s]", id));
 257                         sones.put(id, mockedSone);
 258                         return mockedSone;
 259                 }
 260
 261         }
 262
 263         public class PostMocker {
 264
 265                 private final Post post = mock(Post.class);
 266                 private final String id;
 267                 private final Sone sone;
 268                 private Optional<String> recipientId = absent();
 269                 private long time;
 270                 private Optional<String> text = absent();
 271
 272                 public PostMocker(String id, Sone sone) {
 273                         this.id = id;
 274                         this.sone = sone;
 275                 }
 276
 277                 public PostMocker withRecipient(String recipientId) {
 278                         this.recipientId = fromNullable(recipientId);
 279                         return this;
 280                 }
 281
 282                 public PostMocker withTime(long time) {
 283                         this.time = time;
 284                         return this;
 285                 }
 286
 287                 public PostMocker withText(String text) {
 288                         this.text = fromNullable(text);
 289                         return this;
 290                 }
 291
 292                 public Post create() {
 293                         when(post.getId()).thenReturn(id);
 294                         when(post.getSone()).thenReturn(sone);
 295                         when(post.getRecipientId()).thenReturn(recipientId);
 296                         if (recipientId.isPresent()) {
 297                                 directedPosts.put(recipientId.get(), post);
 298                         }
 299                         when(post.getTime()).thenReturn(time);
 300                         if (text.isPresent()) {
 301                                 when(post.getText()).thenReturn(text.get());
 302                         }
 303                         when(database.getPost(eq(id))).thenReturn(of(post));
 304                         sonePosts.put(sone, post);
 305                         when(post.getReplies()).then(new Answer<List<PostReply>>() {
 306                                 @Override
 307                                 public List<PostReply> answer(InvocationOnMock invocation) throws Throwable {
 308                                         return Ordering.from(Reply.TIME_COMPARATOR).sortedCopy(postReplies.get(post));
 309                                 }
 310                         });
 311                         doAnswer(new Answer<Void>() {
 312                                 @Override
 313                                 public Void answer(InvocationOnMock invocation) throws Throwable {
 314                                         postLikingSones.put(post, (Sone) invocation.getArguments()[0]);
 315                                         return null;
 316                                 }
 317                         }).when(post).like(Matchers.<Sone>any());
 318                         doAnswer(new Answer<Void>() {
 319                                 @Override
 320                                 public Void answer(InvocationOnMock invocation) throws Throwable {
 321                                         postLikingSones.remove(post, (Sone) invocation.getArguments()[0]);
 322                                         return null;
 323                                 }
 324                         }).when(post).unlike(Matchers.<Sone>any());
 325                         when(post.getLikes()).thenAnswer(new Answer<Set<Sone>>() {
 326                                 @Override
 327                                 public Set<Sone> answer(InvocationOnMock invocation) throws Throwable {
 328                                         return postLikingSones.get(post);
 329                                 }
 330                         });
 331                         return post;
 332                 }
 333
 334         }
 335
 336         public class PostReplyMocker {
 337
 338                 private final PostReply postReply = mock(PostReply.class);
 339                 private final String id;
 340                 private final Sone sone;
 341                 private Optional<Post> post = absent();
 342                 private long time;
 343                 private Optional<String> text = absent();
 344
 345                 public PostReplyMocker(String id, Sone sone) {
 346                         this.id = id;
 347                         this.sone = sone;
 348                 }
 349
 350                 public PostReplyMocker inReplyTo(Post post) {
 351                         this.post = fromNullable(post);
 352                         return this;
 353                 }
 354
 355                 public PostReplyMocker withTime(long time) {
 356                         this.time = time;
 357                         return this;
 358                 }
 359
 360                 public PostReplyMocker withText(String text) {
 361                         this.text = fromNullable(text);
 362                         return this;
 363                 }
 364
 365                 public PostReply create() {
 366                         when(postReply.getId()).thenReturn(id);
 367                         when(postReply.getSone()).thenReturn(sone);
 368                         when(postReply.getTime()).thenReturn(time);
 369                         when(database.getPostReply(eq(id))).thenReturn(of(postReply));
 370                         if (post.isPresent()) {
 371                                 postReplies.put(post.get(), postReply);
 372                         }
 373                         if (text.isPresent()) {
 374                                 when(postReply.getText()).thenReturn(text.get());
 375                         }
 376                         doAnswer(new Answer<Void>() {
 377                                 @Override
 378                                 public Void answer(InvocationOnMock invocation) throws Throwable {
 379                                         postReplyLikingSones.put(postReply, (Sone) invocation.getArguments()[0]);
 380                                         return null;
 381                                 }
 382                         }).when(postReply).like(Matchers.<Sone>any());
 383                         doAnswer(new Answer<Void>() {
 384                                 @Override
 385                                 public Void answer(InvocationOnMock invocation) throws Throwable {
 386                                         postReplyLikingSones.remove(postReply, invocation.getArguments()[0]);
 387                                         return null;
 388                                 }
 389                         }).when(postReply).unlike(Matchers.<Sone>any());
 390                         when(postReply.getLikes()).thenAnswer(new Answer<Set<Sone>>() {
 391                                 @Override
 392                                 public Set<Sone> answer(InvocationOnMock invocation) throws Throwable {
 393                                         return postReplyLikingSones.get(postReply);
 394                                 }
 395                         });
 396                         return postReply;
 397                 }
 398         }
 399
 400 }