132 lines
5.0 KiB
Python
132 lines
5.0 KiB
Python
# Copyright 2026 Google LLC
|
|
#
|
|
# 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 json
|
|
import os
|
|
import shutil
|
|
import subprocess
|
|
import tempfile
|
|
from pathlib import Path
|
|
|
|
import jsonschema
|
|
import yaml
|
|
|
|
from .utils import TerraformExample, YamlExample
|
|
|
|
BASE_PATH = Path(__file__).parent
|
|
|
|
|
|
def prepare_files(example, test_path, files, fixtures):
|
|
if files is not None:
|
|
requested_files = files.split(',')
|
|
for f in requested_files:
|
|
destination = test_path / example.files[f].path
|
|
destination.parent.mkdir(parents=True, exist_ok=True)
|
|
destination.write_text(example.files[f].content)
|
|
|
|
if fixtures is not None:
|
|
requested_fixtures = fixtures.split(',')
|
|
for f in requested_fixtures:
|
|
if f.startswith('fixtures/'):
|
|
# fixture is specified referencing a global fixture in (tests/fixtures/)
|
|
source = BASE_PATH.parent / f
|
|
destination = test_path / source.name
|
|
destination.symlink_to(source)
|
|
else:
|
|
# fixture is specified using an inline tftest-fixture tag
|
|
destination = test_path / f'{f}.tf'
|
|
destination.write_text(example.fixtures[f])
|
|
|
|
|
|
def _test_terraform_example(plan_validator, example):
|
|
directive = example.directive
|
|
|
|
# for tfvars-based tests, create the temporary directory with the
|
|
# same parent as the original module
|
|
directory = example.module.parent if example.type == 'tfvars' else None
|
|
prefix = f'pytest-{example.module.name}'
|
|
with tempfile.TemporaryDirectory(prefix=prefix, dir=directory) as tmp_path:
|
|
tmp_path = Path(tmp_path)
|
|
tf_var_files = []
|
|
if example.type == 'hcl':
|
|
(tmp_path / 'fabric').symlink_to(BASE_PATH.parents[1])
|
|
(tmp_path / 'variables.tf').symlink_to(BASE_PATH / 'variables.tf')
|
|
(tmp_path / 'main.tf').write_text(example.code)
|
|
assets_path = (BASE_PATH.parent / str(example.module).replace('-', '_') /
|
|
'assets')
|
|
if assets_path.exists():
|
|
(tmp_path / 'assets').symlink_to(assets_path)
|
|
|
|
prepare_files(example, tmp_path, directive.kwargs.get('files'),
|
|
directive.kwargs.get('fixtures'))
|
|
elif example.type == 'tfvars':
|
|
(tmp_path / 'terraform.auto.tfvars').write_text(example.code)
|
|
shutil.copytree(example.module, tmp_path, dirs_exist_ok=True)
|
|
tf_var_files = [(tmp_path / 'terraform.auto.tfvars').resolve()]
|
|
|
|
inventory = []
|
|
if directive.kwargs.get('inventory') is not None:
|
|
python_test_path = str(example.module).replace('-', '_')
|
|
inventory = BASE_PATH.parent / python_test_path / 'examples'
|
|
inventory = inventory / directive.kwargs['inventory']
|
|
|
|
try:
|
|
summary = plan_validator(module_path=tmp_path, inventory_paths=inventory,
|
|
tf_var_files=tf_var_files)
|
|
except AssertionError:
|
|
repo_root = BASE_PATH.parents[1]
|
|
readme_rel = example.readme_path.relative_to(repo_root)
|
|
index_arg = f" --index {example.index}" if example.index > 1 else ""
|
|
print(
|
|
f'To regenerate inventory run:\nuv run tools/generate_plan_summary.py '
|
|
f'{readme_rel} "{example.header}"{index_arg} --save')
|
|
raise
|
|
|
|
print('\n')
|
|
print(yaml.dump({'values': summary.values}))
|
|
print(yaml.dump({'counts': summary.counts}))
|
|
print(yaml.dump({'outputs': summary.outputs}))
|
|
|
|
counts = summary.counts
|
|
num_modules, num_resources = counts['modules'], counts['resources']
|
|
|
|
if expected_modules := directive.kwargs.get('modules'):
|
|
expected_modules = int(expected_modules)
|
|
assert expected_modules == num_modules, 'wrong number of modules'
|
|
if expected_resources := directive.kwargs.get('resources'):
|
|
expected_resources = int(expected_resources)
|
|
assert expected_resources == num_resources, 'wrong number of resources'
|
|
|
|
# TODO(jccb): this should probably be done in check_documentation
|
|
# but we already have all the data here.
|
|
binary = os.environ.get('TERRAFORM', 'terraform')
|
|
result = subprocess.run(
|
|
f'{binary} fmt -check -diff -no-color main.tf'.split(), cwd=tmp_path,
|
|
stdout=subprocess.PIPE, encoding='utf-8')
|
|
assert result.returncode == 0, f'[{example.name}] terraform example code in README.md not formatted correctly\n{result.stdout}'
|
|
|
|
|
|
def _test_yaml_example(example):
|
|
yaml_object = yaml.safe_load(example.body)
|
|
schema = json.load(example.schema.open())
|
|
jsonschema.validate(instance=yaml_object, schema=schema)
|
|
|
|
|
|
def test_example(plan_validator, example):
|
|
match example:
|
|
case TerraformExample():
|
|
_test_terraform_example(plan_validator, example)
|
|
case YamlExample():
|
|
_test_yaml_example(example)
|