|
| 1 | +# Copyright 2023 The StackStorm Authors. |
| 2 | +# |
| 3 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +# you may not use this file except in compliance with the License. |
| 5 | +# You may obtain a copy of the License at |
| 6 | +# |
| 7 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +# |
| 9 | +# Unless required by applicable law or agreed to in writing, software |
| 10 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +# See the License for the specific language governing permissions and |
| 13 | +# limitations under the License. |
| 14 | +from __future__ import annotations |
| 15 | + |
| 16 | +import pytest |
| 17 | + |
| 18 | +from pants.backend.python import target_types_rules |
| 19 | +from pants.backend.python.target_types import PythonSourcesGeneratorTarget |
| 20 | + |
| 21 | +from pants.core.util_rules.source_files import SourceFiles, SourceFilesRequest |
| 22 | +from pants.engine.addresses import Address |
| 23 | +from pants.engine.fs import CreateDigest, Digest, FileContent, Snapshot |
| 24 | +from pants.engine.target import Target |
| 25 | +from pants.core.goals.fmt import FmtResult |
| 26 | +from pants.testutil.rule_runner import QueryRule, RuleRunner |
| 27 | + |
| 28 | +from .rules import ( |
| 29 | + SCRIPT, |
| 30 | + SCRIPT_DIR, |
| 31 | + GenerateSampleConfFieldSet, |
| 32 | + GenerateSampleConfViaFmtTargetsRequest, |
| 33 | + rules as sample_conf_rules, |
| 34 | +) |
| 35 | +from .target_types import SampleConf |
| 36 | + |
| 37 | + |
| 38 | +@pytest.fixture |
| 39 | +def rule_runner() -> RuleRunner: |
| 40 | + return RuleRunner( |
| 41 | + rules=[ |
| 42 | + *sample_conf_rules(), |
| 43 | + *target_types_rules.rules(), |
| 44 | + QueryRule(FmtResult, (GenerateSampleConfViaFmtTargetsRequest,)), |
| 45 | + QueryRule(SourceFiles, (SourceFilesRequest,)), |
| 46 | + ], |
| 47 | + target_types=[SampleConf, PythonSourcesGeneratorTarget], |
| 48 | + ) |
| 49 | + |
| 50 | + |
| 51 | +def run_st2_generate_sample_conf( |
| 52 | + rule_runner: RuleRunner, |
| 53 | + targets: list[Target], |
| 54 | + *, |
| 55 | + extra_args: list[str] | None = None, |
| 56 | +) -> FmtResult: |
| 57 | + rule_runner.set_options( |
| 58 | + [ |
| 59 | + "--backend-packages=sample_conf", |
| 60 | + f"--source-root-patterns=/{SCRIPT_DIR}", |
| 61 | + *(extra_args or ()), |
| 62 | + ], |
| 63 | + env_inherit={"PATH", "PYENV_ROOT", "HOME"}, |
| 64 | + ) |
| 65 | + field_sets = [GenerateSampleConfFieldSet.create(tgt) for tgt in targets] |
| 66 | + input_sources = rule_runner.request( |
| 67 | + SourceFiles, |
| 68 | + [ |
| 69 | + SourceFilesRequest(field_set.source for field_set in field_sets), |
| 70 | + ], |
| 71 | + ) |
| 72 | + fmt_result = rule_runner.request( |
| 73 | + FmtResult, |
| 74 | + [ |
| 75 | + GenerateSampleConfViaFmtTargetsRequest( |
| 76 | + field_sets, snapshot=input_sources.snapshot |
| 77 | + ), |
| 78 | + ], |
| 79 | + ) |
| 80 | + return fmt_result |
| 81 | + |
| 82 | + |
| 83 | +# copied from pantsbuild/pants.git/src/python/pants/backend/python/lint/black/rules_integration_test.py |
| 84 | +def get_snapshot(rule_runner: RuleRunner, source_files: dict[str, str]) -> Snapshot: |
| 85 | + files = [ |
| 86 | + FileContent(path, content.encode()) for path, content in source_files.items() |
| 87 | + ] |
| 88 | + digest = rule_runner.request(Digest, [CreateDigest(files)]) |
| 89 | + return rule_runner.request(Snapshot, [digest]) |
| 90 | + |
| 91 | + |
| 92 | +# add dummy script at tools/config_gen.py that the test can load. |
| 93 | +SCRIPT_PY = """ |
| 94 | +def main(): |
| 95 | + sample_conf_text = "{sample_conf_text}" |
| 96 | + print(sample_conf_text) |
| 97 | +
|
| 98 | +
|
| 99 | +if __name__ == "__main__": |
| 100 | + main() |
| 101 | +""" |
| 102 | + |
| 103 | + |
| 104 | +def write_files( |
| 105 | + sample_conf_dir: str, |
| 106 | + sample_conf_file: str, |
| 107 | + before: str, |
| 108 | + after: str, |
| 109 | + rule_runner: RuleRunner, |
| 110 | +) -> None: |
| 111 | + files = { |
| 112 | + f"{sample_conf_dir}/{sample_conf_file}": before, |
| 113 | + f"{sample_conf_dir}/BUILD": f"sample_conf(name='t', source='{sample_conf_file}')", |
| 114 | + # add in the target that's hard-coded in the generate_sample_conf_via_fmt rue |
| 115 | + f"{SCRIPT_DIR}/{SCRIPT}.py": SCRIPT_PY.format(sample_conf_text=after), |
| 116 | + f"{SCRIPT_DIR}/__init__.py": "", |
| 117 | + f"{SCRIPT_DIR}/BUILD": "python_sources()", |
| 118 | + } |
| 119 | + |
| 120 | + rule_runner.write_files(files) |
| 121 | + |
| 122 | + |
| 123 | +def test_changed(rule_runner: RuleRunner) -> None: |
| 124 | + write_files( |
| 125 | + sample_conf_dir="my_dir", |
| 126 | + sample_conf_file="dummy.conf", |
| 127 | + before="BEFORE", |
| 128 | + after="AFTER", |
| 129 | + rule_runner=rule_runner, |
| 130 | + ) |
| 131 | + |
| 132 | + tgt = rule_runner.get_target( |
| 133 | + Address("my_dir", target_name="t", relative_file_path="dummy.conf") |
| 134 | + ) |
| 135 | + fmt_result = run_st2_generate_sample_conf(rule_runner, [tgt]) |
| 136 | + assert fmt_result.output == get_snapshot( |
| 137 | + rule_runner, {"my_dir/dummy.conf": "AFTER\n"} |
| 138 | + ) |
| 139 | + assert fmt_result.did_change is True |
| 140 | + |
| 141 | + |
| 142 | +def test_unchanged(rule_runner: RuleRunner) -> None: |
| 143 | + write_files( |
| 144 | + sample_conf_dir="my_dir", |
| 145 | + sample_conf_file="dummy.conf", |
| 146 | + before="AFTER\n", |
| 147 | + after="AFTER", # print() adds a newline |
| 148 | + rule_runner=rule_runner, |
| 149 | + ) |
| 150 | + |
| 151 | + tgt = rule_runner.get_target( |
| 152 | + Address("my_dir", target_name="t", relative_file_path="dummy.conf") |
| 153 | + ) |
| 154 | + fmt_result = run_st2_generate_sample_conf(rule_runner, [tgt]) |
| 155 | + assert fmt_result.output == get_snapshot( |
| 156 | + rule_runner, {"my_dir/dummy.conf": "AFTER\n"} |
| 157 | + ) |
| 158 | + assert fmt_result.did_change is False |
0 commit comments