Merge pull request #91 from codecov/thiago/logging/adding-asctime-to-logging

Adding asctime to logging

Author: ThiagoCodecov

codecov_cli/helpers/logging_utils.py

@@ -34,10 +34,13 @@ class ColorFormatter(logging.Formatter):
     def format(self, record):
         if not record.exc_info:
             level = record.levelname.lower()
+            asctime = self.formatTime(record, self.datefmt)
             msg = record.getMessage()
             if level in self.colors:
-                prefix = click.style("{}: ".format(level), **self.colors[level])
-                msg = "\n".join(prefix + x for x in msg.splitlines())
+                prefix = click.style("{}".format(level), **self.colors[level])
+                msg = "\n".join(
+                    f"{prefix} - {asctime} -- {x}" for x in msg.splitlines()
+                )
             if hasattr(record, "extra_log_attributes"):
                 msg += " --- " + json.dumps(
                     record.extra_log_attributes, cls=JsonEncoder

tests/plugins/test_xcode.py

@@ -4,6 +4,7 @@
 import pytest
 
 from codecov_cli.plugins.xcode import XcodePlugin
+from tests.test_helpers import parse_outstreams_into_log_lines
 
 
 class TestXcode(object):
@@ -24,10 +25,10 @@ def test_no_swift_data_found(self, mocker, tmp_path, capsys, use_verbose_option)
         xcode_plugin = XcodePlugin(derived_data_folder=tmp_path).run_preparation(
             collector=None
         )
-        output = capsys.readouterr().err.splitlines()
+        output = parse_outstreams_into_log_lines(capsys.readouterr().err)
         assert xcode_plugin is None
-        assert f"debug: DerivedData folder: {tmp_path}" in output
-        assert "warning: No swift data found." in output
+        assert ("debug", f"DerivedData folder: {tmp_path}") in output
+        assert ("warning", "No swift data found.") in output
 
     def test_run_preparation_xcrun_not_installed(self, mocker, tmp_path, capsys):
         self.act_like_xcrun_is_not_installed(mocker)
@@ -43,11 +44,12 @@ def test_swift_data_found(self, mocker, tmp_path, capsys):
         dir.mkdir()
         (dir / "cov_data.profdata").touch()
         XcodePlugin(derived_data_folder=tmp_path).run_preparation(collector=None)
-        output = capsys.readouterr().err.splitlines()
+        output = parse_outstreams_into_log_lines(capsys.readouterr().err)
         expected = (
-            'info: Running swift coverage on the following list of files: --- {"matched_paths": ["'
+            "info",
+            'Running swift coverage on the following list of files: --- {"matched_paths": ["'
             + f"{dir}/cov_data.profdata"
-            + '"]}'
+            + '"]}',
         )
         assert expected in output
 

tests/test_commit.py

@@ -4,6 +4,7 @@
 
 from codecov_cli.services.commit import create_commit_logic, send_commit_data
 from codecov_cli.types import RequestError, RequestResult, RequestResultWarning
+from tests.test_helpers import parse_outstreams_into_log_lines
 
 
 def test_commit_command_with_warnings(mocker):
@@ -28,10 +29,10 @@ def test_commit_command_with_warnings(mocker):
             service="service",
         )
 
-    out_bytes = outstreams[0].getvalue().decode().splitlines()
+    out_bytes = parse_outstreams_into_log_lines(outstreams[0].getvalue())
     assert out_bytes == [
-        "info: Commit creating process had 1 warning",
-        "warning: Warning 1: somewarningmessage",
+        ("info", "Commit creating process had 1 warning"),
+        ("warning", "Warning 1: somewarningmessage"),
     ]
     assert res == mock_send_commit_data.return_value
     mock_send_commit_data.assert_called_with(
@@ -71,8 +72,8 @@ def test_commit_command_with_error(mocker):
             service="service",
         )
 
-    out_bytes = outstreams[0].getvalue().decode().splitlines()
-    assert out_bytes == ["error: Commit creating failed: Permission denied"]
+    out_bytes = parse_outstreams_into_log_lines(outstreams[0].getvalue())
+    assert out_bytes == [("error", "Commit creating failed: Permission denied")]
     assert res == mock_send_commit_data.return_value
     mock_send_commit_data.assert_called_with(
         commit_sha="commit_sha",

tests/test_do-upload_command.py

@@ -3,6 +3,7 @@
 from codecov_cli.main import cli
 from codecov_cli.services.legacy_upload import UploadSender
 from codecov_cli.types import RequestError, RequestResult
+from tests.test_helpers import parse_outstreams_into_log_lines
 
 
 def test_upload_missing_commit_sha(mocker):
@@ -34,5 +35,7 @@ def test_upload_raise_Z_option(mocker):
         cli, ["do-upload", "--fail-on-error", "--use-new-uploader=True"], obj={}
     )
     upload_sender.assert_called
-    assert "error: Upload failed: Unauthorized" in result.output.splitlines()
+    assert ("error", "Upload failed: Unauthorized") in parse_outstreams_into_log_lines(
+        result.output
+    )
     assert str(result) == "<Result SystemExit(1)>"

tests/test_helpers.py

@@ -0,0 +1,11 @@
+def parse_outstreams_into_log_lines(this_data):
+    return list(do_parse_outstreams_into_log_lines(this_data))
+
+
+def do_parse_outstreams_into_log_lines(this_data):
+    if isinstance(this_data, bytes):
+        this_data = this_data.decode()
+    for x in this_data.splitlines():
+        prefix_and_asctime, content = x.split(" -- ", 1)
+        prefix, asctime = prefix_and_asctime.split(" - ")
+        yield (prefix, content)

tests/test_report.py

@@ -4,6 +4,7 @@
 
 from codecov_cli.services.report import create_report_logic, send_create_report_request
 from codecov_cli.types import RequestError, RequestResult, RequestResultWarning
+from tests.test_helpers import parse_outstreams_into_log_lines
 
 
 def test_send_create_report_request_200(mocker):
@@ -55,10 +56,10 @@ def test_create_report_command_with_warnings(mocker):
             token="token",
         )
 
-    out_bytes = outstreams[0].getvalue().decode().splitlines()
+    out_bytes = parse_outstreams_into_log_lines(outstreams[0].getvalue())
     assert out_bytes == [
-        "info: Report creating process had 1 warning",
-        "warning: Warning 1: somewarningmessage",
+        ("info", "Report creating process had 1 warning"),
+        ("warning", "Warning 1: somewarningmessage"),
     ]
     assert res == RequestResult(
         error=None,
@@ -99,8 +100,8 @@ def test_create_report_command_with_error(mocker):
             token="token",
         )
 
-    out_bytes = outstreams[0].getvalue().decode().splitlines()
-    assert out_bytes == ["error: Report creating failed: Permission denied"]
+    out_bytes = parse_outstreams_into_log_lines(outstreams[0].getvalue())
+    assert out_bytes == [("error", "Report creating failed: Permission denied")]
     assert res == RequestResult(
         error=RequestError(
             code="HTTP Error 403",

tests/test_report_results.py

@@ -9,6 +9,7 @@
     send_reports_result_request,
 )
 from codecov_cli.types import RequestError, RequestResult, RequestResultWarning
+from tests.test_helpers import parse_outstreams_into_log_lines
 
 
 def test_report_results_command_with_warnings(mocker):
@@ -31,11 +32,12 @@ def test_report_results_command_with_warnings(mocker):
             token="token",
         )
 
-    out_bytes = outstreams[0].getvalue().decode().splitlines()
+    out_bytes = parse_outstreams_into_log_lines(outstreams[0].getvalue())
     assert out_bytes == [
-        "info: Report results creating process had 1 warning",
-        "warning: Warning 1: somewarningmessage",
+        ("info", "Report results creating process had 1 warning"),
+        ("warning", "Warning 1: somewarningmessage"),
     ]
+
     assert res == mock_send_reports_result_request.return_value
     mock_send_reports_result_request.assert_called_with(
         commit_sha="commit_sha",
@@ -70,8 +72,8 @@ def test_report_results_command_with_error(mocker):
             token="token",
         )
 
-    out_bytes = outstreams[0].getvalue().decode().splitlines()
-    assert out_bytes == ["error: Report results creating failed: Permission denied"]
+    out_bytes = parse_outstreams_into_log_lines(outstreams[0].getvalue())
+    assert out_bytes == [("error", "Report results creating failed: Permission denied")]
     assert res == mock_send_reports_result_request.return_value
     mock_send_reports_result_request.assert_called_with(
         commit_sha="commit_sha",
@@ -125,18 +127,19 @@ def test_get_report_results_200_completed(mocker, capsys):
     res = send_reports_result_get_request(
         "commit_sha", "report_code", "encoded_slug", "service", token
     )
-    output = capsys.readouterr().err.splitlines()
+    output = parse_outstreams_into_log_lines(capsys.readouterr().err)
     assert res.error is None
     assert res.warnings == []
     mocked_response.assert_called_once()
     assert (
-        'info: Finished processing report results --- {"state": "failure", "message": "33.33% of diff hit (target 77.77%)"}'
-        in output
-    )
+        "info",
+        'Finished processing report results --- {"state": "failure", "message": "33.33% of diff hit (target 77.77%)"}',
+    ) in output
 
 
 @patch("codecov_cli.services.report.MAX_NUMBER_TRIES", 1)
 def test_get_report_results_200_pending(mocker, capsys):
+    mocker.patch("codecov_cli.services.report.time.sleep")
     mocked_response = mocker.patch(
         "codecov_cli.services.report.requests.get",
         return_value=mocker.MagicMock(
@@ -147,11 +150,11 @@ def test_get_report_results_200_pending(mocker, capsys):
     res = send_reports_result_get_request(
         "commit_sha", "report_code", "encoded_slug", "service", token
     )
-    output = capsys.readouterr().err.splitlines()
+    output = parse_outstreams_into_log_lines(capsys.readouterr().err)
     assert res.error is None
     assert res.warnings == []
     mocked_response.assert_called_once()
-    assert "info: Report with the given code is still being processed." in output
+    assert ("info", "Report with the given code is still being processed.") in output
 
 
 def test_get_report_results_200_error(mocker, capsys):
@@ -165,14 +168,14 @@ def test_get_report_results_200_error(mocker, capsys):
     res = send_reports_result_get_request(
         "commit_sha", "report_code", "encoded_slug", "service", token
     )
-    output = capsys.readouterr().err.splitlines()
+    output = parse_outstreams_into_log_lines(capsys.readouterr().err)
     assert res.error is None
     assert res.warnings == []
     mocked_response.assert_called_once()
     assert (
-        'error: An error occured while processing the report. Please try again later. --- {"response_status_code": 200, "state": "error", "result": {}}'
-        in output
-    )
+        "error",
+        'An error occured while processing the report. Please try again later. --- {"response_status_code": 200, "state": "error", "result": {}}',
+    ) in output
 
 
 def test_get_report_results_200_undefined_state(mocker, capsys):
@@ -186,11 +189,11 @@ def test_get_report_results_200_undefined_state(mocker, capsys):
     res = send_reports_result_get_request(
         "commit_sha", "report_code", "encoded_slug", "service", token
     )
-    output = capsys.readouterr().err.splitlines()
+    output = parse_outstreams_into_log_lines(capsys.readouterr().err)
     assert res.error is None
     assert res.warnings == []
     mocked_response.assert_called_once()
-    assert "error: Please try again later." in output
+    assert ("error", "Please try again later.") in output
 
 
 def test_get_report_results_401(mocker, capsys):
@@ -204,14 +207,14 @@ def test_get_report_results_401(mocker, capsys):
     res = send_reports_result_get_request(
         "commit_sha", "report_code", "encoded_slug", "service", token
     )
-    output = capsys.readouterr().err.splitlines()
+    output = parse_outstreams_into_log_lines(capsys.readouterr().err)
     assert res.error == RequestError(
         code="HTTP Error 401",
         description='{"detail": "Invalid token."}',
         params={},
     )
     mocked_response.assert_called_once()
-    print(output)
     assert (
-        'error: Getting report results failed: {"detail": "Invalid token."}' in output
-    )
+        "error",
+        'Getting report results failed: {"detail": "Invalid token."}',
+    ) in output

tests/test_samples.py

@@ -26,7 +26,6 @@ def test_sample_analysis(input_filename, output_filename):
     with open(output_filename, "r") as file:
         expected_result = json.load(file)
     json_res = json.dumps(res.asdict())
-    print(json_res)
     res_dict = json.loads(json_res)
     assert sorted(res_dict["result"].keys()) == sorted(expected_result["result"].keys())
     res_dict["result"]["functions"] = sorted(

tests/test_upload_service.py

@@ -12,6 +12,7 @@
     UploadSendingResultWarning,
 )
 from codecov_cli.types import RequestResult
+from tests.test_helpers import parse_outstreams_into_log_lines
 
 
 def test_do_upload_logic_happy_path(mocker):
@@ -63,11 +64,12 @@ def test_do_upload_logic_happy_path(mocker):
             slug="slug",
             pull_request_number="pr",
         )
-    out_bytes = outstreams[0].getvalue().decode().splitlines()
+    out_bytes = parse_outstreams_into_log_lines(outstreams[0].getvalue())
     assert out_bytes == [
-        "info: Upload process had 1 warning",
-        "warning: Warning 1: somewarningmessage",
+        ("info", "Upload process had 1 warning"),
+        ("warning", "Warning 1: somewarningmessage"),
     ]
+
     assert res == LegacyUploadSender.send_upload_data.return_value
     mock_select_preparation_plugins.assert_called_with(
         cli_config, ["first_plugin", "another", "forth"]
@@ -139,7 +141,7 @@ def test_do_upload_logic_dry_run(mocker):
             pull_request_number="pr",
             dry_run=True,
         )
-    out_bytes = outstreams[0].getvalue().decode().splitlines()
+    out_bytes = parse_outstreams_into_log_lines(outstreams[0].getvalue())
     mock_select_coverage_file_finder.assert_called_with(None, None, None)
     mock_select_network_finder.assert_called_with(versioning_system)
     assert mock_generate_upload_data.call_count == 1
@@ -148,7 +150,7 @@ def test_do_upload_logic_dry_run(mocker):
         cli_config, ["first_plugin", "another", "forth"]
     )
     assert out_bytes == [
-        "info: dry-run option activated. NOT sending data to Codecov.",
+        ("info", "dry-run option activated. NOT sending data to Codecov.")
     ]
     assert res == RequestResult(
         error=None,
@@ -196,14 +198,17 @@ def test_do_upload_logic_verbose(mocker, use_verbose_option):
             pull_request_number="pr",
             dry_run=True,
         )
-    out_bytes = outstreams[0].getvalue().decode().splitlines()
+    out_bytes = parse_outstreams_into_log_lines(outstreams[0].getvalue())
     assert out_bytes == [
-        "debug: Selected uploader to use: <class "
-        "'codecov_cli.services.legacy_upload.upload_sender.LegacyUploadSender'>",
-        "info: dry-run option activated. NOT sending data to Codecov.",
-        'debug: Process Upload complete. --- {"result": "RequestResult(error=None, '
-        "warnings=None, status_code=200, text='Data NOT sent to Codecov because of "
-        "dry-run option')\"}",
+        (
+            "debug",
+            "Selected uploader to use: <class 'codecov_cli.services.legacy_upload.upload_sender.LegacyUploadSender'>",
+        ),
+        ("info", "dry-run option activated. NOT sending data to Codecov."),
+        (
+            "debug",
+            'Process Upload complete. --- {"result": "RequestResult(error=None, warnings=None, status_code=200, text=\'Data NOT sent to Codecov because of dry-run option\')"}',
+        ),
     ]
     assert res == RequestResult(
         error=None,