InquiryTestCase

Complexity

Total Complexity

5

Size/Duplication

Total Lines	112
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	tearDown()	0	5	1
B	test_simple_inquiry()	0	34	1
A	test_runner_creation()	0	4	1
A	_get_mock_action_obj()	0	6	1
B	test_inquiry_no_parent()	0	35	1

# Licensed to the StackStorm, Inc ('StackStorm') under one or more
# contributor license agreements.  See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You 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 mock

import inquirer
from st2actions.container import service
from st2common.constants.action import LIVEACTION_STATUS_PENDING
from st2common.constants.pack import SYSTEM_PACK_NAME
from st2common.persistence.execution import ActionExecution
from st2common.services import action as action_service
from st2common.transport import reactor
from st2common.util import action_db as action_utils
from st2tests.base import RunnerTestCase


mock_exc_get = mock.Mock()
mock_exc_get.id = 'abcdef'

mock_inquiry_liveaction_db = mock.Mock()
mock_inquiry_liveaction_db.result = {"response": {}}

mock_action_utils = mock.Mock()
mock_action_utils.return_value = mock_inquiry_liveaction_db

test_parent = mock.Mock()
test_parent.id = '1234567890'

mock_get_root = mock.Mock()
mock_get_root.return_value = test_parent

mock_trigger_dispatcher = mock.Mock()
mock_request_pause = mock.Mock()

test_user = 'st2admin'

runner_params = {
    "users": [],
    "roles": [],
    "route": "developers",
    "schema": {}
}


@mock.patch('inquirer.TriggerDispatcher', mock_trigger_dispatcher)
@mock.patch.object(
    reactor,
    'TriggerDispatcher',
    mock_action_utils)
@mock.patch.object(
    action_utils,
    'get_liveaction_by_id',
    mock_action_utils)
@mock.patch.object(
    action_service,
    'request_pause',
    mock_request_pause)
@mock.patch.object(
    action_service,
    'get_root_liveaction',
    mock_get_root)
@mock.patch.object(
    ActionExecution,
    'get',
    mock.MagicMock(return_value=mock_exc_get))
class InquiryTestCase(RunnerTestCase):

    def tearDown(self):
        mock_trigger_dispatcher.reset_mock()
        mock_action_utils.reset_mock()
        mock_get_root.reset_mock()
        mock_request_pause.reset_mock()

    def test_runner_creation(self):
        runner = inquirer.get_runner()
        self.assertTrue(runner is not None, 'Creation failed. No instance.')
        self.assertEqual(type(runner), inquirer.Inquirer, 'Creation failed. No instance.')

    def test_simple_inquiry(self):
        runner = inquirer.get_runner()
        runner.context = {
            'user': test_user
        }
        runner.action = self._get_mock_action_obj()
        runner.runner_parameters = runner_params
        runner.container_service = service.RunnerContainerService()
        runner.pre_run()
        mock_inquiry_liveaction_db.context = {
            "parent": test_parent.id
        }
        (status, output, _) = runner.run({})
        self.assertEqual(status, LIVEACTION_STATUS_PENDING)
        self.assertEqual(
            output,
            {
                'users': [],
                'roles': [],
                'route': "developers",
                'schema': {},
                'ttl': 1440
            }
        )
        mock_trigger_dispatcher.return_value.dispatch.assert_called_once_with(
            'core.st2.generic.inquiry',
            {
                'id': mock_exc_get.id,
                'route': "developers"
            }
        )
        mock_request_pause.assert_called_once_with(
            test_parent,
            test_user
        )

    def test_inquiry_no_parent(self):
        """Should behave like a regular execution, but without requesting a pause
        """

        runner = inquirer.get_runner()
        runner.context = {
            'user': 'st2admin'
        }
        runner.action = self._get_mock_action_obj()
        runner.runner_parameters = runner_params
        runner.container_service = service.RunnerContainerService()
        runner.pre_run()
        mock_inquiry_liveaction_db.context = {
            "parent": None
        }
        (status, output, _) = runner.run({})
        self.assertEqual(status, LIVEACTION_STATUS_PENDING)
        self.assertEqual(
            output,
            {
                'users': [],
                'roles': [],
                'route': "developers",
                'schema': {},
                'ttl': 1440
            }
        )
        mock_trigger_dispatcher.return_value.dispatch.assert_called_once_with(
            'core.st2.generic.inquiry',
            {
                'id': mock_exc_get.id,
                'route': "developers"
            }
        )
        mock_request_pause.assert_not_called()

    def _get_mock_action_obj(self):
        action = mock.Mock()
        action.pack = SYSTEM_PACK_NAME
        action.users = []
        action.roles = []
        return action