From 34d555c72fc523cd9a907a3e7f01671d4b91e5d7 Mon Sep 17 00:00:00 2001
From: Antoine Toulme <antoine@lunar-ocean.com>
Date: Fri, 2 Jun 2023 14:54:50 -0700
Subject: [PATCH] [chore] add metadata status checks on the distribution
 (#21275)

Add a test checking that the status metadata of a component matches their presence in the otelcontribcol test suite.
---
 .../distribution_metadata_test.go             | 95 +++++++++++++++++++
 cmd/otelcontribcol/go.mod                     |  2 +-
 2 files changed, 96 insertions(+), 1 deletion(-)
 create mode 100644 cmd/otelcontribcol/distribution_metadata_test.go

diff --git a/cmd/otelcontribcol/distribution_metadata_test.go b/cmd/otelcontribcol/distribution_metadata_test.go
new file mode 100644
index 000000000000..37e0e5f534cf
--- /dev/null
+++ b/cmd/otelcontribcol/distribution_metadata_test.go
@@ -0,0 +1,95 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package main
+
+import (
+	"context"
+	"os"
+	"path/filepath"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"go.opentelemetry.io/collector/component"
+	"go.opentelemetry.io/collector/confmap/provider/fileprovider"
+)
+
+func TestComponentsArePresent(t *testing.T) {
+	components, err := components()
+	require.NoError(t, err)
+	var metadataComponents []string
+	e := filepath.Walk(filepath.Join("..", ".."), func(path string, info os.FileInfo, err error) error {
+		if err == nil && "metadata.yaml" == info.Name() {
+			metadataComponents = append(metadataComponents, path)
+		}
+		return nil
+	})
+	require.NoError(t, e)
+
+	for _, metadataComponent := range metadataComponents {
+		t.Run(metadataComponent, func(tt *testing.T) {
+			m, err := loadMetadata(metadataComponent)
+			require.NoError(tt, err)
+			if m.Status == nil {
+				tt.Skip("no status present, skipping", metadataComponent)
+				return
+			}
+			inDevelopment := true
+			for stability, pipelines := range m.Status.Stability {
+				if stability != "development" && len(pipelines) > 0 {
+					inDevelopment = false
+					break
+				}
+			}
+
+			if inDevelopment {
+				tt.Skip("component in development, skipping", metadataComponent)
+				return
+			}
+			switch m.Status.Class {
+			case "connector":
+				assert.NotNil(tt, components.Connectors[component.Type(m.Type)], "missing connector: %s", m.Type)
+			case "exporter":
+				assert.NotNil(tt, components.Exporters[component.Type(m.Type)], "missing exporter: %s", m.Type)
+			case "extension":
+				assert.NotNil(tt, components.Extensions[component.Type(m.Type)], "missing extension: %s", m.Type)
+			case "processor":
+				assert.NotNil(tt, components.Processors[component.Type(m.Type)], "missing processor: %s", m.Type)
+			case "receiver":
+				assert.NotNil(tt, components.Receivers[component.Type(m.Type)], "missing receiver: %s", m.Type)
+			}
+		})
+	}
+}
+
+func loadMetadata(filePath string) (metadata, error) {
+	cp, err := fileprovider.New().Retrieve(context.Background(), "file:"+filePath, nil)
+	if err != nil {
+		return metadata{}, err
+	}
+
+	conf, err := cp.AsConf()
+	if err != nil {
+		return metadata{}, err
+	}
+
+	md := metadata{}
+	if err := conf.Unmarshal(&md); err != nil {
+		return md, err
+	}
+
+	return md, nil
+}
+
+type metadata struct {
+	Type   string  `mapstructure:"type"`
+	Status *status `mapstructure:"status"`
+}
+
+type status struct {
+	Stability     map[string][]string `mapstructure:"stability"`
+	Distributions []string            `mapstructure:"distributions"`
+	Class         string              `mapstructure:"class"`
+	Warnings      []string            `mapstructure:"warnings"`
+}
diff --git a/cmd/otelcontribcol/go.mod b/cmd/otelcontribcol/go.mod
index cd585713ee6a..3aefbdade768 100644
--- a/cmd/otelcontribcol/go.mod
+++ b/cmd/otelcontribcol/go.mod
@@ -184,6 +184,7 @@ require (
 	github.com/stretchr/testify v1.8.4
 	go.opentelemetry.io/collector v0.78.3-0.20230601234953-deffd4892002
 	go.opentelemetry.io/collector/component v0.78.3-0.20230601234953-deffd4892002
+	go.opentelemetry.io/collector/confmap v0.78.3-0.20230601234953-deffd4892002
 	go.opentelemetry.io/collector/connector/forwardconnector v0.78.3-0.20230601234953-deffd4892002
 	go.opentelemetry.io/collector/consumer v0.78.3-0.20230601234953-deffd4892002
 	go.opentelemetry.io/collector/exporter v0.78.3-0.20230601234953-deffd4892002
@@ -617,7 +618,6 @@ require (
 	go.mongodb.org/atlas v0.28.0 // indirect
 	go.mongodb.org/mongo-driver v1.11.4 // indirect
 	go.opencensus.io v0.24.0 // indirect
-	go.opentelemetry.io/collector/confmap v0.78.3-0.20230601234953-deffd4892002 // indirect
 	go.opentelemetry.io/collector/featuregate v1.0.0-rcv0012.0.20230601234953-deffd4892002 // indirect
 	go.opentelemetry.io/collector/pdata v1.0.0-rcv0012.0.20230601234953-deffd4892002 // indirect
 	go.opentelemetry.io/collector/semconv v0.78.3-0.20230601234953-deffd4892002 // indirect