modified: lib/pygsm/gsmmodem.py

            make sure max_message argument is sane

modified:   run_tests.py
            added #! line so can be run directly

modified:   test/gsmmodem_test.py
            added tests for max_message argument

Author: jwishnie

lib/pygsm/gsmmodem.py

@@ -441,14 +441,29 @@ def send_sms(self, recipient, text, max_messages = 255):
         multiple SMSs up to max_messages.
 
         To enforce only a single SMS, set max_messages=1
+        
+        If max_messages > 255 it is forced to 255
+        If max_messages < 1 it is forced to 1
 
         Raises 'ValueError' if text will not fit in max_messages
         
         NOTE: Only PDU mode respects max_messages! It has no effect in TEXT mode
 
         """
+        mm = 255
+        try:
+            mm = int(max_messages)
+        except:
+            # dunno what type mm was, so just leave at deafult 255
+            pass
+        
+        if mm > 255:
+            mm = 255
+        elif mm < 1:
+            mm = 1
+        
         with self.modem_lock:
-            self.smshandler.send_sms(recipient, text, max_messages)
+            self.smshandler.send_sms(recipient, text, mm)
 
     def break_out_of_prompt(self):
         self._write(chr(27))

run_tests.py

@@ -1,3 +1,6 @@
+#!/usr/bin/env python
+# vim: ai ts=4 sts=4 et sw=4
+
 import os
 import sys
 import re
@@ -30,4 +33,4 @@ def callback( arg, dirname, fnames ):
 	print f
 	suite.addTests(loader.loadTestsFromName(f))
   unittest.TextTestRunner(verbosity=2).run(suite)
-  		
+  		

test/gsmmodem_test.py

@@ -9,6 +9,51 @@
 
 
 class TestModem(unittest.TestCase):
+    
+    def testMaxMessageArgs(self):
+        # this device is much more complicated than
+        # most, so is tucked away in mock.device
+        device = MockSenderDevice()
+        gsm = pygsm.GsmModem(device=device, mode="PDU")
+
+        # test with no max_message arg
+        gsm.send_sms("1234", "Test Message")
+        self.assertEqual(device.sent_messages[0]["recipient"], "21")
+        self.assertEqual(device.sent_messages[0]["text"], "00110004A821430000AA0CD4F29C0E6A96E7F3F0B90C")
+        
+        # test with reasonable max_message arg, should have no impact
+        gsm.send_sms("1234", "Test Message", max_messages = 20)
+        self.assertEqual(device.sent_messages[0]["recipient"], "21")
+        self.assertEqual(device.sent_messages[0]["text"], "00110004A821430000AA0CD4F29C0E6A96E7F3F0B90C")
+        
+        # test with max_message = 0, should internally set to 1 with no problems
+        gsm.send_sms("1234", "Test Message", -1)
+        self.assertEqual(device.sent_messages[0]["recipient"], "21")
+        self.assertEqual(device.sent_messages[0]["text"], "00110004A821430000AA0CD4F29C0E6A96E7F3F0B90C")
+        
+        # test with max_message > 255, should internally force to 255
+        gsm.send_sms("1234", "Test Message", 1024)
+        self.assertEqual(device.sent_messages[0]["recipient"], "21")
+        self.assertEqual(device.sent_messages[0]["text"], "00110004A821430000AA0CD4F29C0E6A96E7F3F0B90C")
+        
+        # test with max_message = 1 and message too long to fit
+        # should throw a value exception
+        msg="""
+        0123456789012345678901234567890123456789012345678901234567890123456789
+        0123456789012345678901234567890123456789012345678901234567890123456789
+        0123456789012345678901234567890123456789012345678901234567890123456789
+        0123456789012345678901234567890123456789012345678901234567890123456789
+        0123456789012345678901234567890123456789012345678901234567890123456789
+        0123456789012345678901234567890123456789012345678901234567890123456789
+        0123456789012345678901234567890123456789012345678901234567890123456789
+        """
+        try:
+            gsm.send_sms("1234", msg, max_messages=1)
+        except ValueError:
+            print "ValueError caught"
+        else:
+            # Should have thrown an error!
+            self.assertTrue(False)
 
     def testSendSmsPDUMode(self):
         """Checks that the GsmModem in PDU mode accepts outgoing SMS,