scripts/slave/unittests/runtest_annotator_test.py - Issue 548773004: Rename process_log_utils and related things.

Unified Diff: scripts/slave/unittests/runtest_annotator_test.py

Issue 548773004: Rename process_log_utils and related things. (Closed) Base URL: https://chromium.googlesource.com/chromium/tools/build.git@master

Patch Set: Created 6 years, 3 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View side-by-side diff with in-line comments

Download patch

Index: scripts/slave/unittests/runtest_annotator_test.py

diff --git a/scripts/slave/unittests/runtest_annotator_test.py b/scripts/slave/unittests/runtest_annotator_test.py

deleted file mode 100755

index 6ebc8b7c9635b0be23329ebe0f45432ffe143e31..0000000000000000000000000000000000000000

--- a/scripts/slave/unittests/runtest_annotator_test.py

+++ /dev/null

@@ -1,379 +0,0 @@

-#!/usr/bin/env python

ghost stip (do not use) 2014/09/09 21:45:22 we finally renamed this file :)

-# Use of this source code is governed by a BSD-style license that can be

-# found in the LICENSE file.

-"""Unit tests for annotated log parsers (aka log processors) used by runtest.py.

-The classes tested here reside in process_log_utils.py.

-The script runtest.py has the option to parse test output locally and send

-results to the master via annotator steps. This file tests those parsers.

-"""

-import json

-import os

-import unittest

-import test_env # pylint: disable=W0403,W0611

-from slave import process_log_utils

-# These should be the same as the constants used in process_log_utils.

-# See: http://docs.buildbot.net/current/developer/results.html

-SUCCESS, WARNINGS, FAILURE, SKIPPED, EXCEPTION, RETRY = range(6)

-# Custom percentile numbers to use in the tests below.

-TEST_PERCENTILES = [.05, .3, .8]

-class LogProcessorTest(unittest.TestCase):

- """Base class for log processor unit tests. Contains common operations."""

- def setUp(self):

- """Set up for all test method of each test method below."""

- super(LogProcessorTest, self).setUp()

- self._revision = 12345

- self._webkit_revision = 67890

- def _ConstructDefaultProcessor(

- self, log_processor_class, factory_properties=None,

- perf_expectations_path=None):

- """Creates a log processor instance.

- Args:

- log_processor_class: A sub-class of PerformanceLogProcessor.

- factory_properties: A dictionary of properties (optional).

- perf_expectations_path: Expectations file path (optional).

- Returns:

- An instance of the given log processor class.

- """

- factory_properties = factory_properties or {}

- factory_properties['perf_filename'] = perf_expectations_path

- factory_properties['perf_name'] = 'test-system'

- factory_properties['test_name'] = 'test-name'

- processor = log_processor_class(

- revision=self._revision, build_properties={},

- factory_properties=factory_properties,

- webkit_revision=self._webkit_revision)

- # Set custom percentiles. This will be used by GraphingLogProcessor, which

- # has and uses a private member attribute called _percentiles.

- if hasattr(processor, '_percentiles'):

- processor._percentiles = TEST_PERCENTILES

- return processor

- def _ProcessLog(self, log_processor, logfile): # pylint: disable=R0201

- """Reads in a input log file and processes it.

- This changes the state of the log processor object; the output is stored

- in the object and can be gotten using the PerformanceLogs() method.

- Args:

- log_processor: An PerformanceLogProcessor instance.

- logfile: File name of an input performance results log file.

- """

- for line in open(os.path.join(test_env.DATA_PATH, logfile)):

- log_processor.ProcessLine(line)

- def _CheckFileExistsWithData(self, logs, targetfile):

- """Asserts that |targetfile| exists in the |logs| dict and is non-empty."""

- self.assertTrue(targetfile in logs, 'File %s was not output.' % targetfile)

- self.assertTrue(logs[targetfile], 'File %s did not contain data.' %

- targetfile)

- def _ConstructParseAndCheckLogfiles(

- self, inputfiles, logfiles, log_processor_class, *args, **kwargs):

- """Uses a log processor to process the given input files.

- Args:

- inputfiles: A list of input performance results log file names.

- logfiles: List of expected output ".dat" file names.

- log_processor_class: The log processor class to use.

- Returns:

- A dictionary mapping output file name to output file lines.

- """

- parser = self._ConstructDefaultProcessor(

- log_processor_class, *args, **kwargs)

- for inputfile in inputfiles:

- self._ProcessLog(parser, inputfile)

- logs = parser.PerformanceLogs()

- for logfile in logfiles:

- self._CheckFileExistsWithData(logs, logfile)

- return logs

- def _ConstructParseAndCheckJSON(

- self, inputfiles, logfiles, subdir, log_processor_class, *args, **kwargs):

- """Processes input with a log processor and checks against expectations.

- Args:

- inputfiles: A list of input performance result log file names.

- logfiles: A list of expected output ".dat" file names.

- subdir: Subdirectory containing expected output files.

- log_processor_class: A log processor class.

- """

- logs = self._ConstructParseAndCheckLogfiles(

- inputfiles, logfiles, log_processor_class, *args, **kwargs)

- for filename in logfiles:

- actual = json.loads('\n'.join(logs[filename]))

- if subdir:

- path = os.path.join(test_env.DATA_PATH, subdir, filename)

- else:

- path = os.path.join(test_env.DATA_PATH, filename)

- expected = json.load(open(path))

- self.assertEqual(expected, actual, 'JSON data in %s did not match '

- 'expectations.' % filename)

-class GraphingLogProcessorTest(LogProcessorTest):

- """Test case for basic functionality of GraphingLogProcessor class."""

- def testSummary(self):

- """Tests the output of "summary" files, which contain per-graph data."""

- input_files = ['graphing_processor.log']

- output_files = ['%s-summary.dat' % graph for graph in ('commit_charge',

- 'ws_final_total', 'vm_final_browser', 'vm_final_total',

- 'ws_final_browser', 'processes', 'artificial_graph')]

- self._ConstructParseAndCheckJSON(input_files, output_files, None,

- process_log_utils.GraphingLogProcessor)

- def testGraphList(self):

- """Tests the output of "graphs.dat" files, which contains a graph list."""

- input_files = ['graphing_processor.log']

- graphfile = 'graphs.dat'

- output_files = [graphfile]

- logs = self._ConstructParseAndCheckLogfiles(input_files, output_files,

- process_log_utils.GraphingLogProcessor)

- actual = json.loads('\n'.join(logs[graphfile]))

- expected = json.load(open(

- os.path.join(test_env.DATA_PATH, 'graphing_processor-graphs.dat')))

- self.assertEqual(len(actual), len(expected))

- for graph in expected:

- self.assertTrue(graph['name'] in actual)

- for element in graph:

- self.assertEqual(actual[graph['name']][element], graph[element])

- def testHistogramGeometricMeanAndStandardDeviation(self):

- input_files = ['graphing_processor.log']

- summary_file = 'hist1-summary.dat'

- output_files = [summary_file]

- logs = self._ConstructParseAndCheckLogfiles(input_files, output_files,

- process_log_utils.GraphingLogProcessor)

- actual = json.loads('\n'.join(logs[summary_file]))

- expected = json.load(open(

- os.path.join(test_env.DATA_PATH, summary_file)))

- self.assertEqual(actual, expected, 'Filename %s did not contain expected '

- 'data.' % summary_file)

- def testHistogramPercentiles(self):

- input_files = ['graphing_processor.log']

- summary_files = ['hist1_%s-summary.dat' % str(p) for p in TEST_PERCENTILES]

- output_files = summary_files

- logs = self._ConstructParseAndCheckLogfiles(input_files, output_files,

- process_log_utils.GraphingLogProcessor)

- for filename in output_files:

- actual = json.loads('\n'.join(logs[filename]))

- expected = json.load(open(os.path.join(test_env.DATA_PATH, filename)))

- self.assertEqual(actual, expected, 'Filename %s did not contain expected '

- 'data.' % filename)

-class GraphingLogProcessorPerfTest(LogProcessorTest):

- """Another test case for the GraphingLogProcessor class.

- The tests in this test case compare results against the contents of a

- perf expectations file.

- """

- def _TestPerfExpectations(self, perf_expectations_file):

- perf_expectations_path = os.path.join(

- test_env.DATA_PATH, perf_expectations_file)

- input_file = 'graphing_processor.log'

- graph_file = 'graphs.dat'

- parser = self._ConstructDefaultProcessor(

- process_log_utils.GraphingLogProcessor,

- factory_properties={'expectations': True, 'perf_id': 'tester'},

- perf_expectations_path=perf_expectations_path)

- self._ProcessLog(parser, input_file)

- actual = json.loads('\n'.join(parser.PerformanceLogs()[graph_file]))

- expected = json.load(open(

- os.path.join(test_env.DATA_PATH, 'graphing_processor-graphs.dat')))

- self.assertEqual(len(actual), len(expected))

- for graph in expected:

- self.assertTrue(graph['name'] in actual)

- for element in graph:

- self.assertEqual(actual[graph['name']][element], graph[element])

- return parser

- def testPerfExpectationsImproveRelative(self):

- step = self._TestPerfExpectations('perf_improve_relative.json')

- expected = ('PERF_IMPROVE: vm_final_browser/1t_vm_b (25.00%)')