feat: component ref

components/file/types.go

@@ -19,10 +19,13 @@ package file
 import (
 	"encoding/json"
 	"io"
+
+	"mosn.io/layotto/components/ref"
 )
 
 // FileConfig wraps configuration for a file implementation
 type FileConfig struct {
+	ref.Config
 	Metadata json.RawMessage `json:"metadata"`
 	Type     string          `json:"type"`
 }

components/go.mod

@@ -13,20 +13,17 @@ require (
 	github.com/aws/aws-sdk-go-v2/credentials v1.12.4
 	github.com/aws/aws-sdk-go-v2/feature/s3/manager v1.11.14
 	github.com/aws/aws-sdk-go-v2/service/s3 v1.26.10
-	github.com/baiyubin/aliyun-sts-go-sdk v0.0.0-20180326062324-cfa1a18b161f // indirect
+	github.com/dapr/components-contrib v1.5.1-rc.1
 	github.com/go-redis/redis/v8 v8.8.0
 	github.com/go-zookeeper/zk v1.0.2
 	github.com/golang/mock v1.6.0
 	github.com/google/uuid v1.3.0
 	github.com/hashicorp/consul/api v1.3.0
 	github.com/jarcoal/httpmock v1.2.0
 	github.com/jinzhu/copier v0.3.6-0.20220506024824-3e39b055319a
-	github.com/matttproud/golang_protobuf_extensions v1.0.2-0.20181231171920-c182affec369 // indirect
 	github.com/minio/minio-go/v7 v7.0.15
-	github.com/mitchellh/mapstructure v1.4.1 // indirect
 	github.com/pkg/errors v0.9.1
 	github.com/qiniu/go-sdk/v7 v7.11.1
-	github.com/spf13/afero v1.2.2 // indirect
 	github.com/stretchr/testify v1.7.0
 	github.com/tencentyun/cos-go-sdk-v5 v0.7.33
 	github.com/valyala/fasthttp v1.26.0
@@ -36,9 +33,7 @@ require (
 	go.etcd.io/etcd/client/v3 v3.5.0
 	go.etcd.io/etcd/server/v3 v3.5.0
 	go.mongodb.org/mongo-driver v1.8.0
-	go.uber.org/atomic v1.7.0
-	golang.org/x/net v0.0.0-20210614182718-04defd469f4e // indirect
-	golang.org/x/oauth2 v0.0.0-20201208152858-08078c50e5b5 // indirect
+	go.uber.org/atomic v1.8.0
 	google.golang.org/grpc v1.38.0
 	mosn.io/api v1.1.0
 	mosn.io/mosn v1.1.0

components/hello/hello.go

@@ -16,7 +16,11 @@
 
 package hello
 
-import "context"
+import (
+	"context"
+
+	"mosn.io/layotto/components/ref"
+)
 
 const ServiceName = "hello"
 
@@ -26,6 +30,7 @@ type HelloService interface {
 }
 
 type HelloConfig struct {
+	ref.Config
 	Type        string `json:"type"`
 	HelloString string `json:"hello"`
 }

components/hello/helloworld/helloworld.go

@@ -20,11 +20,16 @@ import (
 	"context"
 	"sync/atomic"
 
+	"github.com/dapr/components-contrib/secretstores"
+
+	"mosn.io/layotto/components/configstores"
 	"mosn.io/layotto/components/hello"
 )
 
 type HelloWorld struct {
-	Say atomic.Value
+	Say         atomic.Value
+	config      configstores.Store
+	secretStore secretstores.SecretStore
 }
 
 func (hw *HelloWorld) ApplyConfig(ctx context.Context, metadata map[string]string) (err error) {
@@ -36,6 +41,17 @@ func (hw *HelloWorld) ApplyConfig(ctx context.Context, metadata map[string]strin
 	return nil
 }
 
+func (hw *HelloWorld) SetConfigStore(cs configstores.Store) (err error) {
+	//save for use
+	hw.config = cs
+	return nil
+}
+func (hw *HelloWorld) SetSecretStore(ss secretstores.SecretStore) (err error) {
+	//save for use
+	hw.secretStore = ss
+	return nil
+}
+
 var _ hello.HelloService = &HelloWorld{}
 
 func NewHelloWorld() hello.HelloService {

components/hello/helloworld/helloworld_test.go

@@ -20,6 +20,8 @@ import (
 	"context"
 	"testing"
 
+	"github.com/stretchr/testify/assert"
+
 	"mosn.io/layotto/components/pkg/common"
 
 	"mosn.io/layotto/components/hello"
@@ -59,4 +61,10 @@ func TestHelloWorld(t *testing.T) {
 	if resp.HelloString != "Bye, Layotto" {
 		t.Fatalf("hello output failed")
 	}
+
+	component := hs.(common.SetComponent)
+	err = component.SetConfigStore(nil)
+	assert.Nil(t, err)
+	err = component.SetSecretStore(nil)
+	assert.Nil(t, err)
 }

components/oss/types.go

@@ -19,6 +19,8 @@ package oss
 import (
 	"encoding/json"
 	"errors"
+
+	"mosn.io/layotto/components/ref"
 )
 
 const (
@@ -31,6 +33,7 @@ var (
 
 // Config wraps configuration for a oss implementation
 type Config struct {
+	ref.Config
 	Metadata map[string]json.RawMessage `json:"metadata"`
 	Type     string                     `json:"type"`
 }

components/pkg/common/inject_component.go

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2021 Layotto Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package common
+
+import (
+	"mosn.io/layotto/components/configstores"
+
+	"github.com/dapr/components-contrib/secretstores"
+)
+
+type SetComponent interface {
+	SetConfigStore(cs configstores.Store) (err error)
+	SetSecretStore(ss secretstores.SecretStore) (err error)
+}

components/ref/config.go

@@ -18,10 +18,11 @@ package ref
 
 // Config is ref json config
 type Config struct {
-	SecretRef []*Item `json:"secret_ref"`
+	SecretRef    []*SecretRefConfig  `json:"secret_ref"`
+	ComponentRef *ComponentRefConfig `json:"component_ref"`
 }
 
-type Item struct {
+type SecretRefConfig struct {
 	//secret component name, such as : local.file
 	StoreName string `json:"store_name"`
 	// key in the secret component
@@ -31,3 +32,8 @@ type Item struct {
 	// key need to inject into metadata
 	InjectAs string `json:"inject_as"`
 }
+
+type ComponentRefConfig struct {
+	SecretStore string `json:"secret_store"`
+	ConfigStore string `json:"config_store"`
+}

configs/config_ref_example.json

@@ -24,7 +24,28 @@
                       "hellos": {
                         "helloworld": {
                           "type": "helloworld",
-                          "hello": "greeting"
+                          "hello": "greeting",
+                          "secret_ref": [
+                            {
+                              "store_name": "local.file",
+                              "key": "db-user-pass:password",
+                              "sub_key": "db-user-pass:password",
+                              "inject_as": "redisPassword"
+                            }
+                          ],
+                          "component_ref": {
+                            "config_store": "config_demo",
+                            "secret_store": "local.file"
+                          }
+                        }
+                      },
+                      "config_store": {
+                        "config_demo": {
+                          "type": "etcd",
+                          "address": [
+                            "127.0.0.1:2379"
+                          ],
+                          "timeout": "10"
                         }
                       },
                       "secret_store": {

pkg/runtime/ref/contianer.go

@@ -28,17 +28,18 @@ type RefContainer struct {
 	ConfigRef map[string]configstores.Store
 }
 
+// NewRefContainer return a new container
 func NewRefContainer() *RefContainer {
 	return &RefContainer{
 		SecretRef: make(map[string]secretstores.SecretStore),
 		ConfigRef: make(map[string]configstores.Store),
 	}
 }
 
-func (r *RefContainer) GetSecretStore(key string) secretstores.SecretStore {
+func (r *RefContainer) getSecretStore(key string) secretstores.SecretStore {
 	return r.SecretRef[key]
 }
 
-func (r *RefContainer) GetConfigStore(key string) configstores.Store {
+func (r *RefContainer) getConfigStore(key string) configstores.Store {
 	return r.ConfigRef[key]
 }

pkg/runtime/ref/contianer_test.go

@@ -33,7 +33,7 @@ func TestRefContainer(t *testing.T) {
 	container.SecretRef["fake"] = ss
 	cf := &mock.MockStore{}
 	container.ConfigRef["mock"] = cf
-	assert.Equal(t, ss, container.GetSecretStore("fake"))
-	assert.Equal(t, cf, container.GetConfigStore("mock"))
+	assert.Equal(t, ss, container.getSecretStore("fake"))
+	assert.Equal(t, cf, container.getConfigStore("mock"))
 
 }

pkg/runtime/ref/injector.go

@@ -17,18 +17,34 @@
 package ref
 
 import (
+	"fmt"
+
 	"github.com/dapr/components-contrib/secretstores"
 
+	"mosn.io/layotto/components/configstores"
 	"mosn.io/layotto/components/ref"
 )
 
 type DefaultInjector struct {
-	Container RefContainer
+	//limit ref component
+	ComponentLimit map[string]struct{}
+	Container      RefContainer
+}
+
+// NewDefaultInjector return a single Inject
+func NewDefaultInjector(secretStores map[string]secretstores.SecretStore, configStores map[string]configstores.Store) *DefaultInjector {
+	injector := &DefaultInjector{
+		Container: RefContainer{
+			SecretRef: secretStores,
+			ConfigRef: configStores,
+		},
+	}
+	return injector
 }
 
 // InjectSecretRef  inject secret to metaData
 // TODO: permission control
-func (i *DefaultInjector) InjectSecretRef(items []*ref.Item, metaData map[string]string) (map[string]string, error) {
+func (i *DefaultInjector) InjectSecretRef(items []*ref.SecretRefConfig, metaData map[string]string) (map[string]string, error) {
 	if metaData == nil {
 		metaData = make(map[string]string)
 	}
@@ -38,7 +54,7 @@ func (i *DefaultInjector) InjectSecretRef(items []*ref.Item, metaData map[string
 
 	meta := make(map[string]string)
 	for _, item := range items {
-		store := i.Container.GetSecretStore(item.StoreName)
+		store := i.Container.getSecretStore(item.StoreName)
 		secret, err := store.GetSecret(secretstores.GetSecretRequest{
 			Name: item.Key,
 		})
@@ -62,3 +78,25 @@ func (i *DefaultInjector) InjectSecretRef(items []*ref.Item, metaData map[string
 	}
 	return metaData, nil
 }
+
+func (i *DefaultInjector) InjectConfigStoreRef(cf *ref.ComponentRefConfig) (configstores.Store, error) {
+	if cf == nil || cf.ConfigStore == "" {
+		return nil, nil
+	}
+	configStore := i.Container.getConfigStore(cf.ConfigStore)
+	if configStore == nil {
+		return nil, fmt.Errorf("fail to get configStore:%v", cf.ConfigStore)
+	}
+	return configStore, nil
+}
+
+func (i *DefaultInjector) InjectSecretStoreRef(cf *ref.ComponentRefConfig) (secretstores.SecretStore, error) {
+	if cf == nil || cf.SecretStore == "" {
+		return nil, nil
+	}
+	secretStore := i.Container.getSecretStore(cf.SecretStore)
+	if secretStore == nil {
+		return nil, fmt.Errorf("fail to get secretStore:%v", cf.SecretStore)
+	}
+	return secretStore, nil
+}

pkg/runtime/ref/injector_test.go

@@ -35,29 +35,49 @@ func TestInject(t *testing.T) {
 	cf := &mock.MockStore{}
 	container.ConfigRef["mock_config_store"] = cf
 
-	injector := DefaultInjector{Container: *container}
+	injector := NewDefaultInjector(container.SecretRef, container.ConfigRef)
 	meta := make(map[string]string)
 
-	var items []*ref.Item
+	var items []*ref.SecretRefConfig
 	secretRef, err := injector.InjectSecretRef(nil, meta)
 	assert.Nil(t, err)
 	assert.Equal(t, len(secretRef), 0)
 	secretRef, err = injector.InjectSecretRef(items, nil)
 	assert.Nil(t, err)
 	assert.Equal(t, len(secretRef), 0)
-	items = append(items, &ref.Item{
+	items = append(items, &ref.SecretRefConfig{
 		StoreName: "fake_secret_store",
 		Key:       "good-key",
 		SubKey:    "good-key",
 		InjectAs:  "ref-key",
 	})
-	items = append(items, &ref.Item{
+	items = append(items, &ref.SecretRefConfig{
 		StoreName: "fake_secret_store",
 		Key:       "good-key",
 		SubKey:    "good-key",
 	})
 	injector.InjectSecretRef(items, meta)
 	assert.Equal(t, meta["ref-key"], "life is good")
 	assert.Equal(t, meta["good-key"], "life is good")
+	secretStoreRef, err := injector.InjectSecretStoreRef(&ref.ComponentRefConfig{
+		SecretStore: "fake_secret_store",
+	})
+	assert.Nil(t, err)
+	assert.Equal(t, secretStoreRef, ss)
+
+	_, err = injector.InjectSecretStoreRef(&ref.ComponentRefConfig{
+		SecretStore: "null",
+	})
+	assert.NotNil(t, err)
 
+	configStoreRef, err := injector.InjectConfigStoreRef(&ref.ComponentRefConfig{
+		ConfigStore: "mock_config_store",
+	})
+	assert.Nil(t, err)
+	assert.Equal(t, configStoreRef, cf)
+
+	_, err = injector.InjectConfigStoreRef(&ref.ComponentRefConfig{
+		ConfigStore: "null",
+	})
+	assert.NotNil(t, err)
 }