From bb83f694c8495c6c7ba322172a2492a32c2117cc Mon Sep 17 00:00:00 2001
From: Sam Singh-Crawford <sam.singh-crawford@chainguard.dev>
Date: Thu, 14 May 2026 09:45:45 -0400
Subject: [PATCH] feat(gem-check): add --list flag

---
 gem-check/gem-check              | 35 ++++++++++++++++++++++++++------
 pipelines/test/tw/gem-check.yaml | 25 ++++++++++++++++++++++-
 2 files changed, 53 insertions(+), 7 deletions(-)

diff --git a/gem-check/gem-check b/gem-check/gem-check
index 1964b8f1..0425f51d 100755
--- a/gem-check/gem-check
+++ b/gem-check/gem-check
@@ -70,6 +70,7 @@ exit 9
 }
 
 package=""
+list=""
 require=""
 
 while [ $# -ne 0 ]; do
@@ -89,6 +90,13 @@ while [ $# -ne 0 ]; do
 			fi
 			shift
 		;;
+		-l=*|--list=*)
+			list="${1#*=}"
+		;;
+		-l|--list)
+			list="$2"
+			shift
+		;;
 		-r=*|--require=*)
 			if [ "${1#*=}" = "none" ]; then
 				require=""
@@ -111,7 +119,8 @@ while [ $# -ne 0 ]; do
 	shift
 done
 package=${package# }
-require=${require# }
+list=$(echo "${list# }" | tr ',' ' ')
+require=$(echo "${require# }" | tr ',' ' ')
 
 [ -n "${package}" ] || error "No package specified"
 
@@ -138,13 +147,27 @@ PASSES=0
 #   PASS[gem-check]: Success requiring gem [zip]
 #   INFO[gem-check]: tested [2] files with gem-check.  [2] passes. [0] fails.
 #
+# For meta-packages that bundle multiple gems, or where the apk name isn't
+# itself a gem, override or skip the list check with --list:
+#   $ gem-check --package=ruby3.2-foo --list="bar baz"
+#   $ gem-check --package=ruby3.2-foo --list=none --require=bar
+#
 gem_dash=$(echo "$package" | sed -e "s/^ruby[0-9\.]\+-//")
 gem_slash=$(echo "$package" | sed -e "s/^ruby[0-9\.]\+-//" -e "s:\-:/:g")
-# Test listing the gem
-if gem_list "$gem_dash" ; then
-	pass "Success listing gem [$gem_dash]"
+# Test listing the gem(s)
+if [ -z "$list" ]; then
+	list="$gem_dash"
+fi
+if [ "$list" = "none" ]; then
+	info "Skipping gem list check"
 else
-	fail "Failed listing gem [$gem_dash]"
+	for g in $list; do
+		if gem_list "$g" ; then
+			pass "Success listing gem [$g]"
+		else
+			fail "Failed listing gem [$g]"
+		fi
+	done
 fi
 # Test requiring the gem in ruby code
 if [ -z "$require" ]; then
@@ -158,7 +181,7 @@ for req in $require; do
 	fi
 done
 
-info "Tested [package='$package', require='$require'] with [$PROG].  [$PASSES/$((PASSES+FAILS))] passed."
+info "Tested [package='$package', list='$list', require='$require'] with [$PROG].  [$PASSES/$((PASSES+FAILS))] passed."
 if [ "$FAILS" = "0" ]; then
 	exit 0
 else
diff --git a/pipelines/test/tw/gem-check.yaml b/pipelines/test/tw/gem-check.yaml
index 6fce4746..58897f22 100644
--- a/pipelines/test/tw/gem-check.yaml
+++ b/pipelines/test/tw/gem-check.yaml
@@ -20,6 +20,13 @@ inputs:
       Defaults to the current package being built.
     required: false
     default: "${{context.name}}"
+  list:
+    description: |
+      Exact gem name(s) to check with 'gem list -i' (space-separated).
+      Overrides the auto-detected name from the package.
+      Use 'none' to skip the list check entirely.
+    required: false
+    default: ""
   require:
     description: |
       Exact gem name(s) to test requiring (comma or space-separated).
@@ -43,7 +50,23 @@ inputs:
 #     with:
 #       require: "rails activerecord actionpack"
 #
+# Meta-package that bundles multiple gems whose names don't match the apk:
+#   - uses: test/tw/gem-check
+#     with:
+#       list: |
+#         fluent-plugin-oss
+#         fluent-plugin-foo
+#       require: |
+#         fluent/plugin/out_oss
+#         fluent/plugin/out_foo
+#
+# Meta-package, skipping the list check entirely:
+#   - uses: test/tw/gem-check
+#     with:
+#       list: none
+#       require: "fluent/plugin/out_oss"
+#
 pipeline:
   - name: check a ruby gem installation
     runs: |
-      gem-check --package "${{inputs.package}}" --require "${{inputs.require}}"
+      gem-check --package "${{inputs.package}}" --list "${{inputs.list}}" --require "${{inputs.require}}"