tools: add formatting for releases.json

Have sanity_checks.py check that releases.json is formatted, and have
format.py format it.

Remove the sorted keys check since the format check subsumes it.

We could also format ci_config.json, but sorting keys alphabetically
would break some semantically meaningful groupings, so skip for now.

Author: bgilbert

tools/format.py

@@ -37,6 +37,7 @@ def main() -> None:
                 files += [f for f in patch_dir.rglob('*') if f.name in FORMAT_FILES]
 
     format_meson(files)
+    Releases.format()
 
 
 if __name__ == '__main__':

tools/sanity_checks.py

@@ -211,13 +211,15 @@ def test_releases_json(self):
             self.assertIn(name, self.releases)
             self.assertIn(version, self.releases[name]['versions'], f'for {name}')
 
-        # Verify keys are sorted
-        self.assertEqual(sorted(self.releases.keys()), list(self.releases.keys()))
-
         for name, info in self.releases.items():
             for k in info.keys():
                 self.assertIn(k, PERMITTED_KEYS)
 
+        try:
+            Releases.format(check=True)
+        except FormattingError:
+            self.fail('releases.json is not formatted.  Run tools/format.py to format it.')
+
     def get_patch_path(self, wrap_section):
         patch_directory = wrap_section.get('patch_directory')
         if patch_directory:

tools/utils.py

@@ -126,6 +126,16 @@ def save(self) -> None:
             f.write(self.encode())
         os.rename(f'{self.FILENAME}.new', self.FILENAME)
 
+    @classmethod
+    def format(cls, *, check: bool = False) -> None:
+        contents = Path(cls.FILENAME).read_text(encoding='utf-8')
+        parsed = cls.load()
+        if contents != parsed.encode():
+            if check:
+                raise FormattingError
+            else:
+                parsed.save()
+
 class ProjectReleases(T.TypedDict):
     dependency_names: T.NotRequired[list[str]]
     program_names: T.NotRequired[list[str]]