python source code of test

# -*- coding: utf-8 -*-
u"""
Copyright 2015 Telefónica Investigación y Desarrollo, S.A.U.
This file is part of Toolium.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
"""

import os

import mock
import pytest
import requests_mock
from requests.exceptions import ConnectionError

from toolium import jira
from toolium.driver_wrappers_pool import DriverWrappersPool


@pytest.yield_fixture
def logger():
    # Configure logger mock
    logger = mock.MagicMock()
    logger_patch = mock.patch('logging.getLogger', mock.MagicMock(return_value=logger))
    logger_patch.start()

    yield logger

    logger_patch.stop()

    # Clear jira module configuration
    jira.enabled = None
    jira.execution_url = None
    jira.summary_prefix = None
    jira.labels = None
    jira.comments = None
    jira.fix_version = None
    jira.build = None
    jira.only_if_changes = None
    jira.jira_tests_status.clear()
    jira.attachments = []


def test_change_jira_status(logger):
    # Test response
    response = b"The Test Case Execution 'TOOLIUM-2' has been created\r\n"

    # Configure jira module
    jira.enabled = True
    jira.execution_url = 'http://server/execution_service'
    jira.summary_prefix = 'prefix'
    jira.labels = 'label1 label2'
    jira.comments = 'comment'
    jira.fix_version = 'Release 1.0'
    jira.build = '453'
    jira.only_if_changes = True

    with requests_mock.mock() as req_mock:
        # Configure mock
        req_mock.post(jira.execution_url, content=response)

        # Test method
        jira.change_jira_status('TOOLIUM-1', 'Pass', None, [])

        # Check requested url
        assert jira.execution_url == req_mock.request_history[0].url
        for partial_url in ['jiraStatus=Pass', 'jiraTestCaseId=TOOLIUM-1', 'summaryPrefix=prefix',
                            'labels=label1+label2', 'comments=comment', 'version=Release+1.0', 'build=453',
                            'onlyIfStatusChanges=true']:
            assert partial_url in req_mock.request_history[0].text

    # Check logging call
    logger.debug.assert_called_once_with("%s", "The Test Case Execution 'TOOLIUM-2' has been created")


def test_change_jira_status_attachments(logger):
    # Test response
    response = b"The Test Case Execution 'TOOLIUM-2' has been created\r\n"

    # Configure jira module
    jira.enabled = True
    jira.execution_url = 'http://server/execution_service'
    jira.summary_prefix = 'prefix'
    jira.labels = 'label1 label2'
    jira.comments = 'comment'
    jira.fix_version = 'Release 1.0'
    jira.build = '453'
    jira.only_if_changes = True
    resources_path = os.path.join(os.path.dirname(os.path.realpath(__file__)), 'resources')
    attachments = [os.path.join(resources_path, 'ios.png'), os.path.join(resources_path, 'ios_web.png')]

    with requests_mock.mock() as req_mock:
        # Configure mock
        req_mock.post(jira.execution_url, content=response)

        # Test method
        jira.change_jira_status('TOOLIUM-1', 'Pass', None, attachments)

        # Get response body
        body_bytes = req_mock.last_request.body

    # Check requested url
    try:
        # Python 3
        body = "".join(map(chr, body_bytes))
    except TypeError:
        # Python 2.7
        body = body_bytes
    for partial_url in ['"jiraStatus"\r\n\r\nPass', '"jiraTestCaseId"\r\n\r\nTOOLIUM-1',
                        '"summaryPrefix"\r\n\r\nprefix', '"labels"\r\n\r\nlabel1 label2',
                        '"comments"\r\n\r\ncomment', '"version"\r\n\r\nRelease 1.0', '"build"\r\n\r\n453',
                        '"onlyIfStatusChanges"\r\n\r\ntrue', '"attachments0"; filename="ios.png"',
                        '"attachments1"; filename="ios_web.png"']:
        assert partial_url in body

    # Check logging call
    logger.debug.assert_called_once_with("%s", "The Test Case Execution 'TOOLIUM-2' has been created")


@mock.patch('toolium.jira.requests.get')
def test_change_jira_status_empty_url(jira_get, logger):
    # Configure jira mock
    jira_get.side_effect = ConnectionError('exception error')

    # Configure jira module
    jira.enabled = True

    # Test method
    jira.change_jira_status('TOOLIUM-1', 'Pass', None, [])

    # Check logging error message
    logger.warning.assert_called_once_with("Test Case '%s' can not be updated: execution_url is not configured",
                                           'TOOLIUM-1')


@mock.patch('toolium.jira.requests.post')
def test_change_jira_status_exception(jira_post, logger):
    # Configure jira mock
    jira_post.side_effect = ConnectionError('exception error')

    # Configure jira module
    jira.enabled = True
    jira.execution_url = 'http://server/execution_service'

    # Test method
    jira.change_jira_status('TOOLIUM-1', 'Pass', None, [])

    # Check logging error message
    logger.warning.assert_called_once_with("Error updating Test Case '%s': %s", 'TOOLIUM-1', jira_post.side_effect)


def test_jira_annotation_pass(logger):
    # Configure jira module
    config = DriverWrappersPool.get_default_wrapper().config
    try:
        config.add_section('Jira')
    except Exception:
        pass
    config.set('Jira', 'enabled', 'true')

    # Execute method with jira annotation
    MockTestClass().mock_test_pass()

    # Check jira status
    expected_status = {'TOOLIUM-1': ('TOOLIUM-1', 'Pass', None, [])}
    assert expected_status == jira.jira_tests_status


def test_jira_annotation_fail(logger):
    # Configure jira module
    config = DriverWrappersPool.get_default_wrapper().config
    try:
        config.add_section('Jira')
    except Exception:
        pass
    config.set('Jira', 'enabled', 'true')

    # Execute method with jira annotation
    with pytest.raises(AssertionError):
        MockTestClass().mock_test_fail()

    # Check jira status
    expected_status = {'TOOLIUM-3': ('TOOLIUM-3', 'Fail', "The test 'test name' has failed: test error", [])}
    assert expected_status == jira.jira_tests_status


def test_jira_annotation_multiple(logger):
    # Configure jira module
    config = DriverWrappersPool.get_default_wrapper().config
    try:
        config.add_section('Jira')
    except Exception:
        pass
    config.set('Jira', 'enabled', 'true')

    # Execute methods with jira annotation
    MockTestClass().mock_test_pass()
    with pytest.raises(AssertionError):
        MockTestClass().mock_test_fail()
    MockTestClass().mock_test_pass()

    # Check jira status
    expected_status = {'TOOLIUM-1': ('TOOLIUM-1', 'Pass', None, []),
                       'TOOLIUM-3': ('TOOLIUM-3', 'Fail', "The test 'test name' has failed: test error", []),
                       'TOOLIUM-1': ('TOOLIUM-1', 'Pass', None, [])}
    assert expected_status == jira.jira_tests_status


def test_jira_disabled(logger):
    # Configure jira module
    config = DriverWrappersPool.get_default_wrapper().config
    try:
        config.add_section('Jira')
    except Exception:
        pass
    config.set('Jira', 'enabled', 'false')

    # Execute method with jira annotation
    MockTestClass().mock_test_pass()

    # Check jira status
    expected_status = {}
    assert expected_status == jira.jira_tests_status


class MockTestClass():
    def get_method_name(self):
        return 'test name'

    @jira.jira(test_key='TOOLIUM-1')
    def mock_test_pass(self):
        pass

    @jira.jira(test_key='TOOLIUM-3')
    def mock_test_fail(self):
        raise AssertionError('test error')