Compare commits
105 Commits
Author | SHA1 | Date | |
---|---|---|---|
d85f3f132a | |||
b579ffb5ea | |||
6b4202956e | |||
37e0380939 | |||
|
3cac13e35b | ||
d52e22c187 | |||
3cc1cf899a | |||
89b41364c3 | |||
d7ffcd19f8 | |||
6b27204711 | |||
4bee1a7041 | |||
f8f36b157f | |||
7018485fde | |||
dcae9f14ee | |||
510dd16e48 | |||
|
257964fb26 | ||
11fe3f3ef7 | |||
|
ba9aa37eae | ||
d54d71403c | |||
|
d9c127339d | ||
2290d7573b | |||
|
7f449da60b | ||
c01614781a | |||
|
95606b8f21 | ||
c70f6386d0 | |||
|
28c896b8fb | ||
|
0c0e1307bd | ||
|
1f82ecea93 | ||
76101e6ce1 | |||
|
b830dc9749 | ||
8988703465 | |||
|
0ec641747a | ||
fa03d3b557 | |||
|
2cebca91a6 | ||
5204de7cbb | |||
|
dcebdb62f2 | ||
5877222e8a | |||
|
811c83a189 | ||
0b610c430e | |||
|
e441398ab4 | ||
|
df29357782 | ||
dc0b42f998 | |||
|
c9657f0b20 | ||
150d1e57f6 | |||
|
2c31e3b350 | ||
|
7794d7a281 | ||
|
083ef551a0 | ||
|
0ecb1c1659 | ||
|
e49cae189a | ||
909ad599bb | |||
|
784b309405 | ||
9f71fdea5f | |||
|
dc84a2eb2a | ||
|
ad3e3e3247 | ||
|
006ed2929c | ||
3920f11b69 | |||
|
a84556fc6f | ||
|
6a936fa610 | ||
|
a358f95f2e | ||
23e0b7671b | |||
|
a60d877ed1 | ||
3728d5ed05 | |||
|
2ee7357913 | ||
4fbfd6da4d | |||
|
747def6210 | ||
f5fe1f7318 | |||
|
792d9734c2 | ||
697673296b | |||
|
58860cbb4c | ||
76722cd0de | |||
764e827a9e | |||
|
0f185974fe | ||
|
659f0a2446 | ||
|
345f9cc563 | ||
|
d1b85de9ec | ||
|
4fc4a78a77 | ||
|
f9828bcbf2 | ||
|
5810834afd | ||
|
ca1d9e8da5 | ||
|
bded061837 | ||
|
93c1ac7971 | ||
|
3cce97dc16 | ||
|
b09c5e52e3 | ||
2de3b60cd3 | |||
a70ada6de8 | |||
12720131b2 | |||
|
6fdf1f0bde | ||
fbf63daf83 | |||
5956dfe847 | |||
ff5b32255a | |||
850ed7e455 | |||
|
82d9037eed | ||
|
da528a3a2a | ||
|
38f415ce3c | ||
|
6ca4795979 | ||
|
1acb559e60 | ||
|
d6d7cbe8cb | ||
d5b7526de8 | |||
|
7611c8d008 | ||
578b3c020e | |||
aa160bf194 | |||
b27d88dafc | |||
b11ef4e74f | |||
0112c44d7d | |||
8762cb5a71 |
20
.github/renovate.json
vendored
20
.github/renovate.json
vendored
@@ -1,20 +0,0 @@
|
||||
{
|
||||
"extends": [
|
||||
"config:base"
|
||||
],
|
||||
"postUpdateOptions": ["gomodTidy"],
|
||||
"packageRules": [
|
||||
{
|
||||
"matchUpdateTypes": ["minor", "patch", "pin", "digest"],
|
||||
"automerge": true
|
||||
},
|
||||
{
|
||||
"groupName": "all deps",
|
||||
"separateMajorMinor": true,
|
||||
"groupSlug": "all",
|
||||
"packagePatterns": [
|
||||
"*"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
46
.github/workflows/build.yml
vendored
46
.github/workflows/build.yml
vendored
@@ -1,46 +0,0 @@
|
||||
name: build
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
jobs:
|
||||
test:
|
||||
name: test
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: setup
|
||||
uses: actions/setup-go@v2
|
||||
with:
|
||||
go-version: 1.16
|
||||
- name: checkout
|
||||
uses: actions/checkout@v2
|
||||
- name: cache
|
||||
uses: actions/cache@v2
|
||||
with:
|
||||
path: ~/go/pkg/mod
|
||||
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
|
||||
restore-keys: ${{ runner.os }}-go-
|
||||
- name: deps
|
||||
run: go get -v -t -d ./...
|
||||
- name: test
|
||||
env:
|
||||
INTEGRATION_TESTS: yes
|
||||
run: go test -mod readonly -v ./...
|
||||
lint:
|
||||
name: lint
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: checkout
|
||||
uses: actions/checkout@v2
|
||||
- name: lint
|
||||
uses: golangci/golangci-lint-action@v2
|
||||
continue-on-error: true
|
||||
with:
|
||||
# Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version.
|
||||
version: v1.30
|
||||
# Optional: working directory, useful for monorepos
|
||||
# working-directory: somedir
|
||||
# Optional: golangci-lint command line arguments.
|
||||
# args: --issues-exit-code=0
|
||||
# Optional: show only new issues if it's a pull request. The default value is `false`.
|
||||
# only-new-issues: true
|
53
.github/workflows/job_coverage.yml
vendored
Normal file
53
.github/workflows/job_coverage.yml
vendored
Normal file
@@ -0,0 +1,53 @@
|
||||
name: coverage
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ main, v3, v4 ]
|
||||
paths-ignore:
|
||||
- '.github/**'
|
||||
- '.gitea/**'
|
||||
pull_request:
|
||||
branches: [ main, v3, v4 ]
|
||||
|
||||
jobs:
|
||||
|
||||
build:
|
||||
if: github.server_url != 'https://github.com'
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: checkout code
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
filter: 'blob:none'
|
||||
|
||||
- name: setup go
|
||||
uses: actions/setup-go@v5
|
||||
with:
|
||||
cache-dependency-path: "**/*.sum"
|
||||
go-version: 'stable'
|
||||
|
||||
- name: test coverage
|
||||
run: |
|
||||
go test -v -cover ./... -covermode=count -coverprofile coverage.out -coverpkg ./...
|
||||
go tool cover -func coverage.out -o coverage.out
|
||||
|
||||
- name: coverage badge
|
||||
uses: tj-actions/coverage-badge-go@v2
|
||||
with:
|
||||
green: 80
|
||||
filename: coverage.out
|
||||
|
||||
- uses: stefanzweifel/git-auto-commit-action@v4
|
||||
name: autocommit
|
||||
with:
|
||||
commit_message: Apply Code Coverage Badge
|
||||
skip_fetch: false
|
||||
skip_checkout: false
|
||||
file_pattern: ./README.md
|
||||
|
||||
- name: push
|
||||
if: steps.auto-commit-action.outputs.changes_detected == 'true'
|
||||
uses: ad-m/github-push-action@master
|
||||
with:
|
||||
github_token: ${{ github.token }}
|
||||
branch: ${{ github.ref }}
|
29
.github/workflows/job_lint.yml
vendored
Normal file
29
.github/workflows/job_lint.yml
vendored
Normal file
@@ -0,0 +1,29 @@
|
||||
name: lint
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
types: [opened, reopened, synchronize]
|
||||
branches: [ master, v3, v4 ]
|
||||
paths-ignore:
|
||||
- '.github/**'
|
||||
- '.gitea/**'
|
||||
|
||||
jobs:
|
||||
lint:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: checkout code
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
filter: 'blob:none'
|
||||
- name: setup go
|
||||
uses: actions/setup-go@v5
|
||||
with:
|
||||
cache-dependency-path: "**/*.sum"
|
||||
go-version: 'stable'
|
||||
- name: setup deps
|
||||
run: go get -v ./...
|
||||
- name: run lint
|
||||
uses: golangci/golangci-lint-action@v6
|
||||
with:
|
||||
version: 'latest'
|
31
.github/workflows/job_test.yml
vendored
Normal file
31
.github/workflows/job_test.yml
vendored
Normal file
@@ -0,0 +1,31 @@
|
||||
name: test
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
types: [opened, reopened, synchronize]
|
||||
branches: [ master, v3, v4 ]
|
||||
push:
|
||||
branches: [ master, v3, v4 ]
|
||||
paths-ignore:
|
||||
- '.github/**'
|
||||
- '.gitea/**'
|
||||
|
||||
jobs:
|
||||
test:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: checkout code
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
filter: 'blob:none'
|
||||
- name: setup go
|
||||
uses: actions/setup-go@v5
|
||||
with:
|
||||
cache-dependency-path: "**/*.sum"
|
||||
go-version: 'stable'
|
||||
- name: setup deps
|
||||
run: go get -v ./...
|
||||
- name: run test
|
||||
env:
|
||||
INTEGRATION_TESTS: yes
|
||||
run: go test -mod readonly -v ./...
|
50
.github/workflows/job_tests.yml
vendored
Normal file
50
.github/workflows/job_tests.yml
vendored
Normal file
@@ -0,0 +1,50 @@
|
||||
name: test
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
types: [opened, reopened, synchronize]
|
||||
branches: [ master, v3, v4 ]
|
||||
push:
|
||||
branches: [ master, v3, v4 ]
|
||||
paths-ignore:
|
||||
- '.github/**'
|
||||
- '.gitea/**'
|
||||
|
||||
jobs:
|
||||
test:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: checkout code
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
filter: 'blob:none'
|
||||
- name: checkout tests
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
ref: master
|
||||
filter: 'blob:none'
|
||||
repository: unistack-org/micro-tests
|
||||
path: micro-tests
|
||||
- name: setup go
|
||||
uses: actions/setup-go@v5
|
||||
with:
|
||||
cache-dependency-path: "**/*.sum"
|
||||
go-version: 'stable'
|
||||
- name: setup go work
|
||||
env:
|
||||
GOWORK: ${{ github.workspace }}/go.work
|
||||
run: |
|
||||
go work init
|
||||
go work use .
|
||||
go work use micro-tests
|
||||
- name: setup deps
|
||||
env:
|
||||
GOWORK: ${{ github.workspace }}/go.work
|
||||
run: go get -v ./...
|
||||
- name: run tests
|
||||
env:
|
||||
INTEGRATION_TESTS: yes
|
||||
GOWORK: ${{ github.workspace }}/go.work
|
||||
run: |
|
||||
cd micro-tests
|
||||
go test -mod readonly -v ./... || true
|
46
.github/workflows/pr.yml
vendored
46
.github/workflows/pr.yml
vendored
@@ -1,46 +0,0 @@
|
||||
name: prbuild
|
||||
on:
|
||||
pull_request:
|
||||
branches:
|
||||
- master
|
||||
jobs:
|
||||
test:
|
||||
name: test
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: setup
|
||||
uses: actions/setup-go@v2
|
||||
with:
|
||||
go-version: 1.16
|
||||
- name: checkout
|
||||
uses: actions/checkout@v2
|
||||
- name: cache
|
||||
uses: actions/cache@v2
|
||||
with:
|
||||
path: ~/go/pkg/mod
|
||||
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
|
||||
restore-keys: ${{ runner.os }}-go-
|
||||
- name: deps
|
||||
run: go get -v -t -d ./...
|
||||
- name: test
|
||||
env:
|
||||
INTEGRATION_TESTS: yes
|
||||
run: go test -mod readonly -v ./...
|
||||
lint:
|
||||
name: lint
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: checkout
|
||||
uses: actions/checkout@v2
|
||||
- name: lint
|
||||
uses: golangci/golangci-lint-action@v2
|
||||
continue-on-error: true
|
||||
with:
|
||||
# Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version.
|
||||
version: v1.30
|
||||
# Optional: working directory, useful for monorepos
|
||||
# working-directory: somedir
|
||||
# Optional: golangci-lint command line arguments.
|
||||
# args: --issues-exit-code=0
|
||||
# Optional: show only new issues if it's a pull request. The default value is `false`.
|
||||
# only-new-issues: true
|
5
.golangci.yml
Normal file
5
.golangci.yml
Normal file
@@ -0,0 +1,5 @@
|
||||
run:
|
||||
concurrency: 8
|
||||
timeout: 5m
|
||||
issues-exit-code: 1
|
||||
tests: true
|
@@ -1 +1,2 @@
|
||||
# micro-config-file
|
||||

|
||||
|
336
file.go
336
file.go
@@ -1,27 +1,28 @@
|
||||
package file
|
||||
package file // import "go.unistack.org/micro-config-file/v3"
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"io/ioutil"
|
||||
"os"
|
||||
"regexp"
|
||||
|
||||
"github.com/imdario/mergo"
|
||||
"github.com/unistack-org/micro/v3/codec"
|
||||
"github.com/unistack-org/micro/v3/config"
|
||||
rutil "github.com/unistack-org/micro/v3/util/reflect"
|
||||
"dario.cat/mergo"
|
||||
"go.unistack.org/micro/v3/config"
|
||||
rutil "go.unistack.org/micro/v3/util/reflect"
|
||||
"golang.org/x/text/transform"
|
||||
)
|
||||
|
||||
var (
|
||||
DefaultStructTag = "file"
|
||||
ErrPathNotExist = errors.New("path is not exist")
|
||||
DefaultStructTag = "file"
|
||||
MaxFileSize int64 = 1 * 1024 * 1024
|
||||
)
|
||||
|
||||
type fileConfig struct {
|
||||
opts config.Options
|
||||
path string
|
||||
opts config.Options
|
||||
path string
|
||||
reader io.Reader
|
||||
transformer transform.Transformer
|
||||
}
|
||||
|
||||
func (c *fileConfig) Options() config.Options {
|
||||
@@ -29,93 +30,130 @@ func (c *fileConfig) Options() config.Options {
|
||||
}
|
||||
|
||||
func (c *fileConfig) Init(opts ...config.Option) error {
|
||||
if err := config.DefaultBeforeInit(c.opts.Context, c); err != nil && !c.opts.AllowFail {
|
||||
return err
|
||||
}
|
||||
|
||||
for _, o := range opts {
|
||||
o(&c.opts)
|
||||
}
|
||||
|
||||
path := ""
|
||||
|
||||
if c.opts.Context != nil {
|
||||
if v, ok := c.opts.Context.Value(pathKey{}).(string); ok {
|
||||
path = v
|
||||
c.path = v
|
||||
}
|
||||
if v, ok := c.opts.Context.Value(transformerKey{}).(transform.Transformer); ok {
|
||||
c.transformer = v
|
||||
}
|
||||
if v, ok := c.opts.Context.Value(readerKey{}).(io.Reader); ok {
|
||||
c.reader = v
|
||||
}
|
||||
}
|
||||
|
||||
if path == "" {
|
||||
return ErrPathNotExist
|
||||
if c.opts.Codec == nil {
|
||||
return fmt.Errorf("Codec must be specified")
|
||||
}
|
||||
|
||||
c.path = path
|
||||
if err := config.DefaultAfterInit(c.opts.Context, c); err != nil && !c.opts.AllowFail {
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (c *fileConfig) Load(ctx context.Context, opts ...config.LoadOption) error {
|
||||
for _, fn := range c.opts.BeforeLoad {
|
||||
if err := fn(ctx, c); err != nil && !c.opts.AllowFail {
|
||||
return err
|
||||
if c.opts.SkipLoad != nil && c.opts.SkipLoad(ctx, c) {
|
||||
return nil
|
||||
}
|
||||
|
||||
if err := config.DefaultBeforeLoad(ctx, c); err != nil && !c.opts.AllowFail {
|
||||
return err
|
||||
}
|
||||
|
||||
path := c.path
|
||||
transformer := c.transformer
|
||||
reader := c.reader
|
||||
|
||||
options := config.NewLoadOptions(opts...)
|
||||
if options.Context != nil {
|
||||
if v, ok := options.Context.Value(pathKey{}).(string); ok && v != "" {
|
||||
path = v
|
||||
}
|
||||
if v, ok := c.opts.Context.Value(transformerKey{}).(transform.Transformer); ok {
|
||||
transformer = v
|
||||
}
|
||||
if v, ok := c.opts.Context.Value(readerKey{}).(io.Reader); ok {
|
||||
reader = v
|
||||
}
|
||||
}
|
||||
|
||||
fp, err := os.OpenFile(c.path, os.O_RDONLY, os.FileMode(0400))
|
||||
if err != nil && !c.opts.AllowFail {
|
||||
return fmt.Errorf("failed to open: %s, error: %w", c.path, ErrPathNotExist)
|
||||
} else if err == nil {
|
||||
defer fp.Close()
|
||||
var buf []byte
|
||||
buf, err = ioutil.ReadAll(io.LimitReader(fp, int64(codec.DefaultMaxMsgSize)))
|
||||
if err == nil {
|
||||
src, err := rutil.Zero(c.opts.Struct)
|
||||
if err == nil {
|
||||
err = c.opts.Codec.Unmarshal(buf, src)
|
||||
if err == nil {
|
||||
options := config.NewLoadOptions(opts...)
|
||||
mopts := []func(*mergo.Config){mergo.WithTypeCheck}
|
||||
if options.Override {
|
||||
mopts = append(mopts, mergo.WithOverride)
|
||||
}
|
||||
if options.Append {
|
||||
mopts = append(mopts, mergo.WithAppendSlice)
|
||||
}
|
||||
err = mergo.Merge(c.opts.Struct, src, mopts...)
|
||||
}
|
||||
var fp io.Reader
|
||||
var err error
|
||||
|
||||
if path != "" {
|
||||
fp, err = os.OpenFile(path, os.O_RDONLY, os.FileMode(0o400))
|
||||
} else if c.reader != nil {
|
||||
fp = reader
|
||||
} else {
|
||||
err = fmt.Errorf("Path or Reader must be specified")
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
if !c.opts.AllowFail {
|
||||
if c.path != "" {
|
||||
return fmt.Errorf("file load path %s error: %w", path, err)
|
||||
} else {
|
||||
return fmt.Errorf("file load error: %w", err)
|
||||
}
|
||||
}
|
||||
if err != nil && !c.opts.AllowFail {
|
||||
if err = config.DefaultAfterLoad(ctx, c); err != nil && !c.opts.AllowFail {
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
for _, fn := range c.opts.AfterLoad {
|
||||
if err := fn(ctx, c); err != nil && !c.opts.AllowFail {
|
||||
if fpc, ok := fp.(io.Closer); ok {
|
||||
defer fpc.Close()
|
||||
}
|
||||
|
||||
var r io.Reader
|
||||
if transformer != nil {
|
||||
r = transform.NewReader(fp, c.transformer)
|
||||
} else {
|
||||
r = fp
|
||||
}
|
||||
|
||||
buf, err := io.ReadAll(io.LimitReader(r, MaxFileSize))
|
||||
if err != nil {
|
||||
if !c.opts.AllowFail {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (c *fileConfig) Save(ctx context.Context, opts ...config.SaveOption) error {
|
||||
for _, fn := range c.opts.BeforeSave {
|
||||
if err := fn(ctx, c); err != nil && !c.opts.AllowFail {
|
||||
if err = config.DefaultAfterLoad(ctx, c); err != nil && !c.opts.AllowFail {
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
buf, err := c.opts.Codec.Marshal(c.opts.Struct)
|
||||
dst := c.opts.Struct
|
||||
if options.Struct != nil {
|
||||
dst = options.Struct
|
||||
}
|
||||
|
||||
src, err := rutil.Zero(dst)
|
||||
if err == nil {
|
||||
var fp *os.File
|
||||
fp, err = os.OpenFile(c.path, os.O_RDONLY, os.FileMode(0400))
|
||||
if err != nil && c.opts.AllowFail {
|
||||
return nil
|
||||
} else if err != nil && !c.opts.AllowFail {
|
||||
return fmt.Errorf("failed to open: %s, error: %w", c.path, ErrPathNotExist)
|
||||
}
|
||||
|
||||
if _, werr := fp.Write(buf); werr == nil {
|
||||
err = fp.Close()
|
||||
} else {
|
||||
err = werr
|
||||
err = c.opts.Codec.Unmarshal(buf, src)
|
||||
if err == nil {
|
||||
options := config.NewLoadOptions(opts...)
|
||||
mopts := []func(*mergo.Config){mergo.WithTypeCheck}
|
||||
if options.Override {
|
||||
mopts = append(mopts, mergo.WithOverride)
|
||||
}
|
||||
if options.Append {
|
||||
mopts = append(mopts, mergo.WithAppendSlice)
|
||||
}
|
||||
err = mergo.Merge(dst, src, mopts...)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -123,10 +161,70 @@ func (c *fileConfig) Save(ctx context.Context, opts ...config.SaveOption) error
|
||||
return err
|
||||
}
|
||||
|
||||
for _, fn := range c.opts.AfterSave {
|
||||
if err := fn(ctx, c); err != nil && !c.opts.AllowFail {
|
||||
if err := config.DefaultAfterLoad(ctx, c); err != nil && !c.opts.AllowFail {
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (c *fileConfig) Save(ctx context.Context, opts ...config.SaveOption) error {
|
||||
if c.opts.SkipSave != nil && c.opts.SkipSave(ctx, c) {
|
||||
return nil
|
||||
}
|
||||
|
||||
if err := config.DefaultBeforeSave(ctx, c); err != nil && !c.opts.AllowFail {
|
||||
return err
|
||||
}
|
||||
|
||||
path := c.path
|
||||
options := config.NewSaveOptions(opts...)
|
||||
if options.Context != nil {
|
||||
if v, ok := options.Context.Value(pathKey{}).(string); ok && v != "" {
|
||||
path = v
|
||||
}
|
||||
}
|
||||
|
||||
dst := c.opts.Struct
|
||||
if options.Struct != nil {
|
||||
dst = options.Struct
|
||||
}
|
||||
|
||||
buf, err := c.opts.Codec.Marshal(dst)
|
||||
if err != nil {
|
||||
if !c.opts.AllowFail {
|
||||
return err
|
||||
}
|
||||
if err = config.DefaultAfterSave(ctx, c); err != nil && !c.opts.AllowFail {
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
fp, err := os.OpenFile(path, os.O_WRONLY|os.O_CREATE, os.FileMode(0o600))
|
||||
if err != nil {
|
||||
if !c.opts.AllowFail {
|
||||
return err
|
||||
}
|
||||
if err = config.DefaultAfterSave(ctx, c); err != nil && !c.opts.AllowFail {
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
defer fp.Close()
|
||||
|
||||
if _, err = fp.Write(buf); err == nil {
|
||||
err = fp.Close()
|
||||
}
|
||||
|
||||
if err != nil && !c.opts.AllowFail {
|
||||
return err
|
||||
}
|
||||
|
||||
if err := config.DefaultAfterSave(ctx, c); err != nil && !c.opts.AllowFail {
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
@@ -140,6 +238,29 @@ func (c *fileConfig) Name() string {
|
||||
return c.opts.Name
|
||||
}
|
||||
|
||||
func (c *fileConfig) Watch(ctx context.Context, opts ...config.WatchOption) (config.Watcher, error) {
|
||||
path := c.path
|
||||
options := config.NewWatchOptions(opts...)
|
||||
if options.Context != nil {
|
||||
if v, ok := options.Context.Value(pathKey{}).(string); ok && v != "" {
|
||||
path = v
|
||||
}
|
||||
}
|
||||
|
||||
w := &fileWatcher{
|
||||
path: path,
|
||||
opts: c.opts,
|
||||
wopts: config.NewWatchOptions(opts...),
|
||||
done: make(chan struct{}),
|
||||
vchan: make(chan map[string]interface{}),
|
||||
echan: make(chan error),
|
||||
}
|
||||
|
||||
go w.run()
|
||||
|
||||
return w, nil
|
||||
}
|
||||
|
||||
func NewConfig(opts ...config.Option) config.Config {
|
||||
options := config.NewOptions(opts...)
|
||||
if len(options.StructTag) == 0 {
|
||||
@@ -147,3 +268,82 @@ func NewConfig(opts ...config.Option) config.Config {
|
||||
}
|
||||
return &fileConfig{opts: options}
|
||||
}
|
||||
|
||||
type EnvTransformer struct {
|
||||
maxMatchSize int
|
||||
Regexp *regexp.Regexp
|
||||
TransformerFunc TransformerFunc
|
||||
overflow []byte
|
||||
}
|
||||
|
||||
var _ transform.Transformer = (*EnvTransformer)(nil)
|
||||
|
||||
// Transform implements golang.org/x/text/transform#Transformer
|
||||
func (t *EnvTransformer) Transform(dst, src []byte, atEOF bool) (nDst, nSrc int, err error) {
|
||||
t.maxMatchSize = 1024
|
||||
var n int
|
||||
// copy any overflow from the last call
|
||||
if len(t.overflow) > 0 {
|
||||
n, err = fullcopy(dst, t.overflow)
|
||||
nDst += n
|
||||
if err != nil {
|
||||
t.overflow = t.overflow[n:]
|
||||
return
|
||||
}
|
||||
t.overflow = nil
|
||||
}
|
||||
for _, index := range t.Regexp.FindAllSubmatchIndex(src, -1) {
|
||||
// copy everything up to the match
|
||||
n, err = fullcopy(dst[nDst:], src[nSrc:index[0]])
|
||||
nSrc += n
|
||||
nDst += n
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
// skip the match if it ends at the end the src buffer.
|
||||
// it could potentially match more
|
||||
if index[1] == len(src) && !atEOF {
|
||||
break
|
||||
}
|
||||
// copy the replacement
|
||||
rep := t.TransformerFunc(src, index)
|
||||
n, err = fullcopy(dst[nDst:], rep)
|
||||
nDst += n
|
||||
nSrc = index[1]
|
||||
if err != nil {
|
||||
t.overflow = rep[n:]
|
||||
return
|
||||
}
|
||||
}
|
||||
// if we're at the end, tack on any remaining bytes
|
||||
if atEOF {
|
||||
n, err = fullcopy(dst[nDst:], src[nSrc:])
|
||||
nDst += n
|
||||
nSrc += n
|
||||
return
|
||||
}
|
||||
// skip any bytes which exceede the max match size
|
||||
if skip := len(src[nSrc:]) - t.maxMatchSize; skip > 0 {
|
||||
n, err = fullcopy(dst[nDst:], src[nSrc:nSrc+skip])
|
||||
nSrc += n
|
||||
nDst += n
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
}
|
||||
err = transform.ErrShortSrc
|
||||
return
|
||||
}
|
||||
|
||||
// Reset resets the state and allows a Transformer to be reused.
|
||||
func (t *EnvTransformer) Reset() {
|
||||
t.overflow = nil
|
||||
}
|
||||
|
||||
func fullcopy(dst, src []byte) (n int, err error) {
|
||||
n = copy(dst, src)
|
||||
if n < len(src) {
|
||||
err = transform.ErrShortDst
|
||||
}
|
||||
return
|
||||
}
|
||||
|
59
file_test.go
Normal file
59
file_test.go
Normal file
@@ -0,0 +1,59 @@
|
||||
package file
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"encoding/json"
|
||||
"os"
|
||||
"testing"
|
||||
|
||||
"go.unistack.org/micro/v3/codec"
|
||||
"go.unistack.org/micro/v3/config"
|
||||
)
|
||||
|
||||
type jsoncodec struct{}
|
||||
|
||||
func (*jsoncodec) Marshal(v interface{}, opts ...codec.Option) ([]byte, error) {
|
||||
return json.Marshal(v)
|
||||
}
|
||||
|
||||
func (*jsoncodec) Unmarshal(buf []byte, v interface{}, opts ...codec.Option) error {
|
||||
return json.Unmarshal(buf, v)
|
||||
}
|
||||
|
||||
func (*jsoncodec) String() string {
|
||||
return "json"
|
||||
}
|
||||
|
||||
func TestLoadReplace(t *testing.T) {
|
||||
type Config struct {
|
||||
Key string
|
||||
Pass string
|
||||
}
|
||||
os.Setenv("PLACEHOLDER", "test")
|
||||
cfg := &Config{}
|
||||
ctx := context.TODO()
|
||||
buf := bytes.NewReader([]byte(`{"key":"val","pass":"${PLACEHOLDER}"}`))
|
||||
tr, err := NewEnvTransformer(`(?s)\$\{.*?\}`, 2, 1)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
c := NewConfig(config.Codec(
|
||||
&jsoncodec{}),
|
||||
config.Struct(cfg),
|
||||
Reader(buf),
|
||||
Transformer(tr),
|
||||
)
|
||||
|
||||
if err := c.Init(); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
if err := c.Load(ctx); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
if cfg.Pass != "test" {
|
||||
t.Fatalf("not works %#+v\n", cfg)
|
||||
}
|
||||
}
|
22
go.mod
22
go.mod
@@ -1,8 +1,22 @@
|
||||
module github.com/unistack-org/micro-config-file/v3
|
||||
module go.unistack.org/micro-config-file/v3
|
||||
|
||||
go 1.16
|
||||
go 1.22
|
||||
|
||||
toolchain go1.23.1
|
||||
|
||||
require (
|
||||
github.com/imdario/mergo v0.3.12
|
||||
github.com/unistack-org/micro/v3 v3.4.0
|
||||
dario.cat/mergo v1.0.1
|
||||
go.unistack.org/micro/v3 v3.11.14
|
||||
golang.org/x/text v0.21.0
|
||||
)
|
||||
|
||||
require (
|
||||
github.com/google/go-cmp v0.6.0 // indirect
|
||||
github.com/google/uuid v1.6.0 // indirect
|
||||
github.com/kr/pretty v0.3.1 // indirect
|
||||
github.com/rogpeppe/go-internal v1.11.0 // indirect
|
||||
go.unistack.org/micro-proto/v3 v3.4.1 // indirect
|
||||
google.golang.org/protobuf v1.35.2 // indirect
|
||||
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect
|
||||
gopkg.in/yaml.v3 v3.0.1 // indirect
|
||||
)
|
||||
|
47
go.sum
47
go.sum
@@ -1,18 +1,31 @@
|
||||
github.com/dgrijalva/jwt-go v3.2.0+incompatible/go.mod h1:E3ru+11k8xSBh+hMPgOLZmtrrCbhqsmaPHjLKYnJCaQ=
|
||||
github.com/ef-ds/deque v1.0.4/go.mod h1:gXDnTC3yqvBcHbq2lcExjtAcVrOnJCbMcZXmuj8Z4tg=
|
||||
github.com/google/uuid v1.2.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
|
||||
github.com/imdario/mergo v0.3.12 h1:b6R2BslTbIEToALKP7LxUvijTsNI9TAe80pLWN2g/HU=
|
||||
github.com/imdario/mergo v0.3.12/go.mod h1:jmQim1M+e3UYxmgPu/WyfjB3N3VflVyUjjjwH0dnCYA=
|
||||
github.com/patrickmn/go-cache v2.1.0+incompatible/go.mod h1:3Qf8kWWT7OJRJbdiICTKqZju1ZixQ/KpMGzzAfe6+WQ=
|
||||
github.com/silas/dag v0.0.0-20210121180416-41cf55125c34/go.mod h1:7RTUFBdIRC9nZ7/3RyRNH1bdqIShrDejd1YbLwgPS+I=
|
||||
github.com/unistack-org/micro/v3 v3.4.0 h1:z9F3lgAb2j4cZ1ib5qBj66JPYUAzR4sNIJqUDjVwyVQ=
|
||||
github.com/unistack-org/micro/v3 v3.4.0/go.mod h1:LXmPfbJnJNvL0kQs8HfnkV3Wya2Wb+C7keVq++RCZnk=
|
||||
golang.org/x/net v0.0.0-20210510120150-4163338589ed/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
|
||||
golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
|
||||
golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
|
||||
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
|
||||
dario.cat/mergo v1.0.1 h1:Ra4+bf83h2ztPIQYNP99R6m+Y7KfnARDfID+a+vLl4s=
|
||||
dario.cat/mergo v1.0.1/go.mod h1:uNxQE+84aUszobStD9th8a29P2fMDhsBdgRYvZOxGmk=
|
||||
github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
|
||||
github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
|
||||
github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
|
||||
github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
|
||||
github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
|
||||
github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
|
||||
github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
|
||||
github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=
|
||||
github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
|
||||
github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
|
||||
github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
|
||||
github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
|
||||
github.com/pkg/diff v0.0.0-20210226163009-20ebb0f2a09e/go.mod h1:pJLUxLENpZxwdsKMEsNbx1VGcRFpLqf3715MtcvvzbA=
|
||||
github.com/rogpeppe/go-internal v1.9.0/go.mod h1:WtVeX8xhTBvf0smdhujwtBcq4Qrzq/fJaraNFVN+nFs=
|
||||
github.com/rogpeppe/go-internal v1.11.0 h1:cWPaGQEPrBb5/AsnsZesgZZ9yb1OQ+GOISoDNXVBh4M=
|
||||
github.com/rogpeppe/go-internal v1.11.0/go.mod h1:ddIwULY96R17DhadqLgMfk9H9tvdUzkipdSkR5nkCZA=
|
||||
go.unistack.org/micro-proto/v3 v3.4.1 h1:UTjLSRz2YZuaHk9iSlVqqsA50JQNAEK2ZFboGqtEa9Q=
|
||||
go.unistack.org/micro-proto/v3 v3.4.1/go.mod h1:okx/cnOhzuCX0ggl/vToatbCupi0O44diiiLLsZ93Zo=
|
||||
go.unistack.org/micro/v3 v3.11.14 h1:3e9T30Ih9cvqZTCD8inG1qsBWRk4x5ZinWuTiDFM4CE=
|
||||
go.unistack.org/micro/v3 v3.11.14/go.mod h1:k++F5Ej4LIy3XnOW/oj3P7B97wp2t9yLSlqtUzMpatM=
|
||||
golang.org/x/text v0.21.0 h1:zyQAAkrwaneQ066sspRyJaG9VNi/YJ1NfzcGB3hZ/qo=
|
||||
golang.org/x/text v0.21.0/go.mod h1:4IBbMaMmOPCJ8SecivzSH54+73PCFmPWxNTLm+vZkEQ=
|
||||
google.golang.org/protobuf v1.35.2 h1:8Ar7bF+apOIoThw1EdZl0p1oWvMqTHmpA2fRTyZO8io=
|
||||
google.golang.org/protobuf v1.35.2/go.mod h1:9fA7Ob0pmnwhb644+1+CVWFRbNajQ6iRojtC/QF5bRE=
|
||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||
gopkg.in/yaml.v2 v2.3.0 h1:clyUAQHOM3G0M3f5vQj7LuJrETvjVot3Z5el9nffUtU=
|
||||
gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
|
||||
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
|
||||
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=
|
||||
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
||||
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||
|
55
options.go
55
options.go
@@ -1,7 +1,12 @@
|
||||
package file
|
||||
|
||||
import (
|
||||
"github.com/unistack-org/micro/v3/config"
|
||||
"io"
|
||||
"os"
|
||||
"regexp"
|
||||
|
||||
"go.unistack.org/micro/v3/config"
|
||||
"golang.org/x/text/transform"
|
||||
)
|
||||
|
||||
type pathKey struct{}
|
||||
@@ -9,3 +14,51 @@ type pathKey struct{}
|
||||
func Path(path string) config.Option {
|
||||
return config.SetOption(pathKey{}, path)
|
||||
}
|
||||
|
||||
func LoadPath(path string) config.LoadOption {
|
||||
return config.SetLoadOption(pathKey{}, path)
|
||||
}
|
||||
|
||||
func SavePath(path string) config.SaveOption {
|
||||
return config.SetSaveOption(pathKey{}, path)
|
||||
}
|
||||
|
||||
func WatchPath(path string) config.WatchOption {
|
||||
return config.SetWatchOption(pathKey{}, path)
|
||||
}
|
||||
|
||||
type readerKey struct{}
|
||||
|
||||
func Reader(r io.Reader) config.Option {
|
||||
return config.SetOption(readerKey{}, r)
|
||||
}
|
||||
|
||||
type transformerKey struct{}
|
||||
|
||||
type TransformerFunc func(src []byte, index []int) []byte
|
||||
|
||||
func Transformer(t transform.Transformer) config.Option {
|
||||
return config.SetOption(transformerKey{}, t)
|
||||
}
|
||||
|
||||
func NewEnvTransformer(rs string, trimLeft, trimRight int) (*EnvTransformer, error) {
|
||||
re, err := regexp.Compile(rs)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return &EnvTransformer{
|
||||
Regexp: re,
|
||||
TransformerFunc: func(src []byte, index []int) []byte {
|
||||
var envKey string
|
||||
if len(src) > index[1]-trimRight {
|
||||
envKey = string(src[index[0]+trimLeft : index[1]-trimRight])
|
||||
}
|
||||
|
||||
if envVal, ok := os.LookupEnv(envKey); ok {
|
||||
return []byte(envVal)
|
||||
}
|
||||
|
||||
return src[index[0]:index[1]]
|
||||
},
|
||||
}, nil
|
||||
}
|
||||
|
101
watcher.go
Normal file
101
watcher.go
Normal file
@@ -0,0 +1,101 @@
|
||||
package file
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
"reflect"
|
||||
|
||||
"go.unistack.org/micro/v3/config"
|
||||
"go.unistack.org/micro/v3/util/jitter"
|
||||
rutil "go.unistack.org/micro/v3/util/reflect"
|
||||
)
|
||||
|
||||
type fileWatcher struct {
|
||||
path string
|
||||
opts config.Options
|
||||
wopts config.WatchOptions
|
||||
done chan struct{}
|
||||
vchan chan map[string]interface{}
|
||||
echan chan error
|
||||
}
|
||||
|
||||
func (w *fileWatcher) run() {
|
||||
ticker := jitter.NewTicker(w.wopts.MinInterval, w.wopts.MaxInterval)
|
||||
defer ticker.Stop()
|
||||
|
||||
src := w.opts.Struct
|
||||
if w.wopts.Struct != nil {
|
||||
src = w.wopts.Struct
|
||||
}
|
||||
|
||||
for {
|
||||
select {
|
||||
case <-w.done:
|
||||
return
|
||||
case <-ticker.C:
|
||||
dst, err := rutil.Zero(src)
|
||||
if err == nil {
|
||||
var fp *os.File
|
||||
if fp, err = os.OpenFile(w.path, os.O_RDONLY, os.FileMode(0400)); err != nil {
|
||||
w.echan <- fmt.Errorf("failed to open: %s, error: %w", w.path, err)
|
||||
return
|
||||
}
|
||||
var buf []byte
|
||||
buf, err = io.ReadAll(io.LimitReader(fp, MaxFileSize))
|
||||
if err == nil {
|
||||
err = w.opts.Codec.Unmarshal(buf, dst)
|
||||
}
|
||||
if err != nil {
|
||||
_ = fp.Close()
|
||||
w.echan <- err
|
||||
return
|
||||
}
|
||||
err = fp.Close()
|
||||
}
|
||||
if err != nil {
|
||||
w.echan <- err
|
||||
return
|
||||
}
|
||||
srcmp, err := rutil.StructFieldsMap(src)
|
||||
if err != nil {
|
||||
w.echan <- err
|
||||
return
|
||||
}
|
||||
dstmp, err := rutil.StructFieldsMap(dst)
|
||||
if err != nil {
|
||||
w.echan <- err
|
||||
return
|
||||
}
|
||||
for sk, sv := range srcmp {
|
||||
if reflect.DeepEqual(dstmp[sk], sv) {
|
||||
delete(dstmp, sk)
|
||||
}
|
||||
}
|
||||
if len(dstmp) > 0 {
|
||||
w.vchan <- dstmp
|
||||
src = dst
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func (w *fileWatcher) Next() (map[string]interface{}, error) {
|
||||
select {
|
||||
case <-w.done:
|
||||
break
|
||||
case err := <-w.echan:
|
||||
return nil, err
|
||||
case v, ok := <-w.vchan:
|
||||
if !ok {
|
||||
break
|
||||
}
|
||||
return v, nil
|
||||
}
|
||||
return nil, config.ErrWatcherStopped
|
||||
}
|
||||
|
||||
func (w *fileWatcher) Stop() error {
|
||||
close(w.done)
|
||||
return nil
|
||||
}
|
Reference in New Issue
Block a user