| # Copyright 2017 The Chromium Authors |
| # Use of this source code is governed by a BSD-style license that can be |
| # found in the LICENSE file. |
| |
| import logging |
| from parameterized import parameterized |
| import unittest |
| import xml.dom.minidom |
| |
| import extract_histograms |
| import histogram_configuration_model |
| |
| TEST_SUFFIX_OBSOLETION_XML_CONTENT = """ |
| <histogram-configuration> |
| <histograms> |
| <histogram name="Test.Test1" units="units" expires_after="2019-01-01"> |
| <owner>chrome-metrics-team@google.com</owner> |
| <summary> |
| Sample description. |
| </summary> |
| </histogram> |
| <histogram name="Test.Test2" units="units" expires_after="2019-01-01"> |
| <owner>chrome-metrics-team@google.com</owner> |
| <summary> |
| Sample description. |
| </summary> |
| </histogram> |
| </histograms> |
| <histogram_suffixes_list> |
| <histogram_suffixes name="NonObsoleteSuffix" separator="_"> |
| <suffix name="NonObsolete1" label="First non-obsolete suffix"/> |
| <suffix name="NonObsolete2" label="Second non-obsolete suffix"/> |
| <affected-histogram name="Test.Test1"/> |
| <affected-histogram name="Test.Test2"/> |
| </histogram_suffixes> |
| |
| <histogram_suffixes name="ObsoleteSuffixGroup" separator="_"> |
| <obsolete>This suffix group is obsolete</obsolete> |
| <suffix name="ObsoleteSuffixGroup1" label="First obsolete suffix"/> |
| <suffix name="ObsoleteSuffixGroup2" label="Second obsolete suffix"/> |
| <affected-histogram name="Test.Test1"/> |
| </histogram_suffixes> |
| |
| <histogram_suffixes name="ObsoleteSuffixNonObsoleteGroup" separator="_"> |
| <suffix name="ObsoleteSuffixNonObsoleteGroup1" label="Obsolete suffix"> |
| <obsolete>This suffix is obsolete</obsolete> |
| </suffix> |
| <suffix name="NonObsoleteSuffixNonObsoleteGroup2" |
| label="Non obsolete suffix"/> |
| <affected-histogram name="Test.Test2"/> |
| </histogram_suffixes> |
| |
| <histogram_suffixes name="ObsoleteSuffixObsoleteGroup" separator="_"> |
| <obsolete>This suffix group is obsolete</obsolete> |
| <suffix name="ObsoleteSuffixObsoleteGroup1" label="First obsolete suffix"> |
| <obsolete>This suffix is obsolete</obsolete> |
| </suffix> |
| <suffix name="NonObsoleteSuffixObsoleteGroup2" |
| label="Second obsolete suffix"/> |
| <affected-histogram name="Test.Test2"/> |
| </histogram_suffixes> |
| </histogram_suffixes_list> |
| </histogram-configuration> |
| """ |
| |
| TEST_BASE_HISTOGRAM_XML_CONTENT = """ |
| <histogram-configuration> |
| <histograms> |
| <histogram base="true" name="Test.Base" units="units" |
| expires_after="2211-11-22"> |
| <owner>chrome-metrics-team@google.com</owner> |
| <summary> |
| Base histogram. |
| </summary> |
| </histogram> |
| <histogram base="true" name="Test.Base.Obsolete" units="units" |
| expires_after="2019-01-01"> |
| <owner>chrome-metrics-team@google.com</owner> |
| <summary> |
| Obsolete base histogram. |
| </summary> |
| <obsolete> |
| The whole related set of histograms is obsolete! |
| </obsolete> |
| </histogram> |
| <histogram base="false" name="Test.NotBase.Explicit" units="units" |
| expires_after="2019-01-01"> |
| <owner>chrome-metrics-team@google.com</owner> |
| <summary> |
| Not a base histogram: base attribute explicitly set to "false". |
| </summary> |
| </histogram> |
| <histogram name="Test.NotBase.Implicit" units="units" |
| expires_after="M100"> |
| <owner>chrome-metrics-team@google.com</owner> |
| <summary> |
| Not a base histogram: no base attribute specified. |
| </summary> |
| </histogram> |
| </histograms> |
| <histogram_suffixes_list> |
| <histogram_suffixes name="Suffixes" separator="."> |
| <suffix base="true" name="BaseSuffix" label="A base suffix"/> |
| <suffix name="NonBaseSuffix" label="A non-base suffix"/> |
| <suffix name="ObsoleteSuffix" label="An obsolete suffix"> |
| <obsolete>This suffix is obsolete!</obsolete> |
| </suffix> |
| <affected-histogram name="Test.Base"/> |
| <affected-histogram name="Test.Base.Obsolete"/> |
| </histogram_suffixes> |
| |
| <histogram_suffixes name="SuffixesPlusPlus" separator="."> |
| <suffix name="One" label="One suffix"/> |
| <suffix name="Two" label="Another suffix"/> |
| <affected-histogram name="Test.Base.BaseSuffix"/> |
| <affected-histogram name="Test.Base.NonBaseSuffix"/> |
| </histogram_suffixes> |
| </histogram_suffixes_list> |
| </histogram-configuration> |
| """ |
| |
| TEST_HISTOGRAM_WITH_TOKENS = """ |
| <histogram-configuration> |
| <histograms> |
| <histogram name="HistogramName.{Color}{Size}" expires_after="2017-10-16"> |
| <owner>me@chromium.org</owner> |
| <summary> |
| This is a histogram for button of {Color} color and {Size} size. |
| </summary> |
| <token key="Color"> |
| <variant name="red"> |
| <obsolete> |
| Obsolete red |
| </obsolete> |
| </variant> |
| <variant name="green"> |
| <owner>green@chromium.org</owner> |
| </variant> |
| </token> |
| <token key="Size"> |
| <variant name="" summary="all"/> |
| <variant name=".small" summary="small"> |
| <owner>small@chromium.org</owner> |
| <obsolete> |
| Obsolete small |
| </obsolete> |
| </variant> |
| <variant name=".medium" summary="medium"/> |
| <variant name=".large" summary="large"/> |
| </token> |
| </histogram> |
| </histograms> |
| </histogram-configuration> |
| """ |
| |
| TEST_HISTOGRAM_WITH_VARIANTS = """ |
| <histogram-configuration> |
| <histograms> |
| <variants name="HistogramNameSize"> |
| <variant name="" summary="all"/> |
| <variant name=".small" summary="small"> |
| <owner>small@chromium.org</owner> |
| <obsolete> |
| Obsolete small |
| </obsolete> |
| </variant> |
| <variant name=".medium" summary="medium"/> |
| <variant name=".large" summary="large"/> |
| </variants> |
| |
| <histogram name="HistogramName.{Color}{Size}" expires_after="2017-10-16"> |
| <owner>me@chromium.org</owner> |
| <summary> |
| This is a histogram for button of {Color} color and {Size} size. |
| </summary> |
| <token key="Color"> |
| <variant name="red"> |
| <obsolete> |
| Obsolete red |
| </obsolete> |
| </variant> |
| <variant name="green"> |
| <owner>green@chromium.org</owner> |
| </variant> |
| </token> |
| <token key="Size" variants="HistogramNameSize"/> |
| </histogram> |
| </histograms> |
| </histogram-configuration> |
| """ |
| |
| TEST_HISTOGRAM_TOKENS_DUPLICATE = """ |
| <histogram-configuration> |
| <histograms> |
| <histogram name="Histogram{Color}{Size}" units="things" |
| expires_after="2017-10-16"> |
| <owner>me@chromium.org</owner> |
| <summary> |
| This is a histogram for button of {Color} color and {Size} size. |
| </summary> |
| <token key="Color"> |
| <variant name="" summary="all"/> |
| <variant name=".red" summary="red"/> |
| <variant name=".green" summary="green"/> |
| </token> |
| <token key="Size"> |
| <variant name="" summary="all"/> |
| <variant name=".red" summary="red"/> |
| <variant name=".small" summary="small"/> |
| <variant name=".medium" summary="medium"/> |
| <variant name=".large" summary="large"/> |
| </token> |
| </histogram> |
| </histograms> |
| </histogram-configuration> |
| """ |
| |
| TEST_HISTOGRAM_VARIANTS_DUPLICATE = """ |
| <histogram-configuration> |
| <variants name="HistogramNameSize"> |
| <variant name="" summary="all"/> |
| <variant name=".red" summary="red"/> |
| <variant name=".small" summary="small"/> |
| <variant name=".medium" summary="medium"/> |
| <variant name=".large" summary="large"/> |
| </variants> |
| |
| <histograms> |
| <histogram name="Histogram{Color}{Size}" units="things" |
| expires_after="2017-10-16"> |
| <owner>me@chromium.org</owner> |
| <summary> |
| This is a histogram for button of {Color} color and {Size} size. |
| </summary> |
| <token key="Color"> |
| <variant name="" summary="all"/> |
| <variant name=".red" summary="red"/> |
| <variant name=".green" summary="green"/> |
| </token> |
| <token key="Size" variants="HistogramNameSize"/> |
| </histogram> |
| </histograms> |
| </histogram-configuration> |
| """ |
| |
| |
| TEST_HISTOGRAM_WITH_MIXED_VARIANTS = """ |
| <histogram-configuration> |
| <histograms> |
| <variants name="HistogramNameSize"> |
| <variant name=".medium" summary="medium"/> |
| <variant name=".large" summary="large"/> |
| </variants> |
| |
| <histogram name="HistogramName.{Color}{Size}" expires_after="2017-10-16"> |
| <owner>me@chromium.org</owner> |
| <summary> |
| This is a histogram for button of {Color} color and {Size} size. |
| </summary> |
| <token key="Color"> |
| <variant name="red"> |
| <obsolete> |
| Obsolete red |
| </obsolete> |
| </variant> |
| <variant name="green"> |
| <owner>green@chromium.org</owner> |
| </variant> |
| </token> |
| <token key="Size" variants="HistogramNameSize"> |
| <variant name="" summary="all"/> |
| <variant name=".small" summary="small"> |
| <owner>small@chromium.org</owner> |
| <obsolete> |
| Obsolete small |
| </obsolete> |
| </variant> |
| </token> |
| </histogram> |
| </histograms> |
| </histogram-configuration> |
| """ |
| |
| class ExtractHistogramsTest(unittest.TestCase): |
| |
| def testSuffixObsoletion(self): |
| histograms, had_errors = extract_histograms.ExtractHistogramsFromDom( |
| xml.dom.minidom.parseString(TEST_SUFFIX_OBSOLETION_XML_CONTENT)) |
| self.assertFalse(had_errors) |
| # Obsolete on suffixes doesn't affect the source histogram |
| self.assertNotIn('obsolete', histograms['Test.Test1']) |
| self.assertNotIn('obsolete', histograms['Test.Test2']) |
| |
| self.assertNotIn('obsolete', histograms['Test.Test1_NonObsolete1']) |
| self.assertNotIn('obsolete', histograms['Test.Test1_NonObsolete2']) |
| self.assertNotIn('obsolete', histograms['Test.Test2_NonObsolete1']) |
| self.assertNotIn('obsolete', histograms['Test.Test2_NonObsolete2']) |
| |
| self.assertIn('obsolete', histograms['Test.Test1_ObsoleteSuffixGroup1']) |
| self.assertIn('obsolete', histograms['Test.Test1_ObsoleteSuffixGroup2']) |
| |
| # Obsolete suffixes should apply to individual suffixes and not their group. |
| self.assertIn('obsolete', |
| histograms['Test.Test2_ObsoleteSuffixNonObsoleteGroup1']) |
| self.assertNotIn( |
| 'obsolete', histograms['Test.Test2_NonObsoleteSuffixNonObsoleteGroup2']) |
| self.assertEqual( |
| 'This suffix is obsolete', |
| histograms['Test.Test2_ObsoleteSuffixNonObsoleteGroup1']['obsolete']) |
| |
| # Obsolete suffix reasons should overwrite the suffix group's obsoletion |
| # reason. |
| self.assertIn('obsolete', |
| histograms['Test.Test2_ObsoleteSuffixObsoleteGroup1']) |
| self.assertIn('obsolete', |
| histograms['Test.Test2_NonObsoleteSuffixObsoleteGroup2']) |
| self.assertEqual( |
| 'This suffix is obsolete', |
| histograms['Test.Test2_ObsoleteSuffixObsoleteGroup1']['obsolete']) |
| self.assertEqual( |
| 'This suffix group is obsolete', |
| histograms['Test.Test2_NonObsoleteSuffixObsoleteGroup2']['obsolete']) |
| |
| def testBaseHistograms(self): |
| histograms, had_errors = extract_histograms.ExtractHistogramsFromDom( |
| xml.dom.minidom.parseString(TEST_BASE_HISTOGRAM_XML_CONTENT)) |
| self.assertFalse(had_errors) |
| # Base histograms are implicitly marked as obsolete. |
| self.assertIn('obsolete', histograms['Test.Base']) |
| self.assertIn('obsolete', histograms['Test.Base.Obsolete']) |
| |
| # Other histograms shouldn't be implicitly marked as obsolete. |
| self.assertNotIn('obsolete', histograms['Test.NotBase.Explicit']) |
| self.assertNotIn('obsolete', histograms['Test.NotBase.Implicit']) |
| |
| # Suffixes applied to base histograms shouldn't be marked as obsolete... |
| self.assertNotIn('obsolete', histograms['Test.Base.NonBaseSuffix']) |
| # ... unless the suffix is marked as obsolete, |
| self.assertIn('obsolete', histograms['Test.Base.ObsoleteSuffix']) |
| # ... or the suffix is a base suffix, |
| self.assertIn('obsolete', histograms['Test.Base.BaseSuffix']) |
| # ... or the base histogram is marked as obsolete, |
| self.assertIn('obsolete', histograms['Test.Base.Obsolete.BaseSuffix']) |
| self.assertIn('obsolete', histograms['Test.Base.Obsolete.NonBaseSuffix']) |
| self.assertIn('obsolete', histograms['Test.Base.Obsolete.ObsoleteSuffix']) |
| |
| # It should be possible to have multiple levels of suffixes for base |
| # histograms. |
| self.assertNotIn('obsolete', histograms['Test.Base.BaseSuffix.One']) |
| self.assertNotIn('obsolete', histograms['Test.Base.BaseSuffix.Two']) |
| self.assertNotIn('obsolete', histograms['Test.Base.NonBaseSuffix.One']) |
| self.assertNotIn('obsolete', histograms['Test.Base.NonBaseSuffix.Two']) |
| |
| def testExpiryFormat(self): |
| chrome_histogram_pattern = """<histogram-configuration> |
| |
| <histograms> |
| |
| <histogram name="Histogram.Name" units="units" {}> |
| <owner>SomeOne@google.com</owner> |
| <summary>Summary</summary> |
| </histogram> |
| |
| </histograms> |
| |
| </histogram-configuration> |
| """ |
| chrome_histogram_correct_expiry_date = chrome_histogram_pattern.format( |
| 'expires_after="2211-11-22"') |
| _, had_errors = extract_histograms.ExtractHistogramsFromDom( |
| xml.dom.minidom.parseString(chrome_histogram_correct_expiry_date)) |
| self.assertFalse(had_errors) |
| |
| chrome_histogram_wrong_expiry_date_format = chrome_histogram_pattern.format( |
| 'expires_after="2211/11/22"') |
| _, had_errors = extract_histograms.ExtractHistogramsFromDom( |
| xml.dom.minidom.parseString(chrome_histogram_wrong_expiry_date_format)) |
| self.assertTrue(had_errors) |
| |
| chrome_histogram_wrong_expiry_date_value = chrome_histogram_pattern.format( |
| 'expires_after="2211-22-11"') |
| _, had_errors = extract_histograms.ExtractHistogramsFromDom( |
| xml.dom.minidom.parseString(chrome_histogram_wrong_expiry_date_value)) |
| self.assertTrue(had_errors) |
| |
| chrome_histogram_correct_expiry_milestone = chrome_histogram_pattern.format( |
| 'expires_after="M22"') |
| _, had_errors = extract_histograms.ExtractHistogramsFromDom( |
| xml.dom.minidom.parseString(chrome_histogram_correct_expiry_milestone)) |
| self.assertFalse(had_errors) |
| |
| chrome_histogram_wrong_expiry_milestone = chrome_histogram_pattern.format( |
| 'expires_after="22"') |
| _, had_errors = extract_histograms.ExtractHistogramsFromDom( |
| xml.dom.minidom.parseString(chrome_histogram_wrong_expiry_milestone)) |
| self.assertTrue(had_errors) |
| |
| chrome_histogram_wrong_expiry_milestone = chrome_histogram_pattern.format( |
| 'expires_after="MM22"') |
| _, had_errors = extract_histograms.ExtractHistogramsFromDom( |
| xml.dom.minidom.parseString(chrome_histogram_wrong_expiry_milestone)) |
| self.assertTrue(had_errors) |
| |
| chrome_histogram_no_expiry = chrome_histogram_pattern.format('') |
| _, had_errors = extract_histograms.ExtractHistogramsFromDom( |
| xml.dom.minidom.parseString(chrome_histogram_no_expiry)) |
| self.assertTrue(had_errors) |
| |
| def testExpiryDateExtraction(self): |
| chrome_histogram_pattern = """<histogram-configuration> |
| |
| <histograms> |
| |
| <histogram name="Histogram.Name" units="units" {}> |
| <owner>SomeOne@google.com</owner> |
| <summary>Summary</summary> |
| </histogram> |
| |
| </histograms> |
| |
| </histogram-configuration> |
| """ |
| date_str = '2211-11-22' |
| chrome_histogram_correct_expiry_date = chrome_histogram_pattern.format( |
| 'expires_after="{}"'.format(date_str)) |
| histograms, _ = extract_histograms.ExtractHistogramsFromDom( |
| xml.dom.minidom.parseString(chrome_histogram_correct_expiry_date)) |
| histogram_content = histograms['Histogram.Name'] |
| self.assertIn('expires_after', histogram_content) |
| self.assertEqual(date_str, histogram_content['expires_after']) |
| |
| milestone_str = 'M22' |
| chrome_histogram_correct_expiry_milestone = chrome_histogram_pattern.format( |
| 'expires_after="{}"'.format(milestone_str)) |
| histograms, _ = extract_histograms.ExtractHistogramsFromDom( |
| xml.dom.minidom.parseString(chrome_histogram_correct_expiry_milestone)) |
| histogram_content = histograms['Histogram.Name'] |
| self.assertIn('expires_after', histogram_content) |
| self.assertEqual(milestone_str, histogram_content['expires_after']) |
| |
| chrome_histogram_no_expiry = chrome_histogram_pattern.format('') |
| histograms, _ = extract_histograms.ExtractHistogramsFromDom( |
| xml.dom.minidom.parseString(chrome_histogram_no_expiry)) |
| histogram_content = histograms['Histogram.Name'] |
| self.assertNotIn('expires_after', histogram_content) |
| |
| def testMultiParagraphSummary(self): |
| multiple_paragraph_pattern = xml.dom.minidom.parseString(""" |
| <histogram-configuration> |
| <histograms> |
| <histogram name="MultiParagraphTest.Test1" units="units" |
| expires_after="2019-01-01"> |
| <owner>chrome-metrics-team@google.com</owner> |
| <summary> |
| Sample description |
| Sample description. |
| </summary> |
| </histogram> |
| |
| <histogram name="MultiParagraphTest.Test2" units="units" |
| expires_after="2019-01-01"> |
| <owner>chrome-metrics-team@google.com</owner> |
| <summary> |
| Multi-paragraph sample description UI>Browser. |
| Words. |
| |
| Still multi-paragraph sample description. |
| |
| <!--Comments are allowed.--> |
| |
| Here. |
| </summary> |
| </histogram> |
| </histograms> |
| </histogram-configuration> |
| """) |
| histograms, _ = extract_histograms._ExtractHistogramsFromXmlTree( |
| multiple_paragraph_pattern, {}) |
| self.assertEqual(histograms['MultiParagraphTest.Test1']['summary'], |
| 'Sample description Sample description.') |
| self.assertEqual( |
| histograms['MultiParagraphTest.Test2']['summary'], |
| 'Multi-paragraph sample description UI>Browser. Words.\n\n' |
| 'Still multi-paragraph sample description.\n\nHere.') |
| |
| def testComponentExtraction(self): |
| """Checks that components are successfully extracted from histograms.""" |
| histogram = xml.dom.minidom.parseString(""" |
| <histogram-configuration> |
| <histograms> |
| <histogram name="Coffee" expires_after="2022-01-01"> |
| <owner>histogram_owner@google.com</owner> |
| <summary>An ode to coffee.</summary> |
| <component>Liquid>Hot</component> |
| <component>Caffeine</component> |
| </histogram> |
| </histograms> |
| |
| <histogram_suffixes_list> |
| <histogram_suffixes name="Brand" separator="."> |
| <suffix name="Dunkies" label="The coffee is from Dunkin."/> |
| <affected-histogram name="Coffee"/> |
| </histogram_suffixes> |
| </histogram_suffixes_list> |
| </histogram-configuration> |
| """) |
| histograms, _ = extract_histograms.ExtractHistogramsFromDom(histogram) |
| self.assertEqual(histograms['Coffee']['components'], |
| ['Liquid>Hot', 'Caffeine']) |
| self.assertEqual(histograms['Coffee.Dunkies']['components'], |
| ['Liquid>Hot', 'Caffeine']) |
| |
| def testNewHistogramWithoutSummary(self): |
| histogram_without_summary = xml.dom.minidom.parseString(""" |
| <histogram-configuration> |
| <histograms> |
| <histogram name="Test.Histogram" units="things" expires_after="2019-01-01"> |
| <owner>person@chromium.org</owner> |
| </histogram> |
| </histograms> |
| </histogram-configuration> |
| """) |
| _, have_errors = extract_histograms._ExtractHistogramsFromXmlTree( |
| histogram_without_summary, {}) |
| self.assertTrue(have_errors) |
| |
| def testNewHistogramWithEmptySummary(self): |
| histogram_with_empty_summary = xml.dom.minidom.parseString(""" |
| <histogram-configuration> |
| <histograms> |
| <histogram name="Test.Histogram" units="things" expires_after="2019-01-01"> |
| <owner>person@chromium.org</owner> |
| <summary/> |
| </histogram> |
| </histograms> |
| </histogram-configuration> |
| """) |
| _, have_errors = extract_histograms._ExtractHistogramsFromXmlTree( |
| histogram_with_empty_summary, {}) |
| self.assertTrue(have_errors) |
| |
| def testNewHistogramWithoutEnumOrUnit(self): |
| histogram_without_enum_or_unit = xml.dom.minidom.parseString(""" |
| <histogram-configuration> |
| <histograms> |
| <histogram name="Test.Histogram" expires_after="2019-01-01"> |
| <owner>chrome-metrics-team@google.com</owner> |
| <summary> This is a summary </summary> |
| </histogram> |
| </histograms> |
| </histogram-configuration> |
| """) |
| _, have_errors = extract_histograms._ExtractHistogramsFromXmlTree( |
| histogram_without_enum_or_unit, {}) |
| self.assertTrue(have_errors) |
| |
| def testNewHistogramWithEnumAndUnit(self): |
| histogram_with_enum_and_unit = xml.dom.minidom.parseString(""" |
| <histogram-configuration> |
| <histograms> |
| <histogram name="Test.Histogram" enum="MyEnumType" unit="things" |
| expires_after="2019-01-01"> |
| <owner>chrome-metrics-team@google.com</owner> |
| <summary> This is a summary </summary> |
| </histogram> |
| </histograms> |
| </histogram-configuration> |
| """) |
| _, have_errors = extract_histograms._ExtractHistogramsFromXmlTree( |
| histogram_with_enum_and_unit, {}) |
| self.assertTrue(have_errors) |
| |
| def testEmptyEnum(self): |
| empty_enum = xml.dom.minidom.parseString(""" |
| <histogram-configuration> |
| <enums> |
| <enum name="MyEnumType"> |
| <summary>This is an empty enum</summary> |
| </enum> |
| </enums> |
| </histogram-configuration> |
| """) |
| _, have_errors = extract_histograms.ExtractEnumsFromXmlTree(empty_enum) |
| self.assertTrue(have_errors) |
| |
| def testNewHistogramWithEnum(self): |
| histogram_with_enum = xml.dom.minidom.parseString(""" |
| <histogram-configuration> |
| <enums> |
| <enum name="MyEnumType"> |
| <summary>This is an example enum type</summary> |
| <int value="1" label="FIRST_VALUE">This is the first value.</int> |
| <int value="2" label="SECOND_VALUE">This is the second value.</int> |
| </enum> |
| </enums> |
| |
| <histograms> |
| <histogram name="Test.Histogram.Enum" enum="MyEnumType" |
| expires_after="2019-01-01"> |
| <owner>chrome-metrics-team@google.com</owner> |
| <summary> This is a summary </summary> |
| </histogram> |
| </histograms> |
| </histogram-configuration> |
| """) |
| _, have_errors = extract_histograms.ExtractHistogramsFromDom( |
| histogram_with_enum) |
| self.assertFalse(have_errors) |
| |
| def testEnumWithDuplicateValues(self): |
| bad_enum = xml.dom.minidom.parseString(""" |
| <histogram-configuration> |
| <enums> |
| <enum name="MyEnumType"> |
| <int value="1" label="FIRST_VALUE">This is the first value.</int> |
| <int value="1" label="SECOND_VALUE">This is the second value.</int> |
| </enum> |
| </enums> |
| </histogram-configuration> |
| """) |
| _, have_errors = extract_histograms.ExtractEnumsFromXmlTree(bad_enum) |
| self.assertTrue(have_errors) |
| |
| def testEnumWithDuplicateLabels(self): |
| bad_enum = xml.dom.minidom.parseString(""" |
| <histogram-configuration> |
| <enums> |
| <enum name="MyEnumType"> |
| <int value="1" label="FIRST_VALUE">This is the first value.</int> |
| <int value="2" label="FIRST_VALUE">This is the second value.</int> |
| </enum> |
| </enums> |
| </histogram-configuration> |
| """) |
| _, have_errors = extract_histograms.ExtractEnumsFromXmlTree(bad_enum) |
| self.assertTrue(have_errors) |
| |
| def testNewHistogramWithUnits(self): |
| histogram_with_units = xml.dom.minidom.parseString(""" |
| <histogram-configuration> |
| <histograms> |
| <histogram name="Test.Histogram" units="units" expires_after="2019-01-01"> |
| <owner>chrome-metrics-team@google.com</owner> |
| <summary> This is a summary </summary> |
| </histogram> |
| </histograms> |
| </histogram-configuration> |
| """) |
| _, have_errors = extract_histograms._ExtractHistogramsFromXmlTree( |
| histogram_with_units, {}) |
| self.assertFalse(have_errors) |
| |
| def testNewHistogramWithEmptyOwnerTag(self): |
| histogram_with_empty_owner_tag = xml.dom.minidom.parseString(""" |
| <histogram-configuration> |
| <histograms> |
| <histogram name="Test.Histogram" units="things" expires_after="2019-01-01"> |
| <owner></owner> |
| <summary> This is a summary </summary> |
| </histogram> |
| </histograms> |
| </histogram-configuration> |
| """) |
| _, have_errors = extract_histograms._ExtractHistogramsFromXmlTree( |
| histogram_with_empty_owner_tag, {}) |
| self.assertTrue(have_errors) |
| |
| def testNewHistogramWithoutOwnerTag(self): |
| histogram_without_owner_tag = xml.dom.minidom.parseString(""" |
| <histogram-configuration> |
| <histograms> |
| <histogram name="Test.Histogram" units="things" expires_after="2019-01-01"> |
| <summary> This is a summary </summary> |
| </histogram> |
| </histograms> |
| </histogram-configuration> |
| """) |
| _, have_errors = extract_histograms._ExtractHistogramsFromXmlTree( |
| histogram_without_owner_tag, {}) |
| self.assertTrue(have_errors) |
| |
| def testNewHistogramWithCommaSeparatedOwners(self): |
| histogram_with_comma_separated_owners = xml.dom.minidom.parseString(""" |
| <histogram-configuration> |
| <histograms> |
| <histogram name="Test.Histogram" units="things" expires_after="2019-01-01"> |
| <owner>cait@chromium.org, paul@chromium.org</owner> |
| <summary> This is a summary </summary> |
| </histogram> |
| </histograms> |
| </histogram-configuration> |
| """) |
| _, have_errors = extract_histograms._ExtractHistogramsFromXmlTree( |
| histogram_with_comma_separated_owners, {}) |
| self.assertTrue(have_errors) |
| |
| def testNewHistogramWithInvalidOwner(self): |
| histogram_with_invalid_owner = xml.dom.minidom.parseString(""" |
| <histogram-configuration> |
| <histograms> |
| <histogram name="Test.Histogram" units="things" expires_after="2019-01-01"> |
| <owner>sarah</owner> |
| <summary> This is a summary </summary> |
| </histogram> |
| </histograms> |
| </histogram-configuration> |
| """) |
| _, have_errors = extract_histograms._ExtractHistogramsFromXmlTree( |
| histogram_with_invalid_owner, {}) |
| self.assertTrue(have_errors) |
| |
| def testNewHistogramWithOwnerPlaceHolder(self): |
| histogram_with_owner_placeholder = xml.dom.minidom.parseString(""" |
| <histogram-configuration> |
| <histograms> |
| <histogram name="Test.Histogram" units="things" expires_after="2019-01-01"> |
| <owner> Please list the metric's owners. Add more owner tags as needed. |
| </owner> |
| <summary> |
| <!-- Comments are fine --> |
| This is a summary |
| <!-- Comments are fine --> |
| </summary> |
| </histogram> |
| </histograms> |
| </histogram-configuration> |
| """) |
| _, have_errors = extract_histograms._ExtractHistogramsFromXmlTree( |
| histogram_with_owner_placeholder, {}) |
| self.assertFalse(have_errors) |
| |
| def testHistogramWithEscapeCharacters(self): |
| histogram_with_owner_placeholder = xml.dom.minidom.parseString(""" |
| <histogram-configuration> |
| <histograms> |
| <histogram name="Test.Histogram" units="things" expires_after="2019-01-01"> |
| <owner> Please list the metric's owners. Add more owner tags as needed. |
| </owner> |
| <summary>This is a summary with & and " and '</summary> |
| </histogram> |
| </histograms> |
| </histogram-configuration> |
| """) |
| hists, have_errors = extract_histograms._ExtractHistogramsFromXmlTree( |
| histogram_with_owner_placeholder, {}) |
| self.assertFalse(have_errors) |
| self.assertIn('Test.Histogram', hists) |
| self.assertIn('summary', hists['Test.Histogram']) |
| self.assertEqual('This is a summary with & and " and \'', |
| hists['Test.Histogram']['summary']) |
| |
| def testNewSuffixWithoutLabel(self): |
| suffix_without_label = xml.dom.minidom.parseString(""" |
| <histogram-configuration> |
| <histogram_suffixes_list> |
| <histogram_suffixes name="Suffixes" separator="."> |
| <suffix base="true" name="BaseSuffix"/> |
| </histogram_suffixes> |
| </histogram_suffixes_list> |
| </histogram-configuration> |
| """) |
| _, have_errors = extract_histograms.ExtractHistogramsFromDom( |
| suffix_without_label) |
| self.assertTrue(have_errors) |
| |
| def testNewSuffixWithLabel(self): |
| suffix_with_label = xml.dom.minidom.parseString(""" |
| <histogram-configuration> |
| <histogram_suffixes_list> |
| <histogram_suffixes name="Suffixes" separator="."> |
| <suffix base="true" name="BaseSuffix" label="Base"/> |
| </histogram_suffixes> |
| </histogram_suffixes_list> |
| </histogram-configuration> |
| """) |
| have_errors = extract_histograms._UpdateHistogramsWithSuffixes( |
| suffix_with_label, {}) |
| self.assertFalse(have_errors) |
| |
| @parameterized.expand([ |
| ('InlineTokens', TEST_HISTOGRAM_WITH_TOKENS), |
| ('InlineTokenAndOutOfLineVariants', TEST_HISTOGRAM_WITH_VARIANTS), |
| ('MixedVariants', TEST_HISTOGRAM_WITH_MIXED_VARIANTS), |
| ]) |
| def testUpdateNameWithTokens(self, _, input_xml): |
| histogram_with_token = xml.dom.minidom.parseString(input_xml) |
| histograms_dict, _ = extract_histograms._ExtractHistogramsFromXmlTree( |
| histogram_with_token, {}) |
| histograms_dict, _ = extract_histograms._UpdateHistogramsWithTokens( |
| histograms_dict) |
| self.assertIn('HistogramName.red.small', histograms_dict) |
| self.assertIn('HistogramName.green.small', histograms_dict) |
| self.assertIn('HistogramName.red.medium', histograms_dict) |
| self.assertIn('HistogramName.green.medium', histograms_dict) |
| self.assertIn('HistogramName.red.large', histograms_dict) |
| self.assertIn('HistogramName.green.large', histograms_dict) |
| self.assertIn('HistogramName.red', histograms_dict) |
| self.assertIn('HistogramName.green', histograms_dict) |
| self.assertNotIn('HistogramName{Color}{Size}', histograms_dict) |
| |
| # Make sure generated histograms do not have tokens. |
| self.assertNotIn('tokens', histograms_dict['HistogramName.red.small']) |
| self.assertNotIn('tokens', histograms_dict['HistogramName.green.large']) |
| |
| @parameterized.expand([ |
| ('InlineTokens', TEST_HISTOGRAM_WITH_TOKENS), |
| ('InlineTokenAndOutOfLineVariants', TEST_HISTOGRAM_WITH_VARIANTS), |
| ('MixedVariants', TEST_HISTOGRAM_WITH_MIXED_VARIANTS), |
| ]) |
| def testUpdateSummaryWithTokens(self, _, input_xml): |
| histogram_with_token = xml.dom.minidom.parseString(input_xml) |
| histograms_dict, _ = extract_histograms._ExtractHistogramsFromXmlTree( |
| histogram_with_token, {}) |
| histograms_dict, _ = extract_histograms._UpdateHistogramsWithTokens( |
| histograms_dict) |
| # Use the variant's name to format the summary when the variant's summary |
| # attribute is omitted. |
| self.assertEqual( |
| 'This is a histogram for button of red color and small size.', |
| histograms_dict['HistogramName.red.small']['summary']) |
| self.assertEqual( |
| 'This is a histogram for button of green color and small size.', |
| histograms_dict['HistogramName.green.small']['summary']) |
| self.assertEqual( |
| 'This is a histogram for button of red color and medium size.', |
| histograms_dict['HistogramName.red.medium']['summary']) |
| self.assertEqual( |
| 'This is a histogram for button of green color and medium size.', |
| histograms_dict['HistogramName.green.medium']['summary']) |
| self.assertEqual( |
| 'This is a histogram for button of red color and large size.', |
| histograms_dict['HistogramName.red.large']['summary']) |
| self.assertEqual( |
| 'This is a histogram for button of green color and large size.', |
| histograms_dict['HistogramName.green.large']['summary']) |
| self.assertEqual( |
| 'This is a histogram for button of red color and all size.', |
| histograms_dict['HistogramName.red']['summary']) |
| self.assertEqual( |
| 'This is a histogram for button of green color and all size.', |
| histograms_dict['HistogramName.green']['summary']) |
| |
| @parameterized.expand([ |
| ('InlineTokens', TEST_HISTOGRAM_WITH_TOKENS), |
| ('InlineTokenAndOutOfLineVariants', TEST_HISTOGRAM_WITH_VARIANTS), |
| ('MixedVariants', TEST_HISTOGRAM_WITH_MIXED_VARIANTS), |
| ]) |
| def testUpdateWithTokenOwner(self, _, input_xml): |
| histogram_with_token = xml.dom.minidom.parseString(input_xml) |
| histograms_dict, _ = extract_histograms._ExtractHistogramsFromXmlTree( |
| histogram_with_token, {}) |
| histograms_dict, _ = extract_histograms._UpdateHistogramsWithTokens( |
| histograms_dict) |
| |
| self.assertEqual(['small@chromium.org'], |
| histograms_dict['HistogramName.red.small']['owners']) |
| self.assertEqual(['me@chromium.org'], |
| histograms_dict['HistogramName.red.medium']['owners']) |
| self.assertEqual(['me@chromium.org'], |
| histograms_dict['HistogramName.red.large']['owners']) |
| self.assertEqual(['me@chromium.org'], |
| histograms_dict['HistogramName.red']['owners']) |
| self.assertEqual(['green@chromium.org', 'small@chromium.org'], |
| histograms_dict['HistogramName.green.small']['owners']) |
| self.assertEqual(['green@chromium.org'], |
| histograms_dict['HistogramName.green.medium']['owners']) |
| self.assertEqual(['green@chromium.org'], |
| histograms_dict['HistogramName.green.large']['owners']) |
| self.assertEqual(['green@chromium.org'], |
| histograms_dict['HistogramName.green']['owners']) |
| |
| @parameterized.expand([ |
| ('InlineTokens', TEST_HISTOGRAM_WITH_TOKENS), |
| ('InlineTokenAndOutOfLineVariants', TEST_HISTOGRAM_WITH_VARIANTS), |
| ('MixedVariants', TEST_HISTOGRAM_WITH_MIXED_VARIANTS), |
| ]) |
| def testUpdateWithTokenObsolete(self, _, input_xml): |
| histogram_with_token = xml.dom.minidom.parseString(input_xml) |
| histograms_dict, _ = extract_histograms._ExtractHistogramsFromXmlTree( |
| histogram_with_token, {}) |
| histograms_dict, _ = extract_histograms._UpdateHistogramsWithTokens( |
| histograms_dict) |
| |
| # New histograms should inherit the obsolete reason of the last |
| # obsolete token by order of appearance. |
| self.assertEqual('Obsolete small', |
| histograms_dict['HistogramName.red.small']['obsolete']) |
| self.assertEqual('Obsolete red', |
| histograms_dict['HistogramName.red.medium']['obsolete']) |
| self.assertEqual('Obsolete red', |
| histograms_dict['HistogramName.red.large']['obsolete']) |
| self.assertEqual('Obsolete red', |
| histograms_dict['HistogramName.red']['obsolete']) |
| self.assertEqual('Obsolete small', |
| histograms_dict['HistogramName.green.small']['obsolete']) |
| self.assertNotIn('obsolete', histograms_dict['HistogramName.green.medium']) |
| self.assertNotIn('obsolete', histograms_dict['HistogramName.green.large']) |
| self.assertNotIn('obsolete', histograms_dict['HistogramName.green']) |
| |
| @parameterized.expand([ |
| ('InlineTokens', TEST_HISTOGRAM_TOKENS_DUPLICATE), |
| ('InlineTokenAndOutOfLineVariants', TEST_HISTOGRAM_VARIANTS_DUPLICATE), |
| ]) |
| def testUpdateNameDuplicateVariant(self, _, input_xml): |
| """Tests that if duplicate names are generated due to multiple tokens |
| having the same variant and empty string variant, an error is reported.""" |
| histogram_with_duplicate_variant = xml.dom.minidom.parseString(input_xml) |
| histograms_dict, _ = extract_histograms._ExtractHistogramsFromXmlTree( |
| histogram_with_duplicate_variant, {}) |
| _, have_errors = extract_histograms._UpdateHistogramsWithTokens( |
| histograms_dict) |
| self.assertTrue(have_errors) |
| |
| def testVariantsNotExists(self): |
| histogram_without_corresponding_variants = xml.dom.minidom.parseString(""" |
| <histogram-configuration> |
| <histograms> |
| <histogram name="Histogram{Color}{SizeNone}" units="things" |
| expires_after="2017-10-16"> |
| <owner>me@chromium.org</owner> |
| <summary> |
| This is a histogram for button of {Color} color and {SizeNone} size. |
| </summary> |
| <token key="Color"> |
| <variant name="" summary="all"/> |
| <variant name=".red" summary="red"/> |
| <variant name=".green" summary="green"/> |
| </token> |
| <token key="SizeNone" variants="HistogramNameSize"/> |
| </histogram> |
| </histograms> |
| </histogram-configuration> |
| """) |
| _, have_errors = extract_histograms._ExtractHistogramsFromXmlTree( |
| histogram_without_corresponding_variants, {}) |
| self.assertTrue(have_errors) |
| |
| def testSuffixCanExtendPatternedHistograms(self): |
| patterned_suffix = (""" |
| <histogram-configuration> |
| <histograms> |
| <histogram name="Test{Version}" units="things" |
| expires_after="2017-10-16"> |
| <owner>chrome-metrics-team@google.com</owner> |
| <summary> |
| Sample description. |
| </summary> |
| <token key="Version"> |
| <variant name=".First"/> |
| <variant name=".Last"/> |
| </token> |
| </histogram> |
| </histograms> |
| <histogram_suffixes_list> |
| <histogram_suffixes name="ExtendPatternedHist" separator="."> |
| <suffix name="Found" label="Extending patterned histograms."/> |
| <affected-histogram name="Test.First"/> |
| <affected-histogram name="Test.Last"/> |
| </histogram_suffixes> |
| </histogram_suffixes_list> |
| </histogram-configuration>""") |
| # Only when the histogram is first extended by the token, can the |
| # histogram_suffixes find those affected histograms. |
| histograms_dict, had_errors = extract_histograms.ExtractHistogramsFromDom( |
| xml.dom.minidom.parseString(patterned_suffix)) |
| self.assertFalse(had_errors) |
| self.assertIn('Test.First.Found', histograms_dict) |
| self.assertIn('Test.Last.Found', histograms_dict) |
| |
| def testExtractImprovementDirection(self): |
| histogram_name = 'Histogram.With.InterpretationTag' |
| config = """ |
| <histogram-configuration> |
| |
| <histograms> |
| |
| <histogram name="{histogram_name}" expires_after="M100" units="units"> |
| <owner>owner@chromium.org</owner> |
| {improvement_tag} |
| <summary>The improvement tag says a higher value is good!</summary> |
| </histogram> |
| |
| </histograms> |
| |
| </histogram-configuration>""" |
| |
| improvement_tag_good = '<improvement direction="HIGHER_IS_BETTER"/>' |
| improvement_tag_bad = '<improvement>HIGHER_IS_BETTER</improvement>' |
| |
| config_good = config.format(histogram_name=histogram_name, |
| improvement_tag=improvement_tag_good) |
| config_bad = config.format(histogram_name=histogram_name, |
| improvement_tag=improvement_tag_bad) |
| |
| histograms_dict, had_errors = extract_histograms.ExtractHistogramsFromDom( |
| xml.dom.minidom.parseString(config_good)) |
| self.assertFalse(had_errors) |
| self.assertIn(histogram_name, histograms_dict) |
| self.assertIn('improvement', histograms_dict[histogram_name]) |
| self.assertEqual( |
| histogram_configuration_model.IMPROVEMENT_DIRECTION_HIGHER_IS_BETTER, |
| histograms_dict[histogram_name]['improvement']) |
| |
| histograms_dict, had_errors = extract_histograms.ExtractHistogramsFromDom( |
| xml.dom.minidom.parseString(config_bad)) |
| self.assertTrue(had_errors) |
| self.assertNotIn('improvement', histograms_dict[histogram_name]) |
| |
| |
| if __name__ == "__main__": |
| logging.basicConfig(level=logging.ERROR + 1) |
| unittest.main() |
