Remove @author tags
[Sone.git] / src / test / java / net / pterodactylus / sone / core / SoneInserterTest.java
index 05cc49e..32926e8 100644 (file)
@@ -1,54 +1,73 @@
 package net.pterodactylus.sone.core;
 
+import static com.google.common.io.ByteStreams.toByteArray;
+import static com.google.common.util.concurrent.MoreExecutors.sameThreadExecutor;
+import static java.lang.System.currentTimeMillis;
 import static org.hamcrest.MatcherAssert.assertThat;
-import static org.hamcrest.Matchers.containsInAnyOrder;
+import static org.hamcrest.Matchers.containsString;
+import static org.hamcrest.Matchers.instanceOf;
 import static org.hamcrest.Matchers.is;
+import static org.hamcrest.Matchers.nullValue;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.anyString;
+import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.Mockito.doAnswer;
 import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.never;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
+import static org.mockito.hamcrest.MockitoHamcrest.argThat;
 
+import java.io.IOException;
 import java.util.HashMap;
+import java.util.Map;
 
-import net.pterodactylus.sone.core.SoneInserter.InsertInformation;
-import net.pterodactylus.sone.core.SoneInserter.SetInsertionDelay;
+import net.pterodactylus.sone.core.SoneInserter.ManifestCreator;
+import net.pterodactylus.sone.core.event.InsertionDelayChangedEvent;
+import net.pterodactylus.sone.core.event.SoneEvent;
+import net.pterodactylus.sone.core.event.SoneInsertAbortedEvent;
+import net.pterodactylus.sone.core.event.SoneInsertedEvent;
+import net.pterodactylus.sone.core.event.SoneInsertingEvent;
 import net.pterodactylus.sone.data.Album;
 import net.pterodactylus.sone.data.Sone;
+import net.pterodactylus.sone.main.SonePlugin;
 
 import freenet.keys.FreenetURI;
+import freenet.support.api.ManifestElement;
 
+import com.google.common.base.Charsets;
+import com.google.common.base.Optional;
+import com.google.common.eventbus.AsyncEventBus;
 import com.google.common.eventbus.EventBus;
+import org.junit.Before;
 import org.junit.Test;
+import org.mockito.ArgumentCaptor;
+import org.mockito.invocation.InvocationOnMock;
+import org.mockito.stubbing.Answer;
 
 /**
  * Unit test for {@link SoneInserter} and its subclasses.
- *
- * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  */
 public class SoneInserterTest {
 
-       @Test
-       public void insertionDelayIsForwardedToSoneInserter() {
-               SetInsertionDelay setInsertionDelay = new SetInsertionDelay();
-               setInsertionDelay.optionChanged(null, null, 15);
-               assertThat(SoneInserter.getInsertionDelay().get(), is(15));
-       }
+       private final Core core = mock(Core.class);
+       private final EventBus eventBus = mock(EventBus.class);
+       private final FreenetInterface freenetInterface = mock(FreenetInterface.class);
 
-       @Test
-       /* this test is hilariously bad. */
-       public void manifestEntriesAreCreated() {
-               FreenetURI insertUri = mock(FreenetURI.class);
-               String fingerprint = "fingerprint";
-               Sone sone = createSone(insertUri, fingerprint);
-               Core core = mock(Core.class);
+       @Before
+       public void setupCore() {
                UpdateChecker updateChecker = mock(UpdateChecker.class);
                when(core.getUpdateChecker()).thenReturn(updateChecker);
-               EventBus eventBus = mock(EventBus.class);
-               FreenetInterface freenetInterface = mock(FreenetInterface.class);
-               SoneInserter soneInserter = new SoneInserter(core, eventBus, freenetInterface, sone);
-               InsertInformation insertInformation = soneInserter.new InsertInformation(sone);
-               HashMap<String, Object> manifestEntries = insertInformation.generateManifestEntries();
-               assertThat(manifestEntries.keySet(), containsInAnyOrder("index.html", "sone.xml"));
-               assertThat(insertInformation.getInsertUri(), is(insertUri));
-               assertThat(insertInformation.getFingerprint(), is(fingerprint));
+               when(core.getSone(anyString())).thenReturn(null);
+       }
+
+       @Test
+       public void insertionDelayIsForwardedToSoneInserter() {
+               EventBus eventBus = new AsyncEventBus(sameThreadExecutor());
+               eventBus.register(new SoneInserter(core, eventBus, freenetInterface, "SoneId"));
+               eventBus.post(new InsertionDelayChangedEvent(15));
+               assertThat(SoneInserter.getInsertionDelay().get(), is(15));
        }
 
        private Sone createSone(FreenetURI insertUri, String fingerprint) {
@@ -56,7 +75,212 @@ public class SoneInserterTest {
                when(sone.getInsertUri()).thenReturn(insertUri);
                when(sone.getFingerprint()).thenReturn(fingerprint);
                when(sone.getRootAlbum()).thenReturn(mock(Album.class));
+               when(core.getSone(anyString())).thenReturn(sone);
                return sone;
        }
 
+       @Test
+       public void isModifiedIsTrueIfModificationDetectorSaysSo() {
+               SoneModificationDetector soneModificationDetector = mock(SoneModificationDetector.class);
+               when(soneModificationDetector.isModified()).thenReturn(true);
+               SoneInserter soneInserter = new SoneInserter(core, eventBus, freenetInterface, "SoneId", soneModificationDetector, 1);
+               assertThat(soneInserter.isModified(), is(true));
+       }
+
+       @Test
+       public void isModifiedIsFalseIfModificationDetectorSaysSo() {
+               SoneModificationDetector soneModificationDetector = mock(SoneModificationDetector.class);
+               SoneInserter soneInserter = new SoneInserter(core, eventBus, freenetInterface, "SoneId", soneModificationDetector, 1);
+               assertThat(soneInserter.isModified(), is(false));
+       }
+
+       @Test
+       public void lastFingerprintIsStoredCorrectly() {
+               SoneInserter soneInserter = new SoneInserter(core, eventBus, freenetInterface, "SoneId");
+               soneInserter.setLastInsertFingerprint("last-fingerprint");
+               assertThat(soneInserter.getLastInsertFingerprint(), is("last-fingerprint"));
+       }
+
+       @Test
+       public void soneInserterStopsWhenItShould() {
+               SoneInserter soneInserter = new SoneInserter(core, eventBus, freenetInterface, "SoneId");
+               soneInserter.stop();
+               soneInserter.serviceRun();
+       }
+
+       @Test
+       public void soneInserterInsertsASoneIfItIsEligible() throws SoneException {
+               FreenetURI insertUri = mock(FreenetURI.class);
+               final FreenetURI finalUri = mock(FreenetURI.class);
+               String fingerprint = "fingerprint";
+               Sone sone = createSone(insertUri, fingerprint);
+               SoneModificationDetector soneModificationDetector = mock(SoneModificationDetector.class);
+               when(soneModificationDetector.isEligibleForInsert()).thenReturn(true);
+               when(freenetInterface.insertDirectory(eq(insertUri), any(HashMap.class), eq("index.html"))).thenReturn(finalUri);
+               final SoneInserter soneInserter = new SoneInserter(core, eventBus, freenetInterface, "SoneId", soneModificationDetector, 1);
+               doAnswer(new Answer<Void>() {
+                       @Override
+                       public Void answer(InvocationOnMock invocation) throws Throwable {
+                               soneInserter.stop();
+                               return null;
+                       }
+               }).when(core).touchConfiguration();
+               soneInserter.serviceRun();
+               ArgumentCaptor<SoneEvent> soneEvents = ArgumentCaptor.forClass(SoneEvent.class);
+               verify(freenetInterface).insertDirectory(eq(insertUri), any(HashMap.class), eq("index.html"));
+               verify(eventBus, times(2)).post(soneEvents.capture());
+               assertThat(soneEvents.getAllValues().get(0), instanceOf(SoneInsertingEvent.class));
+               assertThat(soneEvents.getAllValues().get(0).sone(), is(sone));
+               assertThat(soneEvents.getAllValues().get(1), instanceOf(SoneInsertedEvent.class));
+               assertThat(soneEvents.getAllValues().get(1).sone(), is(sone));
+       }
+
+       @Test
+       public void soneInserterBailsOutIfItIsStoppedWhileInserting() throws SoneException {
+               FreenetURI insertUri = mock(FreenetURI.class);
+               final FreenetURI finalUri = mock(FreenetURI.class);
+               String fingerprint = "fingerprint";
+               Sone sone = createSone(insertUri, fingerprint);
+               SoneModificationDetector soneModificationDetector = mock(SoneModificationDetector.class);
+               when(soneModificationDetector.isEligibleForInsert()).thenReturn(true);
+               final SoneInserter soneInserter = new SoneInserter(core, eventBus, freenetInterface, "SoneId", soneModificationDetector, 1);
+               when(freenetInterface.insertDirectory(eq(insertUri), any(HashMap.class), eq("index.html"))).thenAnswer(new Answer<FreenetURI>() {
+                       @Override
+                       public FreenetURI answer(InvocationOnMock invocation) throws Throwable {
+                               soneInserter.stop();
+                               return finalUri;
+                       }
+               });
+               soneInserter.serviceRun();
+               ArgumentCaptor<SoneEvent> soneEvents = ArgumentCaptor.forClass(SoneEvent.class);
+               verify(freenetInterface).insertDirectory(eq(insertUri), any(HashMap.class), eq("index.html"));
+               verify(eventBus, times(2)).post(soneEvents.capture());
+               assertThat(soneEvents.getAllValues().get(0), instanceOf(SoneInsertingEvent.class));
+               assertThat(soneEvents.getAllValues().get(0).sone(), is(sone));
+               assertThat(soneEvents.getAllValues().get(1), instanceOf(SoneInsertedEvent.class));
+               assertThat(soneEvents.getAllValues().get(1).sone(), is(sone));
+               verify(core, never()).touchConfiguration();
+       }
+
+       @Test
+       public void soneInserterDoesNotInsertSoneIfItIsNotEligible() throws SoneException {
+               FreenetURI insertUri = mock(FreenetURI.class);
+               String fingerprint = "fingerprint";
+               Sone sone = createSone(insertUri, fingerprint);
+               SoneModificationDetector soneModificationDetector = mock(SoneModificationDetector.class);
+               final SoneInserter soneInserter = new SoneInserter(core, eventBus, freenetInterface, "SoneId", soneModificationDetector, 1);
+               new Thread(new Runnable() {
+                       @Override
+                       public void run() {
+                               try {
+                                       Thread.sleep(500);
+                               } catch (InterruptedException ie1) {
+                                       throw new RuntimeException(ie1);
+                               }
+                               soneInserter.stop();
+                       }
+               }).start();
+               soneInserter.serviceRun();
+               verify(freenetInterface, never()).insertDirectory(eq(insertUri), any(HashMap.class), eq("index.html"));
+               verify(eventBus, never()).post(argThat(org.hamcrest.Matchers.any(SoneEvent.class)));
+       }
+
+       @Test
+       public void soneInserterPostsAbortedEventIfAnExceptionOccurs() throws SoneException {
+               FreenetURI insertUri = mock(FreenetURI.class);
+               String fingerprint = "fingerprint";
+               Sone sone = createSone(insertUri, fingerprint);
+               SoneModificationDetector soneModificationDetector = mock(SoneModificationDetector.class);
+               when(soneModificationDetector.isEligibleForInsert()).thenReturn(true);
+               final SoneInserter soneInserter = new SoneInserter(core, eventBus, freenetInterface, "SoneId", soneModificationDetector, 1);
+               final SoneException soneException = new SoneException(new Exception());
+               when(freenetInterface.insertDirectory(eq(insertUri), any(HashMap.class), eq("index.html"))).thenAnswer(new Answer<FreenetURI>() {
+                       @Override
+                       public FreenetURI answer(InvocationOnMock invocation) throws Throwable {
+                               soneInserter.stop();
+                               throw soneException;
+                       }
+               });
+               soneInserter.serviceRun();
+               ArgumentCaptor<SoneEvent> soneEvents = ArgumentCaptor.forClass(SoneEvent.class);
+               verify(freenetInterface).insertDirectory(eq(insertUri), any(HashMap.class), eq("index.html"));
+               verify(eventBus, times(2)).post(soneEvents.capture());
+               assertThat(soneEvents.getAllValues().get(0), instanceOf(SoneInsertingEvent.class));
+               assertThat(soneEvents.getAllValues().get(0).sone(), is(sone));
+               assertThat(soneEvents.getAllValues().get(1), instanceOf(SoneInsertAbortedEvent.class));
+               assertThat(soneEvents.getAllValues().get(1).sone(), is(sone));
+               verify(core, never()).touchConfiguration();
+       }
+
+       @Test
+       public void soneInserterExitsIfSoneIsUnknown() {
+               SoneModificationDetector soneModificationDetector =
+                               mock(SoneModificationDetector.class);
+               SoneInserter soneInserter =
+                               new SoneInserter(core, eventBus, freenetInterface, "SoneId",
+                                               soneModificationDetector, 1);
+               when(soneModificationDetector.isEligibleForInsert()).thenReturn(true);
+               when(core.getSone("SoneId")).thenReturn(null);
+               soneInserter.serviceRun();
+       }
+
+       @Test
+       public void soneInserterCatchesExceptionAndContinues() {
+               SoneModificationDetector soneModificationDetector =
+                               mock(SoneModificationDetector.class);
+               final SoneInserter soneInserter =
+                               new SoneInserter(core, eventBus, freenetInterface, "SoneId",
+                                               soneModificationDetector, 1);
+               Answer<Optional<Sone>> stopInserterAndThrowException =
+                               new Answer<Optional<Sone>>() {
+                                       @Override
+                                       public Optional<Sone> answer(
+                                                       InvocationOnMock invocation) {
+                                               soneInserter.stop();
+                                               throw new NullPointerException();
+                                       }
+                               };
+               when(soneModificationDetector.isEligibleForInsert()).thenAnswer(
+                               stopInserterAndThrowException);
+               soneInserter.serviceRun();
+       }
+
+       @Test
+       public void templateIsRenderedCorrectlyForManifestElement()
+       throws IOException {
+               Map<String, Object> soneProperties = new HashMap<String, Object>();
+               soneProperties.put("id", "SoneId");
+               ManifestCreator manifestCreator = new ManifestCreator(core, soneProperties);
+               long now = currentTimeMillis();
+               when(core.getStartupTime()).thenReturn(now);
+               ManifestElement manifestElement = manifestCreator.createManifestElement("test.txt", "plain/text; charset=utf-8", "sone-inserter-manifest.txt");
+               assertThat(manifestElement.getName(), is("test.txt"));
+               assertThat(manifestElement.getMimeTypeOverride(), is("plain/text; charset=utf-8"));
+               String templateContent = new String(toByteArray(manifestElement.getData().getInputStream()), Charsets.UTF_8);
+               assertThat(templateContent, containsString("Sone Version: " + SonePlugin.getPluginVersion() + "\n"));
+               assertThat(templateContent, containsString("Core Startup: " + now + "\n"));
+               assertThat(templateContent, containsString("Sone ID: " + "SoneId" + "\n"));
+       }
+
+       @Test
+       public void invalidTemplateReturnsANullManifestElement() {
+               Map<String, Object> soneProperties = new HashMap<String, Object>();
+               ManifestCreator manifestCreator = new ManifestCreator(core, soneProperties);
+               assertThat(manifestCreator.createManifestElement("test.txt",
+                               "plain/text; charset=utf-8",
+                               "sone-inserter-invalid-manifest.txt"),
+                               nullValue());
+       }
+
+       @Test
+       public void errorWhileRenderingTemplateReturnsANullManifestElement() {
+               Map<String, Object> soneProperties = new HashMap<String, Object>();
+               ManifestCreator manifestCreator = new ManifestCreator(core, soneProperties);
+               when(core.toString()).thenThrow(NullPointerException.class);
+               assertThat(manifestCreator.createManifestElement("test.txt",
+                               "plain/text; charset=utf-8",
+                               "sone-inserter-faulty-manifest.txt"),
+                               nullValue());
+       }
+
 }