flipperzero-firmware/scripts/flipper/assets/manifest.py
hedger 76d38e832e
fbt: reproducible manifest builds & improvements (#1801)
* fbt: reproducible manifest builds, less rebuild on small updates; scripts: assets: using timestamp from commandline af available
* fbt: added app import validation for launch_app & single app build targets
* fbt: COMSTR for app imports validation
* docs: minor fixes
* docs: markdown fix
* vscode: comments for RTOS startup

Co-authored-by: あく <alleteam@gmail.com>
2022-09-29 20:00:22 +09:00

177 lines
4.9 KiB
Python

import datetime
import logging
import os
import posixpath
from pathlib import Path
from flipper.utils import *
from flipper.utils.fstree import *
MANIFEST_VERSION = 0
class ManifestRecord:
tag = None
@staticmethod
def fromLine(line):
raise NotImplementedError
def toLine(self):
raise NotImplementedError
def _unpack(self, manifest, key, nodetype):
key, value = manifest.readline().split(":", 1)
assert key == key
return nodetype(value)
MANIFEST_TAGS_RECORDS = {}
def addManifestRecord(record: ManifestRecord):
assert record.tag
MANIFEST_TAGS_RECORDS[record.tag] = record
class ManifestRecordVersion(ManifestRecord):
tag = "V"
def __init__(self, version):
self.version = version
@staticmethod
def fromLine(line):
return ManifestRecordVersion(int(line))
def toLine(self):
return f"{self.tag}:{self.version}\n"
addManifestRecord(ManifestRecordVersion)
class ManifestRecordTimestamp(ManifestRecord):
tag = "T"
def __init__(self, timestamp: int):
self.timestamp = int(timestamp)
@staticmethod
def fromLine(line):
return ManifestRecordTimestamp(int(line))
def toLine(self):
return f"{self.tag}:{self.timestamp}\n"
addManifestRecord(ManifestRecordTimestamp)
class ManifestRecordDirectory(ManifestRecord):
tag = "D"
def __init__(self, path: str):
self.path = path
@staticmethod
def fromLine(line):
return ManifestRecordDirectory(line)
def toLine(self):
return f"{self.tag}:{self.path}\n"
addManifestRecord(ManifestRecordDirectory)
class ManifestRecordFile(ManifestRecord):
tag = "F"
def __init__(self, path: str, md5: str, size: int):
self.path = path
self.md5 = md5
self.size = size
@staticmethod
def fromLine(line):
data = line.split(":", 3)
return ManifestRecordFile(data[2], data[0], int(data[1]))
def toLine(self):
return f"{self.tag}:{self.md5}:{self.size}:{self.path}\n"
addManifestRecord(ManifestRecordFile)
class Manifest:
def __init__(self, timestamp_value=None):
self.version = None
self.records = []
self.records.append(ManifestRecordVersion(MANIFEST_VERSION))
self.records.append(ManifestRecordTimestamp(timestamp_value or timestamp()))
self.logger = logging.getLogger(self.__class__.__name__)
def load(self, filename):
with open(filename, "r") as manifest:
for line in manifest.readlines():
line = line.strip()
if len(line) == 0:
continue
tag, line = line.split(":", 1)
record = MANIFEST_TAGS_RECORDS[tag].fromLine(line)
self.records.append(record)
def save(self, filename):
with open(filename, "w+", newline="\n") as manifest:
for record in self.records:
manifest.write(record.toLine())
def addDirectory(self, path):
self.records.append(ManifestRecordDirectory(path))
def addFile(self, path, md5, size):
self.records.append(ManifestRecordFile(path, md5, size))
def create(self, directory_path, ignore_files=["Manifest"]):
for root, dirs, files in os.walk(directory_path):
dirs.sort()
files.sort()
relative_root = root.replace(directory_path, "", 1)
if relative_root:
relative_root = Path(relative_root).as_posix()
if relative_root.startswith("/"):
relative_root = relative_root[1:]
# process directories
for dirname in dirs:
relative_dir_path = posixpath.join(relative_root, dirname)
self.logger.debug(f'Adding directory: "{relative_dir_path}"')
self.addDirectory(relative_dir_path)
# Process files
for file in files:
relative_file_path = posixpath.join(relative_root, file)
if file in ignore_files:
self.logger.info(f'Skipping file "{relative_file_path}"')
continue
full_file_path = posixpath.join(root, file)
self.logger.debug(f'Adding file: "{relative_file_path}"')
self.addFile(
relative_file_path,
file_md5(full_file_path),
os.path.getsize(full_file_path),
)
def toFsTree(self):
root = FsNode("", FsNode.NodeType.Directory)
for record in self.records:
if isinstance(record, ManifestRecordDirectory):
root.addDirectory(record.path)
elif isinstance(record, ManifestRecordFile):
root.addFile(record.path, record.md5, record.size)
return root
@staticmethod
def compare(left: "Manifest", right: "Manifest"):
return compare_fs_trees(left.toFsTree(), right.toFsTree())