aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/TESTING.txt
diff options
context:
space:
mode:
Diffstat (limited to 'TESTING.txt')
-rw-r--r--TESTING.txt82
1 files changed, 75 insertions, 7 deletions
diff --git a/TESTING.txt b/TESTING.txt
index 6e4999a..97bffe2 100644
--- a/TESTING.txt
+++ b/TESTING.txt
@@ -1,17 +1,86 @@
1==UPDATE==
2
3The text immediately following is an update to the testing documentation. The
4update is written on 2008.08.30 and is copied from an email to the opensim-dev
5mailing list[1]. The information below the update, beginning with the section
6titled TESTING, is still relevant, so please read this document in its
7entirety.
8
9Mike Mazur
10
11[1] https://lists.berlios.de/pipermail/opensim-dev/2008-August/002695.html
12
13"""
14The tests are contained in certain DLLs. At the time of writing, these DLLs
15have tests in them:
16
17OpenSim.Region.ScriptEngine.Common.Tests.dll
18OpenSim.Region.ScriptEngine.Shared.CodeTools.Tests.dll
19OpenSim.Region.ScriptEngine.Shared.Tests.dll
20OpenSim.Framework.Tests.dll OpenSim.Region.Environment.dll
21OpenSim.Region.Physics.OdePlugin.dll[2]
22
23The console command used to run the tests is `nunit-console` (or
24`nunit-console2` on some systems). This command takes a listing of DLLs to
25inspect for tests.
26
27Currently Bamboo's[3] build file (.nant/bamboo.build) lists only those DLLs
28for nunit-console to use. However it would be equally correct to simply pass
29in all DLLs in bin/; those without tests are just skipped.
30
31The nunit-console command generates a file TestResults.txt by default. This is
32an XML file containing a listing of all DLLs inspected, tests executed,
33successes, failures, etc. If nunit-console is passed in all DLLs in bin/, this
34file bloats with lots of entries like this:
35
36 <test-suite name="/home/mike/source/workspace/bin/OpenSim.Grid.Communications.OGS1.dll" success="True" time="0.000" asserts="0">
37 <results />
38 </test-suite>
39 <test-suite name="/home/mike/source/workspace/bin/OpenSim.Region.ClientStack.dll" success="True" time="0.000" asserts="0">
40 <results />
41 </test-suite>
42
43Therefore it makes more sense to me to specify the DLLs when running
44nunit-console.
45
46[2] Note that OpenSim.Region.Physics.OdePlugin.dll is in bin/Physics/ and
47needs to be first copied to bin/ before nunit-console is executed.
48[3] http://opensimulator.org:8085/
49"""
50
1==TESTING== 51==TESTING==
2To use nunit testing on opensim code, you have a variety of methods. The easiast methods involve using IDE capabilities to test code. Using VS2005/2008 I recommend using the testing capabilities of Resarper(commercial) or TestDriven.Net(free). Both will recognize nunit tests within your application and allow you to test them individually, or all at once, etc. You will also be able to step into debug mode into a test through these add-ins enabling a developer to jump right in and see how a specific test-case/scenerio works. 52To use nunit testing on opensim code, you have a variety of methods. The
53easiast methods involve using IDE capabilities to test code. Using
54VS2005/2008 I recommend using the testing capabilities of Resarper(commercial)
55or TestDriven.Net(free). Both will recognize nunit tests within your
56application and allow you to test them individually, or all at once, etc. You
57will also be able to step into debug mode into a test through these add-ins
58enabling a developer to jump right in and see how a specific
59test-case/scenerio works.
3 60
4Additionally, it is my understanding that sharpdevelop and monodevelop have their own nunit testing plugins within their IDE. Though I am not certain of their exact feature set or stability. 61Additionally, it is my understanding that sharpdevelop and monodevelop have
62their own nunit testing plugins within their IDE. Though I am not certain of
63their exact feature set or stability.
5 64
6== Using NUnit Directly == 65== Using NUnit Directly ==
7The NUnit project is a very mature testing application. It can be obtained from www.nunit.org are via various package distrobutions for Linux. Please be sure to get a .Net 2.0 version of Nunit, as OpenSim makes use of .Net 2.0 functionality. 66The NUnit project is a very mature testing application. It can be obtained
67from www.nunit.org are via various package distrobutions for Linux. Please be
68sure to get a .Net 2.0 version of Nunit, as OpenSim makes use of .Net 2.0
69functionality.
8 70
9Nunit comes with 2 tools that will enable you to run tests from assembly inputs. Nunit-gui and nunit-console. NUnit-gui is a console that will let you view the execution of various tests within your assemblies and give visual indication of teir success or failure. This is a useful tool for those who lack IDE addins ( or lack IDEs at all ). 71Nunit comes with 2 tools that will enable you to run tests from assembly
72inputs. Nunit-gui and nunit-console. NUnit-gui is a console that will let
73you view the execution of various tests within your assemblies and give visual
74indication of teir success or failure. This is a useful tool for those who
75lack IDE addins ( or lack IDEs at all ).
10 76
11Nunit console allows you to execute the nunit tests of assemblies via console. Its output will show test failures and successes and a summary of what happened. This is very useful for a quick overview and/or automated testing. 77Nunit console allows you to execute the nunit tests of assemblies via console.
78Its output will show test failures and successes and a summary of what
79happened. This is very useful for a quick overview and/or automated testing.
12 80
13Windows 81Windows
14Windows version of nunit-console is by default .Net 2.0 if you downloaded the .Net 2.0 version of Nunit. Be sure to setup your PATH environment variable. 82Windows version of nunit-console is by default .Net 2.0 if you downloaded the
83.Net 2.0 version of Nunit. Be sure to setup your PATH environment variable.
15 84
16Linux & OSX 85Linux & OSX
17On these operating systems you will have to use the command "nunit-console2" 86On these operating systems you will have to use the command "nunit-console2"
@@ -22,4 +91,3 @@ nunit-console2 OpenSim.Framework.Tests.dll (on linux)
22nunit-console OpenSim.Framework.Tests.dll (on windows) 91nunit-console OpenSim.Framework.Tests.dll (on windows)
23 92
24For more information on testing contact the autor of this testing readme: Daedius Moskvitch ( daedius @@@@ daedius com) 93For more information on testing contact the autor of this testing readme: Daedius Moskvitch ( daedius @@@@ daedius com)
25