Documentation update and make the golden image error message point to… (

#24490) * Documentation update and make the golden image error message point to docs and command to run * Restyle * Undo file change that was made to test the error reporting * Fix typo s/regenerata/regenerate
project-chip · Apr 21, 2023 · 9916772 · 9916772
1 parent c5a4967
commit 9916772
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/docs/code_generation.md b/docs/code_generation.md
@@ -286,3 +286,10 @@ replacement during running of `ninja check`.
 ```shell
 ZAP_GENERATE_GOLDEN_REGENERATE=1 ninja check
 ```
+
+Alternatively, the golden image can also be re-generated by running the
+stand-alone test in a bootstrapped environment:
+
+```shell
+./scripts/tools/zap/test_generate.py --output out/gen --regenerate
+```
diff --git a/scripts/tools/zap/test_generate.py b/scripts/tools/zap/test_generate.py
@@ -122,6 +122,12 @@ def run_test_cases(self, checker: unittest.TestCase):
                                 f"Copying updated golden image from {actual} to {expected}")
                             subprocess.check_call(["cp", actual, expected])
                         else:
+                            print("*"*80)
+                            print("* Golden image regeneration seems to have failed.")
+                            print("* Documentation regarding code-generation logic available at docs/code_generation.md")
+                            print("*\n* Specifically to update golden images, you may want to run:")
+                            print("*\n* ./scripts/tools/zap/test_generate.py --output out/gen --regenerate")
+                            print("*\n" + "*"*80)
                             raise