Merge pull request #242 from chainguard-dev/arturo-846-package-type-check

package-type-check: introduce check for -dev packages

Author: debasishbsws

package-type-check/main.go

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

package-type-check/package-type-check

@@ -0,0 +1,39 @@
+package checkers
+
+import (
+	"fmt"
+
+	"github.com/chainguard-dev/cg-tw/package-type-check/pkg/utils"
+)
+
+func CheckDevPackage(pkg string) error {
+	fmt.Printf("Checking if package %s is a valid dev package\n", pkg)
+
+	// Check 1: Package name must end with -dev or -devel
+	if !utils.IsDevPackage(pkg) {
+		return fmt.Errorf("FAIL [1/3]: Dev package [%s] name does not end with -dev or -devel", pkg)
+	}
+	fmt.Printf("PASS [1/3]: Dev package [%s] has correct naming convention\n", pkg)
+
+	// Check 2: Package should not be empty
+	isEmpty, err := utils.IsEmptyPackage(pkg)
+	if err != nil {
+		return err
+	}
+	if isEmpty {
+		return fmt.Errorf("FAIL [2/3]: Dev package [%s] is completely empty (installs no files)", pkg)
+	}
+	fmt.Printf("PASS [2/3]: Dev package [%s] is not empty\n", pkg)
+
+	// Check 3: Package should contain .h files under /usr
+	hasHeaders, err := utils.HasHeaderFiles(pkg)
+	if err != nil {
+		return err
+	}
+	if !hasHeaders {
+		return fmt.Errorf("FAIL [3/3]: Dev package [%s] does not contain any .h files under /usr", pkg)
+	}
+	fmt.Printf("PASS [3/3]: Dev package [%s] contains header files under /usr\n", pkg)
+
+	return nil
+}

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

@@ -184,3 +184,23 @@ func TestReadableFile(path string) bool {
 	cmd.Stderr = nil
 	return cmd.Run() == nil
 }
+
+// IsDevPackage checks if package name ends with -dev or -devel
+func IsDevPackage(pkg string) bool {
+	return strings.HasSuffix(pkg, "-dev") || strings.HasSuffix(pkg, "-devel")
+}
+
+// HasHeaderFiles checks if package contains .h files under /usr
+func HasHeaderFiles(pkg string) (bool, error) {
+	files, err := GetPackageFiles(pkg)
+	if err != nil {
+		return false, err
+	}
+
+	for _, file := range files {
+		if strings.HasPrefix(file, "usr/") && strings.HasSuffix(file, ".h") {
+			return true, nil
+		}
+	}
+	return false, nil
+}

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

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