dda-python-terraform/python_terraform/__init__.py

453 lines
16 KiB
Python
Raw Normal View History

2015-12-31 04:10:59 +00:00
import json
import logging
2020-10-19 22:30:02 +00:00
import os
import subprocess
import sys
import tempfile
2015-12-31 04:10:59 +00:00
from python_terraform.tfstate import Tfstate
2020-10-19 21:57:22 +00:00
logger = logging.getLogger(__name__)
2017-08-28 18:17:33 +00:00
2020-10-19 21:57:22 +00:00
COMMAND_WITH_SUBCOMMANDS = {"workspace"}
2015-12-31 04:10:59 +00:00
class IsFlagged:
pass
class IsNotFlagged:
pass
class TerraformCommandError(subprocess.CalledProcessError):
2020-10-19 21:57:22 +00:00
def __init__(self, ret_code, cmd, out, err):
super(TerraformCommandError, self).__init__(ret_code, cmd)
self.out = out
self.err = err
class Terraform(object):
2020-10-19 21:57:22 +00:00
"""Wrapper of terraform command line tool.
https://www.terraform.io/
"""
2020-10-19 21:57:22 +00:00
def __init__(
self,
working_dir=None,
targets=None,
state=None,
variables=None,
parallelism=None,
var_file=None,
terraform_bin_path=None,
is_env_vars_included=True,
):
"""
:param working_dir: the folder of the working folder, if not given,
will be current working folder
:param targets: list of target
as default value of apply/destroy/plan command
:param state: path of state file relative to working folder,
as a default value of apply/destroy/plan command
:param variables: default variables for apply/destroy/plan command,
will be override by variable passing by apply/destroy/plan method
:param parallelism: default parallelism value for apply/destroy command
:param var_file: passed as value of -var-file option,
could be string or list, list stands for multiple -var-file option
:param terraform_bin_path: binary path of terraform
:type is_env_vars_included: bool
:param is_env_vars_included: included env variables when calling terraform cmd
"""
self.is_env_vars_included = is_env_vars_included
self.working_dir = working_dir
self.state = state
2015-12-31 04:10:59 +00:00
self.targets = [] if targets is None else targets
self.variables = dict() if variables is None else variables
self.parallelism = parallelism
2020-10-19 21:57:22 +00:00
self.terraform_bin_path = (
terraform_bin_path if terraform_bin_path else "terraform"
)
self.var_file = var_file
self.temp_var_files = VariableFiles()
# store the tfstate data
self.tfstate = None
self.read_state_file(self.state)
def __getattr__(self, item):
def wrapper(*args, **kwargs):
2017-05-09 07:48:28 +00:00
cmd_name = str(item)
2020-10-19 21:57:22 +00:00
if cmd_name.endswith("_cmd"):
2017-05-09 07:48:28 +00:00
cmd_name = cmd_name[:-4]
2020-10-19 21:57:22 +00:00
logger.debug("called with %r and %r", args, kwargs)
2017-05-09 07:48:28 +00:00
return self.cmd(cmd_name, *args, **kwargs)
return wrapper
2020-10-19 21:57:22 +00:00
def apply(
self,
dir_or_plan=None,
input=False,
2020-10-20 22:08:58 +00:00
skip_plan=True,
2020-10-19 21:57:22 +00:00
no_color=IsFlagged,
**kwargs,
):
"""Refer to https://terraform.io/docs/commands/apply.html
no-color is flagged by default
:param no_color: disable color of stdout
:param input: disable prompt for a missing variable
:param dir_or_plan: folder relative to working folder
2017-11-24 21:03:56 +00:00
:param skip_plan: force apply without plan (default: false)
:param kwargs: same as kwags in method 'cmd'
2016-02-25 09:22:11 +00:00
:returns return_code, stdout, stderr
2015-12-31 06:48:26 +00:00
"""
2020-10-20 22:08:58 +00:00
if not skip_plan:
return self.plan(dir_or_plan=dir_or_plan, **kwargs)
default = kwargs
2020-10-19 21:57:22 +00:00
default["input"] = input
default["no_color"] = no_color
2020-10-20 22:08:58 +00:00
default["auto-approve"] = True
option_dict = self._generate_default_options(default)
args = self._generate_default_args(dir_or_plan)
2020-10-19 21:57:22 +00:00
return self.cmd("apply", *args, **option_dict)
def _generate_default_args(self, dir_or_plan):
return [dir_or_plan] if dir_or_plan else []
def _generate_default_options(self, input_options):
option_dict = dict()
2020-10-19 21:57:22 +00:00
option_dict["state"] = self.state
option_dict["target"] = self.targets
option_dict["var"] = self.variables
option_dict["var_file"] = self.var_file
option_dict["parallelism"] = self.parallelism
option_dict["no_color"] = IsFlagged
option_dict["input"] = False
option_dict.update(input_options)
return option_dict
def destroy(self, dir_or_plan=None, force=IsFlagged, **kwargs):
2020-10-19 21:57:22 +00:00
"""Refer to https://www.terraform.io/docs/commands/destroy.html
force/no-color option is flagged by default
:return: ret_code, stdout, stderr
"""
default = kwargs
2020-10-19 21:57:22 +00:00
default["force"] = force
options = self._generate_default_options(default)
args = self._generate_default_args(dir_or_plan)
2020-10-19 21:57:22 +00:00
return self.cmd("destroy", *args, **options)
def plan(self, dir_or_plan=None, detailed_exitcode=IsFlagged, **kwargs):
2020-10-19 21:57:22 +00:00
"""Refer to https://www.terraform.io/docs/commands/plan.html
:param detailed_exitcode: Return a detailed exit code when the command exits.
:param dir_or_plan: relative path to plan/folder
:param kwargs: options
:return: ret_code, stdout, stderr
"""
options = kwargs
2020-10-19 21:57:22 +00:00
options["detailed_exitcode"] = detailed_exitcode
options = self._generate_default_options(options)
args = self._generate_default_args(dir_or_plan)
2020-10-19 21:57:22 +00:00
return self.cmd("plan", *args, **options)
def init(
self,
dir_or_plan=None,
backend_config=None,
reconfigure=IsFlagged,
backend=True,
**kwargs,
):
"""Refer to https://www.terraform.io/docs/commands/init.html
By default, this assumes you want to use backend config, and tries to
init fresh. The flags -reconfigure and -backend=true are default.
2017-08-30 18:00:15 +00:00
:param dir_or_plan: relative path to the folder want to init
:param backend_config: a dictionary of backend config options. eg.
t = Terraform()
2020-10-19 21:57:22 +00:00
t.init(backend_config={'access_key': 'myaccesskey',
'secret_key': 'mysecretkey', 'bucket': 'mybucketname'})
:param reconfigure: whether or not to force reconfiguration of backend
:param backend: whether or not to use backend settings for init
:param kwargs: options
:return: ret_code, stdout, stderr
"""
options = kwargs
2020-10-19 21:57:22 +00:00
options["backend_config"] = backend_config
options["reconfigure"] = reconfigure
options["backend"] = backend
options = self._generate_default_options(options)
args = self._generate_default_args(dir_or_plan)
2020-10-19 21:57:22 +00:00
return self.cmd("init", *args, **options)
def generate_cmd_string(self, cmd, *args, **kwargs):
2020-10-19 21:57:22 +00:00
"""For any generate_cmd_string doesn't written as public method of Terraform
examples:
1. call import command,
ref to https://www.terraform.io/docs/commands/import.html
--> generate_cmd_string call:
terraform import -input=true aws_instance.foo i-abcd1234
--> python call:
tf.generate_cmd_string('import', 'aws_instance.foo', 'i-abcd1234', input=True)
2. call apply command,
--> generate_cmd_string call:
terraform apply -var='a=b' -var='c=d' -no-color the_folder
--> python call:
tf.generate_cmd_string('apply', the_folder, no_color=IsFlagged, var={'a':'b', 'c':'d'})
:param cmd: command and sub-command of terraform, seperated with space
refer to https://www.terraform.io/docs/commands/index.html
:param args: arguments of a command
:param kwargs: same as kwags in method 'cmd'
:return: string of valid terraform command
2016-02-25 09:22:11 +00:00
"""
cmds = cmd.split()
cmds = [self.terraform_bin_path] + cmds
if cmd in COMMAND_WITH_SUBCOMMANDS:
args = list(args)
subcommand = args.pop(0)
cmds.append(subcommand)
2017-08-30 18:00:15 +00:00
for option, value in kwargs.items():
2020-10-19 21:57:22 +00:00
if "_" in option:
option = option.replace("_", "-")
2017-08-30 18:00:15 +00:00
if type(value) is list:
for sub_v in value:
2020-10-19 21:57:22 +00:00
cmds += [f"-{option}={sub_v}"]
continue
2017-08-30 18:00:15 +00:00
if type(value) is dict:
2020-10-19 21:57:22 +00:00
if "backend-config" in option:
2017-08-30 18:00:15 +00:00
for bk, bv in value.items():
2020-10-19 21:57:22 +00:00
cmds += [f"-backend-config={bk}={bv}"]
continue
# since map type sent in string won't work, create temp var file for
# variables, and clean it up later
2020-10-19 21:57:22 +00:00
elif option == "var":
# We do not create empty var-files if there is no var passed.
# An empty var-file would result in an error: An argument or block definition is required here
if value:
filename = self.temp_var_files.create(value)
2020-10-19 21:57:22 +00:00
cmds += [f"-var-file={filename}"]
continue
# simple flag,
2017-08-30 18:00:15 +00:00
if value is IsFlagged:
2020-10-19 21:57:22 +00:00
cmds += ["-{k}".format(k=option)]
continue
2017-08-30 18:00:15 +00:00
if value is None or value is IsNotFlagged:
continue
2017-08-30 18:00:15 +00:00
if type(value) is bool:
2020-10-19 21:57:22 +00:00
value = "true" if value else "false"
2020-10-19 21:57:22 +00:00
cmds += [f"-{option}={value}"]
cmds += args
return cmds
def cmd(self, cmd, *args, **kwargs):
2020-10-19 21:57:22 +00:00
"""Run a terraform command, if success, will try to read state file
:param cmd: command and sub-command of terraform, seperated with space
refer to https://www.terraform.io/docs/commands/index.html
:param args: arguments of a command
:param kwargs: any option flag with key value without prefixed dash character
if there's a dash in the option name, use under line instead of dash,
ex. -no-color --> no_color
if it's a simple flag with no value, value should be IsFlagged
ex. cmd('taint', allow_missing=IsFlagged)
if it's a boolean value flag, assign True or false
if it's a flag could be used multiple times, assign list to it's value
if it's a "var" variable flag, assign dictionary to it
if a value is None, will skip this option
if the option 'capture_output' is passed (with any value other than
True), terraform output will be printed to stdout/stderr and
"None" will be returned as out and err.
if the option 'raise_on_error' is passed (with any value that evaluates to True),
and the terraform command returns a nonzerop return code, then
a TerraformCommandError exception will be raised. The exception object will
have the following properties:
returncode: The command's return code
out: The captured stdout, or None if not captured
err: The captured stderr, or None if not captured
:return: ret_code, out, err
2015-12-31 04:10:59 +00:00
"""
2020-10-19 21:57:22 +00:00
capture_output = kwargs.pop("capture_output", True)
raise_on_error = kwargs.pop("raise_on_error", False)
synchronous = kwargs.pop("synchronous", True)
if capture_output is True:
stderr = subprocess.PIPE
stdout = subprocess.PIPE
elif capture_output == "framework":
stderr = None
stdout = None
else:
stderr = sys.stderr
stdout = sys.stdout
cmds = self.generate_cmd_string(cmd, *args, **kwargs)
2020-10-19 21:57:22 +00:00
logger.debug("Command: %s", " ".join(cmds))
2015-12-31 04:10:59 +00:00
working_folder = self.working_dir if self.working_dir else None
environ_vars = {}
if self.is_env_vars_included:
environ_vars = os.environ.copy()
2020-10-19 21:57:22 +00:00
p = subprocess.Popen(
cmds, stdout=stdout, stderr=stderr, cwd=working_folder, env=environ_vars
)
if not synchronous:
return p, None, None
out, err = p.communicate()
ret_code = p.returncode
2020-10-19 21:57:22 +00:00
logger.debug("output: %s", out)
2016-02-25 09:22:11 +00:00
if ret_code == 0:
self.read_state_file()
else:
2020-10-19 21:57:22 +00:00
logger.warning("error: %s", err)
self.temp_var_files.clean_up()
if capture_output is True:
2020-10-19 21:57:22 +00:00
out = out.decode()
err = err.decode()
else:
out = None
err = None
2020-10-19 21:57:22 +00:00
if ret_code and raise_on_error:
raise TerraformCommandError(ret_code, " ".join(cmds), out=out, err=err)
return ret_code, out, err
def output(self, *args, **kwargs):
2020-10-19 21:57:22 +00:00
"""Refer https://www.terraform.io/docs/commands/output.html
2020-10-19 21:57:22 +00:00
Note that this method does not conform to the (ret_code, out, err) return
convention. To use the "output" command with the standard convention,
call "output_cmd" instead of "output".
:param args: Positional arguments. There is one optional positional
argument NAME; if supplied, the returned output text
will be the json for a single named output value.
2020-10-19 21:57:22 +00:00
:param kwargs: Named options, passed to the command. In addition,
'full_value': If True, and NAME is provided, then
the return value will be a dict with
"value', 'type', and 'sensitive'
properties.
:return: None, if an error occured
Output value as a string, if NAME is provided and full_value
is False or not provided
Output value as a dict with 'value', 'sensitive', and 'type' if
NAME is provided and full_value is True.
dict of named dicts each with 'value', 'sensitive', and 'type',
if NAME is not provided
"""
2020-10-19 21:57:22 +00:00
kwargs["json"] = IsFlagged
if not kwargs.get("capture_output", True) is True:
raise ValueError("capture_output is required for this method")
ret, out, err = self.output_cmd(*args, **kwargs)
2020-10-19 21:57:22 +00:00
if ret:
2017-10-16 16:12:34 +00:00
return None
2020-10-20 22:08:58 +00:00
return json.loads(out.lstrip())
2015-12-31 04:10:59 +00:00
def read_state_file(self, file_path=None):
2020-10-19 21:57:22 +00:00
"""Read .tfstate file
:param file_path: relative path to working dir
:return: states file in dict type
"""
2015-12-31 04:10:59 +00:00
2020-10-19 21:57:22 +00:00
working_dir = self.working_dir or ""
2020-10-19 21:57:22 +00:00
file_path = file_path or self.state or ""
2015-12-31 04:10:59 +00:00
if not file_path:
2020-10-19 21:57:22 +00:00
backend_path = os.path.join(file_path, ".terraform", "terraform.tfstate")
if os.path.exists(os.path.join(working_dir, backend_path)):
file_path = backend_path
else:
2020-10-19 21:57:22 +00:00
file_path = os.path.join(file_path, "terraform.tfstate")
2015-12-31 04:10:59 +00:00
file_path = os.path.join(working_dir, file_path)
2015-12-31 04:10:59 +00:00
self.tfstate = Tfstate.load_file(file_path)
def set_workspace(self, workspace, *args, **kwargs):
2020-10-19 21:57:22 +00:00
"""Set workspace
2019-05-03 20:54:28 +00:00
:param workspace: the desired workspace.
:return: status
2019-05-03 20:54:28 +00:00
"""
2020-10-19 21:57:22 +00:00
return self.cmd("workspace", "select", workspace, *args, **kwargs)
2019-05-03 20:59:48 +00:00
def create_workspace(self, workspace, *args, **kwargs):
2020-10-19 21:57:22 +00:00
"""Create workspace
2019-05-03 20:59:48 +00:00
:param workspace: the desired workspace.
:return: status
2019-05-03 20:59:48 +00:00
"""
2020-10-19 21:57:22 +00:00
return self.cmd("workspace", "new", workspace, *args, **kwargs)
2019-05-08 17:55:53 +00:00
def delete_workspace(self, workspace, *args, **kwargs):
2020-10-19 21:57:22 +00:00
"""Delete workspace
2019-05-08 17:55:53 +00:00
:param workspace: the desired workspace.
:return: status
"""
2020-10-19 21:57:22 +00:00
return self.cmd("workspace", "delete", workspace, *args, **kwargs)
2019-05-03 20:59:48 +00:00
def show_workspace(self, **kwargs):
2020-10-19 21:57:22 +00:00
"""Show workspace, this command does not need the [DIR] part
:return: workspace
2019-05-03 20:59:48 +00:00
"""
2020-10-19 21:57:22 +00:00
return self.cmd("workspace", "show", **kwargs)
2019-05-03 20:54:28 +00:00
def __exit__(self, exc_type, exc_value, traceback):
self.temp_var_files.clean_up()
class VariableFiles(object):
def __init__(self):
self.files = []
def create(self, variables):
2020-10-19 21:57:22 +00:00
with tempfile.NamedTemporaryFile(
"w+t", suffix=".tfvars.json", delete=False
) as temp:
logger.debug("%s is created", temp.name)
self.files.append(temp)
2020-10-19 21:57:22 +00:00
logger.debug("variables wrote to tempfile: %s", variables)
temp.write(json.dumps(variables))
file_name = temp.name
return file_name
def clean_up(self):
for f in self.files:
os.unlink(f.name)
self.files = []