leapp-data/rebuild_ids.py at cloudlinux · cloudlinux/leapp-data · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
"""
This script is used to rebuild the IDs in PES JSON files. It loads JSON files from specified directories,
reassigns the IDs starting from 1, and saves the modified JSON files back to disk.

The script defines a `JSONFile` dataclass to represent a JSON file with its path and data.
It also defines a `PesIdRebuilder` class that handles the loading, rebuilding, and saving of JSON files.

Why do we need to rebuild the IDs?
- The IDs in the JSON files are used to identify the PES events and packages.
- When Leapp encounters an error with a specific PES event, it logs the event ID.
- To make sure that the event IDs are consistent and identifiable,
we need to rebuild them across all JSON files that will be used by Leapp.

Usage:
- Modify the `directory_list` variable in the `main` function to specify the directories containing the JSON files.
- Run the script to rebuild the IDs and save the modified JSON files.

Note: This script assumes that the PES front file is the first JSON file in the directory list.
"""

import json
import os
from dataclasses import dataclass

@dataclass
class JSONFile:
    path: str
    data: dict


def load_json(file_path: str):
    """Load JSON data from a file."""
    with open(file_path, "r", encoding="utf-8") as file:
        data = json.load(file)
    # The JSON data is a dictionary with a key 'packageinfo'
    # PES events data is stored there
    return data

def save_json(jsonfile: JSONFile):
    """Save JSON data to a file."""
    with open(jsonfile.path, "w", encoding="utf-8") as file:
        json.dump(jsonfile.data, file, indent=4)


class PesIdRebuilder():
    def __init__(self):
        self.json_files = []

        self.event_id = 0
        self.set_id = 0

    def load_json_files(self, directory_list: list):
        # The PES front file should be the first one in the list
        pes_front = None

        for directory_path in directory_list:
            for filename in os.listdir(directory_path):
                if "pes" in filename:
                    file_path = os.path.join(directory_path, filename)
                    data = load_json(file_path)
                    new_json_file = JSONFile(file_path, data)
                    if "pes-events.json" in file_path:
                        pes_front = new_json_file
                    else:
                        self.json_files.append(new_json_file)

        self.json_files.insert(0, pes_front)

    def save_json_files(self):
        for jsonfile in self.json_files:
            save_json(jsonfile)

    def rebuild_ids(self):
        # Go over the "id" field and reassign the values, starting from 1
        for jsonfile in self.json_files:
            self.rebuild_ids_in_file(jsonfile.data)

    def rebuild_ids_in_file(self, file_data):
        for _, item in enumerate(file_data["packageinfo"]):
            item["id"] = self.event_id + 1
            self.event_id += 1

            if "in_packageset" in item:
                in_packageset = item["in_packageset"]
                if "package" in in_packageset and in_packageset["package"]:
                    in_packageset["set_id"] = self.set_id
                    self.set_id += 1
                else:
                    in_packageset["set_id"] = 0
            if "out_packageset" in item:
                out_packageset = item["out_packageset"]
                if out_packageset is None:
                    continue
                if "package" in out_packageset and out_packageset["package"]:
                    out_packageset["set_id"] = self.set_id
                    self.set_id += 1
                else:
                    out_packageset["set_id"] = 0

def main():
    rebuilder = PesIdRebuilder()

    # By default, process the CloudLinux-related PES files.
    os_directory_path = os.path.join(os.path.dirname(__file__), "files/cloudlinux")
    os_vendors_directory_path = os.path.join(os.path.dirname(__file__), "files/cloudlinux/vendors.d")
    common_vendors_directory_path = os.path.join(os.path.dirname(__file__), "vendors.d")
    directory_list = [os_directory_path, os_vendors_directory_path, common_vendors_directory_path]

    rebuilder.load_json_files(directory_list)
    rebuilder.rebuild_ids()
    rebuilder.save_json_files()


if __name__ == "__main__":
    main()