mirror of
https://gerrit.googlesource.com/git-repo
synced 2026-11-14 16:27:13 +00:00
Align with Google style guides and `import repo_logging` as a module rather than import symbols out of it. Change-Id: Ie13c1f13be00dbf6dd3814a8780baf6453972237 Reviewed-on: https://gerrit-review.googlesource.com/c/git-repo/+/647823 Tested-by: Mike Frysinger <vapier@google.com> Commit-Queue: Mike Frysinger <vapier@google.com> Reviewed-by: Brian Gan <brgan@google.com>
108 lines
3.2 KiB
Python
108 lines
3.2 KiB
Python
# Copyright (C) 2023 The Android Open Source Project
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
"""Unittests for the repo_logging.py module."""
|
|
|
|
import contextlib
|
|
import io
|
|
import logging
|
|
import re
|
|
from unittest import mock
|
|
|
|
import pytest
|
|
|
|
from color import SetDefaultColoring
|
|
import error
|
|
import repo_logging
|
|
|
|
|
|
@mock.patch.object(repo_logging.RepoLogger, "error")
|
|
def test_log_aggregated_errors_logs_aggregated_errors(mock_error) -> None:
|
|
"""Test if log_aggregated_errors logs a list of aggregated errors."""
|
|
logger = repo_logging.RepoLogger(__name__)
|
|
logger.log_aggregated_errors(
|
|
error.RepoExitError(
|
|
aggregate_errors=[
|
|
Exception("foo"),
|
|
Exception("bar"),
|
|
Exception("baz"),
|
|
Exception("hello"),
|
|
Exception("world"),
|
|
Exception("test"),
|
|
]
|
|
)
|
|
)
|
|
|
|
mock_error.assert_has_calls(
|
|
[
|
|
mock.call("=" * 80),
|
|
mock.call(
|
|
"Repo command failed due to the following `%s` errors:",
|
|
"RepoExitError",
|
|
),
|
|
mock.call("foo\nbar\nbaz\nhello\nworld"),
|
|
mock.call("+%d additional errors...", 1),
|
|
]
|
|
)
|
|
|
|
|
|
@mock.patch.object(repo_logging.RepoLogger, "error")
|
|
def test_log_aggregated_errors_logs_single_error(mock_error) -> None:
|
|
"""Test if log_aggregated_errors logs empty aggregated_errors."""
|
|
logger = repo_logging.RepoLogger(__name__)
|
|
logger.log_aggregated_errors(error.RepoExitError())
|
|
|
|
mock_error.assert_has_calls(
|
|
[
|
|
mock.call("=" * 80),
|
|
mock.call("Repo command failed: %s", "RepoExitError"),
|
|
]
|
|
)
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"level",
|
|
(
|
|
logging.INFO,
|
|
logging.WARN,
|
|
logging.ERROR,
|
|
),
|
|
)
|
|
def test_log_with_format_string(level: int) -> None:
|
|
"""Test different log levels with format strings."""
|
|
name = logging.getLevelName(level)
|
|
|
|
# Set color output to "always" for consistent test results.
|
|
# This ensures the logger's behavior is uniform across different
|
|
# environments and git configurations.
|
|
SetDefaultColoring("always")
|
|
|
|
# Regex pattern to match optional ANSI color codes.
|
|
# \033 - Escape character
|
|
# \[ - Opening square bracket
|
|
# [0-9;]* - Zero or more digits or semicolons
|
|
# m - Ending 'm' character
|
|
# ? - Makes the entire group optional
|
|
opt_color = r"(\033\[[0-9;]*m)?"
|
|
|
|
output = io.StringIO()
|
|
|
|
with contextlib.redirect_stderr(output):
|
|
logger = repo_logging.RepoLogger(__name__)
|
|
logger.log(level, "%s", "100% pass")
|
|
|
|
assert re.search(
|
|
f"^{opt_color}100% pass{opt_color}$", output.getvalue().strip()
|
|
), f"failed for level {name}"
|