Maintainership converter command line tool

Author: ncounter

osc/commands_git/maintainership_converter.py

@@ -0,0 +1,26 @@
+import osc.commandline_git
+
+
+class MaintainershipCommand(osc.commandline_git.GitObsCommand):
+    """
+    Read _maintainership.json and convert it from legacy format to the current format
+    """
+
+    name = "maintainership-converter"
+
+    def init_arguments(self):
+        self.add_argument(
+            "path",
+            nargs="?",
+            default="_maintainership.json",
+            help="Path to the _maintainership.json file (default: %(default)s)",
+        )
+
+    def run(self, args):
+        from osc.gitea_api import maintainership
+
+        with open(args.path, "r", encoding="utf-8") as f:
+            data = f.read()
+
+        obj = maintainership.Maintainership.from_string(data)
+        print(obj.to_string())

tests/test_maintainership_converter.py

@@ -0,0 +1,136 @@
+import json
+import os
+import sys
+import io
+import tempfile
+import unittest
+
+
+class TestMaintainershipConverter(unittest.TestCase):
+    def setUp(self):
+        self.tmpdir = tempfile.mkdtemp(prefix="osc_test_maintainership_converter_")
+        self.orig_stdout = sys.stdout
+        sys.stdout = io.StringIO()
+
+    def tearDown(self):
+        sys.stdout = self.orig_stdout
+        import shutil
+
+        shutil.rmtree(self.tmpdir, ignore_errors=True)
+
+    def _write_file(self, data):
+        path = os.path.join(self.tmpdir, "_maintainership.json")
+        with open(path, "w", encoding="utf-8") as f:
+            json.dump(data, f)
+        return path
+
+    def _run_converter(self, path):
+        from osc.commands_git.maintainership_converter import MaintainershipCommand
+
+        cmd = MaintainershipCommand.__new__(MaintainershipCommand)
+
+        args = type("Args", (), {"path": path})()
+        cmd.run(args)
+        return sys.stdout.getvalue()
+
+    def test_legacy_format_converted(self):
+        """Legacy format is converted to v1.0 format."""
+        legacy_data = {
+            "": ["project-maintainer", "@project-group"],
+            "package1": ["alice", "@pkg1-group"],
+            "package2": ["bob"],
+        }
+        path = self._write_file(legacy_data)
+        output = self._run_converter(path)
+        result = json.loads(output)
+
+        self.assertEqual(result["header"]["document"], "obs-maintainers")
+        self.assertEqual(result["header"]["version"], "1.0")
+
+        self.assertEqual(result["project"]["users"], ["project-maintainer"])
+        self.assertEqual(result["project"]["groups"], ["project-group"])
+
+        self.assertEqual(result["packages"]["package1"]["users"], ["alice"])
+        self.assertEqual(result["packages"]["package1"]["groups"], ["pkg1-group"])
+
+        self.assertEqual(result["packages"]["package2"]["users"], ["bob"])
+        self.assertIsNone(result["packages"]["package2"]["groups"])
+
+    def test_v1_format_passthrough(self):
+        """v1.0 format is printed unchanged."""
+        v1_data = {
+            "header": {
+                "document": "obs-maintainers",
+                "version": "1.0",
+            },
+            "project": {
+                "users": ["alice"],
+                "groups": None,
+            },
+            "packages": {
+                "pkg1": {
+                    "users": ["bob"],
+                    "groups": ["team"],
+                },
+                "pkg2": {
+                    "users": None,
+                    "groups": ["team"],
+                },
+            },
+        }
+        path = self._write_file(v1_data)
+        output = self._run_converter(path)
+        result = json.loads(output)
+
+        self.assertEqual(result["header"]["document"], "obs-maintainers")
+        self.assertEqual(result["header"]["version"], "1.0")
+        self.assertEqual(result["project"]["users"], ["alice"])
+        self.assertEqual(result["packages"]["pkg1"]["users"], ["bob"])
+        self.assertEqual(result["packages"]["pkg1"]["groups"], ["team"])
+
+    def test_legacy_empty_project_maintainers(self):
+        """Legacy format with no project-level maintainers."""
+        legacy_data = {
+            "package1": ["alice"],
+        }
+        path = self._write_file(legacy_data)
+        output = self._run_converter(path)
+        result = json.loads(output)
+
+        self.assertEqual(result["header"]["document"], "obs-maintainers")
+        self.assertIsNone(result["project"]["users"])
+        self.assertIsNone(result["project"]["groups"])
+        self.assertEqual(result["packages"]["package1"]["users"], ["alice"])
+
+    def test_legacy_groups_only(self):
+        """Legacy format with only groups, no users."""
+        legacy_data = {
+            "": ["@admins", "@maintainers"],
+            "pkg": ["@team"],
+        }
+        path = self._write_file(legacy_data)
+        output = self._run_converter(path)
+        result = json.loads(output)
+
+        self.assertIsNone(result["project"]["users"])
+        self.assertEqual(result["project"]["groups"], ["admins", "maintainers"])
+        self.assertIsNone(result["packages"]["pkg"]["users"])
+        self.assertEqual(result["packages"]["pkg"]["groups"], ["team"])
+
+    def test_file_not_found(self):
+        """Non-existent file raises an error."""
+        path = os.path.join(self.tmpdir, "nonexistent.json")
+        with self.assertRaises(FileNotFoundError):
+            self._run_converter(path)
+
+    def test_invalid_json(self):
+        """Invalid JSON raises an error."""
+        path = os.path.join(self.tmpdir, "_maintainership.json")
+        with open(path, "w") as f:
+            f.write("not valid json")
+        with self.assertRaises(json.JSONDecodeError):
+            self._run_converter(path)
+
+
+if __name__ == "__main__":
+    unittest.main()