[dif] Add overwrite safety check to `util/make_new_dif.py`
If `util/make_new_dif.py` is run initially to auto-generate a DIF header
and checklist boilerplate code/markdown (respectively), and accidentally
run again shortly after manualy modifying the boilerplate code (before
the modifications are checked-in to the repo), the modifications would
be overwritten. This commit adds a check to prevent such a mistake from
happening, partially addressing an action item in #8142.
Signed-off-by: Timothy Trippel <ttrippel@google.com>
diff --git a/util/make_new_dif.py b/util/make_new_dif.py
index 73020d9..5e0bf9c 100755
--- a/util/make_new_dif.py
+++ b/util/make_new_dif.py
@@ -215,8 +215,12 @@
if "header" in args.only:
header_template_file = (REPO_TOP /
"util/make_new_dif/dif_template.h.tpl")
- header_template = Template(header_template_file.read_text())
header_out_file = dif_dir / "dif_{}.h".format(ip.name_snake)
+ if header_out_file.is_file():
+ raise FileExistsError(
+ """DIF header already exists for the IP. To overwrite, """
+ """delete existing header and try again.""")
+ header_template = Template(header_template_file.read_text())
header_out_file.write_text(header_template.render(ip=ip))
print("DIF header successfully written to {}.".format(
str(header_out_file)))
@@ -253,8 +257,12 @@
if "checklist" in args.only:
checklist_template_file = REPO_TOP / "doc/project/sw_checklist.md.tpl"
- markdown_template = Template(checklist_template_file.read_text())
checklist_out_file = dif_dir / "dif_{}.md".format(ip.name_snake)
+ if checklist_out_file.is_file():
+ raise FileExistsError(
+ """DIF checklist already exists for the IP. To """
+ """overwrite, delete existing checklist and try again.""")
+ markdown_template = Template(checklist_template_file.read_text())
checklist_out_file.write_text(markdown_template.render(ip=ip))
print("DIF Checklist successfully written to {}.".format(
str(checklist_out_file)))
