Source code for stepler.cli_clients.fixtures.base

"""
-----------------
Base CLI fixtures
-----------------
"""

# 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 pytest
from six import moves

from stepler import config

__all__ = [
    'remote_executor',
]


@pytest.fixture
def remote_executor(nova_api_node, os_faults_steps, credentials):
    """Function fixture to get remote command executor.

    Args:
        nova_api_node (object): controller (node with nova-api service)
        os_faults_steps (object): instantiated os_faults steps
        credentials (object): CredentialsManager instance

    Returns:
        callable: function to execute command on `nova_api_node`
    """
    def _execute_cli(cmd, use_openrc=True, environ=None, **kwargs):
        environ = environ or {}

        if use_openrc:
            source_cmd = config.OPENRC_ACTIVATE_CMD + ";"

            environ['OS_PROJECT_NAME'] = credentials.project_name
            environ['OS_TENANT_NAME'] = credentials.project_name
            environ['OS_USERNAME'] = credentials.username
            environ['OS_PASSWORD'] = credentials.password

            environ['PYTHONIOENCODING'] = 'utf-8'
        else:
            source_cmd = ""

        environ_string = ' '.join("{0}={1}".format(key,
                                                   moves.shlex_quote(
                                                       str(value)))
                                  for key, value in environ.items())

        cmd = u"{source_cmd} {env} {command}".format(source_cmd=source_cmd,
                                                     env=environ_string,
                                                     command=cmd)

        return os_faults_steps.execute_cmd(nodes=nova_api_node, cmd=cmd,
                                           **kwargs)

    return _execute_cli