update pants-plugins/sample_conf to pants 2.15

The Fmt/Lint plugin API changed in pants 2.15

It now requires a Subsystem with a SkipOption.
I took advantage of this to consolidate the constants and all
the address and pex request definitions in the Subsystem subclass.

It now requires 2 rules instead of 1: to partition, then fmt/lint.
That means the structure of the rule requests had to change
slightly. The tests also had to account for the modified rules.

Author: cognifloyd

pants-plugins/sample_conf/rules.py

@@ -13,15 +13,14 @@
 # limitations under the License.
 from dataclasses import dataclass
 
-from pants.backend.python.target_types import EntryPoint
 from pants.backend.python.util_rules import pex, pex_from_targets
 from pants.backend.python.util_rules.pex import (
     VenvPex,
     VenvPexProcess,
 )
 from pants.backend.python.util_rules.pex_from_targets import PexFromTargetsRequest
 from pants.core.goals.fmt import FmtResult, FmtTargetsRequest
-from pants.engine.addresses import Address
+from pants.core.util_rules.partitions import PartitionerType
 from pants.engine.fs import (
     CreateDigest,
     Digest,
@@ -31,17 +30,13 @@
 from pants.engine.process import FallibleProcessResult
 from pants.engine.rules import Get, collect_rules, rule
 from pants.engine.target import FieldSet
-from pants.engine.unions import UnionRule
 from pants.util.logging import LogLevel
+from pants.util.strutil import strip_v2_chroot_path
 
+from sample_conf.subsystem import ConfigGen
 from sample_conf.target_types import SampleConfSourceField
 
 
-# these constants are also used in the tests.
-SCRIPT_DIR = "tools"
-SCRIPT = "config_gen"
-
-
 @dataclass(frozen=True)
 class GenerateSampleConfFieldSet(FieldSet):
     required_fields = (SampleConfSourceField,)
@@ -51,37 +46,25 @@ class GenerateSampleConfFieldSet(FieldSet):
 
 class GenerateSampleConfViaFmtTargetsRequest(FmtTargetsRequest):
     field_set_type = GenerateSampleConfFieldSet
-    name = SCRIPT
+    tool_subsystem = ConfigGen
+    partitioner_type = PartitionerType.DEFAULT_SINGLE_PARTITION
 
 
 @rule(
-    desc=f"Update conf/st2.conf.sample with {SCRIPT_DIR}/{SCRIPT}.py",
+    desc=f"Update conf/st2.conf.sample with {ConfigGen.directory}/{ConfigGen.script}.py",
     level=LogLevel.DEBUG,
 )
 async def generate_sample_conf_via_fmt(
-    request: GenerateSampleConfViaFmtTargetsRequest,
+    request: GenerateSampleConfViaFmtTargetsRequest.Batch,
+    subsystem: ConfigGen,
 ) -> FmtResult:
     # There will only be one target+field_set, but we iterate
     # to satisfy how fmt expects that there could be more than one.
     # If there is more than one, they will all get the same contents.
 
     # actually generate it with an external script.
     # Generation cannot be inlined here because it needs to import the st2 code.
-    pex = await Get(
-        VenvPex,
-        PexFromTargetsRequest(
-            [
-                Address(
-                    SCRIPT_DIR,
-                    target_name=SCRIPT_DIR,
-                    relative_file_path=f"{SCRIPT}.py",
-                )
-            ],
-            output_filename=f"{SCRIPT}.pex",
-            internal_only=True,
-            main=EntryPoint(SCRIPT),
-        ),
-    )
+    pex = await Get(VenvPex, PexFromTargetsRequest, subsystem.pex_request())
 
     result = await Get(
         FallibleProcessResult,
@@ -91,23 +74,25 @@ async def generate_sample_conf_via_fmt(
         ),
     )
 
-    contents = [
-        FileContent(
-            f"{field_set.address.spec_path}/{field_set.source.value}",
-            result.stdout,
-        )
-        for field_set in request.field_sets
-    ]
+    contents = [FileContent(file, result.stdout) for file in request.files]
 
     output_digest = await Get(Digest, CreateDigest(contents))
     output_snapshot = await Get(Snapshot, Digest, output_digest)
-    return FmtResult.create(request, result, output_snapshot, strip_chroot_path=True)
+
+    return FmtResult(
+        input=request.snapshot,
+        output=output_snapshot,
+        # Drop result.stdout since we already wrote it to a file
+        stdout="",
+        stderr=strip_v2_chroot_path(result.stderr),
+        tool_name=request.tool_name,
+    )
 
 
 def rules():
     return [
         *collect_rules(),
-        UnionRule(FmtTargetsRequest, GenerateSampleConfViaFmtTargetsRequest),
+        *GenerateSampleConfViaFmtTargetsRequest.rules(),
         *pex.rules(),
         *pex_from_targets.rules(),
     ]

pants-plugins/sample_conf/rules_test.py

@@ -23,15 +23,15 @@
 from pants.engine.fs import CreateDigest, Digest, FileContent, Snapshot
 from pants.engine.target import Target
 from pants.core.goals.fmt import FmtResult
+from pants.core.util_rules.partitions import Partitions
 from pants.testutil.rule_runner import QueryRule, RuleRunner
 
 from .rules import (
-    SCRIPT,
-    SCRIPT_DIR,
     GenerateSampleConfFieldSet,
     GenerateSampleConfViaFmtTargetsRequest,
     rules as sample_conf_rules,
 )
+from .subsystem import ConfigGen
 from .target_types import SampleConf
 
 
@@ -41,7 +41,10 @@ def rule_runner() -> RuleRunner:
         rules=[
             *sample_conf_rules(),
             *target_types_rules.rules(),
-            QueryRule(FmtResult, (GenerateSampleConfViaFmtTargetsRequest,)),
+            QueryRule(
+                Partitions, (GenerateSampleConfViaFmtTargetsRequest.PartitionRequest,)
+            ),
+            QueryRule(FmtResult, (GenerateSampleConfViaFmtTargetsRequest.Batch,)),
             QueryRule(SourceFiles, (SourceFilesRequest,)),
         ],
         target_types=[SampleConf, PythonSourcesGeneratorTarget],
@@ -57,23 +60,35 @@ def run_st2_generate_sample_conf(
     rule_runner.set_options(
         [
             "--backend-packages=sample_conf",
-            f"--source-root-patterns=/{SCRIPT_DIR}",
+            f"--source-root-patterns=/{ConfigGen.directory}",
             *(extra_args or ()),
         ],
         env_inherit={"PATH", "PYENV_ROOT", "HOME"},
     )
-    field_sets = [GenerateSampleConfFieldSet.create(tgt) for tgt in targets]
+    field_sets = tuple(GenerateSampleConfFieldSet.create(tgt) for tgt in targets)
     input_sources = rule_runner.request(
         SourceFiles,
         [
             SourceFilesRequest(field_set.source for field_set in field_sets),
         ],
     )
+
+    # run DEFAULT_SINGLE_PARTITION rule
+    partitions = rule_runner.request(
+        Partitions,
+        [GenerateSampleConfViaFmtTargetsRequest.PartitionRequest(field_sets)],
+    )
+    assert len(partitions) == 1
+
+    # run generate_schemas_via_fmt rule
     fmt_result = rule_runner.request(
         FmtResult,
         [
-            GenerateSampleConfViaFmtTargetsRequest(
-                field_sets, snapshot=input_sources.snapshot
+            GenerateSampleConfViaFmtTargetsRequest.Batch(
+                tool_name="",
+                elements=partitions[0].elements,  # ie: files
+                partition_metadata=partitions[0].metadata,
+                snapshot=input_sources.snapshot,
             ),
         ],
     )
@@ -112,9 +127,11 @@ def write_files(
         f"{sample_conf_dir}/{sample_conf_file}": before,
         f"{sample_conf_dir}/BUILD": f"sample_conf(name='t', source='{sample_conf_file}')",
         # add in the target that's hard-coded in the generate_sample_conf_via_fmt rue
-        f"{SCRIPT_DIR}/{SCRIPT}.py": SCRIPT_PY.format(sample_conf_text=after),
-        f"{SCRIPT_DIR}/__init__.py": "",
-        f"{SCRIPT_DIR}/BUILD": "python_sources()",
+        f"{ConfigGen.directory}/{ConfigGen.script}.py": SCRIPT_PY.format(
+            sample_conf_text=after
+        ),
+        f"{ConfigGen.directory}/__init__.py": "",
+        f"{ConfigGen.directory}/BUILD": "python_sources()",
     }
 
     rule_runner.write_files(files)

pants-plugins/sample_conf/subsystem.py

@@ -0,0 +1,43 @@
+# Copyright 2023 The StackStorm Authors.
+#
+# 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.
+from pants.backend.python.target_types import EntryPoint
+from pants.backend.python.util_rules.pex_from_targets import PexFromTargetsRequest
+from pants.engine.addresses import Address
+from pants.option.option_types import SkipOption
+from pants.option.subsystem import Subsystem
+
+
+class ConfigGen(Subsystem):
+    name = "StackStorm Sample st2.conf Generator"
+    options_scope = "st2-config-gen"
+    skip = SkipOption("fmt", "lint")
+    help = "The StackStorm st2.conf.sample generator."
+
+    directory = "tools"
+    script = "config_gen"
+
+    def address(self) -> Address:
+        return Address(
+            self.directory,
+            target_name=self.directory,
+            relative_file_path=f"{self.script}.py",
+        )
+
+    def pex_request(self) -> PexFromTargetsRequest:
+        return PexFromTargetsRequest(
+            [self.address()],
+            output_filename=f"{self.script}.pex",
+            internal_only=True,
+            main=EntryPoint(self.script),
+        )