test_fixtures.py

# -*- coding: utf-8 -*-
#
# Copyright (c) 2019-2020 VMware, Inc. All Rights Reserved.
# SPDX-License-Identifier: BSD-2-Clause

"""
Objects to use for testing
"""

import os
import shutil

from tern.classes.package import Package
from tern.classes.image_layer import ImageLayer
from tern.classes.image import Image
from tern.classes.template import Template
from tern.utils import constants
from tern.utils import general


def create_working_dir():
    """Create the working directory for tests"""
    working_dir = os.path.join(general.get_top_dir(), constants.temp_folder)
    if not os.path.isdir(working_dir):
        os.makedirs(working_dir)


def remove_working_dir():
    """Remove the working directory for tests"""
    # don't remove the cache, just the temp folder
    working_dir = os.path.join(general.get_top_dir(), constants.temp_folder)
    if os.path.exists(working_dir):
        shutil.rmtree(working_dir)


class TestImage(Image):
    def __init__(self, image_id):
        super().__init__(image_id)

    def load_image(self):
        l1 = ImageLayer('123abc', 'path/to/tar')
        self.name = 'testimage'
        self.tag = 'testtag'
        l1.add_package(Package('p1'))
        l1.add_package(Package('p2'))
        self._layers.append(l1)


class TestTemplate1(Template):
    '''Template with no origins mapping'''
    def file_data(self):
        return {'name': 'file.name',
                'path': 'file.path',
                'licenses': 'file.licenses'}

    def package(self):
        return {'name': 'package.name',
                'version': 'package.version',
                'pkg_license': 'package.license',
                'files': 'package.files'}

    def image_layer(self):
        return {'diff_id': 'layer.diff',
                'tar_file': 'layer.tarfile',
                'packages': 'layer.packages',
                'files': 'layer.files'}

    def image(self):
        return {'repotag': 'image.repotag',
                'layers': 'image.layers'}


class TestTemplate2(Template):
    '''Template with origins mapping'''
    def file_data(self):
        mapping = {'name': 'file.name',
                   'path': 'file.path',
                   'licenses': 'file.licenses'}
        # we update the mapping with another defined mapping
        mapping.update(self.origins())
        return mapping

    def package(self):
        mapping = {'name': 'package.name',
                   'version': 'package.version',
                   'pkg_license': 'package.license',
                   'proj_url': 'package.url',
                   'files': 'package.files'}
        # we update the mapping with another defined mapping
        mapping.update(self.origins())
        return mapping

    def image_layer(self):
        mapping = {'diff_id': 'layer.diff',
                   'tar_file': 'layer.tarfile',
                   'packages': 'layer.packages',
                   'files': 'layer.files'}
        # we update the mapping with another defined mapping
        mapping.update(self.origins())
        return mapping

    def image(self):
        mapping = {'repotag': 'image.repotag',
                   'layers': 'image.layers'}
        # we update the mapping with another defined mapping
        mapping.update(self.origins())
        return mapping

    def notice(self):
        return {'level': 'note.level',
                'message': 'note.message'}

    def notice_origin(self):
        return {'origin_str': 'note.source',
                'notices': 'note.messages'}

    def origins(self):
        return {'origins': 'notes'}