Revert "Support formatting metrics xml(s) in the subfolders."

This reverts commit 597ba08be5eb953914ba48d2dc85f1f41dbbec31.

Reason for revert: it broke git_cl.py. Need further patch

Original change's description:
> Support formatting metrics xml(s) in the subfolders.
>
> https://crrev.com/c/6072565 assumed that the XMLs are located under
> tools/metrics/{actions,ukm,structured,histograms} directly, such as
> tools/metrics/histograms/enums.xml.
>
> However, its subfolders may have XML files, and it should format
> the files. This CL fixes it.
>
> Bug: 384940858
> Change-Id: I56484144e6f72f41eb5bc37a5ad462a0de1ec0e3
> Reviewed-on: https://chromium-review.googlesource.com/c/chromium/tools/depot_tools/+/6111994
> Reviewed-by: Josip Sokcevic <sokcevic@chromium.org>
> Auto-Submit: Scott Lee <ddoman@chromium.org>
> Commit-Queue: Scott Lee <ddoman@chromium.org>

Bug: 384940858
Change-Id: I322573ad6d2d758cd3d2de872efdbba4fd9330c2
No-Presubmit: true
No-Tree-Checks: true
No-Try: true
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/tools/depot_tools/+/6111996
Bot-Commit: Rubber Stamper <rubber-stamper@appspot.gserviceaccount.com>
Commit-Queue: Scott Lee <ddoman@chromium.org>

metrics_xml_format.py

@@ -11,16 +11,17 @@ import subprocess
 import sys
 
 
-def GetMetricsDir(top_dir, path):
+def GetMetricsDir(path):
     metrics_xml_dirs = [
-        os.path.join(top_dir, 'tools', 'metrics', 'actions'),
-        os.path.join(top_dir, 'tools', 'metrics', 'histograms'),
-        os.path.join(top_dir, 'tools', 'metrics', 'structured'),
-        os.path.join(top_dir, 'tools', 'metrics', 'ukm'),
+        'tools/metrics/actions',
+        'tools/metrics/histograms',
+        'tools/metrics/structured',
+        'tools/metrics/ukm',
     ]
-    abs_dirname = os.path.dirname(os.path.realpath(path))
+    normalized_abs_dirname = os.path.dirname(os.path.realpath(path)).replace(
+        os.sep, '/')
     for xml_dir in metrics_xml_dirs:
-        if abs_dirname.startswith(xml_dir):
+        if normalized_abs_dirname.endswith(xml_dir):
             return xml_dir
     return None
 
@@ -45,7 +46,7 @@ def FindMetricsXMLFormatterTool(path, verbose=False):
     if not top_dir:
         log('Not executed in a Chromium checkout; skip formatting', verbose)
         return ''
-    xml_dir = GetMetricsDir(top_dir, path)
+    xml_dir = GetMetricsDir(path)
     if not xml_dir:
         log(f'{path} is not a metric XML; skip formatting', verbose)
         return ''
@@ -57,16 +58,17 @@ def FindMetricsXMLFormatterTool(path, verbose=False):
             'skip formatting', verbose)
         return ''
 
-    histograms_base_dir = os.path.join(top_dir, 'tools', 'metrics',
-                                       'histograms')
-    if xml_dir.startswith(histograms_base_dir):
+    if xml_dir == 'tools/metrics/histograms':
         # Skips the formatting, if the XML file is not one of the known types.
         if not IsSupportedHistogramsXML(path):
             log(f'{path} is not a supported histogram XML; skip formatting',
                 verbose)
             return ''
 
-    return os.path.join(xml_dir, 'pretty_print.py')
+    # top_dir is already formatted with the OS specific path separator, whereas
+    # xml_dir is not yet.
+    tool_dir = os.path.join(top_dir, xml_dir.replace('/', os.path.sep))
+    return os.path.join(tool_dir, 'pretty_print.py')
 
 
 usage_text = """Usage: %s [option] filepath

tests/metrics_xml_format_test.py

@@ -14,7 +14,8 @@ sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
 import gclient_paths_test
 import metrics_xml_format
 
-norm = lambda path: os.path.join(*path.split('/'))
+norm = lambda path: path.replace('/', os.sep)
+join = os.path.join
 
 
 class TestBase(gclient_paths_test.TestBase):
@@ -29,95 +30,83 @@ class TestBase(gclient_paths_test.TestBase):
         mock.patch('os.path.realpath', self.realpath).start()
         # gclient_paths.GetPrimarysolutionPath() defaults to src.
         self.make_file_tree({'.gclient': ''})
-        self.cwd = os.path.join(self.cwd, 'src')
+        self.cwd = join(self.cwd, 'src')
 
     def realpath(self, path):
         if os.path.isabs(path):
             return path
 
-        return os.path.join(self.getcwd(), path)
+        return join(self.getcwd(), path)
 
 
 class GetMetricsDirTest(TestBase):
 
     def testWithAbsolutePath(self):
-        top = self.getcwd()
-        get = lambda path: metrics_xml_format.GetMetricsDir(
-            top, os.path.join(top, norm(path)))
+        get = lambda path: metrics_xml_format.GetMetricsDir(norm(path))
+        self.assertTrue(get('/src/tools/metrics/actions/abc.xml'))
+        self.assertTrue(get('/src/tools/metrics/histograms/abc.xml'))
+        self.assertTrue(get('/src/tools/metrics/structured/abc.xml'))
+        self.assertTrue(get('/src/tools/metrics/ukm/abc.xml'))
 
-        self.assertTrue(get('tools/metrics/actions/abc.xml'))
-        self.assertTrue(get('tools/metrics/histograms/abc.xml'))
-        self.assertTrue(get('tools/metrics/structured/abc.xml'))
-        self.assertTrue(get('tools/metrics/ukm/abc.xml'))
-
-        self.assertFalse(get('tools/test/metrics/actions/abc.xml'))
-        self.assertFalse(get('tools/test/metrics/histograms/abc.xml'))
-        self.assertFalse(get('tools/test/metrics/structured/abc.xml'))
-        self.assertFalse(get('tools/test/metrics/ukm/abc.xml'))
+        self.assertFalse(get('/src/tools/metrics/actions/next/abc.xml'))
+        self.assertFalse(get('/src/tools/metrics/histograms/next/abc.xml'))
+        self.assertFalse(get('/src/tools/metrics/structured/next/abc.xml'))
+        self.assertFalse(get('/src/tools/metrics/ukm/next/abc.xml'))
 
     def testWithRelativePaths(self):
-        top = self.getcwd()
-        # chdir() to tools so that relative paths from tools become valid.
-        self.cwd = os.path.join(self.cwd, 'tools')
-        get = lambda path: metrics_xml_format.GetMetricsDir(top, path)
-        self.assertTrue(get(norm('metrics/actions/abc.xml')))
-        self.assertFalse(get(norm('abc.xml')))
+        get = lambda path: metrics_xml_format.GetMetricsDir(norm(path))
+        self.cwd = join(self.cwd, 'tools')
+        self.assertFalse(get('abc.xml'))
+        self.assertTrue(get('metrics/actions/abc.xml'))
 
 
 class FindMetricsXMLFormatTool(TestBase):
 
     def testWithMetricsXML(self):
-        top = self.getcwd()
         findTool = metrics_xml_format.FindMetricsXMLFormatterTool
 
         self.assertEqual(
             findTool(norm('tools/metrics/actions/abc.xml')),
-            os.path.join(top, norm('tools/metrics/actions/pretty_print.py')),
+            join(self.getcwd(), norm('tools/metrics/actions/pretty_print.py')),
         )
 
         # same test, but with an absolute path.
         self.assertEqual(
-            findTool(os.path.join(top, norm('tools/metrics/actions/abc.xml'))),
-            os.path.join(top, norm('tools/metrics/actions/pretty_print.py')),
+            findTool(join(self.getcwd(),
+                          norm('tools/metrics/actions/abc.xml'))),
+            join(self.getcwd(), norm('tools/metrics/actions/pretty_print.py')),
         )
 
     def testWthNonMetricsXML(self):
         findTool = metrics_xml_format.FindMetricsXMLFormatterTool
-        self.assertEqual(findTool(norm('tools/metrics/test/abc.xml')), '')
+        self.assertEqual(findTool('tools/metrics/actions/next/abc.xml'), '')
 
     def testWithNonCheckout(self):
         findTool = metrics_xml_format.FindMetricsXMLFormatterTool
         self.cwd = self.root
-        self.assertEqual(findTool(norm('tools/metrics/actions/abc.xml')), '')
+        self.assertEqual(findTool('tools/metrics/actions/abc.xml'), '')
 
     def testWithDifferentCheckout(self):
         findTool = metrics_xml_format.FindMetricsXMLFormatterTool
-        checkout2 = os.path.join(self.root, '..', self._testMethodName + '2',
-                                 'src')
+        checkout2 = join(self.root, '..', self._testMethodName + '2', 'src')
         self.assertEqual(
             # this is the case the tool was given a file path that is located
             # in a different checkout folder.
-            findTool(
-                os.path.join(checkout2, norm('tools/metrics/actions/abc.xml'))),
+            findTool(join(checkout2, norm('tools/metrics/actions/abc.xml'))),
             '',
         )
 
     def testSupportedHistogramsXML(self):
-        top = self.getcwd()
         findTool = metrics_xml_format.FindMetricsXMLFormatterTool
         self.assertEqual(
             findTool(norm('tools/metrics/histograms/enums.xml')),
-            os.path.join(top, norm('tools/metrics/histograms/pretty_print.py')),
-        )
-        self.assertEqual(
-            findTool(norm('tools/metrics/histograms/tests/histograms.xml')),
-            os.path.join(top, norm('tools/metrics/histograms/pretty_print.py')),
+            join(self.getcwd(),
+                 norm('tools/metrics/histograms/pretty_print.py')),
         )
 
     def testNotSupportedHistogramsXML(self):
-        tool = metrics_xml_format.FindMetricsXMLFormatterTool(
-            norm('tools/metrics/histograms/NO.xml'))
-        self.assertEqual(tool, '')
+        findTool = metrics_xml_format.FindMetricsXMLFormatterTool
+        self.assertEqual(findTool(norm('tools/metrics/histograms/NO.xml')), '')
 
 
 if __name__ == '__main__':