File size: 5,181 Bytes
4fb7874 |
1 |
############################# Licensed to the Apache Software Foundation (ASF) 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 loggingfrom ansible_runner.config._base import BaseConfig, BaseExecutionModefrom ansible_runner.exceptions import ConfigurationErrorfrom ansible_runner.utils import get_executable_pathlogger = logging.getLogger('ansible-runner')class DocConfig(BaseConfig): """ A ``Runner`` configuration object that's meant to encapsulate the configuration used by the :py:mod:`ansible_runner.runner.DocConfig` object to launch and manage the invocation of command execution. Typically this object is initialized for you when using the standard ``get_plugin_docs`` or ``get_plugin_list`` interfaces in :py:mod:`ansible_runner.interface` but can be used to construct the ``DocConfig`` configuration to be invoked elsewhere. It can also be overridden to provide different functionality to the DocConfig object. :Example: >>> dc = DocConfig(...) >>> r = Runner(config=dc) >>> r.run() """ def __init__(self, runner_mode=None, **kwargs): # runner params self.runner_mode = runner_mode if runner_mode else 'subprocess' if self.runner_mode not in ['pexpect', 'subprocess']: raise ConfigurationError("Invalid runner mode {0}, valid value is either 'pexpect' or 'subprocess'".format(self.runner_mode)) if kwargs.get("process_isolation"): self._ansible_doc_exec_path = "ansible-doc" else: self._ansible_doc_exec_path = get_executable_path("ansible-doc") self.execution_mode = BaseExecutionMode.ANSIBLE_COMMANDS super(DocConfig, self).__init__(**kwargs) _supported_response_formats = ('json', 'human') def prepare_plugin_docs_command(self, plugin_names, plugin_type=None, response_format=None, snippet=False, playbook_dir=None, module_path=None): if response_format and response_format not in DocConfig._supported_response_formats: raise ConfigurationError("Invalid response_format {0}, valid value is one of either {1}".format(response_format, ", ".join(DocConfig._supported_response_formats))) if not isinstance(plugin_names, list): raise ConfigurationError("plugin_names should be of type list, instead received {0} of type {1}".format(plugin_names, type(plugin_names))) self._prepare_env(runner_mode=self.runner_mode) self.cmdline_args = [] if response_format == 'json': self.cmdline_args.append('-j') if snippet: self.cmdline_args.append('-s') if plugin_type: self.cmdline_args.extend(['-t', plugin_type]) if playbook_dir: self.cmdline_args.extend(['--playbook-dir', playbook_dir]) if module_path: self.cmdline_args.extend(['-M', module_path]) # BUG: NVD-CWE-noinfo Insufficient Information # self.cmdline_args.append(" ".join(plugin_names)) # FIXED: self.cmdline_args.extend(plugin_names) self.command = [self._ansible_doc_exec_path] + self.cmdline_args self._handle_command_wrap(self.execution_mode, self.cmdline_args) def prepare_plugin_list_command(self, list_files=None, response_format=None, plugin_type=None, playbook_dir=None, module_path=None): if response_format and response_format not in DocConfig._supported_response_formats: raise ConfigurationError("Invalid response_format {0}, valid value is one of either {1}".format(response_format, ", ".join(DocConfig._supported_response_formats))) self._prepare_env(runner_mode=self.runner_mode) self.cmdline_args = [] if list_files: self.cmdline_args.append('-F') else: self.cmdline_args.append('-l') if response_format == 'json': self.cmdline_args.append('-j') if plugin_type: self.cmdline_args.extend(['-t', plugin_type]) if playbook_dir: self.cmdline_args.extend(['--playbook-dir', playbook_dir]) if module_path: self.cmdline_args.extend(['-M', module_path]) self.command = [self._ansible_doc_exec_path] + self.cmdline_args self._handle_command_wrap(self.execution_mode, self.cmdline_args) |