Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add simplemap backend #36

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions backend/simplemap/simplemap.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
package simplemap

import (
"github.com/heetch/confita"
"github.com/pkg/errors"
"reflect"

"context"
)

// Backend that loads config from map
type Backend struct {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about just:

type Backend map[string]interface{}

?
Then we wouldn't need the NewBackend constructor function.

theMap map[string]interface{}
}

// NewBackend creates a simplemap backend.
func NewBackend(theMap map[string]interface{}) *Backend {
return &Backend{
theMap: theMap,
}
}

// LoadStruct takes a struct config and loads the map into it
func (b *Backend) LoadStruct(ctx context.Context, cfg *confita.StructConfig) error {
for _, f := range cfg.Fields {
mapVal := b.theMap[f.Key]
if mapVal == nil {
continue
}
mapRef := reflect.ValueOf(mapVal)
f.Value.Set(mapRef)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will panic if the mapVal does not have the same type as f.Value. We could return an error if the types aren't identical, but this might be perceived as being overly restrictive, because (for example) you wouldn't be able to use an int-valued map item to fill a float-valued struct field.

Perhaps it would be easiest to implement the Backend on map[string]string instead of map[string]interface{} and then just implement the Get method?

}
return nil
}

// Get is not implemented.
func (b *Backend) Get(ctx context.Context, key string) ([]byte, error) {
return nil, errors.New("not implemented")
}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that this is redundant with what we do in the convert function. Moreover you are not handling all the primitive and this is very problematic, for example if the type is an int64 the method will end with a backend.ErrNotFound error.
What can you do to improve this ?
There is also the Unmarshaler and StructLoader interface which can be used maybe you can take a look at them (it's just a proposal not sure that is the correct way to go).

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! Tried the StructLoader way, take a look :)


// Name returns the name of the flags backend.
func (b *Backend) Name() string {
return "simplemap"
}
39 changes: 39 additions & 0 deletions backend/simplemap/simplemap_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
package simplemap_test

import (
"context"
"github.com/heetch/confita"
"github.com/heetch/confita/backend/simplemap"
"github.com/stretchr/testify/require"
"testing"
"time"
)

func TestSimplemapBackend(t *testing.T) {
type config struct {
Name string `config:"Name"`
Age int `config:"Age"`
Negative int `config:"Negative"`
Balance float64 `config:"Balance"`
Timeout time.Duration `config:"Timeout"`
}

b := simplemap.NewBackend(map[string]interface{}{
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's have some test cases that test error cases, such as mismatched types, please.

"Name": "Bob",
"Age": 30,
"Negative": -10,
"Balance": 1234.56,
"Timeout": 10 * time.Second,
})

var c config
require.Equal(t, "simplemap", b.Name())
err := confita.NewLoader(b).Load(context.Background(), &c)

require.NoError(t, err)
require.Equal(t, "Bob", c.Name)
require.Equal(t, 30, c.Age)
require.Equal(t, -10, c.Negative)
require.Equal(t, 1234.56, c.Balance)
require.Equal(t, 10*time.Second, c.Timeout)
}