Merge pull request #5751: Use shellcheck (via pantsbuild)

cognifloyd · web-flow · commit 11989edf5a26 · 2022-10-10T07:19:26.000-05:00
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -53,7 +53,7 @@ Added
 
 * Begin introducing `pants <https://www.pantsbuild.org/docs>`_ to improve DX (Developer Experience)
   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. #5713 #5724 #5726 #5725 #5732 #5733 #5737 #5738 #5758
+  to pants' use of PEX lockfiles. This is not a user-facing addition. #5713 #5724 #5726 #5725 #5732 #5733 #5737 #5738 #5758 #5751
   Contributed by @cognifloyd
 
 Changed
diff --git a/contrib/core/actions/send_mail/BUILD b/contrib/core/actions/send_mail/BUILD
@@ -0,0 +1,4 @@
+shell_source(
+    source="send_mail",
+    skip_shellcheck=True,
+)
diff --git a/contrib/examples/actions/BUILD b/contrib/examples/actions/BUILD
@@ -1,5 +1,6 @@
 python_sources()
 
 shell_sources(
-    name="actions0",
+    name="shell",
+    skip_shellcheck=True,
 )
diff --git a/contrib/examples/actions/bash_ping/BUILD b/contrib/examples/actions/bash_ping/BUILD
@@ -1 +1 @@
-shell_sources()
+shell_sources(skip_shellcheck=True)
diff --git a/contrib/examples/actions/bash_random/BUILD b/contrib/examples/actions/bash_random/BUILD
@@ -1 +1,5 @@
-shell_sources()
+shell_sources(
+    overrides={
+        "random2.sh": {"skip_shellcheck": True},
+    },
+)
diff --git a/contrib/linux/actions/BUILD b/contrib/linux/actions/BUILD
@@ -1,5 +1,6 @@
 python_sources()
 
 shell_sources(
-    name="actions0",
+    name="shell",
+    skip_shellcheck=True,
 )
diff --git a/pants.toml b/pants.toml
@@ -15,6 +15,7 @@ backend_packages = [
 
   # shell
   "pants.backend.shell",
+  "pants.backend.shell.lint.shellcheck",
 ]
 # pants ignores files in .gitignore, .*/ directories, /dist/ directory, and __pycache__.
 pants_ignore.add = [
diff --git a/scripts/BUILD b/scripts/BUILD
@@ -1,5 +1,5 @@
 python_sources()
 
 shell_sources(
-    name="scripts0",
+    name="shell",
 )
diff --git a/st2actions/bin/BUILD b/st2actions/bin/BUILD
@@ -1 +1,8 @@
-shell_sources()
+python_sources(
+    sources=["st2*"],
+)
+
+shell_sources(
+    name="shell",
+    skip_shellcheck=True,
+)
diff --git a/st2api/bin/BUILD b/st2api/bin/BUILD
@@ -0,0 +1,3 @@
+python_sources(
+    sources=["st2*"],
+)
diff --git a/st2auth/bin/BUILD b/st2auth/bin/BUILD
@@ -0,0 +1,3 @@
+python_sources(
+    sources=["st2*"],
+)
diff --git a/st2common/bin/BUILD b/st2common/bin/BUILD
@@ -1 +1,9 @@
-python_sources()
+python_sources(
+    sources=["*.py", "st2*", "!st2ctl", "!st2-self-check", "!st2-run-pack-tests"],
+)
+
+shell_sources(
+    name="shell",
+    sources=["st2ctl", "st2-self-check", "st2-run-pack-tests"],
+    skip_shellcheck=True,
+)
diff --git a/st2common/bin/migrations/v2.1/BUILD b/st2common/bin/migrations/v2.1/BUILD
@@ -1,5 +1,6 @@
 python_sources()
 
 shell_sources(
-    name="v2.10",
+    name="shell",
+    skip_shellcheck=True,
 )
diff --git a/st2common/bin/migrations/v3.5/BUILD b/st2common/bin/migrations/v3.5/BUILD
@@ -1 +1,3 @@
+# TODO: what to do about st2-migrate-db-dict-field-values ?
+# st2_migrate_db_dict_field_values.py is a symlink to st2-migrate-db-dict-field-values
 python_sources()
diff --git a/st2common/tests/fixtures/BUILD b/st2common/tests/fixtures/BUILD
@@ -1,5 +1,5 @@
 python_sources()
 
 shell_sources(
-    name="fixtures0",
+    name="shell",
 )
diff --git a/st2reactor/bin/BUILD b/st2reactor/bin/BUILD
@@ -0,0 +1,3 @@
+python_sources(
+    sources=["st2*"],
+)
diff --git a/st2stream/bin/BUILD b/st2stream/bin/BUILD
@@ -0,0 +1,3 @@
+python_sources(
+    sources=["st2*"],
+)
diff --git a/st2tests/integration/BUILD b/st2tests/integration/BUILD
@@ -1 +1,4 @@
-shell_sources()
+shell_sources(
+    name="shell",
+    skip_shellcheck=True,
+)
diff --git a/st2tests/st2tests/fixtures/packs/BUILD b/st2tests/st2tests/fixtures/packs/BUILD
@@ -14,6 +14,7 @@ resources(
 
 shell_sources(
     name="test_content_version_shell",
+    skip_shellcheck=True,
     sources=[
         "test_content_version/**/*.sh",
     ],
diff --git a/st2tests/testpacks/errorcheck/actions/BUILD b/st2tests/testpacks/errorcheck/actions/BUILD
@@ -1 +1 @@
-shell_sources()
+shell_sources(skip_shellcheck=True)
diff --git a/tools/BUILD b/tools/BUILD
@@ -1,5 +1,10 @@
 python_sources()
 
 shell_sources(
-    name="tools0",
+    name="shell",
+    sources=[
+        "*.sh",
+        "st2-setup-*",
+    ],
+    skip_shellcheck=True,
 )

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`python_sources()`
`2`	`2`
`3`	`3`	`shell_sources(`
`4`		`- name="actions0",`
	`4`	`+ name="shell",`
	`5`	`+ skip_shellcheck=True,`
`5`	`6`	`)`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-shell_sources()`
	`1`	`+shell_sources(skip_shellcheck=True)`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@ backend_packages = [`
`15`	`15`
`16`	`16`	`# shell`
`17`	`17`	`"pants.backend.shell",`
	`18`	`+ "pants.backend.shell.lint.shellcheck",`
`18`	`19`	`]`
`19`	`20`	`# pants ignores files in .gitignore, .*/ directories, /dist/ directory, and __pycache__.`
`20`	`21`	`pants_ignore.add = [`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`python_sources()`
`2`	`2`
`3`	`3`	`shell_sources(`
`4`		`- name="scripts0",`
	`4`	`+ name="shell",`
`5`	`5`	`)`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+python_sources(`
	`2`	`+ sources=["st2*"],`
	`3`	`+)`