diff --git a/tests/syslog/test_logrotate.py b/tests/syslog/test_logrotate.py new file mode 100644 index 00000000000..4d479c2b28e --- /dev/null +++ b/tests/syslog/test_logrotate.py @@ -0,0 +1,215 @@ +import logging +import pytest +import allure + +from tests.common.plugins.loganalyzer.loganalyzer import DisableLogrotateCronContext +from tests.common import config_reload + +logger = logging.getLogger(__name__) + +pytestmark = [ + pytest.mark.topology("any"), + pytest.mark.disable_loganalyzer +] + +LOG_FOLDER = '/var/log' +ROTATE_THRESHOLD_LARGE = '16M' +ROTATE_THRESHOLD_SMALL = '1024K' +SMALL_VAR_LOG_PARTITION_SIZE = '100M' + + +@pytest.fixture(scope='module', autouse=True) +def disable_logrotate_cron_job(rand_selected_dut): + with DisableLogrotateCronContext(rand_selected_dut): + yield + + +@pytest.fixture(scope='module', autouse=True) +def backup_syslog(rand_selected_dut): + """ + Back up current syslog file + :param rand_selected_dut: The fixture returns a randomly selected DUT + """ + duthost = rand_selected_dut + logger.info('Backup syslog file to syslog_bk') + duthost.shell('sudo cp -f /var/log/syslog /var/log/syslog_bk') + + yield + + logger.info('Recover syslog file to syslog') + duthost.shell('sudo mv /var/log/syslog_bk /var/log/syslog') + + logger.info('Remove temp file /var/log/syslog.1') + duthost.shell('sudo rm -f /var/log/syslog.1') + + logger.info('Restart rsyslog service') + duthost.shell('sudo service rsyslog restart') + + +@pytest.fixture(scope='function') +def simulate_small_var_log_partition(rand_selected_dut, localhost): + """ + Simulate a small var log partition + :param rand_selected_dut: The fixture returns a randomly selected DUT + """ + duthost = rand_selected_dut + with allure.step('Create a small var log partition with size of {}'.format(SMALL_VAR_LOG_PARTITION_SIZE)): + logger.info('Create a small var log partition with size of {}'.format(SMALL_VAR_LOG_PARTITION_SIZE)) + duthost.shell('sudo fallocate -l {} log-new-partition'.format(SMALL_VAR_LOG_PARTITION_SIZE)) + duthost.shell('sudo losetup -P /dev/loop2 log-new-partition') + duthost.shell('sudo mkfs.ext4 /dev/loop2') + duthost.shell('sudo mount /dev/loop2 /var/log') + + config_reload(duthost, safe_reload=True) + + logger.info('Start logrotate-config service') + duthost.shell('sudo service logrotate-config start') + + yield + + with allure.step('Recovery var log'): + logger.info('Umount and unload the small var log partition') + duthost.shell('sudo umount -l /dev/loop2') + duthost.shell('sudo losetup -d /dev/loop2') + + logger.info('Remove the small var log partition') + duthost.shell('sudo rm -f log-new-partition') + + config_reload(duthost, safe_reload=True) + + logger.info('Restart logrotate-config service') + duthost.shell('sudo service logrotate-config restart') + + +def get_var_log_size(duthost): + """ + Check the size of /var/log folder + :param duthost: DUT host object + :return: size value + """ + size = duthost.shell("sudo df -k /var/log | sed -n 2p | awk '{ print $2 }'")['stdout'] + return int(size) + + +def get_syslog_file_count(duthost): + """ + Check the rotated syslog file number + :param duthost: DUT host object + :return: file number value + """ + logger.info('Check rotated syslog file number') + num = duthost.shell('sudo ls -l /var/log | grep -Ec "syslog\\.[0-9]{1,4}[\\.gz]{0,1}"')['stdout'] + logger.debug('There are {} rotated syslog files'.format(num)) + return int(num) + + +def create_temp_syslog_file(duthost, size): + """ + Create a temp syslog file with specific size and + :param duthost: DUT host object + :param size: file size with unit, such as 16M or 1024K, the unit could be M or K + """ + logger.info('Create a temp syslog file as {}'.format(size)) + duthost.shell('sudo fallocate -l {} /var/log/syslog'.format(size)) + + +def run_logrotate(duthost, force=False): + """ + Run logrotate command + :param duthost: DUT host object + :param force: force logrotate run immediately even the syslog size is very small, value is True or False + """ + if force: + logger.debug('Make sure there is no big /var/log/syslog exist by forcing execute logrotate') + cmd = 'sudo /usr/sbin/logrotate -f /etc/logrotate.conf > /dev/null 2>&1' + else: + cmd = 'sudo /usr/sbin/logrotate /etc/logrotate.conf > /dev/null 2>&1' + logger.info('Run logrotate command: {}'.format(cmd)) + duthost.shell(cmd) + + +def multiply_with_unit(logrotate_threshold, num): + """ + Multiply logrotate_threshold with number, and return the value + Such as '1024K' * 0.5, return '512K' + :param logrotate_threshold: string type threshold value with unit, such as '1024K' + :param num: the number need to multiply with + :return: value with unit, such as '512K' + """ + return str(int(logrotate_threshold[:-1]) * num) + logrotate_threshold[-1] + + +def validate_logrotate_function(duthost, logrotate_threshold): + """ + Validate logrotate function + :param duthost: DUT host object + :param logrotate_threshold: logrotate threshold, such as 16M or 1024K + """ + with allure.step('Run logrotate with force option to prepare clean syslog environment'): + run_logrotate(duthost, force=True) + + with allure.step('There should be no logrotate process when rsyslog size is smaller than threshold {}'.format( + logrotate_threshold)): + syslog_number_origin = get_syslog_file_count(duthost) + logger.info('There are {} syslog gz files'.format(syslog_number_origin)) + create_temp_syslog_file(duthost, multiply_with_unit(logrotate_threshold, 0.9)) + run_logrotate(duthost) + syslog_number_no_rotate = get_syslog_file_count(duthost) + logger.info('There are {} syslog gz files after running logrotate'.format(syslog_number_no_rotate)) + assert syslog_number_origin == syslog_number_no_rotate, \ + 'Unexpected logrotate happens, there should be no logrotate executed' + + with allure.step('There will be logrotate process when rsyslog size is larger than threshold {}'.format( + logrotate_threshold)): + create_temp_syslog_file(duthost, multiply_with_unit(logrotate_threshold, 1.1)) + run_logrotate(duthost) + syslog_number_with_rotate = get_syslog_file_count(duthost) + logger.info('There are {} syslog gz files after running logrotate'.format(syslog_number_with_rotate)) + assert syslog_number_origin + 1 == syslog_number_with_rotate, \ + 'No logrotate happens, there should be one time logrotate executed' + + +@pytest.mark.disable_loganalyzer +def test_logrotate_normal_size(rand_selected_dut): + """ + Test case of logrotate under normal size /var/log, test steps are listed + + Stop logrotate cron job, make sure no logrotate executes during this test + Back up current syslog file, name the backup file as 'syslog_bk' + Check current /var/log is lower than 200MB, else skip this test + Check current syslog.x file number and save it + Create a temp file with size of rotate_size * 90% , and rename it as 'syslog', run logrotate command + There would be no logrotate happens - by checking the 'syslog.x' file number not increased + Create a temp file with size of rotate_size * 110%, and rename it as 'syslog', run logrotate command + There would be logrotate happens - by checking the 'syslog.x' file number increased by 1 + Remove the temp 'syslog' file and recover the 'syslog_bk' to 'syslog' + + :param rand_selected_dut: The fixture returns a randomly selected DUT + """ + duthost = rand_selected_dut + with allure.step('Check whether the DUT is a small flash DUT'): + if get_var_log_size(duthost) < 200 * 1024: + pytest.skip('{} size is lower than 200MB, skip this test'.format(LOG_FOLDER)) + validate_logrotate_function(duthost, ROTATE_THRESHOLD_LARGE) + + +@pytest.mark.disable_loganalyzer +def test_logrotate_small_size(rand_selected_dut, simulate_small_var_log_partition): + """ + Test case of logrotate under a simulated small size /var/log, test steps are listed + + Create a temp device which is around 100MB large, then mount it to /var/log + Execute config reload to active the mount + Stop logrotate cron job, make sure no logrotate executes during this test + Check current syslog.x file number and save it + Create a temp file with size of rotate_size * 90%, and rename it as 'syslog', run logrotate command + There would be no logrotate happens - by checking the 'syslog.x' file number not increased + Create a temp file with size of rotate_size * 110%, and rename it as 'syslog', run logrotate command + There would be logrotate happens - by checking the 'syslog.x' file number increased by 1 + Reboot the dut to recover original /var/log mount + + :param rand_selected_dut: The fixture returns a randomly selected DUT + :param simulate_small_var_log_partition: The fixture simulates a small var log partition + """ + duthost = rand_selected_dut + validate_logrotate_function(duthost, ROTATE_THRESHOLD_SMALL)