Merge pull request #241 from chainguard-dev/arturo-249-package-type-check

package-type-check: add debug package checker

Author: aborrero

package-type-check/go.sum

@@ -3,6 +3,8 @@ github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2
 github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
 github.com/spf13/cobra v1.10.1 h1:lJeBwCfmrnXthfAupyUTzJ/J4Nc1RsHC/mSRU2dll/s=
+github.com/spf13/cobra v1.10.1/go.mod h1:7SmJGaTHFVBY0jW4NXGluQoLvhqFQM+6XSKD+P4XaB0=
 github.com/spf13/pflag v1.0.9 h1:9exaQaMOCwffKiiiYk6/BndUBv+iRViNW+4lEMi0PvY=
+github.com/spf13/pflag v1.0.9/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

package-type-check/main.go

@@ -29,6 +29,7 @@ func main() {
 	rootCmd.AddCommand(CheckStaticCommand())
 	rootCmd.AddCommand(CheckByProductCommand())
 	rootCmd.AddCommand(CheckDevCommand())
+	rootCmd.AddCommand(CheckDebugCommand())
 
 	if err := rootCmd.Execute(); err != nil {
 		fmt.Println(err)
@@ -117,3 +118,14 @@ func CheckDevCommand() *cobra.Command {
 		},
 	}
 }
+
+func CheckDebugCommand() *cobra.Command {
+	return &cobra.Command{
+		Use:   "debug <PACKAGE>",
+		Short: "Check and verify the package is a debug package",
+		Args:  cobra.ExactArgs(1),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			return checkers.CheckDebugPackage(args[0])
+		},
+	}
+}

package-type-check/pkg/checkers/debug.go

@@ -0,0 +1,32 @@
+package checkers
+
+import (
+	"fmt"
+
+	"github.com/chainguard-dev/cg-tw/package-type-check/pkg/utils"
+)
+
+func CheckDebugPackage(pkg string) error {
+	fmt.Printf("Checking if package %s is a valid debug package\n", pkg)
+
+	// Check 1: Package name contains debug indicators
+	hasDebugName := utils.HasDebugPackageName(pkg)
+	if !hasDebugName {
+		return fmt.Errorf("FAIL [1/2]: Debug package [%s] does not contain '-dbg' or '-debug' in its name.\n"+
+			"Debug packages should have '-dbg' or '-debug' in their name", pkg)
+	}
+	fmt.Printf("PASS [1/2]: Debug package [%s] has debug indicator in name\n", pkg)
+
+	// Check 2: Package contains .debug files in /usr/lib/debug
+	debugFiles, err := utils.GetDebugSymbolFiles(pkg)
+	if err != nil {
+		return err
+	}
+	if len(debugFiles) == 0 {
+		return fmt.Errorf("FAIL [2/2]: Debug package [%s] does not contain any .debug files in /usr/lib/debug/.\n"+
+			"Debug packages must contain debug symbol files", pkg)
+	}
+	fmt.Printf("PASS [2/2]: Debug package [%s] contains %d debug symbol files\n", pkg, len(debugFiles))
+
+	return nil
+}

package-type-check/pkg/utils/package_utils.go

@@ -204,3 +204,25 @@ func HasHeaderFiles(pkg string) (bool, error) {
 	}
 	return false, nil
 }
+
+// HasDebugPackageName checks if package name contains debug indicators
+func HasDebugPackageName(pkg string) bool {
+	return strings.Contains(pkg, "-dbg") || strings.Contains(pkg, "-debug")
+}
+
+// GetDebugSymbolFiles finds .debug files in /usr/lib/debug for a package
+func GetDebugSymbolFiles(pkg string) ([]string, error) {
+	files, err := GetPackageFiles(pkg)
+	if err != nil {
+		return nil, err
+	}
+
+	var debugFiles []string
+	for _, file := range files {
+		if strings.HasPrefix(file, "usr/lib/debug/") && strings.HasSuffix(file, ".debug") {
+			debugFiles = append(debugFiles, file)
+		}
+	}
+
+	return debugFiles, nil
+}

pipelines/test/tw/debugpackage.yaml

@@ -0,0 +1,10 @@
+name: Debug Package Check
+
+needs:
+  packages:
+    - package-type-check
+
+pipeline:
+  - name: Check if the package is a Debug Package
+    runs: |
+      package-type-check debug "${{context.name}}"