solidity/scripts/update_bugs_by_version.py

#!/usr/bin/env python3
#
# This script is used to generate the list of bugs per compiler version
# from the list of bugs.
# It updates the list in place and signals failure if there were changes.
# This makes it possible to use this script as part of CI to check
# that the list is up to date.

import os
import json
import re
import sys

def comp(version_string):
    return [int(c) for c in version_string.split('.')]

path = os.path.dirname(os.path.realpath(__file__))
with open(path + '/../docs/bugs.json', encoding='utf8') as bugsFile:
    bugs = json.load(bugsFile)

versions = {}
with open(path + '/../Changelog.md', encoding='utf8') as changelog:
    for line in changelog:
        m = re.search(r'^### (\S+) \((\d+-\d+-\d+)\)$', line)
        if m:
            versions[m.group(1)] = {}
            versions[m.group(1)]['released'] = m.group(2)

for key, value in versions.items():
    value['bugs'] = []
    for bug in bugs:
        if 'introduced' in bug and comp(bug['introduced']) > comp(key):
            continue
        if comp(bug['fixed']) <= comp(key):
            continue
        value['bugs'] += [bug['name']]

new_contents = json.dumps(versions, sort_keys=True, indent=4, separators=(',', ': '))
with open(path + '/../docs/bugs_by_version.json', 'r', encoding='utf8') as bugs_by_version:
    old_contents = bugs_by_version.read()
with open(path + '/../docs/bugs_by_version.json', 'w', encoding='utf8') as bugs_by_version:
    bugs_by_version.write(new_contents)
sys.exit(old_contents != new_contents)