fix: logging consistency, Rust doc comments, test file headers, naming conventions

piwi3910 · piwi3910 · commit cddce59a01d3 · 2026-03-12T05:45:56.000+04:00
- Replace zap.L() global logger with explicit *zap.Logger parameter in
  buildHtpasswdFromConfig and CreateBackendTLSConfig
- Add tracing imports and use bare macro form in forward.rs and wireguard.rs
- Capitalize log messages in converter.go to match dominant pattern
- Add //! module doc comments to proxy, sdwan, mesh, and l4 mod.rs
- Add Apache 2.0 license headers to 10 test files
- Rename _additional test files to _extended
- Unexport ErrInvalidByteSize to errInvalidByteSize (internal-only sentinel)
diff --git a/dataplane/novaedge-dataplane/src/l4/mod.rs b/dataplane/novaedge-dataplane/src/l4/mod.rs
@@ -1,8 +1,8 @@
-// L4 proxy modules provide advanced TCP/UDP proxying with connection limits,
-// session affinity, metrics, and PROXY protocol support. Currently the
-// listener manager uses inline copy_bidirectional for L4 gateways; these
-// modules will be integrated once per-gateway connection limits and byte
-// counters are wired through config.
+//! L4 proxy modules provide advanced TCP/UDP proxying with connection limits,
+//! session affinity, metrics, and PROXY protocol support. Currently the
+//! listener manager uses inline copy_bidirectional for L4 gateways; these
+//! modules will be integrated once per-gateway connection limits and byte
+//! counters are wired through config.
 #[allow(dead_code)]
 pub mod proxy_protocol;
 #[allow(dead_code)]
diff --git a/dataplane/novaedge-dataplane/src/mesh/mod.rs b/dataplane/novaedge-dataplane/src/mesh/mod.rs
@@ -1,3 +1,5 @@
+//! Service mesh module.
+
 pub mod authz;
 pub mod mtls;
 pub mod spiffe;
diff --git a/dataplane/novaedge-dataplane/src/middleware/auth/forward.rs b/dataplane/novaedge-dataplane/src/middleware/auth/forward.rs
@@ -8,6 +8,7 @@ use std::time::Duration;
 
 use tokio::io::{AsyncReadExt, AsyncWriteExt};
 use tokio::net::TcpStream;
+use tracing::warn;
 
 /// Forward auth configuration.
 #[allow(dead_code)] // Forward auth requires async network calls; handled separately from sync pipeline.
@@ -60,7 +61,7 @@ impl ForwardAuth {
             {
                 // Reject header names/values containing CR or LF to prevent request smuggling.
                 if contains_cr_lf(header_name) || contains_cr_lf(value) {
-                    tracing::warn!(
+                    warn!(
                         header = %header_name,
                         "Dropping header with CR/LF characters to prevent request smuggling"
                     );
@@ -88,7 +89,7 @@ impl ForwardAuth {
         };
         for sock_addr in &resolved {
             if is_denied_ip(&sock_addr.ip()) {
-                tracing::warn!(
+                warn!(
                     addr = %sock_addr,
                     auth_url = %self.config.auth_url,
                     "Forward auth URL resolves to denied internal IP — blocking SSRF"
diff --git a/dataplane/novaedge-dataplane/src/proxy/mod.rs b/dataplane/novaedge-dataplane/src/proxy/mod.rs
@@ -1,3 +1,5 @@
+//! Proxy module.
+
 pub mod handler;
 pub mod http3;
 pub mod response;
diff --git a/dataplane/novaedge-dataplane/src/sdwan/mod.rs b/dataplane/novaedge-dataplane/src/sdwan/mod.rs
@@ -1,3 +1,5 @@
+//! SD-WAN module.
+
 pub mod link;
 pub mod path_selection;
 pub mod wireguard;
diff --git a/dataplane/novaedge-dataplane/src/sdwan/wireguard.rs b/dataplane/novaedge-dataplane/src/sdwan/wireguard.rs
@@ -2,6 +2,8 @@ use std::fmt;
 use std::net::SocketAddr;
 use std::time::Duration;
 
+use tracing::info;
+
 /// WireGuard peer configuration.
 #[derive(Clone)]
 pub struct WireGuardPeer {
@@ -73,14 +75,14 @@ impl WireGuardManager {
     }
 
     pub fn add_tunnel(&mut self, config: WireGuardConfig) -> anyhow::Result<()> {
-        tracing::info!(interface = %config.interface_name, "Adding WireGuard tunnel");
+        info!(interface = %config.interface_name, "Adding WireGuard tunnel");
         self.tunnels.push(config);
         Ok(())
     }
 
     pub fn remove_tunnel(&mut self, interface: &str) -> anyhow::Result<()> {
         self.tunnels.retain(|t| t.interface_name != interface);
-        tracing::info!(interface = %interface, "Removed WireGuard tunnel");
+        info!(interface = %interface, "Removed WireGuard tunnel");
         Ok(())
     }
 
@@ -95,14 +97,14 @@ impl WireGuardManager {
     #[cfg(target_os = "linux")]
     pub fn apply(&mut self) -> anyhow::Result<()> {
         // On Linux: create WireGuard interface via netlink, configure peers
-        tracing::info!("Applying WireGuard configuration (Linux)");
+        info!("Applying WireGuard configuration (Linux)");
         self.active = true;
         Ok(())
     }
 
     #[cfg(not(target_os = "linux"))]
     pub fn apply(&mut self) -> anyhow::Result<()> {
-        tracing::info!("WireGuard apply: mock mode (non-Linux)");
+        info!("WireGuard apply: mock mode (non-Linux)");
         self.active = true;
         Ok(())
     }
diff --git a/internal/acme/client_test.go b/internal/acme/client_test.go
@@ -1,3 +1,19 @@
+/*
+Copyright 2024 NovaEdge Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package acme
 
 import (
diff --git a/internal/acme/selfsigned_test.go b/internal/acme/selfsigned_test.go
@@ -1,3 +1,19 @@
+/*
+Copyright 2024 NovaEdge Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package acme
 
 import (
diff --git a/internal/agent/config/validation_test.go b/internal/agent/config/validation_test.go
@@ -1,3 +1,19 @@
+/*
+Copyright 2024 NovaEdge Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package config
 
 import (
diff --git a/internal/agent/config/watcher_test.go b/internal/agent/config/watcher_test.go
@@ -1,3 +1,19 @@
+/*
+Copyright 2024 NovaEdge Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package config
 
 import (
diff --git a/internal/controller/config_server_test.go b/internal/controller/config_server_test.go
@@ -1,3 +1,19 @@
+/*
+Copyright 2024 NovaEdge Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package controller
 
 import (
diff --git a/internal/dataplane/client_test.go b/internal/dataplane/client_test.go
@@ -1,3 +1,19 @@
+/*
+Copyright 2024 NovaEdge Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package dataplane
 
 import (
diff --git a/internal/dataplane/forwarding_test.go b/internal/dataplane/forwarding_test.go
@@ -1,3 +1,19 @@
+/*
+Copyright 2024 NovaEdge Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package dataplane
 
 import (
diff --git a/internal/dataplane/translator_test.go b/internal/dataplane/translator_test.go
@@ -1,3 +1,19 @@
+/*
+Copyright 2024 NovaEdge Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package dataplane
 
 import (
diff --git a/internal/observability/tracing_extended_test.go b/internal/observability/tracing_extended_test.go
diff --git a/internal/pkg/convert/bytesize.go b/internal/pkg/convert/bytesize.go
@@ -23,8 +23,8 @@ import (
 	"strings"
 )
 
-// ErrInvalidByteSize is returned when a byte size string cannot be parsed.
-var ErrInvalidByteSize = errors.New("invalid byte size")
+// errInvalidByteSize is returned when a byte size string cannot be parsed.
+var errInvalidByteSize = errors.New("invalid byte size")
 
 // ParseByteSize parses a human-readable byte size string (e.g., "10Mi", "1024", "50MB").
 func ParseByteSize(s string) (int64, error) {
@@ -53,11 +53,11 @@ func ParseByteSize(s string) (int64, error) {
 			numStr := strings.TrimSuffix(s, suffix)
 			n, err := strconv.ParseInt(numStr, 10, 64)
 			if err != nil {
-				return 0, fmt.Errorf("%w: %s", ErrInvalidByteSize, s)
+				return 0, fmt.Errorf("%w: %s", errInvalidByteSize, s)
 			}
 			return n * mult, nil
 		}
 	}
 
-	return 0, fmt.Errorf("%w: %s", ErrInvalidByteSize, s)
+	return 0, fmt.Errorf("%w: %s", errInvalidByteSize, s)
 }
diff --git a/internal/pkg/convert/int_test.go b/internal/pkg/convert/int_test.go
@@ -1,3 +1,19 @@
+/*
+Copyright 2024 NovaEdge Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package convert
 
 import (
diff --git a/internal/pkg/grpclimits/grpclimits_extended_test.go b/internal/pkg/grpclimits/grpclimits_extended_test.go
diff --git a/internal/pkg/httpjson/response_test.go b/internal/pkg/httpjson/response_test.go
@@ -1,3 +1,19 @@
+/*
+Copyright 2024 NovaEdge Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 package httpjson_test
 
 import (
diff --git a/internal/pkg/tlsutil/tls.go b/internal/pkg/tlsutil/tls.go
@@ -292,7 +292,7 @@ func CreateClientTLSConfigWithMTLS(certPEM, keyPEM, caPEM []byte, serverName str
 
 // CreateBackendTLSConfig creates a TLS config for backend connections
 // This is used by the upstream pool to connect to backend services
-func CreateBackendTLSConfig(caCertPEM []byte, serverName string, insecureSkipVerify bool) (*tls.Config, error) {
+func CreateBackendTLSConfig(logger *zap.Logger, caCertPEM []byte, serverName string, insecureSkipVerify bool) (*tls.Config, error) {
 	config := &tls.Config{
 		ServerName:   serverName,
 		MinVersion:   tls.VersionTLS13,
@@ -304,7 +304,7 @@ func CreateBackendTLSConfig(caCertPEM []byte, serverName string, insecureSkipVer
 	// Callers are responsible for ensuring this is only enabled when appropriate.
 	if insecureSkipVerify {
 		config.InsecureSkipVerify = true
-		zap.L().Warn("TLS certificate verification disabled for backend connection",
+		logger.Warn("TLS certificate verification disabled for backend connection",
 			zap.String("server_name", serverName),
 			zap.String("security_risk", "man-in-the-middle attacks possible"),
 		)
diff --git a/internal/pkg/tlsutil/tls_test.go b/internal/pkg/tlsutil/tls_test.go
@@ -28,6 +28,8 @@ import (
 	"path/filepath"
 	"testing"
 	"time"
+
+	"go.uber.org/zap"
 )
 
 // generateTestCertificate creates a self-signed certificate for testing
@@ -407,7 +409,7 @@ func TestCreateBackendTLSConfig(t *testing.T) {
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			config, err := CreateBackendTLSConfig(tt.caCertPEM, tt.serverName, tt.insecureSkipVerify)
+			config, err := CreateBackendTLSConfig(zap.NewNop(), tt.caCertPEM, tt.serverName, tt.insecureSkipVerify)
 			if err != nil {
 				t.Fatalf("CreateBackendTLSConfig() error = %v", err)
 			}
@@ -432,7 +434,7 @@ func TestCreateBackendTLSConfig(t *testing.T) {
 }
 
 func TestCreateBackendTLSConfig_InvalidCA(t *testing.T) {
-	_, err := CreateBackendTLSConfig([]byte("invalid-ca"), "backend.example.com", false)
+	_, err := CreateBackendTLSConfig(zap.NewNop(), []byte("invalid-ca"), "backend.example.com", false)
 	if err == nil {
 		t.Error("CreateBackendTLSConfig() should return error for invalid CA")
 	}
diff --git a/internal/standalone/converter.go b/internal/standalone/converter.go

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+//! Service mesh module.`
	`2`	`+`
`1`	`3`	`pub mod authz;`
`2`	`4`	`pub mod mtls;`
`3`	`5`	`pub mod spiffe;`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+//! Proxy module.`
	`2`	`+`
`1`	`3`	`pub mod handler;`
`2`	`4`	`pub mod http3;`
`3`	`5`	`pub mod response;`