tao

tao

___________              
\__    ___/____    ____  
  |    |  \__  \  /  _ \ 
  |    |   / __ \(  <_> )
  |____|  (____  /\____/ 
               \/

The Tao produced One; One produced Two; Two produced Three; Three produced All things.

Tao is a lightweight, modular Go application framework designed for building scalable and maintainable applications. It provides a pipeline-based task scheduling system, factory-pattern component management, configuration management, and graceful shutdown capabilities.

Features

• 🏭 Generic Factory Pattern - Type-safe component factories with multi-instance support via BaseFactory[T]
• ⚙️ Flexible Configuration - Support for YAML/JSON config files, auto-detecting single/multi-instance modes
• 📝 Structured Logging - Built-in multi-level logging system with customizable outputs
• 🔄 Graceful Shutdown - Proper resource cleanup on application termination
• 🧩 Modular Design - Easy to extend with custom components using Register[T, C]()
• 🎯 Context Aware - Full support for Go's context package for cancellation and timeouts

Installation

go get github.com/taouniverse/tao

Quick Start

1. Create a Configuration File

Create conf/config.yaml:

tao:
  log:
    level: debug
    type: console
    flag: std|short
    call_depth: 3
    disable: false
  banner:
    hide: false

2. Define Your Component (with Factory Pattern)

package main

import (
    "context"
    "github.com/taouniverse/tao"
)

// InstanceConfig stores per-instance fields
type MyInstanceConfig struct {
    Message string `json:"message"`
}

// Config implements tao.MultiConfig for multi-instance support
type MyConfig struct {
    tao.BaseMultiConfig[MyInstanceConfig]
}

func (c *MyConfig) Name() string      { return "myapp" }
func (c *MyConfig) ValidSelf()        {}
func (c *MyConfig) ToTask() tao.Task  { return nil }
func (c *MyConfig) RunAfter() []string { return nil }

var Factory *tao.BaseFactory[string]

func init() {
    var err error
    Factory, err = tao.Register("myapp", &MyConfig{}, NewMyApp)
    if err != nil {
        panic(err)
    }
}

func NewMyApp(name string, cfg MyInstanceConfig) (string, func() error, error) {
    closer := func() error { return nil }
    return cfg.Message, closer, nil
}

func main() {
    if err := tao.Run(context.Background(), nil); err != nil {
        panic(err)
    }
}

3. Run Your Application

go run main.go

Core Concepts

Register — Generic Component Registration

Register[T any, C any]() is the unified entry point for all components:

// Multi-instance mode (config implements MultiConfig[C])
factory, _ := tao.Register[*gorm.DB, InstanceConfig]("mysql", &Config{}, NewMySQL)

// Single-instance mode (config does NOT implement MultiConfig)
factory, _ := tao.Register[*gin.Engine, Config]("gin", &Config{}, NewGin)

// Pure config registration (constructor = nil)
_, _ := tao.Register[struct{}, struct{}]("mytask", &TaskConfig{}, nil)

BaseFactory[T] — Type-Safe Component Factory

factory := tao.NewBaseFactory[*gorm.DB]()
factory.RegisterWithCloser("master", dbMaster, dbMaster.Close)
factory.RegisterWithCloser("replica", dbReplica, dbReplica.Close)

db, _ := factory.Get("master")
names := factory.Names()
count := factory.Count()

factory.CloseAll()

MultiConfig[C] — Multi-Instance Configuration Interface

type MultiConfig[C any] interface {
    tao.Config
    GetInstances() []Instance[C]
    SetInstances(instances []Instance[C])
    GetDefaultInstanceName() string
}

Embed BaseMultiConfig[C] to get the implementation for free:

type Config struct {
    tao.BaseMultiConfig[InstanceConfig]
    RunAfters []string `json:"run_after,omitempty"`
}

Instances are stored as an ordered slice to preserve creation order:

type Instance[C any] struct {
    Name string
    Cfg  C
}

Use GetInstanceByName(name string) (C, bool) to look up a specific instance by name.

Task

The basic unit of work in Tao:

task := tao.NewTask("mytask", func(ctx context.Context, param tao.Parameter) (tao.Parameter, error) {
    // Your logic here
    return param, nil
}, tao.SetClose(func() error {
    // Cleanup logic
    return nil
}))

Pipeline

A Pipeline orchestrates multiple tasks with dependencies:

pipeline := tao.NewPipeline("mypipeline")
pipeline.Register(tao.NewPipeTask(task1))
pipeline.Register(tao.NewPipeTask(task2, "task1")) // task2 depends on task1

Configuration

Implement the Config interface for your module:

type Config interface {
    Name() string           // Config identifier
    ValidSelf()             // Set default values
    ToTask() Task           // Convert to executable task
    RunAfter() []string     // Dependency task names
}

For multi-instance components, implement MultiConfig[C] instead.

Logging

Tao provides multiple logging levels:

tao.Debug("debug message")
tao.Info("info message")
tao.Warn("warning message")
tao.Error("error message")

Project Structure

tao/
├── tao.go          # Core Universe, Run(), Register[T,C]()
├── factory.go      # Factory[T] interface + BaseFactory[T]
├── config.go       # Config/MultiConfig interfaces + parseMultiConfig
├── pipeline.go     # Pipeline implementation for task orchestration
├── task.go         # Task interface and implementation
├── init.go         # Initialization and config loading
├── log.go          # Logging system
├── param.go        # Parameter passing between tasks
├── error.go        # Error handling utilities
├── factory_test.go # Factory & BaseMultiConfig tests
└── config_test.go  # Config & parseMultiConfig tests

Unit Tests

The core library has comprehensive test coverage:

Running Tests

# All tests
cd tao && go test -v ./...

# Specific category
cd tao && go test -v -run "TestFactory" ./...
cd tao && go test -v -run "TestParseMultiConfig" ./...

# With coverage
cd tao && go test -race -coverprofile=coverage.out ./...

Advanced Usage

Multi-Instance Database Pattern

mysql:
  default_instance: master
  master:
    host: 10.0.0.1
    port: 3306
    user: app
    password: secret
    db: production
  replica:
    host: 10.0.0.2
    port: 3306
    user: readonly
    db: production

masterDB, _ := mysql.GetDB("master")
replicaDB, _ := mysql.GetDB("replica")

Custom Logger

writer := os.Stdout
logger := &myCustomLogger{}
tao.SetWriter("myapp", writer)
tao.SetLogger("myapp", logger)

Development Mode

For quick testing without configuration files:

func init() {
    tao.DevelopMode() // Uses default configurations
}

Programmatic Configuration

configData := []byte(`
tao:
  log:
    level: info
    type: console
`)
tao.SetAllConfigBytes(configData, tao.Yaml)

Ecosystem Components

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.