Adding unit tests specific to note_parser.

Fixing bug with note_parser - A/B were in wrong octave!! #3

Author: Kevin J Walters

adafruit_midi/midi_message.py

@@ -46,9 +46,9 @@
 # represent all of the sixteen channels
 ALL_CHANNELS = -1
 
-# From C3
-# Semitones    A   B   C   D   E   F   G
-NOTE_OFFSET = [9, 11, 12, 14, 16, 17, 19]
+# From C3 - A and B are above G
+# Semitones     A   B   C   D   E   F   G
+NOTE_OFFSET = [21, 23, 12, 14, 16, 17, 19]
 
 # pylint: disable=no-else-return
 def channel_filter(channel, channel_spec):

tests/test_note_parser.py

@@ -0,0 +1,93 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2019 Kevin J. Walters
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+import unittest
+from unittest.mock import Mock, MagicMock, call
+
+import random
+import os
+verbose = int(os.getenv('TESTVERBOSE', '2'))
+
+# adafruit_midi has an import usb_midi
+import sys
+sys.modules['usb_midi'] = MagicMock()
+
+# Borrowing the dhalbert/tannewt technique from adafruit/Adafruit_CircuitPython_Motor
+sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
+
+from adafruit_midi.midi_message import note_parser
+
+
+class Test_note_parser(unittest.TestCase):
+    def text_int_passthru(self):
+        self.assertEqual(note_parser(0), 0)
+        self.assertEqual(note_parser(70), 70)
+        self.assertEqual(note_parser(127), 127)
+
+        # it does not range check so these should pass
+        self.assertEqual(note_parser(-303), -303)
+        self.assertEqual(note_parser(808), 808)
+
+    def test_good_text(self):
+        note_prefix = { "Cb": 11,
+                        "C" : 12,
+                        "C#": 13,
+                        "Db": 13,
+                        "D" : 14,
+                        "D#": 15,
+                        "Eb": 15,
+                        "E" : 16,
+                        "Fb": 16,
+                        "E#": 17,
+                        "F" : 17,
+                        "F#": 18,
+                        "Gb": 18,
+                        "G" : 19,
+                        "G#": 20,
+                        "Ab": 20,
+                        "A" : 21,
+                        "A#": 22,
+                        "Bb": 22,
+                        "B" : 23,
+                        "B#": 24,
+                      }
+
+        # test from Cb0 to B#8
+        for prefix, base_value in note_prefix.items():
+            for octave in range(9):
+                note = prefix + str(octave)
+                expected_value = base_value + octave * 12  # 12 semitones in octave 
+                self.assertEqual(note_parser(note), expected_value) 
+
+        # re-test with simple C4/A4 tests to catch any bugs in above
+        self.assertEqual(note_parser("C4"), 60)
+        self.assertEqual(note_parser("A4"), 69)
+
+    def test_bad_text(self):
+
+        for text_note in ["H", "H4", "asdfasdfasdf", "000", "999"]:
+            with self.assertRaises(ValueError):
+                note_parser(text_note)
+
+
+if __name__ == '__main__':
+    unittest.main(verbosity=verbose)