[arquillian-issues] [JBoss JIRA] (ARQ-2016) Test extensions should be separate from OSGi Container extensions

[Steve Storck (JIRA)]

     [ https://issues.jboss.org/browse/ARQ-2016?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Steve Storck updated ARQ-2016:
------------------------------
    Description: 
When the arquillian-container-osgi extension is deployed, it also deploys the arquillian-osgi-bundle.  This bundle exposes a few APIs, but it contains (and does not expose) some of the implementation and SPI packages.  This effectively results in only being able to use the provided JUnitBundleTestRunner extension.  I want to use the arquillian-testrunner-spock extension, but it always fails because I have to deploy the test SPI bundle with my test jar, and it conflicts with those packages that the arquillian-osgi-bundle uses internally.  This causes an exception to be thrown that complains that the EventTestRunnerAdaptor implementation is not an instance of the TestRunnerAdaptor interface.  The chain of events that results in the exception is as follows:

ArquillianSputnik.java (arquillian-testrunner-spock core)
{code:java}
import org.jboss.arquillian.test.spi.TestRunnerAdaptor;
import org.jboss.arquillian.test.spi.TestRunnerAdaptorBuilder;
   // Methods and fields omitted for brevity, but you can see that the
   // proper packages are imported
   public void run(RunNotifier notifier)
     // Code omitted for brevity
            final TestRunnerAdaptor adaptor = TestRunnerAdaptorBuilder.build();
     // More code omitted for brevity
   {
{code}

EventTestRunnerAdaptorBuilder.java (arquillian-core test/spi)
{code:java}
public static TestRunnerAdaptor build() 
   {
   private static final String DEFAULT_EXTENSION_CLASS = 
        "org.jboss.arquillian.core.impl.loadable.LoadableExtensionLoader";
   private static final String TEST_RUNNER_IMPL_CLASS =
        "org.jboss.arquillian.test.impl.EventTestRunnerAdaptor";

      // omitted lines for brevity

      ManagerBuilder builder = ManagerBuilder.from()
         .extension(SecurityActions.loadClass(DEFAULT_EXTENSION_CLASS));

      return SecurityActions.newInstance(
            TEST_RUNNER_IMPL_CLASS, 
            new Class<?>[] {ManagerBuilder.class}, 
            new Object[] {builder}, 
            TestRunnerAdaptor.class);     
   }
{code}

SecurityActions.java (arquillian-core test/spi)
{code:java}
   static <T> T newInstance(final String className,
                                            final Class<?>[] argumentTypes,
                                            final Object[] arguments,
                                            final Class<T> expectedType)
   {
      @SuppressWarnings("unchecked")
      Class<T> implClass = (Class<T>) loadClass(className);
      if (!expectedType.isAssignableFrom(implClass)) {
          throw new RuntimeException("Loaded class " + 
                            className + 
                            " is not of expected type " +
                            expectedType);
      }
      return newInstance(implClass, argumentTypes, arguments);
   }
{code}

I think that the best solution would be to completely decouple the JUnitTestRunner from the container modules, or at the very least, it would be good to change the <_exportcontents> to export most (or all) of the embedded dependency packages so that users can make use of other extensions, or build their own.

Edit: After some more thought, it would be really nice to make test extensions loadable (with a default if it is unspecified, of course).  I don't know enough about the code base (yet) to say if it would be best to do this via an annotation, or if pluggability would be better leveraged somewhere else in the framework.

  was:
When the arquillian-container-osgi extension is deployed, it also deploys the arquillian-osgi-bundle.  This bundle exposes a few APIs, but it contains (and does not expose) some of the implementation and SPI packages.  This effectively results in only being able to use the provided JUnitBundleTestRunner extension.  I want to use the arquillian-testrunner-spock extension, but it always fails because I have to deploy the test SPI bundle with my test jar, and it conflicts with those packages that the arquillian-osgi-bundle uses internally.  This causes an exception to be thrown that complains that the EventTestRunnerAdaptor implementation is not an instance of the TestRunnerAdaptor interface.  The chain of events that results in the exception is as follows:

ArquillianSputnik.java
{code:java}
import org.jboss.arquillian.test.spi.TestRunnerAdaptor;
import org.jboss.arquillian.test.spi.TestRunnerAdaptorBuilder;
   // Methods and fields omitted for brevity, but you can see that the
   // proper packages are imported
   public void run(RunNotifier notifier)
     // Code omitted for brevity
            final TestRunnerAdaptor adaptor = TestRunnerAdaptorBuilder.build();
     // More code omitted for brevity
   {
{code}

TestRunnerAdaptor.java
{code:java}
   public static TestRunnerAdaptor build() 
   {
      // omitted lines for brevity
      ManagerBuilder builder = ManagerBuilder.from()
         .extension(SecurityActions.loadClass(DEFAULT_EXTENSION_CLASS));

      return SecurityActions.newInstance(
            TEST_RUNNER_IMPL_CLASS, 
            new Class<?>[] {ManagerBuilder.class}, 
            new Object[] {builder}, 
            TestRunnerAdaptor.class);     
   }
{code}

SecurityActions.java
{code:java}
   static <T> T newInstance(final String className,
                                            final Class<?>[] argumentTypes,
                                            final Object[] arguments,
                                            final Class<T> expectedType)
   {
      @SuppressWarnings("unchecked")
      Class<T> implClass = (Class<T>) loadClass(className);
      if (!expectedType.isAssignableFrom(implClass)) {
          throw new RuntimeException("Loaded class " + 
                            className + 
                            " is not of expected type " +
                            expectedType);
      }
      return newInstance(implClass, argumentTypes, arguments);
   }
{code}

I think that the best solution would be to completely decouple the JUnitTestRunner from the container modules, or at the very least, it would be good to change the <_exportcontents> to export most (or all) of the embedded dependency packages so that users can make use of other extensions, or build their own.

Edit: After some more thought, it would be really nice to make test extensions loadable (with a default if it is unspecified, of course).  I don't know enough about the code base (yet) to say if it would be best to do this via an annotation, or if pluggability would be better leveraged somewhere else in the framework.



> Test extensions should be separate from OSGi Container extensions
> -----------------------------------------------------------------
>
>                 Key: ARQ-2016
>                 URL: https://issues.jboss.org/browse/ARQ-2016
>             Project: Arquillian
>          Issue Type: Feature Request
>          Components: OSGi Containers
>    Affects Versions: osgi_2.1.0.Final
>         Environment: Under Linux, and inside Karaf 4.x
>            Reporter: Steve Storck
>            Assignee: Thomas Diesler
>
> When the arquillian-container-osgi extension is deployed, it also deploys the arquillian-osgi-bundle.  This bundle exposes a few APIs, but it contains (and does not expose) some of the implementation and SPI packages.  This effectively results in only being able to use the provided JUnitBundleTestRunner extension.  I want to use the arquillian-testrunner-spock extension, but it always fails because I have to deploy the test SPI bundle with my test jar, and it conflicts with those packages that the arquillian-osgi-bundle uses internally.  This causes an exception to be thrown that complains that the EventTestRunnerAdaptor implementation is not an instance of the TestRunnerAdaptor interface.  The chain of events that results in the exception is as follows:
> ArquillianSputnik.java (arquillian-testrunner-spock core)
> {code:java}
> import org.jboss.arquillian.test.spi.TestRunnerAdaptor;
> import org.jboss.arquillian.test.spi.TestRunnerAdaptorBuilder;
>    // Methods and fields omitted for brevity, but you can see that the
>    // proper packages are imported
>    public void run(RunNotifier notifier)
>      // Code omitted for brevity
>             final TestRunnerAdaptor adaptor = TestRunnerAdaptorBuilder.build();
>      // More code omitted for brevity
>    {
> {code}
> EventTestRunnerAdaptorBuilder.java (arquillian-core test/spi)
> {code:java}
> public static TestRunnerAdaptor build() 
>    {
>    private static final String DEFAULT_EXTENSION_CLASS = 
>         "org.jboss.arquillian.core.impl.loadable.LoadableExtensionLoader";
>    private static final String TEST_RUNNER_IMPL_CLASS =
>         "org.jboss.arquillian.test.impl.EventTestRunnerAdaptor";
>       // omitted lines for brevity
>       ManagerBuilder builder = ManagerBuilder.from()
>          .extension(SecurityActions.loadClass(DEFAULT_EXTENSION_CLASS));
>       return SecurityActions.newInstance(
>             TEST_RUNNER_IMPL_CLASS, 
>             new Class<?>[] {ManagerBuilder.class}, 
>             new Object[] {builder}, 
>             TestRunnerAdaptor.class);     
>    }
> {code}
> SecurityActions.java (arquillian-core test/spi)
> {code:java}
>    static <T> T newInstance(final String className,
>                                             final Class<?>[] argumentTypes,
>                                             final Object[] arguments,
>                                             final Class<T> expectedType)
>    {
>       @SuppressWarnings("unchecked")
>       Class<T> implClass = (Class<T>) loadClass(className);
>       if (!expectedType.isAssignableFrom(implClass)) {
>           throw new RuntimeException("Loaded class " + 
>                             className + 
>                             " is not of expected type " +
>                             expectedType);
>       }
>       return newInstance(implClass, argumentTypes, arguments);
>    }
> {code}
> I think that the best solution would be to completely decouple the JUnitTestRunner from the container modules, or at the very least, it would be good to change the <_exportcontents> to export most (or all) of the embedded dependency packages so that users can make use of other extensions, or build their own.
> Edit: After some more thought, it would be really nice to make test extensions loadable (with a default if it is unspecified, of course).  I don't know enough about the code base (yet) to say if it would be best to do this via an annotation, or if pluggability would be better leveraged somewhere else in the framework.



--
This message was sent by Atlassian JIRA
(v6.4.11#64026)