#!/usr/bin/env python3
# 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 unittest
import web_idl_diff_tool

# Test to ensure there are no difference in parsing + processing extension API
# schemas when converting them to be written using WebIDL. Uses the alarms API
# schema files as an example to test, copied over at the time they were
# initially converted to WebIDL.


# Note: the following schemas were copied over at the time of their conversion
# and are not intended to be kept up to date with any more recent updates. Once
# all the old IDL has been converted and we are ready to remove the old parser,
# these can all be deleted and this test removed.
_CONVERTED_SCHEMAS = [
  ('alarms.idl', 'alarms.webidl'),
  ('app_current_window_internal.idl', 'app_current_window_internal.webidl'),
  ('bluetooth.idl', 'bluetooth.webidl'),
  ('dns.idl', 'dns.webidl'),
  ('language_settings_private.idl', 'language_settings_private.webidl'),
  ('audio.idl', 'audio.webidl'),
  ('cec_private.idl', 'cec_private.webidl'),
  ('diagnostics.idl', 'diagnostics.webidl'),
  ('login_screen_storage.idl', 'login_screen_storage.webidl'),
  ('virtual_keyboard.idl', 'virtual_keyboard.webidl'),
  ('webcam_private.idl', 'webcam_private.webidl'),
  ('extension_options_internal.idl', 'extension_options_internal.webidl'),
  ('login_screen_ui.idl', 'login_screen_ui.webidl'),
  ('system_cpu.idl', 'system_cpu.webidl'),
  ('system_memory.idl', 'system_memory.webidl'),
  ('system_network.idl', 'system_network.webidl'),
  ('image_loader_private.idl', 'image_loader_private.webidl'),
  ('system_storage.idl', 'system_storage.webidl'),
  ('app_runtime.idl', 'app_runtime.webidl'),
  ('bluetooth_low_energy.idl', 'bluetooth_low_energy.webidl'),
  ('bluetooth_socket.idl', 'bluetooth_socket.webidl'),
  ('clipboard.idl', 'clipboard.webidl'),
  ('system_display.idl', 'system_display.webidl'),
  ('usb.idl', 'usb.webidl'),
  ('chrome_url_overrides.idl', 'chrome_url_overrides.webidl'),
  ('cross_origin_isolation.idl', 'cross_origin_isolation.webidl'),
  ('enterprise_reporting_private.idl', 'enterprise_reporting_private.webidl'),
  ('file_handlers.idl', 'file_handlers.webidl'),
  ('identity.idl', 'identity.webidl'),
  ('oauth2.idl', 'oauth2.webidl'),
  ('protocol_handlers.idl', 'protocol_handlers.webidl'),
  ('shared_module.idl', 'shared_module.webidl'),
  ('web_accessible_resources.idl', 'web_accessible_resources.webidl'),
  (
    'enterprise_platform_keys_internal.idl',
    'enterprise_platform_keys_internal.webidl',
  ),
  ('login.idl', 'login.webidl'),
  ('experimental_ai_data.idl', 'experimental_ai_data.webidl'),
  ('notifications.idl', 'notifications.webidl'),
  ('web_accessible_resources_mv2.idl', 'web_accessible_resources_mv2.webidl'),
  ('automation_internal.idl', 'automation_internal.webidl'),
  ('automation.idl', 'automation.webidl'),
  ('feedback_private.idl', 'feedback_private.webidl'),
  ('file_manager_private_internal.idl', 'file_manager_private_internal.webidl'),
  ('media_perception_private.idl', 'media_perception_private.webidl'),
  ('mojo_private.idl', 'mojo_private.webidl'),
  ('networking_onc.idl', 'networking_onc.webidl'),
  ('networking_private.idl', 'networking_private.webidl'),
  ('offscreen.idl', 'offscreen.webidl'),
  ('power.idl', 'power.webidl'),
  ('serial.idl', 'serial.webidl'),
  ('bluetooth_private.idl', 'bluetooth_private.webidl'),
  ('braille_display_private.idl', 'braille_display_private.webidl'),
  ('content_scripts.idl', 'content_scripts.webidl'),
  ('declarative_net_request.idl', 'declarative_net_request.webidl'),
  ('image_writer_private.idl', 'image_writer_private.webidl'),
  ('printer_provider.idl', 'printer_provider.webidl'),
  ('printer_provider_internal.idl', 'printer_provider_internal.webidl'),
  ('scripts_internal.idl', 'scripts_internal.webidl'),
  ('user_scripts.idl', 'user_scripts.webidl'),
  ('app_window.idl', 'app_window.webidl'),
  ('accessibility_service_private.idl', 'accessibility_service_private.webidl'),
  ('appview_tag.idl', 'appview_tag.webidl'),
  ('autotest_private.idl', 'autotest_private.webidl'),
  ('certificate_provider.idl', 'certificate_provider.webidl'),
  ('certificate_provider_internal.idl', 'certificate_provider_internal.webidl'),
  ('crash_report_private.idl', 'crash_report_private.webidl'),
  ('developer_private.idl', 'developer_private.webidl'),
  ('document_scan.idl', 'document_scan.webidl'),
  ('downloads.idl', 'downloads.webidl'),
  ('downloads_internal.idl', 'downloads_internal.webidl'),
  ('enterprise_device_attributes.idl', 'enterprise_device_attributes.webidl'),
  ('enterprise_hardware_platform.idl', 'enterprise_hardware_platform.webidl'),
  ('enterprise_kiosk_input.idl', 'enterprise_kiosk_input.webidl'),
  ('enterprise_login.idl', 'enterprise_login.webidl'),
  (
    'enterprise_networking_attributes.idl',
    'enterprise_networking_attributes.webidl',
  ),
  ('enterprise_platform_keys.idl', 'enterprise_platform_keys.webidl'),
  ('experimental_actor.idl', 'experimental_actor.webidl'),
  ('file_system_provider.idl', 'file_system_provider.webidl'),
]


class WebIdlDiffToolTest(unittest.TestCase):
  pass


# Helper function to loop over the converted schema file pairs and add a
# separate test case function to WebIdlDiffToolTest for each one.
def _GenerateTestMethods():
  # LoadAndReturnUnifiedDiff expects file paths relative to the repo root.
  converted_schema_path = 'tools/json_schema_compiler/test/converted_schemas/'
  for old_schema_name, new_schema_name in _CONVERTED_SCHEMAS:

    def test(
      self, old_schema_name=old_schema_name, new_schema_name=new_schema_name
    ):
      old_filename = converted_schema_path + old_schema_name
      new_filename = converted_schema_path + new_schema_name
      diff = web_idl_diff_tool.LoadAndReturnUnifiedDiff(
        old_filename, new_filename
      )
      self.assertEqual(
        '',
        diff,
        f"Difference detected between '{old_filename}' and"
        f" '{new_filename}':\n{diff}",
      )

    test_name = f'test_{old_schema_name.replace(".", "_")}'
    setattr(WebIdlDiffToolTest, test_name, test)


_GenerateTestMethods()


if __name__ == '__main__':
  unittest.main()