Skip to content

Commit

Permalink
ARQ-1492 Removing @deprecated Enhancer SPI
Browse files Browse the repository at this point in the history
  • Loading branch information
@kpiwko
kpiwko committed Sep 23, 2013
1 parent c6562f4 commit 7e3f097
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 204 deletions.
2 changes: 0 additions & 2 deletions drone-impl/src/main/java/org/jboss/arquillian/drone/impl/DroneDestructor.java
View file
Expand Up @@ -66,7 +66,6 @@ public class DroneDestructor {
@Inject
private Event<DroneLifecycleEvent> droneLifecycleEvent;

@SuppressWarnings("unchecked")
public void destroyClassScopedDrone(@Observes AfterClass event, DroneContext droneContext) {

Class<?> clazz = event.getTestClass().getJavaClass();
Expand All @@ -90,7 +89,6 @@ public void destroyClassScopedDrone(@Observes AfterClass event, DroneContext dro
}
}

@SuppressWarnings("unchecked")
public void destroyMethodScopedDrone(@Observes After event, DroneContext droneContext) {

Method method = event.getTestMethod();
Expand Down
123 changes: 25 additions & 98 deletions drone-impl/src/main/java/org/jboss/arquillian/drone/impl/DroneEnhancer.java
View file
Expand Up @@ -30,9 +30,7 @@
import org.jboss.arquillian.core.spi.ServiceLoader;
import org.jboss.arquillian.drone.spi.DroneContext;
import org.jboss.arquillian.drone.spi.DroneInstanceEnhancer;
import org.jboss.arquillian.drone.spi.Enhancer;
import org.jboss.arquillian.drone.spi.InstanceOrCallableInstance;
import org.jboss.arquillian.drone.spi.Sortable;
import org.jboss.arquillian.drone.spi.event.AfterDroneDeenhanced;
import org.jboss.arquillian.drone.spi.event.AfterDroneEnhanced;
import org.jboss.arquillian.drone.spi.event.AfterDroneInstantiated;
Expand Down Expand Up @@ -73,56 +71,35 @@ public class DroneEnhancer {
@SuppressWarnings({ "rawtypes", "unchecked" })
public void enhanceDrone(@Observes AfterDroneInstantiated droneInstance, DroneContext context) {

// until deprecated Enhancers are removed, we need to pick both of these classes
List<Sortable> enhancers = new ArrayList<Sortable>(serviceLoader.get().all(DroneInstanceEnhancer.class));
enhancers.addAll(serviceLoader.get().all(Enhancer.class));
List<DroneInstanceEnhancer> enhancers = new ArrayList<DroneInstanceEnhancer>(serviceLoader.get().all(
DroneInstanceEnhancer.class));

Collections.sort(enhancers, PrecedenceComparator.getInstance());

InstanceOrCallableInstance browser = droneInstance.getInstance();
final Class<?> type = droneInstance.getDroneType();
final Class<? extends Annotation> qualifier = droneInstance.getQualifier();

for (Sortable candidate : enhancers) {

if (candidate instanceof DroneInstanceEnhancer) {
DroneInstanceEnhancer enhancer = (DroneInstanceEnhancer) candidate;
if (enhancer.canEnhance(browser, type, qualifier)) {
log.log(Level.FINE,
"Enhancing {0} @{1} using enhancer {2} with precedence {3}",
new Object[] { type.getSimpleName(), qualifier.getSimpleName(), enhancer.getClass().getName(),
enhancer.getPrecedence() });

droneEnhancementEvent.fire(new BeforeDroneEnhanced(enhancer, browser, type, qualifier));
Object newBrowser = enhancer.enhance(browser.asInstance(type), qualifier);
browser.set(newBrowser);
droneEnhancementEvent.fire(new AfterDroneEnhanced(browser, type, qualifier));
}
}
else if (candidate instanceof Enhancer) {
Enhancer enhancer = (Enhancer) candidate;
if (enhancer.canEnhance(type, qualifier)) {
log.log(Level.WARNING,
"Deprecated Enhancer type, please implement DroneInstanceEnhancer instead. Enhancing {0} @{1} using enhancer {2} with precedence {3}",
new Object[] { type.getSimpleName(), qualifier.getSimpleName(), enhancer.getClass().getName(),
enhancer.getPrecedence() });

droneEnhancementEvent.fire(new BeforeDroneEnhanced(new DeprecatedEnhancerWrap(enhancer), browser, type,
qualifier));
Object newBrowser = enhancer.enhance(browser.asInstance(type), qualifier);
browser.set(newBrowser);
droneEnhancementEvent.fire(new AfterDroneEnhanced(browser, type, qualifier));
}
for (DroneInstanceEnhancer enhancer : enhancers) {
if (enhancer.canEnhance(browser, type, qualifier)) {
log.log(Level.FINE,
"Enhancing {0} @{1} using enhancer {2} with precedence {3}",
new Object[] { type.getSimpleName(), qualifier.getSimpleName(), enhancer.getClass().getName(),
enhancer.getPrecedence() });

droneEnhancementEvent.fire(new BeforeDroneEnhanced(enhancer, browser, type, qualifier));
Object newBrowser = enhancer.enhance(browser.asInstance(type), qualifier);
browser.set(newBrowser);
droneEnhancementEvent.fire(new AfterDroneEnhanced(browser, type, qualifier));
}
}
}

@SuppressWarnings({ "rawtypes", "unchecked" })
public void deenhanceDrone(@Observes BeforeDroneDestroyed droneInstance, DroneContext context) {

List<Sortable> enhancers = new ArrayList<Sortable>(serviceLoader.get().all(
List<DroneInstanceEnhancer> enhancers = new ArrayList<DroneInstanceEnhancer>(serviceLoader.get().all(
DroneInstanceEnhancer.class));
enhancers.addAll(serviceLoader.get().all(Enhancer.class));

// here we are deenhancing in reversed order
Collections.sort(enhancers, PrecedenceComparator.getReversedOrder());
Expand All @@ -131,69 +108,19 @@ public void deenhanceDrone(@Observes BeforeDroneDestroyed droneInstance, DroneCo
final Class<?> type = droneInstance.getDroneType();
final Class<? extends Annotation> qualifier = droneInstance.getQualifier();

for (Sortable candidate : enhancers) {
if (candidate instanceof DroneInstanceEnhancer) {
DroneInstanceEnhancer enhancer = (DroneInstanceEnhancer) candidate;
if (enhancer.canEnhance(browser, type, qualifier)) {
log.log(Level.FINE,
"Deenhancing {0} @{1} using enhancer {2} with precedence {3}",
new Object[] { type.getSimpleName(), qualifier.getSimpleName(), enhancer.getClass().getName(),
enhancer.getPrecedence() });

droneEnhancementEvent.fire(new BeforeDroneDeenhanced(enhancer, browser, type, qualifier));
Object newBrowser = enhancer.deenhance(browser.asInstance(type), qualifier);
browser.set(newBrowser);
droneEnhancementEvent.fire(new AfterDroneDeenhanced(browser, type, qualifier));
}
}
else if (candidate instanceof Enhancer) {
Enhancer enhancer = (Enhancer) candidate;
if (enhancer.canEnhance(type, qualifier)) {
log.log(Level.WARNING,
"Deprecated Enhancer type, please implement DroneInstanceEnhancer instead. Deenhancing {0} @{1} using enhancer {2} with precedence {3}",
new Object[] { type.getSimpleName(), qualifier.getSimpleName(), enhancer.getClass().getName(),
enhancer.getPrecedence() });

droneEnhancementEvent.fire(new BeforeDroneDeenhanced(new DeprecatedEnhancerWrap(enhancer), browser, type,
qualifier));
Object newBrowser = enhancer.deenhance(browser.asInstance(type), qualifier);
browser.set(newBrowser);
droneEnhancementEvent.fire(new AfterDroneDeenhanced(browser, type, qualifier));
}
for (DroneInstanceEnhancer enhancer : enhancers) {
if (enhancer.canEnhance(browser, type, qualifier)) {
log.log(Level.FINE,
"Deenhancing {0} @{1} using enhancer {2} with precedence {3}",
new Object[] { type.getSimpleName(), qualifier.getSimpleName(), enhancer.getClass().getName(),
enhancer.getPrecedence() });

droneEnhancementEvent.fire(new BeforeDroneDeenhanced(enhancer, browser, type, qualifier));
Object newBrowser = enhancer.deenhance(browser.asInstance(type), qualifier);
browser.set(newBrowser);
droneEnhancementEvent.fire(new AfterDroneDeenhanced(browser, type, qualifier));
}

}
}

@Deprecated
private static class DeprecatedEnhancerWrap<T> implements DroneInstanceEnhancer<T> {

private final Enhancer<T> deprecated;

public DeprecatedEnhancerWrap(Enhancer<T> deprecated) {
this.deprecated = deprecated;
}

@Override
public int getPrecedence() {
return deprecated.getPrecedence();
}

@Override
public boolean canEnhance(InstanceOrCallableInstance instance, Class<?> droneType, Class<? extends Annotation> qualifier) {
return deprecated.canEnhance(droneType, qualifier);
}

@Override
public T enhance(T instance, Class<? extends Annotation> qualifier) {
return deprecated.enhance(instance, qualifier);
}

@Override
public T deenhance(T enhancedInstance, Class<? extends Annotation> qualifier) {
return deprecated.deenhance(enhancedInstance, qualifier);
}

}

}
36 changes: 0 additions & 36 deletions drone-impl/src/test/java/org/jboss/arquillian/drone/impl/EnhancerTestCase.java
View file
Expand Up @@ -39,7 +39,6 @@
import org.jboss.arquillian.drone.spi.Destructor;
import org.jboss.arquillian.drone.spi.DroneContext;
import org.jboss.arquillian.drone.spi.DroneInstanceEnhancer;
import org.jboss.arquillian.drone.spi.Enhancer;
import org.jboss.arquillian.drone.spi.InstanceOrCallableInstance;
import org.jboss.arquillian.drone.spi.Instantiator;
import org.jboss.arquillian.drone.spi.event.AfterDroneInstantiated;
Expand Down Expand Up @@ -83,7 +82,6 @@ public class EnhancerTestCase extends AbstractTestTestBase {

private MockDrone notEnhanced;
private MockDrone deEnhanced;
private MockDrone deprecatedEnhanced;

@Override
protected void addExtensions(List<Class<?>> extensions) {
Expand Down Expand Up @@ -118,13 +116,10 @@ public void setUp() {
Mockito.when(serviceLoader.onlyOne(DroneInstanceCreator.class)).thenReturn(instanceCreator);
Mockito.when(serviceLoader.all(DroneInstanceEnhancer.class)).thenReturn(
Arrays.<DroneInstanceEnhancer> asList(new MockDroneEnhancer2(), new MockDroneEnhancer1()));
Mockito.when(serviceLoader.all(Enhancer.class)).thenReturn(
Arrays.<Enhancer> asList(new DeprecatedDroneEnhancer()));
Mockito.when(serviceLoader.onlyOne(TestEnricher.class)).thenReturn(testEnricher);

notEnhanced = null;
deEnhanced = null;
deprecatedEnhanced = null;
}

@Test
Expand All @@ -144,14 +139,12 @@ public void testClassLevel() throws Exception {

assertThat("both enhancerns were applied", droneInstance.asInstance(MockDrone.class), equalTo(enhanced2));
assertThat("the initial instance provided by Drone was not enhanced", notEnhanced, is(not(nullValue())));
assertThat("deprecated enhancer was applied", deprecatedEnhanced, is(not(nullValue())));

droneInstance = context.get(MockDrone.class, Default.class);
fire(new AfterClass(EnrichedClass.class));

droneInstance = context.get(MockDrone.class, Default.class);
assertThat(droneInstance, is(nullValue()));
assertThat("deprecated deenhancer was applied", deprecatedEnhanced, is(nullValue()));
assertThat(notEnhanced, equalTo(deEnhanced));
}

Expand All @@ -177,12 +170,10 @@ public void testMethodLevel() throws Exception {

assertThat(droneInstance.asInstance(MockDrone.class), equalTo(enhanced2));
assertThat(notEnhanced, is(not(nullValue())));
assertThat("deprecated enhancer was applied", deprecatedEnhanced, is(not(nullValue())));

fire(new After(instance, testMethod));
droneInstance = context.get(MockDrone.class, Default.class);
assertThat(droneInstance, is(nullValue()));
assertThat("deprecated deenhancer was applied", deprecatedEnhanced, is(nullValue()));
assertThat(notEnhanced, equalTo(deEnhanced));
}

Expand Down Expand Up @@ -253,31 +244,4 @@ public MockDrone deenhance(MockDrone enhancedInstance, Class<? extends Annotatio
}
}

private class DeprecatedDroneEnhancer implements Enhancer<MockDrone> {

@Override
public int getPrecedence() {
return 50;
}

@Override
public boolean canEnhance(Class<?> type, Class<? extends Annotation> qualifier) {
return true;
}

@Override
public MockDrone enhance(MockDrone instance, Class<? extends Annotation> qualifier) {

deprecatedEnhanced = instance;
return instance;
}

@Override
public MockDrone deenhance(MockDrone enhancedInstance, Class<? extends Annotation> qualifier) {
deprecatedEnhanced = null;
return enhancedInstance;
}

}

}
68 changes: 0 additions & 68 deletions drone-spi/src/main/java/org/jboss/arquillian/drone/spi/Enhancer.java
View file

This file was deleted.

0 comments on commit 7e3f097

Please sign in to comment.