gilles/onvif-go
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: enhance code clarity and maintainability across multiple files

Browse Source 
- Updated comments to improve clarity and adhere to best practices in ascii.go, main.go, and diagnostics.
- Removed unnecessary linter directives for improved readability in imaging.go and ptz.go.
- Reformatted function signatures and added helper calls in tests for consistency and clarity.
- Enhanced error handling and logging consistency in various server files, ensuring better maintainability.
This commit is contained in:
0x524a
2025-12-02 22:21:20 -05:00
parent c1daba5be6
commit 02f79ea7a7
12 changed files with 70 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cmd/onvif-cli/ascii.go
+1 -1
View File
@@ -70,7 +70,7 @@ func ImageToASCII(imageData []byte, config ASCIIConfig) (string, error) {
// imageToASCIIFromImage is the core conversion function.
//
//nolint:gocyclo // Image to ASCII conversion has high complexity due to multiple pixel processing paths
//nolint:gocyclo,lll // Image to ASCII conversion has high complexity due to multiple pixel processing paths
func imageToASCIIFromImage(img image.Image, config ASCIIConfig, format string) (string, error) { //nolint:unparam // format reserved for future use
// Validate configuration
if config.Width <= 0 {
cmd/onvif-cli/main.go
+7 -4
View File
@@ -280,6 +280,7 @@ func (c *CLI) performDiscoveryOnInterface(interfaceName string) ([]*discovery.De
if err != nil {
return nil, fmt.Errorf("discovery failed: %w", err)
}
return devices, nil
}
@@ -614,11 +615,13 @@ func (c *CLI) inspectRTSPStream(streamURI string) map[string]interface{} {
// Use rtspeek library for detailed stream inspection
ctx, cancel := context.WithTimeout(
context.Background(),
defaultRetryDelay*time.Second, //nolint:mnd // Stream inspection timeout
defaultRetryDelay*time.Second,
)
defer cancel()
streamInfo, err := sd.DescribeStream(ctx, streamURI, defaultRetryDelay*time.Second) //nolint:mnd // Stream description timeout
streamInfo, err := sd.DescribeStream(
ctx, streamURI, defaultRetryDelay*time.Second,
)
if err == nil && streamInfo != nil {
details["reachable"] = streamInfo.IsReachable()
@@ -685,7 +688,7 @@ func (c *CLI) tryRTSPConnection(streamURI string) map[string]interface{} {
}
// Try to connect
conn, err := net.DialTimeout("tcp", hostPort, maxRetries*time.Second) //nolint:mnd // Connection timeout
conn, err := net.DialTimeout("tcp", hostPort, maxRetries*time.Second)
if err == nil {
//nolint:errcheck // Close error is not critical for connectivity check
_ = conn.Close()
@@ -1615,7 +1618,7 @@ func (c *CLI) captureAndDisplaySnapshot(ctx context.Context) { //nolint:funlen /
filename = "snapshot.jpg"
}
if err := os.WriteFile(
filename, snapshotData, 0600, //nolint:gosec,mnd // 0600 appropriate for CLI output files
filename, snapshotData, 0600, //nolint:mnd // 0600 appropriate for CLI output files
); err != nil {
fmt.Printf("❌ Failed to save file: %v\n", err)
} else {
cmd/onvif-diagnostics/main.go
+7 -7
View File
@@ -152,7 +152,7 @@ var (
captureXML = flag.Bool("capture-xml", false, "Capture raw SOAP XML traffic and create tar.gz archive")
)
//nolint:gocognit // Main function has high complexity due to multiple diagnostic operations
//nolint:funlen,gocognit,gocyclo // Main function has high complexity due to multiple diagnostic operations
func main() {
flag.Parse()
@@ -175,7 +175,7 @@ func main() {
}
// Create output directory
if err := os.MkdirAll(*outputDir, 0750); err != nil { //nolint:gosec,mnd // 0750 appropriate for diagnostic output
if err := os.MkdirAll(*outputDir, 0750); err != nil { //nolint:mnd // 0750 appropriate for diagnostic output
log.Fatalf("Failed to create output directory: %v", err)
}
@@ -199,7 +199,7 @@ func main() {
if *captureXML {
timestamp := time.Now().Format("20060102-150405")
xmlCaptureDir = filepath.Join(*outputDir, "temp_"+timestamp)
if err := os.MkdirAll(xmlCaptureDir, 0750); err != nil { //nolint:gosec,mnd // 0750 appropriate for diagnostic output
if err := os.MkdirAll(xmlCaptureDir, 0750); err != nil { //nolint:mnd // 0750 appropriate for diagnostic output
log.Fatalf("Failed to create XML capture directory: %v", err)
}
@@ -884,7 +884,7 @@ func saveReport(report *CameraReport, filename string) error {
return fmt.Errorf("failed to marshal report: %w", err)
}
if err := os.WriteFile(filename, data, 0600); err != nil { //nolint:gosec,mnd // 0600 appropriate for diagnostic files
if err := os.WriteFile(filename, data, 0600); err != nil { //nolint:mnd // 0600 appropriate for diagnostic files
return fmt.Errorf("failed to write file: %w", err)
}
@@ -1024,7 +1024,7 @@ func (t *LoggingTransport) saveCapture(capture *XMLCapture) {
return
}
if err := os.WriteFile(filename, data, 0600); err != nil { //nolint:gosec,mnd // 0600 appropriate for diagnostic files
if err := os.WriteFile(filename, data, 0600); err != nil { //nolint:mnd // 0600 appropriate for diagnostic files
log.Printf("Failed to write capture: %v", err)
}
@@ -1032,7 +1032,7 @@ func (t *LoggingTransport) saveCapture(capture *XMLCapture) {
reqFile := filepath.Join(t.LogDir, baseFilename+"_request.xml")
prettyRequest := prettyPrintXML(capture.RequestBody)
if err := os.WriteFile(
reqFile, []byte(prettyRequest), 0600, //nolint:gosec,mnd // 0600 appropriate for diagnostic files
reqFile, []byte(prettyRequest), 0600, //nolint:mnd // 0600 appropriate for diagnostic files
); err != nil {
log.Printf("Failed to write request XML: %v", err)
}
@@ -1040,7 +1040,7 @@ func (t *LoggingTransport) saveCapture(capture *XMLCapture) {
respFile := filepath.Join(t.LogDir, baseFilename+"_response.xml")
prettyResponse := prettyPrintXML(capture.ResponseBody)
if err := os.WriteFile(
respFile, []byte(prettyResponse), 0600, //nolint:gosec,mnd // 0600 appropriate for diagnostic files
respFile, []byte(prettyResponse), 0600, //nolint:mnd // 0600 appropriate for diagnostic files
); err != nil {
log.Printf("Failed to write response XML: %v", err)
}
cmd/onvif-server/main.go
+3 -1
View File
@@ -38,7 +38,9 @@ func main() {
model := flag.String("model", "Virtual Multi-Lens Camera", "Device model")
firmware := flag.String("firmware", "1.0.0", "Firmware version")
serial := flag.String("serial", "SN-12345678", "Serial number")
profiles := flag.Int("profiles", maxWorkers, "Number of camera profiles (1-10)") //nolint:mnd // Default profile count
profiles := flag.Int(
"profiles", maxWorkers, "Number of camera profiles (1-10)", //nolint:mnd // Default profile count is reasonable
)
ptz := flag.Bool("ptz", true, "Enable PTZ support")
imaging := flag.Bool("imaging", true, "Enable Imaging support")
events := flag.Bool("events", false, "Enable Events support")
internal/soap/soap.go
+2 -2
View File
@@ -42,14 +42,14 @@ type Fault struct {
// Security represents WS-Security header.
type Security struct {
XMLName xml.Name `xml:"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd Security"`
XMLName xml.Name `xml:"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd Security"` //nolint:lll // Long XML namespace
MustUnderstand string `xml:"http://www.w3.org/2003/05/soap-envelope mustUnderstand,attr,omitempty"`
UsernameToken *UsernameToken `xml:"UsernameToken,omitempty"`
}
// UsernameToken represents a WS-Security username token.
type UsernameToken struct {
XMLName xml.Name `xml:"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd UsernameToken"`
XMLName xml.Name `xml:"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd UsernameToken"` //nolint:lll // Long XML namespace
Username string `xml:"Username"`
Password Password `xml:"Password"`
Nonce Nonce `xml:"Nonce"`
server/imaging.go
+2 -2
View File
@@ -347,8 +347,8 @@ func (s *Server) HandleSetImagingSettings(body interface{}) (interface{}, error)
// HandleGetOptions handles GetOptions request.
func (s *Server) HandleGetOptions(body interface{}) (interface{}, error) {
// Return available imaging options/capabilities
const maxImagingValue = 100 //nolint:mnd // Maximum imaging parameter value
const maxExposureTime = 10000 //nolint:mnd // Maximum exposure time in microseconds
const maxImagingValue = 100 // Maximum imaging parameter value
const maxExposureTime = 10000 // Maximum exposure time in microseconds
options := &ImagingOptions{
Brightness: &FloatRange{Min: 0, Max: maxImagingValue},
ColorSaturation: &FloatRange{Min: 0, Max: maxImagingValue},
server/imaging_test.go
+9 -8
View File
@@ -11,7 +11,7 @@ const (
)
func TestHandleGetImagingSettings(t *testing.T) {
config := createTestConfig(t)
config := createTestConfig()
server, _ := New(config)
videoSourceToken := config.Profiles[0].VideoSource.Token
@@ -47,7 +47,7 @@ func TestHandleGetImagingSettings(t *testing.T) {
}
func TestHandleSetImagingSettings(t *testing.T) {
config := createTestConfig(t)
config := createTestConfig()
server, _ := New(config)
videoSourceToken := config.Profiles[0].VideoSource.Token
@@ -90,7 +90,7 @@ func TestHandleSetImagingSettings(t *testing.T) {
}
func TestHandleGetOptions(t *testing.T) {
config := createTestConfig(t)
config := createTestConfig()
server, _ := New(config)
videoSourceToken := config.Profiles[0].VideoSource.Token
@@ -128,9 +128,10 @@ func TestHandleGetOptions(t *testing.T) {
// TestHandleMove - DISABLED due to SOAP namespace requirements.
//
//nolint:unused // Disabled test function kept for reference
//nolint:unused,thelper // Disabled test function kept for reference
func _DisabledTestHandleMove(t *testing.T) {
config := createTestConfig(t)
t.Helper()
config := createTestConfig()
server, _ := New(config)
videoSourceToken := config.Profiles[0].VideoSource.Token
@@ -470,7 +471,7 @@ func TestGetImagingSettingsResponseXML(t *testing.T) {
}
func TestHandleGetOptionsDetails(t *testing.T) {
config := createTestConfig(t)
config := createTestConfig()
server, _ := New(config)
videoSourceToken := config.Profiles[0].VideoSource.Token
@@ -506,7 +507,7 @@ func TestImagingSettingsEdgeCases(t *testing.T) {
}
func TestSetImagingSettingsEdgeCases(t *testing.T) {
config := createTestConfig(t)
config := createTestConfig()
server, _ := New(config)
videoSourceToken := config.Profiles[0].VideoSource.Token
@@ -525,7 +526,7 @@ func TestSetImagingSettingsEdgeCases(t *testing.T) {
}
func TestGetImagingSettingsEdgeCases(t *testing.T) {
config := createTestConfig(t)
config := createTestConfig()
server, _ := New(config)
// Test with invalid token
server/ptz.go
+2 -2
View File
@@ -306,8 +306,8 @@ func (s *Server) HandleRelativeMove(body interface{}) (interface{}, error) {
}
// Clamp values to valid ranges (simplified)
const maxPan = 180 //nolint:mnd // PTZ pan range
const maxTilt = 90 //nolint:mnd // PTZ tilt range
const maxPan = 180 // PTZ pan range
const maxTilt = 90 // PTZ tilt range
state.Position.Pan = clamp(state.Position.Pan, -maxPan, maxPan)
state.Position.Tilt = clamp(state.Position.Tilt, -maxTilt, maxTilt)
state.Position.Zoom = clamp(state.Position.Zoom, 0, 1)
server/ptz_test.go
+12 -6
View File
@@ -8,8 +8,9 @@ import (
// These handlers are better tested through the SOAP handler in integration tests.
//
//nolint:unused // Disabled test function kept for reference
//nolint:unused,thelper // Disabled test function kept for reference
func _DisabledTestHandleGetPresets(t *testing.T) {
t.Helper()
config := createTestConfig()
server, _ := New(config)
profileToken := config.Profiles[0].Token
@@ -78,8 +79,9 @@ func TestHandleGotoPreset(t *testing.T) {
// TestHandleGetStatus - DISABLED due to SOAP namespace requirements.
//
//nolint:unused // Disabled test function kept for reference
//nolint:unused,thelper // Disabled test function kept for reference
func _DisabledTestHandleGetStatus(t *testing.T) {
t.Helper()
config := createTestConfig()
server, _ := New(config)
profileToken := config.Profiles[0].Token
@@ -116,8 +118,9 @@ func _DisabledTestHandleGetStatus(t *testing.T) {
// TestHandleAbsoluteMove - DISABLED due to SOAP namespace requirements
//
//nolint:dupl // Disabled test functions have similar structure
//nolint:unused // Disabled test function kept for reference
//nolint:unused,thelper // Disabled test function kept for reference
func _DisabledTestHandleAbsoluteMove(t *testing.T) {
t.Helper()
config := createTestConfig()
server, _ := New(config)
profileToken := config.Profiles[0].Token
@@ -159,8 +162,9 @@ func _DisabledTestHandleAbsoluteMove(t *testing.T) {
// TestHandleRelativeMove - DISABLED due to SOAP namespace requirements
//
//nolint:dupl // Disabled test functions have similar structure
//nolint:unused // Disabled test function kept for reference
//nolint:unused,thelper // Disabled test function kept for reference
func _DisabledTestHandleRelativeMove(t *testing.T) {
t.Helper()
config := createTestConfig()
server, _ := New(config)
profileToken := config.Profiles[0].Token
@@ -202,8 +206,9 @@ func _DisabledTestHandleRelativeMove(t *testing.T) {
// TestHandleContinuousMove - DISABLED due to SOAP namespace requirements
//
//nolint:dupl // Disabled test functions have similar structure
//nolint:unused // Disabled test function kept for reference
//nolint:unused,thelper // Disabled test function kept for reference
func _DisabledTestHandleContinuousMove(t *testing.T) {
t.Helper()
config := createTestConfig()
server, _ := New(config)
profileToken := config.Profiles[0].Token
@@ -244,8 +249,9 @@ func _DisabledTestHandleContinuousMove(t *testing.T) {
// TestHandleStop - DISABLED due to SOAP namespace requirements.
//
//nolint:unused // Disabled test function kept for reference
//nolint:unused,thelper // Disabled test function kept for reference
func _DisabledTestHandleStop(t *testing.T) {
t.Helper()
config := createTestConfig()
server, _ := New(config)
profileToken := config.Profiles[0].Token
server/server.go
+1 -1
View File
@@ -160,7 +160,7 @@ func (s *Server) Start(ctx context.Context) error {
select {
case <-ctx.Done():
fmt.Println("\n🛑 Shutting down server...")
const shutdownTimeout = 5 //nolint:mnd // Server shutdown timeout in seconds
const shutdownTimeout = 5 // Server shutdown timeout in seconds
shutdownCtx, cancel := context.WithTimeout(context.Background(), shutdownTimeout*time.Second)
defer cancel()
server/soap/handler_test.go
+3 -2
View File
@@ -12,6 +12,7 @@ import (
"testing"
)
const testXMLHeader = `<?xml version="1.0"?>`
func TestNewHandler(t *testing.T) {
handler := NewHandler("admin", "password")
@@ -68,7 +69,7 @@ func TestServeHTTPValidSOAPRequest(t *testing.T) {
})
// Create SOAP request
soapBody := `<?xml version="1.0"?>
soapBody := testXMLHeader + `
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<TestAction/>
@@ -323,7 +324,7 @@ func TestAuthenticateFailsWithWrongPassword(t *testing.T) {
func TestHandlerWithoutAuthentication(t *testing.T) {
handler := NewHandler("", "") // No authentication
soapBody := `<?xml version="1.0"?>
soapBody := testXMLHeader + `
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<TestAction/>
server/types.go
+21 -20
View File
@@ -250,14 +250,12 @@ type WDRSettings struct {
}
// DefaultConfig returns a default server configuration with a multi-lens camera setup.
//
//nolint:funlen // DefaultConfig has many statements due to comprehensive default configuration
func DefaultConfig() *Config {
func DefaultConfig() *Config { //nolint:funlen // DefaultConfig has many statements due to comprehensive default configuration
return &Config{
Host: "0.0.0.0",
Port: 8080, //nolint:mnd // Default HTTP port
BasePath: "/onvif",
Timeout: defaultTimeoutSec * time.Second, //nolint:mnd // Default timeout
Timeout: defaultTimeoutSec * time.Second,
DeviceInfo: DeviceInfo{
Manufacturer: "onvif-go",
Model: "Virtual Multi-Lens Camera",
@@ -277,25 +275,25 @@ func DefaultConfig() *Config {
VideoSource: VideoSourceConfig{
Token: "video_source_0",
Name: "Main Camera",
Resolution: Resolution{Width: defaultWidth, Height: defaultHeight}, //nolint:mnd // Default resolution
Framerate: defaultFramerate, //nolint:mnd // Default framerate
Bounds: Bounds{X: 0, Y: 0, Width: defaultWidth, Height: defaultHeight}, //nolint:mnd // Default bounds
Resolution: Resolution{Width: defaultWidth, Height: defaultHeight},
Framerate: defaultFramerate,
Bounds: Bounds{X: 0, Y: 0, Width: defaultWidth, Height: defaultHeight},
},
VideoEncoder: VideoEncoderConfig{
Encoding: "H264",
Resolution: Resolution{Width: defaultWidth, Height: defaultHeight}, //nolint:mnd // Default resolution
Quality: defaultQuality, //nolint:mnd // Default quality
Framerate: defaultFramerate, //nolint:mnd // Default framerate
Bitrate: defaultBitrate, //nolint:mnd // Default bitrate
GovLength: defaultFramerate, //nolint:mnd // Default gov length
Resolution: Resolution{Width: defaultWidth, Height: defaultHeight},
Quality: defaultQuality,
Framerate: defaultFramerate,
Bitrate: defaultBitrate,
GovLength: defaultFramerate,
},
PTZ: &PTZConfig{
NodeToken: "ptz_node_0",
PanRange: Range{Min: -maxPan, Max: maxPan}, //nolint:mnd // PTZ pan range
TiltRange: Range{Min: -maxTilt, Max: maxTilt}, //nolint:mnd // PTZ tilt range
PanRange: Range{Min: -maxPan, Max: maxPan},
TiltRange: Range{Min: -maxTilt, Max: maxTilt},
ZoomRange: Range{Min: 0, Max: 1},
DefaultSpeed: PTZSpeed{
Pan: defaultPTZSpeed, Tilt: defaultPTZSpeed, Zoom: defaultPTZSpeed, //nolint:mnd // Default PTZ speed
Pan: defaultPTZSpeed, Tilt: defaultPTZSpeed, Zoom: defaultPTZSpeed,
},
SupportsContinuous: true,
SupportsAbsolute: true,
@@ -357,10 +355,10 @@ func DefaultConfig() *Config {
GovLength: lowFramerate, //nolint:mnd // Low framerate
},
PTZ: &PTZConfig{
NodeToken: "ptz_node_2",
PanRange: Range{Min: -maxPan, Max: maxPan}, //nolint:mnd // PTZ pan range
TiltRange: Range{Min: -maxTilt, Max: maxTilt}, //nolint:mnd // PTZ tilt range
ZoomRange: Range{Min: 0, Max: maxZoom}, //nolint:mnd // Max zoom
NodeToken: "ptz_node_2",
PanRange: Range{Min: -maxPan, Max: maxPan},
TiltRange: Range{Min: -maxTilt, Max: maxTilt},
ZoomRange: Range{Min: 0, Max: maxZoom}, //nolint:mnd // Max zoom
DefaultSpeed: PTZSpeed{
Pan: lowPTZSpeed, Tilt: lowPTZSpeed, Zoom: lowPTZSpeed, //nolint:mnd // Low PTZ speed
},
@@ -369,7 +367,10 @@ func DefaultConfig() *Config {
SupportsRelative: true,
Presets: []Preset{
{Token: "preset_2_0", Name: "Home", Position: PTZPosition{Pan: 0, Tilt: 0, Zoom: 0}},
{Token: "preset_2_1", Name: "Zoom In", Position: PTZPosition{Pan: 0, Tilt: 0, Zoom: presetZoom}}, //nolint:mnd // Preset zoom
{
Token: "preset_2_1", Name: "Zoom In",
Position: PTZPosition{Pan: 0, Tilt: 0, Zoom: presetZoom}, //nolint:mnd // Preset zoom
},
},
},
Snapshot: SnapshotConfig{