metadata: break out write_yaml to standalone function and add unit tests

fdroidserver/metadata.py

@@ -1044,17 +1044,7 @@ def _del_duplicated_NoSourceSince(app):
             del app['AntiFeatures'][key]
 
 
-def write_yaml(mf, app):
+def _field_to_yaml(typ, value):
-    """Write metadata in yaml format.
-
-    Parameters
-    ----------
-    mf
-      active file discriptor for writing
-    app
-      app metadata to written to the yaml file
-    """
-    def _field_to_yaml(typ, value):
     """Convert data to YAML 1.2 format that keeps the right TYPE_*."""
     if typ == TYPE_STRING:
         return str(value)
@@ -1074,7 +1064,35 @@ def write_yaml(mf, app):
     else:
         return value
 
-    def _app_to_yaml(app):
+
+def _builds_to_yaml(app):
+    builds = ruamel.yaml.comments.CommentedSeq()
+    for build in app.get('Builds', []):
+        if not isinstance(build, Build):
+            build = Build(build)
+        b = ruamel.yaml.comments.CommentedMap()
+        for field in build_flags:
+            if hasattr(build, field):
+                value = getattr(build, field)
+                if field == 'gradle' and value == ['off']:
+                    value = [
+                        ruamel.yaml.scalarstring.SingleQuotedScalarString('off')
+                    ]
+                typ = flagtype(field)
+                # don't check value == True for TYPE_INT as it could be 0
+                if value is not None and (typ == TYPE_INT or value):
+                    b.update({field: _field_to_yaml(typ, value)})
+        builds.append(b)
+
+    # insert extra empty lines between build entries
+    for i in range(1, len(builds)):
+        builds.yaml_set_comment_before_after_key(i, 'bogus')
+        builds.ca.items[i][1][-1].value = '\n'
+
+    return builds
+
+
+def _app_to_yaml(app):
     cm = ruamel.yaml.comments.CommentedMap()
     insert_newline = False
     for field in yaml_app_field_order:
@@ -1108,32 +1126,18 @@ def write_yaml(mf, app):
                     cm.ca.items[field][1][-1].value = '\n'
     return cm
 
-    def _builds_to_yaml(app):
-        builds = ruamel.yaml.comments.CommentedSeq()
-        for build in app.get('Builds', []):
-            if not isinstance(build, Build):
-                build = Build(build)
-            b = ruamel.yaml.comments.CommentedMap()
-            for field in build_flags:
-                if hasattr(build, field):
-                    value = getattr(build, field)
-                    if field == 'gradle' and value == ['off']:
-                        value = [
-                            ruamel.yaml.scalarstring.SingleQuotedScalarString('off')
-                        ]
-                    typ = flagtype(field)
-                    # don't check value == True for TYPE_INT as it could be 0
-                    if value is not None and (typ == TYPE_INT or value):
-                        b.update({field: _field_to_yaml(typ, value)})
-            builds.append(b)
 
-        # insert extra empty lines between build entries
+def write_yaml(mf, app):
-        for i in range(1, len(builds)):
+    """Write metadata in yaml format.
-            builds.yaml_set_comment_before_after_key(i, 'bogus')
-            builds.ca.items[i][1][-1].value = '\n'
 
-        return builds
+    Parameters
+    ----------
+    mf
+      active file discriptor for writing
+    app
+      app metadata to written to the yaml file
 
+    """
     _del_duplicated_NoSourceSince(app)
     yaml_app = _app_to_yaml(app)
     yaml = ruamel.yaml.YAML()

tests/metadata.TestCase

@@ -1684,6 +1684,49 @@ class MetadataTest(unittest.TestCase):
             ),
         )
 
+    def test_app_to_yaml_smokecheck(self):
+        self.assertTrue(
+            isinstance(metadata._app_to_yaml(dict()), ruamel.yaml.comments.CommentedMap)
+        )
+
+    def test_app_to_yaml_build_list_empty(self):
+        app = metadata.App({'Builds': [metadata.Build({'rm': []})]})
+        self.assertEqual(dict(), metadata._app_to_yaml(app)['Builds'][0])
+
+    def test_app_to_yaml_build_list_string(self):
+        app = metadata.App({'Builds': [metadata.Build({'rm': 'one'})]})
+        self.assertEqual({'rm': 'one'}, metadata._app_to_yaml(app)['Builds'][0])
+
+    def test_app_to_yaml_build_list_one(self):
+        app = metadata.App({'Builds': [metadata.Build({'rm': ['one']})]})
+        self.assertEqual({'rm': ['one']}, metadata._app_to_yaml(app)['Builds'][0])
+
+    def test_app_to_yaml_build_list(self):
+        app = metadata.App({'Builds': [metadata.Build({'rm': ['b2', 'NO1']})]})
+        self.assertEqual({'rm': ['b2', 'NO1']}, metadata._app_to_yaml(app)['Builds'][0])
+
+    def test_app_to_yaml_AllowedAPKSigningKeys_two(self):
+        cm = metadata._app_to_yaml(metadata.App({'AllowedAPKSigningKeys': ['b', 'A']}))
+        self.assertEqual(['b', 'a'], cm['AllowedAPKSigningKeys'])
+
+    def test_app_to_yaml_AllowedAPKSigningKeys_one(self):
+        cm = metadata._app_to_yaml(metadata.App({'AllowedAPKSigningKeys': ['One']}))
+        self.assertEqual('one', cm['AllowedAPKSigningKeys'])
+
+    def test_app_to_yaml_int_hex(self):
+        cm = metadata._app_to_yaml(metadata.App({'CurrentVersionCode': 0xFF}))
+        self.assertEqual(255, cm['CurrentVersionCode'])
+
+    def test_app_to_yaml_int_underscore(self):
+        cm = metadata._app_to_yaml(metadata.App({'CurrentVersionCode': 1_2_3}))
+        self.assertEqual(123, cm['CurrentVersionCode'])
+
+    def test_app_to_yaml_int_0(self):
+        """Document that 0 values fail to make it through."""
+        # TODO it should be possible to use `CurrentVersionCode: 0`
+        cm = metadata._app_to_yaml(metadata.App({'CurrentVersionCode': 0}))
+        self.assertFalse('CurrentVersionCode' in cm)
+
 
 class PostMetadataParseTest(unittest.TestCase):
     """Test the functions that post process the YAML input.