Removed osdp-diff folder, replaced print() with log.debug(); updated …

…test cases

osdp/_bus.py

@@ -130,8 +130,7 @@ def process_reply(self, reply: Reply, device: Device):
 			device.initialize_secure_channel(reply)
 		elif reply.type == ReplyType.InitialRMac:
 			if device.validate_secure_channel_establishment(reply):
-				print("Secure session established.")
-
+				log.debug("Secure session established.")
 
 		if self._on_reply_received is not None:
 			self._on_reply_received(reply)

osdp/_command.py

@@ -1,9 +1,12 @@
 from abc import abstractmethod
+import logging
 
 from ._types import OutputControls, ReaderLedControls, ReaderBuzzerControl, ReaderTextOutput
 from ._message import Message
 import datetime
 
+log = logging.getLogger('osdp')
+
 
 class Command(Message):
 
@@ -38,7 +41,7 @@ def build_command(self, device) -> bytes:
 		command_buffer.append(self.command_code)
 
 		if device.is_security_established:
-			print("Building secure message...")
+			log.debug("Building secure message...")
 			command_buffer.extend(self.encrypted_data(device))
 
 			# TODO: I don't think this needed
@@ -367,6 +370,7 @@ def data(self) -> bytes:
 	def custom_command_update(self, command_buffer: bytearray):
 		pass
 
+
 class KeySetCommand(Command):
 
 	def __init__(self, address: int, scbk: bytes):
@@ -389,8 +393,8 @@ def custom_command_update(self, command_buffer: bytearray):
 	def keyset_data(self):
 		header = []
 		type = 0x01
-		len = 0x10
+		length = 0x10
 		scbk = [0x41, 0x02, 0x31, 0x84, 0xF1, 0xA2, 0xDE, 0x7C, 0x32, 0x98, 0x01, 0xB8, 0x7B, 0x56, 0xB3, 0x60]
 		header.append(type)
-		header.append(len)
-		return bytes(header + scbk)
+		header.append(length)
+		return bytes(header + scbk)

osdp/_connection.py

@@ -36,7 +36,7 @@ def read(self, size: int = 1) -> bytes:
 
 class SerialPortOsdpConnection(OsdpConnection):
 
-	def __init__(self, port: str, baud_rate: int, raspberry_pi: bool=False):
+	def __init__(self, port: str, baud_rate: int, raspberry_pi: bool = False):
 		self._port = port
 		self._baud_rate = baud_rate
 		self.serial_port = None

osdp/_control_panel.py

@@ -68,7 +68,6 @@ def keyset(self, connection_id: UUID, address: int) -> bool:
 		reply = self.send_command(connection_id, KeySetCommand(address, bytes([])))
 		return reply.type == ReplyType.Ack
 
-
 	def is_online(self, connection_id: UUID, address: int) -> bool:
 		bus = self._buses.get(connection_id)
 		if bus is None:

osdp/_device.py

@@ -1,3 +1,4 @@
+import logging
 import queue
 import datetime
 
@@ -7,6 +8,8 @@
 )
 from ._secure_channel import SecureChannel
 
+log = logging.getLogger('osdp')
+
 
 class Device(object):
 
@@ -30,7 +33,7 @@ def is_online(self) -> bool:
 	def get_next_command_data(self):
 		if self.message_control.sequence == 0:
 			return PollCommand(self.address)
-		
+
 		if self._use_secure_channel and not self._secure_channel.is_initialized:
 			return SecurityInitializationRequestCommand(self.address, self._secure_channel.server_random_number)
 
@@ -56,7 +59,7 @@ def initialize_secure_channel(self, reply):
 
 	def validate_secure_channel_establishment(self, reply) -> bool:
 		if not reply.secure_cryptogram_has_been_accepted():
-			print("Cryptogram not accepted")
+			log.debug("Cryptogram not accepted")
 			return False
 
 		self._secure_channel.establish(reply.extract_reply_data)

osdp/_reply.py

@@ -1,11 +1,14 @@
 from abc import abstractmethod
+import logging
 from uuid import UUID
 
 from ._types import SecurityBlockType, ReplyType, Control
 from ._message import Message
 from ._command import Command
 from ._device import Device
 
+log = logging.getLogger('osdp')
+
 
 class Reply(Message):
 
@@ -112,7 +115,7 @@ def parse(data: bytes, connection_id: UUID, issuing_command: Command, device: De
 		return reply
 
 	def secure_cryptogram_has_been_accepted(self) -> bool:
-		print("Secure block data: ", self.secure_block_data[0])
+		log.debug("Secure block data: %s", self.secure_block_data[0])
 		return self.secure_block_data[0] != 0
 
 	def match_issuing_command(self, command: Command) -> bool:
@@ -156,7 +159,7 @@ def __repr__(self):
 		return "Connection ID: {0} Address: {1} Type: {2}".format(self._connection_id, self.address, self.type)
 
 	def decrypt_data(self, device: Device) -> bytes:
-		print("Extract reply data: ", self.extract_reply_data.hex())
+		log.debug("Extract reply data: %s", self.extract_reply_data.hex())
 		return device.decrypt_data(self.extract_reply_data)
 
 

tests/context.py

@@ -0,0 +1,10 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""Context for tests for OSDP Python Module."""
+
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath('..'))
+from osdp import *

tests/puppet_connection.py

@@ -1,14 +1,15 @@
 
 import os
 import sys
-sys.path.insert(0, os.path.abspath('..'))
-from osdp import *
 import time
 import logging
 import random
 
+from context import OsdpConnection
+
 log = logging.getLogger('osdp')
 
+
 class PuppetOsdpConnection(OsdpConnection):
 
 	def __init__(self):
@@ -40,4 +41,4 @@ def read(self, size: int=1) -> bytes:
 		taken = self.should_reply[:size]
 		remain = self.should_reply[size:]
 		self.should_reply = remain
-		return taken
+		return taken

tests/run_test.sh

@@ -0,0 +1,5 @@
+python3 -m unittest -v test_all.py
+python3 -m unittest -v test_bus.py
+python3 -m unittest -v test_command.py
+#python3 -m unittest -v test_control_panel.py
+python3 -m unittest -v test_reply.py

tests/test_all.py

@@ -1,8 +1,9 @@
 import unittest
 
-from .test_command import CommandTestCase
-from .test_reply import ReplyTestCase
-from .test_bus import BusTestCase
+from test_command import CommandTestCase
+from test_reply import ReplyTestCase
+from test_bus import BusTestCase
+
 
 def create_suite():
     test_suite = unittest.TestSuite()
@@ -11,8 +12,9 @@ def create_suite():
     test_suite.addTest(BusTestCase())
     return test_suite
 
+
 if __name__ == '__main__':
    suite = create_suite()
 
    runner=unittest.TextTestRunner()
-   runner.run(suite)
+   runner.run(suite)

tests/test_bus.py

@@ -8,12 +8,12 @@
 import sys
 import unittest
 
-sys.path.insert(0, os.path.abspath('..'))
-from osdp import *
-from .puppet_connection import PuppetOsdpConnection
+from puppet_connection import PuppetOsdpConnection
+from context import *
 
 log = logging.getLogger('osdp')
 
+
 class BusTestCase(unittest.TestCase):
 
 	"""Test Bus for OSDP Python Module."""
@@ -203,4 +203,4 @@ def test_reader_led_control_denied_checksum(self):
 		self.assertEqual(device.message_control.sequence, 2)
 
 if __name__ == '__main__':
-	unittest.main()
+	unittest.main()

tests/test_command.py

@@ -8,8 +8,7 @@
 import unittest
 import datetime
 
-sys.path.insert(0, os.path.abspath('..'))
-from osdp import *
+from context import *
 
 
 class CommandTestCase(unittest.TestCase):
@@ -489,4 +488,4 @@ def test_reader_mfg_command_crc(self):
 		self.assertEqual(content.hex().upper(), '537F0C0007800B0E0E0FEDCC')
 
 if __name__ == '__main__':
-	unittest.main()
+	unittest.main()

tests/test_control_panel.py

@@ -9,11 +9,11 @@
 import time
 import unittest
 
-sys.path.insert(0, os.path.abspath('..'))
-from osdp import *
+from context import *
 
 log = logging.getLogger('osdp')
 
+
 class ControlPanelTestCase(unittest.TestCase):
 
 	"""Test Bus for OSDP Python Module."""
@@ -106,4 +106,4 @@ def test_cp_checksum_unsecure(self):
 
 
 if __name__ == '__main__':
-	unittest.main()
+	unittest.main()

tests/test_reply.py

@@ -9,8 +9,7 @@
 import datetime
 from uuid import UUID, uuid4
 
-sys.path.insert(0, os.path.abspath('..'))
-from osdp import *
+from context import *
 
 
 class ReplyTestCase(unittest.TestCase):
@@ -163,4 +162,4 @@ def test_poll_reply_key_data_crc(self):
 		self.assertEqual(device.message_control.sequence, 3)
 
 if __name__ == '__main__':
-	unittest.main()
+	unittest.main()