feat: add CheckboxTree component

docs/entity/components.md

@@ -321,6 +321,80 @@ This is how it looks in the UI:
 
 The component maps and unmaps values into a single field in the format `fieldName1/fieldValue1,fieldName2/fieldValue2`, but only for checked rows. For the given example, it emits the following value: `rowUnderGroup1/1200,requiredField/10`.
 
+## `CheckboxTree`
+
+See the following example usage:
+
+```json
+ {
+    "type": "checkboxTree",
+    "label": "CheckboxTreeTitle",
+    "field": "api3",
+    "options": {
+    "groups": [
+        {
+            "label": "Group 1",
+            "options": {
+                "isExpandable": true,
+                "expand": true
+            },
+            "fields": ["rowUnderGroup1"]
+        },
+        {
+            "label": "Group 3",
+            "options": {
+                "isExpandable": true,
+                "expand": true,
+            },
+            "fields": ["firstRowUnderGroup3", "secondRowUnderGroup3", "thirdRowUnderGroup3"]
+        }
+    ],
+    "rows": [
+        {
+            "field": "rowWithoutGroup",
+            "checkbox": {
+                "label": "Row without group",
+                "defaultValue": true
+            }
+        },
+        {
+            "field": "rowUnderGroup1",
+            "checkbox": {
+                "label": "Row under Group 1",
+                "defaultValue": true
+            }
+        },
+        {
+            "field": "firstRowUnderGroup3",
+            "checkbox": {
+                "label": "first row under group 3",
+                "defaultValue": true
+            }
+        },
+        {
+            "field": "secondRowUnderGroup3",
+            "checkbox": {
+                "label": "second row under group 3"
+            }
+        },
+        {
+            "field": "thirdRowUnderGroup3",
+            "checkbox": {
+                "label": "third row checked under group 3",
+                "defaultValue": true,
+            }
+        }
+    ]
+    }
+}
+```
+
+This is how it looks in the UI:
+
+![image](../images/components/checkbox_tree_mixed_example.png)
+
+The component maps and unmaps values into a single field in the format `fieldName1,fieldName2,fieldName3`, but only for checked rows. For the given example, it emits the following value: `rowWithoutGroup,rowUnderGroup1,firstRowUnderGroup3`.
+
 ## `Multiple Select`
 
 See the underlying `@splunk/react-ui` component: [`Multiselect`](https://splunkui.splunk.com/Packages/react-ui/Multiselect).

splunk_add_on_ucc_framework/global_config_validator.py

@@ -474,7 +474,10 @@ def _validate_checkbox_group(self) -> None:
         services = inputs["services"]
         for service in services:
             for entity in service["entity"]:
-                if entity["type"] == "checkboxGroup":
+                if (
+                    entity["type"] == "checkboxGroup"
+                    or entity["type"] == "checkboxTree"
+                ):
                     row_field_names = []
                     for row in entity["options"]["rows"]:
                         if row["field"] in row_field_names:

splunk_add_on_ucc_framework/schema/schema.json

@@ -1452,6 +1452,127 @@
       ],
       "additionalProperties": false
     },
+    "CheckboxTreeEntity": {
+      "type": "object",
+      "properties": {
+        "field": {
+          "$ref": "#/definitions/Field"
+        },
+        "label": {
+          "type": "string",
+          "maxLength": 30,
+          "description": "Text displayed next to entity field"
+        },
+        "type": {
+          "const": "checkboxTree",
+          "type": "string",
+          "description": "Exactly: checkboxTree"
+        },
+        "disabled": {
+          "type": "boolean",
+          "default": false
+        },
+        "options": {
+          "type": "object",
+          "properties": {
+            "groups": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "label": {
+                    "type": "string",
+                    "maxLength": 30,
+                    "description": "Text displayed next to entity field"
+                  },
+                  "options": {
+                    "type": "object",
+                    "properties": {
+                      "isExpandable": {
+                        "type": "boolean",
+                        "default": false
+                      },
+                      "expand": {
+                        "type": "boolean",
+                        "default": false
+                      },
+                      "disabled": {
+                        "type": "boolean",
+                        "default": false
+                      }
+                    },
+                    "additionalProperties": false
+                  },
+                  "fields": {
+                    "type": "array",
+                    "minItems": 1,
+                    "items": {
+                      "type": "string"
+                    },
+                    "uniqueItems": true
+                  }
+                },
+                "required": ["label", "fields"],
+                "additionalProperties": false
+              }
+            },
+            "rows": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "field": {
+                    "type": "string"
+                  },
+                  "checkbox": {
+                    "type": "object",
+                    "properties": {
+                      "label": {
+                        "type": "string",
+                        "maxLength": 30,
+                        "description": "Text displayed next to entity field"
+                      },
+                      "defaultValue": {
+                        "type": "boolean",
+                        "description": "The initial input value."
+                      },
+                      "disabled": {
+                        "type": "boolean",
+                        "default": false
+                      }
+                    },
+                    "additionalProperties": false
+                  }
+                },
+                "required": ["field"],
+                "additionalProperties": false
+              },
+              "minItems": 1
+            },
+            "disableonEdit": {
+              "$ref": "#/definitions/disableonEdit"
+            }
+          },
+          "required": ["rows"],
+          "additionalProperties": false
+        },
+        "validators": {
+          "type": "array",
+          "items": {
+            "anyOf": [
+              {
+                "$ref": "#/definitions/RegexValidator"
+              }
+            ]
+          }
+        },
+        "required": {
+          "type": "boolean"
+        }
+      },
+      "required": ["field", "label", "type", "options"],
+      "additionalProperties": false
+    },
     "RadioEntity": {
       "type": "object",
       "properties": {
@@ -1867,6 +1988,9 @@
           {
             "$ref": "#/definitions/CheckboxGroupEntity"
           },
+          {
+            "$ref": "#/definitions/CheckboxTreeEntity"
+          },
           {
             "$ref": "#/definitions/TextEntity"
           },

tests/testdata/expected_addons/expected_output_global_config_everything/Splunk_TA_UCCExample/README/inputs.conf.spec

@@ -34,6 +34,7 @@ start_date = The date and time, in "YYYY-MM-DDThh:mm:ss.000z" format, after whic
 use_existing_checkpoint = Data input already exists. Select `No` if you want to reset the data collection.  Default: yes
 
 [example_input_three://<name>]
+event_filters =
 interval = Time interval of the data input, in seconds.
 
 [example_input_four://<name>]

tests/testdata/expected_addons/expected_output_global_config_everything/Splunk_TA_UCCExample/bin/splunk_ta_uccexample_rh_three_custom.py

@@ -28,6 +28,14 @@
         'disabled',
         required=False,
         validator=None
+    ),
+
+    field.RestField(
+        'event_filters',
+        required=False,
+        encrypted=False,
+        default=None,
+        validator=None
     )
 
 ]

tests/testdata/test_addons/package_global_config_everything/globalConfig.json

@@ -1486,6 +1486,81 @@
                             "label": "Interval",
                             "help": "Time interval of the data input, in seconds.",
                             "required": true
+                        },
+                        {
+                            "type": "checkboxTree",
+                            "label": "Event Filters",
+                            "field": "event_filters",
+                            "required": true,
+                            "options": {
+                                "groups": [
+                                    {
+                                        "label": "Transactions",
+                                        "options": {
+                                            "isExpandable": true,
+                                            "expand": true
+                                        },
+                                        "fields": [
+                                            "slow_request",
+                                            "transaction_stall"
+                                        ]
+                                    },
+                                    {
+                                        "label": "others",
+                                        "options": {
+                                            "isExpandable": true,
+                                            "expand": true
+                                        },
+                                        "fields": [
+                                            "custom_events",
+                                            "cluster_events",
+                                            "network_events"
+                                        ]
+                                    }
+                                ],
+                                "rows": [
+                                    {
+                                        "field": "code_problems",
+                                        "checkbox": {
+                                            "label": "Code Problems",
+                                            "defaultValue": true
+                                        }
+                                    },
+                                    {
+                                        "field": "slow_request",
+                                        "checkbox": {
+                                            "label": "Slow Request",
+                                            "defaultValue": true
+                                        }
+                                    },
+                                    {
+                                        "field": "transaction_stall",
+                                        "checkbox": {
+                                            "label": "Transactions Stall",
+                                            "defaultValue": false
+                                        }
+                                    },
+                                    {
+                                        "field": "custom_events",
+                                        "checkbox": {
+                                            "label": "Custom Events",
+                                            "defaultValue": true
+                                        }
+                                    },
+                                    {
+                                        "field": "cluster_events",
+                                        "checkbox": {
+                                            "label": "Cluster Events"
+                                        }
+                                    },
+                                    {
+                                        "field": "network_events",
+                                        "checkbox": {
+                                            "label": "Network Events"
+                                        }
+                                    }
+                                ]
+                            }
                         }
                     ],
                     "title": "Example Input Three"

tests/testdata/test_addons/package_global_config_everything/package/bin/splunk_ta_uccexample_rh_three_custom.py

@@ -28,6 +28,14 @@
         'disabled',
         required=False,
         validator=None
+    ),
+
+    field.RestField(
+        'event_filters',
+        required=False,
+        encrypted=False,
+        default=None,
+        validator=None
     )
 
 ]