mirror of
https://github.com/zeromicro/go-zero.git
synced 2026-05-23 14:48:19 +08:00
Compare commits
427 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
bb33a20bc8 | ||
|
|
5536473a08 | ||
|
|
323b35ed2d | ||
|
|
30958a91f7 | ||
|
|
b94b68a427 | ||
|
|
07145b210e | ||
|
|
321a20add6 | ||
|
|
65098d4737 | ||
|
|
35425f6164 | ||
|
|
a0060ff81b | ||
|
|
289a325757 | ||
|
|
3fbe0f87b7 | ||
|
|
ea98d210fd | ||
|
|
b9bc1fdcf8 | ||
|
|
6dc570bcd7 | ||
|
|
e21997f0d7 | ||
|
|
92c0b7c3c5 | ||
|
|
6d3ed98744 | ||
|
|
fb519fa547 | ||
|
|
e9501c3fb3 | ||
|
|
fd12659729 | ||
|
|
72ebbb9774 | ||
|
|
f1fdd55b38 | ||
|
|
58787746db | ||
|
|
ca88b69d24 | ||
|
|
6b1e15cab1 | ||
|
|
6f86e5bff8 | ||
|
|
3f492df74e | ||
|
|
5e7b1f6bfe | ||
|
|
e80a64fa67 | ||
|
|
95282edb78 | ||
|
|
7b82eda993 | ||
|
|
5d09cd0e7c | ||
|
|
1e717f9f5c | ||
|
|
c6e2b4a43a | ||
|
|
e567a0c718 | ||
|
|
52f060caae | ||
|
|
f486685e99 | ||
|
|
3ae874d75d | ||
|
|
c58eb13328 | ||
|
|
14ca39bc86 | ||
|
|
3ea8a2d4b6 | ||
|
|
6d2b9fd904 | ||
|
|
5451d96a81 | ||
|
|
69c2bad410 | ||
|
|
5383e29ce6 | ||
|
|
51472004a3 | ||
|
|
caf5b7b1f1 | ||
|
|
bef9aa55e6 | ||
|
|
d0a59b13a6 | ||
|
|
469e62067c | ||
|
|
a36d58aac9 | ||
|
|
aa5118c2aa | ||
|
|
974ba5c9aa | ||
|
|
ec1de4f48d | ||
|
|
bab72b7630 | ||
|
|
ac321fc146 | ||
|
|
ae2c76765c | ||
|
|
f21970c117 | ||
|
|
d0a58d1f2d | ||
|
|
3bbc90ec24 | ||
|
|
cef83efd4e | ||
|
|
cc09ab2aba | ||
|
|
f7a60cdc24 | ||
|
|
c3a49ece8d | ||
|
|
1a38eddffe | ||
|
|
5bcee4cf7c | ||
|
|
5c9fae7e62 | ||
|
|
ec3e02624c | ||
|
|
22b157bb6c | ||
|
|
095b603788 | ||
|
|
bc3c9484d1 | ||
|
|
162e9cef86 | ||
|
|
94ddb3380e | ||
|
|
16c61c6657 | ||
|
|
14bf2f33f7 | ||
|
|
305587aa81 | ||
|
|
2cdff97934 | ||
|
|
bbe1249ecb | ||
|
|
e62870e268 | ||
|
|
92b450eb11 | ||
|
|
d58cf7a12a | ||
|
|
036d803fbb | ||
|
|
c6ab11b14f | ||
|
|
9e20b1bbfe | ||
|
|
fadef0ccd9 | ||
|
|
4382ec0e0d | ||
|
|
db99addc64 | ||
|
|
97bf3856c1 | ||
|
|
ff6c6558dd | ||
|
|
5d4e7c84ee | ||
|
|
cb4fcf2c6c | ||
|
|
ee88abce14 | ||
|
|
ecc3653d44 | ||
|
|
ba8ac974aa | ||
|
|
50de01fb49 | ||
|
|
fabea4c448 | ||
|
|
6d9dfc08f9 | ||
|
|
252fabcc4b | ||
|
|
415c4c91fc | ||
|
|
0cc9d4ff8d | ||
|
|
8bc34defc4 | ||
|
|
8dd764679c | ||
|
|
9fe868ade9 | ||
|
|
4e48286838 | ||
|
|
ab01442d46 | ||
|
|
8694e38384 | ||
|
|
d5e550e79b | ||
|
|
affdab660e | ||
|
|
7d5858e83a | ||
|
|
815a6a6485 | ||
|
|
475d17e17d | ||
|
|
8472415472 | ||
|
|
faad6e27e3 | ||
|
|
58a0b17451 | ||
|
|
89eccfdb97 | ||
|
|
78ea0769fd | ||
|
|
e0fa8d820d | ||
|
|
dfd58c213c | ||
|
|
83cacf51b7 | ||
|
|
6dccfa29fd | ||
|
|
7e0b0ab0b1 | ||
|
|
ac18cc470d | ||
|
|
f4471846ff | ||
|
|
9c2d526a11 | ||
|
|
2b9fc26c38 | ||
|
|
321dc2d410 | ||
|
|
500bd87c85 | ||
|
|
e9620c8c05 | ||
|
|
70e51bb352 | ||
|
|
278cd123c8 | ||
|
|
3febb1a5d0 | ||
|
|
d8054d8def | ||
|
|
ec271db7a0 | ||
|
|
bbac994c8a | ||
|
|
c1d9e6a00b | ||
|
|
0aeb49a6b0 | ||
|
|
fe262766b4 | ||
|
|
7181505c8a | ||
|
|
f060a226bc | ||
|
|
93d524b797 | ||
|
|
5c169f4f49 | ||
|
|
d29dfa12e3 | ||
|
|
194f55e08e | ||
|
|
c0f9892fe3 | ||
|
|
227104d7d7 | ||
|
|
448029aa4b | ||
|
|
17e0afeac0 | ||
|
|
18916b5189 | ||
|
|
c11a09be23 | ||
|
|
56e1ecf2f3 | ||
|
|
f9e6013a6c | ||
|
|
b5d1d8b0d1 | ||
|
|
09e6d94f9e | ||
|
|
2a5717d7fb | ||
|
|
85cf662c6f | ||
|
|
3279a7ef0f | ||
|
|
fec908a19b | ||
|
|
f5ed0cda58 | ||
|
|
cc9d16f505 | ||
|
|
c05d74b44c | ||
|
|
32c88b6352 | ||
|
|
7dabec260f | ||
|
|
4feb88f9b5 | ||
|
|
2776caed0e | ||
|
|
c55694d957 | ||
|
|
209ffb934b | ||
|
|
26a33932cd | ||
|
|
d6a692971f | ||
|
|
4624390e54 | ||
|
|
63b7d292c1 | ||
|
|
365c569d7c | ||
|
|
68a81fea8a | ||
|
|
08a8bd7ef7 | ||
|
|
b939ce75ba | ||
|
|
3b7ca86e4f | ||
|
|
60760b52ab | ||
|
|
96c128c58a | ||
|
|
0c35f39a7d | ||
|
|
6a66dde0a1 | ||
|
|
36b9fcba44 | ||
|
|
bf99dda620 | ||
|
|
511dfcb409 | ||
|
|
900bc96420 | ||
|
|
be277a7376 | ||
|
|
f15a4f9188 | ||
|
|
e31128650e | ||
|
|
168740b64d | ||
|
|
cc4c4928e0 | ||
|
|
fba6543b23 | ||
|
|
877eb6ac56 | ||
|
|
259a5a13e7 | ||
|
|
cf7c7cb392 | ||
|
|
86d01e2e99 | ||
|
|
7a28e19a27 | ||
|
|
900ea63d68 | ||
|
|
87ab86cdd0 | ||
|
|
0697494ffd | ||
|
|
ffd69a2f5e | ||
|
|
66f10bb5e6 | ||
|
|
8131a0e777 | ||
|
|
32a557dff6 | ||
|
|
db949e40f1 | ||
|
|
e0454138e0 | ||
|
|
3b07ed1b97 | ||
|
|
daa98f5a27 | ||
|
|
842656aa90 | ||
|
|
aa29036cb3 | ||
|
|
607bae27fa | ||
|
|
7c63676be4 | ||
|
|
9e113909b3 | ||
|
|
bd105474ca | ||
|
|
a078f5d764 | ||
|
|
b215fa3ee6 | ||
|
|
50b1928502 | ||
|
|
493e3bcf4b | ||
|
|
6deb80625d | ||
|
|
6ab051568c | ||
|
|
2732d3cdae | ||
|
|
e8c307e4dc | ||
|
|
84ddc660c4 | ||
|
|
e60e707955 | ||
|
|
cf4321b2d0 | ||
|
|
1993faf2f8 | ||
|
|
0ce85376bf | ||
|
|
a40254156f | ||
|
|
05cc62f5ff | ||
|
|
9c2c90e533 | ||
|
|
822ee2e1c5 | ||
|
|
77482c8946 | ||
|
|
7ef0ab3119 | ||
|
|
8bd89a297a | ||
|
|
bb75cc796e | ||
|
|
0fdd8f54eb | ||
|
|
b1ffc464cd | ||
|
|
50174960e4 | ||
|
|
8f46eab977 | ||
|
|
ec299085f5 | ||
|
|
7727d70634 | ||
|
|
5f9d101bc6 | ||
|
|
6c2abe7474 | ||
|
|
14a902c1a7 | ||
|
|
5ad6a6d229 | ||
|
|
6f4b97864a | ||
|
|
0e0abc3a95 | ||
|
|
696fda1db4 | ||
|
|
c1d2634427 | ||
|
|
4b7a680ac5 | ||
|
|
b3e7d2901f | ||
|
|
cdf7ec213c | ||
|
|
f1102fb262 | ||
|
|
09d1fad6e0 | ||
|
|
379c65a3ef | ||
|
|
fdc7f64d6f | ||
|
|
df0f8ed59e | ||
|
|
c903966fc7 | ||
|
|
e57fa8ff53 | ||
|
|
bf2feee5b7 | ||
|
|
ce05c429fc | ||
|
|
272a3f347d | ||
|
|
13db7a1931 | ||
|
|
468c237189 | ||
|
|
b9b80c068b | ||
|
|
9b592b3dee | ||
|
|
2203809e5e | ||
|
|
8d6d37f71e | ||
|
|
ea4f2af67f | ||
|
|
53af194ef9 | ||
|
|
5e0e2d2b14 | ||
|
|
74c99184c5 | ||
|
|
eb4b86137a | ||
|
|
9c4f4f3b4e | ||
|
|
240132e7c7 | ||
|
|
9d67fc4cfb | ||
|
|
892f93a716 | ||
|
|
ba6a7c9dc8 | ||
|
|
a91c3907a8 | ||
|
|
e267d94ee1 | ||
|
|
89ce5e492b | ||
|
|
290de6aa96 | ||
|
|
a7aeb8ac0e | ||
|
|
a8e7fafebf | ||
|
|
7cc64070b1 | ||
|
|
c19d2637ea | ||
|
|
fe1da14332 | ||
|
|
8e9110cedf | ||
|
|
d6ff30a570 | ||
|
|
b98d46bfd6 | ||
|
|
768936b256 | ||
|
|
c6eb1a9670 | ||
|
|
e4ab518576 | ||
|
|
dfc67b5fac | ||
|
|
62266d8f91 | ||
|
|
b8ea16a88e | ||
|
|
23deaf50e6 | ||
|
|
38a36ed8d3 | ||
|
|
49bab23c54 | ||
|
|
78ba00d3a7 | ||
|
|
787b046a70 | ||
|
|
f827a7b985 | ||
|
|
f5f2097d14 | ||
|
|
cfcfb87fd4 | ||
|
|
1d223fc114 | ||
|
|
c0647f0719 | ||
|
|
8745ed9c61 | ||
|
|
836726e710 | ||
|
|
a67c118dcf | ||
|
|
cd289465fd | ||
|
|
263e426ae1 | ||
|
|
d5e493383a | ||
|
|
6f1d27354a | ||
|
|
26101732d2 | ||
|
|
71d40e0c08 | ||
|
|
4ba2ff7cdd | ||
|
|
2cdf5e7395 | ||
|
|
8315a55b3f | ||
|
|
d1c2a31af7 | ||
|
|
3e6c217408 | ||
|
|
b299f350be | ||
|
|
8fd16c17dc | ||
|
|
5979b2aa0f | ||
|
|
0b17e0e5d9 | ||
|
|
3d8ad5e4f6 | ||
|
|
ff1752dd39 | ||
|
|
1becaeb7be | ||
|
|
171afaadb9 | ||
|
|
776e6e647d | ||
|
|
4ccdf4ec72 | ||
|
|
a7bd993c0c | ||
|
|
a290ff4486 | ||
|
|
490ef13822 | ||
|
|
1b14de2ff9 | ||
|
|
914692cc82 | ||
|
|
07191dc430 | ||
|
|
af3fb2b04d | ||
|
|
0240fa131a | ||
|
|
e96577dd38 | ||
|
|
403dd7367a | ||
|
|
8086ad120b | ||
|
|
87a445689c | ||
|
|
b6bda54870 | ||
|
|
9d528dddd6 | ||
|
|
543d590710 | ||
|
|
f1d70eb6b2 | ||
|
|
d828c3f37e | ||
|
|
038491b7bc | ||
|
|
cf683411ee | ||
|
|
de5ed6a677 | ||
|
|
3dda557410 | ||
|
|
c800f6f723 | ||
|
|
0395ba1816 | ||
|
|
86f9f63b46 | ||
|
|
a7a6753118 | ||
|
|
2e80d12d6a | ||
|
|
417a96cbf2 | ||
|
|
2d4c29ea7c | ||
|
|
67db40ed4f | ||
|
|
11c485a5ed | ||
|
|
b0573af9a9 | ||
|
|
09eb53f308 | ||
|
|
11f85d1b80 | ||
|
|
0cb86c6990 | ||
|
|
57d2f22c24 | ||
|
|
fa0c364982 | ||
|
|
a6c8113419 | ||
|
|
4f5c30e083 | ||
|
|
9d0b51fa26 | ||
|
|
ba5f8045a2 | ||
|
|
3a510a9138 | ||
|
|
d3bfa16813 | ||
|
|
28409791fa | ||
|
|
c1abe87953 | ||
|
|
f8367856e8 | ||
|
|
a72b0a689b | ||
|
|
69a4d213a3 | ||
|
|
c28e01fed3 | ||
|
|
e8efcef108 | ||
|
|
d011316997 | ||
|
|
4d22b0c497 | ||
|
|
539215d7df | ||
|
|
3ede597a15 | ||
|
|
01786c5e63 | ||
|
|
6aba5f74fc | ||
|
|
3c894a3fb7 | ||
|
|
1ece3a498f | ||
|
|
b76c7ae55d | ||
|
|
91b10bd3b9 | ||
|
|
7e3fe77e7b | ||
|
|
ba43214dae | ||
|
|
ebc90720ea | ||
|
|
785d100be9 | ||
|
|
f13e6f1149 | ||
|
|
8be0f77d96 | ||
|
|
429f85a9de | ||
|
|
b4d1c6da2c | ||
|
|
3c1cfd4c1e | ||
|
|
a71a210704 | ||
|
|
769d06c8ab | ||
|
|
cd1f8da13f | ||
|
|
8230474667 | ||
|
|
27f553bf84 | ||
|
|
d48bff8c8b | ||
|
|
59b9687f31 | ||
|
|
c1a8ccda11 | ||
|
|
9df6786b09 | ||
|
|
bef5bd4e4f | ||
|
|
68acfb1891 | ||
|
|
9fd3f752d1 | ||
|
|
9c48e9ceab | ||
|
|
bd26783b33 | ||
|
|
eda8230521 | ||
|
|
462ddbb145 | ||
|
|
496a2f341e | ||
|
|
7109d6d635 | ||
|
|
ca72241fa3 | ||
|
|
a6bdffd225 | ||
|
|
5636bf4955 | ||
|
|
a944a7fd7e | ||
|
|
a40fa405e4 | ||
|
|
eab77e21dd | ||
|
|
d41163f5c1 | ||
|
|
265b1f2459 | ||
|
|
c92ea59228 | ||
|
|
afddfea093 | ||
|
|
fa4dc151ca | ||
|
|
44202acb18 | ||
|
|
cf00786209 |
13
.github/FUNDING.yml
vendored
Normal file
13
.github/FUNDING.yml
vendored
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
# These are supported funding model platforms
|
||||||
|
|
||||||
|
github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
|
||||||
|
patreon: # Replace with a single Patreon username
|
||||||
|
open_collective: # Replace with a single Open Collective username
|
||||||
|
ko_fi: # Replace with a single Ko-fi username
|
||||||
|
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
|
||||||
|
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
|
||||||
|
liberapay: # Replace with a single Liberapay username
|
||||||
|
issuehunt: # Replace with a single IssueHunt username
|
||||||
|
otechie: # Replace with a single Otechie username
|
||||||
|
custom: # https://gitee.com/kevwan/static/raw/master/images/sponsor.jpg
|
||||||
|
ethereum: 0x5052b7f6B937B02563996D23feb69b38D06Ca150 | kevwan
|
||||||
60
.github/workflows/go.yml
vendored
60
.github/workflows/go.yml
vendored
@@ -7,32 +7,50 @@ on:
|
|||||||
branches: [ master ]
|
branches: [ master ]
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
test-linux:
|
||||||
name: Build
|
name: Linux
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
|
- name: Set up Go 1.x
|
||||||
|
uses: actions/setup-go@v2
|
||||||
|
with:
|
||||||
|
go-version: ^1.15
|
||||||
|
id: go
|
||||||
|
|
||||||
- name: Set up Go 1.x
|
- name: Check out code into the Go module directory
|
||||||
uses: actions/setup-go@v2
|
uses: actions/checkout@v2
|
||||||
with:
|
|
||||||
go-version: ^1.14
|
|
||||||
id: go
|
|
||||||
|
|
||||||
- name: Check out code into the Go module directory
|
- name: Get dependencies
|
||||||
uses: actions/checkout@v2
|
run: |
|
||||||
|
go get -v -t -d ./...
|
||||||
|
|
||||||
- name: Get dependencies
|
- name: Lint
|
||||||
run: |
|
run: |
|
||||||
go get -v -t -d ./...
|
go vet -stdmethods=false $(go list ./...)
|
||||||
|
go install mvdan.cc/gofumpt@latest
|
||||||
|
test -z "$(gofumpt -l -extra .)" || echo "Please run 'gofumpt -l -w -extra .'"
|
||||||
|
|
||||||
- name: Lint
|
- name: Test
|
||||||
run: |
|
run: go test -race -coverprofile=coverage.txt -covermode=atomic ./...
|
||||||
go vet -stdmethods=false $(go list ./...)
|
|
||||||
go install mvdan.cc/gofumpt@latest
|
|
||||||
test -z "$(gofumpt -s -l -extra .)" || echo "Please run 'gofumpt -l -w -extra .'"
|
|
||||||
|
|
||||||
- name: Test
|
- name: Codecov
|
||||||
run: go test -race -coverprofile=coverage.txt -covermode=atomic ./...
|
uses: codecov/codecov-action@v2
|
||||||
|
|
||||||
- name: Codecov
|
test-win:
|
||||||
uses: codecov/codecov-action@v2
|
name: Windows
|
||||||
|
runs-on: windows-latest
|
||||||
|
steps:
|
||||||
|
- name: Set up Go 1.x
|
||||||
|
uses: actions/setup-go@v2
|
||||||
|
with:
|
||||||
|
go-version: ^1.15
|
||||||
|
|
||||||
|
- name: Checkout codebase
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- name: Test
|
||||||
|
run: |
|
||||||
|
go mod verify
|
||||||
|
go mod download
|
||||||
|
go test -v -race ./...
|
||||||
|
cd tools/goctl && go build -v goctl.go
|
||||||
|
|||||||
18
.github/workflows/issue-translator.yml
vendored
Normal file
18
.github/workflows/issue-translator.yml
vendored
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
name: 'issue-translator'
|
||||||
|
on:
|
||||||
|
issue_comment:
|
||||||
|
types: [created]
|
||||||
|
issues:
|
||||||
|
types: [opened]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: tomsun28/issues-translate-action@v2.6
|
||||||
|
with:
|
||||||
|
IS_MODIFY_TITLE: true
|
||||||
|
# not require, default false, . Decide whether to modify the issue title
|
||||||
|
# if true, the robot account @Issues-translate-bot must have modification permissions, invite @Issues-translate-bot to your project or use your custom bot.
|
||||||
|
CUSTOM_BOT_NOTE: Bot detected the issue body's language is not English, translate it automatically. 👯👭🏻🧑🤝🧑👫🧑🏿🤝🧑🏻👩🏾🤝👨🏿👬🏿
|
||||||
|
# not require. Customize the translation robot prefix message.
|
||||||
28
.github/workflows/release.yaml
vendored
Normal file
28
.github/workflows/release.yaml
vendored
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- "tools/goctl/*"
|
||||||
|
jobs:
|
||||||
|
releases-matrix:
|
||||||
|
name: Release goctl binary
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
# build and publish in parallel: linux/386, linux/amd64, linux/arm64,
|
||||||
|
# windows/386, windows/amd64, windows/arm64, darwin/amd64, darwin/arm64
|
||||||
|
goos: [ linux, windows, darwin ]
|
||||||
|
goarch: [ "386", amd64, arm64 ]
|
||||||
|
exclude:
|
||||||
|
- goarch: "386"
|
||||||
|
goos: darwin
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
- uses: zeromicro/go-zero-release-action@master
|
||||||
|
with:
|
||||||
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
goos: ${{ matrix.goos }}
|
||||||
|
goarch: ${{ matrix.goarch }}
|
||||||
|
goversion: "https://dl.google.com/go/go1.17.5.linux-amd64.tar.gz"
|
||||||
|
project_path: "tools/goctl"
|
||||||
|
binary_name: "goctl"
|
||||||
|
extra_files: tools/goctl/goctl.md
|
||||||
5
.gitignore
vendored
5
.gitignore
vendored
@@ -15,6 +15,11 @@
|
|||||||
**/.DS_Store
|
**/.DS_Store
|
||||||
**/logs
|
**/logs
|
||||||
|
|
||||||
|
# for test purpose
|
||||||
|
**/adhoc
|
||||||
|
go.work
|
||||||
|
go.work.sum
|
||||||
|
|
||||||
# gitlab ci
|
# gitlab ci
|
||||||
.cache
|
.cache
|
||||||
|
|
||||||
|
|||||||
@@ -40,7 +40,7 @@ We will help you to contribute in different areas like filing issues, developing
|
|||||||
getting your work reviewed and merged.
|
getting your work reviewed and merged.
|
||||||
|
|
||||||
If you have questions about the development process,
|
If you have questions about the development process,
|
||||||
feel free to [file an issue](https://github.com/tal-tech/go-zero/issues/new/choose).
|
feel free to [file an issue](https://github.com/zeromicro/go-zero/issues/new/choose).
|
||||||
|
|
||||||
## Find something to work on
|
## Find something to work on
|
||||||
|
|
||||||
@@ -50,10 +50,10 @@ Here is how you get started.
|
|||||||
|
|
||||||
### Find a good first topic
|
### Find a good first topic
|
||||||
|
|
||||||
[go-zero](https://github.com/tal-tech/go-zero) has beginner-friendly issues that provide a good first issue.
|
[go-zero](https://github.com/zeromicro/go-zero) has beginner-friendly issues that provide a good first issue.
|
||||||
For example, [go-zero](https://github.com/tal-tech/go-zero) has
|
For example, [go-zero](https://github.com/zeromicro/go-zero) has
|
||||||
[help wanted](https://github.com/tal-tech/go-zero/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) and
|
[help wanted](https://github.com/zeromicro/go-zero/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) and
|
||||||
[good first issue](https://github.com/tal-tech/go-zero/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
|
[good first issue](https://github.com/zeromicro/go-zero/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
|
||||||
labels for issues that should not need deep knowledge of the system.
|
labels for issues that should not need deep knowledge of the system.
|
||||||
We can help new contributors who wish to work on such issues.
|
We can help new contributors who wish to work on such issues.
|
||||||
|
|
||||||
@@ -79,7 +79,7 @@ This is a rough outline of what a contributor's workflow looks like:
|
|||||||
- Create a topic branch from where to base the contribution. This is usually master.
|
- Create a topic branch from where to base the contribution. This is usually master.
|
||||||
- Make commits of logical units.
|
- Make commits of logical units.
|
||||||
- Push changes in a topic branch to a personal fork of the repository.
|
- Push changes in a topic branch to a personal fork of the repository.
|
||||||
- Submit a pull request to [go-zero](https://github.com/tal-tech/go-zero).
|
- Submit a pull request to [go-zero](https://github.com/zeromicro/go-zero).
|
||||||
|
|
||||||
## Creating Pull Requests
|
## Creating Pull Requests
|
||||||
|
|
||||||
|
|||||||
2
LICENSE
2
LICENSE
@@ -1,6 +1,6 @@
|
|||||||
MIT License
|
MIT License
|
||||||
|
|
||||||
Copyright (c) 2020 xiaoheiban_server_go
|
Copyright (c) 2022 zeromicro
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
|||||||
20
ROADMAP.md
20
ROADMAP.md
@@ -10,13 +10,19 @@ We hope that the items listed below will inspire further engagement from the com
|
|||||||
|
|
||||||
## 2021 Q3
|
## 2021 Q3
|
||||||
- [x] Support `goctl model pg` to support PostgreSQL code generation
|
- [x] Support `goctl model pg` to support PostgreSQL code generation
|
||||||
- [ ] Support `goctl mock` command to start a mocking server with given `.api` file
|
- [x] Adapt builtin tracing mechanism to opentracing solutions
|
||||||
- [ ] Adapt builtin tracing mechanism to opentracing solutions
|
|
||||||
|
|
||||||
## 2021 Q4
|
## 2021 Q4
|
||||||
- [ ] Add `httpx.Client` with governance, like circuit breaker etc.
|
- [x] Support `username/password` authentication in ETCD
|
||||||
|
- [x] Support `SSL/TLS` in ETCD
|
||||||
|
- [x] Support `SSL/TLS` in `zRPC`
|
||||||
|
- [x] Support `TLS` in redis connections
|
||||||
|
- [x] Support `goctl bug` to report bugs conveniently
|
||||||
|
|
||||||
|
## 2022
|
||||||
|
- [x] Support `context` in redis related methods for timeout and tracing
|
||||||
|
- [x] Support `context` in sql related methods for timeout and tracing
|
||||||
|
- [x] Support `context` in mongodb related methods for timeout and tracing
|
||||||
|
- [x] Add `httpc.Do` with HTTP call governance, like circuit breaker etc.
|
||||||
- [ ] Support `goctl doctor` command to report potential issues for given service
|
- [ ] Support `goctl doctor` command to report potential issues for given service
|
||||||
- [ ] Support `context` in redis related methods for timeout and tracing
|
- [ ] Support `goctl mock` command to start a mocking server with given `.api` file
|
||||||
- [ ] Support `context` in sql related methods for timeout and tracing
|
|
||||||
- [ ] Support `context` in mongodb related methods for timeout and tracing
|
|
||||||
- [ ] Support TLS in redis connections
|
|
||||||
|
|||||||
@@ -4,8 +4,8 @@ import (
|
|||||||
"errors"
|
"errors"
|
||||||
"strconv"
|
"strconv"
|
||||||
|
|
||||||
"github.com/tal-tech/go-zero/core/hash"
|
"github.com/zeromicro/go-zero/core/hash"
|
||||||
"github.com/tal-tech/go-zero/core/stores/redis"
|
"github.com/zeromicro/go-zero/core/stores/redis"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
@@ -69,11 +69,8 @@ func (f *Filter) Exists(data []byte) (bool, error) {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return false, err
|
return false, err
|
||||||
}
|
}
|
||||||
if !isSet {
|
|
||||||
return false, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
return true, nil
|
return isSet, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (f *Filter) getLocations(data []byte) []uint {
|
func (f *Filter) getLocations(data []byte) []uint {
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/tal-tech/go-zero/core/stores/redis/redistest"
|
"github.com/zeromicro/go-zero/core/stores/redis/redistest"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestRedisBitSet_New_Set_Test(t *testing.T) {
|
func TestRedisBitSet_New_Set_Test(t *testing.T) {
|
||||||
|
|||||||
@@ -5,12 +5,12 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"strings"
|
"strings"
|
||||||
"sync"
|
"sync"
|
||||||
|
"time"
|
||||||
|
|
||||||
"github.com/tal-tech/go-zero/core/mathx"
|
"github.com/zeromicro/go-zero/core/mathx"
|
||||||
"github.com/tal-tech/go-zero/core/proc"
|
"github.com/zeromicro/go-zero/core/proc"
|
||||||
"github.com/tal-tech/go-zero/core/stat"
|
"github.com/zeromicro/go-zero/core/stat"
|
||||||
"github.com/tal-tech/go-zero/core/stringx"
|
"github.com/zeromicro/go-zero/core/stringx"
|
||||||
"github.com/tal-tech/go-zero/core/timex"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
@@ -171,7 +171,7 @@ func (lt loggedThrottle) allow() (Promise, error) {
|
|||||||
func (lt loggedThrottle) doReq(req func() error, fallback func(err error) error, acceptable Acceptable) error {
|
func (lt loggedThrottle) doReq(req func() error, fallback func(err error) error, acceptable Acceptable) error {
|
||||||
return lt.logError(lt.internalThrottle.doReq(req, fallback, func(err error) bool {
|
return lt.logError(lt.internalThrottle.doReq(req, fallback, func(err error) bool {
|
||||||
accept := acceptable(err)
|
accept := acceptable(err)
|
||||||
if !accept {
|
if !accept && err != nil {
|
||||||
lt.errWin.add(err.Error())
|
lt.errWin.add(err.Error())
|
||||||
}
|
}
|
||||||
return accept
|
return accept
|
||||||
@@ -198,7 +198,7 @@ type errorWindow struct {
|
|||||||
|
|
||||||
func (ew *errorWindow) add(reason string) {
|
func (ew *errorWindow) add(reason string) {
|
||||||
ew.lock.Lock()
|
ew.lock.Lock()
|
||||||
ew.reasons[ew.index] = fmt.Sprintf("%s %s", timex.Time().Format(timeFormat), reason)
|
ew.reasons[ew.index] = fmt.Sprintf("%s %s", time.Now().Format(timeFormat), reason)
|
||||||
ew.index = (ew.index + 1) % numHistoryReasons
|
ew.index = (ew.index + 1) % numHistoryReasons
|
||||||
ew.count = mathx.MinInt(ew.count+1, numHistoryReasons)
|
ew.count = mathx.MinInt(ew.count+1, numHistoryReasons)
|
||||||
ew.lock.Unlock()
|
ew.lock.Unlock()
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/tal-tech/go-zero/core/stat"
|
"github.com/zeromicro/go-zero/core/stat"
|
||||||
)
|
)
|
||||||
|
|
||||||
func init() {
|
func init() {
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/tal-tech/go-zero/core/stat"
|
"github.com/zeromicro/go-zero/core/stat"
|
||||||
)
|
)
|
||||||
|
|
||||||
func init() {
|
func init() {
|
||||||
|
|||||||
@@ -4,8 +4,8 @@ import (
|
|||||||
"math"
|
"math"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/tal-tech/go-zero/core/collection"
|
"github.com/zeromicro/go-zero/core/collection"
|
||||||
"github.com/tal-tech/go-zero/core/mathx"
|
"github.com/zeromicro/go-zero/core/mathx"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
|
|||||||
@@ -7,9 +7,9 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/tal-tech/go-zero/core/collection"
|
"github.com/zeromicro/go-zero/core/collection"
|
||||||
"github.com/tal-tech/go-zero/core/mathx"
|
"github.com/zeromicro/go-zero/core/mathx"
|
||||||
"github.com/tal-tech/go-zero/core/stat"
|
"github.com/zeromicro/go-zero/core/stat"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
|
|||||||
@@ -8,8 +8,8 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/tal-tech/go-zero/core/iox"
|
"github.com/zeromicro/go-zero/core/iox"
|
||||||
"github.com/tal-tech/go-zero/core/lang"
|
"github.com/zeromicro/go-zero/core/lang"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestEnterToContinue(t *testing.T) {
|
func TestEnterToContinue(t *testing.T) {
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import (
|
|||||||
"encoding/base64"
|
"encoding/base64"
|
||||||
"errors"
|
"errors"
|
||||||
|
|
||||||
"github.com/tal-tech/go-zero/core/logx"
|
"github.com/zeromicro/go-zero/core/logx"
|
||||||
)
|
)
|
||||||
|
|
||||||
// ErrPaddingSize indicates bad padding size.
|
// ErrPaddingSize indicates bad padding size.
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/tal-tech/go-zero/core/fs"
|
"github.com/zeromicro/go-zero/core/fs"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
|
|||||||
@@ -6,9 +6,9 @@ import (
|
|||||||
"sync/atomic"
|
"sync/atomic"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/tal-tech/go-zero/core/logx"
|
"github.com/zeromicro/go-zero/core/logx"
|
||||||
"github.com/tal-tech/go-zero/core/mathx"
|
"github.com/zeromicro/go-zero/core/mathx"
|
||||||
"github.com/tal-tech/go-zero/core/syncx"
|
"github.com/zeromicro/go-zero/core/syncx"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
@@ -98,13 +98,18 @@ func (c *Cache) Get(key string) (interface{}, bool) {
|
|||||||
|
|
||||||
// Set sets value into c with key.
|
// Set sets value into c with key.
|
||||||
func (c *Cache) Set(key string, value interface{}) {
|
func (c *Cache) Set(key string, value interface{}) {
|
||||||
|
c.SetWithExpire(key, value, c.expire)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetWithExpire sets value into c with key and expire with the given value.
|
||||||
|
func (c *Cache) SetWithExpire(key string, value interface{}, expire time.Duration) {
|
||||||
c.lock.Lock()
|
c.lock.Lock()
|
||||||
_, ok := c.data[key]
|
_, ok := c.data[key]
|
||||||
c.data[key] = value
|
c.data[key] = value
|
||||||
c.lruCache.add(key)
|
c.lruCache.add(key)
|
||||||
c.lock.Unlock()
|
c.lock.Unlock()
|
||||||
|
|
||||||
expiry := c.unstableExpiry.AroundDuration(c.expire)
|
expiry := c.unstableExpiry.AroundDuration(expire)
|
||||||
if ok {
|
if ok {
|
||||||
c.timingWheel.MoveTimer(key, expiry)
|
c.timingWheel.MoveTimer(key, expiry)
|
||||||
} else {
|
} else {
|
||||||
|
|||||||
@@ -18,7 +18,7 @@ func TestCacheSet(t *testing.T) {
|
|||||||
assert.Nil(t, err)
|
assert.Nil(t, err)
|
||||||
|
|
||||||
cache.Set("first", "first element")
|
cache.Set("first", "first element")
|
||||||
cache.Set("second", "second element")
|
cache.SetWithExpire("second", "second element", time.Second*3)
|
||||||
|
|
||||||
value, ok := cache.Get("first")
|
value, ok := cache.Get("first")
|
||||||
assert.True(t, ok)
|
assert.True(t, ok)
|
||||||
|
|||||||
@@ -61,3 +61,41 @@ func TestPutMore(t *testing.T) {
|
|||||||
assert.Equal(t, string(element), string(body.([]byte)))
|
assert.Equal(t, string(element), string(body.([]byte)))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestPutMoreWithHeaderNotZero(t *testing.T) {
|
||||||
|
elements := [][]byte{
|
||||||
|
[]byte("hello"),
|
||||||
|
[]byte("world"),
|
||||||
|
[]byte("again"),
|
||||||
|
}
|
||||||
|
queue := NewQueue(4)
|
||||||
|
for i := range elements {
|
||||||
|
queue.Put(elements[i])
|
||||||
|
}
|
||||||
|
|
||||||
|
// take 1
|
||||||
|
body, ok := queue.Take()
|
||||||
|
assert.True(t, ok)
|
||||||
|
element, ok := body.([]byte)
|
||||||
|
assert.True(t, ok)
|
||||||
|
assert.Equal(t, element, []byte("hello"))
|
||||||
|
|
||||||
|
// put more
|
||||||
|
queue.Put([]byte("b4"))
|
||||||
|
queue.Put([]byte("b5")) // will store in elements[0]
|
||||||
|
queue.Put([]byte("b6")) // cause expansion
|
||||||
|
|
||||||
|
results := [][]byte{
|
||||||
|
[]byte("world"),
|
||||||
|
[]byte("again"),
|
||||||
|
[]byte("b4"),
|
||||||
|
[]byte("b5"),
|
||||||
|
[]byte("b6"),
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, element := range results {
|
||||||
|
body, ok := queue.Take()
|
||||||
|
assert.True(t, ok)
|
||||||
|
assert.Equal(t, string(element), string(body.([]byte)))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ import (
|
|||||||
"sync"
|
"sync"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/tal-tech/go-zero/core/timex"
|
"github.com/zeromicro/go-zero/core/timex"
|
||||||
)
|
)
|
||||||
|
|
||||||
type (
|
type (
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/tal-tech/go-zero/core/stringx"
|
"github.com/zeromicro/go-zero/core/stringx"
|
||||||
)
|
)
|
||||||
|
|
||||||
const duration = time.Millisecond * 50
|
const duration = time.Millisecond * 50
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/tal-tech/go-zero/core/stringx"
|
"github.com/zeromicro/go-zero/core/stringx"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestSafeMap(t *testing.T) {
|
func TestSafeMap(t *testing.T) {
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
package collection
|
package collection
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"github.com/tal-tech/go-zero/core/lang"
|
"github.com/zeromicro/go-zero/core/lang"
|
||||||
"github.com/tal-tech/go-zero/core/logx"
|
"github.com/zeromicro/go-zero/core/logx"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/tal-tech/go-zero/core/logx"
|
"github.com/zeromicro/go-zero/core/logx"
|
||||||
)
|
)
|
||||||
|
|
||||||
func init() {
|
func init() {
|
||||||
|
|||||||
@@ -2,16 +2,22 @@ package collection
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"container/list"
|
"container/list"
|
||||||
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/tal-tech/go-zero/core/lang"
|
"github.com/zeromicro/go-zero/core/lang"
|
||||||
"github.com/tal-tech/go-zero/core/threading"
|
"github.com/zeromicro/go-zero/core/threading"
|
||||||
"github.com/tal-tech/go-zero/core/timex"
|
"github.com/zeromicro/go-zero/core/timex"
|
||||||
)
|
)
|
||||||
|
|
||||||
const drainWorkers = 8
|
const drainWorkers = 8
|
||||||
|
|
||||||
|
var (
|
||||||
|
ErrClosed = errors.New("TimingWheel is closed already")
|
||||||
|
ErrArgument = errors.New("incorrect task argument")
|
||||||
|
)
|
||||||
|
|
||||||
type (
|
type (
|
||||||
// Execute defines the method to execute the task.
|
// Execute defines the method to execute the task.
|
||||||
Execute func(key, value interface{})
|
Execute func(key, value interface{})
|
||||||
@@ -59,14 +65,15 @@ type (
|
|||||||
// NewTimingWheel returns a TimingWheel.
|
// NewTimingWheel returns a TimingWheel.
|
||||||
func NewTimingWheel(interval time.Duration, numSlots int, execute Execute) (*TimingWheel, error) {
|
func NewTimingWheel(interval time.Duration, numSlots int, execute Execute) (*TimingWheel, error) {
|
||||||
if interval <= 0 || numSlots <= 0 || execute == nil {
|
if interval <= 0 || numSlots <= 0 || execute == nil {
|
||||||
return nil, fmt.Errorf("interval: %v, slots: %d, execute: %p", interval, numSlots, execute)
|
return nil, fmt.Errorf("interval: %v, slots: %d, execute: %p",
|
||||||
|
interval, numSlots, execute)
|
||||||
}
|
}
|
||||||
|
|
||||||
return newTimingWheelWithClock(interval, numSlots, execute, timex.NewTicker(interval))
|
return newTimingWheelWithClock(interval, numSlots, execute, timex.NewTicker(interval))
|
||||||
}
|
}
|
||||||
|
|
||||||
func newTimingWheelWithClock(interval time.Duration, numSlots int, execute Execute, ticker timex.Ticker) (
|
func newTimingWheelWithClock(interval time.Duration, numSlots int, execute Execute,
|
||||||
*TimingWheel, error) {
|
ticker timex.Ticker) (*TimingWheel, error) {
|
||||||
tw := &TimingWheel{
|
tw := &TimingWheel{
|
||||||
interval: interval,
|
interval: interval,
|
||||||
ticker: ticker,
|
ticker: ticker,
|
||||||
@@ -89,47 +96,67 @@ func newTimingWheelWithClock(interval time.Duration, numSlots int, execute Execu
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Drain drains all items and executes them.
|
// Drain drains all items and executes them.
|
||||||
func (tw *TimingWheel) Drain(fn func(key, value interface{})) {
|
func (tw *TimingWheel) Drain(fn func(key, value interface{})) error {
|
||||||
tw.drainChannel <- fn
|
select {
|
||||||
|
case tw.drainChannel <- fn:
|
||||||
|
return nil
|
||||||
|
case <-tw.stopChannel:
|
||||||
|
return ErrClosed
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// MoveTimer moves the task with the given key to the given delay.
|
// MoveTimer moves the task with the given key to the given delay.
|
||||||
func (tw *TimingWheel) MoveTimer(key interface{}, delay time.Duration) {
|
func (tw *TimingWheel) MoveTimer(key interface{}, delay time.Duration) error {
|
||||||
if delay <= 0 || key == nil {
|
if delay <= 0 || key == nil {
|
||||||
return
|
return ErrArgument
|
||||||
}
|
}
|
||||||
|
|
||||||
tw.moveChannel <- baseEntry{
|
select {
|
||||||
|
case tw.moveChannel <- baseEntry{
|
||||||
delay: delay,
|
delay: delay,
|
||||||
key: key,
|
key: key,
|
||||||
|
}:
|
||||||
|
return nil
|
||||||
|
case <-tw.stopChannel:
|
||||||
|
return ErrClosed
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// RemoveTimer removes the task with the given key.
|
// RemoveTimer removes the task with the given key.
|
||||||
func (tw *TimingWheel) RemoveTimer(key interface{}) {
|
func (tw *TimingWheel) RemoveTimer(key interface{}) error {
|
||||||
if key == nil {
|
if key == nil {
|
||||||
return
|
return ErrArgument
|
||||||
}
|
}
|
||||||
|
|
||||||
tw.removeChannel <- key
|
select {
|
||||||
|
case tw.removeChannel <- key:
|
||||||
|
return nil
|
||||||
|
case <-tw.stopChannel:
|
||||||
|
return ErrClosed
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// SetTimer sets the task value with the given key to the delay.
|
// SetTimer sets the task value with the given key to the delay.
|
||||||
func (tw *TimingWheel) SetTimer(key, value interface{}, delay time.Duration) {
|
func (tw *TimingWheel) SetTimer(key, value interface{}, delay time.Duration) error {
|
||||||
if delay <= 0 || key == nil {
|
if delay <= 0 || key == nil {
|
||||||
return
|
return ErrArgument
|
||||||
}
|
}
|
||||||
|
|
||||||
tw.setChannel <- timingEntry{
|
select {
|
||||||
|
case tw.setChannel <- timingEntry{
|
||||||
baseEntry: baseEntry{
|
baseEntry: baseEntry{
|
||||||
delay: delay,
|
delay: delay,
|
||||||
key: key,
|
key: key,
|
||||||
},
|
},
|
||||||
value: value,
|
value: value,
|
||||||
|
}:
|
||||||
|
return nil
|
||||||
|
case <-tw.stopChannel:
|
||||||
|
return ErrClosed
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Stop stops tw.
|
// Stop stops tw. No more actions after stopping a TimingWheel.
|
||||||
func (tw *TimingWheel) Stop() {
|
func (tw *TimingWheel) Stop() {
|
||||||
close(tw.stopChannel)
|
close(tw.stopChannel)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -8,10 +8,10 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/tal-tech/go-zero/core/lang"
|
"github.com/zeromicro/go-zero/core/lang"
|
||||||
"github.com/tal-tech/go-zero/core/stringx"
|
"github.com/zeromicro/go-zero/core/stringx"
|
||||||
"github.com/tal-tech/go-zero/core/syncx"
|
"github.com/zeromicro/go-zero/core/syncx"
|
||||||
"github.com/tal-tech/go-zero/core/timex"
|
"github.com/zeromicro/go-zero/core/timex"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
@@ -28,7 +28,6 @@ func TestTimingWheel_Drain(t *testing.T) {
|
|||||||
ticker := timex.NewFakeTicker()
|
ticker := timex.NewFakeTicker()
|
||||||
tw, _ := newTimingWheelWithClock(testStep, 10, func(k, v interface{}) {
|
tw, _ := newTimingWheelWithClock(testStep, 10, func(k, v interface{}) {
|
||||||
}, ticker)
|
}, ticker)
|
||||||
defer tw.Stop()
|
|
||||||
tw.SetTimer("first", 3, testStep*4)
|
tw.SetTimer("first", 3, testStep*4)
|
||||||
tw.SetTimer("second", 5, testStep*7)
|
tw.SetTimer("second", 5, testStep*7)
|
||||||
tw.SetTimer("third", 7, testStep*7)
|
tw.SetTimer("third", 7, testStep*7)
|
||||||
@@ -56,6 +55,8 @@ func TestTimingWheel_Drain(t *testing.T) {
|
|||||||
})
|
})
|
||||||
time.Sleep(time.Millisecond * 100)
|
time.Sleep(time.Millisecond * 100)
|
||||||
assert.Equal(t, 0, count)
|
assert.Equal(t, 0, count)
|
||||||
|
tw.Stop()
|
||||||
|
assert.Equal(t, ErrClosed, tw.Drain(func(key, value interface{}) {}))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestTimingWheel_SetTimerSoon(t *testing.T) {
|
func TestTimingWheel_SetTimerSoon(t *testing.T) {
|
||||||
@@ -102,6 +103,13 @@ func TestTimingWheel_SetTimerWrongDelay(t *testing.T) {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestTimingWheel_SetTimerAfterClose(t *testing.T) {
|
||||||
|
ticker := timex.NewFakeTicker()
|
||||||
|
tw, _ := newTimingWheelWithClock(testStep, 10, func(k, v interface{}) {}, ticker)
|
||||||
|
tw.Stop()
|
||||||
|
assert.Equal(t, ErrClosed, tw.SetTimer("any", 3, testStep))
|
||||||
|
}
|
||||||
|
|
||||||
func TestTimingWheel_MoveTimer(t *testing.T) {
|
func TestTimingWheel_MoveTimer(t *testing.T) {
|
||||||
run := syncx.NewAtomicBool()
|
run := syncx.NewAtomicBool()
|
||||||
ticker := timex.NewFakeTicker()
|
ticker := timex.NewFakeTicker()
|
||||||
@@ -111,7 +119,6 @@ func TestTimingWheel_MoveTimer(t *testing.T) {
|
|||||||
assert.Equal(t, 3, v.(int))
|
assert.Equal(t, 3, v.(int))
|
||||||
ticker.Done()
|
ticker.Done()
|
||||||
}, ticker)
|
}, ticker)
|
||||||
defer tw.Stop()
|
|
||||||
tw.SetTimer("any", 3, testStep*4)
|
tw.SetTimer("any", 3, testStep*4)
|
||||||
tw.MoveTimer("any", testStep*7)
|
tw.MoveTimer("any", testStep*7)
|
||||||
tw.MoveTimer("any", -testStep)
|
tw.MoveTimer("any", -testStep)
|
||||||
@@ -125,6 +132,8 @@ func TestTimingWheel_MoveTimer(t *testing.T) {
|
|||||||
}
|
}
|
||||||
assert.Nil(t, ticker.Wait(waitTime))
|
assert.Nil(t, ticker.Wait(waitTime))
|
||||||
assert.True(t, run.True())
|
assert.True(t, run.True())
|
||||||
|
tw.Stop()
|
||||||
|
assert.Equal(t, ErrClosed, tw.MoveTimer("any", time.Millisecond))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestTimingWheel_MoveTimerSoon(t *testing.T) {
|
func TestTimingWheel_MoveTimerSoon(t *testing.T) {
|
||||||
@@ -175,6 +184,7 @@ func TestTimingWheel_RemoveTimer(t *testing.T) {
|
|||||||
ticker.Tick()
|
ticker.Tick()
|
||||||
}
|
}
|
||||||
tw.Stop()
|
tw.Stop()
|
||||||
|
assert.Equal(t, ErrClosed, tw.RemoveTimer("any"))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestTimingWheel_SetTimer(t *testing.T) {
|
func TestTimingWheel_SetTimer(t *testing.T) {
|
||||||
|
|||||||
73
core/color/color.go
Normal file
73
core/color/color.go
Normal file
@@ -0,0 +1,73 @@
|
|||||||
|
package color
|
||||||
|
|
||||||
|
import "github.com/fatih/color"
|
||||||
|
|
||||||
|
const (
|
||||||
|
// NoColor is no color for both foreground and background.
|
||||||
|
NoColor Color = iota
|
||||||
|
// FgBlack is the foreground color black.
|
||||||
|
FgBlack
|
||||||
|
// FgRed is the foreground color red.
|
||||||
|
FgRed
|
||||||
|
// FgGreen is the foreground color green.
|
||||||
|
FgGreen
|
||||||
|
// FgYellow is the foreground color yellow.
|
||||||
|
FgYellow
|
||||||
|
// FgBlue is the foreground color blue.
|
||||||
|
FgBlue
|
||||||
|
// FgMagenta is the foreground color magenta.
|
||||||
|
FgMagenta
|
||||||
|
// FgCyan is the foreground color cyan.
|
||||||
|
FgCyan
|
||||||
|
// FgWhite is the foreground color white.
|
||||||
|
FgWhite
|
||||||
|
|
||||||
|
// BgBlack is the background color black.
|
||||||
|
BgBlack
|
||||||
|
// BgRed is the background color red.
|
||||||
|
BgRed
|
||||||
|
// BgGreen is the background color green.
|
||||||
|
BgGreen
|
||||||
|
// BgYellow is the background color yellow.
|
||||||
|
BgYellow
|
||||||
|
// BgBlue is the background color blue.
|
||||||
|
BgBlue
|
||||||
|
// BgMagenta is the background color magenta.
|
||||||
|
BgMagenta
|
||||||
|
// BgCyan is the background color cyan.
|
||||||
|
BgCyan
|
||||||
|
// BgWhite is the background color white.
|
||||||
|
BgWhite
|
||||||
|
)
|
||||||
|
|
||||||
|
var colors = map[Color][]color.Attribute{
|
||||||
|
FgBlack: {color.FgBlack, color.Bold},
|
||||||
|
FgRed: {color.FgRed, color.Bold},
|
||||||
|
FgGreen: {color.FgGreen, color.Bold},
|
||||||
|
FgYellow: {color.FgYellow, color.Bold},
|
||||||
|
FgBlue: {color.FgBlue, color.Bold},
|
||||||
|
FgMagenta: {color.FgMagenta, color.Bold},
|
||||||
|
FgCyan: {color.FgCyan, color.Bold},
|
||||||
|
FgWhite: {color.FgWhite, color.Bold},
|
||||||
|
BgBlack: {color.BgBlack, color.FgHiWhite, color.Bold},
|
||||||
|
BgRed: {color.BgRed, color.FgHiWhite, color.Bold},
|
||||||
|
BgGreen: {color.BgGreen, color.FgHiWhite, color.Bold},
|
||||||
|
BgYellow: {color.BgHiYellow, color.FgHiBlack, color.Bold},
|
||||||
|
BgBlue: {color.BgBlue, color.FgHiWhite, color.Bold},
|
||||||
|
BgMagenta: {color.BgMagenta, color.FgHiWhite, color.Bold},
|
||||||
|
BgCyan: {color.BgCyan, color.FgHiWhite, color.Bold},
|
||||||
|
BgWhite: {color.BgHiWhite, color.FgHiBlack, color.Bold},
|
||||||
|
}
|
||||||
|
|
||||||
|
type Color uint32
|
||||||
|
|
||||||
|
// WithColor returns a string with the given color applied.
|
||||||
|
func WithColor(text string, colour Color) string {
|
||||||
|
c := color.New(colors[colour]...)
|
||||||
|
return c.Sprint(text)
|
||||||
|
}
|
||||||
|
|
||||||
|
// WithColorPadding returns a string with the given color applied with leading and trailing spaces.
|
||||||
|
func WithColorPadding(text string, colour Color) string {
|
||||||
|
return WithColor(" "+text+" ", colour)
|
||||||
|
}
|
||||||
17
core/color/color_test.go
Normal file
17
core/color/color_test.go
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
package color
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestWithColor(t *testing.T) {
|
||||||
|
output := WithColor("Hello", BgRed)
|
||||||
|
assert.Equal(t, "Hello", output)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWithColorPadding(t *testing.T) {
|
||||||
|
output := WithColorPadding("Hello", BgRed)
|
||||||
|
assert.Equal(t, " Hello ", output)
|
||||||
|
}
|
||||||
@@ -6,24 +6,26 @@ import (
|
|||||||
"log"
|
"log"
|
||||||
"os"
|
"os"
|
||||||
"path"
|
"path"
|
||||||
|
"strings"
|
||||||
|
|
||||||
"github.com/tal-tech/go-zero/core/mapping"
|
"github.com/zeromicro/go-zero/core/mapping"
|
||||||
)
|
)
|
||||||
|
|
||||||
var loaders = map[string]func([]byte, interface{}) error{
|
var loaders = map[string]func([]byte, interface{}) error{
|
||||||
".json": LoadConfigFromJsonBytes,
|
".json": LoadFromJsonBytes,
|
||||||
".yaml": LoadConfigFromYamlBytes,
|
".toml": LoadFromTomlBytes,
|
||||||
".yml": LoadConfigFromYamlBytes,
|
".yaml": LoadFromYamlBytes,
|
||||||
|
".yml": LoadFromYamlBytes,
|
||||||
}
|
}
|
||||||
|
|
||||||
// LoadConfig loads config into v from file, .json, .yaml and .yml are acceptable.
|
// Load loads config into v from file, .json, .yaml and .yml are acceptable.
|
||||||
func LoadConfig(file string, v interface{}, opts ...Option) error {
|
func Load(file string, v interface{}, opts ...Option) error {
|
||||||
content, err := ioutil.ReadFile(file)
|
content, err := ioutil.ReadFile(file)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
loader, ok := loaders[path.Ext(file)]
|
loader, ok := loaders[strings.ToLower(path.Ext(file))]
|
||||||
if !ok {
|
if !ok {
|
||||||
return fmt.Errorf("unrecognized file type: %s", file)
|
return fmt.Errorf("unrecognized file type: %s", file)
|
||||||
}
|
}
|
||||||
@@ -40,19 +42,42 @@ func LoadConfig(file string, v interface{}, opts ...Option) error {
|
|||||||
return loader(content, v)
|
return loader(content, v)
|
||||||
}
|
}
|
||||||
|
|
||||||
// LoadConfigFromJsonBytes loads config into v from content json bytes.
|
// LoadConfig loads config into v from file, .json, .yaml and .yml are acceptable.
|
||||||
func LoadConfigFromJsonBytes(content []byte, v interface{}) error {
|
// Deprecated: use Load instead.
|
||||||
|
func LoadConfig(file string, v interface{}, opts ...Option) error {
|
||||||
|
return Load(file, v, opts...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// LoadFromJsonBytes loads config into v from content json bytes.
|
||||||
|
func LoadFromJsonBytes(content []byte, v interface{}) error {
|
||||||
return mapping.UnmarshalJsonBytes(content, v)
|
return mapping.UnmarshalJsonBytes(content, v)
|
||||||
}
|
}
|
||||||
|
|
||||||
// LoadConfigFromYamlBytes loads config into v from content yaml bytes.
|
// LoadConfigFromJsonBytes loads config into v from content json bytes.
|
||||||
func LoadConfigFromYamlBytes(content []byte, v interface{}) error {
|
// Deprecated: use LoadFromJsonBytes instead.
|
||||||
|
func LoadConfigFromJsonBytes(content []byte, v interface{}) error {
|
||||||
|
return LoadFromJsonBytes(content, v)
|
||||||
|
}
|
||||||
|
|
||||||
|
// LoadFromTomlBytes loads config into v from content toml bytes.
|
||||||
|
func LoadFromTomlBytes(content []byte, v interface{}) error {
|
||||||
|
return mapping.UnmarshalTomlBytes(content, v)
|
||||||
|
}
|
||||||
|
|
||||||
|
// LoadFromYamlBytes loads config into v from content yaml bytes.
|
||||||
|
func LoadFromYamlBytes(content []byte, v interface{}) error {
|
||||||
return mapping.UnmarshalYamlBytes(content, v)
|
return mapping.UnmarshalYamlBytes(content, v)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// LoadConfigFromYamlBytes loads config into v from content yaml bytes.
|
||||||
|
// Deprecated: use LoadFromYamlBytes instead.
|
||||||
|
func LoadConfigFromYamlBytes(content []byte, v interface{}) error {
|
||||||
|
return LoadFromYamlBytes(content, v)
|
||||||
|
}
|
||||||
|
|
||||||
// MustLoad loads config into v from path, exits on error.
|
// MustLoad loads config into v from path, exits on error.
|
||||||
func MustLoad(path string, v interface{}, opts ...Option) {
|
func MustLoad(path string, v interface{}, opts ...Option) {
|
||||||
if err := LoadConfig(path, v, opts...); err != nil {
|
if err := Load(path, v, opts...); err != nil {
|
||||||
log.Fatalf("error: config file %s, %s", path, err.Error())
|
log.Fatalf("error: config file %s, %s", path, err.Error())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -6,19 +6,19 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/tal-tech/go-zero/core/fs"
|
"github.com/zeromicro/go-zero/core/fs"
|
||||||
"github.com/tal-tech/go-zero/core/hash"
|
"github.com/zeromicro/go-zero/core/hash"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestLoadConfig_notExists(t *testing.T) {
|
func TestLoadConfig_notExists(t *testing.T) {
|
||||||
assert.NotNil(t, LoadConfig("not_a_file", nil))
|
assert.NotNil(t, Load("not_a_file", nil))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestLoadConfig_notRecogFile(t *testing.T) {
|
func TestLoadConfig_notRecogFile(t *testing.T) {
|
||||||
filename, err := fs.TempFilenameWithText("hello")
|
filename, err := fs.TempFilenameWithText("hello")
|
||||||
assert.Nil(t, err)
|
assert.Nil(t, err)
|
||||||
defer os.Remove(filename)
|
defer os.Remove(filename)
|
||||||
assert.NotNil(t, LoadConfig(filename, nil))
|
assert.NotNil(t, Load(filename, nil))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestConfigJson(t *testing.T) {
|
func TestConfigJson(t *testing.T) {
|
||||||
@@ -57,6 +57,58 @@ func TestConfigJson(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestConfigToml(t *testing.T) {
|
||||||
|
text := `a = "foo"
|
||||||
|
b = 1
|
||||||
|
c = "${FOO}"
|
||||||
|
d = "abcd!@#$112"
|
||||||
|
`
|
||||||
|
os.Setenv("FOO", "2")
|
||||||
|
defer os.Unsetenv("FOO")
|
||||||
|
tmpfile, err := createTempFile(".toml", text)
|
||||||
|
assert.Nil(t, err)
|
||||||
|
defer os.Remove(tmpfile)
|
||||||
|
|
||||||
|
var val struct {
|
||||||
|
A string `json:"a"`
|
||||||
|
B int `json:"b"`
|
||||||
|
C string `json:"c"`
|
||||||
|
D string `json:"d"`
|
||||||
|
}
|
||||||
|
MustLoad(tmpfile, &val)
|
||||||
|
assert.Equal(t, "foo", val.A)
|
||||||
|
assert.Equal(t, 1, val.B)
|
||||||
|
assert.Equal(t, "${FOO}", val.C)
|
||||||
|
assert.Equal(t, "abcd!@#$112", val.D)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestConfigTomlEnv(t *testing.T) {
|
||||||
|
text := `a = "foo"
|
||||||
|
b = 1
|
||||||
|
c = "${FOO}"
|
||||||
|
d = "abcd!@#112"
|
||||||
|
`
|
||||||
|
os.Setenv("FOO", "2")
|
||||||
|
defer os.Unsetenv("FOO")
|
||||||
|
tmpfile, err := createTempFile(".toml", text)
|
||||||
|
assert.Nil(t, err)
|
||||||
|
defer os.Remove(tmpfile)
|
||||||
|
|
||||||
|
var val struct {
|
||||||
|
A string `json:"a"`
|
||||||
|
B int `json:"b"`
|
||||||
|
C string `json:"c"`
|
||||||
|
D string `json:"d"`
|
||||||
|
}
|
||||||
|
|
||||||
|
MustLoad(tmpfile, &val, UseEnv())
|
||||||
|
assert.Equal(t, "foo", val.A)
|
||||||
|
assert.Equal(t, 1, val.B)
|
||||||
|
assert.Equal(t, "2", val.C)
|
||||||
|
assert.Equal(t, "abcd!@#112", val.D)
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
func TestConfigJsonEnv(t *testing.T) {
|
func TestConfigJsonEnv(t *testing.T) {
|
||||||
tests := []string{
|
tests := []string{
|
||||||
".json",
|
".json",
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import (
|
|||||||
"strings"
|
"strings"
|
||||||
"sync"
|
"sync"
|
||||||
|
|
||||||
"github.com/tal-tech/go-zero/core/iox"
|
"github.com/zeromicro/go-zero/core/iox"
|
||||||
)
|
)
|
||||||
|
|
||||||
// PropertyError represents a configuration error message.
|
// PropertyError represents a configuration error message.
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/tal-tech/go-zero/core/fs"
|
"github.com/zeromicro/go-zero/core/fs"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestProperties(t *testing.T) {
|
func TestProperties(t *testing.T) {
|
||||||
|
|||||||
45
core/conf/readme.md
Normal file
45
core/conf/readme.md
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
## How to use
|
||||||
|
|
||||||
|
1. Define a config structure, like below:
|
||||||
|
|
||||||
|
```go
|
||||||
|
RestfulConf struct {
|
||||||
|
Host string `json:",default=0.0.0.0"`
|
||||||
|
Port int
|
||||||
|
LogMode string `json:",options=[file,console]"
|
||||||
|
Verbose bool `json:",optional"`
|
||||||
|
MaxConns int `json:",default=10000"`
|
||||||
|
MaxBytes int64 `json:",default=1048576"`
|
||||||
|
Timeout time.Duration `json:",default=3s"`
|
||||||
|
CpuThreshold int64 `json:",default=900,range=[0:1000]"`
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Write the yaml or json config file:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# most fields are optional or have default values
|
||||||
|
Port: 8080
|
||||||
|
LogMode: console
|
||||||
|
# you can use env settings
|
||||||
|
MaxBytes: ${MAX_BYTES}
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Load the config from a file:
|
||||||
|
|
||||||
|
```go
|
||||||
|
// exit on error
|
||||||
|
var config RestfulConf
|
||||||
|
conf.MustLoad(configFile, &config)
|
||||||
|
|
||||||
|
// or handle the error on your own
|
||||||
|
var config RestfulConf
|
||||||
|
if err := conf.Load(configFile, &config); err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// enable reading from environments
|
||||||
|
var config RestfulConf
|
||||||
|
conf.MustLoad(configFile, &config, conf.UseEnv())
|
||||||
|
```
|
||||||
|
|
||||||
@@ -3,7 +3,7 @@ package contextx
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
|
||||||
"github.com/tal-tech/go-zero/core/mapping"
|
"github.com/zeromicro/go-zero/core/mapping"
|
||||||
)
|
)
|
||||||
|
|
||||||
const contextTagKey = "ctx"
|
const contextTagKey = "ctx"
|
||||||
|
|||||||
14
core/discov/accountregistry.go
Normal file
14
core/discov/accountregistry.go
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
package discov
|
||||||
|
|
||||||
|
import "github.com/zeromicro/go-zero/core/discov/internal"
|
||||||
|
|
||||||
|
// RegisterAccount registers the username/password to the given etcd cluster.
|
||||||
|
func RegisterAccount(endpoints []string, user, pass string) {
|
||||||
|
internal.AddAccount(endpoints, user, pass)
|
||||||
|
}
|
||||||
|
|
||||||
|
// RegisterTLS registers the CertFile/CertKeyFile/CACertFile to the given etcd.
|
||||||
|
func RegisterTLS(endpoints []string, certFile, certKeyFile, caFile string,
|
||||||
|
insecureSkipVerify bool) error {
|
||||||
|
return internal.AddTLS(endpoints, certFile, certKeyFile, caFile, insecureSkipVerify)
|
||||||
|
}
|
||||||
21
core/discov/accountregistry_test.go
Normal file
21
core/discov/accountregistry_test.go
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
package discov
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/zeromicro/go-zero/core/discov/internal"
|
||||||
|
"github.com/zeromicro/go-zero/core/stringx"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestRegisterAccount(t *testing.T) {
|
||||||
|
endpoints := []string{
|
||||||
|
"localhost:2379",
|
||||||
|
}
|
||||||
|
user := "foo" + stringx.Rand()
|
||||||
|
RegisterAccount(endpoints, user, "bar")
|
||||||
|
account, ok := internal.GetAccount(endpoints)
|
||||||
|
assert.True(t, ok)
|
||||||
|
assert.Equal(t, user, account.User)
|
||||||
|
assert.Equal(t, "bar", account.Pass)
|
||||||
|
}
|
||||||
@@ -4,7 +4,7 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
"github.com/tal-tech/go-zero/core/discov/internal"
|
"github.com/zeromicro/go-zero/core/discov/internal"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/tal-tech/go-zero/core/discov/internal"
|
"github.com/zeromicro/go-zero/core/discov/internal"
|
||||||
)
|
)
|
||||||
|
|
||||||
var mockLock sync.Mutex
|
var mockLock sync.Mutex
|
||||||
|
|||||||
@@ -2,18 +2,41 @@ package discov
|
|||||||
|
|
||||||
import "errors"
|
import "errors"
|
||||||
|
|
||||||
|
var (
|
||||||
|
// errEmptyEtcdHosts indicates that etcd hosts are empty.
|
||||||
|
errEmptyEtcdHosts = errors.New("empty etcd hosts")
|
||||||
|
// errEmptyEtcdKey indicates that etcd key is empty.
|
||||||
|
errEmptyEtcdKey = errors.New("empty etcd key")
|
||||||
|
)
|
||||||
|
|
||||||
// EtcdConf is the config item with the given key on etcd.
|
// EtcdConf is the config item with the given key on etcd.
|
||||||
type EtcdConf struct {
|
type EtcdConf struct {
|
||||||
Hosts []string
|
Hosts []string
|
||||||
Key string
|
Key string
|
||||||
|
User string `json:",optional"`
|
||||||
|
Pass string `json:",optional"`
|
||||||
|
CertFile string `json:",optional"`
|
||||||
|
CertKeyFile string `json:",optional=CertFile"`
|
||||||
|
CACertFile string `json:",optional=CertFile"`
|
||||||
|
InsecureSkipVerify bool `json:",optional"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// HasAccount returns if account provided.
|
||||||
|
func (c EtcdConf) HasAccount() bool {
|
||||||
|
return len(c.User) > 0 && len(c.Pass) > 0
|
||||||
|
}
|
||||||
|
|
||||||
|
// HasTLS returns if TLS CertFile/CertKeyFile/CACertFile are provided.
|
||||||
|
func (c EtcdConf) HasTLS() bool {
|
||||||
|
return len(c.CertFile) > 0 && len(c.CertKeyFile) > 0 && len(c.CACertFile) > 0
|
||||||
}
|
}
|
||||||
|
|
||||||
// Validate validates c.
|
// Validate validates c.
|
||||||
func (c EtcdConf) Validate() error {
|
func (c EtcdConf) Validate() error {
|
||||||
if len(c.Hosts) == 0 {
|
if len(c.Hosts) == 0 {
|
||||||
return errors.New("empty etcd hosts")
|
return errEmptyEtcdHosts
|
||||||
} else if len(c.Key) == 0 {
|
} else if len(c.Key) == 0 {
|
||||||
return errors.New("empty etcd key")
|
return errEmptyEtcdKey
|
||||||
} else {
|
} else {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -44,3 +44,39 @@ func TestConfig(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestEtcdConf_HasAccount(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
EtcdConf
|
||||||
|
hasAccount bool
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
EtcdConf: EtcdConf{
|
||||||
|
Hosts: []string{"any"},
|
||||||
|
Key: "key",
|
||||||
|
},
|
||||||
|
hasAccount: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
EtcdConf: EtcdConf{
|
||||||
|
Hosts: []string{"any"},
|
||||||
|
Key: "key",
|
||||||
|
User: "foo",
|
||||||
|
},
|
||||||
|
hasAccount: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
EtcdConf: EtcdConf{
|
||||||
|
Hosts: []string{"any"},
|
||||||
|
Key: "key",
|
||||||
|
User: "foo",
|
||||||
|
Pass: "bar",
|
||||||
|
},
|
||||||
|
hasAccount: true,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, test := range tests {
|
||||||
|
assert.Equal(t, test.hasAccount, test.EtcdConf.HasAccount())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
75
core/discov/internal/accountmanager.go
Normal file
75
core/discov/internal/accountmanager.go
Normal file
@@ -0,0 +1,75 @@
|
|||||||
|
package internal
|
||||||
|
|
||||||
|
import (
|
||||||
|
"crypto/tls"
|
||||||
|
"crypto/x509"
|
||||||
|
"io/ioutil"
|
||||||
|
"sync"
|
||||||
|
)
|
||||||
|
|
||||||
|
var (
|
||||||
|
accounts = make(map[string]Account)
|
||||||
|
tlsConfigs = make(map[string]*tls.Config)
|
||||||
|
lock sync.RWMutex
|
||||||
|
)
|
||||||
|
|
||||||
|
// Account holds the username/password for an etcd cluster.
|
||||||
|
type Account struct {
|
||||||
|
User string
|
||||||
|
Pass string
|
||||||
|
}
|
||||||
|
|
||||||
|
// AddAccount adds the username/password for the given etcd cluster.
|
||||||
|
func AddAccount(endpoints []string, user, pass string) {
|
||||||
|
lock.Lock()
|
||||||
|
defer lock.Unlock()
|
||||||
|
|
||||||
|
accounts[getClusterKey(endpoints)] = Account{
|
||||||
|
User: user,
|
||||||
|
Pass: pass,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// AddTLS adds the tls cert files for the given etcd cluster.
|
||||||
|
func AddTLS(endpoints []string, certFile, certKeyFile, caFile string, insecureSkipVerify bool) error {
|
||||||
|
cert, err := tls.LoadX509KeyPair(certFile, certKeyFile)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
caData, err := ioutil.ReadFile(caFile)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
pool := x509.NewCertPool()
|
||||||
|
pool.AppendCertsFromPEM(caData)
|
||||||
|
|
||||||
|
lock.Lock()
|
||||||
|
defer lock.Unlock()
|
||||||
|
tlsConfigs[getClusterKey(endpoints)] = &tls.Config{
|
||||||
|
Certificates: []tls.Certificate{cert},
|
||||||
|
RootCAs: pool,
|
||||||
|
InsecureSkipVerify: insecureSkipVerify,
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetAccount gets the username/password for the given etcd cluster.
|
||||||
|
func GetAccount(endpoints []string) (Account, bool) {
|
||||||
|
lock.RLock()
|
||||||
|
defer lock.RUnlock()
|
||||||
|
|
||||||
|
account, ok := accounts[getClusterKey(endpoints)]
|
||||||
|
return account, ok
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetTLS gets the tls config for the given etcd cluster.
|
||||||
|
func GetTLS(endpoints []string) (*tls.Config, bool) {
|
||||||
|
lock.RLock()
|
||||||
|
defer lock.RUnlock()
|
||||||
|
|
||||||
|
cfg, ok := tlsConfigs[getClusterKey(endpoints)]
|
||||||
|
return cfg, ok
|
||||||
|
}
|
||||||
34
core/discov/internal/accountmanager_test.go
Normal file
34
core/discov/internal/accountmanager_test.go
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
package internal
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/zeromicro/go-zero/core/stringx"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestAccount(t *testing.T) {
|
||||||
|
endpoints := []string{
|
||||||
|
"192.168.0.2:2379",
|
||||||
|
"192.168.0.3:2379",
|
||||||
|
"192.168.0.4:2379",
|
||||||
|
}
|
||||||
|
username := "foo" + stringx.Rand()
|
||||||
|
password := "bar"
|
||||||
|
anotherPassword := "any"
|
||||||
|
|
||||||
|
_, ok := GetAccount(endpoints)
|
||||||
|
assert.False(t, ok)
|
||||||
|
|
||||||
|
AddAccount(endpoints, username, password)
|
||||||
|
account, ok := GetAccount(endpoints)
|
||||||
|
assert.True(t, ok)
|
||||||
|
assert.Equal(t, username, account.User)
|
||||||
|
assert.Equal(t, password, account.Pass)
|
||||||
|
|
||||||
|
AddAccount(endpoints, username, anotherPassword)
|
||||||
|
account, ok = GetAccount(endpoints)
|
||||||
|
assert.True(t, ok)
|
||||||
|
assert.Equal(t, username, account.User)
|
||||||
|
assert.Equal(t, anotherPassword, account.Pass)
|
||||||
|
}
|
||||||
@@ -9,11 +9,11 @@ import (
|
|||||||
"sync"
|
"sync"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/tal-tech/go-zero/core/contextx"
|
"github.com/zeromicro/go-zero/core/contextx"
|
||||||
"github.com/tal-tech/go-zero/core/lang"
|
"github.com/zeromicro/go-zero/core/lang"
|
||||||
"github.com/tal-tech/go-zero/core/logx"
|
"github.com/zeromicro/go-zero/core/logx"
|
||||||
"github.com/tal-tech/go-zero/core/syncx"
|
"github.com/zeromicro/go-zero/core/syncx"
|
||||||
"github.com/tal-tech/go-zero/core/threading"
|
"github.com/zeromicro/go-zero/core/threading"
|
||||||
clientv3 "go.etcd.io/etcd/client/v3"
|
clientv3 "go.etcd.io/etcd/client/v3"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -37,25 +37,35 @@ func GetRegistry() *Registry {
|
|||||||
|
|
||||||
// GetConn returns an etcd client connection associated with given endpoints.
|
// GetConn returns an etcd client connection associated with given endpoints.
|
||||||
func (r *Registry) GetConn(endpoints []string) (EtcdClient, error) {
|
func (r *Registry) GetConn(endpoints []string) (EtcdClient, error) {
|
||||||
return r.getCluster(endpoints).getClient()
|
c, _ := r.getCluster(endpoints)
|
||||||
|
return c.getClient()
|
||||||
}
|
}
|
||||||
|
|
||||||
// Monitor monitors the key on given etcd endpoints, notify with the given UpdateListener.
|
// Monitor monitors the key on given etcd endpoints, notify with the given UpdateListener.
|
||||||
func (r *Registry) Monitor(endpoints []string, key string, l UpdateListener) error {
|
func (r *Registry) Monitor(endpoints []string, key string, l UpdateListener) error {
|
||||||
return r.getCluster(endpoints).monitor(key, l)
|
c, exists := r.getCluster(endpoints)
|
||||||
|
// if exists, the existing values should be updated to the listener.
|
||||||
|
if exists {
|
||||||
|
kvs := c.getCurrent(key)
|
||||||
|
for _, kv := range kvs {
|
||||||
|
l.OnAdd(kv)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return c.monitor(key, l)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (r *Registry) getCluster(endpoints []string) *cluster {
|
func (r *Registry) getCluster(endpoints []string) (c *cluster, exists bool) {
|
||||||
clusterKey := getClusterKey(endpoints)
|
clusterKey := getClusterKey(endpoints)
|
||||||
r.lock.Lock()
|
r.lock.Lock()
|
||||||
defer r.lock.Unlock()
|
defer r.lock.Unlock()
|
||||||
c, ok := r.clusters[clusterKey]
|
c, exists = r.clusters[clusterKey]
|
||||||
if !ok {
|
if !exists {
|
||||||
c = newCluster(endpoints)
|
c = newCluster(endpoints)
|
||||||
r.clusters[clusterKey] = c
|
r.clusters[clusterKey] = c
|
||||||
}
|
}
|
||||||
|
|
||||||
return c
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
type cluster struct {
|
type cluster struct {
|
||||||
@@ -94,6 +104,21 @@ func (c *cluster) getClient() (EtcdClient, error) {
|
|||||||
return val.(EtcdClient), nil
|
return val.(EtcdClient), nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (c *cluster) getCurrent(key string) []KV {
|
||||||
|
c.lock.Lock()
|
||||||
|
defer c.lock.Unlock()
|
||||||
|
|
||||||
|
var kvs []KV
|
||||||
|
for k, v := range c.values[key] {
|
||||||
|
kvs = append(kvs, KV{
|
||||||
|
Key: k,
|
||||||
|
Val: v,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
return kvs
|
||||||
|
}
|
||||||
|
|
||||||
func (c *cluster) handleChanges(key string, kvs []KV) {
|
func (c *cluster) handleChanges(key string, kvs []KV) {
|
||||||
var add []KV
|
var add []KV
|
||||||
var remove []KV
|
var remove []KV
|
||||||
@@ -197,14 +222,12 @@ func (c *cluster) load(cli EtcdClient, key string) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
var kvs []KV
|
var kvs []KV
|
||||||
c.lock.Lock()
|
|
||||||
for _, ev := range resp.Kvs {
|
for _, ev := range resp.Kvs {
|
||||||
kvs = append(kvs, KV{
|
kvs = append(kvs, KV{
|
||||||
Key: string(ev.Key),
|
Key: string(ev.Key),
|
||||||
Val: string(ev.Value),
|
Val: string(ev.Value),
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
c.lock.Unlock()
|
|
||||||
|
|
||||||
c.handleChanges(key, kvs)
|
c.handleChanges(key, kvs)
|
||||||
}
|
}
|
||||||
@@ -302,14 +325,23 @@ func (c *cluster) watchConnState(cli EtcdClient) {
|
|||||||
|
|
||||||
// DialClient dials an etcd cluster with given endpoints.
|
// DialClient dials an etcd cluster with given endpoints.
|
||||||
func DialClient(endpoints []string) (EtcdClient, error) {
|
func DialClient(endpoints []string) (EtcdClient, error) {
|
||||||
return clientv3.New(clientv3.Config{
|
cfg := clientv3.Config{
|
||||||
Endpoints: endpoints,
|
Endpoints: endpoints,
|
||||||
AutoSyncInterval: autoSyncInterval,
|
AutoSyncInterval: autoSyncInterval,
|
||||||
DialTimeout: DialTimeout,
|
DialTimeout: DialTimeout,
|
||||||
DialKeepAliveTime: dialKeepAliveTime,
|
DialKeepAliveTime: dialKeepAliveTime,
|
||||||
DialKeepAliveTimeout: DialTimeout,
|
DialKeepAliveTimeout: DialTimeout,
|
||||||
RejectOldCluster: true,
|
RejectOldCluster: true,
|
||||||
})
|
}
|
||||||
|
if account, ok := GetAccount(endpoints); ok {
|
||||||
|
cfg.Username = account.User
|
||||||
|
cfg.Password = account.Pass
|
||||||
|
}
|
||||||
|
if tlsCfg, ok := GetTLS(endpoints); ok {
|
||||||
|
cfg.TLS = tlsCfg
|
||||||
|
}
|
||||||
|
|
||||||
|
return clientv3.New(cfg)
|
||||||
}
|
}
|
||||||
|
|
||||||
func getClusterKey(endpoints []string) string {
|
func getClusterKey(endpoints []string) string {
|
||||||
|
|||||||
@@ -7,10 +7,10 @@ import (
|
|||||||
|
|
||||||
"github.com/golang/mock/gomock"
|
"github.com/golang/mock/gomock"
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/tal-tech/go-zero/core/contextx"
|
"github.com/zeromicro/go-zero/core/contextx"
|
||||||
"github.com/tal-tech/go-zero/core/lang"
|
"github.com/zeromicro/go-zero/core/lang"
|
||||||
"github.com/tal-tech/go-zero/core/logx"
|
"github.com/zeromicro/go-zero/core/logx"
|
||||||
"github.com/tal-tech/go-zero/core/stringx"
|
"github.com/zeromicro/go-zero/core/stringx"
|
||||||
"go.etcd.io/etcd/api/v3/mvccpb"
|
"go.etcd.io/etcd/api/v3/mvccpb"
|
||||||
clientv3 "go.etcd.io/etcd/client/v3"
|
clientv3 "go.etcd.io/etcd/client/v3"
|
||||||
)
|
)
|
||||||
@@ -33,9 +33,10 @@ func setMockClient(cli EtcdClient) func() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func TestGetCluster(t *testing.T) {
|
func TestGetCluster(t *testing.T) {
|
||||||
c1 := GetRegistry().getCluster([]string{"first"})
|
AddAccount([]string{"first"}, "foo", "bar")
|
||||||
c2 := GetRegistry().getCluster([]string{"second"})
|
c1, _ := GetRegistry().getCluster([]string{"first"})
|
||||||
c3 := GetRegistry().getCluster([]string{"first"})
|
c2, _ := GetRegistry().getCluster([]string{"second"})
|
||||||
|
c3, _ := GetRegistry().getCluster([]string{"first"})
|
||||||
assert.Equal(t, c1, c3)
|
assert.Equal(t, c1, c3)
|
||||||
assert.NotEqual(t, c1, c2)
|
assert.NotEqual(t, c1, c2)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,18 +1,18 @@
|
|||||||
package discov
|
package discov
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"github.com/tal-tech/go-zero/core/discov/internal"
|
"github.com/zeromicro/go-zero/core/discov/internal"
|
||||||
"github.com/tal-tech/go-zero/core/lang"
|
"github.com/zeromicro/go-zero/core/lang"
|
||||||
"github.com/tal-tech/go-zero/core/logx"
|
"github.com/zeromicro/go-zero/core/logx"
|
||||||
"github.com/tal-tech/go-zero/core/proc"
|
"github.com/zeromicro/go-zero/core/proc"
|
||||||
"github.com/tal-tech/go-zero/core/syncx"
|
"github.com/zeromicro/go-zero/core/syncx"
|
||||||
"github.com/tal-tech/go-zero/core/threading"
|
"github.com/zeromicro/go-zero/core/threading"
|
||||||
clientv3 "go.etcd.io/etcd/client/v3"
|
clientv3 "go.etcd.io/etcd/client/v3"
|
||||||
)
|
)
|
||||||
|
|
||||||
type (
|
type (
|
||||||
// PublisherOption defines the method to customize a Publisher.
|
// PubOption defines the method to customize a Publisher.
|
||||||
PublisherOption func(client *Publisher)
|
PubOption func(client *Publisher)
|
||||||
|
|
||||||
// A Publisher can be used to publish the value to an etcd cluster on the given key.
|
// A Publisher can be used to publish the value to an etcd cluster on the given key.
|
||||||
Publisher struct {
|
Publisher struct {
|
||||||
@@ -32,7 +32,7 @@ type (
|
|||||||
// endpoints is the hosts of the etcd cluster.
|
// endpoints is the hosts of the etcd cluster.
|
||||||
// key:value are a pair to be published.
|
// key:value are a pair to be published.
|
||||||
// opts are used to customize the Publisher.
|
// opts are used to customize the Publisher.
|
||||||
func NewPublisher(endpoints []string, key, value string, opts ...PublisherOption) *Publisher {
|
func NewPublisher(endpoints []string, key, value string, opts ...PubOption) *Publisher {
|
||||||
publisher := &Publisher{
|
publisher := &Publisher{
|
||||||
endpoints: endpoints,
|
endpoints: endpoints,
|
||||||
key: key,
|
key: key,
|
||||||
@@ -146,8 +146,22 @@ func (p *Publisher) revoke(cli internal.EtcdClient) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// WithId customizes a Publisher with the id.
|
// WithId customizes a Publisher with the id.
|
||||||
func WithId(id int64) PublisherOption {
|
func WithId(id int64) PubOption {
|
||||||
return func(publisher *Publisher) {
|
return func(publisher *Publisher) {
|
||||||
publisher.id = id
|
publisher.id = id
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// WithPubEtcdAccount provides the etcd username/password.
|
||||||
|
func WithPubEtcdAccount(user, pass string) PubOption {
|
||||||
|
return func(pub *Publisher) {
|
||||||
|
RegisterAccount(pub.endpoints, user, pass)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// WithPubEtcdTLS provides the etcd CertFile/CertKeyFile/CACertFile.
|
||||||
|
func WithPubEtcdTLS(certFile, certKeyFile, caFile string, insecureSkipVerify bool) PubOption {
|
||||||
|
return func(pub *Publisher) {
|
||||||
|
logx.Must(RegisterTLS(pub.endpoints, certFile, certKeyFile, caFile, insecureSkipVerify))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -8,9 +8,10 @@ import (
|
|||||||
|
|
||||||
"github.com/golang/mock/gomock"
|
"github.com/golang/mock/gomock"
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/tal-tech/go-zero/core/discov/internal"
|
"github.com/zeromicro/go-zero/core/discov/internal"
|
||||||
"github.com/tal-tech/go-zero/core/lang"
|
"github.com/zeromicro/go-zero/core/lang"
|
||||||
"github.com/tal-tech/go-zero/core/logx"
|
"github.com/zeromicro/go-zero/core/logx"
|
||||||
|
"github.com/zeromicro/go-zero/core/stringx"
|
||||||
clientv3 "go.etcd.io/etcd/client/v3"
|
clientv3 "go.etcd.io/etcd/client/v3"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -30,7 +31,8 @@ func TestPublisher_register(t *testing.T) {
|
|||||||
ID: id,
|
ID: id,
|
||||||
}, nil)
|
}, nil)
|
||||||
cli.EXPECT().Put(gomock.Any(), makeEtcdKey("thekey", id), "thevalue", gomock.Any())
|
cli.EXPECT().Put(gomock.Any(), makeEtcdKey("thekey", id), "thevalue", gomock.Any())
|
||||||
pub := NewPublisher(nil, "thekey", "thevalue")
|
pub := NewPublisher(nil, "thekey", "thevalue",
|
||||||
|
WithPubEtcdAccount(stringx.Rand(), "bar"))
|
||||||
_, err := pub.register(cli)
|
_, err := pub.register(cli)
|
||||||
assert.Nil(t, err)
|
assert.Nil(t, err)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -4,21 +4,20 @@ import (
|
|||||||
"sync"
|
"sync"
|
||||||
"sync/atomic"
|
"sync/atomic"
|
||||||
|
|
||||||
"github.com/tal-tech/go-zero/core/discov/internal"
|
"github.com/zeromicro/go-zero/core/discov/internal"
|
||||||
"github.com/tal-tech/go-zero/core/syncx"
|
"github.com/zeromicro/go-zero/core/logx"
|
||||||
|
"github.com/zeromicro/go-zero/core/syncx"
|
||||||
)
|
)
|
||||||
|
|
||||||
type (
|
type (
|
||||||
subOptions struct {
|
|
||||||
exclusive bool
|
|
||||||
}
|
|
||||||
|
|
||||||
// SubOption defines the method to customize a Subscriber.
|
// SubOption defines the method to customize a Subscriber.
|
||||||
SubOption func(opts *subOptions)
|
SubOption func(sub *Subscriber)
|
||||||
|
|
||||||
// A Subscriber is used to subscribe the given key on a etcd cluster.
|
// A Subscriber is used to subscribe the given key on a etcd cluster.
|
||||||
Subscriber struct {
|
Subscriber struct {
|
||||||
items *container
|
endpoints []string
|
||||||
|
exclusive bool
|
||||||
|
items *container
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -27,14 +26,14 @@ type (
|
|||||||
// key is the key to subscribe.
|
// key is the key to subscribe.
|
||||||
// opts are used to customize the Subscriber.
|
// opts are used to customize the Subscriber.
|
||||||
func NewSubscriber(endpoints []string, key string, opts ...SubOption) (*Subscriber, error) {
|
func NewSubscriber(endpoints []string, key string, opts ...SubOption) (*Subscriber, error) {
|
||||||
var subOpts subOptions
|
|
||||||
for _, opt := range opts {
|
|
||||||
opt(&subOpts)
|
|
||||||
}
|
|
||||||
|
|
||||||
sub := &Subscriber{
|
sub := &Subscriber{
|
||||||
items: newContainer(subOpts.exclusive),
|
endpoints: endpoints,
|
||||||
}
|
}
|
||||||
|
for _, opt := range opts {
|
||||||
|
opt(sub)
|
||||||
|
}
|
||||||
|
sub.items = newContainer(sub.exclusive)
|
||||||
|
|
||||||
if err := internal.GetRegistry().Monitor(endpoints, key, sub.items); err != nil {
|
if err := internal.GetRegistry().Monitor(endpoints, key, sub.items); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -55,8 +54,22 @@ func (s *Subscriber) Values() []string {
|
|||||||
// Exclusive means that key value can only be 1:1,
|
// Exclusive means that key value can only be 1:1,
|
||||||
// which means later added value will remove the keys associated with the same value previously.
|
// which means later added value will remove the keys associated with the same value previously.
|
||||||
func Exclusive() SubOption {
|
func Exclusive() SubOption {
|
||||||
return func(opts *subOptions) {
|
return func(sub *Subscriber) {
|
||||||
opts.exclusive = true
|
sub.exclusive = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// WithSubEtcdAccount provides the etcd username/password.
|
||||||
|
func WithSubEtcdAccount(user, pass string) SubOption {
|
||||||
|
return func(sub *Subscriber) {
|
||||||
|
RegisterAccount(sub.endpoints, user, pass)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// WithSubEtcdTLS provides the etcd CertFile/CertKeyFile/CACertFile.
|
||||||
|
func WithSubEtcdTLS(certFile, certKeyFile, caFile string, insecureSkipVerify bool) SubOption {
|
||||||
|
return func(sub *Subscriber) {
|
||||||
|
logx.Must(RegisterTLS(sub.endpoints, certFile, certKeyFile, caFile, insecureSkipVerify))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,8 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/tal-tech/go-zero/core/discov/internal"
|
"github.com/zeromicro/go-zero/core/discov/internal"
|
||||||
|
"github.com/zeromicro/go-zero/core/stringx"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
@@ -201,11 +202,9 @@ func TestContainer(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func TestSubscriber(t *testing.T) {
|
func TestSubscriber(t *testing.T) {
|
||||||
var opt subOptions
|
|
||||||
Exclusive()(&opt)
|
|
||||||
|
|
||||||
sub := new(Subscriber)
|
sub := new(Subscriber)
|
||||||
sub.items = newContainer(opt.exclusive)
|
Exclusive()(sub)
|
||||||
|
sub.items = newContainer(sub.exclusive)
|
||||||
var count int32
|
var count int32
|
||||||
sub.AddListener(func() {
|
sub.AddListener(func() {
|
||||||
atomic.AddInt32(&count, 1)
|
atomic.AddInt32(&count, 1)
|
||||||
@@ -214,3 +213,15 @@ func TestSubscriber(t *testing.T) {
|
|||||||
assert.Empty(t, sub.Values())
|
assert.Empty(t, sub.Values())
|
||||||
assert.Equal(t, int32(1), atomic.LoadInt32(&count))
|
assert.Equal(t, int32(1), atomic.LoadInt32(&count))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestWithSubEtcdAccount(t *testing.T) {
|
||||||
|
endpoints := []string{"localhost:2379"}
|
||||||
|
user := stringx.Rand()
|
||||||
|
WithSubEtcdAccount(user, "bar")(&Subscriber{
|
||||||
|
endpoints: endpoints,
|
||||||
|
})
|
||||||
|
account, ok := internal.GetAccount(endpoints)
|
||||||
|
assert.True(t, ok)
|
||||||
|
assert.Equal(t, user, account.User)
|
||||||
|
assert.Equal(t, "bar", account.Pass)
|
||||||
|
}
|
||||||
|
|||||||
@@ -11,10 +11,12 @@ type (
|
|||||||
errorArray []error
|
errorArray []error
|
||||||
)
|
)
|
||||||
|
|
||||||
// Add adds err to be.
|
// Add adds errs to be, nil errors are ignored.
|
||||||
func (be *BatchError) Add(err error) {
|
func (be *BatchError) Add(errs ...error) {
|
||||||
if err != nil {
|
for _, err := range errs {
|
||||||
be.errs = append(be.errs, err)
|
if err != nil {
|
||||||
|
be.errs = append(be.errs, err)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ import (
|
|||||||
"sync"
|
"sync"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/tal-tech/go-zero/core/threading"
|
"github.com/zeromicro/go-zero/core/threading"
|
||||||
)
|
)
|
||||||
|
|
||||||
// A DelayExecutor delays a tasks on given delay interval.
|
// A DelayExecutor delays a tasks on given delay interval.
|
||||||
|
|||||||
@@ -3,8 +3,8 @@ package executors
|
|||||||
import (
|
import (
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/tal-tech/go-zero/core/syncx"
|
"github.com/zeromicro/go-zero/core/syncx"
|
||||||
"github.com/tal-tech/go-zero/core/timex"
|
"github.com/zeromicro/go-zero/core/timex"
|
||||||
)
|
)
|
||||||
|
|
||||||
// A LessExecutor is an executor to limit execution once within given time interval.
|
// A LessExecutor is an executor to limit execution once within given time interval.
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/tal-tech/go-zero/core/timex"
|
"github.com/zeromicro/go-zero/core/timex"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestLessExecutor_DoOrDiscard(t *testing.T) {
|
func TestLessExecutor_DoOrDiscard(t *testing.T) {
|
||||||
|
|||||||
@@ -6,11 +6,11 @@ import (
|
|||||||
"sync/atomic"
|
"sync/atomic"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/tal-tech/go-zero/core/lang"
|
"github.com/zeromicro/go-zero/core/lang"
|
||||||
"github.com/tal-tech/go-zero/core/proc"
|
"github.com/zeromicro/go-zero/core/proc"
|
||||||
"github.com/tal-tech/go-zero/core/syncx"
|
"github.com/zeromicro/go-zero/core/syncx"
|
||||||
"github.com/tal-tech/go-zero/core/threading"
|
"github.com/zeromicro/go-zero/core/threading"
|
||||||
"github.com/tal-tech/go-zero/core/timex"
|
"github.com/zeromicro/go-zero/core/timex"
|
||||||
)
|
)
|
||||||
|
|
||||||
const idleRound = 10
|
const idleRound = 10
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/tal-tech/go-zero/core/timex"
|
"github.com/zeromicro/go-zero/core/timex"
|
||||||
)
|
)
|
||||||
|
|
||||||
const threshold = 10
|
const threshold = 10
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/tal-tech/go-zero/core/fs"
|
"github.com/zeromicro/go-zero/core/fs"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/tal-tech/go-zero/core/fs"
|
"github.com/zeromicro/go-zero/core/fs"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestSplitLineChunks(t *testing.T) {
|
func TestSplitLineChunks(t *testing.T) {
|
||||||
|
|||||||
@@ -5,6 +5,9 @@ import (
|
|||||||
"os"
|
"os"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// errExceedFileSize indicates that the file size is exceeded.
|
||||||
|
var errExceedFileSize = errors.New("exceed file size")
|
||||||
|
|
||||||
// A RangeReader is used to read a range of content from a file.
|
// A RangeReader is used to read a range of content from a file.
|
||||||
type RangeReader struct {
|
type RangeReader struct {
|
||||||
file *os.File
|
file *os.File
|
||||||
@@ -29,7 +32,7 @@ func (rr *RangeReader) Read(p []byte) (n int, err error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if rr.stop < rr.start || rr.start >= stat.Size() {
|
if rr.stop < rr.start || rr.start >= stat.Size() {
|
||||||
return 0, errors.New("exceed file size")
|
return 0, errExceedFileSize
|
||||||
}
|
}
|
||||||
|
|
||||||
if rr.stop-rr.start < int64(len(p)) {
|
if rr.stop-rr.start < int64(len(p)) {
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/tal-tech/go-zero/core/fs"
|
"github.com/zeromicro/go-zero/core/fs"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestRangeReader(t *testing.T) {
|
func TestRangeReader(t *testing.T) {
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ import (
|
|||||||
"io/ioutil"
|
"io/ioutil"
|
||||||
"os"
|
"os"
|
||||||
|
|
||||||
"github.com/tal-tech/go-zero/core/hash"
|
"github.com/zeromicro/go-zero/core/hash"
|
||||||
)
|
)
|
||||||
|
|
||||||
// TempFileWithText creates the temporary file with the given content,
|
// TempFileWithText creates the temporary file with the given content,
|
||||||
|
|||||||
49
core/fs/temps_test.go
Normal file
49
core/fs/temps_test.go
Normal file
@@ -0,0 +1,49 @@
|
|||||||
|
package fs
|
||||||
|
|
||||||
|
import (
|
||||||
|
"io/ioutil"
|
||||||
|
"os"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestTempFileWithText(t *testing.T) {
|
||||||
|
f, err := TempFileWithText("test")
|
||||||
|
if err != nil {
|
||||||
|
t.Error(err)
|
||||||
|
}
|
||||||
|
if f == nil {
|
||||||
|
t.Error("TempFileWithText returned nil")
|
||||||
|
}
|
||||||
|
if f.Name() == "" {
|
||||||
|
t.Error("TempFileWithText returned empty file name")
|
||||||
|
}
|
||||||
|
defer os.Remove(f.Name())
|
||||||
|
|
||||||
|
bs, err := ioutil.ReadAll(f)
|
||||||
|
assert.Nil(t, err)
|
||||||
|
if len(bs) != 4 {
|
||||||
|
t.Error("TempFileWithText returned wrong file size")
|
||||||
|
}
|
||||||
|
if f.Close() != nil {
|
||||||
|
t.Error("TempFileWithText returned error on close")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTempFilenameWithText(t *testing.T) {
|
||||||
|
f, err := TempFilenameWithText("test")
|
||||||
|
if err != nil {
|
||||||
|
t.Error(err)
|
||||||
|
}
|
||||||
|
if f == "" {
|
||||||
|
t.Error("TempFilenameWithText returned empty file name")
|
||||||
|
}
|
||||||
|
defer os.Remove(f)
|
||||||
|
|
||||||
|
bs, err := ioutil.ReadFile(f)
|
||||||
|
assert.Nil(t, err)
|
||||||
|
if len(bs) != 4 {
|
||||||
|
t.Error("TempFilenameWithText returned wrong file size")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
package fx
|
package fx
|
||||||
|
|
||||||
import "github.com/tal-tech/go-zero/core/threading"
|
import "github.com/zeromicro/go-zero/core/threading"
|
||||||
|
|
||||||
// Parallel runs fns parallelly and waits for done.
|
// Parallel runs fns parallelly and waits for done.
|
||||||
func Parallel(fns ...func()) {
|
func Parallel(fns ...func()) {
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
package fx
|
package fx
|
||||||
|
|
||||||
import "github.com/tal-tech/go-zero/core/errorx"
|
import "github.com/zeromicro/go-zero/core/errorx"
|
||||||
|
|
||||||
const defaultRetryTimes = 3
|
const defaultRetryTimes = 3
|
||||||
|
|
||||||
|
|||||||
@@ -4,9 +4,9 @@ import (
|
|||||||
"sort"
|
"sort"
|
||||||
"sync"
|
"sync"
|
||||||
|
|
||||||
"github.com/tal-tech/go-zero/core/collection"
|
"github.com/zeromicro/go-zero/core/collection"
|
||||||
"github.com/tal-tech/go-zero/core/lang"
|
"github.com/zeromicro/go-zero/core/lang"
|
||||||
"github.com/tal-tech/go-zero/core/threading"
|
"github.com/zeromicro/go-zero/core/threading"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
@@ -90,6 +90,8 @@ func Range(source <-chan interface{}) Stream {
|
|||||||
func (s Stream) AllMach(predicate func(item interface{}) bool) bool {
|
func (s Stream) AllMach(predicate func(item interface{}) bool) bool {
|
||||||
for item := range s.source {
|
for item := range s.source {
|
||||||
if !predicate(item) {
|
if !predicate(item) {
|
||||||
|
// make sure the former goroutine not block, and current func returns fast.
|
||||||
|
go drain(s.source)
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -103,6 +105,8 @@ func (s Stream) AllMach(predicate func(item interface{}) bool) bool {
|
|||||||
func (s Stream) AnyMach(predicate func(item interface{}) bool) bool {
|
func (s Stream) AnyMach(predicate func(item interface{}) bool) bool {
|
||||||
for item := range s.source {
|
for item := range s.source {
|
||||||
if predicate(item) {
|
if predicate(item) {
|
||||||
|
// make sure the former goroutine not block, and current func returns fast.
|
||||||
|
go drain(s.source)
|
||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -186,8 +190,7 @@ func (s Stream) Distinct(fn KeyFunc) Stream {
|
|||||||
|
|
||||||
// Done waits all upstreaming operations to be done.
|
// Done waits all upstreaming operations to be done.
|
||||||
func (s Stream) Done() {
|
func (s Stream) Done() {
|
||||||
for range s.source {
|
drain(s.source)
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Filter filters the items by the given FilterFunc.
|
// Filter filters the items by the given FilterFunc.
|
||||||
@@ -199,9 +202,22 @@ func (s Stream) Filter(fn FilterFunc, opts ...Option) Stream {
|
|||||||
}, opts...)
|
}, opts...)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// First returns the first item, nil if no items.
|
||||||
|
func (s Stream) First() interface{} {
|
||||||
|
for item := range s.source {
|
||||||
|
// make sure the former goroutine not block, and current func returns fast.
|
||||||
|
go drain(s.source)
|
||||||
|
return item
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
// ForAll handles the streaming elements from the source and no later streams.
|
// ForAll handles the streaming elements from the source and no later streams.
|
||||||
func (s Stream) ForAll(fn ForAllFunc) {
|
func (s Stream) ForAll(fn ForAllFunc) {
|
||||||
fn(s.source)
|
fn(s.source)
|
||||||
|
// avoid goroutine leak on fn not consuming all items.
|
||||||
|
go drain(s.source)
|
||||||
}
|
}
|
||||||
|
|
||||||
// ForEach seals the Stream with the ForEachFunc on each item, no successive operations.
|
// ForEach seals the Stream with the ForEachFunc on each item, no successive operations.
|
||||||
@@ -246,11 +262,14 @@ func (s Stream) Head(n int64) Stream {
|
|||||||
}
|
}
|
||||||
if n == 0 {
|
if n == 0 {
|
||||||
// let successive method go ASAP even we have more items to skip
|
// let successive method go ASAP even we have more items to skip
|
||||||
// why we don't just break the loop, because if break,
|
|
||||||
// this former goroutine will block forever, which will cause goroutine leak.
|
|
||||||
close(source)
|
close(source)
|
||||||
|
// why we don't just break the loop, and drain to consume all items.
|
||||||
|
// because if breaks, this former goroutine will block forever,
|
||||||
|
// which will cause goroutine leak.
|
||||||
|
drain(s.source)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
// not enough items in s.source, but we need to let successive method to go ASAP.
|
||||||
if n > 0 {
|
if n > 0 {
|
||||||
close(source)
|
close(source)
|
||||||
}
|
}
|
||||||
@@ -259,6 +278,13 @@ func (s Stream) Head(n int64) Stream {
|
|||||||
return Range(source)
|
return Range(source)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Last returns the last item, or nil if no items.
|
||||||
|
func (s Stream) Last() (item interface{}) {
|
||||||
|
for item = range s.source {
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
// Map converts each item to another corresponding item, which means it's a 1:1 model.
|
// Map converts each item to another corresponding item, which means it's a 1:1 model.
|
||||||
func (s Stream) Map(fn MapFunc, opts ...Option) Stream {
|
func (s Stream) Map(fn MapFunc, opts ...Option) Stream {
|
||||||
return s.Walk(func(item interface{}, pipe chan<- interface{}) {
|
return s.Walk(func(item interface{}, pipe chan<- interface{}) {
|
||||||
@@ -280,6 +306,21 @@ func (s Stream) Merge() Stream {
|
|||||||
return Range(source)
|
return Range(source)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// NoneMatch returns whether all elements of this stream don't match the provided predicate.
|
||||||
|
// May not evaluate the predicate on all elements if not necessary for determining the result.
|
||||||
|
// If the stream is empty then true is returned and the predicate is not evaluated.
|
||||||
|
func (s Stream) NoneMatch(predicate func(item interface{}) bool) bool {
|
||||||
|
for item := range s.source {
|
||||||
|
if predicate(item) {
|
||||||
|
// make sure the former goroutine not block, and current func returns fast.
|
||||||
|
go drain(s.source)
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
// Parallel applies the given ParallelFunc to each item concurrently with given number of workers.
|
// Parallel applies the given ParallelFunc to each item concurrently with given number of workers.
|
||||||
func (s Stream) Parallel(fn ParallelFunc, opts ...Option) {
|
func (s Stream) Parallel(fn ParallelFunc, opts ...Option) {
|
||||||
s.Walk(func(item interface{}, pipe chan<- interface{}) {
|
s.Walk(func(item interface{}, pipe chan<- interface{}) {
|
||||||
@@ -411,15 +452,12 @@ func (s Stream) walkLimited(fn WalkFunc, option *rxOptions) Stream {
|
|||||||
var wg sync.WaitGroup
|
var wg sync.WaitGroup
|
||||||
pool := make(chan lang.PlaceholderType, option.workers)
|
pool := make(chan lang.PlaceholderType, option.workers)
|
||||||
|
|
||||||
for {
|
for item := range s.source {
|
||||||
|
// important, used in another goroutine
|
||||||
|
val := item
|
||||||
pool <- lang.Placeholder
|
pool <- lang.Placeholder
|
||||||
item, ok := <-s.source
|
|
||||||
if !ok {
|
|
||||||
<-pool
|
|
||||||
break
|
|
||||||
}
|
|
||||||
|
|
||||||
wg.Add(1)
|
wg.Add(1)
|
||||||
|
|
||||||
// better to safely run caller defined method
|
// better to safely run caller defined method
|
||||||
threading.GoSafe(func() {
|
threading.GoSafe(func() {
|
||||||
defer func() {
|
defer func() {
|
||||||
@@ -427,7 +465,7 @@ func (s Stream) walkLimited(fn WalkFunc, option *rxOptions) Stream {
|
|||||||
<-pool
|
<-pool
|
||||||
}()
|
}()
|
||||||
|
|
||||||
fn(item, pipe)
|
fn(val, pipe)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -439,22 +477,19 @@ func (s Stream) walkLimited(fn WalkFunc, option *rxOptions) Stream {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (s Stream) walkUnlimited(fn WalkFunc, option *rxOptions) Stream {
|
func (s Stream) walkUnlimited(fn WalkFunc, option *rxOptions) Stream {
|
||||||
pipe := make(chan interface{}, defaultWorkers)
|
pipe := make(chan interface{}, option.workers)
|
||||||
|
|
||||||
go func() {
|
go func() {
|
||||||
var wg sync.WaitGroup
|
var wg sync.WaitGroup
|
||||||
|
|
||||||
for {
|
for item := range s.source {
|
||||||
item, ok := <-s.source
|
// important, used in another goroutine
|
||||||
if !ok {
|
val := item
|
||||||
break
|
|
||||||
}
|
|
||||||
|
|
||||||
wg.Add(1)
|
wg.Add(1)
|
||||||
// better to safely run caller defined method
|
// better to safely run caller defined method
|
||||||
threading.GoSafe(func() {
|
threading.GoSafe(func() {
|
||||||
defer wg.Done()
|
defer wg.Done()
|
||||||
fn(item, pipe)
|
fn(val, pipe)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -465,14 +500,14 @@ func (s Stream) walkUnlimited(fn WalkFunc, option *rxOptions) Stream {
|
|||||||
return Range(pipe)
|
return Range(pipe)
|
||||||
}
|
}
|
||||||
|
|
||||||
// UnlimitedWorkers lets the caller to use as many workers as the tasks.
|
// UnlimitedWorkers lets the caller use as many workers as the tasks.
|
||||||
func UnlimitedWorkers() Option {
|
func UnlimitedWorkers() Option {
|
||||||
return func(opts *rxOptions) {
|
return func(opts *rxOptions) {
|
||||||
opts.unlimitedWorkers = true
|
opts.unlimitedWorkers = true
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// WithWorkers lets the caller to customize the concurrent workers.
|
// WithWorkers lets the caller customize the concurrent workers.
|
||||||
func WithWorkers(workers int) Option {
|
func WithWorkers(workers int) Option {
|
||||||
return func(opts *rxOptions) {
|
return func(opts *rxOptions) {
|
||||||
if workers < minWorkers {
|
if workers < minWorkers {
|
||||||
@@ -483,6 +518,7 @@ func WithWorkers(workers int) Option {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// buildOptions returns a rxOptions with given customizations.
|
||||||
func buildOptions(opts ...Option) *rxOptions {
|
func buildOptions(opts ...Option) *rxOptions {
|
||||||
options := newOptions()
|
options := newOptions()
|
||||||
for _, opt := range opts {
|
for _, opt := range opts {
|
||||||
@@ -492,6 +528,13 @@ func buildOptions(opts ...Option) *rxOptions {
|
|||||||
return options
|
return options
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// drain drains the given channel.
|
||||||
|
func drain(channel <-chan interface{}) {
|
||||||
|
for range channel {
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// newOptions returns a default rxOptions.
|
||||||
func newOptions() *rxOptions {
|
func newOptions() *rxOptions {
|
||||||
return &rxOptions{
|
return &rxOptions{
|
||||||
workers: defaultWorkers,
|
workers: defaultWorkers,
|
||||||
|
|||||||
@@ -13,324 +13,494 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/tal-tech/go-zero/core/stringx"
|
"github.com/zeromicro/go-zero/core/stringx"
|
||||||
|
"go.uber.org/goleak"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestBuffer(t *testing.T) {
|
func TestBuffer(t *testing.T) {
|
||||||
const N = 5
|
runCheckedTest(t, func(t *testing.T) {
|
||||||
var count int32
|
const N = 5
|
||||||
var wait sync.WaitGroup
|
var count int32
|
||||||
wait.Add(1)
|
var wait sync.WaitGroup
|
||||||
From(func(source chan<- interface{}) {
|
wait.Add(1)
|
||||||
ticker := time.NewTicker(10 * time.Millisecond)
|
From(func(source chan<- interface{}) {
|
||||||
defer ticker.Stop()
|
ticker := time.NewTicker(10 * time.Millisecond)
|
||||||
|
defer ticker.Stop()
|
||||||
|
|
||||||
for i := 0; i < 2*N; i++ {
|
for i := 0; i < 2*N; i++ {
|
||||||
select {
|
select {
|
||||||
case source <- i:
|
case source <- i:
|
||||||
atomic.AddInt32(&count, 1)
|
atomic.AddInt32(&count, 1)
|
||||||
case <-ticker.C:
|
case <-ticker.C:
|
||||||
wait.Done()
|
wait.Done()
|
||||||
return
|
return
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}).Buffer(N).ForAll(func(pipe <-chan interface{}) {
|
||||||
}).Buffer(N).ForAll(func(pipe <-chan interface{}) {
|
wait.Wait()
|
||||||
wait.Wait()
|
// why N+1, because take one more to wait for sending into the channel
|
||||||
// why N+1, because take one more to wait for sending into the channel
|
assert.Equal(t, int32(N+1), atomic.LoadInt32(&count))
|
||||||
assert.Equal(t, int32(N+1), atomic.LoadInt32(&count))
|
})
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestBufferNegative(t *testing.T) {
|
func TestBufferNegative(t *testing.T) {
|
||||||
var result int
|
runCheckedTest(t, func(t *testing.T) {
|
||||||
Just(1, 2, 3, 4).Buffer(-1).Reduce(func(pipe <-chan interface{}) (interface{}, error) {
|
var result int
|
||||||
for item := range pipe {
|
Just(1, 2, 3, 4).Buffer(-1).Reduce(func(pipe <-chan interface{}) (interface{}, error) {
|
||||||
result += item.(int)
|
for item := range pipe {
|
||||||
}
|
result += item.(int)
|
||||||
return result, nil
|
}
|
||||||
|
return result, nil
|
||||||
|
})
|
||||||
|
assert.Equal(t, 10, result)
|
||||||
})
|
})
|
||||||
assert.Equal(t, 10, result)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestCount(t *testing.T) {
|
func TestCount(t *testing.T) {
|
||||||
tests := []struct {
|
runCheckedTest(t, func(t *testing.T) {
|
||||||
name string
|
tests := []struct {
|
||||||
elements []interface{}
|
name string
|
||||||
}{
|
elements []interface{}
|
||||||
{
|
}{
|
||||||
name: "no elements with nil",
|
{
|
||||||
},
|
name: "no elements with nil",
|
||||||
{
|
},
|
||||||
name: "no elements",
|
{
|
||||||
elements: []interface{}{},
|
name: "no elements",
|
||||||
},
|
elements: []interface{}{},
|
||||||
{
|
},
|
||||||
name: "1 element",
|
{
|
||||||
elements: []interface{}{1},
|
name: "1 element",
|
||||||
},
|
elements: []interface{}{1},
|
||||||
{
|
},
|
||||||
name: "multiple elements",
|
{
|
||||||
elements: []interface{}{1, 2, 3},
|
name: "multiple elements",
|
||||||
},
|
elements: []interface{}{1, 2, 3},
|
||||||
}
|
},
|
||||||
|
}
|
||||||
|
|
||||||
for _, test := range tests {
|
for _, test := range tests {
|
||||||
t.Run(test.name, func(t *testing.T) {
|
t.Run(test.name, func(t *testing.T) {
|
||||||
val := Just(test.elements...).Count()
|
val := Just(test.elements...).Count()
|
||||||
assert.Equal(t, len(test.elements), val)
|
assert.Equal(t, len(test.elements), val)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestDone(t *testing.T) {
|
func TestDone(t *testing.T) {
|
||||||
var count int32
|
runCheckedTest(t, func(t *testing.T) {
|
||||||
Just(1, 2, 3).Walk(func(item interface{}, pipe chan<- interface{}) {
|
var count int32
|
||||||
time.Sleep(time.Millisecond * 100)
|
Just(1, 2, 3).Walk(func(item interface{}, pipe chan<- interface{}) {
|
||||||
atomic.AddInt32(&count, int32(item.(int)))
|
time.Sleep(time.Millisecond * 100)
|
||||||
}).Done()
|
atomic.AddInt32(&count, int32(item.(int)))
|
||||||
assert.Equal(t, int32(6), count)
|
}).Done()
|
||||||
|
assert.Equal(t, int32(6), count)
|
||||||
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestJust(t *testing.T) {
|
func TestJust(t *testing.T) {
|
||||||
var result int
|
runCheckedTest(t, func(t *testing.T) {
|
||||||
Just(1, 2, 3, 4).Reduce(func(pipe <-chan interface{}) (interface{}, error) {
|
var result int
|
||||||
for item := range pipe {
|
Just(1, 2, 3, 4).Reduce(func(pipe <-chan interface{}) (interface{}, error) {
|
||||||
result += item.(int)
|
for item := range pipe {
|
||||||
}
|
result += item.(int)
|
||||||
return result, nil
|
}
|
||||||
|
return result, nil
|
||||||
|
})
|
||||||
|
assert.Equal(t, 10, result)
|
||||||
})
|
})
|
||||||
assert.Equal(t, 10, result)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestDistinct(t *testing.T) {
|
func TestDistinct(t *testing.T) {
|
||||||
var result int
|
runCheckedTest(t, func(t *testing.T) {
|
||||||
Just(4, 1, 3, 2, 3, 4).Distinct(func(item interface{}) interface{} {
|
var result int
|
||||||
return item
|
Just(4, 1, 3, 2, 3, 4).Distinct(func(item interface{}) interface{} {
|
||||||
}).Reduce(func(pipe <-chan interface{}) (interface{}, error) {
|
return item
|
||||||
for item := range pipe {
|
}).Reduce(func(pipe <-chan interface{}) (interface{}, error) {
|
||||||
result += item.(int)
|
for item := range pipe {
|
||||||
}
|
result += item.(int)
|
||||||
return result, nil
|
}
|
||||||
|
return result, nil
|
||||||
|
})
|
||||||
|
assert.Equal(t, 10, result)
|
||||||
})
|
})
|
||||||
assert.Equal(t, 10, result)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestFilter(t *testing.T) {
|
func TestFilter(t *testing.T) {
|
||||||
var result int
|
runCheckedTest(t, func(t *testing.T) {
|
||||||
Just(1, 2, 3, 4).Filter(func(item interface{}) bool {
|
var result int
|
||||||
return item.(int)%2 == 0
|
Just(1, 2, 3, 4).Filter(func(item interface{}) bool {
|
||||||
}).Reduce(func(pipe <-chan interface{}) (interface{}, error) {
|
return item.(int)%2 == 0
|
||||||
for item := range pipe {
|
}).Reduce(func(pipe <-chan interface{}) (interface{}, error) {
|
||||||
result += item.(int)
|
for item := range pipe {
|
||||||
}
|
result += item.(int)
|
||||||
return result, nil
|
}
|
||||||
|
return result, nil
|
||||||
|
})
|
||||||
|
assert.Equal(t, 6, result)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFirst(t *testing.T) {
|
||||||
|
runCheckedTest(t, func(t *testing.T) {
|
||||||
|
assert.Nil(t, Just().First())
|
||||||
|
assert.Equal(t, "foo", Just("foo").First())
|
||||||
|
assert.Equal(t, "foo", Just("foo", "bar").First())
|
||||||
})
|
})
|
||||||
assert.Equal(t, 6, result)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestForAll(t *testing.T) {
|
func TestForAll(t *testing.T) {
|
||||||
var result int
|
runCheckedTest(t, func(t *testing.T) {
|
||||||
Just(1, 2, 3, 4).Filter(func(item interface{}) bool {
|
var result int
|
||||||
return item.(int)%2 == 0
|
Just(1, 2, 3, 4).Filter(func(item interface{}) bool {
|
||||||
}).ForAll(func(pipe <-chan interface{}) {
|
return item.(int)%2 == 0
|
||||||
for item := range pipe {
|
}).ForAll(func(pipe <-chan interface{}) {
|
||||||
result += item.(int)
|
for item := range pipe {
|
||||||
}
|
result += item.(int)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
assert.Equal(t, 6, result)
|
||||||
})
|
})
|
||||||
assert.Equal(t, 6, result)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestGroup(t *testing.T) {
|
func TestGroup(t *testing.T) {
|
||||||
var groups [][]int
|
runCheckedTest(t, func(t *testing.T) {
|
||||||
Just(10, 11, 20, 21).Group(func(item interface{}) interface{} {
|
var groups [][]int
|
||||||
v := item.(int)
|
Just(10, 11, 20, 21).Group(func(item interface{}) interface{} {
|
||||||
return v / 10
|
v := item.(int)
|
||||||
}).ForEach(func(item interface{}) {
|
return v / 10
|
||||||
v := item.([]interface{})
|
}).ForEach(func(item interface{}) {
|
||||||
var group []int
|
v := item.([]interface{})
|
||||||
for _, each := range v {
|
var group []int
|
||||||
group = append(group, each.(int))
|
for _, each := range v {
|
||||||
}
|
group = append(group, each.(int))
|
||||||
groups = append(groups, group)
|
}
|
||||||
})
|
groups = append(groups, group)
|
||||||
|
})
|
||||||
|
|
||||||
assert.Equal(t, 2, len(groups))
|
assert.Equal(t, 2, len(groups))
|
||||||
for _, group := range groups {
|
for _, group := range groups {
|
||||||
assert.Equal(t, 2, len(group))
|
assert.Equal(t, 2, len(group))
|
||||||
assert.True(t, group[0]/10 == group[1]/10)
|
assert.True(t, group[0]/10 == group[1]/10)
|
||||||
}
|
}
|
||||||
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestHead(t *testing.T) {
|
func TestHead(t *testing.T) {
|
||||||
var result int
|
runCheckedTest(t, func(t *testing.T) {
|
||||||
Just(1, 2, 3, 4).Head(2).Reduce(func(pipe <-chan interface{}) (interface{}, error) {
|
var result int
|
||||||
for item := range pipe {
|
Just(1, 2, 3, 4).Head(2).Reduce(func(pipe <-chan interface{}) (interface{}, error) {
|
||||||
result += item.(int)
|
for item := range pipe {
|
||||||
}
|
result += item.(int)
|
||||||
return result, nil
|
}
|
||||||
|
return result, nil
|
||||||
|
})
|
||||||
|
assert.Equal(t, 3, result)
|
||||||
})
|
})
|
||||||
assert.Equal(t, 3, result)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestHeadZero(t *testing.T) {
|
func TestHeadZero(t *testing.T) {
|
||||||
assert.Panics(t, func() {
|
runCheckedTest(t, func(t *testing.T) {
|
||||||
Just(1, 2, 3, 4).Head(0).Reduce(func(pipe <-chan interface{}) (interface{}, error) {
|
assert.Panics(t, func() {
|
||||||
return nil, nil
|
Just(1, 2, 3, 4).Head(0).Reduce(func(pipe <-chan interface{}) (interface{}, error) {
|
||||||
|
return nil, nil
|
||||||
|
})
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestHeadMore(t *testing.T) {
|
func TestHeadMore(t *testing.T) {
|
||||||
var result int
|
runCheckedTest(t, func(t *testing.T) {
|
||||||
Just(1, 2, 3, 4).Head(6).Reduce(func(pipe <-chan interface{}) (interface{}, error) {
|
var result int
|
||||||
for item := range pipe {
|
Just(1, 2, 3, 4).Head(6).Reduce(func(pipe <-chan interface{}) (interface{}, error) {
|
||||||
result += item.(int)
|
for item := range pipe {
|
||||||
}
|
result += item.(int)
|
||||||
return result, nil
|
}
|
||||||
|
return result, nil
|
||||||
|
})
|
||||||
|
assert.Equal(t, 10, result)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLast(t *testing.T) {
|
||||||
|
runCheckedTest(t, func(t *testing.T) {
|
||||||
|
goroutines := runtime.NumGoroutine()
|
||||||
|
assert.Nil(t, Just().Last())
|
||||||
|
assert.Equal(t, "foo", Just("foo").Last())
|
||||||
|
assert.Equal(t, "bar", Just("foo", "bar").Last())
|
||||||
|
// let scheduler schedule first
|
||||||
|
runtime.Gosched()
|
||||||
|
assert.Equal(t, goroutines, runtime.NumGoroutine())
|
||||||
})
|
})
|
||||||
assert.Equal(t, 10, result)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestMap(t *testing.T) {
|
func TestMap(t *testing.T) {
|
||||||
log.SetOutput(ioutil.Discard)
|
runCheckedTest(t, func(t *testing.T) {
|
||||||
|
log.SetOutput(ioutil.Discard)
|
||||||
|
|
||||||
tests := []struct {
|
tests := []struct {
|
||||||
mapper MapFunc
|
mapper MapFunc
|
||||||
expect int
|
expect int
|
||||||
}{
|
}{
|
||||||
{
|
{
|
||||||
mapper: func(item interface{}) interface{} {
|
mapper: func(item interface{}) interface{} {
|
||||||
v := item.(int)
|
v := item.(int)
|
||||||
return v * v
|
return v * v
|
||||||
|
},
|
||||||
|
expect: 30,
|
||||||
},
|
},
|
||||||
expect: 30,
|
{
|
||||||
},
|
mapper: func(item interface{}) interface{} {
|
||||||
{
|
v := item.(int)
|
||||||
mapper: func(item interface{}) interface{} {
|
if v%2 == 0 {
|
||||||
v := item.(int)
|
return 0
|
||||||
if v%2 == 0 {
|
|
||||||
return 0
|
|
||||||
}
|
|
||||||
return v * v
|
|
||||||
},
|
|
||||||
expect: 10,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
mapper: func(item interface{}) interface{} {
|
|
||||||
v := item.(int)
|
|
||||||
if v%2 == 0 {
|
|
||||||
panic(v)
|
|
||||||
}
|
|
||||||
return v * v
|
|
||||||
},
|
|
||||||
expect: 10,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
// Map(...) works even WithWorkers(0)
|
|
||||||
for i, test := range tests {
|
|
||||||
t.Run(stringx.Rand(), func(t *testing.T) {
|
|
||||||
var result int
|
|
||||||
var workers int
|
|
||||||
if i%2 == 0 {
|
|
||||||
workers = 0
|
|
||||||
} else {
|
|
||||||
workers = runtime.NumCPU()
|
|
||||||
}
|
|
||||||
From(func(source chan<- interface{}) {
|
|
||||||
for i := 1; i < 5; i++ {
|
|
||||||
source <- i
|
|
||||||
}
|
|
||||||
}).Map(test.mapper, WithWorkers(workers)).Reduce(
|
|
||||||
func(pipe <-chan interface{}) (interface{}, error) {
|
|
||||||
for item := range pipe {
|
|
||||||
result += item.(int)
|
|
||||||
}
|
}
|
||||||
return result, nil
|
return v * v
|
||||||
})
|
},
|
||||||
|
expect: 10,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
mapper: func(item interface{}) interface{} {
|
||||||
|
v := item.(int)
|
||||||
|
if v%2 == 0 {
|
||||||
|
panic(v)
|
||||||
|
}
|
||||||
|
return v * v
|
||||||
|
},
|
||||||
|
expect: 10,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
assert.Equal(t, test.expect, result)
|
// Map(...) works even WithWorkers(0)
|
||||||
})
|
for i, test := range tests {
|
||||||
}
|
t.Run(stringx.Rand(), func(t *testing.T) {
|
||||||
|
var result int
|
||||||
|
var workers int
|
||||||
|
if i%2 == 0 {
|
||||||
|
workers = 0
|
||||||
|
} else {
|
||||||
|
workers = runtime.NumCPU()
|
||||||
|
}
|
||||||
|
From(func(source chan<- interface{}) {
|
||||||
|
for i := 1; i < 5; i++ {
|
||||||
|
source <- i
|
||||||
|
}
|
||||||
|
}).Map(test.mapper, WithWorkers(workers)).Reduce(
|
||||||
|
func(pipe <-chan interface{}) (interface{}, error) {
|
||||||
|
for item := range pipe {
|
||||||
|
result += item.(int)
|
||||||
|
}
|
||||||
|
return result, nil
|
||||||
|
})
|
||||||
|
|
||||||
|
assert.Equal(t, test.expect, result)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestMerge(t *testing.T) {
|
func TestMerge(t *testing.T) {
|
||||||
Just(1, 2, 3, 4).Merge().ForEach(func(item interface{}) {
|
runCheckedTest(t, func(t *testing.T) {
|
||||||
assert.ElementsMatch(t, []interface{}{1, 2, 3, 4}, item.([]interface{}))
|
Just(1, 2, 3, 4).Merge().ForEach(func(item interface{}) {
|
||||||
|
assert.ElementsMatch(t, []interface{}{1, 2, 3, 4}, item.([]interface{}))
|
||||||
|
})
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestParallelJust(t *testing.T) {
|
func TestParallelJust(t *testing.T) {
|
||||||
var count int32
|
runCheckedTest(t, func(t *testing.T) {
|
||||||
Just(1, 2, 3).Parallel(func(item interface{}) {
|
var count int32
|
||||||
time.Sleep(time.Millisecond * 100)
|
Just(1, 2, 3).Parallel(func(item interface{}) {
|
||||||
atomic.AddInt32(&count, int32(item.(int)))
|
time.Sleep(time.Millisecond * 100)
|
||||||
}, UnlimitedWorkers())
|
atomic.AddInt32(&count, int32(item.(int)))
|
||||||
assert.Equal(t, int32(6), count)
|
}, UnlimitedWorkers())
|
||||||
|
assert.Equal(t, int32(6), count)
|
||||||
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestReverse(t *testing.T) {
|
func TestReverse(t *testing.T) {
|
||||||
Just(1, 2, 3, 4).Reverse().Merge().ForEach(func(item interface{}) {
|
runCheckedTest(t, func(t *testing.T) {
|
||||||
assert.ElementsMatch(t, []interface{}{4, 3, 2, 1}, item.([]interface{}))
|
Just(1, 2, 3, 4).Reverse().Merge().ForEach(func(item interface{}) {
|
||||||
|
assert.ElementsMatch(t, []interface{}{4, 3, 2, 1}, item.([]interface{}))
|
||||||
|
})
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestSort(t *testing.T) {
|
func TestSort(t *testing.T) {
|
||||||
var prev int
|
runCheckedTest(t, func(t *testing.T) {
|
||||||
Just(5, 3, 7, 1, 9, 6, 4, 8, 2).Sort(func(a, b interface{}) bool {
|
var prev int
|
||||||
return a.(int) < b.(int)
|
Just(5, 3, 7, 1, 9, 6, 4, 8, 2).Sort(func(a, b interface{}) bool {
|
||||||
}).ForEach(func(item interface{}) {
|
return a.(int) < b.(int)
|
||||||
next := item.(int)
|
}).ForEach(func(item interface{}) {
|
||||||
assert.True(t, prev < next)
|
next := item.(int)
|
||||||
prev = next
|
assert.True(t, prev < next)
|
||||||
|
prev = next
|
||||||
|
})
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestSplit(t *testing.T) {
|
func TestSplit(t *testing.T) {
|
||||||
assert.Panics(t, func() {
|
runCheckedTest(t, func(t *testing.T) {
|
||||||
Just(1, 2, 3, 4, 5, 6, 7, 8, 9, 10).Split(0).Done()
|
assert.Panics(t, func() {
|
||||||
|
Just(1, 2, 3, 4, 5, 6, 7, 8, 9, 10).Split(0).Done()
|
||||||
|
})
|
||||||
|
var chunks [][]interface{}
|
||||||
|
Just(1, 2, 3, 4, 5, 6, 7, 8, 9, 10).Split(4).ForEach(func(item interface{}) {
|
||||||
|
chunk := item.([]interface{})
|
||||||
|
chunks = append(chunks, chunk)
|
||||||
|
})
|
||||||
|
assert.EqualValues(t, [][]interface{}{
|
||||||
|
{1, 2, 3, 4},
|
||||||
|
{5, 6, 7, 8},
|
||||||
|
{9, 10},
|
||||||
|
}, chunks)
|
||||||
})
|
})
|
||||||
var chunks [][]interface{}
|
|
||||||
Just(1, 2, 3, 4, 5, 6, 7, 8, 9, 10).Split(4).ForEach(func(item interface{}) {
|
|
||||||
chunk := item.([]interface{})
|
|
||||||
chunks = append(chunks, chunk)
|
|
||||||
})
|
|
||||||
assert.EqualValues(t, [][]interface{}{
|
|
||||||
{1, 2, 3, 4},
|
|
||||||
{5, 6, 7, 8},
|
|
||||||
{9, 10},
|
|
||||||
}, chunks)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestTail(t *testing.T) {
|
func TestTail(t *testing.T) {
|
||||||
var result int
|
runCheckedTest(t, func(t *testing.T) {
|
||||||
Just(1, 2, 3, 4).Tail(2).Reduce(func(pipe <-chan interface{}) (interface{}, error) {
|
var result int
|
||||||
for item := range pipe {
|
Just(1, 2, 3, 4).Tail(2).Reduce(func(pipe <-chan interface{}) (interface{}, error) {
|
||||||
result += item.(int)
|
for item := range pipe {
|
||||||
}
|
result += item.(int)
|
||||||
return result, nil
|
}
|
||||||
|
return result, nil
|
||||||
|
})
|
||||||
|
assert.Equal(t, 7, result)
|
||||||
})
|
})
|
||||||
assert.Equal(t, 7, result)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestTailZero(t *testing.T) {
|
func TestTailZero(t *testing.T) {
|
||||||
assert.Panics(t, func() {
|
runCheckedTest(t, func(t *testing.T) {
|
||||||
Just(1, 2, 3, 4).Tail(0).Reduce(func(pipe <-chan interface{}) (interface{}, error) {
|
assert.Panics(t, func() {
|
||||||
return nil, nil
|
Just(1, 2, 3, 4).Tail(0).Reduce(func(pipe <-chan interface{}) (interface{}, error) {
|
||||||
|
return nil, nil
|
||||||
|
})
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestWalk(t *testing.T) {
|
func TestWalk(t *testing.T) {
|
||||||
var result int
|
runCheckedTest(t, func(t *testing.T) {
|
||||||
Just(1, 2, 3, 4, 5).Walk(func(item interface{}, pipe chan<- interface{}) {
|
var result int
|
||||||
if item.(int)%2 != 0 {
|
Just(1, 2, 3, 4, 5).Walk(func(item interface{}, pipe chan<- interface{}) {
|
||||||
pipe <- item
|
if item.(int)%2 != 0 {
|
||||||
}
|
pipe <- item
|
||||||
}, UnlimitedWorkers()).ForEach(func(item interface{}) {
|
}
|
||||||
result += item.(int)
|
}, UnlimitedWorkers()).ForEach(func(item interface{}) {
|
||||||
|
result += item.(int)
|
||||||
|
})
|
||||||
|
assert.Equal(t, 9, result)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestStream_AnyMach(t *testing.T) {
|
||||||
|
runCheckedTest(t, func(t *testing.T) {
|
||||||
|
assetEqual(t, false, Just(1, 2, 3).AnyMach(func(item interface{}) bool {
|
||||||
|
return item.(int) == 4
|
||||||
|
}))
|
||||||
|
assetEqual(t, false, Just(1, 2, 3).AnyMach(func(item interface{}) bool {
|
||||||
|
return item.(int) == 0
|
||||||
|
}))
|
||||||
|
assetEqual(t, true, Just(1, 2, 3).AnyMach(func(item interface{}) bool {
|
||||||
|
return item.(int) == 2
|
||||||
|
}))
|
||||||
|
assetEqual(t, true, Just(1, 2, 3).AnyMach(func(item interface{}) bool {
|
||||||
|
return item.(int) == 2
|
||||||
|
}))
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestStream_AllMach(t *testing.T) {
|
||||||
|
runCheckedTest(t, func(t *testing.T) {
|
||||||
|
assetEqual(
|
||||||
|
t, true, Just(1, 2, 3).AllMach(func(item interface{}) bool {
|
||||||
|
return true
|
||||||
|
}),
|
||||||
|
)
|
||||||
|
assetEqual(
|
||||||
|
t, false, Just(1, 2, 3).AllMach(func(item interface{}) bool {
|
||||||
|
return false
|
||||||
|
}),
|
||||||
|
)
|
||||||
|
assetEqual(
|
||||||
|
t, false, Just(1, 2, 3).AllMach(func(item interface{}) bool {
|
||||||
|
return item.(int) == 1
|
||||||
|
}),
|
||||||
|
)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestStream_NoneMatch(t *testing.T) {
|
||||||
|
runCheckedTest(t, func(t *testing.T) {
|
||||||
|
assetEqual(
|
||||||
|
t, true, Just(1, 2, 3).NoneMatch(func(item interface{}) bool {
|
||||||
|
return false
|
||||||
|
}),
|
||||||
|
)
|
||||||
|
assetEqual(
|
||||||
|
t, false, Just(1, 2, 3).NoneMatch(func(item interface{}) bool {
|
||||||
|
return true
|
||||||
|
}),
|
||||||
|
)
|
||||||
|
assetEqual(
|
||||||
|
t, true, Just(1, 2, 3).NoneMatch(func(item interface{}) bool {
|
||||||
|
return item.(int) == 4
|
||||||
|
}),
|
||||||
|
)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestConcat(t *testing.T) {
|
||||||
|
runCheckedTest(t, func(t *testing.T) {
|
||||||
|
a1 := []interface{}{1, 2, 3}
|
||||||
|
a2 := []interface{}{4, 5, 6}
|
||||||
|
s1 := Just(a1...)
|
||||||
|
s2 := Just(a2...)
|
||||||
|
stream := Concat(s1, s2)
|
||||||
|
var items []interface{}
|
||||||
|
for item := range stream.source {
|
||||||
|
items = append(items, item)
|
||||||
|
}
|
||||||
|
sort.Slice(items, func(i, j int) bool {
|
||||||
|
return items[i].(int) < items[j].(int)
|
||||||
|
})
|
||||||
|
ints := make([]interface{}, 0)
|
||||||
|
ints = append(ints, a1...)
|
||||||
|
ints = append(ints, a2...)
|
||||||
|
assetEqual(t, ints, items)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestStream_Skip(t *testing.T) {
|
||||||
|
runCheckedTest(t, func(t *testing.T) {
|
||||||
|
assetEqual(t, 3, Just(1, 2, 3, 4).Skip(1).Count())
|
||||||
|
assetEqual(t, 1, Just(1, 2, 3, 4).Skip(3).Count())
|
||||||
|
assetEqual(t, 4, Just(1, 2, 3, 4).Skip(0).Count())
|
||||||
|
equal(t, Just(1, 2, 3, 4).Skip(3), []interface{}{4})
|
||||||
|
assert.Panics(t, func() {
|
||||||
|
Just(1, 2, 3, 4).Skip(-1)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestStream_Concat(t *testing.T) {
|
||||||
|
runCheckedTest(t, func(t *testing.T) {
|
||||||
|
stream := Just(1).Concat(Just(2), Just(3))
|
||||||
|
var items []interface{}
|
||||||
|
for item := range stream.source {
|
||||||
|
items = append(items, item)
|
||||||
|
}
|
||||||
|
sort.Slice(items, func(i, j int) bool {
|
||||||
|
return items[i].(int) < items[j].(int)
|
||||||
|
})
|
||||||
|
assetEqual(t, []interface{}{1, 2, 3}, items)
|
||||||
|
|
||||||
|
just := Just(1)
|
||||||
|
equal(t, just.Concat(just), []interface{}{1})
|
||||||
})
|
})
|
||||||
assert.Equal(t, 9, result)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func BenchmarkParallelMapReduce(b *testing.B) {
|
func BenchmarkParallelMapReduce(b *testing.B) {
|
||||||
@@ -377,6 +547,12 @@ func BenchmarkMapReduce(b *testing.B) {
|
|||||||
}).Map(mapper).Reduce(reducer)
|
}).Map(mapper).Reduce(reducer)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func assetEqual(t *testing.T, except, data interface{}) {
|
||||||
|
if !reflect.DeepEqual(except, data) {
|
||||||
|
t.Errorf(" %v, want %v", data, except)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func equal(t *testing.T, stream Stream, data []interface{}) {
|
func equal(t *testing.T, stream Stream, data []interface{}) {
|
||||||
items := make([]interface{}, 0)
|
items := make([]interface{}, 0)
|
||||||
for item := range stream.source {
|
for item := range stream.source {
|
||||||
@@ -387,85 +563,7 @@ func equal(t *testing.T, stream Stream, data []interface{}) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func assetEqual(t *testing.T, except, data interface{}) {
|
func runCheckedTest(t *testing.T, fn func(t *testing.T)) {
|
||||||
if !reflect.DeepEqual(except, data) {
|
defer goleak.VerifyNone(t)
|
||||||
t.Errorf(" %v, want %v", data, except)
|
fn(t)
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestStream_AnyMach(t *testing.T) {
|
|
||||||
assetEqual(t, false, Just(1, 2, 3).AnyMach(func(item interface{}) bool {
|
|
||||||
return item.(int) == 4
|
|
||||||
}))
|
|
||||||
assetEqual(t, false, Just(1, 2, 3).AnyMach(func(item interface{}) bool {
|
|
||||||
return item.(int) == 0
|
|
||||||
}))
|
|
||||||
assetEqual(t, true, Just(1, 2, 3).AnyMach(func(item interface{}) bool {
|
|
||||||
return item.(int) == 2
|
|
||||||
}))
|
|
||||||
assetEqual(t, true, Just(1, 2, 3).AnyMach(func(item interface{}) bool {
|
|
||||||
return item.(int) == 2
|
|
||||||
}))
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestStream_AllMach(t *testing.T) {
|
|
||||||
assetEqual(
|
|
||||||
t, true, Just(1, 2, 3).AllMach(func(item interface{}) bool {
|
|
||||||
return true
|
|
||||||
}),
|
|
||||||
)
|
|
||||||
assetEqual(
|
|
||||||
t, false, Just(1, 2, 3).AllMach(func(item interface{}) bool {
|
|
||||||
return false
|
|
||||||
}),
|
|
||||||
)
|
|
||||||
assetEqual(
|
|
||||||
t, false, Just(1, 2, 3).AllMach(func(item interface{}) bool {
|
|
||||||
return item.(int) == 1
|
|
||||||
}),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestConcat(t *testing.T) {
|
|
||||||
a1 := []interface{}{1, 2, 3}
|
|
||||||
a2 := []interface{}{4, 5, 6}
|
|
||||||
s1 := Just(a1...)
|
|
||||||
s2 := Just(a2...)
|
|
||||||
stream := Concat(s1, s2)
|
|
||||||
var items []interface{}
|
|
||||||
for item := range stream.source {
|
|
||||||
items = append(items, item)
|
|
||||||
}
|
|
||||||
sort.Slice(items, func(i, j int) bool {
|
|
||||||
return items[i].(int) < items[j].(int)
|
|
||||||
})
|
|
||||||
ints := make([]interface{}, 0)
|
|
||||||
ints = append(ints, a1...)
|
|
||||||
ints = append(ints, a2...)
|
|
||||||
assetEqual(t, ints, items)
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestStream_Skip(t *testing.T) {
|
|
||||||
assetEqual(t, 3, Just(1, 2, 3, 4).Skip(1).Count())
|
|
||||||
assetEqual(t, 1, Just(1, 2, 3, 4).Skip(3).Count())
|
|
||||||
assetEqual(t, 4, Just(1, 2, 3, 4).Skip(0).Count())
|
|
||||||
equal(t, Just(1, 2, 3, 4).Skip(3), []interface{}{4})
|
|
||||||
assert.Panics(t, func() {
|
|
||||||
Just(1, 2, 3, 4).Skip(-1)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestStream_Concat(t *testing.T) {
|
|
||||||
stream := Just(1).Concat(Just(2), Just(3))
|
|
||||||
var items []interface{}
|
|
||||||
for item := range stream.source {
|
|
||||||
items = append(items, item)
|
|
||||||
}
|
|
||||||
sort.Slice(items, func(i, j int) bool {
|
|
||||||
return items[i].(int) < items[j].(int)
|
|
||||||
})
|
|
||||||
assetEqual(t, []interface{}{1, 2, 3}, items)
|
|
||||||
|
|
||||||
just := Just(1)
|
|
||||||
equal(t, just.Concat(just), []interface{}{1})
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -6,8 +6,8 @@ import (
|
|||||||
"strconv"
|
"strconv"
|
||||||
"sync"
|
"sync"
|
||||||
|
|
||||||
"github.com/tal-tech/go-zero/core/lang"
|
"github.com/zeromicro/go-zero/core/lang"
|
||||||
"github.com/tal-tech/go-zero/core/mapping"
|
"github.com/zeromicro/go-zero/core/mapping"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/tal-tech/go-zero/core/mathx"
|
"github.com/zeromicro/go-zero/core/mathx"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
@@ -74,12 +74,12 @@ func TestConsistentHashIncrementalTransfer(t *testing.T) {
|
|||||||
laterCh := create()
|
laterCh := create()
|
||||||
laterCh.AddWithWeight(node, 10*(i+1))
|
laterCh.AddWithWeight(node, 10*(i+1))
|
||||||
|
|
||||||
for i := 0; i < requestSize; i++ {
|
for j := 0; j < requestSize; j++ {
|
||||||
key, ok := laterCh.Get(requestSize + i)
|
key, ok := laterCh.Get(requestSize + j)
|
||||||
assert.True(t, ok)
|
assert.True(t, ok)
|
||||||
assert.NotNil(t, key)
|
assert.NotNil(t, key)
|
||||||
value := key.(string)
|
value := key.(string)
|
||||||
assert.True(t, value == keys[i] || value == node)
|
assert.True(t, value == keys[j] || value == node)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -9,8 +9,8 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/tal-tech/go-zero/core/fs"
|
"github.com/zeromicro/go-zero/core/fs"
|
||||||
"github.com/tal-tech/go-zero/core/stringx"
|
"github.com/zeromicro/go-zero/core/stringx"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestReadText(t *testing.T) {
|
func TestReadText(t *testing.T) {
|
||||||
|
|||||||
@@ -5,6 +5,7 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
"github.com/globalsign/mgo/bson"
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -106,3 +107,20 @@ func TestMilliTime_UnmarshalJSON(t *testing.T) {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestUnmarshalWithError(t *testing.T) {
|
||||||
|
var mt MilliTime
|
||||||
|
assert.NotNil(t, mt.UnmarshalJSON([]byte("hello")))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSetBSON(t *testing.T) {
|
||||||
|
data, err := bson.Marshal(time.Now())
|
||||||
|
assert.Nil(t, err)
|
||||||
|
|
||||||
|
var raw bson.Raw
|
||||||
|
assert.Nil(t, bson.Unmarshal(data, &raw))
|
||||||
|
|
||||||
|
var mt MilliTime
|
||||||
|
assert.Nil(t, mt.SetBSON(raw))
|
||||||
|
assert.NotNil(t, mt.SetBSON(bson.Raw{}))
|
||||||
|
}
|
||||||
|
|||||||
@@ -51,5 +51,5 @@ func unmarshalUseNumber(decoder *json.Decoder, v interface{}) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func formatError(v string, err error) error {
|
func formatError(v string, err error) error {
|
||||||
return fmt.Errorf("string: `%s`, error: `%s`", v, err.Error())
|
return fmt.Errorf("string: `%s`, error: `%w`", v, err)
|
||||||
}
|
}
|
||||||
|
|||||||
87
core/jsonx/json_test.go
Normal file
87
core/jsonx/json_test.go
Normal file
@@ -0,0 +1,87 @@
|
|||||||
|
package jsonx
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestMarshal(t *testing.T) {
|
||||||
|
var v = struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Age int `json:"age"`
|
||||||
|
}{
|
||||||
|
Name: "John",
|
||||||
|
Age: 30,
|
||||||
|
}
|
||||||
|
bs, err := Marshal(v)
|
||||||
|
assert.Nil(t, err)
|
||||||
|
assert.Equal(t, `{"name":"John","age":30}`, string(bs))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestUnmarshal(t *testing.T) {
|
||||||
|
const s = `{"name":"John","age":30}`
|
||||||
|
var v struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Age int `json:"age"`
|
||||||
|
}
|
||||||
|
err := Unmarshal([]byte(s), &v)
|
||||||
|
assert.Nil(t, err)
|
||||||
|
assert.Equal(t, "John", v.Name)
|
||||||
|
assert.Equal(t, 30, v.Age)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestUnmarshalError(t *testing.T) {
|
||||||
|
const s = `{"name":"John","age":30`
|
||||||
|
var v struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Age int `json:"age"`
|
||||||
|
}
|
||||||
|
err := Unmarshal([]byte(s), &v)
|
||||||
|
assert.NotNil(t, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestUnmarshalFromString(t *testing.T) {
|
||||||
|
const s = `{"name":"John","age":30}`
|
||||||
|
var v struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Age int `json:"age"`
|
||||||
|
}
|
||||||
|
err := UnmarshalFromString(s, &v)
|
||||||
|
assert.Nil(t, err)
|
||||||
|
assert.Equal(t, "John", v.Name)
|
||||||
|
assert.Equal(t, 30, v.Age)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestUnmarshalFromStringError(t *testing.T) {
|
||||||
|
const s = `{"name":"John","age":30`
|
||||||
|
var v struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Age int `json:"age"`
|
||||||
|
}
|
||||||
|
err := UnmarshalFromString(s, &v)
|
||||||
|
assert.NotNil(t, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestUnmarshalFromRead(t *testing.T) {
|
||||||
|
const s = `{"name":"John","age":30}`
|
||||||
|
var v struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Age int `json:"age"`
|
||||||
|
}
|
||||||
|
err := UnmarshalFromReader(strings.NewReader(s), &v)
|
||||||
|
assert.Nil(t, err)
|
||||||
|
assert.Equal(t, "John", v.Name)
|
||||||
|
assert.Equal(t, 30, v.Age)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestUnmarshalFromReaderError(t *testing.T) {
|
||||||
|
const s = `{"name":"John","age":30`
|
||||||
|
var v struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Age int `json:"age"`
|
||||||
|
}
|
||||||
|
err := UnmarshalFromReader(strings.NewReader(s), &v)
|
||||||
|
assert.NotNil(t, err)
|
||||||
|
}
|
||||||
@@ -4,8 +4,8 @@ package lang
|
|||||||
var Placeholder PlaceholderType
|
var Placeholder PlaceholderType
|
||||||
|
|
||||||
type (
|
type (
|
||||||
// GenericType can be used to hold any type.
|
// AnyType can be used to hold any type.
|
||||||
GenericType = interface{}
|
AnyType = interface{}
|
||||||
// PlaceholderType represents a placeholder type.
|
// PlaceholderType represents a placeholder type.
|
||||||
PlaceholderType = struct{}
|
PlaceholderType = struct{}
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -5,26 +5,23 @@ import (
|
|||||||
"strconv"
|
"strconv"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/tal-tech/go-zero/core/stores/redis"
|
"github.com/zeromicro/go-zero/core/stores/redis"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
// to be compatible with aliyun redis, we cannot use `local key = KEYS[1]` to reuse the key
|
||||||
// to be compatible with aliyun redis, we cannot use `local key = KEYS[1]` to reuse the key
|
const periodScript = `local limit = tonumber(ARGV[1])
|
||||||
periodScript = `local limit = tonumber(ARGV[1])
|
|
||||||
local window = tonumber(ARGV[2])
|
local window = tonumber(ARGV[2])
|
||||||
local current = redis.call("INCRBY", KEYS[1], 1)
|
local current = redis.call("INCRBY", KEYS[1], 1)
|
||||||
if current == 1 then
|
if current == 1 then
|
||||||
redis.call("expire", KEYS[1], window)
|
redis.call("expire", KEYS[1], window)
|
||||||
return 1
|
end
|
||||||
elseif current < limit then
|
if current < limit then
|
||||||
return 1
|
return 1
|
||||||
elseif current == limit then
|
elseif current == limit then
|
||||||
return 2
|
return 2
|
||||||
else
|
else
|
||||||
return 0
|
return 0
|
||||||
end`
|
end`
|
||||||
zoneDiff = 3600 * 8 // GMT+8 for our services
|
|
||||||
)
|
|
||||||
|
|
||||||
const (
|
const (
|
||||||
// Unknown means not initialized state.
|
// Unknown means not initialized state.
|
||||||
@@ -104,7 +101,9 @@ func (h *PeriodLimit) Take(key string) (int, error) {
|
|||||||
|
|
||||||
func (h *PeriodLimit) calcExpireSeconds() int {
|
func (h *PeriodLimit) calcExpireSeconds() int {
|
||||||
if h.align {
|
if h.align {
|
||||||
unix := time.Now().Unix() + zoneDiff
|
now := time.Now()
|
||||||
|
_, offset := now.Zone()
|
||||||
|
unix := now.Unix() + int64(offset)
|
||||||
return h.period - int(unix%int64(h.period))
|
return h.period - int(unix%int64(h.period))
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -112,6 +111,8 @@ func (h *PeriodLimit) calcExpireSeconds() int {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Align returns a func to customize a PeriodLimit with alignment.
|
// Align returns a func to customize a PeriodLimit with alignment.
|
||||||
|
// For example, if we want to limit end users with 5 sms verification messages every day,
|
||||||
|
// we need to align with the local timezone and the start of the day.
|
||||||
func Align() PeriodOption {
|
func Align() PeriodOption {
|
||||||
return func(l *PeriodLimit) {
|
return func(l *PeriodLimit) {
|
||||||
l.align = true
|
l.align = true
|
||||||
|
|||||||
@@ -5,8 +5,8 @@ import (
|
|||||||
|
|
||||||
"github.com/alicebob/miniredis/v2"
|
"github.com/alicebob/miniredis/v2"
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/tal-tech/go-zero/core/stores/redis"
|
"github.com/zeromicro/go-zero/core/stores/redis"
|
||||||
"github.com/tal-tech/go-zero/core/stores/redis/redistest"
|
"github.com/zeromicro/go-zero/core/stores/redis/redistest"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestPeriodLimit_Take(t *testing.T) {
|
func TestPeriodLimit_Take(t *testing.T) {
|
||||||
@@ -23,10 +23,9 @@ func TestPeriodLimit_RedisUnavailable(t *testing.T) {
|
|||||||
|
|
||||||
const (
|
const (
|
||||||
seconds = 1
|
seconds = 1
|
||||||
total = 100
|
|
||||||
quota = 5
|
quota = 5
|
||||||
)
|
)
|
||||||
l := NewPeriodLimit(seconds, quota, redis.NewRedis(s.Addr(), redis.NodeType), "periodlimit")
|
l := NewPeriodLimit(seconds, quota, redis.New(s.Addr()), "periodlimit")
|
||||||
s.Close()
|
s.Close()
|
||||||
val, err := l.Take("first")
|
val, err := l.Take("first")
|
||||||
assert.NotNil(t, err)
|
assert.NotNil(t, err)
|
||||||
@@ -66,3 +65,13 @@ func testPeriodLimit(t *testing.T, opts ...PeriodOption) {
|
|||||||
assert.Equal(t, 1, hitQuota)
|
assert.Equal(t, 1, hitQuota)
|
||||||
assert.Equal(t, total-quota, overQuota)
|
assert.Equal(t, total-quota, overQuota)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestQuotaFull(t *testing.T) {
|
||||||
|
s, err := miniredis.Run()
|
||||||
|
assert.Nil(t, err)
|
||||||
|
|
||||||
|
l := NewPeriodLimit(1, 1, redis.New(s.Addr()), "periodlimit")
|
||||||
|
val, err := l.Take("first")
|
||||||
|
assert.Nil(t, err)
|
||||||
|
assert.Equal(t, HitQuota, val)
|
||||||
|
}
|
||||||
|
|||||||
@@ -7,8 +7,8 @@ import (
|
|||||||
"sync/atomic"
|
"sync/atomic"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/tal-tech/go-zero/core/logx"
|
"github.com/zeromicro/go-zero/core/logx"
|
||||||
"github.com/tal-tech/go-zero/core/stores/redis"
|
"github.com/zeromicro/go-zero/core/stores/redis"
|
||||||
xrate "golang.org/x/time/rate"
|
xrate "golang.org/x/time/rate"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -85,8 +85,8 @@ func (lim *TokenLimiter) Allow() bool {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// AllowN reports whether n events may happen at time now.
|
// AllowN reports whether n events may happen at time now.
|
||||||
// Use this method if you intend to drop / skip events that exceed the rate rate.
|
// Use this method if you intend to drop / skip events that exceed the rate.
|
||||||
// Otherwise use Reserve or Wait.
|
// Otherwise, use Reserve or Wait.
|
||||||
func (lim *TokenLimiter) AllowN(now time.Time, n int) bool {
|
func (lim *TokenLimiter) AllowN(now time.Time, n int) bool {
|
||||||
return lim.reserveN(now, n)
|
return lim.reserveN(now, n)
|
||||||
}
|
}
|
||||||
@@ -112,7 +112,8 @@ func (lim *TokenLimiter) reserveN(now time.Time, n int) bool {
|
|||||||
// Lua boolean false -> r Nil bulk reply
|
// Lua boolean false -> r Nil bulk reply
|
||||||
if err == redis.Nil {
|
if err == redis.Nil {
|
||||||
return false
|
return false
|
||||||
} else if err != nil {
|
}
|
||||||
|
if err != nil {
|
||||||
logx.Errorf("fail to use rate limiter: %s, use in-process limiter for rescue", err)
|
logx.Errorf("fail to use rate limiter: %s, use in-process limiter for rescue", err)
|
||||||
lim.startMonitor()
|
lim.startMonitor()
|
||||||
return lim.rescueLimiter.AllowN(now, n)
|
return lim.rescueLimiter.AllowN(now, n)
|
||||||
|
|||||||
@@ -6,9 +6,9 @@ import (
|
|||||||
|
|
||||||
"github.com/alicebob/miniredis/v2"
|
"github.com/alicebob/miniredis/v2"
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/tal-tech/go-zero/core/logx"
|
"github.com/zeromicro/go-zero/core/logx"
|
||||||
"github.com/tal-tech/go-zero/core/stores/redis"
|
"github.com/zeromicro/go-zero/core/stores/redis"
|
||||||
"github.com/tal-tech/go-zero/core/stores/redis/redistest"
|
"github.com/zeromicro/go-zero/core/stores/redis/redistest"
|
||||||
)
|
)
|
||||||
|
|
||||||
func init() {
|
func init() {
|
||||||
|
|||||||
@@ -7,11 +7,11 @@ import (
|
|||||||
"sync/atomic"
|
"sync/atomic"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/tal-tech/go-zero/core/collection"
|
"github.com/zeromicro/go-zero/core/collection"
|
||||||
"github.com/tal-tech/go-zero/core/logx"
|
"github.com/zeromicro/go-zero/core/logx"
|
||||||
"github.com/tal-tech/go-zero/core/stat"
|
"github.com/zeromicro/go-zero/core/stat"
|
||||||
"github.com/tal-tech/go-zero/core/syncx"
|
"github.com/zeromicro/go-zero/core/syncx"
|
||||||
"github.com/tal-tech/go-zero/core/timex"
|
"github.com/zeromicro/go-zero/core/timex"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
|
|||||||
@@ -8,11 +8,11 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/tal-tech/go-zero/core/collection"
|
"github.com/zeromicro/go-zero/core/collection"
|
||||||
"github.com/tal-tech/go-zero/core/logx"
|
"github.com/zeromicro/go-zero/core/logx"
|
||||||
"github.com/tal-tech/go-zero/core/mathx"
|
"github.com/zeromicro/go-zero/core/mathx"
|
||||||
"github.com/tal-tech/go-zero/core/stat"
|
"github.com/zeromicro/go-zero/core/stat"
|
||||||
"github.com/tal-tech/go-zero/core/syncx"
|
"github.com/zeromicro/go-zero/core/syncx"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ package load
|
|||||||
import (
|
import (
|
||||||
"io"
|
"io"
|
||||||
|
|
||||||
"github.com/tal-tech/go-zero/core/syncx"
|
"github.com/zeromicro/go-zero/core/syncx"
|
||||||
)
|
)
|
||||||
|
|
||||||
// A ShedderGroup is a manager to manage key based shedders.
|
// A ShedderGroup is a manager to manage key based shedders.
|
||||||
|
|||||||
@@ -4,8 +4,8 @@ import (
|
|||||||
"sync/atomic"
|
"sync/atomic"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/tal-tech/go-zero/core/logx"
|
"github.com/zeromicro/go-zero/core/logx"
|
||||||
"github.com/tal-tech/go-zero/core/stat"
|
"github.com/zeromicro/go-zero/core/stat"
|
||||||
)
|
)
|
||||||
|
|
||||||
type (
|
type (
|
||||||
|
|||||||
26
core/logx/color.go
Normal file
26
core/logx/color.go
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
package logx
|
||||||
|
|
||||||
|
import (
|
||||||
|
"sync/atomic"
|
||||||
|
|
||||||
|
"github.com/zeromicro/go-zero/core/color"
|
||||||
|
)
|
||||||
|
|
||||||
|
// WithColor is a helper function to add color to a string, only in plain encoding.
|
||||||
|
func WithColor(text string, colour color.Color) string {
|
||||||
|
if atomic.LoadUint32(&encoding) == plainEncodingType {
|
||||||
|
return color.WithColor(text, colour)
|
||||||
|
}
|
||||||
|
|
||||||
|
return text
|
||||||
|
}
|
||||||
|
|
||||||
|
// WithColorPadding is a helper function to add color to a string with leading and trailing spaces,
|
||||||
|
// only in plain encoding.
|
||||||
|
func WithColorPadding(text string, colour color.Color) string {
|
||||||
|
if atomic.LoadUint32(&encoding) == plainEncodingType {
|
||||||
|
return color.WithColorPadding(text, colour)
|
||||||
|
}
|
||||||
|
|
||||||
|
return text
|
||||||
|
}
|
||||||
33
core/logx/color_test.go
Normal file
33
core/logx/color_test.go
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
package logx
|
||||||
|
|
||||||
|
import (
|
||||||
|
"sync/atomic"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/zeromicro/go-zero/core/color"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestWithColor(t *testing.T) {
|
||||||
|
old := atomic.SwapUint32(&encoding, plainEncodingType)
|
||||||
|
defer atomic.StoreUint32(&encoding, old)
|
||||||
|
|
||||||
|
output := WithColor("hello", color.BgBlue)
|
||||||
|
assert.Equal(t, "hello", output)
|
||||||
|
|
||||||
|
atomic.StoreUint32(&encoding, jsonEncodingType)
|
||||||
|
output = WithColor("hello", color.BgBlue)
|
||||||
|
assert.Equal(t, "hello", output)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWithColorPadding(t *testing.T) {
|
||||||
|
old := atomic.SwapUint32(&encoding, plainEncodingType)
|
||||||
|
defer atomic.StoreUint32(&encoding, old)
|
||||||
|
|
||||||
|
output := WithColorPadding("hello", color.BgBlue)
|
||||||
|
assert.Equal(t, " hello ", output)
|
||||||
|
|
||||||
|
atomic.StoreUint32(&encoding, jsonEncodingType)
|
||||||
|
output = WithColorPadding("hello", color.BgBlue)
|
||||||
|
assert.Equal(t, "hello", output)
|
||||||
|
}
|
||||||
@@ -3,10 +3,11 @@ package logx
|
|||||||
// A LogConf is a logging config.
|
// A LogConf is a logging config.
|
||||||
type LogConf struct {
|
type LogConf struct {
|
||||||
ServiceName string `json:",optional"`
|
ServiceName string `json:",optional"`
|
||||||
Mode string `json:",default=console,options=console|file|volume"`
|
Mode string `json:",default=console,options=[console,file,volume]"`
|
||||||
|
Encoding string `json:",default=json,options=[json,plain]"`
|
||||||
TimeFormat string `json:",optional"`
|
TimeFormat string `json:",optional"`
|
||||||
Path string `json:",default=logs"`
|
Path string `json:",default=logs"`
|
||||||
Level string `json:",default=info,options=info|error|severe"`
|
Level string `json:",default=info,options=[info,error,severe]"`
|
||||||
Compress bool `json:",optional"`
|
Compress bool `json:",optional"`
|
||||||
KeepDays int `json:",optional"`
|
KeepDays int `json:",optional"`
|
||||||
StackCooldownMillis int `json:",default=100"`
|
StackCooldownMillis int `json:",default=100"`
|
||||||
|
|||||||
@@ -1,17 +1,13 @@
|
|||||||
package logx
|
package logx
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"context"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/tal-tech/go-zero/core/timex"
|
"github.com/zeromicro/go-zero/core/timex"
|
||||||
)
|
)
|
||||||
|
|
||||||
const durationCallerDepth = 3
|
|
||||||
|
|
||||||
type durationLogger logEntry
|
|
||||||
|
|
||||||
// WithDuration returns a Logger which logs the given duration.
|
// WithDuration returns a Logger which logs the given duration.
|
||||||
func WithDuration(d time.Duration) Logger {
|
func WithDuration(d time.Duration) Logger {
|
||||||
return &durationLogger{
|
return &durationLogger{
|
||||||
@@ -19,57 +15,62 @@ func WithDuration(d time.Duration) Logger {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
type durationLogger logEntry
|
||||||
|
|
||||||
func (l *durationLogger) Error(v ...interface{}) {
|
func (l *durationLogger) Error(v ...interface{}) {
|
||||||
if shallLog(ErrorLevel) {
|
l.err(fmt.Sprint(v...))
|
||||||
l.write(errorLog, levelError, formatWithCaller(fmt.Sprint(v...), durationCallerDepth))
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (l *durationLogger) Errorf(format string, v ...interface{}) {
|
func (l *durationLogger) Errorf(format string, v ...interface{}) {
|
||||||
if shallLog(ErrorLevel) {
|
l.err(fmt.Sprintf(format, v...))
|
||||||
l.write(errorLog, levelError, formatWithCaller(fmt.Sprintf(format, v...), durationCallerDepth))
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (l *durationLogger) Errorv(v interface{}) {
|
func (l *durationLogger) Errorv(v interface{}) {
|
||||||
if shallLog(ErrorLevel) {
|
l.err(v)
|
||||||
l.write(errorLog, levelError, v)
|
}
|
||||||
}
|
|
||||||
|
func (l *durationLogger) Errorw(msg string, fields ...LogField) {
|
||||||
|
l.err(msg, fields...)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (l *durationLogger) Info(v ...interface{}) {
|
func (l *durationLogger) Info(v ...interface{}) {
|
||||||
if shallLog(InfoLevel) {
|
l.info(fmt.Sprint(v...))
|
||||||
l.write(infoLog, levelInfo, fmt.Sprint(v...))
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (l *durationLogger) Infof(format string, v ...interface{}) {
|
func (l *durationLogger) Infof(format string, v ...interface{}) {
|
||||||
if shallLog(InfoLevel) {
|
l.info(fmt.Sprintf(format, v...))
|
||||||
l.write(infoLog, levelInfo, fmt.Sprintf(format, v...))
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (l *durationLogger) Infov(v interface{}) {
|
func (l *durationLogger) Infov(v interface{}) {
|
||||||
if shallLog(InfoLevel) {
|
l.info(v)
|
||||||
l.write(infoLog, levelInfo, v)
|
}
|
||||||
}
|
|
||||||
|
func (l *durationLogger) Infow(msg string, fields ...LogField) {
|
||||||
|
l.info(msg, fields...)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (l *durationLogger) Slow(v ...interface{}) {
|
func (l *durationLogger) Slow(v ...interface{}) {
|
||||||
if shallLog(ErrorLevel) {
|
l.slow(fmt.Sprint(v...))
|
||||||
l.write(slowLog, levelSlow, fmt.Sprint(v...))
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (l *durationLogger) Slowf(format string, v ...interface{}) {
|
func (l *durationLogger) Slowf(format string, v ...interface{}) {
|
||||||
if shallLog(ErrorLevel) {
|
l.slow(fmt.Sprintf(format, v...))
|
||||||
l.write(slowLog, levelSlow, fmt.Sprintf(format, v...))
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (l *durationLogger) Slowv(v interface{}) {
|
func (l *durationLogger) Slowv(v interface{}) {
|
||||||
if shallLog(ErrorLevel) {
|
l.slow(v)
|
||||||
l.write(slowLog, levelSlow, v)
|
}
|
||||||
|
|
||||||
|
func (l *durationLogger) Sloww(msg string, fields ...LogField) {
|
||||||
|
l.slow(msg, fields...)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (l *durationLogger) WithContext(ctx context.Context) Logger {
|
||||||
|
return &traceLogger{
|
||||||
|
ctx: ctx,
|
||||||
|
logEntry: logEntry{
|
||||||
|
Duration: l.Duration,
|
||||||
|
},
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -78,9 +79,23 @@ func (l *durationLogger) WithDuration(duration time.Duration) Logger {
|
|||||||
return l
|
return l
|
||||||
}
|
}
|
||||||
|
|
||||||
func (l *durationLogger) write(writer io.Writer, level string, val interface{}) {
|
func (l *durationLogger) err(v interface{}, fields ...LogField) {
|
||||||
l.Timestamp = getTimestamp()
|
if shallLog(ErrorLevel) {
|
||||||
l.Level = level
|
fields = append(fields, Field(durationKey, l.Duration))
|
||||||
l.Content = val
|
getWriter().Error(v, fields...)
|
||||||
outputJson(writer, l)
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (l *durationLogger) info(v interface{}, fields ...LogField) {
|
||||||
|
if shallLog(InfoLevel) {
|
||||||
|
fields = append(fields, Field(durationKey, l.Duration))
|
||||||
|
getWriter().Info(v, fields...)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (l *durationLogger) slow(v interface{}, fields ...LogField) {
|
||||||
|
if shallLog(ErrorLevel) {
|
||||||
|
fields = append(fields, Field(durationKey, l.Duration))
|
||||||
|
getWriter().Slow(v, fields...)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,52 +1,161 @@
|
|||||||
package logx
|
package logx
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"log"
|
"context"
|
||||||
"strings"
|
"strings"
|
||||||
|
"sync/atomic"
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
|
"go.opentelemetry.io/otel"
|
||||||
|
sdktrace "go.opentelemetry.io/otel/sdk/trace"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestWithDurationError(t *testing.T) {
|
func TestWithDurationError(t *testing.T) {
|
||||||
var builder strings.Builder
|
w := new(mockWriter)
|
||||||
log.SetOutput(&builder)
|
old := writer.Swap(w)
|
||||||
|
defer writer.Store(old)
|
||||||
|
|
||||||
WithDuration(time.Second).Error("foo")
|
WithDuration(time.Second).Error("foo")
|
||||||
assert.True(t, strings.Contains(builder.String(), "duration"), builder.String())
|
assert.True(t, strings.Contains(w.String(), "duration"), w.String())
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestWithDurationErrorf(t *testing.T) {
|
func TestWithDurationErrorf(t *testing.T) {
|
||||||
var builder strings.Builder
|
w := new(mockWriter)
|
||||||
log.SetOutput(&builder)
|
old := writer.Swap(w)
|
||||||
|
defer writer.Store(old)
|
||||||
|
|
||||||
WithDuration(time.Second).Errorf("foo")
|
WithDuration(time.Second).Errorf("foo")
|
||||||
assert.True(t, strings.Contains(builder.String(), "duration"), builder.String())
|
assert.True(t, strings.Contains(w.String(), "duration"), w.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWithDurationErrorv(t *testing.T) {
|
||||||
|
w := new(mockWriter)
|
||||||
|
old := writer.Swap(w)
|
||||||
|
defer writer.Store(old)
|
||||||
|
|
||||||
|
WithDuration(time.Second).Errorv("foo")
|
||||||
|
assert.True(t, strings.Contains(w.String(), "duration"), w.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWithDurationErrorw(t *testing.T) {
|
||||||
|
w := new(mockWriter)
|
||||||
|
old := writer.Swap(w)
|
||||||
|
defer writer.Store(old)
|
||||||
|
|
||||||
|
WithDuration(time.Second).Errorw("foo", Field("foo", "bar"))
|
||||||
|
assert.True(t, strings.Contains(w.String(), "duration"), w.String())
|
||||||
|
assert.True(t, strings.Contains(w.String(), "foo"), w.String())
|
||||||
|
assert.True(t, strings.Contains(w.String(), "bar"), w.String())
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestWithDurationInfo(t *testing.T) {
|
func TestWithDurationInfo(t *testing.T) {
|
||||||
var builder strings.Builder
|
w := new(mockWriter)
|
||||||
log.SetOutput(&builder)
|
old := writer.Swap(w)
|
||||||
|
defer writer.Store(old)
|
||||||
|
|
||||||
WithDuration(time.Second).Info("foo")
|
WithDuration(time.Second).Info("foo")
|
||||||
assert.True(t, strings.Contains(builder.String(), "duration"), builder.String())
|
assert.True(t, strings.Contains(w.String(), "duration"), w.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWithDurationInfoConsole(t *testing.T) {
|
||||||
|
old := atomic.LoadUint32(&encoding)
|
||||||
|
atomic.StoreUint32(&encoding, plainEncodingType)
|
||||||
|
defer func() {
|
||||||
|
atomic.StoreUint32(&encoding, old)
|
||||||
|
}()
|
||||||
|
|
||||||
|
w := new(mockWriter)
|
||||||
|
o := writer.Swap(w)
|
||||||
|
defer writer.Store(o)
|
||||||
|
|
||||||
|
WithDuration(time.Second).Info("foo")
|
||||||
|
assert.True(t, strings.Contains(w.String(), "ms"), w.String())
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestWithDurationInfof(t *testing.T) {
|
func TestWithDurationInfof(t *testing.T) {
|
||||||
var builder strings.Builder
|
w := new(mockWriter)
|
||||||
log.SetOutput(&builder)
|
old := writer.Swap(w)
|
||||||
|
defer writer.Store(old)
|
||||||
|
|
||||||
WithDuration(time.Second).Infof("foo")
|
WithDuration(time.Second).Infof("foo")
|
||||||
assert.True(t, strings.Contains(builder.String(), "duration"), builder.String())
|
assert.True(t, strings.Contains(w.String(), "duration"), w.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWithDurationInfov(t *testing.T) {
|
||||||
|
w := new(mockWriter)
|
||||||
|
old := writer.Swap(w)
|
||||||
|
defer writer.Store(old)
|
||||||
|
|
||||||
|
WithDuration(time.Second).Infov("foo")
|
||||||
|
assert.True(t, strings.Contains(w.String(), "duration"), w.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWithDurationInfow(t *testing.T) {
|
||||||
|
w := new(mockWriter)
|
||||||
|
old := writer.Swap(w)
|
||||||
|
defer writer.Store(old)
|
||||||
|
|
||||||
|
WithDuration(time.Second).Infow("foo", Field("foo", "bar"))
|
||||||
|
assert.True(t, strings.Contains(w.String(), "duration"), w.String())
|
||||||
|
assert.True(t, strings.Contains(w.String(), "foo"), w.String())
|
||||||
|
assert.True(t, strings.Contains(w.String(), "bar"), w.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWithDurationWithContextInfow(t *testing.T) {
|
||||||
|
w := new(mockWriter)
|
||||||
|
old := writer.Swap(w)
|
||||||
|
defer writer.Store(old)
|
||||||
|
|
||||||
|
otp := otel.GetTracerProvider()
|
||||||
|
tp := sdktrace.NewTracerProvider(sdktrace.WithSampler(sdktrace.AlwaysSample()))
|
||||||
|
otel.SetTracerProvider(tp)
|
||||||
|
defer otel.SetTracerProvider(otp)
|
||||||
|
|
||||||
|
ctx, _ := tp.Tracer("foo").Start(context.Background(), "bar")
|
||||||
|
WithDuration(time.Second).WithContext(ctx).Infow("foo", Field("foo", "bar"))
|
||||||
|
assert.True(t, strings.Contains(w.String(), "duration"), w.String())
|
||||||
|
assert.True(t, strings.Contains(w.String(), "foo"), w.String())
|
||||||
|
assert.True(t, strings.Contains(w.String(), "bar"), w.String())
|
||||||
|
assert.True(t, strings.Contains(w.String(), "trace"), w.String())
|
||||||
|
assert.True(t, strings.Contains(w.String(), "span"), w.String())
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestWithDurationSlow(t *testing.T) {
|
func TestWithDurationSlow(t *testing.T) {
|
||||||
var builder strings.Builder
|
w := new(mockWriter)
|
||||||
log.SetOutput(&builder)
|
old := writer.Swap(w)
|
||||||
|
defer writer.Store(old)
|
||||||
|
|
||||||
WithDuration(time.Second).Slow("foo")
|
WithDuration(time.Second).Slow("foo")
|
||||||
assert.True(t, strings.Contains(builder.String(), "duration"), builder.String())
|
assert.True(t, strings.Contains(w.String(), "duration"), w.String())
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestWithDurationSlowf(t *testing.T) {
|
func TestWithDurationSlowf(t *testing.T) {
|
||||||
var builder strings.Builder
|
w := new(mockWriter)
|
||||||
log.SetOutput(&builder)
|
old := writer.Swap(w)
|
||||||
|
defer writer.Store(old)
|
||||||
|
|
||||||
WithDuration(time.Second).WithDuration(time.Hour).Slowf("foo")
|
WithDuration(time.Second).WithDuration(time.Hour).Slowf("foo")
|
||||||
assert.True(t, strings.Contains(builder.String(), "duration"), builder.String())
|
assert.True(t, strings.Contains(w.String(), "duration"), w.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWithDurationSlowv(t *testing.T) {
|
||||||
|
w := new(mockWriter)
|
||||||
|
old := writer.Swap(w)
|
||||||
|
defer writer.Store(old)
|
||||||
|
|
||||||
|
WithDuration(time.Second).WithDuration(time.Hour).Slowv("foo")
|
||||||
|
assert.True(t, strings.Contains(w.String(), "duration"), w.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWithDurationSloww(t *testing.T) {
|
||||||
|
w := new(mockWriter)
|
||||||
|
old := writer.Swap(w)
|
||||||
|
defer writer.Store(old)
|
||||||
|
|
||||||
|
WithDuration(time.Second).WithDuration(time.Hour).Sloww("foo", Field("foo", "bar"))
|
||||||
|
assert.True(t, strings.Contains(w.String(), "duration"), w.String())
|
||||||
|
assert.True(t, strings.Contains(w.String(), "foo"), w.String())
|
||||||
|
assert.True(t, strings.Contains(w.String(), "bar"), w.String())
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
package logx
|
package logx
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"log"
|
|
||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
@@ -9,23 +8,27 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
func TestLessLogger_Error(t *testing.T) {
|
func TestLessLogger_Error(t *testing.T) {
|
||||||
var builder strings.Builder
|
w := new(mockWriter)
|
||||||
log.SetOutput(&builder)
|
old := writer.Swap(w)
|
||||||
|
defer writer.Store(old)
|
||||||
|
|
||||||
l := NewLessLogger(500)
|
l := NewLessLogger(500)
|
||||||
for i := 0; i < 100; i++ {
|
for i := 0; i < 100; i++ {
|
||||||
l.Error("hello")
|
l.Error("hello")
|
||||||
}
|
}
|
||||||
|
|
||||||
assert.Equal(t, 1, strings.Count(builder.String(), "\n"))
|
assert.Equal(t, 1, strings.Count(w.String(), "\n"))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestLessLogger_Errorf(t *testing.T) {
|
func TestLessLogger_Errorf(t *testing.T) {
|
||||||
var builder strings.Builder
|
w := new(mockWriter)
|
||||||
log.SetOutput(&builder)
|
old := writer.Swap(w)
|
||||||
|
defer writer.Store(old)
|
||||||
|
|
||||||
l := NewLessLogger(500)
|
l := NewLessLogger(500)
|
||||||
for i := 0; i < 100; i++ {
|
for i := 0; i < 100; i++ {
|
||||||
l.Errorf("hello")
|
l.Errorf("hello")
|
||||||
}
|
}
|
||||||
|
|
||||||
assert.Equal(t, 1, strings.Count(builder.String(), "\n"))
|
assert.Equal(t, 1, strings.Count(w.String(), "\n"))
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -4,8 +4,8 @@ import (
|
|||||||
"sync/atomic"
|
"sync/atomic"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/tal-tech/go-zero/core/syncx"
|
"github.com/zeromicro/go-zero/core/syncx"
|
||||||
"github.com/tal-tech/go-zero/core/timex"
|
"github.com/zeromicro/go-zero/core/timex"
|
||||||
)
|
)
|
||||||
|
|
||||||
type limitedExecutor struct {
|
type limitedExecutor struct {
|
||||||
|
|||||||
62
core/logx/limitedexecutor_test.go
Normal file
62
core/logx/limitedexecutor_test.go
Normal file
@@ -0,0 +1,62 @@
|
|||||||
|
package logx
|
||||||
|
|
||||||
|
import (
|
||||||
|
"sync/atomic"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/zeromicro/go-zero/core/timex"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestLimitedExecutor_logOrDiscard(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
threshold time.Duration
|
||||||
|
lastTime time.Duration
|
||||||
|
discarded uint32
|
||||||
|
executed bool
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "nil executor",
|
||||||
|
executed: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "regular",
|
||||||
|
threshold: time.Hour,
|
||||||
|
lastTime: timex.Now(),
|
||||||
|
discarded: 10,
|
||||||
|
executed: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "slow",
|
||||||
|
threshold: time.Duration(1),
|
||||||
|
lastTime: -1000,
|
||||||
|
discarded: 10,
|
||||||
|
executed: true,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, test := range tests {
|
||||||
|
test := test
|
||||||
|
t.Run(test.name, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
executor := newLimitedExecutor(0)
|
||||||
|
executor.threshold = test.threshold
|
||||||
|
executor.discarded = test.discarded
|
||||||
|
executor.lastTime.Set(test.lastTime)
|
||||||
|
|
||||||
|
var run int32
|
||||||
|
executor.logOrDiscard(func() {
|
||||||
|
atomic.AddInt32(&run, 1)
|
||||||
|
})
|
||||||
|
if test.executed {
|
||||||
|
assert.Equal(t, int32(1), atomic.LoadInt32(&run))
|
||||||
|
} else {
|
||||||
|
assert.Equal(t, int32(0), atomic.LoadInt32(&run))
|
||||||
|
assert.Equal(t, test.discarded+1, atomic.LoadUint32(&executor.discarded))
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
38
core/logx/logger.go
Normal file
38
core/logx/logger.go
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
package logx
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// A Logger represents a logger.
|
||||||
|
type Logger interface {
|
||||||
|
// Error logs a message at error level.
|
||||||
|
Error(...interface{})
|
||||||
|
// Errorf logs a message at error level.
|
||||||
|
Errorf(string, ...interface{})
|
||||||
|
// Errorv logs a message at error level.
|
||||||
|
Errorv(interface{})
|
||||||
|
// Errorw logs a message at error level.
|
||||||
|
Errorw(string, ...LogField)
|
||||||
|
// Info logs a message at info level.
|
||||||
|
Info(...interface{})
|
||||||
|
// Infof logs a message at info level.
|
||||||
|
Infof(string, ...interface{})
|
||||||
|
// Infov logs a message at info level.
|
||||||
|
Infov(interface{})
|
||||||
|
// Infow logs a message at info level.
|
||||||
|
Infow(string, ...LogField)
|
||||||
|
// Slow logs a message at slow level.
|
||||||
|
Slow(...interface{})
|
||||||
|
// Slowf logs a message at slow level.
|
||||||
|
Slowf(string, ...interface{})
|
||||||
|
// Slowv logs a message at slow level.
|
||||||
|
Slowv(interface{})
|
||||||
|
// Sloww logs a message at slow level.
|
||||||
|
Sloww(string, ...LogField)
|
||||||
|
// WithContext returns a new logger with the given context.
|
||||||
|
WithContext(context.Context) Logger
|
||||||
|
// WithDuration returns a new logger with the given duration.
|
||||||
|
WithDuration(time.Duration) Logger
|
||||||
|
}
|
||||||
@@ -1,82 +1,29 @@
|
|||||||
package logx
|
package logx
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"encoding/json"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"io/ioutil"
|
|
||||||
"log"
|
"log"
|
||||||
"os"
|
"os"
|
||||||
"path"
|
"path"
|
||||||
"runtime"
|
|
||||||
"runtime/debug"
|
"runtime/debug"
|
||||||
"strconv"
|
|
||||||
"strings"
|
|
||||||
"sync"
|
|
||||||
"sync/atomic"
|
"sync/atomic"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/tal-tech/go-zero/core/iox"
|
"github.com/zeromicro/go-zero/core/sysx"
|
||||||
"github.com/tal-tech/go-zero/core/sysx"
|
|
||||||
"github.com/tal-tech/go-zero/core/timex"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const callerDepth = 5
|
||||||
// InfoLevel logs everything
|
|
||||||
InfoLevel = iota
|
|
||||||
// ErrorLevel includes errors, slows, stacks
|
|
||||||
ErrorLevel
|
|
||||||
// SevereLevel only log severe messages
|
|
||||||
SevereLevel
|
|
||||||
)
|
|
||||||
|
|
||||||
const (
|
|
||||||
accessFilename = "access.log"
|
|
||||||
errorFilename = "error.log"
|
|
||||||
severeFilename = "severe.log"
|
|
||||||
slowFilename = "slow.log"
|
|
||||||
statFilename = "stat.log"
|
|
||||||
|
|
||||||
consoleMode = "console"
|
|
||||||
volumeMode = "volume"
|
|
||||||
|
|
||||||
levelAlert = "alert"
|
|
||||||
levelInfo = "info"
|
|
||||||
levelError = "error"
|
|
||||||
levelSevere = "severe"
|
|
||||||
levelFatal = "fatal"
|
|
||||||
levelSlow = "slow"
|
|
||||||
levelStat = "stat"
|
|
||||||
|
|
||||||
backupFileDelimiter = "-"
|
|
||||||
callerInnerDepth = 5
|
|
||||||
flags = 0x0
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
var (
|
||||||
// ErrLogPathNotSet is an error that indicates the log path is not set.
|
timeFormat = "2006-01-02T15:04:05.000Z07:00"
|
||||||
ErrLogPathNotSet = errors.New("log path must be set")
|
logLevel uint32
|
||||||
// ErrLogNotInitialized is an error that log is not initialized.
|
encoding uint32 = jsonEncodingType
|
||||||
ErrLogNotInitialized = errors.New("log not initialized")
|
|
||||||
// ErrLogServiceNameNotSet is an error that indicates that the service name is not set.
|
|
||||||
ErrLogServiceNameNotSet = errors.New("log service name must be set")
|
|
||||||
|
|
||||||
timeFormat = "2006-01-02T15:04:05.000Z07"
|
|
||||||
writeConsole bool
|
|
||||||
logLevel uint32
|
|
||||||
// use uint32 for atomic operations
|
// use uint32 for atomic operations
|
||||||
disableStat uint32
|
disableStat uint32
|
||||||
infoLog io.WriteCloser
|
|
||||||
errorLog io.WriteCloser
|
|
||||||
severeLog io.WriteCloser
|
|
||||||
slowLog io.WriteCloser
|
|
||||||
statLog io.WriteCloser
|
|
||||||
stackLog io.Writer
|
|
||||||
|
|
||||||
once sync.Once
|
options logOptions
|
||||||
initialized uint32
|
writer = new(atomicWriter)
|
||||||
options logOptions
|
|
||||||
)
|
)
|
||||||
|
|
||||||
type (
|
type (
|
||||||
@@ -84,103 +31,37 @@ type (
|
|||||||
Timestamp string `json:"@timestamp"`
|
Timestamp string `json:"@timestamp"`
|
||||||
Level string `json:"level"`
|
Level string `json:"level"`
|
||||||
Duration string `json:"duration,omitempty"`
|
Duration string `json:"duration,omitempty"`
|
||||||
|
Caller string `json:"caller,omitempty"`
|
||||||
Content interface{} `json:"content"`
|
Content interface{} `json:"content"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
logEntryWithFields map[string]interface{}
|
||||||
|
|
||||||
logOptions struct {
|
logOptions struct {
|
||||||
gzipEnabled bool
|
gzipEnabled bool
|
||||||
logStackCooldownMills int
|
logStackCooldownMills int
|
||||||
keepDays int
|
keepDays int
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// LogField is a key-value pair that will be added to the log entry.
|
||||||
|
LogField struct {
|
||||||
|
Key string
|
||||||
|
Value interface{}
|
||||||
|
}
|
||||||
|
|
||||||
// LogOption defines the method to customize the logging.
|
// LogOption defines the method to customize the logging.
|
||||||
LogOption func(options *logOptions)
|
LogOption func(options *logOptions)
|
||||||
|
|
||||||
// A Logger represents a logger.
|
|
||||||
Logger interface {
|
|
||||||
Error(...interface{})
|
|
||||||
Errorf(string, ...interface{})
|
|
||||||
Errorv(interface{})
|
|
||||||
Info(...interface{})
|
|
||||||
Infof(string, ...interface{})
|
|
||||||
Infov(interface{})
|
|
||||||
Slow(...interface{})
|
|
||||||
Slowf(string, ...interface{})
|
|
||||||
Slowv(interface{})
|
|
||||||
WithDuration(time.Duration) Logger
|
|
||||||
}
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// MustSetup sets up logging with given config c. It exits on error.
|
|
||||||
func MustSetup(c LogConf) {
|
|
||||||
Must(SetUp(c))
|
|
||||||
}
|
|
||||||
|
|
||||||
// SetUp sets up the logx. If already set up, just return nil.
|
|
||||||
// we allow SetUp to be called multiple times, because for example
|
|
||||||
// we need to allow different service frameworks to initialize logx respectively.
|
|
||||||
// the same logic for SetUp
|
|
||||||
func SetUp(c LogConf) error {
|
|
||||||
if len(c.TimeFormat) > 0 {
|
|
||||||
timeFormat = c.TimeFormat
|
|
||||||
}
|
|
||||||
|
|
||||||
switch c.Mode {
|
|
||||||
case consoleMode:
|
|
||||||
setupWithConsole(c)
|
|
||||||
return nil
|
|
||||||
case volumeMode:
|
|
||||||
return setupWithVolume(c)
|
|
||||||
default:
|
|
||||||
return setupWithFiles(c)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Alert alerts v in alert level, and the message is written to error log.
|
// Alert alerts v in alert level, and the message is written to error log.
|
||||||
func Alert(v string) {
|
func Alert(v string) {
|
||||||
outputText(errorLog, levelAlert, v)
|
getWriter().Alert(v)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Close closes the logging.
|
// Close closes the logging.
|
||||||
func Close() error {
|
func Close() error {
|
||||||
if writeConsole {
|
if w := writer.Swap(nil); w != nil {
|
||||||
return nil
|
return w.(io.Closer).Close()
|
||||||
}
|
|
||||||
|
|
||||||
if atomic.LoadUint32(&initialized) == 0 {
|
|
||||||
return ErrLogNotInitialized
|
|
||||||
}
|
|
||||||
|
|
||||||
atomic.StoreUint32(&initialized, 0)
|
|
||||||
|
|
||||||
if infoLog != nil {
|
|
||||||
if err := infoLog.Close(); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if errorLog != nil {
|
|
||||||
if err := errorLog.Close(); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if severeLog != nil {
|
|
||||||
if err := severeLog.Close(); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if slowLog != nil {
|
|
||||||
if err := slowLog.Close(); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if statLog != nil {
|
|
||||||
if err := statLog.Close(); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
@@ -188,16 +69,7 @@ func Close() error {
|
|||||||
|
|
||||||
// Disable disables the logging.
|
// Disable disables the logging.
|
||||||
func Disable() {
|
func Disable() {
|
||||||
once.Do(func() {
|
writer.Store(nopWriter{})
|
||||||
atomic.StoreUint32(&initialized, 1)
|
|
||||||
|
|
||||||
infoLog = iox.NopCloser(ioutil.Discard)
|
|
||||||
errorLog = iox.NopCloser(ioutil.Discard)
|
|
||||||
severeLog = iox.NopCloser(ioutil.Discard)
|
|
||||||
slowLog = iox.NopCloser(ioutil.Discard)
|
|
||||||
statLog = iox.NopCloser(ioutil.Discard)
|
|
||||||
stackLog = ioutil.Discard
|
|
||||||
})
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// DisableStat disables the stat logs.
|
// DisableStat disables the stat logs.
|
||||||
@@ -207,22 +79,12 @@ func DisableStat() {
|
|||||||
|
|
||||||
// Error writes v into error log.
|
// Error writes v into error log.
|
||||||
func Error(v ...interface{}) {
|
func Error(v ...interface{}) {
|
||||||
ErrorCaller(1, v...)
|
errorTextSync(fmt.Sprint(v...))
|
||||||
}
|
|
||||||
|
|
||||||
// ErrorCaller writes v with context into error log.
|
|
||||||
func ErrorCaller(callDepth int, v ...interface{}) {
|
|
||||||
errorTextSync(fmt.Sprint(v...), callDepth+callerInnerDepth)
|
|
||||||
}
|
|
||||||
|
|
||||||
// ErrorCallerf writes v with context in format into error log.
|
|
||||||
func ErrorCallerf(callDepth int, format string, v ...interface{}) {
|
|
||||||
errorTextSync(fmt.Sprintf(format, v...), callDepth+callerInnerDepth)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Errorf writes v with format into error log.
|
// Errorf writes v with format into error log.
|
||||||
func Errorf(format string, v ...interface{}) {
|
func Errorf(format string, v ...interface{}) {
|
||||||
ErrorCallerf(1, format, v...)
|
errorTextSync(fmt.Errorf(format, v...).Error())
|
||||||
}
|
}
|
||||||
|
|
||||||
// ErrorStack writes v along with call stack into error log.
|
// ErrorStack writes v along with call stack into error log.
|
||||||
@@ -243,6 +105,49 @@ func Errorv(v interface{}) {
|
|||||||
errorAnySync(v)
|
errorAnySync(v)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Errorw writes msg along with fields into error log.
|
||||||
|
func Errorw(msg string, fields ...LogField) {
|
||||||
|
errorFieldsSync(msg, fields...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Field returns a LogField for the given key and value.
|
||||||
|
func Field(key string, value interface{}) LogField {
|
||||||
|
switch val := value.(type) {
|
||||||
|
case error:
|
||||||
|
return LogField{Key: key, Value: val.Error()}
|
||||||
|
case []error:
|
||||||
|
var errs []string
|
||||||
|
for _, err := range val {
|
||||||
|
errs = append(errs, err.Error())
|
||||||
|
}
|
||||||
|
return LogField{Key: key, Value: errs}
|
||||||
|
case time.Duration:
|
||||||
|
return LogField{Key: key, Value: fmt.Sprint(val)}
|
||||||
|
case []time.Duration:
|
||||||
|
var durs []string
|
||||||
|
for _, dur := range val {
|
||||||
|
durs = append(durs, fmt.Sprint(dur))
|
||||||
|
}
|
||||||
|
return LogField{Key: key, Value: durs}
|
||||||
|
case []time.Time:
|
||||||
|
var times []string
|
||||||
|
for _, t := range val {
|
||||||
|
times = append(times, fmt.Sprint(t))
|
||||||
|
}
|
||||||
|
return LogField{Key: key, Value: times}
|
||||||
|
case fmt.Stringer:
|
||||||
|
return LogField{Key: key, Value: val.String()}
|
||||||
|
case []fmt.Stringer:
|
||||||
|
var strs []string
|
||||||
|
for _, str := range val {
|
||||||
|
strs = append(strs, str.String())
|
||||||
|
}
|
||||||
|
return LogField{Key: key, Value: strs}
|
||||||
|
default:
|
||||||
|
return LogField{Key: key, Value: val}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// Info writes v into access log.
|
// Info writes v into access log.
|
||||||
func Info(v ...interface{}) {
|
func Info(v ...interface{}) {
|
||||||
infoTextSync(fmt.Sprint(v...))
|
infoTextSync(fmt.Sprint(v...))
|
||||||
@@ -258,14 +163,32 @@ func Infov(v interface{}) {
|
|||||||
infoAnySync(v)
|
infoAnySync(v)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Must checks if err is nil, otherwise logs the err and exits.
|
// Infow writes msg along with fields into access log.
|
||||||
|
func Infow(msg string, fields ...LogField) {
|
||||||
|
infoFieldsSync(msg, fields...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Must checks if err is nil, otherwise logs the error and exits.
|
||||||
func Must(err error) {
|
func Must(err error) {
|
||||||
if err != nil {
|
if err == nil {
|
||||||
msg := formatWithCaller(err.Error(), 3)
|
return
|
||||||
log.Print(msg)
|
|
||||||
outputText(severeLog, levelFatal, msg)
|
|
||||||
os.Exit(1)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
msg := err.Error()
|
||||||
|
log.Print(msg)
|
||||||
|
getWriter().Severe(msg)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
|
||||||
|
// MustSetup sets up logging with given config c. It exits on error.
|
||||||
|
func MustSetup(c LogConf) {
|
||||||
|
Must(SetUp(c))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Reset clears the writer and resets the log level.
|
||||||
|
func Reset() Writer {
|
||||||
|
SetLevel(InfoLevel)
|
||||||
|
return writer.Swap(nil)
|
||||||
}
|
}
|
||||||
|
|
||||||
// SetLevel sets the logging level. It can be used to suppress some logs.
|
// SetLevel sets the logging level. It can be used to suppress some logs.
|
||||||
@@ -273,6 +196,43 @@ func SetLevel(level uint32) {
|
|||||||
atomic.StoreUint32(&logLevel, level)
|
atomic.StoreUint32(&logLevel, level)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SetWriter sets the logging writer. It can be used to customize the logging.
|
||||||
|
// Call Reset before calling SetWriter again.
|
||||||
|
func SetWriter(w Writer) {
|
||||||
|
if writer.Load() == nil {
|
||||||
|
writer.Store(w)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetUp sets up the logx. If already set up, just return nil.
|
||||||
|
// we allow SetUp to be called multiple times, because for example
|
||||||
|
// we need to allow different service frameworks to initialize logx respectively.
|
||||||
|
// the same logic for SetUp
|
||||||
|
func SetUp(c LogConf) error {
|
||||||
|
setupLogLevel(c)
|
||||||
|
|
||||||
|
if len(c.TimeFormat) > 0 {
|
||||||
|
timeFormat = c.TimeFormat
|
||||||
|
}
|
||||||
|
|
||||||
|
switch c.Encoding {
|
||||||
|
case plainEncoding:
|
||||||
|
atomic.StoreUint32(&encoding, plainEncodingType)
|
||||||
|
default:
|
||||||
|
atomic.StoreUint32(&encoding, jsonEncodingType)
|
||||||
|
}
|
||||||
|
|
||||||
|
switch c.Mode {
|
||||||
|
case fileMode:
|
||||||
|
return setupWithFiles(c)
|
||||||
|
case volumeMode:
|
||||||
|
return setupWithVolume(c)
|
||||||
|
default:
|
||||||
|
setupWithConsole()
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// Severe writes v into severe log.
|
// Severe writes v into severe log.
|
||||||
func Severe(v ...interface{}) {
|
func Severe(v ...interface{}) {
|
||||||
severeSync(fmt.Sprint(v...))
|
severeSync(fmt.Sprint(v...))
|
||||||
@@ -298,6 +258,11 @@ func Slowv(v interface{}) {
|
|||||||
slowAnySync(v)
|
slowAnySync(v)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Sloww writes msg along with fields into slow log.
|
||||||
|
func Sloww(msg string, fields ...LogField) {
|
||||||
|
slowFieldsSync(msg, fields...)
|
||||||
|
}
|
||||||
|
|
||||||
// Stat writes v into stat log.
|
// Stat writes v into stat log.
|
||||||
func Stat(v ...interface{}) {
|
func Stat(v ...interface{}) {
|
||||||
statSync(fmt.Sprint(v...))
|
statSync(fmt.Sprint(v...))
|
||||||
@@ -340,52 +305,30 @@ func createOutput(path string) (io.WriteCloser, error) {
|
|||||||
|
|
||||||
func errorAnySync(v interface{}) {
|
func errorAnySync(v interface{}) {
|
||||||
if shallLog(ErrorLevel) {
|
if shallLog(ErrorLevel) {
|
||||||
outputAny(errorLog, levelError, v)
|
getWriter().Error(v)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func errorTextSync(msg string, callDepth int) {
|
func errorFieldsSync(content string, fields ...LogField) {
|
||||||
if shallLog(ErrorLevel) {
|
if shallLog(ErrorLevel) {
|
||||||
outputError(errorLog, msg, callDepth)
|
getWriter().Error(content, fields...)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func formatWithCaller(msg string, callDepth int) string {
|
func errorTextSync(msg string) {
|
||||||
var buf strings.Builder
|
if shallLog(ErrorLevel) {
|
||||||
|
getWriter().Error(msg)
|
||||||
caller := getCaller(callDepth)
|
|
||||||
if len(caller) > 0 {
|
|
||||||
buf.WriteString(caller)
|
|
||||||
buf.WriteByte(' ')
|
|
||||||
}
|
}
|
||||||
|
|
||||||
buf.WriteString(msg)
|
|
||||||
|
|
||||||
return buf.String()
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func getCaller(callDepth int) string {
|
func getWriter() Writer {
|
||||||
var buf strings.Builder
|
w := writer.Load()
|
||||||
|
if w == nil {
|
||||||
_, file, line, ok := runtime.Caller(callDepth)
|
w = newConsoleWriter()
|
||||||
if ok {
|
writer.Store(w)
|
||||||
short := file
|
|
||||||
for i := len(file) - 1; i > 0; i-- {
|
|
||||||
if file[i] == '/' {
|
|
||||||
short = file[i+1:]
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
buf.WriteString(short)
|
|
||||||
buf.WriteByte(':')
|
|
||||||
buf.WriteString(strconv.Itoa(line))
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return buf.String()
|
return w
|
||||||
}
|
|
||||||
|
|
||||||
func getTimestamp() string {
|
|
||||||
return timex.Time().Format(timeFormat)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func handleOptions(opts []LogOption) {
|
func handleOptions(opts []LogOption) {
|
||||||
@@ -396,46 +339,19 @@ func handleOptions(opts []LogOption) {
|
|||||||
|
|
||||||
func infoAnySync(val interface{}) {
|
func infoAnySync(val interface{}) {
|
||||||
if shallLog(InfoLevel) {
|
if shallLog(InfoLevel) {
|
||||||
outputAny(infoLog, levelInfo, val)
|
getWriter().Info(val)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func infoFieldsSync(content string, fields ...LogField) {
|
||||||
|
if shallLog(InfoLevel) {
|
||||||
|
getWriter().Info(content, fields...)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func infoTextSync(msg string) {
|
func infoTextSync(msg string) {
|
||||||
if shallLog(InfoLevel) {
|
if shallLog(InfoLevel) {
|
||||||
outputText(infoLog, levelInfo, msg)
|
getWriter().Info(msg)
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func outputAny(writer io.Writer, level string, val interface{}) {
|
|
||||||
info := logEntry{
|
|
||||||
Timestamp: getTimestamp(),
|
|
||||||
Level: level,
|
|
||||||
Content: val,
|
|
||||||
}
|
|
||||||
outputJson(writer, info)
|
|
||||||
}
|
|
||||||
|
|
||||||
func outputText(writer io.Writer, level, msg string) {
|
|
||||||
info := logEntry{
|
|
||||||
Timestamp: getTimestamp(),
|
|
||||||
Level: level,
|
|
||||||
Content: msg,
|
|
||||||
}
|
|
||||||
outputJson(writer, info)
|
|
||||||
}
|
|
||||||
|
|
||||||
func outputError(writer io.Writer, msg string, callDepth int) {
|
|
||||||
content := formatWithCaller(msg, callDepth)
|
|
||||||
outputText(writer, levelError, content)
|
|
||||||
}
|
|
||||||
|
|
||||||
func outputJson(writer io.Writer, info interface{}) {
|
|
||||||
if content, err := json.Marshal(info); err != nil {
|
|
||||||
log.Println(err.Error())
|
|
||||||
} else if atomic.LoadUint32(&initialized) == 0 || writer == nil {
|
|
||||||
log.Println(string(content))
|
|
||||||
} else {
|
|
||||||
writer.Write(append(content, '\n'))
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -450,72 +366,18 @@ func setupLogLevel(c LogConf) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func setupWithConsole(c LogConf) {
|
func setupWithConsole() {
|
||||||
once.Do(func() {
|
SetWriter(newConsoleWriter())
|
||||||
atomic.StoreUint32(&initialized, 1)
|
|
||||||
writeConsole = true
|
|
||||||
setupLogLevel(c)
|
|
||||||
|
|
||||||
infoLog = newLogWriter(log.New(os.Stdout, "", flags))
|
|
||||||
errorLog = newLogWriter(log.New(os.Stderr, "", flags))
|
|
||||||
severeLog = newLogWriter(log.New(os.Stderr, "", flags))
|
|
||||||
slowLog = newLogWriter(log.New(os.Stderr, "", flags))
|
|
||||||
stackLog = newLessWriter(errorLog, options.logStackCooldownMills)
|
|
||||||
statLog = infoLog
|
|
||||||
})
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func setupWithFiles(c LogConf) error {
|
func setupWithFiles(c LogConf) error {
|
||||||
var opts []LogOption
|
w, err := newFileWriter(c)
|
||||||
var err error
|
if err != nil {
|
||||||
|
return err
|
||||||
if len(c.Path) == 0 {
|
|
||||||
return ErrLogPathNotSet
|
|
||||||
}
|
}
|
||||||
|
|
||||||
opts = append(opts, WithCooldownMillis(c.StackCooldownMillis))
|
SetWriter(w)
|
||||||
if c.Compress {
|
return nil
|
||||||
opts = append(opts, WithGzip())
|
|
||||||
}
|
|
||||||
if c.KeepDays > 0 {
|
|
||||||
opts = append(opts, WithKeepDays(c.KeepDays))
|
|
||||||
}
|
|
||||||
|
|
||||||
accessFile := path.Join(c.Path, accessFilename)
|
|
||||||
errorFile := path.Join(c.Path, errorFilename)
|
|
||||||
severeFile := path.Join(c.Path, severeFilename)
|
|
||||||
slowFile := path.Join(c.Path, slowFilename)
|
|
||||||
statFile := path.Join(c.Path, statFilename)
|
|
||||||
|
|
||||||
once.Do(func() {
|
|
||||||
atomic.StoreUint32(&initialized, 1)
|
|
||||||
handleOptions(opts)
|
|
||||||
setupLogLevel(c)
|
|
||||||
|
|
||||||
if infoLog, err = createOutput(accessFile); err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if errorLog, err = createOutput(errorFile); err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if severeLog, err = createOutput(severeFile); err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if slowLog, err = createOutput(slowFile); err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if statLog, err = createOutput(statFile); err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
stackLog = newLessWriter(errorLog, options.logStackCooldownMills)
|
|
||||||
})
|
|
||||||
|
|
||||||
return err
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func setupWithVolume(c LogConf) error {
|
func setupWithVolume(c LogConf) error {
|
||||||
@@ -529,7 +391,7 @@ func setupWithVolume(c LogConf) error {
|
|||||||
|
|
||||||
func severeSync(msg string) {
|
func severeSync(msg string) {
|
||||||
if shallLog(SevereLevel) {
|
if shallLog(SevereLevel) {
|
||||||
outputText(severeLog, levelSevere, fmt.Sprintf("%s\n%s", msg, string(debug.Stack())))
|
getWriter().Severe(fmt.Sprintf("%s\n%s", msg, string(debug.Stack())))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -543,43 +405,30 @@ func shallLogStat() bool {
|
|||||||
|
|
||||||
func slowAnySync(v interface{}) {
|
func slowAnySync(v interface{}) {
|
||||||
if shallLog(ErrorLevel) {
|
if shallLog(ErrorLevel) {
|
||||||
outputAny(slowLog, levelSlow, v)
|
getWriter().Slow(v)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func slowFieldsSync(content string, fields ...LogField) {
|
||||||
|
if shallLog(ErrorLevel) {
|
||||||
|
getWriter().Slow(content, fields...)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func slowTextSync(msg string) {
|
func slowTextSync(msg string) {
|
||||||
if shallLog(ErrorLevel) {
|
if shallLog(ErrorLevel) {
|
||||||
outputText(slowLog, levelSlow, msg)
|
getWriter().Slow(msg)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func stackSync(msg string) {
|
func stackSync(msg string) {
|
||||||
if shallLog(ErrorLevel) {
|
if shallLog(ErrorLevel) {
|
||||||
outputText(stackLog, levelError, fmt.Sprintf("%s\n%s", msg, string(debug.Stack())))
|
getWriter().Stack(fmt.Sprintf("%s\n%s", msg, string(debug.Stack())))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func statSync(msg string) {
|
func statSync(msg string) {
|
||||||
if shallLogStat() && shallLog(InfoLevel) {
|
if shallLogStat() && shallLog(InfoLevel) {
|
||||||
outputText(statLog, levelStat, msg)
|
getWriter().Stat(msg)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
type logWriter struct {
|
|
||||||
logger *log.Logger
|
|
||||||
}
|
|
||||||
|
|
||||||
func newLogWriter(logger *log.Logger) logWriter {
|
|
||||||
return logWriter{
|
|
||||||
logger: logger,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (lw logWriter) Close() error {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (lw logWriter) Write(data []byte) (int, error) {
|
|
||||||
lw.logger.Print(string(data))
|
|
||||||
return len(data), nil
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -2,11 +2,12 @@ package logx
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
|
||||||
"io/ioutil"
|
"io/ioutil"
|
||||||
"log"
|
"log"
|
||||||
"os"
|
"os"
|
||||||
|
"reflect"
|
||||||
"runtime"
|
"runtime"
|
||||||
"strings"
|
"strings"
|
||||||
"sync"
|
"sync"
|
||||||
@@ -18,8 +19,9 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
var (
|
var (
|
||||||
s = []byte("Sending #11 notification (id: 1451875113812010473) in #1 connection")
|
s = []byte("Sending #11 notification (id: 1451875113812010473) in #1 connection")
|
||||||
pool = make(chan []byte, 1)
|
pool = make(chan []byte, 1)
|
||||||
|
_ Writer = (*mockWriter)(nil)
|
||||||
)
|
)
|
||||||
|
|
||||||
type mockWriter struct {
|
type mockWriter struct {
|
||||||
@@ -27,10 +29,46 @@ type mockWriter struct {
|
|||||||
builder strings.Builder
|
builder strings.Builder
|
||||||
}
|
}
|
||||||
|
|
||||||
func (mw *mockWriter) Write(data []byte) (int, error) {
|
func (mw *mockWriter) Alert(v interface{}) {
|
||||||
mw.lock.Lock()
|
mw.lock.Lock()
|
||||||
defer mw.lock.Unlock()
|
defer mw.lock.Unlock()
|
||||||
return mw.builder.Write(data)
|
output(&mw.builder, levelAlert, v)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (mw *mockWriter) Error(v interface{}, fields ...LogField) {
|
||||||
|
mw.lock.Lock()
|
||||||
|
defer mw.lock.Unlock()
|
||||||
|
output(&mw.builder, levelError, v, fields...)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (mw *mockWriter) Info(v interface{}, fields ...LogField) {
|
||||||
|
mw.lock.Lock()
|
||||||
|
defer mw.lock.Unlock()
|
||||||
|
output(&mw.builder, levelInfo, v, fields...)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (mw *mockWriter) Severe(v interface{}) {
|
||||||
|
mw.lock.Lock()
|
||||||
|
defer mw.lock.Unlock()
|
||||||
|
output(&mw.builder, levelSevere, v)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (mw *mockWriter) Slow(v interface{}, fields ...LogField) {
|
||||||
|
mw.lock.Lock()
|
||||||
|
defer mw.lock.Unlock()
|
||||||
|
output(&mw.builder, levelSlow, v, fields...)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (mw *mockWriter) Stack(v interface{}) {
|
||||||
|
mw.lock.Lock()
|
||||||
|
defer mw.lock.Unlock()
|
||||||
|
output(&mw.builder, levelError, v)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (mw *mockWriter) Stat(v interface{}, fields ...LogField) {
|
||||||
|
mw.lock.Lock()
|
||||||
|
defer mw.lock.Unlock()
|
||||||
|
output(&mw.builder, levelStat, v, fields...)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (mw *mockWriter) Close() error {
|
func (mw *mockWriter) Close() error {
|
||||||
@@ -55,155 +93,376 @@ func (mw *mockWriter) String() string {
|
|||||||
return mw.builder.String()
|
return mw.builder.String()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestField(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
f LogField
|
||||||
|
want map[string]interface{}
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "error",
|
||||||
|
f: Field("foo", errors.New("bar")),
|
||||||
|
want: map[string]interface{}{
|
||||||
|
"foo": "bar",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "errors",
|
||||||
|
f: Field("foo", []error{errors.New("bar"), errors.New("baz")}),
|
||||||
|
want: map[string]interface{}{
|
||||||
|
"foo": []interface{}{"bar", "baz"},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "strings",
|
||||||
|
f: Field("foo", []string{"bar", "baz"}),
|
||||||
|
want: map[string]interface{}{
|
||||||
|
"foo": []interface{}{"bar", "baz"},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "duration",
|
||||||
|
f: Field("foo", time.Second),
|
||||||
|
want: map[string]interface{}{
|
||||||
|
"foo": "1s",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "durations",
|
||||||
|
f: Field("foo", []time.Duration{time.Second, 2 * time.Second}),
|
||||||
|
want: map[string]interface{}{
|
||||||
|
"foo": []interface{}{"1s", "2s"},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "times",
|
||||||
|
f: Field("foo", []time.Time{
|
||||||
|
time.Date(2020, time.January, 1, 0, 0, 0, 0, time.UTC),
|
||||||
|
time.Date(2020, time.January, 2, 0, 0, 0, 0, time.UTC),
|
||||||
|
}),
|
||||||
|
want: map[string]interface{}{
|
||||||
|
"foo": []interface{}{"2020-01-01 00:00:00 +0000 UTC", "2020-01-02 00:00:00 +0000 UTC"},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "stringer",
|
||||||
|
f: Field("foo", ValStringer{val: "bar"}),
|
||||||
|
want: map[string]interface{}{
|
||||||
|
"foo": "bar",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "stringers",
|
||||||
|
f: Field("foo", []fmt.Stringer{ValStringer{val: "bar"}, ValStringer{val: "baz"}}),
|
||||||
|
want: map[string]interface{}{
|
||||||
|
"foo": []interface{}{"bar", "baz"},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, test := range tests {
|
||||||
|
test := test
|
||||||
|
t.Run(test.name, func(t *testing.T) {
|
||||||
|
w := new(mockWriter)
|
||||||
|
old := writer.Swap(w)
|
||||||
|
defer writer.Store(old)
|
||||||
|
|
||||||
|
Infow("foo", test.f)
|
||||||
|
validateFields(t, w.String(), test.want)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestFileLineFileMode(t *testing.T) {
|
func TestFileLineFileMode(t *testing.T) {
|
||||||
writer := new(mockWriter)
|
w := new(mockWriter)
|
||||||
errorLog = writer
|
old := writer.Swap(w)
|
||||||
atomic.StoreUint32(&initialized, 1)
|
defer writer.Store(old)
|
||||||
|
|
||||||
file, line := getFileLine()
|
file, line := getFileLine()
|
||||||
Error("anything")
|
Error("anything")
|
||||||
assert.True(t, writer.Contains(fmt.Sprintf("%s:%d", file, line+1)))
|
assert.True(t, w.Contains(fmt.Sprintf("%s:%d", file, line+1)))
|
||||||
|
|
||||||
writer.Reset()
|
|
||||||
file, line = getFileLine()
|
file, line = getFileLine()
|
||||||
Errorf("anything %s", "format")
|
Errorf("anything %s", "format")
|
||||||
assert.True(t, writer.Contains(fmt.Sprintf("%s:%d", file, line+1)))
|
assert.True(t, w.Contains(fmt.Sprintf("%s:%d", file, line+1)))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestFileLineConsoleMode(t *testing.T) {
|
func TestFileLineConsoleMode(t *testing.T) {
|
||||||
writer := new(mockWriter)
|
w := new(mockWriter)
|
||||||
writeConsole = true
|
old := writer.Swap(w)
|
||||||
errorLog = newLogWriter(log.New(writer, "[ERROR] ", flags))
|
defer writer.Store(old)
|
||||||
atomic.StoreUint32(&initialized, 1)
|
|
||||||
file, line := getFileLine()
|
file, line := getFileLine()
|
||||||
Error("anything")
|
Error("anything")
|
||||||
assert.True(t, writer.Contains(fmt.Sprintf("%s:%d", file, line+1)))
|
assert.True(t, w.Contains(fmt.Sprintf("%s:%d", file, line+1)))
|
||||||
|
|
||||||
writer.Reset()
|
w.Reset()
|
||||||
file, line = getFileLine()
|
file, line = getFileLine()
|
||||||
Errorf("anything %s", "format")
|
Errorf("anything %s", "format")
|
||||||
assert.True(t, writer.Contains(fmt.Sprintf("%s:%d", file, line+1)))
|
assert.True(t, w.Contains(fmt.Sprintf("%s:%d", file, line+1)))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestStructedLogAlert(t *testing.T) {
|
func TestStructedLogAlert(t *testing.T) {
|
||||||
doTestStructedLog(t, levelAlert, func(writer io.WriteCloser) {
|
w := new(mockWriter)
|
||||||
errorLog = writer
|
old := writer.Swap(w)
|
||||||
}, func(v ...interface{}) {
|
defer writer.Store(old)
|
||||||
|
|
||||||
|
doTestStructedLog(t, levelAlert, w, func(v ...interface{}) {
|
||||||
Alert(fmt.Sprint(v...))
|
Alert(fmt.Sprint(v...))
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestStructedLogError(t *testing.T) {
|
func TestStructedLogError(t *testing.T) {
|
||||||
doTestStructedLog(t, levelError, func(writer io.WriteCloser) {
|
w := new(mockWriter)
|
||||||
errorLog = writer
|
old := writer.Swap(w)
|
||||||
}, func(v ...interface{}) {
|
defer writer.Store(old)
|
||||||
|
|
||||||
|
doTestStructedLog(t, levelError, w, func(v ...interface{}) {
|
||||||
Error(v...)
|
Error(v...)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestStructedLogErrorf(t *testing.T) {
|
func TestStructedLogErrorf(t *testing.T) {
|
||||||
doTestStructedLog(t, levelError, func(writer io.WriteCloser) {
|
w := new(mockWriter)
|
||||||
errorLog = writer
|
old := writer.Swap(w)
|
||||||
}, func(v ...interface{}) {
|
defer writer.Store(old)
|
||||||
|
|
||||||
|
doTestStructedLog(t, levelError, w, func(v ...interface{}) {
|
||||||
Errorf("%s", fmt.Sprint(v...))
|
Errorf("%s", fmt.Sprint(v...))
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestStructedLogErrorv(t *testing.T) {
|
func TestStructedLogErrorv(t *testing.T) {
|
||||||
doTestStructedLog(t, levelError, func(writer io.WriteCloser) {
|
w := new(mockWriter)
|
||||||
errorLog = writer
|
old := writer.Swap(w)
|
||||||
}, func(v ...interface{}) {
|
defer writer.Store(old)
|
||||||
|
|
||||||
|
doTestStructedLog(t, levelError, w, func(v ...interface{}) {
|
||||||
Errorv(fmt.Sprint(v...))
|
Errorv(fmt.Sprint(v...))
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestStructedLogErrorw(t *testing.T) {
|
||||||
|
w := new(mockWriter)
|
||||||
|
old := writer.Swap(w)
|
||||||
|
defer writer.Store(old)
|
||||||
|
|
||||||
|
doTestStructedLog(t, levelError, w, func(v ...interface{}) {
|
||||||
|
Errorw(fmt.Sprint(v...), Field("foo", "bar"))
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
func TestStructedLogInfo(t *testing.T) {
|
func TestStructedLogInfo(t *testing.T) {
|
||||||
doTestStructedLog(t, levelInfo, func(writer io.WriteCloser) {
|
w := new(mockWriter)
|
||||||
infoLog = writer
|
old := writer.Swap(w)
|
||||||
}, func(v ...interface{}) {
|
defer writer.Store(old)
|
||||||
|
|
||||||
|
doTestStructedLog(t, levelInfo, w, func(v ...interface{}) {
|
||||||
Info(v...)
|
Info(v...)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestStructedLogInfof(t *testing.T) {
|
func TestStructedLogInfof(t *testing.T) {
|
||||||
doTestStructedLog(t, levelInfo, func(writer io.WriteCloser) {
|
w := new(mockWriter)
|
||||||
infoLog = writer
|
old := writer.Swap(w)
|
||||||
}, func(v ...interface{}) {
|
defer writer.Store(old)
|
||||||
|
|
||||||
|
doTestStructedLog(t, levelInfo, w, func(v ...interface{}) {
|
||||||
Infof("%s", fmt.Sprint(v...))
|
Infof("%s", fmt.Sprint(v...))
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestStructedLogInfov(t *testing.T) {
|
func TestStructedLogInfov(t *testing.T) {
|
||||||
doTestStructedLog(t, levelInfo, func(writer io.WriteCloser) {
|
w := new(mockWriter)
|
||||||
infoLog = writer
|
old := writer.Swap(w)
|
||||||
}, func(v ...interface{}) {
|
defer writer.Store(old)
|
||||||
|
|
||||||
|
doTestStructedLog(t, levelInfo, w, func(v ...interface{}) {
|
||||||
Infov(fmt.Sprint(v...))
|
Infov(fmt.Sprint(v...))
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestStructedLogInfow(t *testing.T) {
|
||||||
|
w := new(mockWriter)
|
||||||
|
old := writer.Swap(w)
|
||||||
|
defer writer.Store(old)
|
||||||
|
|
||||||
|
doTestStructedLog(t, levelInfo, w, func(v ...interface{}) {
|
||||||
|
Infow(fmt.Sprint(v...), Field("foo", "bar"))
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestStructedLogInfoConsoleAny(t *testing.T) {
|
||||||
|
w := new(mockWriter)
|
||||||
|
old := writer.Swap(w)
|
||||||
|
defer writer.Store(old)
|
||||||
|
|
||||||
|
doTestStructedLogConsole(t, w, func(v ...interface{}) {
|
||||||
|
old := atomic.LoadUint32(&encoding)
|
||||||
|
atomic.StoreUint32(&encoding, plainEncodingType)
|
||||||
|
defer func() {
|
||||||
|
atomic.StoreUint32(&encoding, old)
|
||||||
|
}()
|
||||||
|
|
||||||
|
Infov(v)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestStructedLogInfoConsoleAnyString(t *testing.T) {
|
||||||
|
w := new(mockWriter)
|
||||||
|
old := writer.Swap(w)
|
||||||
|
defer writer.Store(old)
|
||||||
|
|
||||||
|
doTestStructedLogConsole(t, w, func(v ...interface{}) {
|
||||||
|
old := atomic.LoadUint32(&encoding)
|
||||||
|
atomic.StoreUint32(&encoding, plainEncodingType)
|
||||||
|
defer func() {
|
||||||
|
atomic.StoreUint32(&encoding, old)
|
||||||
|
}()
|
||||||
|
|
||||||
|
Infov(fmt.Sprint(v...))
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestStructedLogInfoConsoleAnyError(t *testing.T) {
|
||||||
|
w := new(mockWriter)
|
||||||
|
old := writer.Swap(w)
|
||||||
|
defer writer.Store(old)
|
||||||
|
|
||||||
|
doTestStructedLogConsole(t, w, func(v ...interface{}) {
|
||||||
|
old := atomic.LoadUint32(&encoding)
|
||||||
|
atomic.StoreUint32(&encoding, plainEncodingType)
|
||||||
|
defer func() {
|
||||||
|
atomic.StoreUint32(&encoding, old)
|
||||||
|
}()
|
||||||
|
|
||||||
|
Infov(errors.New(fmt.Sprint(v...)))
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestStructedLogInfoConsoleAnyStringer(t *testing.T) {
|
||||||
|
w := new(mockWriter)
|
||||||
|
old := writer.Swap(w)
|
||||||
|
defer writer.Store(old)
|
||||||
|
|
||||||
|
doTestStructedLogConsole(t, w, func(v ...interface{}) {
|
||||||
|
old := atomic.LoadUint32(&encoding)
|
||||||
|
atomic.StoreUint32(&encoding, plainEncodingType)
|
||||||
|
defer func() {
|
||||||
|
atomic.StoreUint32(&encoding, old)
|
||||||
|
}()
|
||||||
|
|
||||||
|
Infov(ValStringer{
|
||||||
|
val: fmt.Sprint(v...),
|
||||||
|
})
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestStructedLogInfoConsoleText(t *testing.T) {
|
||||||
|
w := new(mockWriter)
|
||||||
|
old := writer.Swap(w)
|
||||||
|
defer writer.Store(old)
|
||||||
|
|
||||||
|
doTestStructedLogConsole(t, w, func(v ...interface{}) {
|
||||||
|
old := atomic.LoadUint32(&encoding)
|
||||||
|
atomic.StoreUint32(&encoding, plainEncodingType)
|
||||||
|
defer func() {
|
||||||
|
atomic.StoreUint32(&encoding, old)
|
||||||
|
}()
|
||||||
|
|
||||||
|
Info(fmt.Sprint(v...))
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
func TestStructedLogSlow(t *testing.T) {
|
func TestStructedLogSlow(t *testing.T) {
|
||||||
doTestStructedLog(t, levelSlow, func(writer io.WriteCloser) {
|
w := new(mockWriter)
|
||||||
slowLog = writer
|
old := writer.Swap(w)
|
||||||
}, func(v ...interface{}) {
|
defer writer.Store(old)
|
||||||
|
|
||||||
|
doTestStructedLog(t, levelSlow, w, func(v ...interface{}) {
|
||||||
Slow(v...)
|
Slow(v...)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestStructedLogSlowf(t *testing.T) {
|
func TestStructedLogSlowf(t *testing.T) {
|
||||||
doTestStructedLog(t, levelSlow, func(writer io.WriteCloser) {
|
w := new(mockWriter)
|
||||||
slowLog = writer
|
old := writer.Swap(w)
|
||||||
}, func(v ...interface{}) {
|
defer writer.Store(old)
|
||||||
|
|
||||||
|
doTestStructedLog(t, levelSlow, w, func(v ...interface{}) {
|
||||||
Slowf(fmt.Sprint(v...))
|
Slowf(fmt.Sprint(v...))
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestStructedLogSlowv(t *testing.T) {
|
func TestStructedLogSlowv(t *testing.T) {
|
||||||
doTestStructedLog(t, levelSlow, func(writer io.WriteCloser) {
|
w := new(mockWriter)
|
||||||
slowLog = writer
|
old := writer.Swap(w)
|
||||||
}, func(v ...interface{}) {
|
defer writer.Store(old)
|
||||||
|
|
||||||
|
doTestStructedLog(t, levelSlow, w, func(v ...interface{}) {
|
||||||
Slowv(fmt.Sprint(v...))
|
Slowv(fmt.Sprint(v...))
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestStructedLogSloww(t *testing.T) {
|
||||||
|
w := new(mockWriter)
|
||||||
|
old := writer.Swap(w)
|
||||||
|
defer writer.Store(old)
|
||||||
|
|
||||||
|
doTestStructedLog(t, levelSlow, w, func(v ...interface{}) {
|
||||||
|
Sloww(fmt.Sprint(v...), Field("foo", time.Second))
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
func TestStructedLogStat(t *testing.T) {
|
func TestStructedLogStat(t *testing.T) {
|
||||||
doTestStructedLog(t, levelStat, func(writer io.WriteCloser) {
|
w := new(mockWriter)
|
||||||
statLog = writer
|
old := writer.Swap(w)
|
||||||
}, func(v ...interface{}) {
|
defer writer.Store(old)
|
||||||
|
|
||||||
|
doTestStructedLog(t, levelStat, w, func(v ...interface{}) {
|
||||||
Stat(v...)
|
Stat(v...)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestStructedLogStatf(t *testing.T) {
|
func TestStructedLogStatf(t *testing.T) {
|
||||||
doTestStructedLog(t, levelStat, func(writer io.WriteCloser) {
|
w := new(mockWriter)
|
||||||
statLog = writer
|
old := writer.Swap(w)
|
||||||
}, func(v ...interface{}) {
|
defer writer.Store(old)
|
||||||
|
|
||||||
|
doTestStructedLog(t, levelStat, w, func(v ...interface{}) {
|
||||||
Statf(fmt.Sprint(v...))
|
Statf(fmt.Sprint(v...))
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestStructedLogSevere(t *testing.T) {
|
func TestStructedLogSevere(t *testing.T) {
|
||||||
doTestStructedLog(t, levelSevere, func(writer io.WriteCloser) {
|
w := new(mockWriter)
|
||||||
severeLog = writer
|
old := writer.Swap(w)
|
||||||
}, func(v ...interface{}) {
|
defer writer.Store(old)
|
||||||
|
|
||||||
|
doTestStructedLog(t, levelSevere, w, func(v ...interface{}) {
|
||||||
Severe(v...)
|
Severe(v...)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestStructedLogSeveref(t *testing.T) {
|
func TestStructedLogSeveref(t *testing.T) {
|
||||||
doTestStructedLog(t, levelSevere, func(writer io.WriteCloser) {
|
w := new(mockWriter)
|
||||||
severeLog = writer
|
old := writer.Swap(w)
|
||||||
}, func(v ...interface{}) {
|
defer writer.Store(old)
|
||||||
|
|
||||||
|
doTestStructedLog(t, levelSevere, w, func(v ...interface{}) {
|
||||||
Severef(fmt.Sprint(v...))
|
Severef(fmt.Sprint(v...))
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestStructedLogWithDuration(t *testing.T) {
|
func TestStructedLogWithDuration(t *testing.T) {
|
||||||
const message = "hello there"
|
const message = "hello there"
|
||||||
writer := new(mockWriter)
|
w := new(mockWriter)
|
||||||
infoLog = writer
|
old := writer.Swap(w)
|
||||||
atomic.StoreUint32(&initialized, 1)
|
defer writer.Store(old)
|
||||||
|
|
||||||
WithDuration(time.Second).Info(message)
|
WithDuration(time.Second).Info(message)
|
||||||
var entry logEntry
|
var entry logEntry
|
||||||
if err := json.Unmarshal([]byte(writer.builder.String()), &entry); err != nil {
|
if err := json.Unmarshal([]byte(w.String()), &entry); err != nil {
|
||||||
t.Error(err)
|
t.Error(err)
|
||||||
}
|
}
|
||||||
assert.Equal(t, levelInfo, entry.Level)
|
assert.Equal(t, levelInfo, entry.Level)
|
||||||
@@ -214,11 +473,12 @@ func TestStructedLogWithDuration(t *testing.T) {
|
|||||||
func TestSetLevel(t *testing.T) {
|
func TestSetLevel(t *testing.T) {
|
||||||
SetLevel(ErrorLevel)
|
SetLevel(ErrorLevel)
|
||||||
const message = "hello there"
|
const message = "hello there"
|
||||||
writer := new(mockWriter)
|
w := new(mockWriter)
|
||||||
infoLog = writer
|
old := writer.Swap(w)
|
||||||
atomic.StoreUint32(&initialized, 1)
|
defer writer.Store(old)
|
||||||
|
|
||||||
Info(message)
|
Info(message)
|
||||||
assert.Equal(t, 0, writer.builder.Len())
|
assert.Equal(t, 0, w.builder.Len())
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestSetLevelTwiceWithMode(t *testing.T) {
|
func TestSetLevelTwiceWithMode(t *testing.T) {
|
||||||
@@ -227,19 +487,35 @@ func TestSetLevelTwiceWithMode(t *testing.T) {
|
|||||||
"console",
|
"console",
|
||||||
"volumn",
|
"volumn",
|
||||||
}
|
}
|
||||||
|
w := new(mockWriter)
|
||||||
|
old := writer.Swap(w)
|
||||||
|
defer writer.Store(old)
|
||||||
|
|
||||||
for _, mode := range testModes {
|
for _, mode := range testModes {
|
||||||
testSetLevelTwiceWithMode(t, mode)
|
testSetLevelTwiceWithMode(t, mode, w)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestSetLevelWithDuration(t *testing.T) {
|
func TestSetLevelWithDuration(t *testing.T) {
|
||||||
SetLevel(ErrorLevel)
|
SetLevel(ErrorLevel)
|
||||||
const message = "hello there"
|
const message = "hello there"
|
||||||
writer := new(mockWriter)
|
w := new(mockWriter)
|
||||||
infoLog = writer
|
old := writer.Swap(w)
|
||||||
atomic.StoreUint32(&initialized, 1)
|
defer writer.Store(old)
|
||||||
|
|
||||||
WithDuration(time.Second).Info(message)
|
WithDuration(time.Second).Info(message)
|
||||||
assert.Equal(t, 0, writer.builder.Len())
|
assert.Equal(t, 0, w.builder.Len())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestErrorfWithWrappedError(t *testing.T) {
|
||||||
|
SetLevel(ErrorLevel)
|
||||||
|
const message = "there"
|
||||||
|
w := new(mockWriter)
|
||||||
|
old := writer.Swap(w)
|
||||||
|
defer writer.Store(old)
|
||||||
|
|
||||||
|
Errorf("hello %w", errors.New(message))
|
||||||
|
assert.True(t, strings.Contains(w.String(), "hello there"))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestMustNil(t *testing.T) {
|
func TestMustNil(t *testing.T) {
|
||||||
@@ -247,6 +523,11 @@ func TestMustNil(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func TestSetup(t *testing.T) {
|
func TestSetup(t *testing.T) {
|
||||||
|
defer func() {
|
||||||
|
SetLevel(InfoLevel)
|
||||||
|
atomic.StoreUint32(&encoding, jsonEncodingType)
|
||||||
|
}()
|
||||||
|
|
||||||
MustSetup(LogConf{
|
MustSetup(LogConf{
|
||||||
ServiceName: "any",
|
ServiceName: "any",
|
||||||
Mode: "console",
|
Mode: "console",
|
||||||
@@ -261,6 +542,17 @@ func TestSetup(t *testing.T) {
|
|||||||
Mode: "volume",
|
Mode: "volume",
|
||||||
Path: os.TempDir(),
|
Path: os.TempDir(),
|
||||||
})
|
})
|
||||||
|
MustSetup(LogConf{
|
||||||
|
ServiceName: "any",
|
||||||
|
Mode: "console",
|
||||||
|
TimeFormat: timeFormat,
|
||||||
|
})
|
||||||
|
MustSetup(LogConf{
|
||||||
|
ServiceName: "any",
|
||||||
|
Mode: "console",
|
||||||
|
Encoding: plainEncoding,
|
||||||
|
})
|
||||||
|
|
||||||
assert.NotNil(t, setupWithVolume(LogConf{}))
|
assert.NotNil(t, setupWithVolume(LogConf{}))
|
||||||
assert.NotNil(t, setupWithFiles(LogConf{}))
|
assert.NotNil(t, setupWithFiles(LogConf{}))
|
||||||
assert.Nil(t, setupWithFiles(LogConf{
|
assert.Nil(t, setupWithFiles(LogConf{
|
||||||
@@ -281,6 +573,8 @@ func TestSetup(t *testing.T) {
|
|||||||
_, err := createOutput("")
|
_, err := createOutput("")
|
||||||
assert.NotNil(t, err)
|
assert.NotNil(t, err)
|
||||||
Disable()
|
Disable()
|
||||||
|
SetLevel(InfoLevel)
|
||||||
|
atomic.StoreUint32(&encoding, jsonEncodingType)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestDisable(t *testing.T) {
|
func TestDisable(t *testing.T) {
|
||||||
@@ -290,7 +584,6 @@ func TestDisable(t *testing.T) {
|
|||||||
WithKeepDays(1)(&opt)
|
WithKeepDays(1)(&opt)
|
||||||
WithGzip()(&opt)
|
WithGzip()(&opt)
|
||||||
assert.Nil(t, Close())
|
assert.Nil(t, Close())
|
||||||
writeConsole = false
|
|
||||||
assert.Nil(t, Close())
|
assert.Nil(t, Close())
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -298,11 +591,20 @@ func TestDisableStat(t *testing.T) {
|
|||||||
DisableStat()
|
DisableStat()
|
||||||
|
|
||||||
const message = "hello there"
|
const message = "hello there"
|
||||||
writer := new(mockWriter)
|
w := new(mockWriter)
|
||||||
statLog = writer
|
old := writer.Swap(w)
|
||||||
atomic.StoreUint32(&initialized, 1)
|
defer writer.Store(old)
|
||||||
Stat(message)
|
Stat(message)
|
||||||
assert.Equal(t, 0, writer.builder.Len())
|
assert.Equal(t, 0, w.builder.Len())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSetWriter(t *testing.T) {
|
||||||
|
Reset()
|
||||||
|
SetWriter(nopWriter{})
|
||||||
|
assert.NotNil(t, writer.Load())
|
||||||
|
assert.True(t, writer.Load() == nopWriter{})
|
||||||
|
SetWriter(new(mockWriter))
|
||||||
|
assert.True(t, writer.Load() == nopWriter{})
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestWithGzip(t *testing.T) {
|
func TestWithGzip(t *testing.T) {
|
||||||
@@ -404,15 +706,12 @@ func put(b []byte) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func doTestStructedLog(t *testing.T, level string, setup func(writer io.WriteCloser),
|
func doTestStructedLog(t *testing.T, level string, w *mockWriter, write func(...interface{})) {
|
||||||
write func(...interface{})) {
|
|
||||||
const message = "hello there"
|
const message = "hello there"
|
||||||
writer := new(mockWriter)
|
|
||||||
setup(writer)
|
|
||||||
atomic.StoreUint32(&initialized, 1)
|
|
||||||
write(message)
|
write(message)
|
||||||
|
fmt.Println(w.String())
|
||||||
var entry logEntry
|
var entry logEntry
|
||||||
if err := json.Unmarshal([]byte(writer.builder.String()), &entry); err != nil {
|
if err := json.Unmarshal([]byte(w.String()), &entry); err != nil {
|
||||||
t.Error(err)
|
t.Error(err)
|
||||||
}
|
}
|
||||||
assert.Equal(t, level, entry.Level)
|
assert.Equal(t, level, entry.Level)
|
||||||
@@ -421,7 +720,14 @@ func doTestStructedLog(t *testing.T, level string, setup func(writer io.WriteClo
|
|||||||
assert.True(t, strings.Contains(val, message))
|
assert.True(t, strings.Contains(val, message))
|
||||||
}
|
}
|
||||||
|
|
||||||
func testSetLevelTwiceWithMode(t *testing.T, mode string) {
|
func doTestStructedLogConsole(t *testing.T, w *mockWriter, write func(...interface{})) {
|
||||||
|
const message = "hello there"
|
||||||
|
write(message)
|
||||||
|
assert.True(t, strings.Contains(w.String(), message))
|
||||||
|
}
|
||||||
|
|
||||||
|
func testSetLevelTwiceWithMode(t *testing.T, mode string, w *mockWriter) {
|
||||||
|
writer.Store(nil)
|
||||||
SetUp(LogConf{
|
SetUp(LogConf{
|
||||||
Mode: mode,
|
Mode: mode,
|
||||||
Level: "error",
|
Level: "error",
|
||||||
@@ -433,15 +739,35 @@ func testSetLevelTwiceWithMode(t *testing.T, mode string) {
|
|||||||
Path: "/dev/null",
|
Path: "/dev/null",
|
||||||
})
|
})
|
||||||
const message = "hello there"
|
const message = "hello there"
|
||||||
writer := new(mockWriter)
|
|
||||||
infoLog = writer
|
|
||||||
atomic.StoreUint32(&initialized, 1)
|
|
||||||
Info(message)
|
Info(message)
|
||||||
assert.Equal(t, 0, writer.builder.Len())
|
assert.Equal(t, 0, w.builder.Len())
|
||||||
Infof(message)
|
Infof(message)
|
||||||
assert.Equal(t, 0, writer.builder.Len())
|
assert.Equal(t, 0, w.builder.Len())
|
||||||
ErrorStack(message)
|
ErrorStack(message)
|
||||||
assert.Equal(t, 0, writer.builder.Len())
|
assert.Equal(t, 0, w.builder.Len())
|
||||||
ErrorStackf(message)
|
ErrorStackf(message)
|
||||||
assert.Equal(t, 0, writer.builder.Len())
|
assert.Equal(t, 0, w.builder.Len())
|
||||||
|
}
|
||||||
|
|
||||||
|
type ValStringer struct {
|
||||||
|
val string
|
||||||
|
}
|
||||||
|
|
||||||
|
func (v ValStringer) String() string {
|
||||||
|
return v.val
|
||||||
|
}
|
||||||
|
|
||||||
|
func validateFields(t *testing.T, content string, fields map[string]interface{}) {
|
||||||
|
var m map[string]interface{}
|
||||||
|
if err := json.Unmarshal([]byte(content), &m); err != nil {
|
||||||
|
t.Error(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
for k, v := range fields {
|
||||||
|
if reflect.TypeOf(v).Kind() == reflect.Slice {
|
||||||
|
assert.EqualValues(t, v, m[k])
|
||||||
|
} else {
|
||||||
|
assert.Equal(t, v, m[k], content)
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
22
core/logx/logwriter.go
Normal file
22
core/logx/logwriter.go
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
package logx
|
||||||
|
|
||||||
|
import "log"
|
||||||
|
|
||||||
|
type logWriter struct {
|
||||||
|
logger *log.Logger
|
||||||
|
}
|
||||||
|
|
||||||
|
func newLogWriter(logger *log.Logger) logWriter {
|
||||||
|
return logWriter{
|
||||||
|
logger: logger,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (lw logWriter) Close() error {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (lw logWriter) Write(data []byte) (int, error) {
|
||||||
|
lw.logger.Print(string(data))
|
||||||
|
return len(data), nil
|
||||||
|
}
|
||||||
197
core/logx/readme-cn.md
Normal file
197
core/logx/readme-cn.md
Normal file
@@ -0,0 +1,197 @@
|
|||||||
|
<IMG align="right" width="150px" src="https://raw.githubusercontent.com/zeromicro/zero-doc/main/doc/images/go-zero.png">
|
||||||
|
|
||||||
|
# logx
|
||||||
|
|
||||||
|
[English](readme.md) | 简体中文
|
||||||
|
|
||||||
|
## logx 配置
|
||||||
|
|
||||||
|
```go
|
||||||
|
type LogConf struct {
|
||||||
|
ServiceName string `json:",optional"`
|
||||||
|
Mode string `json:",default=console,options=[console,file,volume]"`
|
||||||
|
Encoding string `json:",default=json,options=[json,plain]"`
|
||||||
|
TimeFormat string `json:",optional"`
|
||||||
|
Path string `json:",default=logs"`
|
||||||
|
Level string `json:",default=info,options=[info,error,severe]"`
|
||||||
|
Compress bool `json:",optional"`
|
||||||
|
KeepDays int `json:",optional"`
|
||||||
|
StackCooldownMillis int `json:",default=100"`
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
- `ServiceName`:设置服务名称,可选。在 `volume` 模式下,该名称用于生成日志文件。在 `rest/zrpc` 服务中,名称将被自动设置为 `rest`或`zrpc` 的名称。
|
||||||
|
- `Mode`:输出日志的模式,默认是 `console`
|
||||||
|
- `console` 模式将日志写到 `stdout/stderr`
|
||||||
|
- `file` 模式将日志写到 `Path` 指定目录的文件中
|
||||||
|
- `volume` 模式在 docker 中使用,将日志写入挂载的卷中
|
||||||
|
- `Encoding`: 指示如何对日志进行编码,默认是 `json`
|
||||||
|
- `json`模式以 json 格式写日志
|
||||||
|
- `plain`模式用纯文本写日志,并带有终端颜色显示
|
||||||
|
- `TimeFormat`:自定义时间格式,可选。默认是 `2006-01-02T15:04:05.000Z07:00`
|
||||||
|
- `Path`:设置日志路径,默认为 `logs`
|
||||||
|
- `Level`: 用于过滤日志的日志级别。默认为 `info`
|
||||||
|
- `info`,所有日志都被写入
|
||||||
|
- `error`, `info` 的日志被丢弃
|
||||||
|
- `severe`, `info` 和 `error` 日志被丢弃,只有 `severe` 日志被写入
|
||||||
|
- `Compress`: 是否压缩日志文件,只在 `file` 模式下工作
|
||||||
|
- `KeepDays`:日志文件被保留多少天,在给定的天数之后,过期的文件将被自动删除。对 `console` 模式没有影响
|
||||||
|
- `StackCooldownMillis`:多少毫秒后再次写入堆栈跟踪。用来避免堆栈跟踪日志过多
|
||||||
|
|
||||||
|
## 打印日志方法
|
||||||
|
|
||||||
|
```go
|
||||||
|
type Logger interface {
|
||||||
|
// Error logs a message at error level.
|
||||||
|
Error(...interface{})
|
||||||
|
// Errorf logs a message at error level.
|
||||||
|
Errorf(string, ...interface{})
|
||||||
|
// Errorv logs a message at error level.
|
||||||
|
Errorv(interface{})
|
||||||
|
// Errorw logs a message at error level.
|
||||||
|
Errorw(string, ...LogField)
|
||||||
|
// Info logs a message at info level.
|
||||||
|
Info(...interface{})
|
||||||
|
// Infof logs a message at info level.
|
||||||
|
Infof(string, ...interface{})
|
||||||
|
// Infov logs a message at info level.
|
||||||
|
Infov(interface{})
|
||||||
|
// Infow logs a message at info level.
|
||||||
|
Infow(string, ...LogField)
|
||||||
|
// Slow logs a message at slow level.
|
||||||
|
Slow(...interface{})
|
||||||
|
// Slowf logs a message at slow level.
|
||||||
|
Slowf(string, ...interface{})
|
||||||
|
// Slowv logs a message at slow level.
|
||||||
|
Slowv(interface{})
|
||||||
|
// Sloww logs a message at slow level.
|
||||||
|
Sloww(string, ...LogField)
|
||||||
|
// WithContext returns a new logger with the given context.
|
||||||
|
WithContext(context.Context) Logger
|
||||||
|
// WithDuration returns a new logger with the given duration.
|
||||||
|
WithDuration(time.Duration) Logger
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
- `Error`, `Info`, `Slow`: 将任何类型的信息写进日志,使用 `fmt.Sprint(...)` 来转换为 `string`
|
||||||
|
- `Errorf`, `Infof`, `Slowf`: 将指定格式的信息写入日志
|
||||||
|
- `Errorv`, `Infov`, `Slowv`: 将任何类型的信息写入日志,用 `json marshal` 编码
|
||||||
|
- `Errorw`, `Infow`, `Sloww`: 写日志,并带上给定的 `key:value` 字段
|
||||||
|
- `WithContext`:将给定的 ctx 注入日志信息,例如用于记录 `trace-id`和`span-id`
|
||||||
|
- `WithDuration`: 将指定的时间写入日志信息中,字段名为 `duration`
|
||||||
|
|
||||||
|
## 与第三方日志库集成
|
||||||
|
|
||||||
|
- zap
|
||||||
|
- 实现:[https://github.com/zeromicro/zero-contrib/blob/main/logx/zapx/zap.go](https://github.com/zeromicro/zero-contrib/blob/main/logx/zapx/zap.go)
|
||||||
|
- 使用示例:[https://github.com/zeromicro/zero-examples/blob/main/logx/zaplog/main.go](https://github.com/zeromicro/zero-examples/blob/main/logx/zaplog/main.go)
|
||||||
|
- logrus
|
||||||
|
- 实现:[https://github.com/zeromicro/zero-contrib/blob/main/logx/logrusx/logrus.go](https://github.com/zeromicro/zero-contrib/blob/main/logx/logrusx/logrus.go)
|
||||||
|
- 使用示例:[https://github.com/zeromicro/zero-examples/blob/main/logx/logrus/main.go](https://github.com/zeromicro/zero-examples/blob/main/logx/logrus/main.go)
|
||||||
|
|
||||||
|
对于其它的日志库,请参考上面示例实现,并欢迎提交 `PR` 到 [https://github.com/zeromicro/zero-contrib](https://github.com/zeromicro/zero-contrib)
|
||||||
|
|
||||||
|
## 将日志写到指定的存储
|
||||||
|
|
||||||
|
`logx`定义了两个接口,方便自定义 `logx`,将日志写入任何存储。
|
||||||
|
|
||||||
|
- `logx.NewWriter(w io.Writer)`
|
||||||
|
- `logx.SetWriter(write logx.Writer)`
|
||||||
|
|
||||||
|
例如,如果我们想把日志写进kafka,而不是控制台或文件,我们可以像下面这样做。
|
||||||
|
|
||||||
|
```go
|
||||||
|
type KafkaWriter struct {
|
||||||
|
Pusher *kq.Pusher
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewKafkaWriter(pusher *kq.Pusher) *KafkaWriter {
|
||||||
|
return &KafkaWriter{
|
||||||
|
Pusher: pusher,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *KafkaWriter) Write(p []byte) (n int, err error) {
|
||||||
|
// writing log with newlines, trim them.
|
||||||
|
if err := w.Pusher.Push(strings.TrimSpace(string(p))); err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return len(p), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
pusher := kq.NewPusher([]string{"localhost:9092"}, "go-zero")
|
||||||
|
defer pusher.Close()
|
||||||
|
|
||||||
|
writer := logx.NewWriter(NewKafkaWriter(pusher))
|
||||||
|
logx.SetWriter(writer)
|
||||||
|
|
||||||
|
// more code
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
完整代码:[https://github.com/zeromicro/zero-examples/blob/main/logx/tokafka/main.go](https://github.com/zeromicro/zero-examples/blob/main/logx/tokafka/main.go)
|
||||||
|
|
||||||
|
## 过滤敏感字段
|
||||||
|
|
||||||
|
如果我们需要防止 `password` 字段被记录下来,我们可以像下面这样实现。
|
||||||
|
|
||||||
|
```go
|
||||||
|
type (
|
||||||
|
Message struct {
|
||||||
|
Name string
|
||||||
|
Password string
|
||||||
|
Message string
|
||||||
|
}
|
||||||
|
|
||||||
|
SensitiveLogger struct {
|
||||||
|
logx.Writer
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
func NewSensitiveLogger(writer logx.Writer) *SensitiveLogger {
|
||||||
|
return &SensitiveLogger{
|
||||||
|
Writer: writer,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (l *SensitiveLogger) Info(msg interface{}, fields ...logx.LogField) {
|
||||||
|
if m, ok := msg.(Message); ok {
|
||||||
|
l.Writer.Info(Message{
|
||||||
|
Name: m.Name,
|
||||||
|
Password: "******",
|
||||||
|
Message: m.Message,
|
||||||
|
}, fields...)
|
||||||
|
} else {
|
||||||
|
l.Writer.Info(msg, fields...)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
// setup logx to make sure originalWriter not nil,
|
||||||
|
// the injected writer is only for filtering, like a middleware.
|
||||||
|
|
||||||
|
originalWriter := logx.Reset()
|
||||||
|
writer := NewSensitiveLogger(originalWriter)
|
||||||
|
logx.SetWriter(writer)
|
||||||
|
|
||||||
|
logx.Infov(Message{
|
||||||
|
Name: "foo",
|
||||||
|
Password: "shouldNotAppear",
|
||||||
|
Message: "bar",
|
||||||
|
})
|
||||||
|
|
||||||
|
// more code
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
完整代码:[https://github.com/zeromicro/zero-examples/blob/main/logx/filterfields/main.go](https://github.com/zeromicro/zero-examples/blob/main/logx/filterfields/main.go)
|
||||||
|
|
||||||
|
## 更多示例
|
||||||
|
|
||||||
|
[https://github.com/zeromicro/zero-examples/tree/main/logx](https://github.com/zeromicro/zero-examples/tree/main/logx)
|
||||||
|
|
||||||
|
## Give a Star! ⭐
|
||||||
|
|
||||||
|
如果你正在使用或者觉得这个项目对你有帮助,请 **star** 支持,感谢!
|
||||||
197
core/logx/readme.md
Normal file
197
core/logx/readme.md
Normal file
@@ -0,0 +1,197 @@
|
|||||||
|
<img align="right" width="150px" src="https://raw.githubusercontent.com/zeromicro/zero-doc/main/doc/images/go-zero.png">
|
||||||
|
|
||||||
|
# logx
|
||||||
|
|
||||||
|
English | [简体中文](readme-cn.md)
|
||||||
|
|
||||||
|
## logx configurations
|
||||||
|
|
||||||
|
```go
|
||||||
|
type LogConf struct {
|
||||||
|
ServiceName string `json:",optional"`
|
||||||
|
Mode string `json:",default=console,options=[console,file,volume]"`
|
||||||
|
Encoding string `json:",default=json,options=[json,plain]"`
|
||||||
|
TimeFormat string `json:",optional"`
|
||||||
|
Path string `json:",default=logs"`
|
||||||
|
Level string `json:",default=info,options=[info,error,severe]"`
|
||||||
|
Compress bool `json:",optional"`
|
||||||
|
KeepDays int `json:",optional"`
|
||||||
|
StackCooldownMillis int `json:",default=100"`
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
- `ServiceName`: set the service name, optional. on `volume` mode, the name is used to generate the log files. Within `rest/zrpc` services, the name will be set to the name of `rest` or `zrpc` automatically.
|
||||||
|
- `Mode`: the mode to output the logs, default is `console`.
|
||||||
|
- `console` mode writes the logs to `stdout/stderr`.
|
||||||
|
- `file` mode writes the logs to the files specified by `Path`.
|
||||||
|
- `volume` mode is used in docker, to write logs into mounted volumes.
|
||||||
|
- `Encoding`: indicates how to encode the logs, default is `json`.
|
||||||
|
- `json` mode writes the logs in json format.
|
||||||
|
- `plain` mode writes the logs with plain text, with terminal color enabled.
|
||||||
|
- `TimeFormat`: customize the time format, optional. Default is `2006-01-02T15:04:05.000Z07:00`.
|
||||||
|
- `Path`: set the log path, default to `logs`.
|
||||||
|
- `Level`: the logging level to filter logs. Default is `info`.
|
||||||
|
- `info`, all logs are written.
|
||||||
|
- `error`, `info` logs are suppressed.
|
||||||
|
- `severe`, `info` and `error` logs are suppressed, only `severe` logs are written.
|
||||||
|
- `Compress`: whether or not to compress log files, only works with `file` mode.
|
||||||
|
- `KeepDays`: how many days that the log files are kept, after the given days, the outdated files will be deleted automatically. It has no effect on `console` mode.
|
||||||
|
- `StackCooldownMillis`: how many milliseconds to rewrite stacktrace again. It’s used to avoid stacktrace flooding.
|
||||||
|
|
||||||
|
## Logging methods
|
||||||
|
|
||||||
|
```go
|
||||||
|
type Logger interface {
|
||||||
|
// Error logs a message at error level.
|
||||||
|
Error(...interface{})
|
||||||
|
// Errorf logs a message at error level.
|
||||||
|
Errorf(string, ...interface{})
|
||||||
|
// Errorv logs a message at error level.
|
||||||
|
Errorv(interface{})
|
||||||
|
// Errorw logs a message at error level.
|
||||||
|
Errorw(string, ...LogField)
|
||||||
|
// Info logs a message at info level.
|
||||||
|
Info(...interface{})
|
||||||
|
// Infof logs a message at info level.
|
||||||
|
Infof(string, ...interface{})
|
||||||
|
// Infov logs a message at info level.
|
||||||
|
Infov(interface{})
|
||||||
|
// Infow logs a message at info level.
|
||||||
|
Infow(string, ...LogField)
|
||||||
|
// Slow logs a message at slow level.
|
||||||
|
Slow(...interface{})
|
||||||
|
// Slowf logs a message at slow level.
|
||||||
|
Slowf(string, ...interface{})
|
||||||
|
// Slowv logs a message at slow level.
|
||||||
|
Slowv(interface{})
|
||||||
|
// Sloww logs a message at slow level.
|
||||||
|
Sloww(string, ...LogField)
|
||||||
|
// WithContext returns a new logger with the given context.
|
||||||
|
WithContext(context.Context) Logger
|
||||||
|
// WithDuration returns a new logger with the given duration.
|
||||||
|
WithDuration(time.Duration) Logger
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
- `Error`, `Info`, `Slow`: write any kind of messages into logs, with like `fmt.Sprint(…)`.
|
||||||
|
- `Errorf`, `Infof`, `Slowf`: write messages with given format into logs.
|
||||||
|
- `Errorv`, `Infov`, `Slowv`: write any kind of messages into logs, with json marshalling to encode them.
|
||||||
|
- `Errorw`, `Infow`, `Sloww`: write the string message with given `key:value` fields.
|
||||||
|
- `WithContext`: inject the given ctx into the log messages, typically used to log `trace-id` and `span-id`.
|
||||||
|
- `WithDuration`: write elapsed duration into the log messages, with key `duration`.
|
||||||
|
|
||||||
|
## Integrating with third-party logging libs
|
||||||
|
|
||||||
|
- zap
|
||||||
|
- implementation: [https://github.com/zeromicro/zero-contrib/blob/main/logx/zapx/zap.go](https://github.com/zeromicro/zero-contrib/blob/main/logx/zapx/zap.go)
|
||||||
|
- usage example: [https://github.com/zeromicro/zero-examples/blob/main/logx/zaplog/main.go](https://github.com/zeromicro/zero-examples/blob/main/logx/zaplog/main.go)
|
||||||
|
- logrus
|
||||||
|
- implementation: [https://github.com/zeromicro/zero-contrib/blob/main/logx/logrusx/logrus.go](https://github.com/zeromicro/zero-contrib/blob/main/logx/logrusx/logrus.go)
|
||||||
|
- usage example: [https://github.com/zeromicro/zero-examples/blob/main/logx/logrus/main.go](https://github.com/zeromicro/zero-examples/blob/main/logx/logrus/main.go)
|
||||||
|
|
||||||
|
For more libs, please implement and PR to [https://github.com/zeromicro/zero-contrib](https://github.com/zeromicro/zero-contrib)
|
||||||
|
|
||||||
|
## Write the logs to specific stores
|
||||||
|
|
||||||
|
`logx` defined two interfaces to let you customize `logx` to write logs into any stores.
|
||||||
|
|
||||||
|
- `logx.NewWriter(w io.Writer)`
|
||||||
|
- `logx.SetWriter(writer logx.Writer)`
|
||||||
|
|
||||||
|
For example, if we want to write the logs into kafka instead of console or files, we can do it like below:
|
||||||
|
|
||||||
|
```go
|
||||||
|
type KafkaWriter struct {
|
||||||
|
Pusher *kq.Pusher
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewKafkaWriter(pusher *kq.Pusher) *KafkaWriter {
|
||||||
|
return &KafkaWriter{
|
||||||
|
Pusher: pusher,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *KafkaWriter) Write(p []byte) (n int, err error) {
|
||||||
|
// writing log with newlines, trim them.
|
||||||
|
if err := w.Pusher.Push(strings.TrimSpace(string(p))); err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return len(p), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
pusher := kq.NewPusher([]string{"localhost:9092"}, "go-zero")
|
||||||
|
defer pusher.Close()
|
||||||
|
|
||||||
|
writer := logx.NewWriter(NewKafkaWriter(pusher))
|
||||||
|
logx.SetWriter(writer)
|
||||||
|
|
||||||
|
// more code
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Complete code: [https://github.com/zeromicro/zero-examples/blob/main/logx/tokafka/main.go](https://github.com/zeromicro/zero-examples/blob/main/logx/tokafka/main.go)
|
||||||
|
|
||||||
|
## Filtering sensitive fields
|
||||||
|
|
||||||
|
If we need to prevent the `password` fields from logging, we can do it like below:
|
||||||
|
|
||||||
|
```go
|
||||||
|
type (
|
||||||
|
Message struct {
|
||||||
|
Name string
|
||||||
|
Password string
|
||||||
|
Message string
|
||||||
|
}
|
||||||
|
|
||||||
|
SensitiveLogger struct {
|
||||||
|
logx.Writer
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
func NewSensitiveLogger(writer logx.Writer) *SensitiveLogger {
|
||||||
|
return &SensitiveLogger{
|
||||||
|
Writer: writer,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (l *SensitiveLogger) Info(msg interface{}, fields ...logx.LogField) {
|
||||||
|
if m, ok := msg.(Message); ok {
|
||||||
|
l.Writer.Info(Message{
|
||||||
|
Name: m.Name,
|
||||||
|
Password: "******",
|
||||||
|
Message: m.Message,
|
||||||
|
}, fields...)
|
||||||
|
} else {
|
||||||
|
l.Writer.Info(msg, fields...)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
// setup logx to make sure originalWriter not nil,
|
||||||
|
// the injected writer is only for filtering, like a middleware.
|
||||||
|
|
||||||
|
originalWriter := logx.Reset()
|
||||||
|
writer := NewSensitiveLogger(originalWriter)
|
||||||
|
logx.SetWriter(writer)
|
||||||
|
|
||||||
|
logx.Infov(Message{
|
||||||
|
Name: "foo",
|
||||||
|
Password: "shouldNotAppear",
|
||||||
|
Message: "bar",
|
||||||
|
})
|
||||||
|
|
||||||
|
// more code
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Complete code: [https://github.com/zeromicro/zero-examples/blob/main/logx/filterfields/main.go](https://github.com/zeromicro/zero-examples/blob/main/logx/filterfields/main.go)
|
||||||
|
|
||||||
|
## More examples
|
||||||
|
|
||||||
|
[https://github.com/zeromicro/zero-examples/tree/main/logx](https://github.com/zeromicro/zero-examples/tree/main/logx)
|
||||||
|
|
||||||
|
## Give a Star! ⭐
|
||||||
|
|
||||||
|
If you like or are using this project to learn or start your solution, please give it a star. Thanks!
|
||||||
@@ -13,9 +13,8 @@ import (
|
|||||||
"sync"
|
"sync"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/tal-tech/go-zero/core/fs"
|
"github.com/zeromicro/go-zero/core/fs"
|
||||||
"github.com/tal-tech/go-zero/core/lang"
|
"github.com/zeromicro/go-zero/core/lang"
|
||||||
"github.com/tal-tech/go-zero/core/timex"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
@@ -211,6 +210,12 @@ func (l *RotateLogger) maybeCompressFile(file string) {
|
|||||||
ErrorStack(r)
|
ErrorStack(r)
|
||||||
}
|
}
|
||||||
}()
|
}()
|
||||||
|
|
||||||
|
if _, err := os.Stat(file); err != nil {
|
||||||
|
// file not exists or other error, ignore compression
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
compressLogFile(file)
|
compressLogFile(file)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -290,12 +295,12 @@ func (l *RotateLogger) write(v []byte) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func compressLogFile(file string) {
|
func compressLogFile(file string) {
|
||||||
start := timex.Now()
|
start := time.Now()
|
||||||
Infof("compressing log file: %s", file)
|
Infof("compressing log file: %s", file)
|
||||||
if err := gzipFile(file); err != nil {
|
if err := gzipFile(file); err != nil {
|
||||||
Errorf("compress error: %s", err)
|
Errorf("compress error: %s", err)
|
||||||
} else {
|
} else {
|
||||||
Infof("compressed log file: %s, took %s", file, timex.Since(start))
|
Infof("compressed log file: %s, took %s", file, time.Since(start))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/tal-tech/go-zero/core/fs"
|
"github.com/zeromicro/go-zero/core/fs"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestDailyRotateRuleMarkRotated(t *testing.T) {
|
func TestDailyRotateRuleMarkRotated(t *testing.T) {
|
||||||
@@ -75,10 +75,7 @@ func TestRotateLoggerMayCompressFileTrue(t *testing.T) {
|
|||||||
logger, err := NewLogger(filename, new(DailyRotateRule), true)
|
logger, err := NewLogger(filename, new(DailyRotateRule), true)
|
||||||
assert.Nil(t, err)
|
assert.Nil(t, err)
|
||||||
if len(filename) > 0 {
|
if len(filename) > 0 {
|
||||||
defer func() {
|
defer os.Remove(filepath.Base(logger.getBackupFilename()) + ".gz")
|
||||||
os.Remove(filename)
|
|
||||||
os.Remove(filepath.Base(logger.getBackupFilename()) + ".gz")
|
|
||||||
}()
|
|
||||||
}
|
}
|
||||||
logger.maybeCompressFile(filename)
|
logger.maybeCompressFile(filename)
|
||||||
_, err = os.Stat(filename)
|
_, err = os.Stat(filename)
|
||||||
@@ -92,7 +89,6 @@ func TestRotateLoggerRotate(t *testing.T) {
|
|||||||
assert.Nil(t, err)
|
assert.Nil(t, err)
|
||||||
if len(filename) > 0 {
|
if len(filename) > 0 {
|
||||||
defer func() {
|
defer func() {
|
||||||
os.Remove(filename)
|
|
||||||
os.Remove(logger.getBackupFilename())
|
os.Remove(logger.getBackupFilename())
|
||||||
os.Remove(filepath.Base(logger.getBackupFilename()) + ".gz")
|
os.Remove(filepath.Base(logger.getBackupFilename()) + ".gz")
|
||||||
}()
|
}()
|
||||||
@@ -102,6 +98,10 @@ func TestRotateLoggerRotate(t *testing.T) {
|
|||||||
case *os.LinkError:
|
case *os.LinkError:
|
||||||
// avoid rename error on docker container
|
// avoid rename error on docker container
|
||||||
assert.Equal(t, syscall.EXDEV, v.Err)
|
assert.Equal(t, syscall.EXDEV, v.Err)
|
||||||
|
case *os.PathError:
|
||||||
|
// ignore remove error for tests,
|
||||||
|
// files are cleaned in GitHub actions.
|
||||||
|
assert.Equal(t, "remove", v.Op)
|
||||||
default:
|
default:
|
||||||
assert.Nil(t, err)
|
assert.Nil(t, err)
|
||||||
}
|
}
|
||||||
@@ -115,12 +115,18 @@ func TestRotateLoggerWrite(t *testing.T) {
|
|||||||
assert.Nil(t, err)
|
assert.Nil(t, err)
|
||||||
if len(filename) > 0 {
|
if len(filename) > 0 {
|
||||||
defer func() {
|
defer func() {
|
||||||
os.Remove(filename)
|
|
||||||
os.Remove(logger.getBackupFilename())
|
os.Remove(logger.getBackupFilename())
|
||||||
os.Remove(filepath.Base(logger.getBackupFilename()) + ".gz")
|
os.Remove(filepath.Base(logger.getBackupFilename()) + ".gz")
|
||||||
}()
|
}()
|
||||||
}
|
}
|
||||||
|
// the following write calls cannot be changed to Write, because of DATA RACE.
|
||||||
logger.write([]byte(`foo`))
|
logger.write([]byte(`foo`))
|
||||||
rule.rotatedTime = time.Now().Add(-time.Hour * 24).Format(dateFormat)
|
rule.rotatedTime = time.Now().Add(-time.Hour * 24).Format(dateFormat)
|
||||||
logger.write([]byte(`bar`))
|
logger.write([]byte(`bar`))
|
||||||
|
logger.Close()
|
||||||
|
logger.write([]byte(`baz`))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLogWriterClose(t *testing.T) {
|
||||||
|
assert.Nil(t, newLogWriter(nil).Close())
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -29,20 +29,24 @@ func TestRedirector(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func captureOutput(f func()) string {
|
func captureOutput(f func()) string {
|
||||||
atomic.StoreUint32(&initialized, 1)
|
w := new(mockWriter)
|
||||||
writer := new(mockWriter)
|
old := writer.Swap(w)
|
||||||
infoLog = writer
|
defer writer.Store(old)
|
||||||
|
|
||||||
prevLevel := atomic.LoadUint32(&logLevel)
|
prevLevel := atomic.LoadUint32(&logLevel)
|
||||||
SetLevel(InfoLevel)
|
SetLevel(InfoLevel)
|
||||||
f()
|
f()
|
||||||
SetLevel(prevLevel)
|
SetLevel(prevLevel)
|
||||||
|
|
||||||
return writer.builder.String()
|
return w.String()
|
||||||
}
|
}
|
||||||
|
|
||||||
func getContent(jsonStr string) string {
|
func getContent(jsonStr string) string {
|
||||||
var entry logEntry
|
var entry logEntry
|
||||||
json.Unmarshal([]byte(jsonStr), &entry)
|
json.Unmarshal([]byte(jsonStr), &entry)
|
||||||
return entry.Content.(string)
|
val, ok := entry.Content.(string)
|
||||||
|
if ok {
|
||||||
|
return val
|
||||||
|
}
|
||||||
|
return ""
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,72 +3,79 @@ package logx
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/tal-tech/go-zero/core/timex"
|
"github.com/zeromicro/go-zero/core/timex"
|
||||||
"go.opentelemetry.io/otel/trace"
|
"go.opentelemetry.io/otel/trace"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// WithContext sets ctx to log, for keeping tracing information.
|
||||||
|
func WithContext(ctx context.Context) Logger {
|
||||||
|
return &traceLogger{
|
||||||
|
ctx: ctx,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
type traceLogger struct {
|
type traceLogger struct {
|
||||||
logEntry
|
logEntry
|
||||||
Trace string `json:"trace,omitempty"`
|
ctx context.Context
|
||||||
Span string `json:"span,omitempty"`
|
|
||||||
ctx context.Context
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (l *traceLogger) Error(v ...interface{}) {
|
func (l *traceLogger) Error(v ...interface{}) {
|
||||||
if shallLog(ErrorLevel) {
|
l.err(fmt.Sprint(v...))
|
||||||
l.write(errorLog, levelError, formatWithCaller(fmt.Sprint(v...), durationCallerDepth))
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (l *traceLogger) Errorf(format string, v ...interface{}) {
|
func (l *traceLogger) Errorf(format string, v ...interface{}) {
|
||||||
if shallLog(ErrorLevel) {
|
l.err(fmt.Sprintf(format, v...))
|
||||||
l.write(errorLog, levelError, formatWithCaller(fmt.Sprintf(format, v...), durationCallerDepth))
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (l *traceLogger) Errorv(v interface{}) {
|
func (l *traceLogger) Errorv(v interface{}) {
|
||||||
if shallLog(ErrorLevel) {
|
l.err(fmt.Sprint(v))
|
||||||
l.write(errorLog, levelError, v)
|
}
|
||||||
}
|
|
||||||
|
func (l *traceLogger) Errorw(msg string, fields ...LogField) {
|
||||||
|
l.err(msg, fields...)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (l *traceLogger) Info(v ...interface{}) {
|
func (l *traceLogger) Info(v ...interface{}) {
|
||||||
if shallLog(InfoLevel) {
|
l.info(fmt.Sprint(v...))
|
||||||
l.write(infoLog, levelInfo, fmt.Sprint(v...))
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (l *traceLogger) Infof(format string, v ...interface{}) {
|
func (l *traceLogger) Infof(format string, v ...interface{}) {
|
||||||
if shallLog(InfoLevel) {
|
l.info(fmt.Sprintf(format, v...))
|
||||||
l.write(infoLog, levelInfo, fmt.Sprintf(format, v...))
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (l *traceLogger) Infov(v interface{}) {
|
func (l *traceLogger) Infov(v interface{}) {
|
||||||
if shallLog(InfoLevel) {
|
l.info(v)
|
||||||
l.write(infoLog, levelInfo, v)
|
}
|
||||||
}
|
|
||||||
|
func (l *traceLogger) Infow(msg string, fields ...LogField) {
|
||||||
|
l.info(msg, fields...)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (l *traceLogger) Slow(v ...interface{}) {
|
func (l *traceLogger) Slow(v ...interface{}) {
|
||||||
if shallLog(ErrorLevel) {
|
l.slow(fmt.Sprint(v...))
|
||||||
l.write(slowLog, levelSlow, fmt.Sprint(v...))
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (l *traceLogger) Slowf(format string, v ...interface{}) {
|
func (l *traceLogger) Slowf(format string, v ...interface{}) {
|
||||||
if shallLog(ErrorLevel) {
|
l.slow(fmt.Sprintf(format, v...))
|
||||||
l.write(slowLog, levelSlow, fmt.Sprintf(format, v...))
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (l *traceLogger) Slowv(v interface{}) {
|
func (l *traceLogger) Slowv(v interface{}) {
|
||||||
if shallLog(ErrorLevel) {
|
l.slow(v)
|
||||||
l.write(slowLog, levelSlow, v)
|
}
|
||||||
|
|
||||||
|
func (l *traceLogger) Sloww(msg string, fields ...LogField) {
|
||||||
|
l.slow(msg, fields...)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (l *traceLogger) WithContext(ctx context.Context) Logger {
|
||||||
|
if ctx == nil {
|
||||||
|
return l
|
||||||
}
|
}
|
||||||
|
|
||||||
|
l.ctx = ctx
|
||||||
|
return l
|
||||||
}
|
}
|
||||||
|
|
||||||
func (l *traceLogger) WithDuration(duration time.Duration) Logger {
|
func (l *traceLogger) WithDuration(duration time.Duration) Logger {
|
||||||
@@ -76,19 +83,37 @@ func (l *traceLogger) WithDuration(duration time.Duration) Logger {
|
|||||||
return l
|
return l
|
||||||
}
|
}
|
||||||
|
|
||||||
func (l *traceLogger) write(writer io.Writer, level string, val interface{}) {
|
func (l *traceLogger) buildFields(fields ...LogField) []LogField {
|
||||||
l.Timestamp = getTimestamp()
|
if len(l.Duration) > 0 {
|
||||||
l.Level = level
|
fields = append(fields, Field(durationKey, l.Duration))
|
||||||
l.Content = val
|
}
|
||||||
l.Trace = traceIdFromContext(l.ctx)
|
traceID := traceIdFromContext(l.ctx)
|
||||||
l.Span = spanIdFromContext(l.ctx)
|
if len(traceID) > 0 {
|
||||||
outputJson(writer, l)
|
fields = append(fields, Field(traceKey, traceID))
|
||||||
|
}
|
||||||
|
spanID := spanIdFromContext(l.ctx)
|
||||||
|
if len(spanID) > 0 {
|
||||||
|
fields = append(fields, Field(spanKey, spanID))
|
||||||
|
}
|
||||||
|
|
||||||
|
return fields
|
||||||
}
|
}
|
||||||
|
|
||||||
// WithContext sets ctx to log, for keeping tracing information.
|
func (l *traceLogger) err(v interface{}, fields ...LogField) {
|
||||||
func WithContext(ctx context.Context) Logger {
|
if shallLog(ErrorLevel) {
|
||||||
return &traceLogger{
|
getWriter().Error(v, l.buildFields(fields...)...)
|
||||||
ctx: ctx,
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (l *traceLogger) info(v interface{}, fields ...LogField) {
|
||||||
|
if shallLog(InfoLevel) {
|
||||||
|
getWriter().Info(v, l.buildFields(fields...)...)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (l *traceLogger) slow(v interface{}, fields ...LogField) {
|
||||||
|
if shallLog(ErrorLevel) {
|
||||||
|
getWriter().Slow(v, l.buildFields(fields...)...)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -2,7 +2,8 @@ package logx
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"log"
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
"strings"
|
"strings"
|
||||||
"sync/atomic"
|
"sync/atomic"
|
||||||
"testing"
|
"testing"
|
||||||
@@ -13,99 +14,195 @@ import (
|
|||||||
sdktrace "go.opentelemetry.io/otel/sdk/trace"
|
sdktrace "go.opentelemetry.io/otel/sdk/trace"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
|
||||||
traceKey = "trace"
|
|
||||||
spanKey = "span"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestTraceLog(t *testing.T) {
|
func TestTraceLog(t *testing.T) {
|
||||||
var buf mockWriter
|
SetLevel(InfoLevel)
|
||||||
atomic.StoreUint32(&initialized, 1)
|
w := new(mockWriter)
|
||||||
|
old := writer.Swap(w)
|
||||||
|
writer.lock.RLock()
|
||||||
|
defer func() {
|
||||||
|
writer.lock.RUnlock()
|
||||||
|
writer.Store(old)
|
||||||
|
}()
|
||||||
|
|
||||||
otp := otel.GetTracerProvider()
|
otp := otel.GetTracerProvider()
|
||||||
tp := sdktrace.NewTracerProvider(sdktrace.WithSampler(sdktrace.AlwaysSample()))
|
tp := sdktrace.NewTracerProvider(sdktrace.WithSampler(sdktrace.AlwaysSample()))
|
||||||
otel.SetTracerProvider(tp)
|
otel.SetTracerProvider(tp)
|
||||||
defer otel.SetTracerProvider(otp)
|
defer otel.SetTracerProvider(otp)
|
||||||
|
|
||||||
ctx, _ := tp.Tracer("foo").Start(context.Background(), "bar")
|
ctx, span := tp.Tracer("foo").Start(context.Background(), "bar")
|
||||||
WithContext(ctx).(*traceLogger).write(&buf, levelInfo, testlog)
|
defer span.End()
|
||||||
assert.True(t, strings.Contains(buf.String(), traceKey))
|
|
||||||
assert.True(t, strings.Contains(buf.String(), spanKey))
|
WithContext(ctx).Info(testlog)
|
||||||
|
validate(t, w.String(), true, true)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestTraceError(t *testing.T) {
|
func TestTraceError(t *testing.T) {
|
||||||
var buf mockWriter
|
w := new(mockWriter)
|
||||||
atomic.StoreUint32(&initialized, 1)
|
old := writer.Swap(w)
|
||||||
errorLog = newLogWriter(log.New(&buf, "", flags))
|
writer.lock.RLock()
|
||||||
|
defer func() {
|
||||||
|
writer.lock.RUnlock()
|
||||||
|
writer.Store(old)
|
||||||
|
}()
|
||||||
|
|
||||||
otp := otel.GetTracerProvider()
|
otp := otel.GetTracerProvider()
|
||||||
tp := sdktrace.NewTracerProvider(sdktrace.WithSampler(sdktrace.AlwaysSample()))
|
tp := sdktrace.NewTracerProvider(sdktrace.WithSampler(sdktrace.AlwaysSample()))
|
||||||
otel.SetTracerProvider(tp)
|
otel.SetTracerProvider(tp)
|
||||||
defer otel.SetTracerProvider(otp)
|
defer otel.SetTracerProvider(otp)
|
||||||
|
|
||||||
ctx, _ := tp.Tracer("foo").Start(context.Background(), "bar")
|
ctx, span := tp.Tracer("foo").Start(context.Background(), "bar")
|
||||||
l := WithContext(ctx).(*traceLogger)
|
defer span.End()
|
||||||
SetLevel(InfoLevel)
|
|
||||||
|
var nilCtx context.Context
|
||||||
|
l := WithContext(context.Background())
|
||||||
|
l = l.WithContext(nilCtx)
|
||||||
|
l = l.WithContext(ctx)
|
||||||
|
SetLevel(ErrorLevel)
|
||||||
l.WithDuration(time.Second).Error(testlog)
|
l.WithDuration(time.Second).Error(testlog)
|
||||||
assert.True(t, strings.Contains(buf.String(), traceKey))
|
validate(t, w.String(), true, true)
|
||||||
assert.True(t, strings.Contains(buf.String(), spanKey))
|
w.Reset()
|
||||||
buf.Reset()
|
|
||||||
l.WithDuration(time.Second).Errorf(testlog)
|
l.WithDuration(time.Second).Errorf(testlog)
|
||||||
assert.True(t, strings.Contains(buf.String(), traceKey))
|
validate(t, w.String(), true, true)
|
||||||
assert.True(t, strings.Contains(buf.String(), spanKey))
|
w.Reset()
|
||||||
|
l.WithDuration(time.Second).Errorv(testlog)
|
||||||
|
fmt.Println(w.String())
|
||||||
|
validate(t, w.String(), true, true)
|
||||||
|
w.Reset()
|
||||||
|
l.WithDuration(time.Second).Errorw(testlog, Field("foo", "bar"))
|
||||||
|
fmt.Println(w.String())
|
||||||
|
validate(t, w.String(), true, true)
|
||||||
|
assert.True(t, strings.Contains(w.String(), "foo"), w.String())
|
||||||
|
assert.True(t, strings.Contains(w.String(), "bar"), w.String())
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestTraceInfo(t *testing.T) {
|
func TestTraceInfo(t *testing.T) {
|
||||||
var buf mockWriter
|
w := new(mockWriter)
|
||||||
atomic.StoreUint32(&initialized, 1)
|
old := writer.Swap(w)
|
||||||
infoLog = newLogWriter(log.New(&buf, "", flags))
|
writer.lock.RLock()
|
||||||
|
defer func() {
|
||||||
|
writer.lock.RUnlock()
|
||||||
|
writer.Store(old)
|
||||||
|
}()
|
||||||
|
|
||||||
otp := otel.GetTracerProvider()
|
otp := otel.GetTracerProvider()
|
||||||
tp := sdktrace.NewTracerProvider(sdktrace.WithSampler(sdktrace.AlwaysSample()))
|
tp := sdktrace.NewTracerProvider(sdktrace.WithSampler(sdktrace.AlwaysSample()))
|
||||||
otel.SetTracerProvider(tp)
|
otel.SetTracerProvider(tp)
|
||||||
defer otel.SetTracerProvider(otp)
|
defer otel.SetTracerProvider(otp)
|
||||||
|
|
||||||
ctx, _ := tp.Tracer("foo").Start(context.Background(), "bar")
|
ctx, span := tp.Tracer("foo").Start(context.Background(), "bar")
|
||||||
l := WithContext(ctx).(*traceLogger)
|
defer span.End()
|
||||||
|
|
||||||
|
SetLevel(InfoLevel)
|
||||||
|
l := WithContext(ctx)
|
||||||
|
l.WithDuration(time.Second).Info(testlog)
|
||||||
|
validate(t, w.String(), true, true)
|
||||||
|
w.Reset()
|
||||||
|
l.WithDuration(time.Second).Infof(testlog)
|
||||||
|
validate(t, w.String(), true, true)
|
||||||
|
w.Reset()
|
||||||
|
l.WithDuration(time.Second).Infov(testlog)
|
||||||
|
validate(t, w.String(), true, true)
|
||||||
|
w.Reset()
|
||||||
|
l.WithDuration(time.Second).Infow(testlog, Field("foo", "bar"))
|
||||||
|
validate(t, w.String(), true, true)
|
||||||
|
assert.True(t, strings.Contains(w.String(), "foo"), w.String())
|
||||||
|
assert.True(t, strings.Contains(w.String(), "bar"), w.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTraceInfoConsole(t *testing.T) {
|
||||||
|
old := atomic.SwapUint32(&encoding, jsonEncodingType)
|
||||||
|
defer atomic.StoreUint32(&encoding, old)
|
||||||
|
|
||||||
|
w := new(mockWriter)
|
||||||
|
o := writer.Swap(w)
|
||||||
|
writer.lock.RLock()
|
||||||
|
defer func() {
|
||||||
|
writer.lock.RUnlock()
|
||||||
|
writer.Store(o)
|
||||||
|
}()
|
||||||
|
|
||||||
|
otp := otel.GetTracerProvider()
|
||||||
|
tp := sdktrace.NewTracerProvider(sdktrace.WithSampler(sdktrace.AlwaysSample()))
|
||||||
|
otel.SetTracerProvider(tp)
|
||||||
|
defer otel.SetTracerProvider(otp)
|
||||||
|
|
||||||
|
ctx, span := tp.Tracer("foo").Start(context.Background(), "bar")
|
||||||
|
defer span.End()
|
||||||
|
|
||||||
|
l := WithContext(ctx)
|
||||||
SetLevel(InfoLevel)
|
SetLevel(InfoLevel)
|
||||||
l.WithDuration(time.Second).Info(testlog)
|
l.WithDuration(time.Second).Info(testlog)
|
||||||
assert.True(t, strings.Contains(buf.String(), traceKey))
|
validate(t, w.String(), true, true)
|
||||||
assert.True(t, strings.Contains(buf.String(), spanKey))
|
w.Reset()
|
||||||
buf.Reset()
|
|
||||||
l.WithDuration(time.Second).Infof(testlog)
|
l.WithDuration(time.Second).Infof(testlog)
|
||||||
assert.True(t, strings.Contains(buf.String(), traceKey))
|
validate(t, w.String(), true, true)
|
||||||
assert.True(t, strings.Contains(buf.String(), spanKey))
|
w.Reset()
|
||||||
|
l.WithDuration(time.Second).Infov(testlog)
|
||||||
|
validate(t, w.String(), true, true)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestTraceSlow(t *testing.T) {
|
func TestTraceSlow(t *testing.T) {
|
||||||
var buf mockWriter
|
w := new(mockWriter)
|
||||||
atomic.StoreUint32(&initialized, 1)
|
old := writer.Swap(w)
|
||||||
slowLog = newLogWriter(log.New(&buf, "", flags))
|
writer.lock.RLock()
|
||||||
|
defer func() {
|
||||||
|
writer.lock.RUnlock()
|
||||||
|
writer.Store(old)
|
||||||
|
}()
|
||||||
|
|
||||||
otp := otel.GetTracerProvider()
|
otp := otel.GetTracerProvider()
|
||||||
tp := sdktrace.NewTracerProvider(sdktrace.WithSampler(sdktrace.AlwaysSample()))
|
tp := sdktrace.NewTracerProvider(sdktrace.WithSampler(sdktrace.AlwaysSample()))
|
||||||
otel.SetTracerProvider(tp)
|
otel.SetTracerProvider(tp)
|
||||||
defer otel.SetTracerProvider(otp)
|
defer otel.SetTracerProvider(otp)
|
||||||
|
|
||||||
ctx, _ := tp.Tracer("foo").Start(context.Background(), "bar")
|
ctx, span := tp.Tracer("foo").Start(context.Background(), "bar")
|
||||||
l := WithContext(ctx).(*traceLogger)
|
defer span.End()
|
||||||
|
|
||||||
|
l := WithContext(ctx)
|
||||||
SetLevel(InfoLevel)
|
SetLevel(InfoLevel)
|
||||||
l.WithDuration(time.Second).Slow(testlog)
|
l.WithDuration(time.Second).Slow(testlog)
|
||||||
assert.True(t, strings.Contains(buf.String(), traceKey))
|
assert.True(t, strings.Contains(w.String(), traceKey))
|
||||||
assert.True(t, strings.Contains(buf.String(), spanKey))
|
assert.True(t, strings.Contains(w.String(), spanKey))
|
||||||
buf.Reset()
|
w.Reset()
|
||||||
l.WithDuration(time.Second).Slowf(testlog)
|
l.WithDuration(time.Second).Slowf(testlog)
|
||||||
assert.True(t, strings.Contains(buf.String(), traceKey))
|
fmt.Println("buf:", w.String())
|
||||||
assert.True(t, strings.Contains(buf.String(), spanKey))
|
validate(t, w.String(), true, true)
|
||||||
|
w.Reset()
|
||||||
|
l.WithDuration(time.Second).Slowv(testlog)
|
||||||
|
validate(t, w.String(), true, true)
|
||||||
|
w.Reset()
|
||||||
|
l.WithDuration(time.Second).Sloww(testlog, Field("foo", "bar"))
|
||||||
|
validate(t, w.String(), true, true)
|
||||||
|
assert.True(t, strings.Contains(w.String(), "foo"), w.String())
|
||||||
|
assert.True(t, strings.Contains(w.String(), "bar"), w.String())
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestTraceWithoutContext(t *testing.T) {
|
func TestTraceWithoutContext(t *testing.T) {
|
||||||
var buf mockWriter
|
w := new(mockWriter)
|
||||||
atomic.StoreUint32(&initialized, 1)
|
old := writer.Swap(w)
|
||||||
infoLog = newLogWriter(log.New(&buf, "", flags))
|
writer.lock.RLock()
|
||||||
l := WithContext(context.Background()).(*traceLogger)
|
defer func() {
|
||||||
|
writer.lock.RUnlock()
|
||||||
|
writer.Store(old)
|
||||||
|
}()
|
||||||
|
|
||||||
|
l := WithContext(context.Background())
|
||||||
SetLevel(InfoLevel)
|
SetLevel(InfoLevel)
|
||||||
l.WithDuration(time.Second).Info(testlog)
|
l.WithDuration(time.Second).Info(testlog)
|
||||||
assert.False(t, strings.Contains(buf.String(), traceKey))
|
validate(t, w.String(), false, false)
|
||||||
assert.False(t, strings.Contains(buf.String(), spanKey))
|
w.Reset()
|
||||||
buf.Reset()
|
|
||||||
l.WithDuration(time.Second).Infof(testlog)
|
l.WithDuration(time.Second).Infof(testlog)
|
||||||
assert.False(t, strings.Contains(buf.String(), traceKey))
|
validate(t, w.String(), false, false)
|
||||||
assert.False(t, strings.Contains(buf.String(), spanKey))
|
}
|
||||||
|
|
||||||
|
func validate(t *testing.T, body string, expectedTrace, expectedSpan bool) {
|
||||||
|
var val mockValue
|
||||||
|
assert.Nil(t, json.Unmarshal([]byte(body), &val), body)
|
||||||
|
assert.Equal(t, expectedTrace, len(val.Trace) > 0, body)
|
||||||
|
assert.Equal(t, expectedSpan, len(val.Span) > 0, body)
|
||||||
|
}
|
||||||
|
|
||||||
|
type mockValue struct {
|
||||||
|
Trace string `json:"trace"`
|
||||||
|
Span string `json:"span"`
|
||||||
}
|
}
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user