python-terraform-1 Make option with bool value/ more sense for the caller

This commit is contained in:
Freddy Tan 2016-11-24 15:09:16 +08:00
parent 2c94402d52
commit 110a1f1c4f
2 changed files with 15 additions and 36 deletions

View file

@ -29,10 +29,6 @@ For any terraform command
if a value is None, will skip this option if a value is None, will skip this option
:return: ret_code, out, err :return: ret_code, out, err
For apply/destroy method, the flag options, like, `-no-color` or `-force`
have been implemented as boolean argument. simply use `is_no_color=True/False` for
apply/destroy method
## Examples ## Examples
### Have a test.tf file under folder "/home/test" ### Have a test.tf file under folder "/home/test"
@ -46,7 +42,7 @@ In python-terraform:
from python_terraform import Terraform from python_terraform import Terraform
tf = terraform(working_dir='/home/test') tf = terraform(working_dir='/home/test')
tf.apply(is_no_color=True, refresh=False, var={'a':'b', 'c':'d'}) tf.apply(no_color=IsFlagged, refresh=False, var={'a':'b', 'c':'d'})
#### taint command, allow-missing and no color #### taint command, allow-missing and no color
In shell: In shell:

View file

@ -53,57 +53,40 @@ class Terraform:
# store the tfstate data # store the tfstate data
self.tfstate = dict() self.tfstate = dict()
def apply(self, def apply(self, dir_or_plan=None, **kwargs):
dir=None,
is_no_color=True,
is_input=False,
**kwargs):
""" """
refer to https://terraform.io/docs/commands/apply.html refer to https://terraform.io/docs/commands/apply.html
:raise RuntimeError when return code is not zero no-color is flagged by default
:param is_no_color: if True, add flag -no-color :param dir_or_plan: folder relative to working folder
:param is_input: if True, add option -input=true
:param dir: folder relative to working folder
:param kwargs: same as kwags in method 'cmd' :param kwargs: same as kwags in method 'cmd'
:returns return_code, stdout, stderr :returns return_code, stdout, stderr
""" """
default = dict()
args, option_dict = self._create_cmd_args(is_input, args, option_dict = self._create_cmd_args(dir_or_plan, default, kwargs)
is_no_color,
dir,
kwargs)
return self.cmd('apply', *args, **option_dict) return self.cmd('apply', *args, **option_dict)
def _create_cmd_args(self, is_input, is_no_color, dir, kwargs): def _create_cmd_args(self, dir_or_plan, default_dict, kwargs):
option_dict = dict() option_dict = default_dict
option_dict['state'] = self.state option_dict['state'] = self.state
option_dict['target'] = self.targets option_dict['target'] = self.targets
option_dict['var'] = self.variables option_dict['var'] = self.variables
option_dict['var_file'] = self.var_file option_dict['var_file'] = self.var_file
option_dict['parallelism'] = self.parallelism option_dict['parallelism'] = self.parallelism
if is_no_color:
option_dict['no_color'] = IsFlagged option_dict['no_color'] = IsFlagged
option_dict['input'] = is_input option_dict['input'] = True
option_dict.update(kwargs) option_dict.update(kwargs)
args = [dir] if dir else [] args = [dir_or_plan] if dir_or_plan else []
return args, option_dict return args, option_dict
def destroy(self, working_dir=None, is_force=True, def destroy(self, dir_or_plan=None, **kwargs):
is_no_color=True, is_input=False, **kwargs):
""" """
refer to https://www.terraform.io/docs/commands/destroy.html refer to https://www.terraform.io/docs/commands/destroy.html
:raise RuntimeError when return code is not zero force/no-color option is flagged by default
:return: ret_code, stdout, stderr :return: ret_code, stdout, stderr
""" """
default = {'force': IsFlagged}
args, option_dict = self._create_cmd_args(is_input, args, option_dict = self._create_cmd_args(dir_or_plan, default, kwargs)
is_no_color,
working_dir,
kwargs)
if is_force:
option_dict['force'] = IsFlagged
return self.cmd('destroy', *args, **option_dict) return self.cmd('destroy', *args, **option_dict)
def generate_cmd_string(self, cmd, *args, **kwargs): def generate_cmd_string(self, cmd, *args, **kwargs):