From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <pve-devel-bounces@lists.proxmox.com>
Received: from firstgate.proxmox.com (firstgate.proxmox.com [IPv6:2a01:7e0:0:424::9])
	by lore.proxmox.com (Postfix) with ESMTPS id 845011FF16B
	for <inbox@lore.proxmox.com>; Thu, 20 Feb 2025 14:27:53 +0100 (CET)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
	by firstgate.proxmox.com (Proxmox) with ESMTP id 3BA09125A3;
	Thu, 20 Feb 2025 14:27:47 +0100 (CET)
Message-ID: <39a966ad-8430-4ca3-953a-921071e3c833@proxmox.com>
Date: Thu, 20 Feb 2025 14:27:43 +0100
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
To: Proxmox VE development discussion <pve-devel@lists.proxmox.com>
References: <20250108121529.5813-1-lou.lecrivain@wdz.de>
 <mailman.145.1736338582.441.pve-devel@lists.proxmox.com>
Content-Language: en-US
From: =?UTF-8?Q?Hannes_D=C3=BCrr?= <h.duerr@proxmox.com>
In-Reply-To: <mailman.145.1736338582.441.pve-devel@lists.proxmox.com>
X-SPAM-LEVEL: Spam detection results:  0
 AWL 0.021 Adjusted score from AWL reputation of From: address
 BAYES_00                 -1.9 Bayes spam probability is 0 to 1%
 DMARC_MISSING             0.1 Missing DMARC policy
 KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment
 RCVD_IN_VALIDITY_CERTIFIED_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to
 Validity was blocked. See
 https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more
 information.
 RCVD_IN_VALIDITY_RPBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to
 Validity was blocked. See
 https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more
 information.
 RCVD_IN_VALIDITY_SAFE_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to
 Validity was blocked. See
 https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more
 information.
 SPF_HELO_NONE           0.001 SPF: HELO does not publish an SPF Record
 SPF_PASS               -0.001 SPF: sender matches SPF record
Subject: Re: [pve-devel] SPAM: [PATCH pve-network v2 4/7] ipam: nautobot:
 base plugin + enhance errors
X-BeenThere: pve-devel@lists.proxmox.com
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Proxmox VE development discussion <pve-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pve-devel>, 
 <mailto:pve-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pve-devel/>
List-Post: <mailto:pve-devel@lists.proxmox.com>
List-Help: <mailto:pve-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel>, 
 <mailto:pve-devel-request@lists.proxmox.com?subject=subscribe>
Reply-To: Proxmox VE development discussion <pve-devel@lists.proxmox.com>
Content-Transfer-Encoding: 7bit
Content-Type: text/plain; charset="us-ascii"; Format="flowed"
Errors-To: pve-devel-bounces@lists.proxmox.com
Sender: "pve-devel" <pve-devel-bounces@lists.proxmox.com>


On 1/8/25 13:15, Lou Lecrivain wrote:
> added error handling in helpers
>
> Signed-off-by: lou lecrivain <lou.lecrivain@wdz.de>
> ---
>   src/PVE/Network/SDN/Ipams/NautobotPlugin.pm | 126 ++++++++++++++++++--
>   1 file changed, 113 insertions(+), 13 deletions(-)
>
> diff --git a/src/PVE/Network/SDN/Ipams/NautobotPlugin.pm b/src/PVE/Network/SDN/Ipams/NautobotPlugin.pm
> index 22867df..79ac04d 100644
> --- a/src/PVE/Network/SDN/Ipams/NautobotPlugin.pm
> +++ b/src/PVE/Network/SDN/Ipams/NautobotPlugin.pm
> @@ -7,7 +7,7 @@ use PVE::Cluster;
>   use PVE::Tools;
>   use NetAddr::IP;
>   
> -use base('PVE::Network::SDN::Ipams::NetboxPlugin');
> +use base('PVE::Network::SDN::Ipams::Plugin');
>   
>   sub type {
>       return 'nautobot';
> @@ -51,7 +51,7 @@ sub add_subnet {
>       my $namespace = $plugin_config->{namespace};
>       my $headers = default_headers($plugin_config);
>   
> -    my $internalid = PVE::Network::SDN::Ipams::NetboxPlugin::get_prefix_id($url, $cidr, $headers);
> +    my $internalid = get_prefix_id($url, $cidr, $headers, $noerr);
>   
>       #create subnet
>       if (!$internalid) {
> @@ -66,6 +66,27 @@ sub add_subnet {
>       }
>   }
>   
> +sub del_subnet {
> +    my ($class, $plugin_config, $subnetid, $subnet, $noerr) = @_;
> +
> +    my $cidr = $subnet->{cidr};
> +    my $url = $plugin_config->{url};
> +    my $headers = default_headers($plugin_config);
> +
> +    my $internalid = get_prefix_id($url, $cidr, $headers, $noerr);
> +    return if !$internalid;
> +
> +    # TODO check that prefix is empty before deletion
> +    return;
> +
> +    eval {
> +	PVE::Network::SDN::api_request("DELETE", "$url/ipam/prefixes/$internalid/", $headers);
> +    };
> +    if ($@) {
> +	die "error deleting subnet in Nautobot: $@" if !$noerr;
> +    }
> +}
> +
>   sub add_ip {
>       my ($class, $plugin_config, $subnetid, $subnet, $ip, $hostname, $mac, $vmid, $is_gateway, $noerr) = @_;
>   
> @@ -89,7 +110,7 @@ sub add_ip {
>   
>       if ($@) {
>   	if($is_gateway) {
> -	    die "error adding subnet ip to ipam: ip $ip already exists: $@" if !PVE::Network::SDN::Ipams::NetboxPlugin::is_ip_gateway($url, $ip, $headers) && !$noerr;
> +	    die "error adding subnet ip to ipam: ip $ip already exists: $@" if !$noerr && !is_ip_gateway($url, $ip, $headers, $noerr);
>   	} else {
>   	    die "error adding subnet ip to ipam: ip $ip already exists: $@" if !$noerr;
>   	}
> @@ -105,7 +126,8 @@ sub add_next_freeip {
>       my $namespace = $plugin_config->{namespace};
>       my $headers = default_headers($plugin_config);
>   
> -    my $internalid = PVE::Network::SDN::Ipams::NetboxPlugin::get_prefix_id($url, $cidr, $headers);
> +    my $internalid = get_prefix_id($url, $cidr, $headers, $noerr);
> +    die "cannot find prefix $cidr in Nautobot" if !$internalid;
>   
>       my $description = "mac:$mac" if $mac;
>   
> @@ -133,7 +155,7 @@ sub add_range_next_freeip {
>   
>       # ranges are not supported natively in nautobot, hence why we have to get a little hacky.
>       my $minimal_size = NetAddr::IP->new($range->{'start-address'}) - NetAddr::IP->new($cidr);
> -    my $internalid = PVE::Network::SDN::Ipams::NetboxPlugin::get_prefix_id($url, $cidr, $headers);
> +    my $internalid = get_prefix_id($url, $cidr, $headers, $noerr);
>   
>       my $ip = eval {
>   	my $result = PVE::Network::SDN::api_request("GET", "$url/ipam/prefixes/$internalid/available-ips/?limit=$minimal_size", $headers);
> @@ -174,8 +196,8 @@ sub update_ip {
>   
>       my $params = { address => "$ip/$mask", type => "dhcp", dns_name => $hostname, description => $description, namespace => $namespace, status => default_ip_status()};
please break this line, we accept max 100 chars per line
>   
> -    my $ip_id = PVE::Network::SDN::Ipams::NetboxPlugin::get_ip_id($url, $ip, $headers);
> -    die "can't find ip $ip in ipam" if !$ip_id;
> +    my $ip_id = get_ip_id($url, $ip, $headers, $noerr);
> +    die "can't find ip $ip in ipam" if !$noerr && !$ip_id;
>   
>       eval {
>   	PVE::Network::SDN::api_request("PATCH", "$url/ipam/ip-addresses/$ip_id/", $headers, $params);
> @@ -186,6 +208,26 @@ sub update_ip {
>   }
>   
>   
> +sub del_ip {
> +    my ($class, $plugin_config, $subnetid, $subnet, $ip, $noerr) = @_;
$subnetid and $subnet are both unused
> +
> +    return if !$ip;
> +
> +    my $url = $plugin_config->{url};
> +    my $headers = default_headers($plugin_config);
> +
> +    my $ip_id = get_ip_id($url, $ip, $headers, $noerr);
> +    die "can't find ip $ip in ipam" if !$ip_id && !$noerr;
> +
> +    eval {
> +	PVE::Network::SDN::api_request("DELETE", "$url/ipam/ip-addresses/$ip_id/", $headers);
> +    };
> +    if ($@) {
> +	die "error deleting ip $ip : $@" if !$noerr;
> +    }
> +}
> +
> +
>   sub verify_api {
>       my ($class, $plugin_config) = @_;
>   
> @@ -196,8 +238,8 @@ sub verify_api {
>       # check that the namespace exists AND that default IP active status
>       # exists AND that we have indeed API access
>       eval {
> -	get_namespace_id($url, $namespace, $headers) // die "namespace $namespace does not exist";
> -	get_status_id($url, default_ip_status(), $headers) // die "default IP status ". default_ip_status() . " not found";
> +	get_namespace_id($url, $namespace, $headers, 0) // die "namespace $namespace does not exist";
> +	get_status_id($url, default_ip_status(), $headers, 0) // die "default IP status ". default_ip_status() . " not found";
>       };
>       if ($@) {
>   	die "Can't use nautobot api: $@";
> @@ -242,22 +284,80 @@ sub get_ips_within_range {
>       return grep($start_address <= NetAddr::IP->new($_) <= $end_address, @list);
>   }
>   
> +sub get_ip_id {
> +    my ($url, $ip, $headers, $noerr) = @_;
> +
> +    my $result = eval {
> +	return PVE::Network::SDN::api_request("GET", "$url/ipam/ip-addresses/?q=$ip", $headers);
> +    };
> +    if ($@) {
> +	die "error while querying for ip $ip id: $@" if !$noerr;
> +    }
> +
> +    my $data = @{$result->{results}}[0];
> +    my $ip_id = $data->{id};
> +    return $ip_id;
> +}
> +
> +sub get_prefix_id {
> +    my ($url, $cidr, $headers, $noerr) = @_;
> +
> +    my $result = eval {
> +	return PVE::Network::SDN::api_request("GET", "$url/ipam/prefixes/?q=$cidr", $headers);
> +    };
> +    if ($@) {
> +	die "error while querying for cidr $cidr prefix id: $@" if !$noerr;
> +    }
> +
> +    my $data = @{$result->{results}}[0];
> +    my $internalid = $data->{id};
> +    return $internalid;
> +}
> +
>   sub get_namespace_id {
> -    my ($url, $namespace, $headers) = @_;
> +    my ($url, $namespace, $headers, $noerr) = @_;
> +
> +    my $result = eval {
> +	return PVE::Network::SDN::api_request("GET", "$url/ipam/namespaces/?q=$namespace", $headers);
> +    };
> +    if ($@) {
> +	die "error while querying for namespace $namespace id: $@" if !$noerr;
> +    }
>   
> -    my $result = PVE::Network::SDN::api_request("GET", "$url/ipam/namespaces/?q=$namespace", $headers);
>       my $data = @{$result->{results}}[0];
>       my $internalid = $data->{id};
>       return $internalid;
>   }
>   
>   sub get_status_id {
> -    my ($url, $status, $headers) = @_;
> +    my ($url, $status, $headers, $noerr) = @_;
> +
> +    my $result = eval {
> +	return PVE::Network::SDN::api_request("GET", "$url/extras/statuses/?q=$status", $headers);
> +    };
> +    if ($@) {
> +	die "error while querying for status $status id: $@" if !$noerr;
> +    }
>   
> -    my $result = PVE::Network::SDN::api_request("GET", "$url/extras/statuses/?q=$status", $headers);
>       my $data = @{$result->{results}}[0];
>       my $internalid = $data->{id};
>       return $internalid;
>   }
>   
> +sub is_ip_gateway {
> +    my ($url, $ip, $headers, $noerr) = @_;
> +
> +    my $result = eval {
> +	return PVE::Network::SDN::api_request("GET", "$url/ipam/ip-addresses/?q=$ip", $headers);
> +    };
> +    if ($@) {
> +	die "error while checking if $ip is a gateway" if !$noerr;
> +    }
> +
> +    my $data = @{$result->{results}}[0];
> +    my $description = $data->{description};
> +    my $is_gateway = 1 if $description eq 'gateway';
> +    return $is_gateway;
> +}
> +
>   1;


_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel