otamaker: Check payload types and files

Verify that the payload type is in the known list.

Warn if a file with a compressed-looking name is provided for anything
other than a tmpfile, as it is almost certainly a mistake.

Signed-off-by: Phil Elwell <phil@raspberrypi.com>

Author: pelwell

otamaker/otamaker

@@ -46,6 +46,14 @@ BLOCK_PAYLOADS = 2
 
 CONTENTS_FILE = '_contents_.yaml'
 
+# Must be kept up to date with new payload types
+KNOWN_PAYLOAD_TYPES = ('image-sparse', 'script', 'tmpfile', 'eeprom-ab')
+
+# The final artefact is already zstd-compressed as a whole, so an
+# individually-compressed payload (e.g. 'boot.sparse.zst' instead of
+# 'boot.sparse') is almost always a mistake.
+COMPRESSED_SUFFIXES = ('.zst', '.gz', '.bz2', '.xz', '.lz4', '.tgz', '.tzst')
+
 def main():
     parser = argparse.ArgumentParser()
     parser.add_argument('contents',
@@ -72,6 +80,7 @@ def main():
     payloads = [CONTENTS_FILE]
     outfile = args.outfile
     errors = 0
+    current_payload = {}
 
     with tempfile.TemporaryDirectory() as tmpdir:
         for raw_line in lines:
@@ -100,9 +109,11 @@ def main():
                 # Normalise list item: '- name: x' -> '  name: x'
                 payload_line = re.sub(r'^\s*-\s*', '  ', line)
                 name_m = re.match(r'^\s+name:\s*(.+)$', payload_line)
+                type_m = re.match(r'^\s+type:\s*(.+)$', payload_line)
                 if name_m:
                     name = name_m.group(1).strip()
                     target = (comment if comment is not None else name).strip()
+                    current_payload = {'name': name, 'target': target}
                     src = os.path.join(cwd, target)
                     dst = os.path.join(tmpdir, name)
                     if not os.path.isfile(src) and not os.path.islink(src) and not os.path.isdir(src):
@@ -120,6 +131,18 @@ def main():
                             else:
                                 print(f'* error: cannot symlink {target}')
                                 errors += 1
+                elif type_m:
+                    ptype = type_m.group(1).strip()
+                    pname = current_payload.get('name', '?')
+                    target = current_payload.get('target', pname)
+                    if ptype not in KNOWN_PAYLOAD_TYPES:
+                        print(f"* error: payload '{pname}' has unknown type '{ptype}' "
+                              f"(expected one of: {', '.join(KNOWN_PAYLOAD_TYPES)})")
+                        errors += 1
+                    if ptype != "tmpfile" and target.endswith(COMPRESSED_SUFFIXES):
+                        print(f"* warning: payload '{pname}' file '{target}' looks pre-compressed; "
+                              f"the artefact is already compressed as a whole, "
+                              f"did you mean '{re.sub(r'(?:'+'|'.join(re.escape(s) for s in COMPRESSED_SUFFIXES)+r')$', '', target)}'?")
 
         if errors:
             sys.exit(1)