suzushiro

suzushiro

Package suzushiro provides a simple pipeline pettern implementation.

Example

// implements 'A' and 'B' types on the interface 'Actor'
type A struct{}

func (a *A) GetName() string {
	return "A"
}

func (a *A) Run(context *Context) error {
	context.AddStr("Key", "A")

	return nil
}

func (a *A) OnSucceeded(context *Context)         {}
func (a *A) OnFailed(context *Context, err error) {}

type B struct {
	name string
}

func (b *B) GetName() string {
	return b.name
}

func (b *B) Run(context *Context) error {
	str, err := context.GetStr("Key")
	if err != nil {
		return err
	}

	context.AddStr("Key", str+b.name)

	return nil
}

func (b *B) OnSucceeded(context *Context)         {}
func (b *B) OnFailed(context *Context, err error) {}

func TestSuzushiro_Example(t *testing.T) {

	// supports anonymous functions via NewAction function.
	c := NewAction(
		"C",
		func(context *Context) error {
			str, err := context.GetStr("Key")
			if err != nil {
				return err
			}

			context.AddStr("Key", str+"C")
			return nil
		},
		nil,
		nil,
	)
	suzu := NewSuzushiro()
	actions := []Actor{
		&A{},
		&B{
			name: "B",
		},
		c,
	}

	suzu.AddLane("lane", actions)

	context := NewContext(true)
	done := make(chan interface{})
	suzu.RunLaneAsync(
		"lane",
		context,
		func(context *Context) {
			defer close(done)

			str, err := context.GetStr("Key")
			if err != nil {
				return
			}

			// 'str' is 'ABC'!
			assert.Equal(t, str, "ABC")
		},
		func(context *Context, err error) {
			defer close(done)

			assert.Fail(t, err.Error())
		},
	)

	<-done
}

Enjoy!

License

MIT License.