819894d2ba
* IAM modules refactor proposal * policy * subheading * Update 20230816-iam-refactor.md * log Julio's +1 * data-catalog-policy-tag * dataproc * dataproc * folder * folder * folder * folder * project * better filtering in test examples * project * folder * folder * organization * fix variable descriptions * kms * net-vpc * dataplex-datascan * modules/iam-service-account * modules/source-repository/ * blueprints/cloud-operations/vm-migration/ * blueprints/third-party-solutions/wordpress * dataplex-datascan * blueprints/cloud-operations/workload-identity-federation * blueprints/data-solutions/cloudsql-multiregion/ * blueprints/data-solutions/composer-2 * Update 20230816-iam-refactor.md * Update 20230816-iam-refactor.md * capture discussion in architectural doc * update variable names and refactor proposal * project * blueprints first round * folder * organization * data-catalog-policy-tag * re-enable folder inventory * project module style fix * dataproc * source-repository * source-repository tests * dataplex-datascan * dataplex-datascan tests * net-vpc * net-vpc test examples * iam-service-account * iam-service-account test examples * kms * boilerplate * tfdoc * fix module tests * more blueprint fixes * fix typo in data blueprints * incomplete refactor of data platform foundations * tfdoc * data platform foundation * refactor data platform foundation iam locals * remove redundant example test * shielded folder fix * fix typo * project factory * project factory outputs * tfdoc * test workflow: less verbose tests, fix tf version * re-enable -vv, shorter traceback, fix action version * ignore github extension warning, re-enable action version * fast bootstrap IAM, untested * bootstrap stage IAM fixes * stage 0 tests * fast stage 1 * tenant stage 1 * minor changes to fast stage 0 and 1 * fast security stage * fast mt stage 0 * fast mt stage 0 * fast pf
76 lines
2.6 KiB
Python
76 lines
2.6 KiB
Python
# Copyright 2023 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.
|
|
"""Pytest configuration for testing code examples."""
|
|
|
|
import collections
|
|
import re
|
|
from pathlib import Path
|
|
|
|
import marko
|
|
|
|
FABRIC_ROOT = Path(__file__).parents[2]
|
|
|
|
FILE_TEST_RE = re.compile(r'# tftest-file +id=([\w_.-]+) +path=([\S]+)')
|
|
|
|
Example = collections.namedtuple('Example', 'name code module files')
|
|
File = collections.namedtuple('File', 'path content')
|
|
|
|
|
|
def pytest_generate_tests(metafunc):
|
|
"""Find all README.md files and collect code examples tagged for testing."""
|
|
if 'example' in metafunc.fixturenames:
|
|
readmes = FABRIC_ROOT.glob('**/README.md')
|
|
examples = []
|
|
ids = []
|
|
|
|
for readme in readmes:
|
|
module = readme.parent
|
|
doc = marko.parse(readme.read_text())
|
|
index = 0
|
|
files = collections.defaultdict(dict)
|
|
|
|
# first pass: collect all examples tagged with tftest-file
|
|
last_header = None
|
|
for child in doc.children:
|
|
if isinstance(child, marko.block.FencedCode):
|
|
code = child.children[0].children
|
|
match = FILE_TEST_RE.search(code)
|
|
if match:
|
|
name, path = match.groups()
|
|
files[last_header][name] = File(path, code)
|
|
elif isinstance(child, marko.block.Heading):
|
|
last_header = child.children[0].children
|
|
|
|
# second pass: collect all examples tagged with tftest
|
|
last_header = None
|
|
index = 0
|
|
for child in doc.children:
|
|
if isinstance(child, marko.block.FencedCode):
|
|
index += 1
|
|
code = child.children[0].children
|
|
if 'tftest skip' in code:
|
|
continue
|
|
if child.lang == 'hcl':
|
|
path = module.relative_to(FABRIC_ROOT)
|
|
name = f'{path}:{last_header}'
|
|
if index > 1:
|
|
name += f' {index}'
|
|
ids.append(f'{path}:{last_header}:{index}')
|
|
examples.append(Example(name, code, path, files[last_header]))
|
|
elif isinstance(child, marko.block.Heading):
|
|
last_header = child.children[0].children
|
|
index = 0
|
|
|
|
metafunc.parametrize('example', examples, ids=ids)
|