mirror of
https://github.com/nabbar/golib.git
synced 2025-12-24 11:51:02 +08:00
3837f0b2bb
[file/bandwidth] - ADD documentation: add enhanced README and TESTING guidelines - ADD tests: complete test suites with benchmarks, concurrency, and edge cases [file/perm] - ADD documentation: add enhanced README and TESTING guidelines - ADD tests: complete test suites with benchmarks, concurrency, and edge cases - ADD function to parse form "rwx-wxr-x" or "-rwx-w-r-x" - ADD function to ParseFileMode to convert os.FileMode to file.Perm [file/progress] - ADD documentation: add enhanced README and TESTING guidelines - ADD tests: complete test suites with benchmarks, concurrency, and edge cases [ioutils/...] - UPDATE documentation: update enhanced README and TESTING guidelines - UPDATE tests: complete test suites with benchmarks, concurrency, and edge cases [logger/...] - UPDATE documentation: update enhanced README and TESTING guidelines - ADD documentation: add enhanced README and TESTING guidelines for sub packages - UPDATE tests: complete test suites with benchmarks, concurrency, and edge cases - UPDATE config: remove FileBufferSize from OptionFile (rework hookfile) - UPDATE fields: expose Store function in interface - REWORK hookfile: rework package, use aggregator to allow multi write and single file - FIX hookstderr: fix bug with NonColorable - FIX hookstdout: fix bug with NonColorable - FIX hookwriter: fix bug with NonColorable [network/protocol] - ADD function IsTCP, IsUDP, IsUnixLike to check type of protocol [runner] - FIX typo [socket] - UPDATE documentation: update enhanced README and TESTING guidelines - ADD documentation: add enhanced README and TESTING guidelines for sub packages - UPDATE tests: complete test suites with benchmarks, concurrency, and edge cases - REWORK server: use context compatible io.reader, io.writer, io.closer instead of reader / writer - REWORK server: simplify, optimize server - REMOVE reader, writer type - ADD context: add new interface in root socket interface to expose context interface that extend context, io reader/writer/closer, dediacted function to server (IsConnected, ...)
400 lines
9.6 KiB
Go
400 lines
9.6 KiB
Go
/*
|
|
* MIT License
|
|
*
|
|
* Copyright (c) 2025 Nicolas JUHEL
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in all
|
|
* copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
* SOFTWARE.
|
|
*
|
|
*/
|
|
|
|
package aggregator_test
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
|
|
"github.com/nabbar/golib/ioutils/aggregator"
|
|
|
|
. "github.com/onsi/ginkgo/v2"
|
|
. "github.com/onsi/gomega"
|
|
)
|
|
|
|
var _ = Describe("Aggregator Creation", func() {
|
|
var (
|
|
ctx context.Context
|
|
cancel context.CancelFunc
|
|
)
|
|
|
|
BeforeEach(func() {
|
|
ctx, cancel = context.WithCancel(testCtx)
|
|
})
|
|
|
|
AfterEach(func() {
|
|
if cancel != nil {
|
|
cancel()
|
|
}
|
|
})
|
|
|
|
Describe("New()", func() {
|
|
Context("with valid configuration", func() {
|
|
It("should create aggregator with all parameters", func() {
|
|
writer := newTestWriter()
|
|
cfg := aggregator.Config{
|
|
AsyncTimer: 100 * time.Millisecond,
|
|
AsyncMax: 5,
|
|
AsyncFct: func(ctx context.Context) {},
|
|
SyncTimer: 200 * time.Millisecond,
|
|
SyncFct: func(ctx context.Context) {},
|
|
BufWriter: 10,
|
|
FctWriter: writer.Write,
|
|
}
|
|
|
|
agg, err := aggregator.New(ctx, cfg)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
Expect(agg).ToNot(BeNil())
|
|
|
|
// Cleanup
|
|
err = agg.Close()
|
|
Expect(err).ToNot(HaveOccurred())
|
|
})
|
|
|
|
It("should create aggregator with minimal configuration", func() {
|
|
writer := newTestWriter()
|
|
cfg := aggregator.Config{
|
|
FctWriter: writer.Write,
|
|
}
|
|
|
|
agg, err := aggregator.New(ctx, cfg)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
Expect(agg).ToNot(BeNil())
|
|
|
|
// Cleanup
|
|
err = agg.Close()
|
|
Expect(err).ToNot(HaveOccurred())
|
|
})
|
|
|
|
It("should create aggregator with nil context", func() {
|
|
writer := newTestWriter()
|
|
cfg := aggregator.Config{
|
|
FctWriter: writer.Write,
|
|
}
|
|
|
|
agg, err := aggregator.New(nil, cfg)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
Expect(agg).ToNot(BeNil())
|
|
|
|
// Cleanup
|
|
err = agg.Close()
|
|
Expect(err).ToNot(HaveOccurred())
|
|
})
|
|
|
|
It("should create aggregator with custom logger", func() {
|
|
writer := newTestWriter()
|
|
cfg := aggregator.Config{
|
|
FctWriter: writer.Write,
|
|
}
|
|
|
|
agg, err := aggregator.New(ctx, cfg)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
Expect(agg).ToNot(BeNil())
|
|
|
|
// Cleanup
|
|
err = agg.Close()
|
|
Expect(err).ToNot(HaveOccurred())
|
|
})
|
|
|
|
It("should create aggregator with unbuffered channel", func() {
|
|
writer := newTestWriter()
|
|
cfg := aggregator.Config{
|
|
BufWriter: 0, // unbuffered
|
|
FctWriter: writer.Write,
|
|
}
|
|
|
|
agg, err := aggregator.New(ctx, cfg)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
Expect(agg).ToNot(BeNil())
|
|
|
|
// Cleanup
|
|
err = agg.Close()
|
|
Expect(err).ToNot(HaveOccurred())
|
|
})
|
|
|
|
It("should create aggregator with buffered channel", func() {
|
|
writer := newTestWriter()
|
|
cfg := aggregator.Config{
|
|
BufWriter: 100,
|
|
FctWriter: writer.Write,
|
|
}
|
|
|
|
agg, err := aggregator.New(ctx, cfg)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
Expect(agg).ToNot(BeNil())
|
|
|
|
// Cleanup
|
|
err = agg.Close()
|
|
Expect(err).ToNot(HaveOccurred())
|
|
})
|
|
})
|
|
|
|
Context("with invalid configuration", func() {
|
|
It("should return error when FctWriter is nil", func() {
|
|
cfg := aggregator.Config{
|
|
AsyncTimer: 100 * time.Millisecond,
|
|
SyncTimer: 200 * time.Millisecond,
|
|
BufWriter: 10,
|
|
FctWriter: nil, // missing required field
|
|
}
|
|
|
|
agg, err := aggregator.New(ctx, cfg)
|
|
Expect(err).To(HaveOccurred())
|
|
Expect(err).To(Equal(aggregator.ErrInvalidWriter))
|
|
Expect(agg).To(BeNil())
|
|
})
|
|
|
|
It("should handle async configuration without function", func() {
|
|
writer := newTestWriter()
|
|
cfg := aggregator.Config{
|
|
AsyncTimer: 100 * time.Millisecond,
|
|
AsyncMax: 5,
|
|
AsyncFct: nil, // timer without function
|
|
FctWriter: writer.Write,
|
|
}
|
|
|
|
agg, err := aggregator.New(ctx, cfg)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
Expect(agg).ToNot(BeNil())
|
|
|
|
// Should not crash, async timer should be ignored
|
|
err = agg.Close()
|
|
Expect(err).ToNot(HaveOccurred())
|
|
})
|
|
|
|
It("should handle sync configuration without function", func() {
|
|
writer := newTestWriter()
|
|
cfg := aggregator.Config{
|
|
SyncTimer: 100 * time.Millisecond,
|
|
SyncFct: nil, // timer without function
|
|
FctWriter: writer.Write,
|
|
}
|
|
|
|
agg, err := aggregator.New(ctx, cfg)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
Expect(agg).ToNot(BeNil())
|
|
|
|
// Should not crash, sync timer should be ignored
|
|
err = agg.Close()
|
|
Expect(err).ToNot(HaveOccurred())
|
|
})
|
|
})
|
|
|
|
Context("with edge cases", func() {
|
|
It("should handle zero AsyncMax", func() {
|
|
writer := newTestWriter()
|
|
cfg := aggregator.Config{
|
|
AsyncMax: 0,
|
|
FctWriter: writer.Write,
|
|
}
|
|
|
|
agg, err := aggregator.New(ctx, cfg)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
Expect(agg).ToNot(BeNil())
|
|
|
|
err = agg.Close()
|
|
Expect(err).ToNot(HaveOccurred())
|
|
})
|
|
|
|
It("should handle negative AsyncMax", func() {
|
|
writer := newTestWriter()
|
|
cfg := aggregator.Config{
|
|
AsyncMax: -1,
|
|
FctWriter: writer.Write,
|
|
}
|
|
|
|
agg, err := aggregator.New(ctx, cfg)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
Expect(agg).ToNot(BeNil())
|
|
|
|
err = agg.Close()
|
|
Expect(err).ToNot(HaveOccurred())
|
|
})
|
|
|
|
It("should handle zero timers", func() {
|
|
writer := newTestWriter()
|
|
cfg := aggregator.Config{
|
|
AsyncTimer: 0,
|
|
SyncTimer: 0,
|
|
FctWriter: writer.Write,
|
|
}
|
|
|
|
agg, err := aggregator.New(ctx, cfg)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
Expect(agg).ToNot(BeNil())
|
|
|
|
err = agg.Close()
|
|
Expect(err).ToNot(HaveOccurred())
|
|
})
|
|
})
|
|
})
|
|
|
|
Describe("Context Interface", func() {
|
|
var (
|
|
agg aggregator.Aggregator
|
|
)
|
|
|
|
BeforeEach(func() {
|
|
writer := newTestWriter()
|
|
cfg := aggregator.Config{
|
|
FctWriter: writer.Write,
|
|
}
|
|
|
|
var err error
|
|
agg, err = aggregator.New(ctx, cfg)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
Expect(agg).ToNot(BeNil())
|
|
})
|
|
|
|
AfterEach(func() {
|
|
if agg != nil {
|
|
_ = agg.Close()
|
|
}
|
|
})
|
|
|
|
It("should implement context.Context interface", func() {
|
|
// Test Done channel
|
|
doneChan := agg.Done()
|
|
Expect(doneChan).ToNot(BeNil())
|
|
|
|
// Test Err (should be nil when not cancelled)
|
|
err := agg.Err()
|
|
Expect(err).To(BeNil())
|
|
|
|
// Test Value
|
|
val := agg.Value("test-key")
|
|
Expect(val).To(BeNil())
|
|
})
|
|
|
|
It("should implement context with deadline", func() {
|
|
deadline := time.Now().Add(5 * time.Second)
|
|
ctxWithDeadline, cancel := context.WithDeadline(ctx, deadline)
|
|
defer cancel()
|
|
|
|
writer := newTestWriter()
|
|
cfg := aggregator.Config{
|
|
FctWriter: writer.Write,
|
|
}
|
|
|
|
agg2, err := aggregator.New(ctxWithDeadline, cfg)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
Expect(agg2).ToNot(BeNil())
|
|
|
|
d, ok := agg2.Deadline()
|
|
Expect(ok).To(BeTrue())
|
|
Expect(d).To(BeTemporally("~", deadline, time.Second))
|
|
|
|
_ = agg2.Close()
|
|
})
|
|
|
|
It("should propagate context values", func() {
|
|
type ctxKey string
|
|
key := ctxKey("test-key")
|
|
value := "test-value"
|
|
|
|
ctxWithValue := context.WithValue(ctx, key, value)
|
|
|
|
writer := newTestWriter()
|
|
cfg := aggregator.Config{
|
|
FctWriter: writer.Write,
|
|
}
|
|
|
|
agg2, err := aggregator.New(ctxWithValue, cfg)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
Expect(agg2).ToNot(BeNil())
|
|
|
|
val := agg2.Value(key)
|
|
Expect(val).To(Equal(value))
|
|
|
|
_ = agg2.Close()
|
|
})
|
|
})
|
|
|
|
Describe("Logger Configuration", func() {
|
|
It("should set custom error logger", func() {
|
|
writer := newTestWriter()
|
|
cfg := aggregator.Config{
|
|
FctWriter: writer.Write,
|
|
}
|
|
|
|
agg, err := aggregator.New(ctx, cfg)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
defer agg.Close()
|
|
|
|
agg.SetLoggerError(func(msg string, err ...error) {
|
|
// Custom logger - just ensure it doesn't panic
|
|
})
|
|
|
|
// This test mainly ensures SetLoggerError doesn't panic
|
|
})
|
|
|
|
It("should set custom info logger", func() {
|
|
writer := newTestWriter()
|
|
cfg := aggregator.Config{
|
|
FctWriter: writer.Write,
|
|
}
|
|
|
|
agg, err := aggregator.New(ctx, cfg)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
defer agg.Close()
|
|
|
|
agg.SetLoggerInfo(func(msg string, arg ...any) {
|
|
// Custom logger - just ensure it doesn't panic
|
|
})
|
|
|
|
// This test mainly ensures SetLoggerInfo doesn't panic
|
|
})
|
|
|
|
It("should handle nil error logger", func() {
|
|
writer := newTestWriter()
|
|
cfg := aggregator.Config{
|
|
FctWriter: writer.Write,
|
|
}
|
|
|
|
agg, err := aggregator.New(ctx, cfg)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
defer agg.Close()
|
|
|
|
// Should not panic
|
|
agg.SetLoggerError(nil)
|
|
})
|
|
|
|
It("should handle nil info logger", func() {
|
|
writer := newTestWriter()
|
|
cfg := aggregator.Config{
|
|
FctWriter: writer.Write,
|
|
}
|
|
|
|
agg, err := aggregator.New(ctx, cfg)
|
|
Expect(err).ToNot(HaveOccurred())
|
|
defer agg.Close()
|
|
|
|
// Should not panic
|
|
agg.SetLoggerInfo(nil)
|
|
})
|
|
})
|
|
})
|