From 04db8103c4d435357cd3e7c4b2d8852819d8e5df Mon Sep 17 00:00:00 2001 From: Jean-Gabriel Gill-Couture Date: Sun, 12 Jan 2025 15:57:01 -0500 Subject: [PATCH] fix(config): update variable names and remove unused imports Refactor variable names to follow snake_case convention and remove unused imports across multiple files to improve code readability and maintainability. --- harmony-rs/Cargo.lock | 70 ++++++++++--------- harmony-rs/demo/vbox-opnsense/src/main.rs | 3 +- harmony-rs/harmony_macros/src/lib.rs | 2 +- harmony-rs/opnsense-config-xml/Cargo.toml | 3 - .../opnsense-config-xml/src/data/haproxy.rs | 4 +- .../opnsense-config-xml/src/data/opnsense.rs | 48 ++++++++----- .../opnsense-config/src/config/config.rs | 2 +- .../opnsense-config/src/config/shell/ssh.rs | 4 +- .../opnsense-config/src/modules/dhcp.rs | 2 - harmony-rs/opnsense-config/src/modules/dns.rs | 1 - 10 files changed, 74 insertions(+), 65 deletions(-) diff --git a/harmony-rs/Cargo.lock b/harmony-rs/Cargo.lock index aa9664f..4c7797e 100644 --- a/harmony-rs/Cargo.lock +++ b/harmony-rs/Cargo.lock @@ -152,7 +152,7 @@ checksum = "a27b8a3a6e1a44fa4c8baf1f653e4172e81486d4941f2237e20dc2d0cf4ddff1" dependencies = [ "proc-macro2", "quote", - "syn 2.0.90", + "syn", ] [[package]] @@ -471,7 +471,7 @@ checksum = "f46882e17999c6cc590af592290432be3bce0428cb0d5f8b6715e4dc7b383eb3" dependencies = [ "proc-macro2", "quote", - "syn 2.0.90", + "syn", ] [[package]] @@ -499,7 +499,7 @@ checksum = "2cdc8d50f426189eef89dac62fabfa0abb27d5cc008f25bf4156a0203325becc" dependencies = [ "proc-macro2", "quote", - "syn 2.0.90", + "syn", ] [[package]] @@ -537,7 +537,7 @@ checksum = "97369cbbc041bc366949bc74d34658d6cda5621039731c6310521892a3a20ae0" dependencies = [ "proc-macro2", "quote", - "syn 2.0.90", + "syn", ] [[package]] @@ -784,7 +784,7 @@ checksum = "87750cf4b7a4c0625b1529e4c543c2182106e4dedc60a2a6455e00d212c489ac" dependencies = [ "proc-macro2", "quote", - "syn 2.0.90", + "syn", ] [[package]] @@ -916,7 +916,7 @@ version = "1.0.0" dependencies = [ "harmony_types", "quote", - "syn 2.0.90", + "syn", ] [[package]] @@ -1189,7 +1189,7 @@ checksum = "1ec89e9337638ecdc08744df490b221a7399bf8d164eb52a665454e60e075ad6" dependencies = [ "proc-macro2", "quote", - "syn 2.0.90", + "syn", ] [[package]] @@ -1499,7 +1499,7 @@ checksum = "a948666b637a0f465e8564c73e89d4dde00d72d4d473cc972f390fc3dcee7d9c" dependencies = [ "proc-macro2", "quote", - "syn 2.0.90", + "syn", ] [[package]] @@ -2219,7 +2219,7 @@ checksum = "a5831b979fd7b5439637af1752d535ff49f4860c0f341d1baeb6faf0f4242170" dependencies = [ "proc-macro2", "quote", - "syn 2.0.90", + "syn", ] [[package]] @@ -2234,6 +2234,18 @@ dependencies = [ "serde", ] +[[package]] +name = "serde_tokenstream" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "64060d864397305347a78851c51588fd283767e7e7589829e8121d65512340f1" +dependencies = [ + "proc-macro2", + "quote", + "serde", + "syn", +] + [[package]] name = "serde_urlencoded" version = "0.7.1" @@ -2397,17 +2409,6 @@ version = "2.6.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "13c2bddecc57b384dee18652358fb23172facb8a2c51ccc10d74c157bdea3292" -[[package]] -name = "syn" -version = "1.0.109" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "72b64191b275b66ffe2469e8af2c1cfe3bafa67b529ead792a6d0160888b4237" -dependencies = [ - "proc-macro2", - "quote", - "unicode-ident", -] - [[package]] name = "syn" version = "2.0.90" @@ -2433,7 +2434,7 @@ checksum = "c8af7666ab7b6390ab78131fb5b0fce11d6b7a6951602017c35fa82800708971" dependencies = [ "proc-macro2", "quote", - "syn 2.0.90", + "syn", ] [[package]] @@ -2493,7 +2494,7 @@ checksum = "a4558b58466b9ad7ca0f102865eccc95938dca1a74a856f2b57b6629050da261" dependencies = [ "proc-macro2", "quote", - "syn 2.0.90", + "syn", ] [[package]] @@ -2540,7 +2541,7 @@ checksum = "693d596312e88961bc67d7f1f97af8a70227d9f90c31bba5806eec004978d752" dependencies = [ "proc-macro2", "quote", - "syn 2.0.90", + "syn", ] [[package]] @@ -2678,7 +2679,7 @@ checksum = "6b91f57fe13a38d0ce9e28a03463d8d3c2468ed03d75375110ec71d93b449a08" dependencies = [ "proc-macro2", "quote", - "syn 2.0.90", + "syn", ] [[package]] @@ -2743,7 +2744,7 @@ dependencies = [ "once_cell", "proc-macro2", "quote", - "syn 2.0.90", + "syn", "wasm-bindgen-shared", ] @@ -2777,7 +2778,7 @@ checksum = "afc340c74d9005395cf9dd098506f7f44e38f2b4a21c6aaacf9a105ea5e1e836" dependencies = [ "proc-macro2", "quote", - "syn 2.0.90", + "syn", "wasm-bindgen-backend", "wasm-bindgen-shared", ] @@ -2995,6 +2996,7 @@ dependencies = [ "env_logger", "harmony", "harmony_macros", + "harmony_types", "log", "tokio", ] @@ -3034,7 +3036,7 @@ checksum = "cfe53a6657fd280eaa890a3bc59152892ffa3e30101319d168b781ed6529b049" [[package]] name = "yaserde" -version = "0.11.1" +version = "0.12.0" dependencies = [ "log", "xml-rs", @@ -3042,13 +3044,15 @@ dependencies = [ [[package]] name = "yaserde_derive" -version = "0.11.1" +version = "0.12.0" dependencies = [ "heck", "log", "proc-macro2", "quote", - "syn 1.0.109", + "serde", + "serde_tokenstream", + "syn", "xml-rs", ] @@ -3072,7 +3076,7 @@ checksum = "2380878cad4ac9aac1e2435f3eb4020e8374b5f13c296cb75b4620ff8e229154" dependencies = [ "proc-macro2", "quote", - "syn 2.0.90", + "syn", "synstructure", ] @@ -3094,7 +3098,7 @@ checksum = "fa4f8080344d4671fb4e831a13ad1e68092748387dfc4f55e356242fae12ce3e" dependencies = [ "proc-macro2", "quote", - "syn 2.0.90", + "syn", ] [[package]] @@ -3114,7 +3118,7 @@ checksum = "595eed982f7d355beb85837f651fa22e90b3c044842dc7f2c2842c086f295808" dependencies = [ "proc-macro2", "quote", - "syn 2.0.90", + "syn", "synstructure", ] @@ -3143,5 +3147,5 @@ checksum = "6eafa6dfb17584ea3e2bd6e76e0cc15ad7af12b09abdd1ca55961bed9b1063c6" dependencies = [ "proc-macro2", "quote", - "syn 2.0.90", + "syn", ] diff --git a/harmony-rs/demo/vbox-opnsense/src/main.rs b/harmony-rs/demo/vbox-opnsense/src/main.rs index 5084dd2..97482c8 100644 --- a/harmony-rs/demo/vbox-opnsense/src/main.rs +++ b/harmony-rs/demo/vbox-opnsense/src/main.rs @@ -28,8 +28,7 @@ async fn main() { }; let opnsense = Arc::new( - harmony::infra::opnsense::OPNSenseFirewall::new(firewall, None, "lan", "root", "opnsense") - .await, + harmony::infra::opnsense::OPNSenseFirewall::new(firewall, None, "root", "opnsense").await, ); let lan_subnet = Ipv4Addr::new(10, 100, 8, 0); let gateway_ipv4 = Ipv4Addr::new(10, 100, 8, 1); diff --git a/harmony-rs/harmony_macros/src/lib.rs b/harmony-rs/harmony_macros/src/lib.rs index d73e12d..a49db36 100644 --- a/harmony-rs/harmony_macros/src/lib.rs +++ b/harmony-rs/harmony_macros/src/lib.rs @@ -52,7 +52,7 @@ pub fn mac_address(input: TokenStream) -> TokenStream { let b5 = bytes[5]; quote! { - MacAddress( [#b0, #b1, #b2, #b3, #b4, #b5] ) + harmony_types::net::MacAddress( [#b0, #b1, #b2, #b3, #b4, #b5] ) } .into() } diff --git a/harmony-rs/opnsense-config-xml/Cargo.toml b/harmony-rs/opnsense-config-xml/Cargo.toml index ac57fe4..0f3c6ca 100644 --- a/harmony-rs/opnsense-config-xml/Cargo.toml +++ b/harmony-rs/opnsense-config-xml/Cargo.toml @@ -22,6 +22,3 @@ rand = { workspace = true } [dev-dependencies] pretty_assertions = "1.4.1" - -[target.x86_64-unknown-linux-gnu] -rustflags = ["-C", "link-arg=-fuse-ld=mold"] diff --git a/harmony-rs/opnsense-config-xml/src/data/haproxy.rs b/harmony-rs/opnsense-config-xml/src/data/haproxy.rs index e38d200..b49ae4a 100644 --- a/harmony-rs/opnsense-config-xml/src/data/haproxy.rs +++ b/harmony-rs/opnsense-config-xml/src/data/haproxy.rs @@ -65,8 +65,8 @@ impl YaSerializeTrait for HAProxyId { fn serialize_attributes( &self, - attributes: Vec, - namespace: xml::namespace::Namespace, + _attributes: Vec, + _namespace: xml::namespace::Namespace, ) -> Result< ( Vec, diff --git a/harmony-rs/opnsense-config-xml/src/data/opnsense.rs b/harmony-rs/opnsense-config-xml/src/data/opnsense.rs index 869c612..d992704 100644 --- a/harmony-rs/opnsense-config-xml/src/data/opnsense.rs +++ b/harmony-rs/opnsense-config-xml/src/data/opnsense.rs @@ -275,7 +275,7 @@ pub struct Group { pub gid: u32, pub member: Vec, #[yaserde(rename = "priv")] - pub priv_: String, + pub priv_field: String, } #[derive(Default, PartialEq, Debug, YaSerialize, YaDeserialize)] @@ -885,38 +885,50 @@ pub struct Proxy { #[derive(Default, PartialEq, Debug, YaSerialize, YaDeserialize)] pub struct ConfigGeneral { pub enabled: i8, - #[yaserde(rename = "error_pages")] pub error_pages: String, - pub icpPort: MaybeString, + #[yaserde(rename = "icpPort")] + pub icp_port: MaybeString, pub logging: Logging, - pub alternateDNSservers: MaybeString, - pub dnsV4First: i8, - pub forwardedForHandling: String, - pub uriWhitespaceHandling: String, - pub enablePinger: i8, - pub useViaHeader: i8, - pub suppressVersion: i32, - pub connecttimeout: MaybeString, + #[yaserde(rename = "alternateDNSservers")] + pub alternate_dns_servers: MaybeString, + #[yaserde(rename = "dnsV4First")] + pub dns_v4_first: i8, + #[yaserde(rename = "forwardedForHandling")] + pub forwarded_for_handling: String, + #[yaserde(rename = "uriWhitespaceHandling")] + pub uri_whitespace_handling: String, + #[yaserde(rename = "enablePinger")] + pub enable_pinger: i8, + #[yaserde(rename = "useViaHeader")] + pub use_via_header: i8, + #[yaserde(rename = "suppressVersion")] + pub suppress_version: i32, + #[yaserde(rename = "connecttimeout")] + pub connect_timeout: MaybeString, #[yaserde(rename = "VisibleEmail")] pub visible_email: String, #[yaserde(rename = "VisibleHostname")] pub visible_hostname: MaybeString, pub cache: Cache, pub traffic: Traffic, - pub parentproxy: ParentProxy, + #[yaserde(rename = "parentproxy")] + pub parent_proxy: ParentProxy, } #[derive(Default, PartialEq, Debug, YaSerialize, YaDeserialize)] pub struct Logging { pub enable: Enable, - pub ignoreLogACL: MaybeString, + #[yaserde(rename = "ifnoreLogACL")] + pub ignore_log_acl: MaybeString, pub target: MaybeString, } #[derive(Default, PartialEq, Debug, YaSerialize, YaDeserialize)] pub struct Enable { - pub accessLog: i8, - pub storeLog: i8, + #[yaserde(rename = "accessLog")] + pub access_log: i8, + #[yaserde(rename = "storeLog")] + pub store_log: i8, } #[derive(Default, PartialEq, Debug, YaSerialize, YaDeserialize)] @@ -1368,11 +1380,11 @@ pub struct ConfigOpenVPN { #[yaserde(attribute = true)] pub version: String, #[yaserde(rename = "Overwrites")] - pub Overwrites: MaybeString, + pub overwrites: MaybeString, #[yaserde(rename = "Instances")] - pub Instances: MaybeString, + pub instances: MaybeString, #[yaserde(rename = "StaticKeys")] - pub StaticKeys: MaybeString, + pub static_keys: MaybeString, } #[derive(Default, PartialEq, Debug, YaSerialize, YaDeserialize)] diff --git a/harmony-rs/opnsense-config/src/config/config.rs b/harmony-rs/opnsense-config/src/config/config.rs index 5d5ca6f..0a73a72 100644 --- a/harmony-rs/opnsense-config/src/config/config.rs +++ b/harmony-rs/opnsense-config/src/config/config.rs @@ -1,4 +1,4 @@ -use std::{sync::Arc, time::Duration}; +use std::sync::Arc; use crate::{ config::{SshConfigManager, SshCredentials, SshOPNSenseShell}, diff --git a/harmony-rs/opnsense-config/src/config/shell/ssh.rs b/harmony-rs/opnsense-config/src/config/shell/ssh.rs index dd9ed12..3c66864 100644 --- a/harmony-rs/opnsense-config/src/config/shell/ssh.rs +++ b/harmony-rs/opnsense-config/src/config/shell/ssh.rs @@ -12,8 +12,8 @@ use russh::{ Channel, }; use russh_keys::key; -use russh_sftp::{client::SftpSession, protocol::OpenFlags}; -use tokio::io::{AsyncReadExt, AsyncWriteExt}; +use russh_sftp::client::SftpSession; +use tokio::io::AsyncWriteExt; use crate::{config::SshCredentials, Error}; diff --git a/harmony-rs/opnsense-config/src/modules/dhcp.rs b/harmony-rs/opnsense-config/src/modules/dhcp.rs index ed1e0bf..9c98291 100644 --- a/harmony-rs/opnsense-config/src/modules/dhcp.rs +++ b/harmony-rs/opnsense-config/src/modules/dhcp.rs @@ -1,8 +1,6 @@ use log::info; use opnsense_config_xml::MaybeString; -use opnsense_config_xml::Range; use opnsense_config_xml::StaticMap; -use std::cmp::Ordering; use std::net::Ipv4Addr; use std::sync::Arc; diff --git a/harmony-rs/opnsense-config/src/modules/dns.rs b/harmony-rs/opnsense-config/src/modules/dns.rs index cdb1952..d8d5123 100644 --- a/harmony-rs/opnsense-config/src/modules/dns.rs +++ b/harmony-rs/opnsense-config/src/modules/dns.rs @@ -1,6 +1,5 @@ use opnsense_config_xml::{Host, OPNsense}; -use crate::config::OPNsenseShell; pub struct DnsConfig<'a> { opnsense: &'a mut OPNsense,