Merge pull request #26 from donutloop/feat/example_tests

Feat/example tests

retry/doc_test.go

@@ -0,0 +1,21 @@
+package retry_test
+
+import (
+	"context"
+	"fmt"
+	"github.com/donutloop/toolkit/retry"
+)
+
+func ExampleRetrier() {
+	r := retry.NewRetrier()
+	err := r.Retry(context.Background(), func() (bool, error) {
+		fmt.Println("fire request")
+		return true, nil
+	})
+
+	if err != nil {
+		fmt.Println(fmt.Sprintf("error: (%v)", err))
+	}
+
+	// Output: fire request
+}

schedule/doc_test.go

@@ -0,0 +1,25 @@
+package schedule_test
+
+import (
+	"context"
+	"fmt"
+	"github.com/donutloop/toolkit/schedule"
+)
+
+func ExampleFIFOScheduler() {
+
+	s := schedule.NewFIFOScheduler()
+	defer s.Stop()
+
+	job := func(ctx context.Context) {
+		fmt.Println("create db entry")
+	}
+
+	if err := s.Schedule(job); err != nil {
+		fmt.Println(fmt.Sprintf("error: (%v)", err))
+	}
+
+	s.WaitFinish(1)
+
+	// Output: create db entry
+}

singleton/README.md

@@ -16,8 +16,8 @@ type config struct {
 	Port int
 }
 
-var configSingleton = NewSingleton(func() (interface{}, error) {
-	return &config{Addr:"localhost", Port:80,}, nil
+var configSingleton singleton.NewSingleton = singleton.NewSingleton(func() (interface{}, error) {
+	return &config{Addr:"localhost", Port:80}, nil
 })
 
 func Config() (*config, error) {

singleton/doc_test.go

@@ -0,0 +1,36 @@
+package singleton_test
+
+import (
+	"fmt"
+	"github.com/donutloop/toolkit/singleton"
+)
+
+func ExampleSingleton() {
+
+	type config struct {
+		Addr string
+		Port int
+	}
+
+	configSingleton := singleton.NewSingleton(func() (interface{}, error) {
+		return &config{Addr: "localhost", Port: 80}, nil
+	})
+
+	configFunc := func() (*config, error) {
+		s, err := configSingleton.Get()
+		if err != nil {
+			return nil, err
+		}
+		return s.(*config), nil
+	}
+
+	configFunc()
+
+	c, err := configFunc()
+	if err != nil {
+		fmt.Println(fmt.Sprintf("error: (%v)", err))
+	}
+
+	fmt.Println(fmt.Sprintf("%#v", c))
+	// Output: &singleton_test.config{Addr:"localhost", Port:80}
+}