Merge lp:~mcfletch/simplegc/testsuite into lp:simplegc

[Mike C. Fletcher]

Hi Sam,

One thing that came up in reviewing the GSOC projects so far is that we are way behind on testing and testability. So, here's a quick skeleton of a test suite. You'd install nose and globalsub (pip install --user nose globalsub, then run nosetests -sv in the root of the checkout to run the (two very simple) test cases.

globalsub isn't necessarily something you need to use, it's just what *I* use for most of my test suites. There are lots of similar projects (look for Python mock).

You'll notice in this test suite that there are very few assertions of expected results. Normally you want your code to be testable in such a way that you can assert functionality without needing to "peek into" the code. That is, if I run ".update( time )" where the mouse is over the button, I expect to see e.g. a "MouseIn" event show up, and I want my test case to test for that. Or I want to be able to call the public API to see what the current state is. That style of suite is not "unit testing", it's closer to functional testing, but for now I'd be happy if we could get a reasonable functional test suite covering the bulk of the functionality. A fairly extensive functional test suite will catch most *major* regressions, and will often point out API issues where you might want to refactor the code to allow for easier sub-classing or to break functionality into smaller units.

Enjoy,
Mike

=== added directory 'tests'
=== added file 'tests/__init__.py'
=== added file 'tests/test_button.py'
--- tests/test_button.py	1970-01-01 00:00:00 +0000
+++ tests/test_button.py	2012-07-23 02:56:18 +0000
@@ -0,0 +1,36 @@
+from unittest import TestCase
+import sgc # python setup.py install --user 
+from sgc.locals import *
+
+import pygame
+from pygame.locals import *
+pygame.display.init()
+pygame.font.init()
+
+import globalsub # pip install --user "globalsub>=1.0.2"
+
+class TestButton( TestCase ):
+    def setUp( self ):
+        self.screen = sgc.surface.Screen((640,480))
+        self.simple_button = sgc.Button(
+            label="Clicky", pos=(100, 100)
+        )
+        self.simple_button.add(0)
+        self.posted_events = []
+        globalsub.subs( pygame.event.post, self.posted_events.append )
+    def tearDown( self ):
+        globalsub.restore( pygame.event.post )
+        globalsub.restore( pygame.mouse.get_pos )
+    def test_on_click( self ):
+        self.simple_button.on_click( )
+        assert self.posted_events, """Should have posted an event by default"""
+    def test_update( self ):
+        def fake_get_pos( ):
+            return (105, 105)
+        globalsub.subs( pygame.mouse.get_pos, fake_get_pos )
+        self.simple_button.update( 23.35 )
+        # we would *want* to be able to say, e.g.
+        # that we generated an observable event through the public API
+        #  but we don't currently have any observable behaviour
+        assert self.simple_button._state == 'over', self.simple_button._state 
+