documentation/subprojects/apache-felix-sigil/sigil-user-guide/sigil-junit.html - felix-site-pub - Git at Google

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <html>
 <!--

     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

        https://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.
 -->
   <head>
     <title>Apache Felix - Sigil JUnit</title>
     <link rel="icon" href="/res/favicon.ico">
     <link rel="stylesheet" href="/res/site.css" type="text/css" media="all">
     <link rel="stylesheet" href="/res/codehilite.css" type="text/css" media="all">
     <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
   </head>
   <body>
     <div class="title">
       <div class="logo">
         <a href="https://felix.apache.org/">
           <img border="0" alt="Apache Felix" src="/res/logo.png">
         </a>
       </div>
       <div class="header">
         <a href="https://www.apache.org/">
           <img border="0" alt="Apache" src="/res/apache.png">
         </a>
       </div>
     </div>

     <div class="menu">
       <style type="text/css">
 /* The following code is added by mdx_elementid.py
    It was originally lifted from http://subversion.apache.org/style/site.css */
 /*
  * Hide class="elementid-permalink", except when an enclosing heading
  * has the :hover property.
  */
 .headerlink, .elementid-permalink {
   visibility: hidden;
 }
 h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
 <p><a href="/news.html">News</a>  <br />
 <a href="/license.html">License</a>  <br />
 <a href="/downloads.cgi">Downloads</a>  <br />
 <a href="/documentation.html">Documentation</a>  <br />
 <a href="/mailinglists.html">Mailing Lists</a>  <br />
 <a href="/documentation/community/contributing.html">Contributing</a>  <br />
 <a href="/sitemap.html">Site Map</a>  <br />
 <a href="https://www.apache.org/">ASF</a>  <br />
 <a href="https://www.apache.org/security/">Security</a>  <br />
 <a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a>  <br />
 <a href="https://www.apache.org/foundation/thanks.html">Sponsors</a>    </p>
 <iframe
     src="https://www.apache.org/ads/button.html"
     style="border-width:0; float: left"
     frameborder="0"
     scrolling="no"
     width="135"
     height="135">
 </iframe>
     </div>

     <div class="main">
       <div class="breadcrump" style="font-size: 80%;">
         <a href="/">Home</a>&nbsp;&raquo&nbsp;<a href="/documentation.html">Documentation</a>&nbsp;&raquo&nbsp;<a href="/documentation/subprojects.html">Apache Felix Subproject Documentation</a>&nbsp;&raquo&nbsp;<a href="/documentation/subprojects/apache-felix-sigil.html">Apache Felix Sigil</a>&nbsp;&raquo&nbsp;<a href="/documentation/subprojects/apache-felix-sigil/sigil-user-guide.html">Sigil User Guide</a>
       </div>

       <h1>Sigil JUnit</h1>
       <style type="text/css">
 /* The following code is added by mdx_elementid.py
    It was originally lifted from http://subversion.apache.org/style/site.css */
 /*
  * Hide class="elementid-permalink", except when an enclosing heading
  * has the :hover property.
  */
 .headerlink, .elementid-permalink {
   visibility: hidden;
 }
 h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
 <h2 id="overview">Overview<a class="headerlink" href="#overview" title="Permanent link">&para;</a></h2>
 <p>The Sigil JUnit plugin is an OSGi bundle that when started in an OSGi enabled JVM watches for other bundles that contain JUnit TestCase classes in the framework. The main access point to the plugin is the <code>org.cauldron.sigil.junit.server.JUnitService</code>.</p>
 <DIV class="code panel" style="border-style: solid;border-width: 1px;"><DIV class="codeHeader panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;"><B>JUnitService.java|borderStyle=solid</B></DIV><DIV class="codeContent panelContent">
     package org.cauldron.sigil.junit.server;

     import java.util.Set;

     import org.osgi.framework.BundleContext;

     import junit.framework.TestSuite;

     /**
      *
      */
     public interface JUnitService {
         /**
          * Returns the names of all tests currently installed in the OSGi runtime
          */
         Set<String> getTests();

         /**
          * Create a new instance of the specified test. Equivalent to calling createTest(test, null);
          */
         TestSuite createTest(String test);

         /**
          * Create a new instance of the specified test passing the specified bundle context to the test classes.
          * If ctx is null the callers BundleContext is passed to the test.
          */
         TestSuite createTest(String test, BundleContext ctx);
     }


 When a test is created the `JUnitService` introspects the test class and looks for a method `public void setBundleContext(BundleContext ctx);` if one is found then the BundleContext is injected into the test class before being returned to the caller.
       <div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
         Rev. 1700393 by cziegeler on Tue, 1 Sep 2015 06:04:06 +0000
       </div>
       <div class="trademarkFooter">
         Apache Felix, Felix, Apache, the Apache feather logo, and the Apache Felix project
         logo are trademarks of The Apache Software Foundation. All other marks mentioned
         may be trademarks or registered trademarks of their respective owners.
       </div>
     </div>
   </body>
 </html>
	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
	<html>
	<!--

	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

	https://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.
	-->
	<head>
	<title>Apache Felix - Sigil JUnit</title>
	<link rel="icon" href="/res/favicon.ico">
	<link rel="stylesheet" href="/res/site.css" type="text/css" media="all">
	<link rel="stylesheet" href="/res/codehilite.css" type="text/css" media="all">
	<meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
	</head>
	<body>
	<div class="title">
	<div class="logo">
	<a href="https://felix.apache.org/">
	<img border="0" alt="Apache Felix" src="/res/logo.png">
	</a>
	</div>
	<div class="header">
	<a href="https://www.apache.org/">
	<img border="0" alt="Apache" src="/res/apache.png">
	</a>
	</div>
	</div>

	<div class="menu">
	<style type="text/css">
	/* The following code is added by mdx_elementid.py
	It was originally lifted from http://subversion.apache.org/style/site.css */
	/*
	* Hide class="elementid-permalink", except when an enclosing heading
	* has the :hover property.
	*/
	.headerlink, .elementid-permalink {
	visibility: hidden;
	}
	h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
	<p><a href="/news.html">News</a> <br />
	<a href="/license.html">License</a> <br />
	<a href="/downloads.cgi">Downloads</a> <br />
	<a href="/documentation.html">Documentation</a> <br />
	<a href="/mailinglists.html">Mailing Lists</a> <br />
	<a href="/documentation/community/contributing.html">Contributing</a> <br />
	<a href="/sitemap.html">Site Map</a> <br />
	<a href="https://www.apache.org/">ASF</a> <br />
	<a href="https://www.apache.org/security/">Security</a> <br />
	<a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a> <br />
	<a href="https://www.apache.org/foundation/thanks.html">Sponsors</a> </p>
	<iframe
	src="https://www.apache.org/ads/button.html"
	style="border-width:0; float: left"
	frameborder="0"
	scrolling="no"
	width="135"
	height="135">
	</iframe>
	</div>

	<div class="main">
	<div class="breadcrump" style="font-size: 80%;">
	<a href="/">Home</a> &raquo <a href="/documentation.html">Documentation</a> &raquo <a href="/documentation/subprojects.html">Apache Felix Subproject Documentation</a> &raquo <a href="/documentation/subprojects/apache-felix-sigil.html">Apache Felix Sigil</a> &raquo <a href="/documentation/subprojects/apache-felix-sigil/sigil-user-guide.html">Sigil User Guide</a>
	</div>

	<h1>Sigil JUnit</h1>
	<style type="text/css">
	/* The following code is added by mdx_elementid.py
	It was originally lifted from http://subversion.apache.org/style/site.css */
	/*
	* Hide class="elementid-permalink", except when an enclosing heading
	* has the :hover property.
	*/
	.headerlink, .elementid-permalink {
	visibility: hidden;
	}
	h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
	<h2 id="overview">Overview<a class="headerlink" href="#overview" title="Permanent link">¶</a></h2>
	<p>The Sigil JUnit plugin is an OSGi bundle that when started in an OSGi enabled JVM watches for other bundles that contain JUnit TestCase classes in the framework. The main access point to the plugin is the <code>org.cauldron.sigil.junit.server.JUnitService</code>.</p>
	<DIV class="code panel" style="border-style: solid;border-width: 1px;"><DIV class="codeHeader panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;"><B>JUnitService.java\|borderStyle=solid</B></DIV><DIV class="codeContent panelContent">
	package org.cauldron.sigil.junit.server;

	import java.util.Set;

	import org.osgi.framework.BundleContext;

	import junit.framework.TestSuite;

	/**
	*
	*/
	public interface JUnitService {
	/**
	* Returns the names of all tests currently installed in the OSGi runtime
	*/
	Set<String> getTests();

	/**
	* Create a new instance of the specified test. Equivalent to calling createTest(test, null);
	*/
	TestSuite createTest(String test);

	/**
	* Create a new instance of the specified test passing the specified bundle context to the test classes.
	* If ctx is null the callers BundleContext is passed to the test.
	*/
	TestSuite createTest(String test, BundleContext ctx);
	}


	When a test is created the `JUnitService` introspects the test class and looks for a method `public void setBundleContext(BundleContext ctx);` if one is found then the BundleContext is injected into the test class before being returned to the caller.
	<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
	Rev. 1700393 by cziegeler on Tue, 1 Sep 2015 06:04:06 +0000
	</div>
	<div class="trademarkFooter">
	Apache Felix, Felix, Apache, the Apache feather logo, and the Apache Felix project
	logo are trademarks of The Apache Software Foundation. All other marks mentioned
	may be trademarks or registered trademarks of their respective owners.
	</div>
	</div>
	</body>
	</html>