mirror of
https://github.com/lukaszraczylo/kportal.git
synced 2026-07-08 06:35:10 +00:00
improvements nov2025 (#10)
* Add benchmark and httplog modules, update UI for modals artefacts
This commit is contained in:
@@ -25,6 +25,9 @@ const (
|
||||
DefaultTCPKeepalive = 30 * time.Second // OS-level TCP keepalive interval
|
||||
DefaultDialTimeout = 30 * time.Second // Connection establishment timeout
|
||||
DefaultWatchdogPeriod = 30 * time.Second // Goroutine health check interval
|
||||
|
||||
// Default HTTP logging settings
|
||||
DefaultHTTPLogMaxBodySize = 1024 * 1024 // 1MB max body size for logging
|
||||
)
|
||||
|
||||
// Config represents the root configuration structure from .kportal.yaml
|
||||
@@ -158,14 +161,44 @@ type Namespace struct {
|
||||
Forwards []Forward `yaml:"forwards"`
|
||||
}
|
||||
|
||||
// HTTPLogSpec configures HTTP traffic logging for a forward
|
||||
type HTTPLogSpec struct {
|
||||
Enabled bool `yaml:"enabled"` // Enable HTTP logging
|
||||
LogFile string `yaml:"logFile,omitempty"` // Output file (empty = stdout)
|
||||
MaxBodySize int `yaml:"maxBodySize,omitempty"` // Max body size to log (default 1MB)
|
||||
IncludeHeaders bool `yaml:"includeHeaders,omitempty"` // Include headers in log
|
||||
FilterPath string `yaml:"filterPath,omitempty"` // Optional glob filter for paths
|
||||
}
|
||||
|
||||
// UnmarshalYAML implements custom unmarshaling to support both bool and struct formats
|
||||
// Allows: httpLog: true OR httpLog: { enabled: true, ... }
|
||||
func (h *HTTPLogSpec) UnmarshalYAML(unmarshal func(interface{}) error) error {
|
||||
// First try to unmarshal as a boolean
|
||||
var boolVal bool
|
||||
if err := unmarshal(&boolVal); err == nil {
|
||||
h.Enabled = boolVal
|
||||
return nil
|
||||
}
|
||||
|
||||
// Otherwise try to unmarshal as a struct
|
||||
type httpLogSpecAlias HTTPLogSpec // Use alias to avoid infinite recursion
|
||||
var spec httpLogSpecAlias
|
||||
if err := unmarshal(&spec); err != nil {
|
||||
return err
|
||||
}
|
||||
*h = HTTPLogSpec(spec)
|
||||
return nil
|
||||
}
|
||||
|
||||
// Forward represents a single port-forward configuration
|
||||
type Forward struct {
|
||||
Resource string `yaml:"resource"` // e.g., "pod/my-app", "service/postgres", "pod"
|
||||
Selector string `yaml:"selector"` // Label selector for pod resolution (e.g., "app=nginx,env=prod")
|
||||
Protocol string `yaml:"protocol"` // tcp or udp
|
||||
Port int `yaml:"port"` // Remote port
|
||||
LocalPort int `yaml:"localPort"` // Local port
|
||||
Alias string `yaml:"alias,omitempty"` // Optional human-readable alias for this forward
|
||||
Resource string `yaml:"resource"` // e.g., "pod/my-app", "service/postgres", "pod"
|
||||
Selector string `yaml:"selector"` // Label selector for pod resolution (e.g., "app=nginx,env=prod")
|
||||
Protocol string `yaml:"protocol"` // tcp or udp
|
||||
Port int `yaml:"port"` // Remote port
|
||||
LocalPort int `yaml:"localPort"` // Local port
|
||||
Alias string `yaml:"alias,omitempty"` // Optional human-readable alias for this forward
|
||||
HTTPLog *HTTPLogSpec `yaml:"httpLog,omitempty"` // Optional HTTP traffic logging
|
||||
|
||||
// Runtime fields (not in YAML)
|
||||
contextName string
|
||||
@@ -212,6 +245,19 @@ func (f *Forward) GetNamespace() string {
|
||||
return f.namespaceName
|
||||
}
|
||||
|
||||
// IsHTTPLogEnabled returns true if HTTP logging is enabled for this forward
|
||||
func (f *Forward) IsHTTPLogEnabled() bool {
|
||||
return f.HTTPLog != nil && f.HTTPLog.Enabled
|
||||
}
|
||||
|
||||
// GetHTTPLogMaxBodySize returns the max body size for HTTP logging
|
||||
func (f *Forward) GetHTTPLogMaxBodySize() int {
|
||||
if f.HTTPLog == nil || f.HTTPLog.MaxBodySize <= 0 {
|
||||
return DefaultHTTPLogMaxBodySize
|
||||
}
|
||||
return f.HTTPLog.MaxBodySize
|
||||
}
|
||||
|
||||
// GetMDNSAlias returns the alias to use for mDNS hostname registration.
|
||||
// If an explicit alias is set, it returns that.
|
||||
// Otherwise, it generates one from the resource name (e.g., "service/logto" -> "logto").
|
||||
|
||||
@@ -313,3 +313,87 @@ func TestForward_SetContext(t *testing.T) {
|
||||
assert.Equal(t, "my-cluster", fwd.GetContext())
|
||||
assert.Equal(t, "my-namespace", fwd.GetNamespace())
|
||||
}
|
||||
|
||||
func TestHTTPLogSpec_UnmarshalYAML(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
yaml string
|
||||
expected bool
|
||||
}{
|
||||
{
|
||||
name: "httpLog as boolean true",
|
||||
yaml: `contexts:
|
||||
- name: test
|
||||
namespaces:
|
||||
- name: default
|
||||
forwards:
|
||||
- resource: service/api
|
||||
port: 8080
|
||||
localPort: 8080
|
||||
httpLog: true
|
||||
`,
|
||||
expected: true,
|
||||
},
|
||||
{
|
||||
name: "httpLog as boolean false",
|
||||
yaml: `contexts:
|
||||
- name: test
|
||||
namespaces:
|
||||
- name: default
|
||||
forwards:
|
||||
- resource: service/api
|
||||
port: 8080
|
||||
localPort: 8080
|
||||
httpLog: false
|
||||
`,
|
||||
expected: false,
|
||||
},
|
||||
{
|
||||
name: "httpLog as struct",
|
||||
yaml: `contexts:
|
||||
- name: test
|
||||
namespaces:
|
||||
- name: default
|
||||
forwards:
|
||||
- resource: service/api
|
||||
port: 8080
|
||||
localPort: 8080
|
||||
httpLog:
|
||||
enabled: true
|
||||
includeHeaders: true
|
||||
`,
|
||||
expected: true,
|
||||
},
|
||||
{
|
||||
name: "httpLog not specified",
|
||||
yaml: `contexts:
|
||||
- name: test
|
||||
namespaces:
|
||||
- name: default
|
||||
forwards:
|
||||
- resource: service/api
|
||||
port: 8080
|
||||
localPort: 8080
|
||||
`,
|
||||
expected: false,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
cfg, err := ParseConfig([]byte(tt.yaml))
|
||||
assert.NoError(t, err)
|
||||
assert.NotNil(t, cfg)
|
||||
|
||||
fwd := cfg.Contexts[0].Namespaces[0].Forwards[0]
|
||||
if tt.expected {
|
||||
assert.NotNil(t, fwd.HTTPLog, "HTTPLog should not be nil")
|
||||
assert.True(t, fwd.HTTPLog.Enabled, "HTTPLog.Enabled should be true")
|
||||
} else {
|
||||
if fwd.HTTPLog != nil {
|
||||
assert.False(t, fwd.HTTPLog.Enabled, "HTTPLog.Enabled should be false")
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user