cloud-build/tests/test_errors.py

from unittest import TestCase
from unittest import mock

import os
import shutil
import tempfile

import yaml

from cloud_build import CB
from cloud_build import Error, BuildError, MultipleBuildErrors

import tests.call as call


def update(old_dict, kwargs):
    new_dict = old_dict.copy()
    for key, value in kwargs.items():
        if value is None:
            del new_dict[key]
        else:
            new_dict[key] = value
    return new_dict


class TestErrors(TestCase):
    def setUp(self):
        kwargs = {}
        kwargs['data_dir'] = tempfile.mkdtemp(prefix='cloud_build_data')
        self.kwargs = kwargs
        self.images_dir = tempfile.mkdtemp(prefix='cloud_build_images')
        self.config = None

    def tearDown(self):
        shutil.rmtree(self.kwargs['data_dir'])
        shutil.rmtree(self.images_dir)
        if (config := self.config) is not None:
            os.unlink(config)

    def test_read_config_not_found(self):
        regex = 'config file.*No such file or directory'
        self.kwargs.update(config='/var/empty/cb_conf.yaml')
        self.assertRaisesRegex(Error, regex, CB, **self.kwargs)

    def test_read_config_permission_denied(self):
        regex = 'config file.*Permission denied'
        self.kwargs.update(config='/root/cb_conf.yaml')
        self.assertRaisesRegex(Error, regex, CB, **self.kwargs)

    def test_required_parameters_in_config(self):
        self.config = tempfile.mktemp(prefix='cb_conf')
        with open('tests/minimal_config.yaml') as f:
            cfg = yaml.safe_load(f)

        for parameter in ['remote', 'images', 'branches']:
            with open(self.config, 'w') as f:
                yaml.safe_dump(update(cfg, {parameter: None}), f)

            regex = f'parameter.*{parameter}'
            self.kwargs.update(config=self.config)
            self.assertRaisesRegex(Error, regex, CB, **self.kwargs)

    def test_override_required_parameters_in_config(self):
        self.config = tempfile.mktemp(prefix='cb_conf')
        config_override = {
            'remote': '/var/empty',
            'images': {},
            'branches': {},
        }
        with open('tests/minimal_config.yaml') as f:
            cfg = yaml.safe_load(f)

        for parameter in ['remote', 'images', 'branches']:
            with open(self.config, 'w') as f:
                yaml.safe_dump(update(cfg, {parameter: None}), f)

            self.kwargs.update(config=self.config)
            self.kwargs.update(config_override=config_override)
            CB(**self.kwargs)

    def test_run_already_running(self):
        self.kwargs.update(config='tests/minimal_config.yaml')
        cb = CB(**self.kwargs)  # noqa F841
        regex = 'already running'
        self.assertRaisesRegex(Error, regex, CB, **self.kwargs)

    def test_try_build_all_zero_rc(self):
        def cond(args):
            return args[1].endswith('aarch64')
        ds = {'make': [call.return_d(0, cond=cond), call.nop_d(cond=cond)]}
        with mock.patch('subprocess.call', call.Call(decorators=ds)):
            cloud_build = CB(
                config='tests/test_try_build_all.yaml',
                data_dir=self.kwargs['data_dir'],
            )
            regex = r'build.*:'
            self.assertRaisesRegex(
                MultipleBuildErrors,
                regex,
                cloud_build.create_images,
                no_tests=True
            )

    def test_try_build_all_non_zero_rc(self):
        def cond(args):
            return args[1].endswith('aarch64')
        ds = {'make': [call.return_d(2, cond=cond), call.nop_d(cond=cond)]}
        with mock.patch('subprocess.call', call.Call(decorators=ds)):
            cloud_build = CB(
                config='tests/test_try_build_all.yaml',
                data_dir=self.kwargs['data_dir'],
            )
            regex = r'build.*:'
            self.assertRaisesRegex(
                MultipleBuildErrors,
                regex,
                cloud_build.create_images,
                no_tests=True
            )

    def test_not_try_build_all(self):
        def cond(args):
            return args[1].endswith('aarch64')
        ds = {'make': [call.return_d(0, cond=cond), call.nop_d(cond=cond)]}
        with mock.patch('subprocess.call', call.Call(decorators=ds)):
            cloud_build = CB(
                config='tests/test_not_try_build_all.yaml',
                data_dir=self.kwargs['data_dir'],
            )
            regex = r'build.*aarch64'
            self.assertRaisesRegex(
                BuildError,
                regex,
                cloud_build.create_images,
                no_tests=True
            )

    def test_rebuild_after_format(self):
        regex = 'years.*rebuild_after'
        self.kwargs.update(config='tests/test_rebuild_after_format.yaml')
        self.assertRaisesRegex(Error, regex, CB, **self.kwargs)

    def test_bad_size(self):
        with mock.patch('subprocess.call', call.Call()):
            regex = 'Bad size.*'
            cloud_build = CB(
                config='tests/test_bad_size.yaml',
                data_dir=self.kwargs['data_dir'],
            )
            self.assertRaisesRegex(
                Error,
                regex,
                cloud_build.create_images,
                no_tests=True
            )

    def test_sign_requires_key(self):
        with mock.patch('subprocess.call', call.Call()):
            regex = 'key.*config'
            cloud_build = CB(
                config='tests/minimal_config.yaml',
                data_dir=self.kwargs['data_dir'],
            )
            cloud_build.create_images(no_tests=True)
            self.assertRaisesRegex(Error, regex, cloud_build.sign)

    def test_sign_override_key(self):
        with mock.patch('subprocess.call', call.Call()):
            cloud_build = CB(
                config='tests/minimal_config.yaml',
                data_dir=self.kwargs['data_dir'],
                config_override={'key': 0},
            )
            cloud_build.create_images(no_tests=True)
            cloud_build.sign()

    def test_skiped_build(self):
        with mock.patch('subprocess.call'):
            cloud_build = CB(
                config='tests/minimal_config.yaml',
                data_dir=self.kwargs['data_dir'],
                built_images_dir=self.images_dir,
            )
            regex = r'build.*skip'
            self.assertRaisesRegex(
                Error,
                regex,
                cloud_build.create_images,
                no_tests=True
            )