View Javadoc

1   package org.apache.maven.surefire.booter;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *     http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  /**
23   * Represents the classpaths for the BooterConfiguration.
24   * <p/>
25   *
26   * @author Jason van Zyl
27   * @author Emmanuel Venisse
28   * @author Kristian Rosenvold
29   */
30  public class ClasspathConfiguration
31  {
32      private static final String CHILD_DELEGATION = "childDelegation";
33  
34      private static final String ENABLE_ASSERTIONS = "enableAssertions";
35  
36      private static final String CLASSPATH = "classPathUrl.";
37  
38      private static final String SUREFIRE_CLASSPATH = "surefireClassPathUrl.";
39  
40      private final Classpath classpathUrls;
41  
42      private final Classpath surefireClasspathUrls;
43  
44      /**
45       * The surefire classpath to use when invoking in-process with the plugin
46       */
47      private final Classpath inprocClasspath;
48  
49      /**
50       * Whether to enable assertions or not (can be affected by the fork arguments, and the ability to do so based on the
51       * JVM).
52       */
53      private final boolean enableAssertions;
54  
55      // todo: @deprecated because the IsolatedClassLoader is really isolated - no parent.
56      private final boolean childDelegation;
57  
58      public ClasspathConfiguration( boolean enableAssertions, boolean childDelegation )
59      {
60          this( new Classpath(), new Classpath(), new Classpath(), enableAssertions, childDelegation );
61      }
62  
63      ClasspathConfiguration( PropertiesWrapper properties )
64      {
65          this( properties.getClasspath( CLASSPATH ), properties.getClasspath( SUREFIRE_CLASSPATH ), new Classpath(),
66                properties.getBooleanProperty( ENABLE_ASSERTIONS ), properties.getBooleanProperty( CHILD_DELEGATION ) );
67      }
68  
69      public ClasspathConfiguration( Classpath testClasspath, Classpath surefireClassPathUrls, Classpath inprocClasspath,
70                                     boolean enableAssertions, boolean childDelegation )
71      {
72          this.enableAssertions = enableAssertions;
73          this.childDelegation = childDelegation;
74          this.inprocClasspath = inprocClasspath;
75          this.classpathUrls = testClasspath;
76          this.surefireClasspathUrls = surefireClassPathUrls;
77      }
78  
79      public void addForkProperties( PropertiesWrapper properties )
80      {
81          properties.setClasspath( CLASSPATH, classpathUrls );
82          properties.setClasspath( SUREFIRE_CLASSPATH, surefireClasspathUrls );
83          properties.setProperty( ENABLE_ASSERTIONS, String.valueOf( enableAssertions ) );
84          properties.setProperty( CHILD_DELEGATION, String.valueOf( childDelegation ) );
85      }
86  
87      public ClassLoader createTestClassLoader( boolean childDelegation )
88          throws SurefireExecutionException
89      {
90          return classpathUrls.createClassLoader( null, childDelegation, enableAssertions, "test" );
91      }
92  
93      public ClassLoader createTestClassLoader()
94          throws SurefireExecutionException
95      {
96          return classpathUrls.createClassLoader( null, this.childDelegation, enableAssertions, "test" );
97      }
98  
99      public ClassLoader createSurefireClassLoader( ClassLoader parent )
100         throws SurefireExecutionException
101     {
102         return surefireClasspathUrls.createClassLoader( parent, false, enableAssertions, "provider" );
103     }
104 
105     public ClassLoader createInprocSurefireClassLoader( ClassLoader parent )
106         throws SurefireExecutionException
107     {
108         return inprocClasspath.createClassLoader( parent, false, enableAssertions, "provider" );
109     }
110 
111     public Classpath getTestClasspath()
112     {
113         return classpathUrls;
114     }
115 
116     public ClassLoader createForkingTestClassLoader( boolean manifestOnlyJarRequestedAndUsable )
117         throws SurefireExecutionException
118     {
119         if ( manifestOnlyJarRequestedAndUsable )
120         {
121             System.setProperty( "surefire.real.class.path", System.getProperty( "java.class.path" ) );
122             getTestClasspath().writeToSystemProperty( "java.class.path" );
123             // this.getClass.getClassLoader() is always loaded in system classloader if forking
124             // this.getClass().getClassLoader() is plugin classloder if in-process
125             // "this" must refer to a class within the booter module
126             return this.getClass().getClassLoader();   // SUREFIRE-459, trick the app under test into thinking its classpath was conventional;
127         }
128         else
129         {
130             return createTestClassLoader();
131         }
132     }
133 }