hrw4u: add validation for some boolean values (#12553)

When the expected value is a boolean, we should make sure it actually is one of the accepted inputs. Its also generally confusing if they should be quoted or not, so try to give the user some indication that quotes are bad for these values.

Author: mlibbey

tools/hrw4u/src/symbols.py

@@ -73,6 +73,10 @@ def resolve_assignment(self, name: str, value: str, section: SectionType | None
                         if validator:
                             validator(qualifier)
 
+                        # Add boolean value validation for http.cntl assignments.
+                        if op_key == "http.cntl.":
+                            types.SuffixGroup.BOOL_FIELDS.validate(value)
+
                         if isinstance(commands, (list, tuple)):
                             if value == '""':
                                 return f"{commands[0]} {qualifier}"

tools/hrw4u/src/types.py

@@ -99,9 +99,21 @@ class SuffixGroup(Enum):
     def validate(self, suffix: str) -> None:
         allowed_upper = {val.upper() for val in self.value}
         if suffix.upper() not in allowed_upper:
-            raise ValueError(
-                f"Invalid suffix '{suffix}' for group '{self.name}'. "
-                f"Must be one of: {', '.join(sorted(self.value))}")
+            # Special handling for BOOL_FIELDS to detect quoted boolean values
+            if self == SuffixGroup.BOOL_FIELDS:
+                bool_msg = f"Invalid boolean value '{suffix}'. Must be one of: {', '.join(sorted(self.value))}"
+
+                # Check if this is a quoted boolean value
+                is_double_quoted = (suffix.startswith('"') and suffix.endswith('"'))
+                is_single_quoted = (suffix.startswith("'") and suffix.endswith("'"))
+                if ((is_double_quoted or is_single_quoted) and len(suffix) > 2 and suffix[1:-1].upper() in allowed_upper):
+                    raise ValueError(f"{bool_msg} and must not be quoted")
+                else:
+                    raise ValueError(bool_msg)
+            else:
+                raise ValueError(
+                    f"Invalid suffix '{suffix}' for group '{self.name}'. "
+                    f"Must be one of: {', '.join(sorted(self.value))}")
 
 
 class VarType(Enum):

tools/hrw4u/tests/data/ops/http_cntl_invalid_bool.fail.error.txt

@@ -0,0 +1 @@
+Invalid boolean value 'invalid_value'. Must be one of: 0, 1, FALSE, NO, OFF, ON, TRUE, YES

tools/hrw4u/tests/data/ops/http_cntl_invalid_bool.fail.input.txt

@@ -0,0 +1,3 @@
+SEND_RESPONSE {
+    http.cntl.LOGGING = invalid_value;
+}

tools/hrw4u/tests/data/ops/http_cntl_quoted_bool.fail.error.txt

@@ -0,0 +1 @@
+Invalid boolean value '"true"'. Must be one of: 0, 1, FALSE, NO, OFF, ON, TRUE, YES and must not be quoted

tools/hrw4u/tests/data/ops/http_cntl_quoted_bool.fail.input.txt

@@ -0,0 +1,3 @@
+SEND_RESPONSE {
+    http.cntl.LOGGING = "true";
+}

tools/hrw4u/tests/data/ops/http_cntl_valid_bools.ast.txt

@@ -0,0 +1 @@
+(program (section SEND_RESPONSE { (sectionBody (statement http.cntl.LOGGING = (value TRUE) ;)) (sectionBody (statement http.cntl.TXN_DEBUG = (value FALSE) ;)) (sectionBody (statement http.cntl.REQ_CACHEABLE = (value YES) ;)) (sectionBody (statement http.cntl.RESP_CACHEABLE = (value NO) ;)) (sectionBody (statement http.cntl.SERVER_NO_STORE = (value ON) ;)) (sectionBody (statement http.cntl.SKIP_REMAP = (value OFF) ;)) (sectionBody (statement http.cntl.INTERCEPT_RETRY = (value 1) ;)) (sectionBody (statement http.cntl.LOGGING = (value 0) ;)) (sectionBody (statement http.cntl.TXN_DEBUG = (value true) ;)) (sectionBody (statement http.cntl.REQ_CACHEABLE = (value false) ;)) (sectionBody (statement http.cntl.RESP_CACHEABLE = (value yes) ;)) (sectionBody (statement http.cntl.SERVER_NO_STORE = (value no) ;)) (sectionBody (statement http.cntl.SKIP_REMAP = (value on) ;)) (sectionBody (statement http.cntl.INTERCEPT_RETRY = (value off) ;)) (sectionBody (statement http.cntl.LOGGING = (value True) ;)) (sectionBody (statement http.cntl.TXN_DEBUG = (value False) ;)) (sectionBody (statement http.cntl.LOGGING = (value TRue) ;)) }) <EOF>)

tools/hrw4u/tests/data/ops/http_cntl_valid_bools.input.txt

@@ -0,0 +1,19 @@
+SEND_RESPONSE {
+    http.cntl.LOGGING = TRUE;
+    http.cntl.TXN_DEBUG = FALSE;
+    http.cntl.REQ_CACHEABLE = YES;
+    http.cntl.RESP_CACHEABLE = NO;
+    http.cntl.SERVER_NO_STORE = ON;
+    http.cntl.SKIP_REMAP = OFF;
+    http.cntl.INTERCEPT_RETRY = 1;
+    http.cntl.LOGGING = 0;
+    http.cntl.TXN_DEBUG = true;
+    http.cntl.REQ_CACHEABLE = false;
+    http.cntl.RESP_CACHEABLE = yes;
+    http.cntl.SERVER_NO_STORE = no;
+    http.cntl.SKIP_REMAP = on;
+    http.cntl.INTERCEPT_RETRY = off;
+    http.cntl.LOGGING = True;
+    http.cntl.TXN_DEBUG = False;
+    http.cntl.LOGGING = TRue;
+}

tools/hrw4u/tests/data/ops/http_cntl_valid_bools.output.txt

@@ -0,0 +1,18 @@
+cond %{SEND_RESPONSE_HDR_HOOK} [AND]
+    set-http-cntl LOGGING TRUE
+    set-http-cntl TXN_DEBUG FALSE
+    set-http-cntl REQ_CACHEABLE YES
+    set-http-cntl RESP_CACHEABLE NO
+    set-http-cntl SERVER_NO_STORE ON
+    set-http-cntl SKIP_REMAP OFF
+    set-http-cntl INTERCEPT_RETRY 1
+    set-http-cntl LOGGING 0
+    set-http-cntl TXN_DEBUG true
+    set-http-cntl REQ_CACHEABLE false
+    set-http-cntl RESP_CACHEABLE yes
+    set-http-cntl SERVER_NO_STORE no
+    set-http-cntl SKIP_REMAP on
+    set-http-cntl INTERCEPT_RETRY off
+    set-http-cntl LOGGING True
+    set-http-cntl TXN_DEBUG False
+    set-http-cntl LOGGING TRue

tools/hrw4u/tests/data/ops/skip_remap_quoted_bool.fail.error.txt

@@ -0,0 +1 @@
+Invalid boolean value '"true"'. Must be one of: 0, 1, FALSE, NO, OFF, ON, TRUE, YES and must not be quoted