feat(core): protobuf for doc spec

internal/docs/component_protobuf.go

@@ -0,0 +1,96 @@
+package docs
+
+import (
+	pb "github.com/warpstreamlabs/bento/internal/docs/specpb"
+)
+
+func FromComponentSpec(comp ComponentSpec) (*pb.ComponentSpec, error) {
+	conf, err := FromFieldSpec(comp.Config)
+	if err != nil {
+		return nil, err
+	}
+
+	proto := &pb.ComponentSpec{
+		Name:   comp.Name,
+		Config: conf,
+	}
+
+	switch comp.Type {
+	case TypeBuffer:
+		proto.ComponentType = pb.ComponentType_COMPONENT_TYPE_BUFFER
+	case TypeCache:
+		proto.ComponentType = pb.ComponentType_COMPONENT_TYPE_CACHE
+	case TypeInput:
+		proto.ComponentType = pb.ComponentType_COMPONENT_TYPE_INPUT
+	case TypeMetrics:
+		proto.ComponentType = pb.ComponentType_COMPONENT_TYPE_METRICS
+	case TypeOutput:
+		proto.ComponentType = pb.ComponentType_COMPONENT_TYPE_OUTPUT
+	case TypeProcessor:
+		proto.ComponentType = pb.ComponentType_COMPONENT_TYPE_PROCESSOR
+	case TypeRateLimit:
+		proto.ComponentType = pb.ComponentType_COMPONENT_TYPE_RATE_LIMIT
+	case TypeTracer:
+		proto.ComponentType = pb.ComponentType_COMPONENT_TYPE_TRACER
+	case TypeScanner:
+		proto.ComponentType = pb.ComponentType_COMPONENT_TYPE_SCANNER
+	default:
+		proto.ComponentType = pb.ComponentType_COMPONENT_TYPE_UNKNOWN
+	}
+
+	switch comp.Status {
+	case StatusStable:
+		proto.ComponentStatus = pb.ComponentStatus_COMPONENT_STATUS_STABLE
+	case StatusBeta:
+		proto.ComponentStatus = pb.ComponentStatus_COMPONENT_STATUS_BETA
+	case StatusExperimental:
+		proto.ComponentStatus = pb.ComponentStatus_COMPONENT_STATUS_EXPERIMENTAL
+	case StatusDeprecated:
+		proto.ComponentStatus = pb.ComponentStatus_COMPONENT_STATUS_DEPRECATED
+	default:
+		proto.ComponentStatus = pb.ComponentStatus_COMPONENT_STATUS_UNKNOWN
+	}
+
+	return proto, nil
+}
+
+func ToComponentSpec(proto *pb.ComponentSpec) ComponentSpec {
+	comp := ComponentSpec{
+		Name:   proto.Name,
+		Config: ToFieldSpec(proto.Config),
+	}
+
+	switch proto.ComponentType {
+	case pb.ComponentType_COMPONENT_TYPE_BUFFER:
+		comp.Type = TypeBuffer
+	case pb.ComponentType_COMPONENT_TYPE_CACHE:
+		comp.Type = TypeCache
+	case pb.ComponentType_COMPONENT_TYPE_INPUT:
+		comp.Type = TypeInput
+	case pb.ComponentType_COMPONENT_TYPE_METRICS:
+		comp.Type = TypeMetrics
+	case pb.ComponentType_COMPONENT_TYPE_OUTPUT:
+		comp.Type = TypeOutput
+	case pb.ComponentType_COMPONENT_TYPE_PROCESSOR:
+		comp.Type = TypeProcessor
+	case pb.ComponentType_COMPONENT_TYPE_RATE_LIMIT:
+		comp.Type = TypeRateLimit
+	case pb.ComponentType_COMPONENT_TYPE_TRACER:
+		comp.Type = TypeTracer
+	case pb.ComponentType_COMPONENT_TYPE_SCANNER:
+		comp.Type = TypeScanner
+	}
+
+	switch proto.ComponentStatus {
+	case pb.ComponentStatus_COMPONENT_STATUS_STABLE:
+		comp.Status = StatusStable
+	case pb.ComponentStatus_COMPONENT_STATUS_BETA:
+		comp.Status = StatusBeta
+	case pb.ComponentStatus_COMPONENT_STATUS_EXPERIMENTAL:
+		comp.Status = StatusExperimental
+	case pb.ComponentStatus_COMPONENT_STATUS_DEPRECATED:
+		comp.Status = StatusDeprecated
+	}
+
+	return comp
+}

internal/docs/component_protobuf_test.go

@@ -0,0 +1,192 @@
+package docs
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	pb "github.com/warpstreamlabs/bento/internal/docs/specpb"
+)
+
+func TestComponentSpecRoundTrip(t *testing.T) {
+	tests := []struct {
+		name string
+		spec ComponentSpec
+	}{
+		{
+			name: "all component types and statuses",
+			spec: ComponentSpec{
+				Name:   "comprehensive_component",
+				Type:   TypeProcessor,
+				Status: StatusStable,
+				Config: FieldSpec{
+					Name: "config",
+					Type: FieldTypeObject,
+					Kind: KindScalar,
+					Children: FieldSpecs{
+						{
+							Name: "input_component",
+							Type: FieldTypeInput,
+							Kind: KindScalar,
+						},
+						{
+							Name: "buffer_component",
+							Type: FieldTypeBuffer,
+							Kind: KindScalar,
+						},
+						{
+							Name: "cache_component",
+							Type: FieldTypeCache,
+							Kind: KindScalar,
+						},
+						{
+							Name: "processor_components",
+							Type: FieldTypeProcessor,
+							Kind: KindArray,
+						},
+						{
+							Name: "rate_limit_component",
+							Type: FieldTypeRateLimit,
+							Kind: KindScalar,
+						},
+						{
+							Name: "output_component",
+							Type: FieldTypeOutput,
+							Kind: KindScalar,
+						},
+						{
+							Name: "metrics_component",
+							Type: FieldTypeMetrics,
+							Kind: KindScalar,
+						},
+						{
+							Name: "tracer_component",
+							Type: FieldTypeTracer,
+							Kind: KindScalar,
+						},
+						{
+							Name: "scanner_component",
+							Type: FieldTypeScanner,
+							Kind: KindScalar,
+						},
+						{
+							Name:    "enabled",
+							Type:    FieldTypeBool,
+							Kind:    KindScalar,
+							Default: ptr(true),
+						},
+						{
+							Name:    "timeout",
+							Type:    FieldTypeString,
+							Kind:    KindScalar,
+							Default: ptr("5s"),
+						},
+					},
+				},
+			},
+		},
+	}
+
+	for _, test := range tests {
+		test := test
+		t.Run(test.name, func(t *testing.T) {
+			proto, err := FromComponentSpec(test.spec)
+			require.NoError(t, err)
+			result := ToComponentSpec(proto)
+			assert.Equal(t, test.spec, result)
+		})
+	}
+}
+
+func TestComponentTypeConversion(t *testing.T) {
+	tests := []struct {
+		name      string
+		goType    Type
+		protoType pb.ComponentType
+	}{
+		{"buffer", TypeBuffer, pb.ComponentType_COMPONENT_TYPE_BUFFER},
+		{"cache", TypeCache, pb.ComponentType_COMPONENT_TYPE_CACHE},
+		{"input", TypeInput, pb.ComponentType_COMPONENT_TYPE_INPUT},
+		{"metrics", TypeMetrics, pb.ComponentType_COMPONENT_TYPE_METRICS},
+		{"output", TypeOutput, pb.ComponentType_COMPONENT_TYPE_OUTPUT},
+		{"processor", TypeProcessor, pb.ComponentType_COMPONENT_TYPE_PROCESSOR},
+		{"rate_limit", TypeRateLimit, pb.ComponentType_COMPONENT_TYPE_RATE_LIMIT},
+		{"tracer", TypeTracer, pb.ComponentType_COMPONENT_TYPE_TRACER},
+		{"scanner", TypeScanner, pb.ComponentType_COMPONENT_TYPE_SCANNER},
+	}
+
+	for _, test := range tests {
+		test := test
+		t.Run(test.name, func(t *testing.T) {
+			spec := ComponentSpec{
+				Name: "test",
+				Type: test.goType,
+				Config: FieldSpec{
+					Name: "config",
+					Type: FieldTypeObject,
+					Kind: KindScalar,
+				},
+			}
+			proto, err := FromComponentSpec(spec)
+			require.NoError(t, err)
+			assert.Equal(t, test.protoType, proto.ComponentType)
+
+			protoSpec := &pb.ComponentSpec{
+				Name:          "test",
+				ComponentType: test.protoType,
+				Config: &pb.FieldSpec{
+					Name:      "config",
+					FieldType: pb.FieldType_FIELD_TYPE_OBJECT,
+					FieldKind: pb.FieldKind_FIELD_KIND_SCALAR,
+				},
+			}
+			goSpec := ToComponentSpec(protoSpec)
+			assert.Equal(t, test.goType, goSpec.Type)
+		})
+	}
+}
+
+func TestComponentStatusConversion(t *testing.T) {
+	tests := []struct {
+		name        string
+		goStatus    Status
+		protoStatus pb.ComponentStatus
+	}{
+		{"stable", StatusStable, pb.ComponentStatus_COMPONENT_STATUS_STABLE},
+		{"beta", StatusBeta, pb.ComponentStatus_COMPONENT_STATUS_BETA},
+		{"experimental", StatusExperimental, pb.ComponentStatus_COMPONENT_STATUS_EXPERIMENTAL},
+		{"deprecated", StatusDeprecated, pb.ComponentStatus_COMPONENT_STATUS_DEPRECATED},
+	}
+
+	for _, test := range tests {
+		test := test
+		t.Run(test.name, func(t *testing.T) {
+			spec := ComponentSpec{
+				Name:   "test",
+				Type:   TypeProcessor,
+				Status: test.goStatus,
+				Config: FieldSpec{
+					Name: "config",
+					Type: FieldTypeObject,
+					Kind: KindScalar,
+				},
+			}
+			proto, err := FromComponentSpec(spec)
+			require.NoError(t, err)
+			assert.Equal(t, test.protoStatus, proto.ComponentStatus)
+
+			protoSpec := &pb.ComponentSpec{
+				Name:            "test",
+				ComponentType:   pb.ComponentType_COMPONENT_TYPE_PROCESSOR,
+				ComponentStatus: test.protoStatus,
+				Config: &pb.FieldSpec{
+					Name:      "config",
+					FieldType: pb.FieldType_FIELD_TYPE_OBJECT,
+					FieldKind: pb.FieldKind_FIELD_KIND_SCALAR,
+				},
+			}
+			goSpec := ToComponentSpec(protoSpec)
+			assert.Equal(t, test.goStatus, goSpec.Status)
+		})
+	}
+}