Re: Re: Spindle compatability test suite
"Hugo Palma" <[email protected]> Fri, 12 May 2006 10:18:24 +0100
| Newsgroups | gmane.comp.ide.eclipse.spindle.devel |
|---|---|
| Message-ID | <[email protected]> |
------=_Part_4739_12690770.1147425504153 Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: quoted-printable Content-Disposition: inline inline On 5/12/06, Geoff Longman <[email protected]> wrote: > > Ok. I see what you have. A fixture is an interface to build a > "project" with context and classpath for testing. Can provide or point > me to (in you repo) an example of a Test? I'll upload the test suite and an example test tonight. I'll post again whe= n it's available. On 5/10/06, Hugo Palma <[email protected]> wrote: > > Forgot to mention how the tested class implementation would be served t= o > > the test class. > > ok, I'm lost at this point. "tested class implementation" is? The test suite is supposed to test the implementation of abstract concepts. As such, the test suite only works with ICoreResource, IResourceRoot, and s= o on. The respective implementation, the "tested class implementation", has t= o be provided to the test suite by the IDE specific implementation module. Anyway, i think it will be clear when you look at the example code. Geoff > > > I got this working by declaring a hivemind service for each tested clas= s > > in spindle-tests and then providing the implementation in the IDE > > implementation module. There's also an utility method in > > AbstractSpindleTestCase that gets the tested class implementation. > > I'm not crazy about having to declare every tested class in the hivemin= d > > descriptor but i couldn't find a better way of doing this. > > > > > > Hugo Palma wrote: > > > I told you i wouldn't let you forget about this :o) > > > > > > I took advantage of a few dead hours in my day job to give this some > > > thought. After some experimenting i came up with some ideas and some > > > code also. > > > > > > There should be a separate module(spindle-tests) with all the > > > framework classes and the tests themselves. > > > > > > The framework consists of one interface, one class and one hivemind > > > descriptor. The interface is IFixture, it provides the signature for > > > all operations that can be executed in a fixture. A fresh instance of > > > the fixture will be provided to each test class at every test run. > > > I've come up with the following code for now, still some operations > > > missing but good for getting the main picture: > > > > > > /** > > > * A test fixture. Should have an implementation for each IDE. > > > */ > > > public interface IFixture<W, F> > > > { > > > /** > > > * Adds a web root. > > > * > > > * @param filePath the absolute path to the web root > directory. > > > * @param relativePath the relative path of the web root. Some > > > IDEs let the user specify a different relative path for each web root= , > > > changing the default "/" path. > > > * @return the added web root. > > > */ > > > W addWebRoot(String filePath, String relativePath); > > > > > > /** > > > * Adds a web root with the default "/" relative path. > > > * > > > * @param filePath the absolute path to the web root directory. > > > * @return the added web root. > > > */ > > > W addWebRoot(String filePath); > > > > > > /** > > > * Adds an empty file to a web root. > > > * > > > * @param webRoot the web root to add the file to. > > > * @param path the absolute path of the file to be added. > > > * @return the added file. > > > */ > > > F addFileToWebRoot(W webRoot, String path); > > > > > > /** > > > * Adds a source root. > > > * > > > * @param filePath the absolute path to the source root directory= . > > > * @return the added source root. > > > */ > > > F addSourceRoot(String filePath); > > > > > > /** > > > * Adds an empty class to a source root. > > > * > > > * @param root the source root to add the class to. > > > * @param packageName the class package. > > > * @param className the class name. > > > */ > > > void addClassToSourceRoot(F root, String packageName, String > > > className); > > > > > > /** > > > * Adds a .jar file to the classpath. > > > * > > > * @param jarFile the .jar file to add to the classpath. > > > */ > > > void addJarToClasspath(F jarFile); > > > > > > /** > > > * Adds a file to a source root. > > > * > > > * @param root the source root to add the file to. > > > * @param packageName the package to add the file to. > > > * @param fileName the absolute path to the file to be added. > > > */ > > > void addFileToSourceRoot(F root, String packageName, String > > > fileName); > > > > > > /** > > > * Tears down the fixture. > > > */ > > > void tearDown(); > > > } > > > > > > > > > The base class for all tests is also provided. I called it > > > AbstractSpindleTestCase. This class provides a getFixture() method to > > > every subclass and is responsible for getting the fresh fixture > > > instance from Hivemind at every test run. Here's the code i came up > with: > > > > > > /** > > > * Base class for all test classes. > > > * > > > * @author Hugo Palma > > > */ > > > public abstract class AbstractSpindleTestCase extends TestCase > > > { > > > private IFixture _fixture; > > > private static Registry _registry; > > > > > > { > > > _registry =3D RegistryBuilder.constructDefaultRegistry(); > > > } > > > > > > /** > > > * {@inheritDoc} > > > */ > > > protected void setUp() throws Exception > > > { > > > super.setUp(); > > > > > > // Allows getting a brand new IFixture instance every time. > > > _registry.cleanupThread(); > > > _registry.setupThread(); > > > > > > _fixture =3D (IFixture) _registry.getService(IFixture.class )= ; > > > } > > > > > > /** > > > * {@inheritDoc} > > > */ > > > protected void tearDown() throws Exception > > > { > > > super.tearDown(); > > > > > > // Cleanup the fixture. > > > _fixture.tearDown(); > > > _fixture =3D null; > > > } > > > > > > protected IFixture getFixture() > > > { > > > return _fixture; > > > } > > > } > > > > > > The only thing missing is the hivemodule.xml in the spindle-tests > module: > > > > > > <module id=3D" net.sf.spindle.tests" version=3D"1.0.0"> > > > <service-point id=3D"fixture" > > > interface=3D"net.sf.spindle.tests.IFixture"/> > > > </module> > > > > > > So, given this, all the IDE has to do is: > > > > > > - Create an implementation of the IFixture interface. > > > - Provide a hivemodule.xml file in it's spindle-core implementation > > > module with something like: > > > > > > <module id=3D"org.intellij.tapestry" version=3D" 1.0.0"> > > > <dependency module-id=3D"net.sf.spindle.tests" version=3D"1.0.0"/= > > > > > > > <implementation service-id=3D"net.sf.spindle.tests.fixture"> > > > <invoke-factory model=3D"threaded"> > > > <construct class=3D"org.intellij.tapestry.test.Fixture"/> > > > </invoke-factory> > > > </implementation> > > > </module> > > > - Execute the tests. I managed to run the tests from IDEA with no > > > problem. I'm going to see how/if i can run tests from a jar file with > > > Maven2. > > > > > > > > > Thoughts ? > > > > > > ------------------------------------------------------- > > Using Tomcat but need to do more? Need to support web services, > security? > > Get stuff done quickly with pre-integrated technology to make your job > easier > > Download IBM WebSphere Application Server v.1.0.1 based on Apache > Geronimo > > http://sel.as-us.falkag.net/sel?cmd=3Dlnk&kid=3D120709&bid=3D263057&dat= =3D121642 > > _______________________________________________ > > Spindle-developer mailing list > > [email protected] > > https://lists.sourceforge.net/lists/listinfo/spindle-developer > > > > > -- > The Spindle guy. http://spindle.sf.net > Blog: http://jroller.com/page/glongman > Other interests: http://www.squidoo.com/spaceelevator/ > > > ------------------------------------------------------- > Using Tomcat but need to do more? Need to support web services, security? > Get stuff done quickly with pre-integrated technology to make your job > easier > Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronim= o > http://sel.as-us.falkag.net/sel?cmdlnk&kid=120709&bid&3057&dat=121642 > _______________________________________________ > Spindle-developer mailing list > [email protected] > https://lists.sourceforge.net/lists/listinfo/spindle-developer > ------=_Part_4739_12690770.1147425504153 Content-Type: text/html; charset=ISO-8859-1 Content-Transfer-Encoding: quoted-printable Content-Disposition: inline inline<br><br><div><span class=3D"gmail_quote">On 5/12/06, <b class=3D"gmai= l_sendername">Geoff Longman</b> <<a href=3D"mailto:[email protected]">g= [email protected]</a>> wrote:</span><blockquote class=3D"gmail_quote" st= yle=3D"border-left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex= ; padding-left: 1ex;"> Ok. I see what you have. A fixture is an interface to build a<br>"proj= ect" with context and classpath for testing. Can provide or point<br>m= e to (in you repo) an example of a Test?</blockquote><div><br>I'll upload t= he test suite and an example test tonight. I'll post again when it's availa= ble.=20 <br></div><br><blockquote class=3D"gmail_quote" style=3D"border-left: 1px s= olid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;">On = 5/10/06, Hugo Palma <<a href=3D"mailto:[email protected]">hugo.m.pa= [email protected] </a>> wrote:<br>> Forgot to mention how the tested class implementati= on would be served to<br>> the test class.<br><br>ok, I'm lost at this p= oint. "tested class implementation" is?</blockquote><div><br> The test suite is supposed to test the implementation of abstract concepts.= As such, the test suite only works with ICoreResource, IResourceRoot, and = so on. The respective implementation, the "tested class implementation= ", has to be provided to the test suite by the IDE specific implementa= tion module. <br>Anyway, i think it will be clear when you look at the example code.<br>= </div><br><blockquote class=3D"gmail_quote" style=3D"border-left: 1px solid= rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;">Geoff<b= r> <br>> I got this working by declaring a hivemind service for each tested= class<br>> in spindle-tests and then providing the implementation in th= e IDE<br>> implementation module. There's also an utility method in<br> > AbstractSpindleTestCase that gets the tested class implementation.<br>= > I'm not crazy about having to declare every tested class in the hivemi= nd<br>> descriptor but i couldn't find a better way of doing this.<br> ><br>><br>> Hugo Palma wrote:<br>> > I told you i wouldn't l= et you forget about this :o)<br>> ><br>> > I took advantage of = a few dead hours in my day job to give this some<br>> > thought. Afte= r some experimenting i came up with some ideas and some <br>> > code also.<br>> ><br>> > There should be a separa= te module(spindle-tests) with all the<br>> > framework classes and th= e tests themselves.<br>> ><br>> > The framework consists of one= interface, one class and one hivemind <br>> > descriptor. The interface is IFixture, it provides the signat= ure for<br>> > all operations that can be executed in a fixture. A fr= esh instance of<br>> > the fixture will be provided to each test clas= s at every test run. <br>> > I've come up with the following code for now, still some oper= ations<br>> > missing but good for getting the main picture:<br>> = ><br>> > /**<br>> > * A test fixture. Should have= an implementation for each IDE. <br>> > */<br>> > public interface IFixture<W, F&= gt;<br>> > {<br>> > /**<br>> >&nb= sp; * Adds a web root.<br>> >  = ; *<br>> > = * @param filePath the absolute path to the web root= directory. <br>> > * @param relativePath the = relative path of the web root. Some<br>> > IDEs let the user specify = a different relative path for each web root,<br>> > changing the defa= ult "/" path.<br> > > * @return the added web root.<= br>> > */<br>> > = W addWebRoot(String filePath, String relativePath);<br>> &g= t;<br>> > /**<br>> > &= nbsp; * Adds a web root with the default "/" relative = path. <br>> > *<br>> > = * @param filePath the absolute path to the web root= directory.<br>> > * @return the a= dded web root.<br>> > */<br>> &= gt; W addWebRoot(String filePath);<br> > ><br>> > /**<br>> > = * Adds an empty file to a web root.<br>> >&nb= sp; *<br>> > &nbs= p; * @param webRoot the web root to add the file to.<br>> > = ; * @param path the abs= olute path of the file to be added. <br>> > * @return the added file.<= br>> > */<br>> > = F addFileToWebRoot(W webRoot, String path);<br>> ><br>&g= t; > /**<br>> > &nb= sp; * Adds a source root.<br>> > &n= bsp;*<br> > > * @param filePath the absolute= path to the source root directory.<br>> > &nb= sp; * @return the added source root.<br>> > &nb= sp; */<br>> > F addSourceRoot(Stri= ng filePath);<br>> ><br>> > /** <br>> > * Adds an empty class to a= source root.<br>> > *<br>> >= ; * @param root &= nbsp; the source root to add the class to.<br>> >&nb= sp; * @param packageName the class package.<br= >> > * @param className  = ; the class name. <br>> > */<br>> >  = ; void addClassToSourceRoot(F root, String packageName, String<= br>> > className);<br>> ><br>> > = /**<br>> > * Adds a .jar file to t= he classpath.<br>> > * <br>> > * @param jarFile the .jar = file to add to the classpath.<br>> > &nb= sp;*/<br>> > void addJarToClasspath(F jarFile= );<br>> ><br>> > /**<br>> > = * Adds a file to a source root. <br>> > *<br>> > = * @param root &n= bsp; the source root to add the file to.<br>> >  = ; * @param packageName the package to add the file to.<br>= > > * @param fileName &= nbsp; the absolute path to the file to be added. <br>> > */<br>> >  = ; void addFileToSourceRoot(F root, String packageName, String<b= r>> > fileName);<br>> ><br>> > /*= *<br>> > * Tears down the fixture.= <br>> > */ <br>> > void tearDown();<br>> > }<br>&g= t; ><br>> ><br>> > The base class for all tests is also prov= ided. I called it<br>> > AbstractSpindleTestCase. This class provides= a getFixture() method to <br>> > every subclass and is responsible for getting the fresh fixtu= re<br>> > instance from Hivemind at every test run. Here's the code i= came up with:<br>> ><br>> > /**<br>> > * Base= class for all test classes. <br>> > *<br>> > * @author Hugo Palma<br>= > > */<br>> > public abstract class AbstractSpindleT= estCase extends TestCase<br>> > {<br>> >  = ; private IFixture _fixture;<br>> > private s= tatic Registry _registry; <br>> ><br>> > {<br>> > &nbs= p; _registry =3D RegistryBuilder.constr= uctDefaultRegistry();<br>> > }<br>> ><b= r>> > /**<br>> >  = ; * {@inheritDoc}<br>> > &nbs= p;*/<br> > > protected void setUp() throws Exception<b= r>> > {<br>> > &= nbsp; super.setUp();<br>> ><br>> >  = ; // Allows getting a brand new IFixtur= e instance every time.<br>> > &nbs= p; _registry.cleanupThread(); <br>> > _registry.set= upThread();<br>> ><br>> > &n= bsp; _fixture =3D (IFixture) _registry.getService(IFixture.class );<b= r>> > }<br>> ><br>> > = /**<br>> > * {@inheri= tDoc} <br>> > */<br>> >  = ; protected void tearDown() throws Exception<br>> > = {<br>> > = super.tearDown();<br>> ><br>> > &= nbsp; // Cleanup the fixture.<br>> > &nb= sp; _fixture.tearDown(); <br>> > _fixture =3D = null;<br>> > }<br>> ><br>> > = ; protected IFixture getFixture()<br>> >  = ; {<br>> >  = ; return _fixture;<br>> > }<br>> > }<br= >> > <br>> > The only thing missing is the hivemodule.xml in the spindle-t= ests module:<br>> ><br>> > <module id=3D" net.sf.spindl= e.tests" version=3D"1.0.0"><br>> >  = ; <service-point id=3D"fixture" <br>> > interface=3D"net.sf.spindle.tests.IFixture"/><br= >> > </module><br>> ><br>> > So, given this, all th= e IDE has to do is:<br>> ><br>> > - Create an implementation of= the IFixture interface. <br>> > - Provide a hivemodule.xml file in it's spindle-core implemen= tation<br>> > module with something like:<br>> ><br>> >&n= bsp; <module id=3D"org.intellij.tapestry" version=3D&quo= t; 1.0.0"> <br>> > <dependency module-id=3D"net.= sf.spindle.tests" version=3D"1.0.0"/><br>> ><br>>= ; > <implementation service-id=3D"net.sf= .spindle.tests.fixture"><br>> > = <invoke-factory model=3D"threaded"> <br>> > &n= bsp; <construct class=3D"org.intellij.tapestry.test.Fixture&q= uot;/><br>> > <= /invoke-factory><br>> > </implementatio= n><br>> > </module><br>> > - Execute the tests. I mana= ged to run the tests from IDEA with no <br>> > problem. I'm going to see how/if i can run tests from a jar f= ile with<br>> > Maven2.<br>> ><br>> ><br>> > Though= ts ?<br>><br>><br>> ----------------------------------------------= --------- <br>> Using Tomcat but need to do more? Need to support web services, se= curity?<br>> Get stuff done quickly with pre-integrated technology to ma= ke your job easier<br>> Download IBM WebSphere Application Server v.1.0.= 1 based on Apache Geronimo<br>> <a href=3D"http://sel.as-us.falkag.net/se= l?cmd=3Dlnk&kid=3D120709&bid=3D263057&dat=3D121642">http://sel.= as-us.falkag.net/sel?cmd=3Dlnk&kid=3D120709&bid=3D263057&dat=3D= 121642</a><br> > _______________________________________________<br>> Spindle-develo= per mailing list<br>> <a href=3D"mailto:[email protected]= rge.net">[email protected]</a><br>> <a href=3D"htt= ps://lists.sourceforge.net/lists/listinfo/spindle-developer"> https://lists.sourceforge.net/lists/listinfo/spindle-developer</a><br>><= br><br><br>--<br>The Spindle guy. <a href=3D"http://spindle.sf.net">http://= spindle.sf.net</a><br>Blog: = <a href=3D"http= ://jroller.com/page/glongman"> http://jroller.com/page/glongman</a><br>Other interests: <a href= =3D"http://www.squidoo.com/spaceelevator/">http://www.squidoo.com/spaceelev= ator/</a><br><br><br>------------------------------------------------------= -<br>Using Tomcat but need to do more? Need to support web services, securi= ty? <br>Get stuff done quickly with pre-integrated technology to make your job = easier<br>Download IBM WebSphere Application Server v.1.0.1 based on Apache= Geronimo<br><a href=3D"http://sel.as-us.falkag.net/sel?cmdlnk&kid=1207= 09&bid&3057&dat=121642"> http://sel.as-us.falkag.net/sel?cmdlnk&kid=120709&bid&3057&= dat=121642</a><br>_______________________________________________<br>Spindl= e-developer mailing list<br><a href=3D"mailto:[email protected]= eforge.net"> [email protected]</a><br><a href=3D"https://lists.sou= rceforge.net/lists/listinfo/spindle-developer">https://lists.sourceforge.ne= t/lists/listinfo/spindle-developer</a><br></blockquote></div><br> ------=_Part_4739_12690770.1147425504153-- ------------------------------------------------------- Using Tomcat but need to do more? Need to support web services, security? Get stuff done quickly with pre-integrated technology to make your job easier Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642