From b469dc72609efc17256cc0406cc1415b5040ad78 Mon Sep 17 00:00:00 2001
From: Doug Hellmann <doug@doughellmann.com>
Date: Wed, 16 May 2018 14:25:28 -0400
Subject: [PATCH] add a --strict flag to the template generator

When --strict is passed warnings are treated as errors to stop the
build. This is useful for debugging when running tools/test.sh
locally, for example.

Change-Id: I1747f0e554d76ed85d8e00cf850f3413eef1949b
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
---
 tools/www-generator.py | 32 +++++++++++++++++++++++---------
 1 file changed, 23 insertions(+), 9 deletions(-)

diff --git a/tools/www-generator.py b/tools/www-generator.py
index 84a7f1dc33..87164bda04 100755
--- a/tools/www-generator.py
+++ b/tools/www-generator.py
@@ -135,6 +135,11 @@ def parse_command_line_arguments():
                         action='store_true',
                         help='only test links, do not render templates',
                         )
+    parser.add_argument('--strict',
+                        default=False,
+                        action='store_true',
+                        help='treat warnings as errors',
+                        )
     return parser.parse_args()
 
 
@@ -186,7 +191,8 @@ def load_project_data(source_directory,
                       check_all_links=False,
                       skip_links=False,
                       series_to_load=None,
-                      governed_deliverables=[]):
+                      governed_deliverables=[],
+                      strict=False):
     "Return a dict with project data grouped by series."
     logger = logging.getLogger()
     series_to_load = series_to_load or []
@@ -228,10 +234,16 @@ def load_project_data(source_directory,
 
             if (series == 'latest' and
                     deliverable_name not in governed_deliverables):
-                logger.warning(
-                    ('%s is no longer part of an official project, '
-                     'ignoring in %s'),
-                    deliverable_name, filename)
+                msg = ('{} is no longer part of an official project, '
+                       '{} in {}').format(
+                           deliverable_name,
+                           'error' if strict else 'ignoring',
+                           filename)
+                logger.warning(msg)
+                if strict:
+                    logger.info('Known deliverables: %s',
+                                sorted(governed_deliverables))
+                    raise RuntimeError(msg)
                 continue
             logger.info('including %s', deliverable_name)
             data.append(project)
@@ -316,10 +328,11 @@ def load_project_data(source_directory,
                     )
                     fail = True
                 elif (not flag_val) and check_all_links and exists:
-                    logger.warning(
-                        '%s not set for %s but %s does exist',
-                        flag, project_name, url,
-                    )
+                    msg = '{} not set for {} but {} does exist'.format(
+                        flag, project_name, url)
+                    logger.warning(msg)
+                    if strict:
+                        raise RuntimeError(msg)
 
         if fail:
             raise ValueError('invalid input in %s' % filename)
@@ -469,6 +482,7 @@ def main():
         skip_links=args.skip_links,
         series_to_load=args.series,
         governed_deliverables=deliverables,
+        strict=args.strict,
     )
 
     # Set up jinja to discover the templates.