component

Example test to demonstrate usage of the component package

package main

import (
	"context"
	"errors"
	"fmt"
	"log/slog"

	"github.com/gopherd/core/component"
	"github.com/gopherd/core/typing"
)

// mockComponent is a mock implementation of the Component interface for testing
type mockComponent struct {
	component.BaseComponent[mockOptions]
	initCalled     bool
	uninitCalled   bool
	startCalled    bool
	shutdownCalled bool

	initError     bool
	startError    bool
	shutdownError bool
	uninitError   bool
}

type mockOptions struct {
	Value string
}

func (m *mockComponent) Init(ctx context.Context) error {
	m.initCalled = true
	if m.initError {
		return errors.New("mock init error")
	}
	return nil
}

func (m *mockComponent) Uninit(ctx context.Context) error {
	m.uninitCalled = true
	if m.uninitError {
		return errors.New("mock uninit error")
	}
	return nil
}

func (m *mockComponent) Start(ctx context.Context) error {
	m.startCalled = true
	if m.startError {
		return errors.New("mock start error")
	}
	return nil
}

func (m *mockComponent) Shutdown(ctx context.Context) error {
	m.shutdownCalled = true
	if m.shutdownError {
		return errors.New("mock shutdown error")
	}
	return nil
}

// mockContainer is a mock implementation of the Container interface for testing
type mockContainer struct {
	components map[string]component.Component
	logger     *slog.Logger
}

func newMockContainer() *mockContainer {
	return &mockContainer{
		components: make(map[string]component.Component),
		logger:     slog.Default(),
	}
}

func (c *mockContainer) GetComponent(uuid string) component.Component {
	return c.components[uuid]
}

func (c *mockContainer) Logger() *slog.Logger {
	return c.logger
}

func main() {
	// Create a mock component
	mc := &mockComponent{}

	// Setup the component
	container := newMockContainer()
	config := component.Config{
		Name:    "ExampleComponent",
		UUID:    "example-uuid",
		Options: typing.NewRawObject(`{"Value":"example"}`),
	}

	err := mc.Setup(container, &config, false)
	if err != nil {
		fmt.Printf("Failed to setup component: %v\n", err)
		return
	}

	// Use the component
	fmt.Println(mc.String())
	fmt.Println(mc.Options().Value)

}

Output:

ExampleComponent#example-uuid
example

package main

import (
	"context"
	"errors"
	"fmt"
	"log/slog"

	"github.com/gopherd/core/component"
)

// mockComponent is a mock implementation of the Component interface for testing
type mockComponent struct {
	component.BaseComponent[mockOptions]
	initCalled     bool
	uninitCalled   bool
	startCalled    bool
	shutdownCalled bool

	initError     bool
	startError    bool
	shutdownError bool
	uninitError   bool
}

type mockOptions struct {
	Value string
}

func (m *mockComponent) Init(ctx context.Context) error {
	m.initCalled = true
	if m.initError {
		return errors.New("mock init error")
	}
	return nil
}

func (m *mockComponent) Uninit(ctx context.Context) error {
	m.uninitCalled = true
	if m.uninitError {
		return errors.New("mock uninit error")
	}
	return nil
}

func (m *mockComponent) Start(ctx context.Context) error {
	m.startCalled = true
	if m.startError {
		return errors.New("mock start error")
	}
	return nil
}

func (m *mockComponent) Shutdown(ctx context.Context) error {
	m.shutdownCalled = true
	if m.shutdownError {
		return errors.New("mock shutdown error")
	}
	return nil
}

// mockContainer is a mock implementation of the Container interface for testing
type mockContainer struct {
	components map[string]component.Component
	logger     *slog.Logger
}

func newMockContainer() *mockContainer {
	return &mockContainer{
		components: make(map[string]component.Component),
		logger:     slog.Default(),
	}
}

func (c *mockContainer) GetComponent(uuid string) component.Component {
	return c.components[uuid]
}

func (c *mockContainer) Logger() *slog.Logger {
	return c.logger
}

func main() {
	// Create a new group
	group := component.NewGroup()

	// Create and add components to the group
	for i := 0; i < 3; i++ {
		mc := &mockComponent{}
		uuid := fmt.Sprintf("example-uuid-%d", i)
		container := newMockContainer()
		_ = mc.Setup(container, &component.Config{Name: fmt.Sprintf("ExampleComponent-%d", i), UUID: uuid}, false)
		group.AddComponent(uuid, mc)
	}

	// Use the group to manage component lifecycle
	ctx := context.Background()
	_ = group.Init(ctx)
	_ = group.Start(ctx)

	// Simulate some work
	fmt.Println("Components are running...")

	// Shutdown and uninitialize
	_ = group.Shutdown(ctx)
	_ = group.Uninit(ctx)

	fmt.Println("All components have been shut down")

}

Output:

Components are running...
All components have been shut down