Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow filtering by event type #1367

Merged
merged 19 commits into from
Jun 4, 2020
Merged
Show file tree
Hide file tree
Changes from 18 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@

import java.util.List;
import java.util.Map;
import java.util.stream.Stream;

import javax.annotation.CheckForNull;

import com.github.dockerjava.api.model.Event;
import com.github.dockerjava.api.model.EventType;

/**
* Get events
Expand Down Expand Up @@ -33,6 +35,24 @@ public interface EventsCmd extends AsyncDockerCmd<EventsCmd, Event> {
*/
EventsCmd withEventFilter(String... event);

/**
* @param eventTypes event types to filter
*/
EventsCmd withEventTypeFilter(String... eventTypes);

/**
* This provides a type safe version of {@link #withEventTypeFilter(String...)}.
*
* @param eventTypes event types to filter
*/
default EventsCmd withEventTypeFilter(EventType... eventTypes) {
return withEventTypeFilter(
Stream.of(eventTypes)
.map(EventType::getValue)
.toArray(String[]::new)
);
}

/**
* @param image
* - image to filter
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,13 @@ public EventsCmd withEventFilter(String... event) {
return this;
}

@Override
public EventsCmd withEventTypeFilter(String... eventTypes) {
checkNotNull(eventTypes, "event types have not been specified");
this.filters.withEventTypes(eventTypes);
return this;
}

@Override
public EventsCmd withLabelFilter(String... label) {
checkNotNull(label, "label have not been specified");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
import java.util.Map;
import java.util.Map.Entry;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
import java.util.stream.Stream;

/**
* Representation of Docker filters.
Expand Down Expand Up @@ -64,6 +66,16 @@ public List<String> getContainer() {
return getFilter("container");
}

/**
* Filter by event types
*
* @param eventTypes an array of event types
*/
public FiltersBuilder withEventTypes(String... eventTypes) {
withFilter("type", Stream.of(eventTypes).collect(Collectors.toList()));
return this;
}

/**
* Filter by labels
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import com.github.dockerjava.api.async.ResultCallback;
import com.github.dockerjava.api.command.CreateContainerResponse;
import com.github.dockerjava.api.model.Event;
import com.github.dockerjava.api.model.EventType;
import com.github.dockerjava.utils.TestUtils;
import org.junit.Test;
import org.slf4j.Logger;
Expand Down Expand Up @@ -113,6 +114,57 @@ public void testEventStreamingWithFilter() throws Exception {
}
}

@Test
public void testEventStreamingWithContainerEventTypeFilter() throws Exception {
bsideup marked this conversation as resolved.
Show resolved Hide resolved
assumeNotSwarm("", dockerRule);

String startTime = getEpochTime();
int expectedEvents = 1;

EventsTestCallback eventCallback = new EventsTestCallback(expectedEvents);

dockerRule.getClient().eventsCmd()
.withSince(startTime)
.withEventTypeFilter(EventType.CONTAINER)
.withEventFilter("start")
bsideup marked this conversation as resolved.
Show resolved Hide resolved
.exec(eventCallback);

generateEvents();

List<Event> events = eventCallback.awaitExpectedEvents(30, TimeUnit.SECONDS);

// we should only get "start" events here
for (Event event : events) {
assertThat("Received event: " + event, event.getAction(), is("start"));
bsideup marked this conversation as resolved.
Show resolved Hide resolved
assertThat("Received event: " + event, event.getType(), is(EventType.CONTAINER));
}
}

@Test
public void testEventStreamingWithImageEventTypeFilter() throws Exception {
assumeNotSwarm("", dockerRule);

String startTime = getEpochTime();
int expectedEvents = 1;

EventsTestCallback eventCallback = new EventsTestCallback(expectedEvents);

dockerRule.getClient().eventsCmd()
.withSince(startTime)
.withEventTypeFilter(EventType.IMAGE)
.exec(eventCallback);

generateEvents();

List<Event> events = eventCallback.awaitExpectedEvents(30, TimeUnit.SECONDS);

// we should only get "pull" events here
for (Event event : events) {
assertThat("Received event: " + event, event.getAction(), is("pull"));
bsideup marked this conversation as resolved.
Show resolved Hide resolved
assertThat("Received event: " + event, event.getType(), is(EventType.IMAGE));
}
}

/**
* This method generates some events and returns the number of events being generated
*/
Expand Down