mirror of
https://gerrit.googlesource.com/git-repo
synced 2024-12-21 07:16:21 +00:00
febe73ff16
Testing: - Unit tests - Verified git trace log has "evt": "2" (vs "evt": 2 previously) Bug: https://crbug.com/gerrit/13966 Change-Id: I2e0c98dda0cccdd5cb6328105c11b93cd42676eb Reviewed-on: https://gerrit-review.googlesource.com/c/git-repo/+/294123 Reviewed-by: Jonathan Nieder <jrn@google.com> Tested-by: Ian Kasprzak <iankaz@google.com>
189 lines
7.0 KiB
Python
189 lines
7.0 KiB
Python
# Copyright (C) 2020 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 git_trace2_event_log.py module."""
|
|
|
|
import json
|
|
import os
|
|
import tempfile
|
|
import unittest
|
|
from unittest import mock
|
|
|
|
import git_trace2_event_log
|
|
|
|
|
|
class EventLogTestCase(unittest.TestCase):
|
|
"""TestCase for the EventLog module."""
|
|
|
|
PARENT_SID_KEY = 'GIT_TRACE2_PARENT_SID'
|
|
PARENT_SID_VALUE = 'parent_sid'
|
|
SELF_SID_REGEX = r'repo-\d+T\d+Z-.*'
|
|
FULL_SID_REGEX = r'^%s/%s' % (PARENT_SID_VALUE, SELF_SID_REGEX)
|
|
|
|
def setUp(self):
|
|
"""Load the event_log module every time."""
|
|
self._event_log_module = None
|
|
# By default we initialize with the expected case where
|
|
# repo launches us (so GIT_TRACE2_PARENT_SID is set).
|
|
env = {
|
|
self.PARENT_SID_KEY: self.PARENT_SID_VALUE,
|
|
}
|
|
self._event_log_module = git_trace2_event_log.EventLog(env=env)
|
|
self._log_data = None
|
|
|
|
def verifyCommonKeys(self, log_entry, expected_event_name, full_sid=True):
|
|
"""Helper function to verify common event log keys."""
|
|
self.assertIn('event', log_entry)
|
|
self.assertIn('sid', log_entry)
|
|
self.assertIn('thread', log_entry)
|
|
self.assertIn('time', log_entry)
|
|
|
|
# Do basic data format validation.
|
|
self.assertEqual(expected_event_name, log_entry['event'])
|
|
if full_sid:
|
|
self.assertRegex(log_entry['sid'], self.FULL_SID_REGEX)
|
|
else:
|
|
self.assertRegex(log_entry['sid'], self.SELF_SID_REGEX)
|
|
self.assertRegex(log_entry['time'], r'^\d+-\d+-\d+T\d+:\d+:\d+\.\d+Z$')
|
|
|
|
def readLog(self, log_path):
|
|
"""Helper function to read log data into a list."""
|
|
log_data = []
|
|
with open(log_path, mode='rb') as f:
|
|
for line in f:
|
|
log_data.append(json.loads(line))
|
|
return log_data
|
|
|
|
def test_initial_state_with_parent_sid(self):
|
|
"""Test initial state when 'GIT_TRACE2_PARENT_SID' is set by parent."""
|
|
self.assertRegex(self._event_log_module.full_sid, self.FULL_SID_REGEX)
|
|
|
|
def test_initial_state_no_parent_sid(self):
|
|
"""Test initial state when 'GIT_TRACE2_PARENT_SID' is not set."""
|
|
# Setup an empty environment dict (no parent sid).
|
|
self._event_log_module = git_trace2_event_log.EventLog(env={})
|
|
self.assertRegex(self._event_log_module.full_sid, self.SELF_SID_REGEX)
|
|
|
|
def test_version_event(self):
|
|
"""Test 'version' event data is valid.
|
|
|
|
Verify that the 'version' event is written even when no other
|
|
events are addded.
|
|
|
|
Expected event log:
|
|
<version event>
|
|
"""
|
|
with tempfile.TemporaryDirectory(prefix='event_log_tests') as tempdir:
|
|
log_path = self._event_log_module.Write(path=tempdir)
|
|
self._log_data = self.readLog(log_path)
|
|
|
|
# A log with no added events should only have the version entry.
|
|
self.assertEqual(len(self._log_data), 1)
|
|
version_event = self._log_data[0]
|
|
self.verifyCommonKeys(version_event, expected_event_name='version')
|
|
# Check for 'version' event specific fields.
|
|
self.assertIn('evt', version_event)
|
|
self.assertIn('exe', version_event)
|
|
# Verify "evt" version field is a string.
|
|
self.assertIsInstance(version_event['evt'], str)
|
|
|
|
def test_start_event(self):
|
|
"""Test and validate 'start' event data is valid.
|
|
|
|
Expected event log:
|
|
<version event>
|
|
<start event>
|
|
"""
|
|
self._event_log_module.StartEvent()
|
|
with tempfile.TemporaryDirectory(prefix='event_log_tests') as tempdir:
|
|
log_path = self._event_log_module.Write(path=tempdir)
|
|
self._log_data = self.readLog(log_path)
|
|
|
|
self.assertEqual(len(self._log_data), 2)
|
|
start_event = self._log_data[1]
|
|
self.verifyCommonKeys(self._log_data[0], expected_event_name='version')
|
|
self.verifyCommonKeys(start_event, expected_event_name='start')
|
|
# Check for 'start' event specific fields.
|
|
self.assertIn('argv', start_event)
|
|
self.assertTrue(isinstance(start_event['argv'], list))
|
|
|
|
def test_exit_event_result_none(self):
|
|
"""Test 'exit' event data is valid when result is None.
|
|
|
|
We expect None result to be converted to 0 in the exit event data.
|
|
|
|
Expected event log:
|
|
<version event>
|
|
<exit event>
|
|
"""
|
|
self._event_log_module.ExitEvent(None)
|
|
with tempfile.TemporaryDirectory(prefix='event_log_tests') as tempdir:
|
|
log_path = self._event_log_module.Write(path=tempdir)
|
|
self._log_data = self.readLog(log_path)
|
|
|
|
self.assertEqual(len(self._log_data), 2)
|
|
exit_event = self._log_data[1]
|
|
self.verifyCommonKeys(self._log_data[0], expected_event_name='version')
|
|
self.verifyCommonKeys(exit_event, expected_event_name='exit')
|
|
# Check for 'exit' event specific fields.
|
|
self.assertIn('code', exit_event)
|
|
# 'None' result should convert to 0 (successful) return code.
|
|
self.assertEqual(exit_event['code'], 0)
|
|
|
|
def test_exit_event_result_integer(self):
|
|
"""Test 'exit' event data is valid when result is an integer.
|
|
|
|
Expected event log:
|
|
<version event>
|
|
<exit event>
|
|
"""
|
|
self._event_log_module.ExitEvent(2)
|
|
with tempfile.TemporaryDirectory(prefix='event_log_tests') as tempdir:
|
|
log_path = self._event_log_module.Write(path=tempdir)
|
|
self._log_data = self.readLog(log_path)
|
|
|
|
self.assertEqual(len(self._log_data), 2)
|
|
exit_event = self._log_data[1]
|
|
self.verifyCommonKeys(self._log_data[0], expected_event_name='version')
|
|
self.verifyCommonKeys(exit_event, expected_event_name='exit')
|
|
# Check for 'exit' event specific fields.
|
|
self.assertIn('code', exit_event)
|
|
self.assertEqual(exit_event['code'], 2)
|
|
|
|
def test_write_with_filename(self):
|
|
"""Test Write() with a path to a file exits with None."""
|
|
self.assertIsNone(self._event_log_module.Write(path='path/to/file'))
|
|
|
|
def test_write_with_git_config(self):
|
|
"""Test Write() uses the git config path when 'git config' call succeeds."""
|
|
with tempfile.TemporaryDirectory(prefix='event_log_tests') as tempdir:
|
|
with mock.patch.object(self._event_log_module,
|
|
'_GetEventTargetPath', return_value=tempdir):
|
|
self.assertEqual(os.path.dirname(self._event_log_module.Write()), tempdir)
|
|
|
|
def test_write_no_git_config(self):
|
|
"""Test Write() with no git config variable present exits with None."""
|
|
with mock.patch.object(self._event_log_module,
|
|
'_GetEventTargetPath', return_value=None):
|
|
self.assertIsNone(self._event_log_module.Write())
|
|
|
|
def test_write_non_string(self):
|
|
"""Test Write() with non-string type for |path| throws TypeError."""
|
|
with self.assertRaises(TypeError):
|
|
self._event_log_module.Write(path=1234)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
unittest.main()
|