AI tests

src/pyspacewar/tests/test_ai.py

@@ -6,6 +6,12 @@
 import os
 
 
+def effect(msg):
+    def callback(*args):
+        print(msg)
+    return callback
+
+
 def doctest_AIController_chooseEnemy():
     """Tests for AIController.chooseEnemy.
 
@@ -59,6 +65,176 @@ def doctest_AIController_chooseEnemy():
     """
 
 
+def doctest_AIController_control():
+    """Tests for AIController.control.
+
+        >>> from ai import AIController
+        >>> from world import Ship, World, Object, Vector
+        >>> ship = Ship(velocity=Vector(30, 0))
+        >>> world = World()
+        >>> world.add(ship)
+        >>> ai = AIController(ship)
+
+    Not much to do in an empty world.
+
+        >>> ai.control()
+        >>> ship.engage_brakes
+        True
+
+    But if we find other ships, we can engage them!
+
+        >>> other = Ship(position=Vector(100, 20))
+        >>> world.add(other)
+        >>> ai.control()
+
+    unless we're dead
+
+        >>> ship.dead = True
+        >>> ai.control()
+
+    """
+
+
+def doctest_AIController_target():
+    """Tests for AIController.target.
+
+        >>> from ai import AIController
+        >>> from world import Ship, World, Vector
+        >>> ship = Ship(position=Vector(0, 0))
+        >>> other = Ship(position=Vector(10, 20))
+        >>> world = World()
+        >>> world.add(ship)
+        >>> world.add(other)
+        >>> ai = AIController(ship)
+        >>> ai.maybe_fire = effect('Foom!')
+
+    The AI has to be able to turn the ship towards the enemy
+
+        >>> ai.target(other)
+        >>> ship.right_thrust
+        0
+        >>> ship.left_thrust > 0
+        True
+
+    We'll fire when we're turning across the enemy
+
+        >>> ship.direction = 90
+        >>> ai.target(other)
+        Foom!
+
+        >>> ship.direction = 45
+        >>> ai.target(other)
+        Foom!
+
+    """
+
+
+def doctest_AIController_evade():
+    """Tests for AIController.evade.
+
+        >>> from ai import AIController
+        >>> from world import Ship, World, Missile, Planet, Vector
+        >>> ship = Ship(position=Vector(0, 0))
+        >>> other = Ship(position=Vector(10, 20))
+        >>> sun = Planet(position=Vector(35, 20), radius=5)
+        >>> world = World()
+        >>> world.add(ship)
+        >>> world.add(other)
+        >>> world.add(sun)
+        >>> ai = AIController(ship)
+
+    In order not to crash into planets we need to take evasive action
+    sometimes.  E.g. the planet is to the left of our path
+
+        >>> ai.evade(other)
+        >>> ship.left_thrust
+        0
+        >>> ship.right_thrust
+        1
+
+    and when it's to the right
+
+        >>> ship.direction = 90
+        >>> ai.evade(other)
+        >>> ship.left_thrust
+        1
+        >>> ship.right_thrust
+        0
+
+    If we're further away from the planet, then we can follow the
+    enemy instead of focusing 100% on the planet
+
+        >>> ship.position = Vector(-100, -100)
+        >>> ship.direction = 0
+        >>> ship.left_thrust = 10
+        >>> ship.right_thrust = 0
+        >>> ai.evade(other)
+        >>> ship.left_thrust
+        10
+        >>> ship.right_thrust
+        1
+
+        >>> ship.direction = 90
+        >>> ship.left_thrust = 10
+        >>> ship.right_thrust = 0
+        >>> ai.evade(other)
+        >>> ship.left_thrust
+        11
+        >>> ship.right_thrust
+        0
+
+    """
+
+
+def doctest_AIController_getClosestToObject():
+    """Tests for AIController.getClosestToObject.
+
+        >>> from ai import AIController
+        >>> from world import Ship, World, Missile, Planet, Vector
+        >>> ship = Ship(position=Vector(30, 0))
+        >>> missile = Missile(position=Vector(31, 0))
+        >>> sun = Planet(position=Vector(35, 20), radius=5)
+        >>> moon = Planet(position=Vector(0, -10), radius=2)
+        >>> world = World()
+        >>> world.add(ship)
+        >>> world.add(missile)
+        >>> world.add(sun)
+        >>> world.add(moon)
+        >>> ai = AIController(ship)
+
+    In order not to crash into planets we need to pay attention
+
+        >>> ai.getClosestToObject(ship) is sun
+        True
+
+    """
+
+
+def doctest_AIController_maybe_fire():
+    """Tests for AIController.maybe_fire.
+
+        >>> from ai import AIController
+        >>> from world import Ship, World, Object, Vector
+        >>> ship = Ship()
+        >>> ship.launch_effect = effect('Foom!')
+        >>> world = World()
+        >>> world.add(ship)
+        >>> ai = AIController(ship)
+
+    The AI always fires at very close range
+
+        >>> enemy = Ship()
+        >>> ai.maybe_fire(enemy, 10)
+        Foom!
+
+    unless the enemy is already dead
+
+        >>> enemy.dead = True
+        >>> ai.maybe_fire(enemy, 10)
+
+    """
+
+
 def test_suite():
     path = os.path.join(os.path.dirname(__file__), os.path.pardir)
     if path not in sys.path: