meissa/dda-python-terraform
6
3
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add pre-commit and apply Black format

Browse source
This commit is contained in:
aubustou 2020-10-20 00:30:02 +02:00
parent 61a76803d4
commit 151c5dc92a
12 changed files with 321 additions and 259 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
.bumpversion.cfg
View file

@ -4,4 +4,3 @@ commit = True
tag = False tag = False
[bumpversion:file:setup.py] [bumpversion:file:setup.py]

28
.pre-commit-config.yaml Normal file
View file

@ -0,0 +1,28 @@
default_language_version:
python: python3.6
fail_fast: true
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v3.1.0 # v2.1.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
- id: check-docstring-first
- id: check-json
- id: check-merge-conflict
- id: check-toml
- id: check-yaml
- id: debug-statements
- id: requirements-txt-fixer
- repo: https://github.com/pre-commit/mirrors-isort
rev: v4.3.21
hooks:
- id: isort
- repo: https://github.com/lovesegfault/beautysh
rev: 6.0.1
hooks:
- id: beautysh
- repo: https://github.com/psf/black
rev: 19.10b0
hooks:
- id: black

2
CHANGELOG.md
View file

@ -16,4 +16,4 @@
## [0.10.1] ## [0.10.1]
1. [#48] adding extension for temp file to adopt the change in terraform 0.12.0 1. [#48] adding extension for temp file to adopt the change in terraform 0.12.0
1. [#49] add workspace support 1. [#49] add workspace support

2
DESCRIPTION.rst
View file

@ -1,3 +1,3 @@
Please see README at github_ Please see README at github_
.. _github: https://github.com/beelit94/python-terraform/blob/master/README.md .. _github: https://github.com/beelit94/python-terraform/blob/master/README.md

2
LICENSE.txt
View file

@ -4,4 +4,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

68
README.md
View file

@ -1,6 +1,6 @@
## Introduction ## Introduction
python-terraform is a python module provide a wrapper of `terraform` command line tool. python-terraform is a python module provide a wrapper of `terraform` command line tool.
`terraform` is a tool made by Hashicorp, please refer to https://terraform.io/ `terraform` is a tool made by Hashicorp, please refer to https://terraform.io/
### Status ### Status
@ -8,7 +8,7 @@ python-terraform is a python module provide a wrapper of `terraform` command lin
## Installation ## Installation
pip install python-terraform pip install python-terraform
## Usage ## Usage
#### For any terraform command #### For any terraform command
@ -29,44 +29,44 @@ or just call cmd method directly
from python_terraform import * from python_terraform import *
t = Terraform() t = Terraform()
return_code, stdout, stderr = t.cmd(<cmd_name>, *arguments, **options) return_code, stdout, stderr = t.cmd(<cmd_name>, *arguments, **options)
#### For any argument #### For any argument
simply pass the string to arguments of the method, for example, simply pass the string to arguments of the method, for example,
terraform apply target_dir terraform apply target_dir
--> <instance>.apply('target_dir') --> <instance>.apply('target_dir')
terraform import aws_instance.foo i-abcd1234 terraform import aws_instance.foo i-abcd1234
--> <instance>.import('aws_instance.foo', 'i-abcd1234') --> <instance>.import('aws_instance.foo', 'i-abcd1234')
#### For any options #### For any options
* dash to underscore * dash to underscore
remove first dash, and then use underscore to replace dash symbol as option name remove first dash, and then use underscore to replace dash symbol as option name
ex. -no-color --> no_color ex. -no-color --> no_color
* for a simple flag option * for a simple flag option
use ```IsFlagged/None``` as value for raising/not raising flag, for example, use ```IsFlagged/None``` as value for raising/not raising flag, for example,
terraform taint -allow-missing terraform taint -allow-missing
--> <instance>.taint(allow＿missing=IsFlagged) --> <instance>.taint(allow＿missing=IsFlagged)
terraform taint terraform taint
--> <instance>.taint(allow＿missing=None) or <instance>.taint() --> <instance>.taint(allow＿missing=None) or <instance>.taint()
terraform apply -no-color terraform apply -no-color
--> <instance>.apply(no_color=IsFlagged) --> <instance>.apply(no_color=IsFlagged)
* for a boolean value option * for a boolean value option
assign True or False, for example, assign True or False, for example,
terraform apply -refresh=true --> <instance>.apply(refresh=True) terraform apply -refresh=true --> <instance>.apply(refresh=True)
* if a flag could be used multiple times, assign a list to it's value * if a flag could be used multiple times, assign a list to it's value
terraform apply -target=aws_instance.foo[1] -target=aws_instance.foo[2] terraform apply -target=aws_instance.foo[1] -target=aws_instance.foo[2]
---> --->
<instance>.apply(target=['aws_instance.foo[1]', 'aws_instance.foo[2]']) <instance>.apply(target=['aws_instance.foo[1]', 'aws_instance.foo[2]'])
* for the "var" flag, assign dictionary to it * for the "var" flag, assign dictionary to it
@ -84,19 +84,19 @@ By default, stdout and stderr are captured and returned. This causes the applica
return_code, stdout, stderr = t.<cmd_name>(capture_output=False) return_code, stdout, stderr = t.<cmd_name>(capture_output=False)
## Examples ## Examples
### Have a test.tf file under folder "/home/test" ### Have a test.tf file under folder "/home/test"
#### 1. apply with variables a=b, c=d, refresh=false, no color in the output #### 1. apply with variables a=b, c=d, refresh=false, no color in the output
In shell: In shell:
cd /home/test cd /home/test
terraform apply -var='a=b' -var='c=d' -refresh=false -no-color terraform apply -var='a=b' -var='c=d' -refresh=false -no-color
In python-terraform: In python-terraform:
from python_terraform import * from python_terraform import *
tf = Terraform(working_dir='/home/test') tf = Terraform(working_dir='/home/test')
tf.apply(no_color=IsFlagged, refresh=False, var={'a':'b', 'c':'d'}) tf.apply(no_color=IsFlagged, refresh=False, var={'a':'b', 'c':'d'})
or or
from python_terraform import * from python_terraform import *
@ -108,40 +108,32 @@ or
from python_terraform import * from python_terraform import *
tf = Terraform(working_dir='/home/test', variables={'a':'b', 'c':'d'}) tf = Terraform(working_dir='/home/test', variables={'a':'b', 'c':'d'})
tf.apply(no_color=IsFlagged, refresh=False) tf.apply(no_color=IsFlagged, refresh=False)
#### 2. fmt command, diff=true #### 2. fmt command, diff=true
In shell: In shell:
cd /home/test cd /home/test
terraform fmt -diff=true terraform fmt -diff=true
In python-terraform: In python-terraform:
from python_terraform import * from python_terraform import *
tf = terraform(working_dir='/home/test') tf = terraform(working_dir='/home/test')
tf.fmt(diff=True) tf.fmt(diff=True)
## default values ## default values
for apply/plan/destroy command, assign with following default value to make for apply/plan/destroy command, assign with following default value to make
caller easier in python caller easier in python
1. ```input=False```, in this case process won't hang because you missing a variable 1. ```input=False```, in this case process won't hang because you missing a variable
1. ```no_color=IsFlagged```, in this case, stdout of result is easier for parsing 1. ```no_color=IsFlagged```, in this case, stdout of result is easier for parsing
## Implementation ## Implementation
IMHO, how terraform design boolean options is confusing. IMHO, how terraform design boolean options is confusing.
Take `input=True` and `-no-color` option of `apply` command for example, Take `input=True` and `-no-color` option of `apply` command for example,
they're all boolean value but with different option type. they're all boolean value but with different option type.
This make api caller don't have a general rule to follow but to do This make api caller don't have a general rule to follow but to do
a exhaustive method implementation which I don't prefer to. a exhaustive method implementation which I don't prefer to.
Therefore I end-up with using `IsFlagged` or `IsNotFlagged` as value of option Therefore I end-up with using `IsFlagged` or `IsNotFlagged` as value of option
like `-no-color` and `True/False` value reserved for option like `refresh=true` like `-no-color` and `True/False` value reserved for option like `refresh=true`

7
python_terraform/__init__.py
View file

@ -1,13 +1,12 @@
import subprocess
import os
import sys
import json import json
import logging import logging
import os
import subprocess
import sys
import tempfile import tempfile
from python_terraform.tfstate import Tfstate from python_terraform.tfstate import Tfstate
logger = logging.getLogger(__name__) logger = logging.getLogger(__name__)
COMMAND_WITH_SUBCOMMANDS = {"workspace"} COMMAND_WITH_SUBCOMMANDS = {"workspace"}

6
python_terraform/tfstate.py
View file

@ -1,6 +1,6 @@
import json import json
import os
import logging import logging
import os
logger = logging.getLogger(__name__) logger = logging.getLogger(__name__)
@ -18,7 +18,7 @@ class Tfstate:
Parses then as JSON and put the result into the object. Parses then as JSON and put the result into the object.
""" """
logger.debug('read data from %s', file_path) logger.debug("read data from %s", file_path)
if os.path.exists(file_path): if os.path.exists(file_path):
with open(file_path) as f: with open(file_path) as f:
json_data = json.load(f) json_data = json.load(f)
@ -27,6 +27,6 @@ class Tfstate:
tf_state.tfstate_file = file_path tf_state.tfstate_file = file_path
return tf_state return tf_state
logger.debug('%s is not exist', file_path) logger.debug("%s is not exist", file_path)
return Tfstate() return Tfstate()

4
requirements.txt
View file

@ -1,3 +1,3 @@
tox-pyenv
pytest pytest
tox tox
tox-pyenv

47
setup.py
View file

@ -7,12 +7,13 @@ except ImportError:
from distutils.core import setup from distutils.core import setup
dependencies = [] dependencies = []
module_name = 'python-terraform' module_name = "python-terraform"
short_description = 'This is a python module provide a wrapper ' \ short_description = (
'of terraform command line tool' "This is a python module provide a wrapper " "of terraform command line tool"
)
try: try:
with open('DESCRIPTION.rst') as f: with open("DESCRIPTION.rst") as f:
long_description = f.read() long_description = f.read()
except IOError: except IOError:
long_description = short_description long_description = short_description
@ -20,36 +21,36 @@ except IOError:
setup( setup(
name=module_name, name=module_name,
version='0.10.2', version="0.10.2",
url='https://github.com/beelit94/python-terraform', url="https://github.com/beelit94/python-terraform",
license='MIT', license="MIT",
author='Freddy Tan', author="Freddy Tan",
author_email='beelit94@gmail.com', author_email="beelit94@gmail.com",
description=short_description, description=short_description,
long_description=long_description, long_description=long_description,
packages=['python_terraform'], packages=["python_terraform"],
package_data={}, package_data={},
platforms='any', platforms="any",
install_requires=dependencies, install_requires=dependencies,
classifiers=[ classifiers=[
# As from http://pypi.python.org/pypi?%3Aaction=list_classifiers # As from http://pypi.python.org/pypi?%3Aaction=list_classifiers
# 'Development Status :: 1 - Planning', # 'Development Status :: 1 - Planning',
# 'Development Status :: 2 - Pre-Alpha', # 'Development Status :: 2 - Pre-Alpha',
# 'Development Status :: 3 - Alpha', # 'Development Status :: 3 - Alpha',
'Development Status :: 4 - Beta', "Development Status :: 4 - Beta",
# 'Development Status :: 5 - Production/Stable', # 'Development Status :: 5 - Production/Stable',
# 'Development Status :: 6 - Mature', # 'Development Status :: 6 - Mature',
# 'Development Status :: 7 - Inactive', # 'Development Status :: 7 - Inactive',
'Environment :: Console', "Environment :: Console",
'Intended Audience :: Developers', "Intended Audience :: Developers",
'License :: OSI Approved :: MIT License', "License :: OSI Approved :: MIT License",
'Operating System :: POSIX', "Operating System :: POSIX",
'Operating System :: MacOS', "Operating System :: MacOS",
'Operating System :: Unix', "Operating System :: Unix",
# 'Operating System :: Windows', # 'Operating System :: Windows',
'Programming Language :: Python', "Programming Language :: Python",
'Programming Language :: Python :: 2', "Programming Language :: Python :: 2",
'Programming Language :: Python :: 3', "Programming Language :: Python :: 3",
'Topic :: Software Development :: Libraries :: Python Modules', "Topic :: Software Development :: Libraries :: Python Modules",
] ],
) )

411
test/test_terraform.py
View file

@ -1,15 +1,16 @@
try: try:
from cStringIO import StringIO # Python 2 from cStringIO import StringIO # Python 2
except ImportError: except ImportError:
from io import StringIO from io import StringIO
from python_terraform import * import fnmatch
from contextlib import contextmanager
import pytest
import os
import logging import logging
import os
import re import re
import shutil import shutil
import fnmatch from contextlib import contextmanager
import pytest
from python_terraform import *
logging.basicConfig(level=logging.DEBUG) logging.basicConfig(level=logging.DEBUG)
root_logger = logging.getLogger() root_logger = logging.getLogger()
@ -18,78 +19,97 @@ current_path = os.path.dirname(os.path.realpath(__file__))
FILE_PATH_WITH_SPACE_AND_SPACIAL_CHARS = "test 'test.out!" FILE_PATH_WITH_SPACE_AND_SPACIAL_CHARS = "test 'test.out!"
STRING_CASES = [ STRING_CASES = [
[ [
lambda x: x.generate_cmd_string('apply', 'the_folder', lambda x: x.generate_cmd_string("apply", "the_folder", no_color=IsFlagged),
no_color=IsFlagged), "terraform apply -no-color the_folder",
"terraform apply -no-color the_folder" ],
], [
[ lambda x: x.generate_cmd_string(
lambda x: x.generate_cmd_string('push', 'path', vcs=True, "push", "path", vcs=True, token="token", atlas_address="url"
token='token', ),
atlas_address='url'), "terraform push -vcs=true -token=token -atlas-address=url path",
"terraform push -vcs=true -token=token -atlas-address=url path" ],
], ]
]
CMD_CASES = [ CMD_CASES = [
['method', 'expected_output', 'expected_ret_code', 'expected_exception', 'expected_logs', 'folder'], [
"method",
"expected_output",
"expected_ret_code",
"expected_exception",
"expected_logs",
"folder",
],
[ [
[ [
lambda x: x.cmd('plan', 'var_to_output', no_color=IsFlagged, var={'test_var': 'test'}), lambda x: x.cmd(
"plan", "var_to_output", no_color=IsFlagged, var={"test_var": "test"}
),
# Expected output varies by terraform version # Expected output varies by terraform version
["doesn't need to do anything", # Terraform < 0.10.7 (used in travis env) [
"no\nactions need to be performed"], # Terraform >= 0.10.7 "doesn't need to do anything", # Terraform < 0.10.7 (used in travis env)
"no\nactions need to be performed",
], # Terraform >= 0.10.7
0, 0,
False, False,
'', "",
'var_to_output' "var_to_output",
], ],
# try import aws instance # try import aws instance
[ [
lambda x: x.cmd('import', 'aws_instance.foo', 'i-abcd1234', no_color=IsFlagged), lambda x: x.cmd(
'', "import", "aws_instance.foo", "i-abcd1234", no_color=IsFlagged
),
"",
1, 1,
False, False,
'Command: terraform import -no-color aws_instance.foo i-abcd1234', "Command: terraform import -no-color aws_instance.foo i-abcd1234",
'' "",
], ],
# try import aws instance with raise_on_error # try import aws instance with raise_on_error
[ [
lambda x: x.cmd('import', 'aws_instance.foo', 'i-abcd1234', no_color=IsFlagged, raise_on_error=True), lambda x: x.cmd(
'', "import",
"aws_instance.foo",
"i-abcd1234",
no_color=IsFlagged,
raise_on_error=True,
),
"",
1, 1,
True, True,
'Command: terraform import -no-color aws_instance.foo i-abcd1234', "Command: terraform import -no-color aws_instance.foo i-abcd1234",
'' "",
], ],
# test with space and special character in file path # test with space and special character in file path
[ [
lambda x: x.cmd('plan', 'var_to_output', out=FILE_PATH_WITH_SPACE_AND_SPACIAL_CHARS), lambda x: x.cmd(
'', "plan", "var_to_output", out=FILE_PATH_WITH_SPACE_AND_SPACIAL_CHARS
),
"",
0, 0,
False, False,
'', "",
'var_to_output' "var_to_output",
], ],
# test workspace command (commands with subcommand) # test workspace command (commands with subcommand)
[ [
lambda x: x.cmd('workspace', 'show', no_color=IsFlagged), lambda x: x.cmd("workspace", "show", no_color=IsFlagged),
'', "",
0, 0,
False, False,
'Command: terraform workspace show -no-color', "Command: terraform workspace show -no-color",
'' "",
], ],
] ],
] ]
@pytest.fixture(scope='function') @pytest.fixture(scope="function")
def fmt_test_file(request): def fmt_test_file(request):
target = os.path.join(current_path, 'bad_fmt', 'test.backup') target = os.path.join(current_path, "bad_fmt", "test.backup")
orgin = os.path.join(current_path, 'bad_fmt', 'test.tf') orgin = os.path.join(current_path, "bad_fmt", "test.tf")
shutil.copy(orgin, shutil.copy(orgin, target)
target)
def td(): def td():
shutil.move(target, orgin) shutil.move(target, orgin)
@ -120,6 +140,7 @@ def workspace_setup_teardown():
Create and tear down a workspace Create and tear down a workspace
*Use as a contextmanager* *Use as a contextmanager*
""" """
@contextmanager @contextmanager
def wrapper(workspace_name, create=True, delete=True, *args, **kwargs): def wrapper(workspace_name, create=True, delete=True, *args, **kwargs):
tf = Terraform(working_dir=current_path) tf = Terraform(working_dir=current_path)
@ -128,7 +149,7 @@ def workspace_setup_teardown():
tf.create_workspace(workspace_name, *args, **kwargs) tf.create_workspace(workspace_name, *args, **kwargs)
yield tf yield tf
if delete: if delete:
tf.set_workspace('default') tf.set_workspace("default")
tf.delete_workspace(workspace_name) tf.delete_workspace(workspace_name)
yield wrapper yield wrapper
@ -139,9 +160,7 @@ class TestTerraform(object):
""" teardown any state that was previously setup with a setup_method """ teardown any state that was previously setup with a setup_method
call. call.
""" """
exclude = ['test_tfstate_file', exclude = ["test_tfstate_file", "test_tfstate_file2", "test_tfstate_file3"]
'test_tfstate_file2',
'test_tfstate_file3']
def purge(dir, pattern): def purge(dir, pattern):
for root, dirnames, filenames in os.walk(dir): for root, dirnames, filenames in os.walk(dir):
@ -153,14 +172,12 @@ class TestTerraform(object):
d = os.path.join(root, dirname) d = os.path.join(root, dirname)
shutil.rmtree(d) shutil.rmtree(d)
purge('.', '*.tfstate') purge(".", "*.tfstate")
purge('.', '*.tfstate.backup') purge(".", "*.tfstate.backup")
purge('.', '*.terraform') purge(".", "*.terraform")
purge('.', FILE_PATH_WITH_SPACE_AND_SPACIAL_CHARS) purge(".", FILE_PATH_WITH_SPACE_AND_SPACIAL_CHARS)
@pytest.mark.parametrize([ @pytest.mark.parametrize(["method", "expected"], STRING_CASES)
"method", "expected"
], STRING_CASES)
def test_generate_cmd_string(self, method, expected): def test_generate_cmd_string(self, method, expected):
tf = Terraform(working_dir=current_path) tf = Terraform(working_dir=current_path)
result = method(tf) result = method(tf)
@ -170,7 +187,16 @@ class TestTerraform(object):
assert s in result assert s in result
@pytest.mark.parametrize(*CMD_CASES) @pytest.mark.parametrize(*CMD_CASES)
def test_cmd(self, method, expected_output, expected_ret_code, expected_exception, expected_logs, string_logger, folder): def test_cmd(
self,
method,
expected_output,
expected_ret_code,
expected_exception,
expected_logs,
string_logger,
folder,
):
tf = Terraform(working_dir=current_path) tf = Terraform(working_dir=current_path)
tf.init(folder) tf.init(folder)
try: try:
@ -183,7 +209,7 @@ class TestTerraform(object):
err = e.err err = e.err
logs = string_logger() logs = string_logger()
logs = logs.replace('\n', '') logs = logs.replace("\n", "")
if isinstance(expected_output, list): if isinstance(expected_output, list):
ok = False ok = False
for xo in expected_output: for xo in expected_output:
@ -200,154 +226,161 @@ class TestTerraform(object):
@pytest.mark.parametrize( @pytest.mark.parametrize(
("folder", "variables", "var_files", "expected_output", "options"), ("folder", "variables", "var_files", "expected_output", "options"),
[ [
("var_to_output", ("var_to_output", {"test_var": "test"}, None, "test_output=test", {}),
{'test_var': 'test'}, None, "test_output=test", {}), (
("var_to_output", {'test_list_var': ['c', 'd']}, None, "test_list_output=[c,d]", {}), "var_to_output",
("var_to_output", {'test_map_var': {"c": "c", "d": "d"}}, None, "test_map_output={a=ab=bc=cd=d}", {}), {"test_list_var": ["c", "d"]},
("var_to_output", {'test_map_var': {"c": "c", "d": "d"}}, 'var_to_output/test_map_var.json', "test_map_output={a=ab=bc=cd=de=ef=f}", {}), None,
("var_to_output", {}, None, "\x1b[0m\x1b[1m\x1b[32mApplycomplete!", {"no_color": IsNotFlagged}) "test_list_output=[c,d]",
]) {},
),
(
"var_to_output",
{"test_map_var": {"c": "c", "d": "d"}},
None,
"test_map_output={a=ab=bc=cd=d}",
{},
),
(
"var_to_output",
{"test_map_var": {"c": "c", "d": "d"}},
"var_to_output/test_map_var.json",
"test_map_output={a=ab=bc=cd=de=ef=f}",
{},
),
(
"var_to_output",
{},
None,
"\x1b[0m\x1b[1m\x1b[32mApplycomplete!",
{"no_color": IsNotFlagged},
),
],
)
def test_apply(self, folder, variables, var_files, expected_output, options): def test_apply(self, folder, variables, var_files, expected_output, options):
tf = Terraform(working_dir=current_path, variables=variables, var_file=var_files) tf = Terraform(
working_dir=current_path, variables=variables, var_file=var_files
)
# after 0.10.0 we always need to init # after 0.10.0 we always need to init
tf.init(folder) tf.init(folder)
ret, out, err = tf.apply(folder, **options) ret, out, err = tf.apply(folder, **options)
assert ret == 0 assert ret == 0
assert expected_output in out.replace('\n', '').replace(' ', '') assert expected_output in out.replace("\n", "").replace(" ", "")
assert err == '' assert err == ""
def test_apply_with_var_file(self, string_logger): def test_apply_with_var_file(self, string_logger):
tf = Terraform(working_dir=current_path) tf = Terraform(working_dir=current_path)
tf.init() tf.init()
tf.apply(var_file=os.path.join(current_path, 'tfvar_file', 'test.tfvars')) tf.apply(var_file=os.path.join(current_path, "tfvar_file", "test.tfvars"))
logs = string_logger() logs = string_logger()
logs = logs.split('\n') logs = logs.split("\n")
for log in logs: for log in logs:
if log.startswith('command: terraform apply'): if log.startswith("command: terraform apply"):
assert log.count('-var-file=') == 1 assert log.count("-var-file=") == 1
@pytest.mark.parametrize( @pytest.mark.parametrize(
['cmd', 'args', 'options'], ["cmd", "args", "options"],
[ [
# bool value # bool value
('fmt', ['bad_fmt'], {'list': False, 'diff': False}) ("fmt", ["bad_fmt"], {"list": False, "diff": False})
] ],
) )
def test_options(self, cmd, args, options, fmt_test_file): def test_options(self, cmd, args, options, fmt_test_file):
tf = Terraform(working_dir=current_path) tf = Terraform(working_dir=current_path)
ret, out, err = getattr(tf, cmd)(*args, **options) ret, out, err = getattr(tf, cmd)(*args, **options)
assert ret == 0 assert ret == 0
assert out == '' assert out == ""
def test_state_data(self): def test_state_data(self):
cwd = os.path.join(current_path, 'test_tfstate_file') cwd = os.path.join(current_path, "test_tfstate_file")
tf = Terraform(working_dir=cwd, state='tfstate.test') tf = Terraform(working_dir=cwd, state="tfstate.test")
tf.read_state_file() tf.read_state_file()
assert tf.tfstate.modules[0]['path'] == ['root'] assert tf.tfstate.modules[0]["path"] == ["root"]
def test_state_default(self): def test_state_default(self):
cwd = os.path.join(current_path, 'test_tfstate_file2') cwd = os.path.join(current_path, "test_tfstate_file2")
tf = Terraform(working_dir=cwd) tf = Terraform(working_dir=cwd)
tf.read_state_file() tf.read_state_file()
assert tf.tfstate.modules[0]['path'] == ['default'] assert tf.tfstate.modules[0]["path"] == ["default"]
def test_state_default_backend(self): def test_state_default_backend(self):
cwd = os.path.join(current_path, 'test_tfstate_file3') cwd = os.path.join(current_path, "test_tfstate_file3")
tf = Terraform(working_dir=cwd) tf = Terraform(working_dir=cwd)
tf.read_state_file() tf.read_state_file()
assert tf.tfstate.modules[0]['path'] == ['default_backend'] assert tf.tfstate.modules[0]["path"] == ["default_backend"]
def test_pre_load_state_data(self): def test_pre_load_state_data(self):
cwd = os.path.join(current_path, 'test_tfstate_file') cwd = os.path.join(current_path, "test_tfstate_file")
tf = Terraform(working_dir=cwd, state='tfstate.test') tf = Terraform(working_dir=cwd, state="tfstate.test")
assert tf.tfstate.modules[0]['path'] == ['root'] assert tf.tfstate.modules[0]["path"] == ["root"]
@pytest.mark.parametrize( @pytest.mark.parametrize(
("folder", 'variables'), ("folder", "variables"), [("var_to_output", {"test_var": "test"})]
[
("var_to_output", {'test_var': 'test'})
]
) )
def test_override_default(self, folder, variables): def test_override_default(self, folder, variables):
tf = Terraform(working_dir=current_path, variables=variables) tf = Terraform(working_dir=current_path, variables=variables)
tf.init(folder) tf.init(folder)
ret, out, err = tf.apply(folder, var={'test_var': 'test2'}, ret, out, err = tf.apply(
no_color=IsNotFlagged) folder, var={"test_var": "test2"}, no_color=IsNotFlagged
out = out.replace('\n', '') )
assert '\x1b[0m\x1b[1m\x1b[32mApply' in out out = out.replace("\n", "")
out = tf.output('test_output') assert "\x1b[0m\x1b[1m\x1b[32mApply" in out
assert 'test2' in out out = tf.output("test_output")
assert "test2" in out
@pytest.mark.parametrize( @pytest.mark.parametrize(("param"), [({}), ({"module": "test2"}),])
("param"),
[
({}),
({'module': 'test2'}),
]
)
def test_output(self, param, string_logger): def test_output(self, param, string_logger):
tf = Terraform(working_dir=current_path, variables={'test_var': 'test'}) tf = Terraform(working_dir=current_path, variables={"test_var": "test"})
tf.init('var_to_output') tf.init("var_to_output")
tf.apply('var_to_output') tf.apply("var_to_output")
result = tf.output('test_output', **param) result = tf.output("test_output", **param)
regex = re.compile("terraform output (-module=test2 -json|-json -module=test2) test_output") regex = re.compile(
"terraform output (-module=test2 -json|-json -module=test2) test_output"
)
log_str = string_logger() log_str = string_logger()
if param: if param:
assert re.search(regex, log_str), log_str assert re.search(regex, log_str), log_str
else: else:
assert result == 'test' assert result == "test"
@pytest.mark.parametrize( @pytest.mark.parametrize(("param"), [({}), ({"module": "test2"}),])
("param"),
[
({}),
({'module': 'test2'}),
]
)
def test_output_full_value(self, param, string_logger): def test_output_full_value(self, param, string_logger):
tf = Terraform(working_dir=current_path, variables={'test_var': 'test'}) tf = Terraform(working_dir=current_path, variables={"test_var": "test"})
tf.init('var_to_output') tf.init("var_to_output")
tf.apply('var_to_output') tf.apply("var_to_output")
result = tf.output('test_output', **dict(param, full_value=True)) result = tf.output("test_output", **dict(param, full_value=True))
regex = re.compile("terraform output (-module=test2 -json|-json -module=test2) test_output") regex = re.compile(
"terraform output (-module=test2 -json|-json -module=test2) test_output"
)
log_str = string_logger() log_str = string_logger()
if param: if param:
assert re.search(regex, log_str), log_str assert re.search(regex, log_str), log_str
else: else:
assert result['value'] == 'test' assert result["value"] == "test"
@pytest.mark.parametrize( @pytest.mark.parametrize(("param"), [({}), ({"module": "test2"}),])
("param"),
[
({}),
({'module': 'test2'}),
]
)
def test_output_all(self, param, string_logger): def test_output_all(self, param, string_logger):
tf = Terraform(working_dir=current_path, variables={'test_var': 'test'}) tf = Terraform(working_dir=current_path, variables={"test_var": "test"})
tf.init('var_to_output') tf.init("var_to_output")
tf.apply('var_to_output') tf.apply("var_to_output")
result = tf.output(**param) result = tf.output(**param)
regex = re.compile("terraform output (-module=test2 -json|-json -module=test2)") regex = re.compile("terraform output (-module=test2 -json|-json -module=test2)")
log_str = string_logger() log_str = string_logger()
if param: if param:
assert re.search(regex, log_str), log_str assert re.search(regex, log_str), log_str
else: else:
assert result['test_output']['value'] == 'test' assert result["test_output"]["value"] == "test"
def test_destroy(self): def test_destroy(self):
tf = Terraform(working_dir=current_path, variables={'test_var': 'test'}) tf = Terraform(working_dir=current_path, variables={"test_var": "test"})
tf.init('var_to_output') tf.init("var_to_output")
ret, out, err = tf.destroy('var_to_output') ret, out, err = tf.destroy("var_to_output")
assert ret == 0 assert ret == 0
assert 'Destroy complete! Resources: 0 destroyed.' in out assert "Destroy complete! Resources: 0 destroyed." in out
@pytest.mark.parametrize( @pytest.mark.parametrize(
("plan", "variables", "expected_ret"), ("plan", "variables", "expected_ret"), [("vars_require_input", {}, 1)]
[
('vars_require_input', {}, 1)
]
) )
def test_plan(self, plan, variables, expected_ret): def test_plan(self, plan, variables, expected_ret):
tf = Terraform(working_dir=current_path, variables=variables) tf = Terraform(working_dir=current_path, variables=variables)
@ -355,103 +388,113 @@ class TestTerraform(object):
assert ret == expected_ret assert ret == expected_ret
def test_fmt(self, fmt_test_file): def test_fmt(self, fmt_test_file):
tf = Terraform(working_dir=current_path, variables={'test_var': 'test'}) tf = Terraform(working_dir=current_path, variables={"test_var": "test"})
ret, out, err = tf.fmt(diff=True) ret, out, err = tf.fmt(diff=True)
assert ret == 0 assert ret == 0
def test_import(self, string_logger): def test_import(self, string_logger):
tf = Terraform(working_dir=current_path) tf = Terraform(working_dir=current_path)
tf.import_cmd('aws_instance.foo', 'i-abc1234', no_color=IsFlagged) tf.import_cmd("aws_instance.foo", "i-abc1234", no_color=IsFlagged)
assert 'Command: terraform import -no-color aws_instance.foo i-abc1234' in string_logger() assert (
"Command: terraform import -no-color aws_instance.foo i-abc1234"
in string_logger()
)
def test_create_workspace(self, workspace_setup_teardown): def test_create_workspace(self, workspace_setup_teardown):
workspace_name = 'test' workspace_name = "test"
with workspace_setup_teardown(workspace_name, create=False) as tf: with workspace_setup_teardown(workspace_name, create=False) as tf:
ret, out, err = tf.create_workspace('test') ret, out, err = tf.create_workspace("test")
assert ret == 0 assert ret == 0
assert err == '' assert err == ""
def test_create_workspace_with_args( def test_create_workspace_with_args(self, workspace_setup_teardown, string_logger):
self, workspace_setup_teardown, string_logger workspace_name = "test"
): state_file_path = os.path.join(
workspace_name = 'test' current_path, "test_tfstate_file2", "terraform.tfstate"
state_file_path = os.path.join(current_path, 'test_tfstate_file2', 'terraform.tfstate') )
with workspace_setup_teardown(workspace_name, create=False) as tf: with workspace_setup_teardown(workspace_name, create=False) as tf:
ret, out, err = tf.create_workspace('test', current_path, no_color=IsFlagged) ret, out, err = tf.create_workspace(
"test", current_path, no_color=IsFlagged
)
assert ret == 0 assert ret == 0
assert err == '' assert err == ""
logs = string_logger() logs = string_logger()
logs = logs.replace('\n', '') logs = logs.replace("\n", "")
expected_log = 'Command: terraform workspace new -no-color test {}'.format(current_path) expected_log = "Command: terraform workspace new -no-color test {}".format(
current_path
)
assert expected_log in logs assert expected_log in logs
def test_set_workspace(self, workspace_setup_teardown): def test_set_workspace(self, workspace_setup_teardown):
workspace_name = 'test' workspace_name = "test"
with workspace_setup_teardown(workspace_name) as tf: with workspace_setup_teardown(workspace_name) as tf:
ret, out, err = tf.set_workspace(workspace_name) ret, out, err = tf.set_workspace(workspace_name)
assert ret == 0 assert ret == 0
assert err == '' assert err == ""
def test_set_workspace_with_args( def test_set_workspace_with_args(self, workspace_setup_teardown, string_logger):
self, workspace_setup_teardown, string_logger): workspace_name = "test"
workspace_name = 'test'
with workspace_setup_teardown(workspace_name) as tf: with workspace_setup_teardown(workspace_name) as tf:
ret, out, err = tf.set_workspace(workspace_name, current_path, no_color=IsFlagged) ret, out, err = tf.set_workspace(
workspace_name, current_path, no_color=IsFlagged
)
assert ret == 0 assert ret == 0
assert err == '' assert err == ""
logs = string_logger() logs = string_logger()
logs = logs.replace('\n', '') logs = logs.replace("\n", "")
expected_log = 'Command: terraform workspace select -no-color test {}'.format(current_path) expected_log = "Command: terraform workspace select -no-color test {}".format(
current_path
)
assert expected_log in logs assert expected_log in logs
def test_show_workspace(self, workspace_setup_teardown): def test_show_workspace(self, workspace_setup_teardown):
workspace_name = 'test' workspace_name = "test"
with workspace_setup_teardown(workspace_name) as tf: with workspace_setup_teardown(workspace_name) as tf:
ret, out, err = tf.show_workspace() ret, out, err = tf.show_workspace()
assert ret == 0 assert ret == 0
assert err == '' assert err == ""
def test_show_workspace_with_no_color( def test_show_workspace_with_no_color(
self, workspace_setup_teardown, string_logger self, workspace_setup_teardown, string_logger
): ):
workspace_name = 'test' workspace_name = "test"
with workspace_setup_teardown(workspace_name) as tf: with workspace_setup_teardown(workspace_name) as tf:
ret, out, err = tf.show_workspace(no_color=IsFlagged) ret, out, err = tf.show_workspace(no_color=IsFlagged)
assert ret == 0 assert ret == 0
assert err == '' assert err == ""
logs = string_logger() logs = string_logger()
logs = logs.replace('\n', '') logs = logs.replace("\n", "")
expected_log = 'Command: terraform workspace show -no-color' expected_log = "Command: terraform workspace show -no-color"
assert expected_log in logs assert expected_log in logs
def test_delete_workspace(self, workspace_setup_teardown): def test_delete_workspace(self, workspace_setup_teardown):
workspace_name = 'test' workspace_name = "test"
with workspace_setup_teardown(workspace_name, delete=False) as tf: with workspace_setup_teardown(workspace_name, delete=False) as tf:
tf.set_workspace('default') tf.set_workspace("default")
ret, out, err = tf.delete_workspace(workspace_name) ret, out, err = tf.delete_workspace(workspace_name)
assert ret == 0 assert ret == 0
assert err == '' assert err == ""
def test_delete_workspace_with_args( def test_delete_workspace_with_args(self, workspace_setup_teardown, string_logger):
self, workspace_setup_teardown, string_logger workspace_name = "test"
):
workspace_name = 'test'
with workspace_setup_teardown(workspace_name, delete=False) as tf: with workspace_setup_teardown(workspace_name, delete=False) as tf:
tf.set_workspace('default') tf.set_workspace("default")
ret, out, err = tf.delete_workspace( ret, out, err = tf.delete_workspace(
workspace_name, current_path, force=IsFlagged, workspace_name, current_path, force=IsFlagged,
) )
assert ret == 0 assert ret == 0
assert err == '' assert err == ""
logs = string_logger() logs = string_logger()
logs = logs.replace('\n', '') logs = logs.replace("\n", "")
expected_log = 'Command: terraform workspace delete -force test {}'.format(current_path) expected_log = "Command: terraform workspace delete -force test {}".format(
current_path
)
assert expected_log in logs assert expected_log in logs

2
test/var_to_output/test_map_var.json
View file

@ -4,4 +4,4 @@
"e": "e", "e": "e",
"f": "f" "f": "f"
} }
} }