maven-surefire-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From krosenv...@apache.org
Subject svn commit: r1078912 - /maven/surefire/trunk/maven-surefire-plugin/src/site/apt/developingSurefire.apt
Date Mon, 07 Mar 2011 20:02:47 GMT
Author: krosenvold
Date: Mon Mar  7 20:02:46 2011
New Revision: 1078912

URL: http://svn.apache.org/viewvc?rev=1078912&view=rev
Log:
o Added documentation about developing surefire itself

Added:
    maven/surefire/trunk/maven-surefire-plugin/src/site/apt/developingSurefire.apt   (with
props)

Added: maven/surefire/trunk/maven-surefire-plugin/src/site/apt/developingSurefire.apt
URL: http://svn.apache.org/viewvc/maven/surefire/trunk/maven-surefire-plugin/src/site/apt/developingSurefire.apt?rev=1078912&view=auto
==============================================================================
--- maven/surefire/trunk/maven-surefire-plugin/src/site/apt/developingSurefire.apt (added)
+++ maven/surefire/trunk/maven-surefire-plugin/src/site/apt/developingSurefire.apt Mon Mar
 7 20:02:46 2011
@@ -0,0 +1,50 @@
+  ------
+  Developing surefire
+  ------
+  Kristian Rosenvold
+  ------
+ 2011-03-07
+  ------
+  
+ ~~ Licensed to the Apache Software Foundation (ASF) under one
+ ~~ or more contributor license agreements.  See the NOTICE file
+ ~~ distributed with this work for additional information
+ ~~ regarding copyright ownership.  The ASF licenses this file
+ ~~ to you under the Apache License, Version 2.0 (the
+ ~~ "License"); you may not use this file except in compliance
+ ~~ with the License.  You may obtain a copy of the License at
+ ~~
+ ~~   http://www.apache.org/licenses/LICENSE-2.0
+ ~~
+ ~~ Unless required by applicable law or agreed to in writing,
+ ~~ software distributed under the License is distributed on an
+ ~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ ~~ KIND, either express or implied.  See the License for the
+ ~~ specific language governing permissions and limitations
+ ~~ under the License.
+
+ ~~ NOTE: For help with the syntax of this file, see:
+ ~~ http://maven.apache.org/doxia/references/apt-format.html  
+
+When working with surefire, it is necessary to understand a few things:
+
+* The surefire booter is capable of booting all the way back to jdk1.3. Specifically
+  this means surefire-api, surefire-booter, common-junit3 and surefire-junit3 are
+  source/target 1.3. The plugin itself is 1.4 and several providers are 1.5.
+
+* Classes in the SUT (Subject Under Test), override any classes within the
+  surefire providers. This means providers using any
+  third party dependencies (other than the test framework itself), should
+  shade these classes to a different package.
+
+* The surefire-providers module contains common-junitXX modules. These modules
+  depend on the XX version of JUnit and can access the JUnit API's at the correct
+  JUnit version level. Unit tests can also be written that will run with the
+  correct JUnit version. At build time, all of the relevant parts of these "common"
+  modules are just shaded into the providers jar files.
+
+* "Shadefire" is the first module to be run in the
+  surefire build. This creates as shaded version of the JUnit provider, and this provider
+  is thereafter used to build surefire itself (As of any release after 2.8). This is
+  because the SUT overrides the provider, and the shadefire provider has been
+  relocated to avoid this overriding when surefire is building itself.
\ No newline at end of file

Propchange: maven/surefire/trunk/maven-surefire-plugin/src/site/apt/developingSurefire.apt
------------------------------------------------------------------------------
    svn:eol-style = native



Mime
View raw message