Tools/Scripts/webkitpy/tool/commands/commandtest.py

# Copyright (C) 2009 Google Inc. All rights reserved.
# Copyright (C) 2020 Apple Inc. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#    * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
#    * Redistributions in binary form must reproduce the above
# copyright notice, this list of conditions and the following disclaimer
# in the documentation and/or other materials provided with the
# distribution.
#    * Neither the name of Google Inc. nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

import logging

from webkitpy.common.webkitunittest import TestCase
from webkitpy.tool.mocktool import MockOptions, MockTool

from webkitcorepy import OutputCapture


class CommandsTest(TestCase):
    def assert_execute_outputs(self, command, args=[], expected_stdout="", expected_stderr="", expected_exception=None, expected_logs=None, options=MockOptions(), tool=MockTool()):
        options.blocks = None
        if getattr(options, "cc", None) == None:
            options.cc = 'MOCK cc'
        if getattr(options, "cc_radar", None) == None:
            options.cc_radar = False
        options.component = 'MOCK component'
        options.confirm = True
        options.email = 'MOCK email'
        options.git_commit = 'MOCK git commit'
        options.obsolete_patches = True
        options.open_bug = True
        options.port = 'MOCK port'
        options.update_changelogs = False
        options.quiet = True
        options.reviewer = 'MOCK reviewer'
        command.bind_to_tool(tool)

        with OutputCapture(level=logging.INFO) as captured:
            command.execute(options, args, tool)

        actual_stdout = self._remove_deprecated_warning(captured.stdout.getvalue())
        actual_stderr = self._remove_deprecated_warning(captured.stderr.getvalue())
        actual_logs = self._remove_deprecated_warning(captured.root.log.getvalue())

        self.assertEqual(actual_stdout, expected_stdout or '')
        self.assertEqual(actual_stderr, expected_stderr or '')
        self.assertEqual(actual_logs, expected_logs or '')

    def _remove_deprecated_warning(self, s):
        lines = s.splitlines(True)  # keepends=True (PY2 doesn't accept keyword form)
        return "".join(l for l in lines
                       if "currently deprecated due to believed non-use" not in l)