more wip

Author: atoulme

cmd/checkapi/main.go

@@ -10,14 +10,15 @@ import (
 	"go/ast"
 	"go/parser"
 	"go/token"
-	"gopkg.in/yaml.v3"
 	"io/fs"
 	"log"
 	"os"
 	"path/filepath"
 	"sort"
 	"strings"
 	"unicode"
+
+	"gopkg.in/yaml.v3"
 )
 
 func main() {
@@ -76,7 +77,7 @@ func run(folder string, allowlistFilePath string) error {
 			}
 
 			var componentType string
-			if _, err := os.Stat(filepath.Join(base, "metadata.yaml")); errors.Is(err, os.ErrNotExist) {
+			if _, err = os.Stat(filepath.Join(base, "metadata.yaml")); errors.Is(err, os.ErrNotExist) {
 				componentType = "pkg"
 			} else {
 				m, err := os.ReadFile(filepath.Join(base, "metadata.yaml"))
@@ -215,10 +216,10 @@ func walkFolder(folder string, componentType string) error {
 		return nil
 	}
 
-	if len(result.Functions) > 1 && componentType != "pkg" {
+	if len(result.Functions) > 1 && componentType != "pkg" && componentType != "cmd" {
 		return fmt.Errorf("%s has more than one function: %q", folder, strings.Join(fnNames, ","))
 	}
-	if len(result.Functions) == 1 && componentType != "pkg" {
+	if len(result.Functions) == 1 && componentType != "pkg" && componentType != "cmd" {
 		if err := checkFactoryFunction(result.Functions[0], folder, componentType); err != nil {
 			return err
 		}
@@ -233,6 +234,33 @@ func walkFolder(folder string, componentType string) error {
 
 // check the only exported function of the module is NewFactory, matching the signature of the factory expected by the collector builder.
 func checkFactoryFunction(newFactoryFn *function, folder string, componentType string) error {
+	switch componentType {
+	case "provider":
+		return checkProviderFactoryFunction(newFactoryFn, folder, componentType)
+	default:
+		return checkComponentFactoryFunction(newFactoryFn, folder, componentType)
+	}
+}
+
+func checkProviderFactoryFunction(newFactoryFn *function, folder string, componentType string) error {
+	if newFactoryFn.Name != "NewFactory" {
+		return fmt.Errorf("%s does not define a NewFactory function as a %s", folder, componentType)
+	}
+	if newFactoryFn.Receiver != "" {
+		return fmt.Errorf("%s associated NewFactory with a receiver type", folder)
+	}
+	if len(newFactoryFn.ReturnTypes) != 1 {
+		return fmt.Errorf("%s NewFactory function returns more than one result", folder)
+	}
+	returnType := newFactoryFn.ReturnTypes[0]
+
+	if returnType != "confmap.ProviderFactory" {
+		return fmt.Errorf("%s NewFactory function does not return a valid type: %s, expected confmap.ProviderFactory", folder, returnType)
+	}
+	return nil
+}
+
+func checkComponentFactoryFunction(newFactoryFn *function, folder string, componentType string) error {
 	if newFactoryFn.Name != "NewFactory" {
 		return fmt.Errorf("%s does not define a NewFactory function as a %s", folder, componentType)
 	}

testbed/mockdatasenders/mockdatadogagentexporter/metadata.yaml

@@ -1,3 +1,4 @@
 status:
+  class: pkg
   codeowners:
     active: [boostchicken]