debian_distro-tracker/distro_tracker/test/utils.py

# -*- coding: utf-8 -*-

# Copyright 2013 The Distro Tracker Developers
# See the COPYRIGHT file at the top-level directory of this distribution and
# at http://deb.li/DTAuthors
#
# This file is part of Distro Tracker. It is subject to the license terms
# in the LICENSE file found in the top-level directory of this
# distribution and at http://deb.li/DTLicense. No part of Distro Tracker,
# including this file, may be copied, modified, propagated, or distributed
# except according to the terms contained in the LICENSE file.
from distro_tracker.core.models import Architecture
from distro_tracker.accounts.models import UserEmail
from distro_tracker.core.models import ContributorName
from distro_tracker.core.models import SourcePackage
from distro_tracker.core.models import SourcePackageName
from distro_tracker.core.models import BinaryPackageName

import shutil
import tempfile
import contextlib


@contextlib.contextmanager
def make_temp_directory(suffix=''):
    """
    Helper context manager which creates a temporary directory on enter and
    cleans it up on exit.
    """
    temp_dir_name = tempfile.mkdtemp(suffix=suffix)
    try:
        yield temp_dir_name
    finally:
        shutil.rmtree(temp_dir_name)


def create_source_package(arguments):
    """
    Creates and returns a new
    :class:`SourcePackage <distro_tracker.core.models.SourcePackage>`
    instance based on the parameters given in the arguments.

    It takes care to automatically create any missing maintainers, package
    names, etc.
    """
    kwargs = {}
    if 'maintainer' in arguments:
        maintainer = arguments['maintainer']
        maintainer_email = UserEmail.objects.get_or_create(
            email=maintainer['email'])[0]
        kwargs['maintainer'] = ContributorName.objects.get_or_create(
            contributor_email=maintainer_email,
            name=maintainer.get('name', ''))[0]
    if 'name' in arguments:
        name = arguments['name']
        kwargs['source_package_name'] = (
            SourcePackageName.objects.get_or_create(name=name)[0])
    for arg in ('version', 'directory', 'dsc_file_name'):
        if arg in arguments:
            kwargs[arg] = arguments[arg]

    src_pkg = SourcePackage.objects.create(**kwargs)

    # Now add m2m fields
    if 'architectures' in arguments:
        architectures = arguments['architectures']
        src_pkg.architectures = Architecture.objects.filter(
            name__in=architectures)
    if 'binary_packages' in arguments:
        binaries = []
        for binary in arguments['binary_packages']:
            binaries.append(
                BinaryPackageName.objects.get_or_create(name=binary)[0])
        src_pkg.binary_packages = binaries
    if 'uploaders' in arguments:
        for uploader in arguments['uploaders']:
            contributor = ContributorName.objects.get_or_create(
                contributor_email=UserEmail.objects.get_or_create(
                    email=uploader)[0])[0]
            src_pkg.uploaders.add(contributor)

    src_pkg.save()
    return src_pkg


def set_mock_response(mock_requests, text="", headers=None, status_code=200):
    """
    Helper method which sets a mock response to the given mock requests
    module.

    It takes care to correctly set the return value of all useful requests
    module functions.

    :param mock_requests: A mock requests module.
    :param text: The text of the response.
    :param headers: The headers of the response.
    :param status_code: The status code of the response.
    """
    if headers is None:
        headers = {}
    mock_response = mock_requests.models.Response()
    mock_response.headers = headers
    mock_response.status_code = status_code
    mock_response.ok = status_code < 400
    mock_response.text = text
    mock_response.content = text.encode('utf-8')
    mock_response.iter_lines.return_value = text.splitlines()
    mock_requests.get.return_value = mock_response