Added ability to remove serve events (logged requests) by ID

wiremock · Sep 6, 2019 · 25b057a · 25b057a
1 parent 42efe35
commit 25b057a
Show file tree

Hide file tree

Showing 11 changed files with 144 additions and 12 deletions.
diff --git a/src/main/java/com/github/tomakehurst/wiremock/WireMockServer.java b/src/main/java/com/github/tomakehurst/wiremock/WireMockServer.java
@@ -380,6 +380,11 @@ public FindRequestsResult findUnmatchedRequests() {
         return wireMockApp.findUnmatchedRequests();
     }
 
+    @Override
+    public void removeServeEvent(UUID eventId) {
+        wireMockApp.removeServeEvent(eventId);
+    }
+
     @Override
     public void updateGlobalSettings(GlobalSettings newSettings) {
         wireMockApp.updateGlobalSettings(newSettings);

diff --git a/src/main/java/com/github/tomakehurst/wiremock/admin/AdminRoutes.java b/src/main/java/com/github/tomakehurst/wiremock/admin/AdminRoutes.java
@@ -89,6 +89,7 @@ private void initDefaultRoutes(Router router) {
         router.add(GET,  "/requests/unmatched", FindUnmatchedRequestsTask.class);
         router.add(GET,  "/requests/unmatched/near-misses", FindNearMissesForUnmatchedTask.class);
         router.add(GET,  "/requests/{id}", GetServedStubTask.class);
+        router.add(DELETE, "/requests/{id}", RemoveServeEventTask.class);
 
         router.add(POST, "/recordings/snapshot", SnapshotTask.class);
         router.add(POST, "/recordings/start", StartRecordingTask.class);

diff --git a/src/main/java/com/github/tomakehurst/wiremock/admin/RemoveServeEventTask.java b/src/main/java/com/github/tomakehurst/wiremock/admin/RemoveServeEventTask.java
@@ -0,0 +1,19 @@
+package com.github.tomakehurst.wiremock.admin;
+
+import com.github.tomakehurst.wiremock.admin.model.PathParams;
+import com.github.tomakehurst.wiremock.core.Admin;
+import com.github.tomakehurst.wiremock.http.Request;
+import com.github.tomakehurst.wiremock.http.ResponseDefinition;
+
+import java.util.UUID;
+
+public class RemoveServeEventTask implements AdminTask {
+
+    @Override
+    public ResponseDefinition execute(Admin admin, Request request, PathParams pathParams) {
+        String idString = pathParams.get("id");
+        UUID id = UUID.fromString(idString);
+        admin.removeServeEvent(id);
+        return ResponseDefinition.okEmptyJson();
+    }
+}
diff --git a/src/main/java/com/github/tomakehurst/wiremock/client/HttpAdminClient.java b/src/main/java/com/github/tomakehurst/wiremock/client/HttpAdminClient.java
@@ -241,6 +241,15 @@ public FindRequestsResult findUnmatchedRequests() {
         return Json.read(body, FindRequestsResult.class);
     }
 
+    @Override
+    public void removeServeEvent(UUID eventId) {
+        executeRequest(
+                adminRoutes.requestSpecForTask(RemoveServeEventTask.class),
+                PathParams.single("id", eventId),
+                Void.class
+        );
+    }
+
     @Override
     public FindNearMissesResult findNearMissesForUnmatchedRequests() {
         String body = getJsonAssertOkAndReturnBody(urlFor(FindNearMissesForUnmatchedTask.class));

diff --git a/src/main/java/com/github/tomakehurst/wiremock/client/WireMock.java b/src/main/java/com/github/tomakehurst/wiremock/client/WireMock.java
@@ -581,6 +581,22 @@ public List<ServeEvent> getServeEvents() {
         return admin.getServeEvents().getRequests();
     }
 
+    public static void removeServeEvent(UUID eventId) {
+	    defaultInstance.get().removeEvent(eventId);
+    }
+
+    public void removeEvent(UUID eventId) {
+	    admin.removeServeEvent(eventId);
+    }
+
+    public void removeEvents(RequestPatternBuilder requestPatternBuilder) {
+
+    }
+
+    public static void removeServeEvents(RequestPatternBuilder requestPatternBuilder) {
+	    defaultInstance.get().removeEvents(requestPatternBuilder);
+    }
+
     public static RequestPatternBuilder getRequestedFor(UrlPattern urlPattern) {
 		return new RequestPatternBuilder(RequestMethod.GET, urlPattern);
 	}

diff --git a/src/main/java/com/github/tomakehurst/wiremock/core/Admin.java b/src/main/java/com/github/tomakehurst/wiremock/core/Admin.java
@@ -53,6 +53,8 @@ public interface Admin {
     FindRequestsResult findRequestsMatching(RequestPattern requestPattern);
     FindRequestsResult findUnmatchedRequests();
 
+    void removeServeEvent(UUID eventId);
+
     FindNearMissesResult findTopNearMissesFor(LoggedRequest loggedRequest);
     FindNearMissesResult findTopNearMissesFor(RequestPattern requestPattern);
     FindNearMissesResult findNearMissesForUnmatchedRequests();

diff --git a/src/main/java/com/github/tomakehurst/wiremock/core/WireMockApp.java b/src/main/java/com/github/tomakehurst/wiremock/core/WireMockApp.java
@@ -348,6 +348,11 @@ public FindRequestsResult findUnmatchedRequests() {
         }
     }
 
+    @Override
+    public void removeServeEvent(UUID eventId) {
+        requestJournal.removeEvent(eventId);
+    }
+
     @Override
     public FindNearMissesResult findNearMissesForUnmatchedRequests() {
         ImmutableList.Builder<NearMiss> listBuilder = ImmutableList.builder();

diff --git a/src/main/java/com/github/tomakehurst/wiremock/verification/DisabledRequestJournal.java b/src/main/java/com/github/tomakehurst/wiremock/verification/DisabledRequestJournal.java
@@ -51,4 +51,8 @@ public void reset() {
     @Override
     public void requestReceived(ServeEvent serveEvent) {
     }
+
+    @Override
+    public void removeEvent(UUID eventId) {
+    }
 }
diff --git a/src/main/java/com/github/tomakehurst/wiremock/verification/InMemoryRequestJournal.java b/src/main/java/com/github/tomakehurst/wiremock/verification/InMemoryRequestJournal.java
@@ -22,7 +22,9 @@
 import com.google.common.base.Function;
 import com.google.common.base.Optional;
 import com.google.common.base.Predicate;
+import com.google.common.collect.FluentIterable;
 import com.google.common.collect.ImmutableList;
+import com.google.common.collect.Iterables;
 
 import java.util.Collections;
 import java.util.List;
@@ -56,21 +58,27 @@ public List<LoggedRequest> getRequestsMatching(RequestPattern requestPattern) {
 		return ImmutableList.copyOf(filter(getRequests(), thatMatch(requestPattern)));
 	}
 
-    private Predicate<Request> matchedBy(final RequestPattern requestPattern) {
-		return new Predicate<Request>() {
-			public boolean apply(Request input) {
-				return requestPattern.isMatchedBy(input, Collections.<String, RequestMatcherExtension>emptyMap());
-			}
-		};
-	}
-
 	@Override
 	public void requestReceived(ServeEvent serveEvent) {
 		serveEvents.add(serveEvent);
         removeOldEntries();
 	}
 
-    @Override
+	@Override
+	public void removeEvent(final UUID eventId) {
+		Iterable<ServeEvent> toDelete = filter(serveEvents, new Predicate<ServeEvent>() {
+			@Override
+			public boolean apply(ServeEvent input) {
+				return input.getId().equals(eventId);
+			}
+		});
+
+		for (ServeEvent event: toDelete) {
+			serveEvents.remove(event);
+		}
+	}
+
+	@Override
     public List<ServeEvent> getAllServeEvents() {
         return ImmutableList.copyOf(serveEvents).reverse();
     }

diff --git a/src/main/java/com/github/tomakehurst/wiremock/verification/RequestJournal.java b/src/main/java/com/github/tomakehurst/wiremock/verification/RequestJournal.java
@@ -33,4 +33,6 @@ public interface RequestJournal {
 	void reset();
 
     void requestReceived(ServeEvent serveEvent);
+
+    void removeEvent(UUID eventId);
 }
diff --git a/src/test/java/com/github/tomakehurst/wiremock/VerificationAcceptanceTest.java b/src/test/java/com/github/tomakehurst/wiremock/VerificationAcceptanceTest.java
@@ -22,32 +22,35 @@
 import com.github.tomakehurst.wiremock.http.Request;
 import com.github.tomakehurst.wiremock.junit.WireMockRule;
 import com.github.tomakehurst.wiremock.matching.*;
+import com.github.tomakehurst.wiremock.stubbing.ServeEvent;
+import com.github.tomakehurst.wiremock.testsupport.WireMatchers;
 import com.github.tomakehurst.wiremock.testsupport.WireMockTestClient;
 import com.github.tomakehurst.wiremock.verification.LoggedRequest;
 import com.github.tomakehurst.wiremock.verification.RequestJournalDisabledException;
 import com.google.common.base.Optional;
 import org.apache.http.HttpEntity;
 import org.apache.http.entity.ByteArrayEntity;
 import org.apache.http.entity.StringEntity;
+import org.junit.Ignore;
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.experimental.runners.Enclosed;
 import org.junit.runner.RunWith;
 
 import javax.swing.text.html.parser.Entity;
 import java.util.List;
+import java.util.UUID;
 
 import static com.github.tomakehurst.wiremock.client.WireMock.*;
 import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.options;
 import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.wireMockConfig;
 import static com.github.tomakehurst.wiremock.matching.RequestPatternBuilder.forCustomMatcher;
 import static com.github.tomakehurst.wiremock.testsupport.TestHttpHeader.withHeader;
+import static com.github.tomakehurst.wiremock.testsupport.WireMatchers.findServeEventWithUrl;
 import static com.github.tomakehurst.wiremock.verification.diff.JUnitStyleDiffRenderer.junitStyleDiffMessage;
 import static java.lang.System.lineSeparator;
 import static org.apache.http.entity.ContentType.TEXT_PLAIN;
-import static org.hamcrest.Matchers.allOf;
-import static org.hamcrest.Matchers.containsString;
-import static org.hamcrest.Matchers.is;
+import static org.hamcrest.Matchers.*;
 import static org.junit.Assert.assertThat;
 import static org.junit.Assert.assertTrue;
 import static org.junit.Assert.fail;
@@ -645,6 +648,64 @@ public MatchResult match(Request request, Parameters parameters) {
             }));
         }
 
+        @Test
+        public void removesEventsById() {
+            stubFor(get(anyUrl()).willReturn(ok()));
+
+            testClient.get("/one", withHeader("My-Header", "one"));
+            testClient.get("/one", withHeader("My-Header", "two"));
+            testClient.get("/two");
+
+            List<ServeEvent> initialServeEvents = getAllServeEvents();
+            assertThat(initialServeEvents.size(), is(3));
+
+            removeServeEvent(initialServeEvents.get(0).getId());
+            removeServeEvent(initialServeEvents.get(2).getId());
+
+            List<ServeEvent> finalServeEvents = getAllServeEvents();
+
+            assertThat(finalServeEvents.size(), is(1));
+            assertThat(finalServeEvents.get(0).getRequest().header("My-Header").firstValue(), is("two"));
+        }
+
+        @Test
+        public void doesNothingWhenAttemptingToRemoveANonExistentServeEvent() {
+            stubFor(get(anyUrl()).willReturn(ok()));
+
+            testClient.get("/one", withHeader("My-Header", "one"));
+            testClient.get("/one", withHeader("My-Header", "two"));
+            testClient.get("/two");
+
+            List<ServeEvent> initialServeEvents = getAllServeEvents();
+            assertThat(initialServeEvents.size(), is(3));
+
+            removeServeEvent(UUID.randomUUID());
+
+            List<ServeEvent> finalServeEvents = getAllServeEvents();
+
+            assertThat(finalServeEvents.size(), is(3));
+        }
+
+//        @Test
+//        public void removesEventsPerSuppliedFilter() {
+//            stubFor(get(anyUrl()).willReturn(ok()));
+//
+//            testClient.get("/one", withHeader("My-Header", "one"));
+//            testClient.get("/one", withHeader("My-Header", "two"));
+//            testClient.get("/two");
+//
+//            removeServeEvents(getRequestedFor(urlPathEqualTo("/one")).withHeader("My-Header", equalTo("two")));
+//
+//            List<ServeEvent> serveEvents = getAllServeEvents();
+//            assertThat(serveEvents.size(), is(2));
+//
+//            ServeEvent event1 = findServeEventWithUrl(serveEvents, "/one");
+//            assertThat(event1.getRequest().header("My-Header").firstValue(), is("one"));
+//
+//            ServeEvent event2 = findServeEventWithUrl(serveEvents, "/two");
+//            assertThat(event2, notNullValue());
+//        }
+
     }
 
     public static class JournalDisabled {