Pants: Add pack_metadata targets to BUILD files (#5871)

* pants: add pack_metadata targets * add packs_metadata and related targets * Add pack_metadata dependencies * Add pack_metadata for more fixtures * Allow pants to detect packs fixture usage * Cleanup fixtures BUILD files Several fixtures have been adjusted so pants can infer them. So, I dropped the hard-coded dep in the BUILD files. * add BUILD metadata for st2tests/testpacks * depend on pack_metadata in st2tests.fixtures.packs.core.fixture * Add pack_metadata targets in st2reactor pack fixtures * Enable pants-plugins/pack_metadata This reverts commit 4a1b241. * update changelog entry * disable spurious pack_metadata target where there is no metadata * add pack_metadata to contrib/debug with `./pants tailor ::`
StackStorm · Jan 27, 2023 · 6e773e6 · 6e773e6
1 parent 33a5039
commit 6e773e6
Show file tree

Hide file tree

Showing 68 changed files with 389 additions and 45 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -14,7 +14,7 @@ Added
   working on StackStorm, improve our security posture, and improve CI reliability thanks in part
   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
+  #5846 #5853 #5848 #5847 #5858 #5857 #5860 #5868 #5871
   Contributed by @cognifloyd
 
 * Added a joint index to solve the problem of slow mongo queries for scheduled executions. #5805

diff --git a/contrib/chatops/BUILD b/contrib/chatops/BUILD
@@ -0,0 +1,3 @@
+pack_metadata(
+    name="metadata",
+)
diff --git a/contrib/core/BUILD b/contrib/core/BUILD
@@ -1,4 +1,6 @@
-python_sources()
+pack_metadata(
+    name="metadata",
+)
 
 python_requirements(
     name="reqs",
@@ -7,3 +9,7 @@ python_requirements(
     # https://github.com/pantsbuild/pants/pull/17390
     module_mapping={"mail-parser": ["mailparser"]},
 )
+
+python_sources(
+    dependencies=[":metadata"],
+)
diff --git a/contrib/debug/BUILD b/contrib/debug/BUILD
@@ -0,0 +1,3 @@
+pack_metadata(
+    name="metadata",
+)
diff --git a/contrib/default/BUILD b/contrib/default/BUILD
@@ -0,0 +1,3 @@
+pack_metadata(
+    name="metadata",
+)
diff --git a/contrib/examples/BUILD b/contrib/examples/BUILD
@@ -1,3 +1,7 @@
+pack_metadata(
+    name="metadata",
+)
+
 # Using `python_requirements()` here results in:
 # ">1 target exports this module, so it is ambiguous which to use"
 # This error refers to the "requests" module.

diff --git a/contrib/hello_st2/BUILD b/contrib/hello_st2/BUILD
@@ -0,0 +1,3 @@
+pack_metadata(
+    name="metadata",
+)
diff --git a/contrib/linux/BUILD b/contrib/linux/BUILD
@@ -1,3 +1,7 @@
+pack_metadata(
+    name="metadata",
+)
+
 python_requirements(
     name="reqs",
 )
diff --git a/contrib/packs/BUILD b/contrib/packs/BUILD
@@ -0,0 +1,3 @@
+pack_metadata(
+    name="metadata",
+)
diff --git a/contrib/packs/tests/fixtures/BUILD b/contrib/packs/tests/fixtures/BUILD
@@ -1 +1,8 @@
-python_sources()
+python_sources(
+    dependencies=[
+        "./stackstorm-test:metadata",
+        "./stackstorm-test2:metadata",
+        "./stackstorm-test3:metadata",
+        "./stackstorm-test4:metadata",
+    ],
+)
diff --git a/contrib/packs/tests/fixtures/stackstorm-test/BUILD b/contrib/packs/tests/fixtures/stackstorm-test/BUILD
@@ -0,0 +1,3 @@
+pack_metadata(
+    name="metadata",
+)
diff --git a/contrib/packs/tests/fixtures/stackstorm-test2/BUILD b/contrib/packs/tests/fixtures/stackstorm-test2/BUILD
@@ -0,0 +1,3 @@
+pack_metadata(
+    name="metadata",
+)
diff --git a/contrib/packs/tests/fixtures/stackstorm-test3/BUILD b/contrib/packs/tests/fixtures/stackstorm-test3/BUILD
@@ -0,0 +1,3 @@
+pack_metadata(
+    name="metadata",
+)
diff --git a/contrib/packs/tests/fixtures/stackstorm-test4/BUILD b/contrib/packs/tests/fixtures/stackstorm-test4/BUILD
@@ -0,0 +1,3 @@
+pack_metadata(
+    name="metadata",
+)
diff --git a/pants.toml b/pants.toml
@@ -25,7 +25,7 @@ backend_packages = [
   # internal plugins in pants-plugins/
   "pants.backend.plugin_development",
   "api_spec",
-  #"pack_metadata",
+  "pack_metadata",
   "sample_conf",
   "schemas",
 ]

diff --git a/st2reactor/tests/fixtures/packs/pack_with_rules/BUILD b/st2reactor/tests/fixtures/packs/pack_with_rules/BUILD
@@ -1 +1,7 @@
-python_sources()
+pack_metadata(
+    name="metadata",
+)
+
+python_sources(
+    dependencies=[":metadata"],
+)
diff --git a/st2reactor/tests/fixtures/packs/pack_with_sensor/BUILD b/st2reactor/tests/fixtures/packs/pack_with_sensor/BUILD
@@ -1 +1,7 @@
-python_sources()
+pack_metadata(
+    name="metadata",
+)
+
+python_sources(
+    dependencies=[":metadata"],
+)
diff --git a/st2tests/st2tests/fixtures/aliases/BUILD b/st2tests/st2tests/fixtures/aliases/BUILD
@@ -1 +1,7 @@
-python_sources()
+pack_metadata(
+    name="metadata",
+)
+
+python_sources(
+    dependencies=[":metadata"],
+)
diff --git a/st2tests/st2tests/fixtures/backstop/BUILD b/st2tests/st2tests/fixtures/backstop/BUILD
@@ -1 +1,7 @@
-python_sources()
+pack_metadata(
+    name="metadata",
+)
+
+python_sources(
+    dependencies=[":metadata"],
+)
diff --git a/st2tests/st2tests/fixtures/descendants/BUILD b/st2tests/st2tests/fixtures/descendants/BUILD
@@ -1 +1,7 @@
-python_sources()
+pack_metadata(
+    name="metadata",
+)
+
+python_sources(
+    dependencies=[":metadata"],
+)
diff --git a/st2tests/st2tests/fixtures/generic/BUILD b/st2tests/st2tests/fixtures/generic/BUILD
@@ -1 +1,7 @@
-python_sources()
+pack_metadata(
+    name="metadata",
+)
+
+python_sources(
+    dependencies=[":metadata"],
+)
diff --git a/st2tests/st2tests/fixtures/localrunner_pack/BUILD b/st2tests/st2tests/fixtures/localrunner_pack/BUILD
@@ -1 +1,7 @@
-python_sources()
+pack_metadata(
+    name="metadata",
+)
+
+python_sources(
+    dependencies=[":metadata"],
+)
diff --git a/st2tests/st2tests/fixtures/packs/BUILD b/st2tests/st2tests/fixtures/packs/BUILD
@@ -3,8 +3,7 @@
 # instructions on how to checkout the submodules if they are not checked out.
 # The test_content_version* targets are dependencies of ./test_content_version_fixture
 
-# pack_metadata_in_git_submodule(
-resources(
+pack_metadata_in_git_submodule(
     name="test_content_version_metadata",
     sources=[
         "test_content_version/pack.yaml",

diff --git a/st2tests/st2tests/fixtures/packs/action_chain_tests/BUILD b/st2tests/st2tests/fixtures/packs/action_chain_tests/BUILD
@@ -1 +1,7 @@
-python_sources()
+pack_metadata(
+    name="metadata",
+)
+
+python_sources(
+    dependencies=[":metadata"],
+)
diff --git a/st2tests/st2tests/fixtures/packs/dummy_pack_1/BUILD b/st2tests/st2tests/fixtures/packs/dummy_pack_1/BUILD
@@ -1,5 +1,10 @@
+pack_metadata(
+    name="metadata",
+)
+
 python_sources(
     dependencies=[
+        ":metadata",
         "st2tests/st2tests/fixtures/packs/configs/dummy_pack_1.yaml",
     ],
 )
diff --git a/st2tests/st2tests/fixtures/packs/dummy_pack_10/BUILD b/st2tests/st2tests/fixtures/packs/dummy_pack_10/BUILD
@@ -1 +1,7 @@
-python_sources()
+pack_metadata(
+    name="metadata",
+)
+
+python_sources(
+    dependencies=[":metadata"],
+)
diff --git a/st2tests/st2tests/fixtures/packs/dummy_pack_11/BUILD b/st2tests/st2tests/fixtures/packs/dummy_pack_11/BUILD
@@ -1,5 +1,10 @@
+pack_metadata(
+    name="metadata",
+)
+
 python_sources(
     dependencies=[
+        ":metadata",
         "st2tests/st2tests/fixtures/packs/configs/dummy_pack_11.yaml",
     ],
 )
diff --git a/st2tests/st2tests/fixtures/packs/dummy_pack_12/BUILD b/st2tests/st2tests/fixtures/packs/dummy_pack_12/BUILD
@@ -1 +1,7 @@
-python_sources()
+pack_metadata(
+    name="metadata",
+)
+
+python_sources(
+    dependencies=[":metadata"],
+)
diff --git a/st2tests/st2tests/fixtures/packs/dummy_pack_13/BUILD b/st2tests/st2tests/fixtures/packs/dummy_pack_13/BUILD
@@ -1 +1,7 @@
-python_sources()
+pack_metadata(
+    name="metadata",
+)
+
+python_sources(
+    dependencies=[":metadata"],
+)
diff --git a/st2tests/st2tests/fixtures/packs/dummy_pack_14/BUILD b/st2tests/st2tests/fixtures/packs/dummy_pack_14/BUILD
@@ -1 +1,7 @@
-python_sources()
+pack_metadata(
+    name="metadata",
+)
+
+python_sources(
+    dependencies=[":metadata"],
+)
diff --git a/st2tests/st2tests/fixtures/packs/dummy_pack_15/BUILD b/st2tests/st2tests/fixtures/packs/dummy_pack_15/BUILD
@@ -1 +1,7 @@
-python_sources()
+pack_metadata(
+    name="metadata",
+)
+
+python_sources(
+    dependencies=[":metadata"],
+)
diff --git a/st2tests/st2tests/fixtures/packs/dummy_pack_16/BUILD b/st2tests/st2tests/fixtures/packs/dummy_pack_16/BUILD
@@ -1 +1,7 @@
-python_sources()
+pack_metadata(
+    name="metadata",
+)
+
+python_sources(
+    dependencies=[":metadata"],
+)
diff --git a/st2tests/st2tests/fixtures/packs/dummy_pack_17/BUILD b/st2tests/st2tests/fixtures/packs/dummy_pack_17/BUILD
@@ -1 +1,7 @@
-python_sources()
+pack_metadata(
+    name="metadata",
+)
+
+python_sources(
+    dependencies=[":metadata"],
+)
diff --git a/st2tests/st2tests/fixtures/packs/dummy_pack_18/BUILD b/st2tests/st2tests/fixtures/packs/dummy_pack_18/BUILD
@@ -1 +1,7 @@
-python_sources()
+pack_metadata(
+    name="metadata",
+)
+
+python_sources(
+    dependencies=[":metadata"],
+)
diff --git a/st2tests/st2tests/fixtures/packs/dummy_pack_19/BUILD b/st2tests/st2tests/fixtures/packs/dummy_pack_19/BUILD
@@ -1,5 +1,10 @@
+pack_metadata(
+    name="metadata",
+)
+
 python_sources(
     dependencies=[
+        ":metadata",
         "st2tests/st2tests/fixtures/packs/configs/dummy_pack_19.yaml",
     ],
 )
diff --git a/st2tests/st2tests/fixtures/packs/dummy_pack_2/BUILD b/st2tests/st2tests/fixtures/packs/dummy_pack_2/BUILD
@@ -1,6 +1,12 @@
+pack_metadata(
+    name="metadata",
+)
+
 resource(
     name="pack_requirements",
     source="requirements.txt",
 )
 
-python_sources()
+python_sources(
+    dependencies=[":metadata"],
+)
diff --git a/st2tests/st2tests/fixtures/packs/dummy_pack_20/BUILD b/st2tests/st2tests/fixtures/packs/dummy_pack_20/BUILD
@@ -1 +1,7 @@
-python_sources()
+pack_metadata(
+    name="metadata",
+)
+
+python_sources(
+    dependencies=[":metadata"],
+)
diff --git a/st2tests/st2tests/fixtures/packs/dummy_pack_21/BUILD b/st2tests/st2tests/fixtures/packs/dummy_pack_21/BUILD
@@ -1 +1,7 @@
-python_sources()
+pack_metadata(
+    name="metadata",
+)
+
+python_sources(
+    dependencies=[":metadata"],
+)
diff --git a/st2tests/st2tests/fixtures/packs/dummy_pack_22/BUILD b/st2tests/st2tests/fixtures/packs/dummy_pack_22/BUILD
@@ -1,5 +1,10 @@
+pack_metadata(
+    name="metadata",
+)
+
 python_sources(
     dependencies=[
+        ":metadata",
         "st2tests/st2tests/fixtures/packs/configs/dummy_pack_22.yaml",
     ],
 )
diff --git a/st2tests/st2tests/fixtures/packs/dummy_pack_23/BUILD b/st2tests/st2tests/fixtures/packs/dummy_pack_23/BUILD
@@ -1 +1,9 @@
-python_sources()
+# There are no metadata files in dummy_pack_23 yet.
+# It is used in the pack copy tests.
+# pack_metadata(
+#    name="metadata",
+# )
+
+python_sources(
+    # dependencies=[":metadata"],
+)
diff --git a/st2tests/st2tests/fixtures/packs/dummy_pack_3/BUILD b/st2tests/st2tests/fixtures/packs/dummy_pack_3/BUILD
@@ -1 +1,7 @@
-python_sources()
+pack_metadata(
+    name="metadata",
+)
+
+python_sources(
+    dependencies=[":metadata"],
+)
diff --git a/st2tests/st2tests/fixtures/packs/dummy_pack_4/BUILD b/st2tests/st2tests/fixtures/packs/dummy_pack_4/BUILD
@@ -1 +1,7 @@
-python_sources()
+pack_metadata(
+    name="metadata",
+)
+
+python_sources(
+    dependencies=[":metadata"],
+)
diff --git a/st2tests/st2tests/fixtures/packs/dummy_pack_5/BUILD b/st2tests/st2tests/fixtures/packs/dummy_pack_5/BUILD
@@ -1,5 +1,10 @@
+pack_metadata(
+    name="metadata",
+)
+
 python_sources(
     dependencies=[
+        ":metadata",
         "st2tests/st2tests/fixtures/packs/configs/dummy_pack_5.yaml",
     ],
 )
diff --git a/st2tests/st2tests/fixtures/packs/dummy_pack_6/BUILD b/st2tests/st2tests/fixtures/packs/dummy_pack_6/BUILD
@@ -1,5 +1,10 @@
+pack_metadata(
+    name="metadata",
+)
+
 python_sources(
     dependencies=[
+        ":metadata",
         "st2tests/st2tests/fixtures/packs/configs/dummy_pack_6.yaml",
     ],
 )
diff --git a/st2tests/st2tests/fixtures/packs/dummy_pack_7/BUILD b/st2tests/st2tests/fixtures/packs/dummy_pack_7/BUILD
@@ -1,5 +1,10 @@
+pack_metadata(
+    name="metadata",
+)
+
 python_sources(
     dependencies=[
+        ":metadata",
         "st2tests/st2tests/fixtures/packs/configs/dummy_pack_7.yaml",
     ],
 )
diff --git a/st2tests/st2tests/fixtures/packs/dummy_pack_8/BUILD b/st2tests/st2tests/fixtures/packs/dummy_pack_8/BUILD
@@ -1 +1,7 @@
-python_sources()
+pack_metadata(
+    name="metadata",
+)
+
+python_sources(
+    dependencies=[":metadata"],
+)