In order to make sure a method works correctly, a test can be implemented that assures the correct behavior.
It is a common practice to write tests to clarify how an object should respond, and it may avoid inconsistencies on the long run. A test is always a subclass of UnitTest, implementing at least one method starting with test_.
When running all tests of one class (see run), each test method is called in a separate instance of this class. Test methods, therefore, do not interfere with each other.
testsuite/classlibrary directory of the SuperCollider sources.
To install, download the sources and add the directory to your sclang_conf.yaml, either by editing it or via the ScIDE preferences.
A graphical interface to run and browse all tests
UnitTest.guiAccessor controlling whether passing tests should be reported. Defaults to true. See also *passVerbosity which controls how much detail is reported from passing tests when this is set to true.
| (value) |
Should be |
Accessor controlling whether extra details should be reported for passing tests.
Defaults to UnitTest.full so that all details are reported; however this behaviour may be too verbose for some, for whom it is sufficient to see that a test is passing without needing to see the detail. If set to UnitTest.brief, and *reportPassesis true, passes will be reported, but without any extra details which may be provided by assertions.
| (value) |
Should be |
Run all methods whose names begin with test_.
xxxxxxxxxxTestUnitTest.new.run;| reset |
If |
| report |
If |
Run a single test method.
xxxxxxxxxxUnitTest.reset;UnitTest.runTest("TestUnitTest:test_assert");| methodName |
A String referring to the class and test method within it, e.g. |
Run the entire test suite. As this method addresses the entire test suite, it should be called only on UnitTest. Calling it on any of its subclasses will result in throwing an Error.
xxxxxxxxxxUnitTest.reset;UnitTest.runAll;Run a single test method of this class
xxxxxxxxxxTestUnitTest.new.runTestMethod(TestUnitTest.findMethod(\test_assert));| method |
the method to run |
| report |
Reports the result of the test if |
(describe returnvalue here)
Asserts that an expression must be true.
xxxxxxxxxxthis.assert(2 == 2, "passes");this.assert(2 == 2.00001, "fails");| boolean |
A boolean, where |
| message |
A message describing the purpose of the assertion, e.g. |
| report |
Reports the result of the test if |
| onFailure |
If not |
| details |
Some optional extra details which will be passed to the reporting framework for display unless brief reporting is requested (see *passVerbosity). |
Asserts that an expression a is equal to the value b, where equality is determined according to a's implementation of ==.
Automatically passes details of the equality check to the reporting framework, which will be displayed if the assertion fails, and also if it passes and *reportPasses is true and *passVerbosity is not set to UnitTest.brief.
xxxxxxxxxxthis.assertEquals(2 + 2, 4, "passes");this.assertEquals(2 + 2, 5, "fails");| a |
the experimentally produced value |
| b |
the expected value |
| message |
A message describing the purpose of the assertion, e.g. |
| report |
Reports the result of the test if |
| onFailure |
If not |
Asserts that an expression a returning a float is within a given range (within) of being equal to b.
Automatically passes details of the equality check to the reporting framework, which will be displayed if the assertion fails, and also if it passes and *reportPasses is true and *passVerbosity is not set to UnitTest.brief.
xxxxxxxxxxthis.assertFloatEquals(2, 2.0001, "Pass since 2 is close enough to 2.0001.", 0.001);this.assertFloatEquals(2, 2.0001, "Fail since 2 isn't close enough to 2.0001.", 0.0001);| a |
the experimentally produced float value |
| b |
the expected float value |
| message |
A message describing the purpose of the assertion, e.g. |
| within |
The range within which |
| report |
Reports the result of the test if |
| onFailure |
If not |
Make sure that the two arrays of floats a and b equal within a given range (within).
xxxxxxxxxxthis.assertArrayFloatEquals([2, 3] + 0.0001, [2, 3], "Pass since pairs of floats are close enough", 0.001);this.assertArrayFloatEquals([2, 3.0001], [2, 3], "Fail since pairs of floats aren't both close enough", 0.0001);| a |
the experimentally produced value, which is an |
| b |
the |
| message |
A message describing the purpose of the assertion, e.g. |
| within |
The range within which each item of |
| report |
Reports the result of the test if |
| onFailure |
If not |
Make a further assertion only if it passed, or only if it failed.
xxxxxxxxxx(a = UnitTest.new;a.ifAsserts(2 == 3, "yes", { a.assert(2 == 4) }, { a.assert(1 == 1, "but this is correct") });)Make sure that a specific Exception or Error is thrown.
| func |
Pass the code that is expected to throw an error in this function. |
| errorClass |
The class or class name which the error should be kind of. |
| message |
A message describing the purpose of the assertion. |
| report |
Reports the result of the test if |
| onFailure |
If not |
| details |
Some optional extra details which will be passed to the reporting framework for display unless brief reporting is requested (see *passVerbosity). |
Make sure that a specific Exception or Error is not thrown. For arguments, see -assertException.
Wait for a predicate function to return true. Considers the test failed after maxTime. Only valid within a test (or a routine).
xxxxxxxxxx({ s.reboot; UnitTest.new.wait({ s.serverRunning }, "server failed to boot in time", 2);}.fork)Wait for server boot until continued. Only valid within a test (or a routine).
If already booted, then freeAll and create new allocators.
xxxxxxxxxx({ UnitTest.new.bootServer(s);}.fork)Supply some debugging information relevant to the currently running test case. This will be displayed immediately preceding any details which may be displayed through use of the details argument of -passed and -failed.
| text |
The debugging text. |
xxxxxxxxxxtest_myMethod { var obj = MyClass.new; this.debug("obj has color" + obj.color); this.assert(2 + 2, 5);}will result in:
xxxxxxxxxxFAIL: a TestMyClass: test_myMethodobj has color redIs: 4Should be: 5Register a passed test.
| method |
Name of the method in which the test is passing. |
| message |
A message describing the purpose of the assertion, e.g. |
| report |
Reports the result of the test if true and *reportPasses is true. |
| details |
Some optional extra details which will be displayed if *reportPasses is true and *passVerbosity is not set to |
xxxxxxxxxxthis.passed(message: "this passed");Register a test failure.
| method |
Name of the method in which the test is failing. |
| message |
A message describing the purpose of the assertion, e.g. |
| report |
Reports the result of the test if true. |
| details |
Some optional extra details which will be displayed if |
xxxxxxxxxxthis.failed(message: "this failed");Write tests by subclassing UnitTest, and defining methods whose names begins test_. Each test method will be called from a fresh instance of the subclass.
If you implement the methods setUp and tearDown in your test class, they will be called before and after every test. This can help to eliminate repetitive code, and makes it easier to maintain your tests by ensuring that they all run under the same set of conditions.
TestYourClass : UnitTest { setUp { // this will be called before each test } tearDown { // this will be called after each test } test_yourMethod { // every method whose name begins with "test_" will be run this.assert( 6 == 6, "6 should equal 6"); this.assertEquals( 9, 9, "9 should equal 9"); this.assertFloatEquals( 4.0 , 1.0 * 4.0 / 4.0 4.0, "floating point math should be close to equal"); // we are inside a Routine, you may wait 1.0.wait; // this will wait until the server is booted this.bootServer; // if the server is already booted it will free all nodes // and create new allocators, giving you a clean slate p = { SinOsc.ar }; p.play; p.register; // will wait until the condition is true // will be considered a failure after 10 seconds this.wait( { p.isPlaying }, "waiting for synth to play", 10); }}