Skip to content

fix: _list() filter matches falsy-but-valid field values #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
atoomic merged 1 commit into from
Sep 11, 2026
Merged

fix: _list() filter matches falsy-but-valid field values #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions lib/OpenStack/MetaAPI/Roles/Listable.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,13 @@ sub _list {

# can use a regexp as a filter
next
unless $candidate->{$filter}
unless defined $candidate->{$filter}
&& $candidate->{$filter} =~ $opts{$filter};
} else {

# otherwise do one 'eq' check
next
unless $candidate->{$filter}
unless defined $candidate->{$filter}
&& $candidate->{$filter} eq $opts{$filter};
}

Expand Down
111 changes: 111 additions & 0 deletions t/listable-filter.t
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
#!/usr/bin/env perl

use strict;
use warnings;

use OpenStack::MetaAPI ();

use Test2::Bundle::Extended;
use Test2::Tools::Explain;
use Test2::Plugin::NoWarnings;

use FindBin;
use lib "$FindBin::Bin/lib";

use Test::OpenStack::MetaAPI qw{:all};
use Test::OpenStack::MetaAPI::Auth qw{:all};

use JSON;

mock_lwp_useragent();

my $api = get_api_object(use_env => 0);

ok $api, "got one api object" or die;

# Servers with falsy-but-valid field values
my $servers_json = encode_json({
servers => [
{
id => 'aaa11111-1111-1111-1111-111111111111',
name => 'server-running',
status => 'ACTIVE',
'OS-EXT-STS:power_state' => 1,
},
{
id => 'bbb22222-2222-2222-2222-222222222222',
name => 'server-stopped',
status => 'SHUTOFF',
'OS-EXT-STS:power_state' => 0,
},
{
id => 'ccc33333-3333-3333-3333-333333333333',
name => 'server-nogroup',
status => 'ACTIVE',
'OS-EXT-STS:power_state' => 1,
'OS-EXT-SRV-ATTR:host' => '',
},
],
});

mock_get_request(
'http://127.0.0.1:8774/v2.1/servers',
application_json($servers_json),
);

{
note "Filter by numeric zero value (power_state => 0)";

my $result = $api->servers('OS-EXT-STS:power_state' => 0);

is $result,
{
id => 'bbb22222-2222-2222-2222-222222222222',
name => 'server-stopped',
status => 'SHUTOFF',
'OS-EXT-STS:power_state' => 0,
},
"filtering by zero value returns the matching server";
}

{
note "Filter by empty string value (OS-EXT-SRV-ATTR:host => '')";

my $result = $api->servers('OS-EXT-SRV-ATTR:host' => '');

is $result,
{
id => 'ccc33333-3333-3333-3333-333333333333',
name => 'server-nogroup',
status => 'ACTIVE',
'OS-EXT-STS:power_state' => 1,
'OS-EXT-SRV-ATTR:host' => '',
},
"filtering by empty string value returns the matching server";
}

{
note "Filter by regex on field with zero value";

my $result = $api->servers('OS-EXT-STS:power_state' => qr/^0$/);

is $result,
{
id => 'bbb22222-2222-2222-2222-222222222222',
name => 'server-stopped',
status => 'SHUTOFF',
'OS-EXT-STS:power_state' => 0,
},
"regex filter matches zero value";
}

{
note "Filter by undef field still excludes (field not present)";

my @results = $api->servers('OS-EXT-SRV-ATTR:hypervisor_hostname' => 'some-host');

is \@results, [undef],
"filtering by field not present on entries returns no match";
}

done_testing;
Loading