Simplify the event enabling code by allowing RefEvents only
Move the event type check in ActionController and pass only RefEvents
to the code enabling events in ItsConfig.
Modify the PropertyExtractor class to comply with event type changes.
This refactoring is needed work in order to ease the handling of
multiple servers which is done in a follow up change.
Change-Id: I038493bbea0bc91742c1dea64f2c88cfa1b7c41e
diff --git a/src/main/java/com/googlesource/gerrit/plugins/its/base/its/ItsConfig.java b/src/main/java/com/googlesource/gerrit/plugins/its/base/its/ItsConfig.java
index 99fe80c..55edae3 100644
--- a/src/main/java/com/googlesource/gerrit/plugins/its/base/its/ItsConfig.java
+++ b/src/main/java/com/googlesource/gerrit/plugins/its/base/its/ItsConfig.java
@@ -28,8 +28,8 @@
import com.google.gerrit.server.events.ChangeMergedEvent;
import com.google.gerrit.server.events.ChangeRestoredEvent;
import com.google.gerrit.server.events.CommentAddedEvent;
-import com.google.gerrit.server.events.Event;
import com.google.gerrit.server.events.PatchSetCreatedEvent;
+import com.google.gerrit.server.events.RefEvent;
import com.google.gerrit.server.events.RefUpdatedEvent;
import com.google.gerrit.server.project.NoSuchProjectException;
import com.google.gerrit.server.project.ProjectCache;
@@ -76,29 +76,17 @@
// Plugin enablement --------------------------------------------------------
- public boolean isEnabled(Event event) {
- if (event instanceof PatchSetCreatedEvent) {
- PatchSetCreatedEvent e = (PatchSetCreatedEvent) event;
- return isEnabled(e.getProjectNameKey(), e.getRefName());
- } else if (event instanceof CommentAddedEvent) {
- CommentAddedEvent e = (CommentAddedEvent) event;
- return isEnabled(e.getProjectNameKey(), e.getRefName());
- } else if (event instanceof ChangeMergedEvent) {
- ChangeMergedEvent e = (ChangeMergedEvent) event;
- return isEnabled(e.getProjectNameKey(), e.getRefName());
- } else if (event instanceof ChangeAbandonedEvent) {
- ChangeAbandonedEvent e = (ChangeAbandonedEvent) event;
- return isEnabled(e.getProjectNameKey(), e.getRefName());
- } else if (event instanceof ChangeRestoredEvent) {
- ChangeRestoredEvent e = (ChangeRestoredEvent) event;
- return isEnabled(e.getProjectNameKey(), e.getRefName());
- } else if (event instanceof RefUpdatedEvent) {
- RefUpdatedEvent e = (RefUpdatedEvent) event;
- return isEnabled(e.getProjectNameKey(), e.getRefName());
- } else {
- log.debug("Event {} not recognised and ignored", event);
- return false;
+ public boolean isEnabled(RefEvent event) {
+ if (event instanceof PatchSetCreatedEvent
+ || event instanceof CommentAddedEvent
+ || event instanceof ChangeMergedEvent
+ || event instanceof ChangeAbandonedEvent
+ || event instanceof ChangeRestoredEvent
+ || event instanceof RefUpdatedEvent) {
+ return isEnabled(event.getProjectNameKey(), event.getRefName());
}
+ log.debug("Event {} not recognised and ignored", event);
+ return false;
}
public boolean isEnabled(Project.NameKey projectNK, String refName) {
diff --git a/src/main/java/com/googlesource/gerrit/plugins/its/base/util/PropertyExtractor.java b/src/main/java/com/googlesource/gerrit/plugins/its/base/util/PropertyExtractor.java
index 3442cbf..a969b4c 100644
--- a/src/main/java/com/googlesource/gerrit/plugins/its/base/util/PropertyExtractor.java
+++ b/src/main/java/com/googlesource/gerrit/plugins/its/base/util/PropertyExtractor.java
@@ -27,9 +27,9 @@
import com.google.gerrit.server.events.ChangeMergedEvent;
import com.google.gerrit.server.events.ChangeRestoredEvent;
import com.google.gerrit.server.events.CommentAddedEvent;
-import com.google.gerrit.server.events.Event;
import com.google.gerrit.server.events.PatchSetCreatedEvent;
import com.google.gerrit.server.events.PatchSetEvent;
+import com.google.gerrit.server.events.RefEvent;
import com.google.gerrit.server.events.RefUpdatedEvent;
import com.google.inject.Inject;
import com.googlesource.gerrit.plugins.its.base.workflow.Property;
@@ -167,7 +167,7 @@
* @param event The event to extract property sets from.
* @return sets of property sets extracted from the event.
*/
- public Set<Set<Property>> extractFrom(Event event) {
+ public Set<Set<Property>> extractFrom(RefEvent event) {
Map<String, Set<String>> associations = null;
Set<Set<Property>> ret = Sets.newHashSet();
diff --git a/src/main/java/com/googlesource/gerrit/plugins/its/base/workflow/ActionController.java b/src/main/java/com/googlesource/gerrit/plugins/its/base/workflow/ActionController.java
index 6ef9143..844ac91 100644
--- a/src/main/java/com/googlesource/gerrit/plugins/its/base/workflow/ActionController.java
+++ b/src/main/java/com/googlesource/gerrit/plugins/its/base/workflow/ActionController.java
@@ -16,6 +16,7 @@
import com.google.gerrit.server.events.Event;
import com.google.gerrit.server.events.EventListener;
+import com.google.gerrit.server.events.RefEvent;
import com.google.inject.Inject;
import com.googlesource.gerrit.plugins.its.base.its.ItsConfig;
import com.googlesource.gerrit.plugins.its.base.util.PropertyExtractor;
@@ -48,11 +49,16 @@
@Override
public void onEvent(Event event) {
- if (!itsConfig.isEnabled(event)) {
- return;
+ if (event instanceof RefEvent) {
+ RefEvent refEvent = (RefEvent) event;
+ if (itsConfig.isEnabled(refEvent)) {
+ handleEvent(refEvent);
+ }
}
+ }
- Set<Set<Property>> propertiesCollections = propertyExtractor.extractFrom(event);
+ private void handleEvent(RefEvent refEvent) {
+ Set<Set<Property>> propertiesCollections = propertyExtractor.extractFrom(refEvent);
for (Set<Property> properties : propertiesCollections) {
Collection<ActionRequest> actions = ruleBase.actionRequestsFor(properties);
if (!actions.isEmpty()) {
diff --git a/src/test/java/com/googlesource/gerrit/plugins/its/base/its/ItsConfigTest.java b/src/test/java/com/googlesource/gerrit/plugins/its/base/its/ItsConfigTest.java
index 6561d00..9664542 100644
--- a/src/test/java/com/googlesource/gerrit/plugins/its/base/its/ItsConfigTest.java
+++ b/src/test/java/com/googlesource/gerrit/plugins/its/base/its/ItsConfigTest.java
@@ -28,8 +28,8 @@
import com.google.gerrit.server.events.ChangeMergedEvent;
import com.google.gerrit.server.events.ChangeRestoredEvent;
import com.google.gerrit.server.events.CommentAddedEvent;
-import com.google.gerrit.server.events.Event;
import com.google.gerrit.server.events.PatchSetCreatedEvent;
+import com.google.gerrit.server.events.RefEvent;
import com.google.gerrit.server.events.RefUpdatedEvent;
import com.google.gerrit.server.project.ProjectCache;
import com.google.gerrit.server.project.ProjectState;
@@ -469,7 +469,7 @@
}
public void BROKEN_testIsEnabledUnknownEvent() {
- Event event = new Event("foo") {};
+ RefEvent event = createMock(RefEvent.class);
ItsConfig itsConfig = createItsConfig();
diff --git a/src/test/java/com/googlesource/gerrit/plugins/its/base/util/PropertyExtractorTest.java b/src/test/java/com/googlesource/gerrit/plugins/its/base/util/PropertyExtractorTest.java
index 981eeae..7255f43 100644
--- a/src/test/java/com/googlesource/gerrit/plugins/its/base/util/PropertyExtractorTest.java
+++ b/src/test/java/com/googlesource/gerrit/plugins/its/base/util/PropertyExtractorTest.java
@@ -22,6 +22,7 @@
import com.google.gerrit.extensions.config.FactoryModule;
import com.google.gerrit.reviewdb.client.Change;
import com.google.gerrit.reviewdb.client.PatchSet;
+import com.google.gerrit.reviewdb.client.Project.NameKey;
import com.google.gerrit.server.data.AccountAttribute;
import com.google.gerrit.server.data.ApprovalAttribute;
import com.google.gerrit.server.data.ChangeAttribute;
@@ -31,8 +32,8 @@
import com.google.gerrit.server.events.ChangeMergedEvent;
import com.google.gerrit.server.events.ChangeRestoredEvent;
import com.google.gerrit.server.events.CommentAddedEvent;
-import com.google.gerrit.server.events.Event;
import com.google.gerrit.server.events.PatchSetCreatedEvent;
+import com.google.gerrit.server.events.RefEvent;
import com.google.gerrit.server.events.RefUpdatedEvent;
import com.google.inject.Guice;
import com.google.inject.Injector;
@@ -330,7 +331,7 @@
}
private void eventHelper(
- Event event, String className, String type, Set<Property> common, boolean withRevision) {
+ RefEvent event, String className, String type, Set<Property> common, boolean withRevision) {
PropertyExtractor propertyExtractor = injector.getInstance(PropertyExtractor.class);
Property propertyItsName = createMock(Property.class);
@@ -421,9 +422,19 @@
}
}
- private class DummyEvent extends Event {
+ private class DummyEvent extends RefEvent {
public DummyEvent() {
super(null);
}
+
+ @Override
+ public String getRefName() {
+ return null;
+ }
+
+ @Override
+ public NameKey getProjectNameKey() {
+ return null;
+ }
}
}
diff --git a/src/test/java/com/googlesource/gerrit/plugins/its/base/workflow/ActionControllerTest.java b/src/test/java/com/googlesource/gerrit/plugins/its/base/workflow/ActionControllerTest.java
index d2926f9..7c85f7f 100644
--- a/src/test/java/com/googlesource/gerrit/plugins/its/base/workflow/ActionControllerTest.java
+++ b/src/test/java/com/googlesource/gerrit/plugins/its/base/workflow/ActionControllerTest.java
@@ -20,7 +20,7 @@
import com.google.common.collect.Sets;
import com.google.gerrit.extensions.config.FactoryModule;
import com.google.gerrit.server.events.ChangeEvent;
-import com.google.gerrit.server.events.Event;
+import com.google.gerrit.server.events.RefEvent;
import com.google.inject.Guice;
import com.google.inject.Injector;
import com.googlesource.gerrit.plugins.its.base.its.ItsConfig;
@@ -173,7 +173,7 @@
}
private void setupCommonMocks() {
- expect(itsConfig.isEnabled(anyObject(Event.class))).andReturn(true).anyTimes();
+ expect(itsConfig.isEnabled(anyObject(RefEvent.class))).andReturn(true).anyTimes();
}
@Override
