Source code for rhui4_tests.test_retain_repo_versions

'''Tests for the "retain repo versions" feature'''

import logging
from os.path import basename, join
import time

import nose
import yaml
from stitches.expect import Expect

from rhui4_tests_lib.cfg import Config
from rhui4_tests_lib.conmgr import ConMgr
from rhui4_tests_lib.pulp_api import PulpAPI
from rhui4_tests_lib.rhuimanager import RHUIManager
from rhui4_tests_lib.rhuimanager_cmdline import RHUIManagerCLI

logging.basicConfig(level=logging.DEBUG)

RHUA = ConMgr.connect()


[docs]
class TestCLI():
    ''' class for the tests '''

    def __init__(self):
        with open("/etc/rhui4_tests/tested_repos.yaml", encoding="utf-8") as configfile:
            doc = yaml.safe_load(configfile)

        self.test_packages = doc["repo_versions"]["test_packages"]
        self.repo_id = "test-versions"
        self.tmpdir = join("/tmp", self.repo_id)
        self.configured_number = int(Config.get_from_rhui_tools_conf(RHUA,
                                                                     "rhui",
                                                                     "retain_repo_versions"))
        self.limit_single = self.configured_number - 1
        self.limit_all = self.configured_number - 3


[docs]
    @staticmethod
    def setup_class():
        ''' announce the beginning of the test run '''
        print(f"*** Running {basename(__file__)}: ***")



[docs]
    @staticmethod
    def test_01_init():
        '''log in to RHUI'''
        RHUIManager.initial_run(RHUA)



[docs]
    def test_02_create_repo(self):
        '''create a custom repo'''
        RHUIManagerCLI.repo_create_custom(RHUA, self.repo_id)



[docs]
    def test_03_check_max_repo_versions(self):
        '''check if the repo was created with the configured number of versions'''
        repos = PulpAPI.list_repos(RHUA)
        actual_number = repos[0]["retain_repo_versions"]
        nose.tools.eq_(actual_number, self.configured_number)



[docs]
    def test_04_prep_packages_for_upload(self):
        '''prepare packages for upload'''
        Expect.expect_retval(RHUA, "mkdir " + self.tmpdir)
        Expect.expect_retval(RHUA, f"cd {self.tmpdir}; " +
                                   f"yumdownloader {' '.join(self.test_packages)}")



[docs]
    def test_05_upload_packages(self):
        '''upload the packages, one by one, so as to create multiple repo versions'''
        for package in self.test_packages:
            RHUIManagerCLI.packages_upload(RHUA, self.repo_id, join(self.tmpdir, package) + ".rpm")
            time.sleep(7)



[docs]
    def test_06_check_versions(self):
        '''check if the current number of repo versions did not exceed the limit and 0 is gone'''
        versions = PulpAPI.list_repo_versions(RHUA, self.repo_id)
        # the number of versions should match the setting
        # edit: the number is exceeded by one; https://github.com/pulp/pulpcore/issues/2705
        nose.tools.eq_(len(versions), self.configured_number + 1)
        # the last version number should not be 0 anymore
        nose.tools.assert_not_equal(versions[-1]["number"], 0)



[docs]
    def test_07_check_version_0_gone(self):
        '''also check if its deletion was logged'''
        entry = f"Deleting repository version <Repository: {self.repo_id}; Version: 0>"
        Expect.expect_retval(RHUA, f"grep '{entry}' /var/log/messages")



[docs]
    def test_08_set_retain_versions_single(self):
        '''set the number of versions to a custom value for a single repo'''
        RHUIManagerCLI.repo_set_retain_versions(RHUA, self.limit_single, repo_id=self.repo_id)
        time.sleep(5)



[docs]
    def test_09_check_versions(self):
        '''check if the new number of repo versions was set'''
        versions = PulpAPI.list_repo_versions(RHUA, self.repo_id)
        # the number of versions should match the setting
        nose.tools.eq_(len(versions), self.limit_single)
        # the last version number should not be 1 anymore
        nose.tools.assert_not_equal(versions[-1]["number"], 1)



[docs]
    def test_10_check_version_1_gone(self):
        '''also check if the deletion of the oldest version was logged'''
        entry = f"Deleting and squashing version 1 of repository '{self.repo_id}'"
        Expect.expect_retval(RHUA, f"grep \"{entry}\" /var/log/messages")



[docs]
    def test_11_set_retain_versions_all(self):
        '''set the number of versions to a custom value for all repos'''
        RHUIManagerCLI.repo_set_retain_versions(RHUA, self.limit_all, True)
        time.sleep(5)



[docs]
    def test_12_check_versions(self):
        '''check if the new number of repo versions was set'''
        versions = PulpAPI.list_repo_versions(RHUA, self.repo_id)
        # the number of versions should match the setting
        nose.tools.eq_(len(versions), self.limit_all)
        # the last version number should not be 3 anymore
        nose.tools.assert_not_equal(versions[-1]["number"], 3)



[docs]
    def test_13_check_version_3_gone(self):
        '''also check if the deletion of older versions was logged'''
        entry = f"Deleting and squashing version 3 of repository '{self.repo_id}'"
        Expect.expect_retval(RHUA, f"grep \"{entry}\" /var/log/messages")



[docs]
    def test_14_cleanup(self):
        '''clean up'''
        RHUIManagerCLI.repo_delete(RHUA, self.repo_id)
        Expect.expect_retval(RHUA, "rm -rf " + self.tmpdir)



[docs]
    @staticmethod
    def teardown_class():
        ''' announce the end of the test run '''
        print(f"*** Finished running {basename(__file__)}. ***")