# Copyright 2025 The Chromium Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

import xml.dom.minidom

import setup_modules  # pylint: disable=unused-import

import chromium_src.tools.metrics.ukm.xml_validations as xml_validations
import chromium_src.tools.metrics.histograms.extract_histograms as extract_histograms
import chromium_src.tools.metrics.histograms.histogram_paths as histogram_paths
import chromium_src.tools.metrics.histograms.merge_xml as merge_xml


class EventBasedXmlValidation(xml_validations.UkmXmlValidation):
  """Validations for the content of event-based Private Metrics configurations."""

  def __init__(
    self, config_xml: xml.dom.minidom.Element, config_type: str
  ) -> None:
    """Attributes:

    config_xml: A XML minidom Element representing the root node of the config
      tree.
    config_type: Type of the configuration, e.g. "DWA" for DWA
    """
    super().__init__(config_xml)
    self.config_type = config_type

  def check_metric_type_is_specified(self):
    """Checks each metric is either specified with an enum or a unit."""
    errors = []

    enum_tree = merge_xml.MergeFiles(histogram_paths.ENUMS_XMLS)
    enums, _ = extract_histograms.ExtractEnumsFromXmlTree(enum_tree)

    for event_node in self.config.getElementsByTagName('event'):
      for metric_node in event_node.getElementsByTagName('metric'):
        if metric_node.hasAttribute('enum'):
          enum_name = metric_node.getAttribute('enum')
          # Check if the enum is defined in enums.xml.
          if enum_name not in enums:
            errors.append(
              'Unknown enum %s in %s metric %s:%s.'
              % (
                enum_name,
                self.config_type,
                event_node.getAttribute('name'),
                metric_node.getAttribute('name'),
              )
            )

    is_success = not errors

    return (is_success, errors)


class DwaXmlValidation(EventBasedXmlValidation):
  """Validations for the content of dwa.xml."""

  def __init__(self, dwa_config: xml.dom.minidom.Element) -> None:
    """Attributes:

    dwa_config: A XML minidom Element representing the root node of the DWA
        config tree.
    """
    super().__init__(dwa_config, 'DWA')