Merge pull request #5890: pants: Add st2_shell_sources_and_resources() macro to pants-plugins/macros.py

Author: cognifloyd

CHANGELOG.rst

@@ -16,6 +16,7 @@ Added
   to pants' use of PEX lockfiles. This is not a user-facing addition.
   #5778 #5789 #5817 #5795 #5830 #5833 #5834 #5841 #5840 #5838 #5842 #5837 #5849 #5850
   #5846 #5853 #5848 #5847 #5858 #5857 #5860 #5868 #5871 #5864 #5874 #5884 #5893 #5891
+  #5890
   Contributed by @cognifloyd
 
 * Added a joint index to solve the problem of slow mongo queries for scheduled executions. #5805

pants-plugins/BUILD

@@ -11,3 +11,5 @@ pants_requirements(
     name="pants",
     testutil=True,
 )
+
+python_sources()

pants-plugins/README.md

@@ -16,6 +16,7 @@ These StackStorm-specific plugins might be useful in other StackStorm-related re
 
 These StackStorm-specific plugins are probably only useful for the st2 repo.
 - `api_spec`
+- `macros.py` (not a plugin - see pants.toml `[GLOBAL].build_file_prelude_globs`)
 - `release`
 - `sample_conf`
 - `schemas`
@@ -33,6 +34,16 @@ This plugin also wires up pants so that the `lint` goal runs additional
 api spec validation on `st2common/st2common/openapi.yaml` with something
 like `./pants lint st2common/st2common/openapi.yaml`.
 
+### `macros.py` macros
+
+[Macros](https://www.pantsbuild.org/docs/macros) are a pants feature
+that can reduce "boilerplate"/duplication in BUILD files. The functions
+defined in `macros.py` are available in all the BUILD files, and using
+them looks just like using the normal BUILD targets.
+
+For documentation about our macros, please refer to the function docstrings
+in the `macros.py` file.
+
 ### `pack_metadata` plugin
 
 This plugin adds two new targets to pants:

pants-plugins/macros.py

@@ -0,0 +1,28 @@
+# 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.
+
+
+def st2_shell_sources_and_resources(**kwargs):
+    """This creates a shell_sources and a resources target.
+
+    This is needed because python_sources dependencies on shell_sources
+    are silently ignored. So, we also need the resources target
+    to allow depending on them.
+    """
+    shell_sources(**kwargs)  # noqa: F821
+
+    kwargs.pop("skip_shellcheck", None)
+
+    kwargs["name"] += "_resources"
+    resources(**kwargs)  # noqa: F821

pants.toml

@@ -8,6 +8,7 @@ repo_id = "de0dea7a-9f6a-4c6e-aa20-6ba5ad969b8a"
 [GLOBAL]
 pants_version = "2.14.0"
 pythonpath = ["%(buildroot)s/pants-plugins"]
+build_file_prelude_globs = ["pants-plugins/macros.py"]
 backend_packages = [
   # python
   "pants.backend.python",

st2actions/bin/BUILD

@@ -5,7 +5,8 @@ python_sources(
     skip_pylint=True,
 )
 
-shell_sources(
+st2_shell_sources_and_resources(
     name="shell",
+    sources=["*.sh"],
     skip_shellcheck=True,
 )

st2common/bin/BUILD

@@ -5,7 +5,7 @@ python_sources(
     skip_pylint=True,
 )
 
-shell_sources(
+st2_shell_sources_and_resources(
     name="shell",
     sources=["st2ctl", "st2-self-check", "st2-run-pack-tests"],
     skip_shellcheck=True,

st2tests/st2tests/fixtures/generic/BUILD

@@ -1,5 +1,9 @@
 pack_metadata(
     name="metadata",
+    dependencies=[
+        "./actions:shell",
+        "./actions:shell_resources",
+    ],
 )
 
 python_sources(

st2tests/st2tests/fixtures/generic/actions/BUILD

@@ -1 +1,4 @@
-shell_sources()
+st2_shell_sources_and_resources(
+    name="shell",
+    sources=["*.sh"],
+)

st2tests/st2tests/fixtures/packs/BUILD

@@ -13,7 +13,7 @@ pack_metadata_in_git_submodule(
     ],
 )
 
-shell_sources(
+st2_shell_sources_and_resources(
     name="test_content_version_shell",
     # do not check across git submodule boundary
     skip_shellcheck=True,
@@ -29,6 +29,7 @@ python_sources(
     dependencies=[
         ":test_content_version_metadata",
         ":test_content_version_shell",
+        ":test_content_version_shell_resources",
     ],
     sources=[
         "test_content_version/**/*.py",