Skip to content

Commit

Permalink
Expand generic 'cache' entry in the profile, and its unit tests
Browse files Browse the repository at this point in the history
  • Loading branch information
@tgreenx
tgreenx committed Nov 8, 2023
1 parent 1ac4951 commit efb6118
Show file tree
Hide file tree
Showing 4 changed files with 79 additions and 15 deletions.
8 changes: 6 additions & 2 deletions lib/Zonemaster/Engine/Nameserver/Cache.pm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,12 @@ sub get_cache_type {
my ( $class, $profile ) = @_;
my $cache_type = 'LocalCache';

if ( $profile->get( 'cache.redis' ) ) {
$cache_type = 'RedisCache';
if ( $profile->get( 'cache' ) ) {
my %cache_config = %{ $profile->get( 'cache' ) };

if ( exists $cache_config{'redis'} ) {
$cache_type = 'RedisCache';
}
}

return $cache_type;
Expand Down
2 changes: 1 addition & 1 deletion lib/Zonemaster/Engine/Nameserver/Cache/RedisCache.pm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ sub new {
return $object_cache->{ $params->{address} };
} else {
if (! defined $redis) {
my $redis_config = Zonemaster::Engine::Profile->effective->get( q{cache.redis} );
my $redis_config = Zonemaster::Engine::Profile->effective->get( q{cache} )->{'redis'};
$redis = Redis->new(server => $redis_config->{server});
$config = $redis_config;
}
Expand Down
39 changes: 32 additions & 7 deletions lib/Zonemaster/Engine/Profile.pm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,26 @@ $YAML::XS::Boolean = "JSON::PP";
use Zonemaster::Engine::Constants qw( $RESOLVER_SOURCE_OS_DEFAULT $DURATION_5_MINUTES_IN_SECONDS $DURATION_1_HOUR_IN_SECONDS $DURATION_4_HOURS_IN_SECONDS $DURATION_12_HOURS_IN_SECONDS $DURATION_1_DAY_IN_SECONDS $DURATION_1_WEEK_IN_SECONDS $DURATION_180_DAYS_IN_SECONDS );

my %profile_properties_details = (
q{cache.redis} => {
q{cache} => {
type => q{HashRef},
test => sub {
my @allowed_keys = ( 'redis' );
foreach my $cache_database ( keys %{$_[0]} ) {
if ( not grep( /^$cache_database$/, @allowed_keys ) ) {
die "Property cache keys have " . scalar @allowed_keys . " possible values : " . join(", ", @allowed_keys);
}

if ( not scalar keys %{ $_[0]->{$cache_database} } ) {
die "Property cache.$cache_database has no items";
}
else {
foreach my $key ( keys %{ $_[0]->{$cache_database} } ) {
die "Property cache.$cache_database.$key has a NULL or empty item" if not $_[0]->{$cache_database}->{$key};
die "Property cache.$cache_database.$key has a negative value" if ( $key eq 'expire' and scalar $_[0]->{$cache_database}->{$key} < 0 ) ;
}
}
}
}
},
q{resolver.defaults.debug} => {
type => q{Bool}
Expand Down Expand Up @@ -766,16 +784,23 @@ in the list will be used, the rest are backups in case the earlier ones don't
work.
Default C<"asnlookup.zonemaster.net">.
=head2 cache (EXPERIMENTAL)
A hash of hashes. The currently supported keys are C<"redis">.
See more information in L<cache.redis>.
Undefined by default.
=head2 cache.redis (EXPERIMENTAL)
A hashref. Undefined by default.
A hashref. The currently supported keys are C<"server"> and C<"expire">.
Specifies the address of the Redis server used to perform
global caching (C<cache.redis.server>) and an optional expire time which
defaults to 5 seconds (C<cache.redis.expire>).
Specifies the address of the Redis server used to perform global caching
(C<cache.redis.server>) and an optional expire time (C<cache.redis.expire>).
C<cache.redis.server> is a string in the form C<host:port>.
C<cache.redis.exire> is an integer and defines a time in second.
C<cache.redis.server> must be a string in the form C<host:port>.
C<cache.redis.expire> must be a non-negative integer and defines a time in seconds. Default 5 seconds.
=head2 logfilter
Expand Down
45 changes: 40 additions & 5 deletions t/profiles.t
View file
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,12 @@ Readonly my $EXAMPLE_PROFILE_2 => q(
"ipv6": true
},
"no_network": false,
"cache": {
"redis": {
"server": "127.0.0.2:6379",
"expire": 7200
}
},
"asnroots": [
"asn1.example.com", "asn2.example.com"
],
Expand Down Expand Up @@ -191,7 +197,7 @@ subtest 'new() returns a profile with all properties unset' => sub {
is $profile->get( 'logfilter' ), undef, 'logfilter is unset';
is $profile->get( 'test_levels' ), undef, 'test_levels is unset';
is $profile->get( 'test_cases' ), undef, 'test_cases is unset';
is $profile->get( 'cache.redis' ), undef, 'cache.redis is unset';
is $profile->get( 'cache' ), undef, 'cache is unset';
};

subtest 'default() returns a new profile every time' => sub {
Expand Down Expand Up @@ -251,7 +257,7 @@ subtest 'from_json("{}") returns a profile with all properties unset' => sub {
is $profile->get( 'logfilter' ), undef, 'logfilter is unset';
is $profile->get( 'test_levels' ), undef, 'test_levels is unset';
is $profile->get( 'test_cases' ), undef, 'test_cases is unset';
is $profile->get( 'cache.redis' ), undef, 'cache_redis is unset';
is $profile->get( 'cache' ), undef, 'cache is unset';
};

subtest 'from_json() parses values from a string' => sub {
Expand All @@ -275,7 +281,7 @@ subtest 'from_json() parses values from a string' => sub {
'logfilter was parsed from JSON';
eq_or_diff $profile->get( 'test_levels' ), { Zone => { TAG => 'INFO' } }, 'test_levels was parsed from JSON';
eq_or_diff $profile->get( 'test_cases' ), ['Zone01'], 'test_cases was parsed from JSON';
eq_or_diff $profile->get( 'cache.redis' ), { server => '127.0.0.1:6379', expire => 3600 }, 'cache.redis was parsed from JSON';
eq_or_diff $profile->get( 'cache' ), { redis => { server => '127.0.0.1:6379', expire => 3600 } }, 'cache was parsed from JSON';
};

subtest 'from_json() parses sentinel values from a string' => sub {
Expand Down Expand Up @@ -318,6 +324,7 @@ subtest 'from_json() dies on illegal values' => sub {
dies_ok { Zonemaster::Engine::Profile->from_json( '{"logfilter":[]}' ); } "checks type of logfilter";
dies_ok { Zonemaster::Engine::Profile->from_json( '{"test_levels":[]}' ); } "checks type of test_levels";
dies_ok { Zonemaster::Engine::Profile->from_json( '{"test_cases":{}}' ); } "checks type of test_cases";
dies_ok { Zonemaster::Engine::Profile->from_json( '{"cache":[]}' ); } "checks type of cache";
};

subtest 'from_json() emits warning on illegal values' => sub {
Expand Down Expand Up @@ -406,16 +413,19 @@ subtest 'get() returns deep copies of properties with complex types' => sub {
$profile->set( 'logfilter', {} );
$profile->set( 'test_levels', {} );
$profile->set( 'test_cases', [] );
$profile->set( 'cache', {} );

push @{ $profile->get( 'asnroots' ) }, 'asn2.example.com';
push @{ $profile->get( 'test_cases' ) }, 'Zone01';
$profile->get( 'logfilter' )->{Zone} = {};
$profile->get( 'test_levels' )->{Zone}{TAG} = 'INFO';
$profile->get( 'cache' )->{redis}{server} = '127.0.0.1:6379';

eq_or_diff $profile->get( 'asnroots' ), ['asn1.example.com'], 'get(asnroots) returns a deep copy';
eq_or_diff $profile->get( 'logfilter' ), {}, 'get(logfilter) returns a deep copy';
eq_or_diff $profile->get( 'test_levels' ), {}, 'get(test_levels) returns a deep copy';
eq_or_diff $profile->get( 'test_cases' ), [], 'get(test_cases) returns a deep copy';
eq_or_diff $profile->get( 'cache' ), {}, 'get(cache) returns a deep copy';
};

subtest 'get() dies if the given property name is invalid' => sub {
Expand All @@ -424,6 +434,7 @@ subtest 'get() dies if the given property name is invalid' => sub {
$profile->set( 'logfilter', { Zone => {} } );
$profile->set( 'test_levels', { Zone => { TAG => 'INFO' } } );
$profile->set( 'test_cases', ['Zone01'] );
$profile->set( 'cache', { redis => { server => '127.0.0.1:6379' } } );

throws_ok { $profile->get( 'net' ) } qr/^.*Unknown property .*/, 'net';
throws_ok { $profile->get( 'net.foobar' ) } qr/^.*Unknown property .*/, 'net.foobar';
Expand All @@ -433,6 +444,7 @@ subtest 'get() dies if the given property name is invalid' => sub {
throws_ok { $profile->get( 'logfilter.Zone' ) } qr/^.*Unknown property .*/, 'logfilter.Zone';
throws_ok { $profile->get( 'test_levels.Zone' ) } qr/^.*Unknown property .*/, 'test_levels.Zone';
throws_ok { $profile->get( 'test_cases.Zone01' ) } qr/^.*Unknown property .*/, 'test_cases.Zone01';
throws_ok { $profile->get( 'cache.redis' ) } qr/^.*Unknown property .*/, 'cache.redis';
};

subtest 'set() inserts values for unset properties' => sub {
Expand All @@ -455,6 +467,7 @@ subtest 'set() inserts values for unset properties' => sub {
$profile->set( 'logfilter', { Zone => { TAG => [ { when => { bananas => 0 }, set => 'WARNING' } ] } } );
$profile->set( 'test_levels', { Zone => { TAG => 'INFO' } } );
$profile->set( 'test_cases', ['Zone01'] );
$profile->set( 'cache', { redis => { server => '127.0.0.1:6379', expire => 3600 } } );

is $profile->get( 'resolver.defaults.usevc' ), 1, 'resolver.defaults.usevc can be given a value when unset';
is $profile->get( 'resolver.defaults.dnssec' ), 0, 'resolver.defaults.dnssec can be given a value when unset';
Expand All @@ -475,6 +488,8 @@ subtest 'set() inserts values for unset properties' => sub {
eq_or_diff $profile->get( 'test_levels' ), { Zone => { TAG => 'INFO' } },
'test_levels can be given a value when unset';
eq_or_diff $profile->get( 'test_cases' ), ['Zone01'], 'test_cases can be given a value when unset';
eq_or_diff $profile->get( 'cache' ), { redis => { server => '127.0.0.1:6379', expire => 3600 } },
'cache can be given a value when unset';
};

subtest 'set() updates values for set properties' => sub {
Expand All @@ -497,6 +512,7 @@ subtest 'set() updates values for set properties' => sub {
$profile->set( 'logfilter', { Nameserver => { OTHER_TAG => [ { when => { apples => 1 }, set => 'INFO' } ] } } );
$profile->set( 'test_levels', { Nameserver => { OTHER_TAG => 'ERROR' } } );
$profile->set( 'test_cases', ['Zone02'] );
$profile->set( 'cache', { redis => { server => '127.0.0.2:6379', expire => 7200 } } );

is $profile->get( 'resolver.defaults.usevc' ), 0, 'resolver.defaults.usevc was updated';
is $profile->get( 'resolver.defaults.dnssec' ), 1, 'resolver.defaults.dnssec was updated';
Expand All @@ -515,6 +531,8 @@ subtest 'set() updates values for set properties' => sub {
{ Nameserver => { OTHER_TAG => [ { when => { apples => 1 }, set => 'INFO' } ] } }, 'logfilter was updated';
eq_or_diff $profile->get( 'test_levels' ), { Nameserver => { OTHER_TAG => 'ERROR' } }, 'test_levels was updated';
eq_or_diff $profile->get( 'test_cases' ), ['Zone02'], 'test_cases was updated';
eq_or_diff $profile->get( 'cache' ), { redis => { server => '127.0.0.2:6379', expire => 7200 } },
'cache was updated';
};

subtest 'set() dies on attempts to unset properties' => sub {
Expand All @@ -537,6 +555,7 @@ subtest 'set() dies on attempts to unset properties' => sub {
throws_ok { $profile->set( 'logfilter', undef ); } qr/^.* can not be undef/, 'dies on attempt to unset logfilter';
throws_ok { $profile->set( 'test_levels', undef ); } qr/^.* can not be undef/, 'dies on attempt to unset test_levels';
throws_ok { $profile->set( 'test_cases', undef ); } qr/^.* can not be undef/, 'dies on attempt to unset test_cases';
throws_ok { $profile->set( 'cache', undef ); } qr/^.* can not be undef/, 'dies on attempt to unset cache';
};

subtest 'set() dies if the given property name is invalid' => sub {
Expand All @@ -545,6 +564,7 @@ subtest 'set() dies if the given property name is invalid' => sub {
$profile->set( 'logfilter', { Zone => {} } );
$profile->set( 'test_levels', { Zone => {} } );
$profile->set( 'test_cases', ['Zone01'] );
$profile->set( 'cache', { redis => { server => '127.0.0.1:6379' } } );

throws_ok { $profile->set( 'net', 1 ) } qr/^.*Unknown property .*/, 'dies on attempt to set a value for net';
throws_ok { $profile->set( 'net.foobar', 1 ) } qr/^.*Unknown property .*/, 'dies on attempt to set a value for net.foobar';
Expand All @@ -554,6 +574,7 @@ subtest 'set() dies if the given property name is invalid' => sub {
throws_ok { $profile->set( 'logfilter.Zone', 1 ) } qr/^.*Unknown property .*/, 'dies on attempt to set a value for logfilter.Zone';
throws_ok { $profile->set( 'test_levels.Zone', 1 ) } qr/^.*Unknown property .*/, 'dies on attempt to set a value for test_levels.Zone';
throws_ok { $profile->set( 'test_cases.Zone01', 1 ) } qr/^.*Unknown property .*/, 'dies on attempt to set a value for test_cases.Zone01';
throws_ok { $profile->set( 'cache.redis', 1 ) } qr/^.*Unknown property .*/, 'dies on attempt to set a value for cache.redis';
};

subtest 'set() dies on illegal value' => sub {
Expand All @@ -571,7 +592,8 @@ subtest 'set() dies on illegal value' => sub {
dies_ok { $profile->set( 'asnroots', ['[email protected]'] ); } 'checks type of asnroots';
dies_ok { $profile->set( 'logfilter', [] ); } 'checks type of logfilter';
dies_ok { $profile->set( 'test_levels', [] ); } 'checks type of test_levels';
dies_ok { $profile->set( 'test_cases', {} ); } 'checks type of test_cases';
dies_ok { $profile->set( 'test_cases', {} ); } 'checks type of test_cases';
dies_ok { $profile->set( 'cache', [] ); } 'checks type of cache';
};

subtest 'set() accepts sentinel values' => sub {
Expand Down Expand Up @@ -644,8 +666,9 @@ subtest 'merge() with a profile with all properties unset' => sub {
eq_or_diff $profile1->get( 'asnroots' ), ['example.com'], 'keeps value of asnroots';
eq_or_diff $profile1->get( 'logfilter' ), { Zone => { TAG => [ { when => { bananas => 0 }, set => 'WARNING' } ] } },
'keeps value of logfilter';
eq_or_diff $profile1->get( 'test_levels' ), { Zone => { TAG => 'INFO' } }, 'test_levels';
eq_or_diff $profile1->get( 'test_levels' ), { Zone => { TAG => 'INFO' } }, 'keeps value of test_levels';
eq_or_diff $profile1->get( 'test_cases' ), ['Zone01'], 'keeps value of test_cases';
eq_or_diff $profile1->get( 'cache' ), { redis => { server => '127.0.0.1:6379', expire => 3600 } }, 'keeps value of cache';
};

subtest 'merge() with a profile with all properties set' => sub {
Expand All @@ -672,6 +695,7 @@ subtest 'merge() with a profile with all properties set' => sub {
{ Nameserver => { OTHER_TAG => [ { when => { apples => 1 }, set => 'INFO' } ] } }, 'updates logfilter';
eq_or_diff $profile1->get( 'test_levels' ), { Nameserver => { OTHER_TAG => 'ERROR' } }, 'updates test_levels';
eq_or_diff $profile1->get( 'test_cases' ), ['Zone02'], 'updates test_cases';
eq_or_diff $profile1->get( 'cache' ), { redis => { server => '127.0.0.2:6379', expire => 7200 } }, 'updates cache';
};

subtest 'merge() does not update the other profile' => sub {
Expand All @@ -697,6 +721,7 @@ subtest 'merge() does not update the other profile' => sub {
is $profile2->get( 'logfilter' ), undef, 'logfilter was untouched in other';
is $profile2->get( 'test_levels' ), undef, 'test_levels was untouched in other';
is $profile2->get( 'test_cases' ), undef, 'test_cases was untouched in other';
is $profile2->get( 'cache' ), undef, 'cache was untouched in other';
};

subtest 'to_json() serializes each property' => sub {
Expand Down Expand Up @@ -881,6 +906,16 @@ subtest 'to_json() serializes each property' => sub {
eq_or_diff decode_json( $json ),
decode_json( '{"logfilter":{"Zone":{"TAG":[{"when":{"bananas":0},"set":"WARNING"}]}}}' );
};

subtest 'cache' => sub {
my $profile = Zonemaster::Engine::Profile->new;
$profile->set( 'cache', { redis => { server => '127.0.0.1:6379', expire => 3600 } } );

my $json = $profile->to_json;

eq_or_diff decode_json( $json ),
decode_json( '{"cache":{"redis":{"server":"127.0.0.1:6379","expire":3600}}}' );
};
};

subtest 'effective() is initially equivalent to default()' => sub {
Expand Down

0 comments on commit efb6118

Please sign in to comment.