Add unit test coverage to CI script (sandflow#131)

Closes sandflow#64
* Add unit test coverage to CI script (sandflow#64)
* Code coverage greater than 80% across all files (sandflow#64)

Co-authored-by: Valentin NOEL <valentin.noel@media-io.com>
Co-authored-by: Bob Brown <bob@bigleafdesigns.com>

Author: 3 people

.coveragerc

@@ -1,5 +1,6 @@
 [run]
 data_file = build/.coverage
+source_pkgs = ttconv
 
 [html]
 directory = build/htmlcov

scripts/ci.sh

@@ -4,7 +4,7 @@
 
 pipenv run python -m pylint src/main/python/ttconv/ src/test/python/
 
-## Unit tests
-
-pipenv run python -m unittest discover -v -s src/test/python/ -t .
+## unit test and coverage
 
+pipenv run coverage run -m unittest discover -v -s src/test/python/ -t .
+pipenv run coverage report | awk '!/-|(Name)/ {if (int($NF) < 80) {print $1 " has less than 80% coverage"; flag=2;}}; END { if (flag) exit(flag)}'

scripts/coverage.sh

@@ -55,7 +55,7 @@ def local_name(cls):
     raise NotImplementedError
 
   @classmethod
-  def has_px(cls, attrib_value: typing.Any) -> bool:
+  def has_px(cls, _attrib_value: typing.Any) -> bool:
     return False
 
   @classmethod

src/main/python/ttconv/imsc/style_properties.py

@@ -26,10 +26,10 @@
 '''IMSC writer'''
 
 import logging
+import xml.etree.ElementTree as et
 import ttconv.imsc.elements as imsc_elements
 import ttconv.imsc.namespaces as xml_ns
 import ttconv.model as model
-import xml.etree.ElementTree as et
 
 LOGGER = logging.getLogger(__name__)
 

src/main/python/ttconv/imsc/writer.py

@@ -24,9 +24,11 @@
 # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 """SCC disassembly functions"""
+import logging
 
 from ttconv.style_properties import ColorType, NamedColors, FontStyleType, TextDecorationType
 
+LOGGER = logging.getLogger(__name__)
 
 def get_color_disassembly(color: ColorType) -> str:
   """Get color disassembly code"""
@@ -35,28 +37,34 @@ def get_color_disassembly(color: ColorType) -> str:
   if color is None:
     return disassembly
 
-  if color is NamedColors.white.value:
+  rgb_color = color.components[:-1]
+  if rgb_color == NamedColors.white.value.components[:-1]:
     disassembly = "Wh"
-  elif color is NamedColors.green.value:
+  elif rgb_color == NamedColors.green.value.components[:-1]:
     disassembly = "Gr"
-  elif color is NamedColors.blue.value:
+  elif rgb_color == NamedColors.blue.value.components[:-1]:
     disassembly = "Bl"
-  elif color is NamedColors.cyan.value:
+  elif rgb_color == NamedColors.cyan.value.components[:-1]:
     disassembly = "Cy"
-  elif color is NamedColors.red.value:
+  elif rgb_color == NamedColors.red.value.components[:-1]:
     disassembly = "R"
-  elif color is NamedColors.yellow.value:
+  elif rgb_color == NamedColors.yellow.value.components[:-1]:
     disassembly = "Y"
-  elif color is NamedColors.magenta.value:
+  elif rgb_color == NamedColors.magenta.value.components[:-1]:
     disassembly = "Ma"
-  elif color is NamedColors.black.value:
+  elif rgb_color == NamedColors.black.value.components[:-1]:
     disassembly = "Bk"
-  elif color is NamedColors.transparent.value:
-    disassembly = "T"
 
   # Alpha channel
-  if color.components[3] == 0x88:
+  if color.components[3] == 0:
+    disassembly = "T"
+  elif color.components[3] == 0x88:
     disassembly += "S"
+  elif color.components[3] != 0xFF:
+    LOGGER.warning("Skip unsupported %s alpha level in disassembly format.", color.components[3])
+
+  if not disassembly:
+    LOGGER.warning("Unsupported '%s' color in disassembly format.", color.components)
 
   return disassembly
 

src/main/python/ttconv/scc/disassembly.py

@@ -35,9 +35,27 @@
 import ttconv.model as model
 import ttconv.style_properties as styles
 import ttconv.imsc.reader as imsc_reader
+import ttconv.imsc.namespaces as xml_ns
 
 class IMSCReaderTest(unittest.TestCase):
 
+  def test_reader_tt_element_not_root_element(self):
+
+    xml_str = """<?xml version="1.0" encoding="UTF-8"?>
+      <not_tt xml:lang="en"
+          xmlns="http://www.w3.org/ns/ttml"
+          xmlns:ttm="http://www.w3.org/ns/ttml#metadata" 
+          xmlns:tts="http://www.w3.org/ns/ttml#styling"
+          xmlns:ttp="http://www.w3.org/ns/ttml#parameter" 
+          xmlns:ittp="http://www.w3.org/ns/ttml/profile/imsc1#parameter"
+          ittp:activeArea="50% 50% 80% 80%"
+          tts:extent="640px 480px"
+          ttp:profile="http://www.w3.org/ns/ttml/profile/imsc1/text">
+      </not_tt>"""
+
+    tt_not_root = et.ElementTree(et.fromstring(xml_str))
+    self.assertIsNone(imsc_reader.to_model(tt_not_root))
+
   def test_body_only(self):
     tree = et.parse('src/test/resources/ttml/body_only.ttml')
     imsc_reader.to_model(tree)

src/test/python/test_imsc_reader.py

@@ -29,13 +29,54 @@
 
 import unittest
 
-from ttconv.scc.disassembly import get_text_decoration_disassembly
+from ttconv.scc.disassembly import get_color_disassembly, get_font_style_disassembly, get_text_decoration_disassembly
 from ttconv.scc.reader import to_disassembly
-from ttconv.style_properties import TextDecorationType
+from ttconv.style_properties import NamedColors, ColorType, FontStyleType, TextDecorationType
 
 
 class SccReaderTest(unittest.TestCase):
 
+  def test_scc_disassembly_color(self):
+    disassembly_colors = {
+      NamedColors.white: "Wh",
+      NamedColors.green: "Gr",
+      NamedColors.blue: "Bl",
+      NamedColors.cyan: "Cy",
+      NamedColors.aqua: "Cy",
+      NamedColors.red: "R",
+      NamedColors.yellow: "Y",
+      NamedColors.magenta: "Ma",
+      NamedColors.fuchsia: "Ma",
+      NamedColors.black: "Bk",
+      NamedColors.transparent: "T",
+      NamedColors.silver: "",
+      NamedColors.gray: "",
+      NamedColors.maroon: "",
+      NamedColors.purple: "",
+      NamedColors.lime: "",
+      NamedColors.olive: "",
+      NamedColors.navy: "",
+      NamedColors.teal: ""
+    }
+
+    for (color, code) in disassembly_colors.items():
+      self.assertEqual(code, get_color_disassembly(color.value))
+
+    self.assertEqual("BlS", get_color_disassembly(ColorType((0, 0, 255, 136))))
+    self.assertEqual("Bl", get_color_disassembly(ColorType((0, 0, 255, 128))))
+    self.assertEqual("Bl", get_color_disassembly(ColorType((0, 0, 255, 145))))
+    self.assertEqual("T", get_color_disassembly(ColorType((0, 0, 255, 0))))
+
+  def test_scc_disassembly_font_style(self):
+    disassembly_font_style = {
+      FontStyleType.normal: "",
+      FontStyleType.oblique: "",
+      FontStyleType.italic: "I",
+    }
+
+    for (font_style, code) in disassembly_font_style.items():
+      self.assertEqual(code, get_font_style_disassembly(font_style))
+
   def test_scc_disassembly_text_decoration(self):
     disassembly_text_decoration = {
       TextDecorationType(underline=True): "U",