Merge pull request #41 from atoomic/test

use File::Temp for unit tests

Author: atoomic

t/statefile_bad_call_unlocked.t

@@ -1,27 +1,25 @@
 #!/usr/bin/perl
 
+use strict;
+use warnings;
+
 use FindBin;
 use lib "$FindBin::Bin/mocks";
 
 use Test::More tests => 5;
 use File::Path ();
-
-use strict;
-use warnings;
+use File::Temp;
 
 use cPanel::StateFile;
 use MockCacheable;
 
-my $tmpdir   = './tmp';
+my $tmpdir   = File::Temp->newdir();
 my $dir      = "$tmpdir/state_test";
 my $file     = "$dir/state_dir/state_file";
 my $lockname = "$file.lock";
 
-cleanup();
-File::Path::mkpath($tmpdir) or die "Unable to create temporary directory: $!";
-
 my $mock_obj = MockCacheable->new;
-my $state = cPanel::StateFile->new( { state_file => $file, data_obj => $mock_obj } );
+my $state    = cPanel::StateFile->new( { state_file => $file, data_obj => $mock_obj } );
 
 {
     my $guard = $state->synch();
@@ -56,10 +54,3 @@ my $state = cPanel::StateFile->new( { state_file => $file, data_obj => $mock_obj
     };
     like( $@, qr/test exception/, 'Exceptions are passed out of call correctly.' );
 }
-
-cleanup();
-
-# Discard temporary files that we don't need any more.
-sub cleanup {
-    File::Path::rmtree($tmpdir) if -d $tmpdir;
-}

t/statefile_load_save.t

@@ -6,23 +6,20 @@
 use FindBin;
 use lib "$FindBin::Bin/mocks";
 use File::Path ();
+use File::Temp ();
 
 use Test::More tests => 24;
 use cPanel::StateFile;
 use MockCacheable;
 
-my $tmpdir   = './tmp';
+my $tmpdir   = File::Temp->newdir();
 my $dir      = "$tmpdir/state_test";
 my $file     = "$dir/state_dir/state_file";
 my $lockname = "$file.lock";
 
 # TODO: Need to testing for timeout logic, but it would slow down the tests.
 #   Decide how I would like to turn it on provisionally: cmdline, env, etc.
 
-# clean up if last run failed.
-cleanup();
-File::Path::mkpath($tmpdir) or die "Unable to create tmpdir: $!";
-
 # test valid creation
 my $mock_obj = MockCacheable->new;
 
@@ -92,19 +89,11 @@ ok( !-e $lockname, "File is unlocked." );
 ok( $state->synch(), 'Synch occured.' );
 ok( !-e $lockname,   "File is not locked." );
 
-is( $mock_obj->{load_called}, 1, "file changed, load." );
-is( $mock_obj->{data}, 'This is the updated state file.', 'Correct data is loaded.' );
+is( $mock_obj->{load_called}, 1,                                 "file changed, load." );
+is( $mock_obj->{data},        'This is the updated state file.', 'Correct data is loaded.' );
 
 # Test that we don't reload after the last synch
 ok( $state->synch(), 'Synch occured.' );
-is( $mock_obj->{load_called}, 1, "don't load again." );
-is( $mock_obj->{data}, 'This is the updated state file.', 'Correct data is loaded.' );
-
-cleanup();
+is( $mock_obj->{load_called}, 1,                                 "don't load again." );
+is( $mock_obj->{data},        'This is the updated state file.', 'Correct data is loaded.' );
 
-# Discard temporary files that we don't need any more.
-sub cleanup {
-    unlink $file                if -e $file;
-    unlink $lockname            if -e $lockname;
-    File::Path::rmtree($tmpdir) if -d $tmpdir;
-}

t/taskqueue_bad_statefile.t

@@ -6,16 +6,13 @@ use strict;
 use warnings;
 use FindBin;
 use File::Path ();
+use File::Temp ();
 use lib "$FindBin::Bin/mocks";
 
 use cPanel::TaskQueue ( -logger => 'cPanel::FakeLogger' );
 
-my $tmpdir   = './tmp';
-my $statedir = "$tmpdir/state_test";
-
-# In case the last test did not succeed.
-cleanup();
-File::Path::mkpath($statedir);
+my ( $tmpdir, $statedir );
+setup();
 
 {
     open( my $fh, '>', "$statedir/tasks_queue.stor" );
@@ -34,8 +31,7 @@ File::Path::mkpath($statedir);
     );
 }
 
-cleanup();
-File::Path::mkpath($statedir);
+setup();
 
 {
     use Storable ();
@@ -51,9 +47,11 @@ File::Path::mkpath($statedir);
     ok( -e "$statedir/tasks_queue.stor.broken", 'Bad file moved out of the way.' );
 }
 
-cleanup();
-
 # Clean up after myself
-sub cleanup {
-    File::Path::rmtree($tmpdir);
+sub setup {
+    $tmpdir   = File::Temp->newdir();
+    $statedir = "$tmpdir/state_test";
+    File::Path::mkpath($statedir);
+
+    return;
 }

t/taskqueue_bad_yaml_statefile.t

@@ -6,16 +6,13 @@ use strict;
 use warnings;
 use FindBin;
 use File::Path ();
+use File::Temp ();
 use lib "$FindBin::Bin/mocks";
 
 use cPanel::TaskQueue ( -logger => 'cPanel::FakeLogger', -serializer => 'cPanel::TQSerializer::YAML' );
 
-my $tmpdir   = './tmp';
-my $statedir = "$tmpdir/state_test";
-
-# In case the last test did not succeed.
-cleanup();
-File::Path::mkpath($statedir);
+my ( $tmpdir, $statedir );
+setup();
 
 {
     open( my $fh, '>', "$statedir/tasks_queue.yaml" );
@@ -34,8 +31,7 @@ File::Path::mkpath($statedir);
     );
 }
 
-cleanup();
-File::Path::mkpath($statedir);
+setup();
 
 {
     use YAML::Syck ();
@@ -51,9 +47,12 @@ File::Path::mkpath($statedir);
     ok( -e "$statedir/tasks_queue.yaml.broken", 'Bad file moved out of the way.' );
 }
 
-cleanup();
+exit;
+
+sub setup {
+    $tmpdir   = File::Temp->newdir();
+    $statedir = "$tmpdir/state_test";
+    File::Path::mkpath($statedir);
 
-# Clean up after myself
-sub cleanup {
-    File::Path::rmtree($tmpdir);
+    return;
 }

t/taskqueue_basics.t

@@ -7,17 +7,14 @@ use strict;
 use FindBin;
 use lib "$FindBin::Bin/mocks";
 use File::Path ();
+use File::Temp ();
 
 use Test::More tests => 42;
 use cPanel::TaskQueue;
 
-my $tmpdir   = './tmp';
+my $tmpdir   = File::Temp->newdir();
 my $statedir = "$tmpdir/state_test";
 
-# In case the last test did not succeed.
-cleanup();
-File::Path::mkpath($tmpdir) or die "Unable to create tmpdir: $!";
-
 # Create the real TaskQueue
 my $queue = cPanel::TaskQueue->new( { name => 'tasks', state_dir => $statedir } );
 isa_ok( $queue, 'cPanel::TaskQueue', 'Correct object built.' );
@@ -58,10 +55,10 @@ ok( !$queue->queue_task("noop a b c"), 'cannot queue a duplicate command' );
 # Look at first task
 my $task = $queue->peek_next_task();
 isa_ok( $task, 'cPanel::TaskQueue::Task', 'We have a task' );
-is( $task->command(), 'noop', 'Correct command in the queue.' );
-is( join( ' ', $task->args() ), 'a b c', 'Correct command arguments.' );
-is( $task->argstring(), 'a  b  c', 'Correct command argument string.' );
-is( $task->uuid(),      $qid2,     'Correct Task id.' );
+is( $task->command(),           'noop',    'Correct command in the queue.' );
+is( join( ' ', $task->args() ), 'a b c',   'Correct command arguments.' );
+is( $task->argstring(),         'a  b  c', 'Correct command argument string.' );
+is( $task->uuid(),              $qid2,     'Correct Task id.' );
 
 # Test a second TaskQueue on same file.
 my $q2 = cPanel::TaskQueue->new( { name => 'tasks', state_dir => $statedir } );
@@ -104,10 +101,3 @@ like( $@, qr/No Task uuid/, 'Can not check processing task without a uuid' );
 
 eval { $queue->is_task_processing(1111111); };
 like( $@, qr/No Task uuid/, 'Can not check processing task with an invalid uuid' );
-
-cleanup();
-
-# Clean up after myself
-sub cleanup {
-    File::Path::rmtree($tmpdir);
-}

t/taskqueue_dupes_and_overrides.t

@@ -7,12 +7,13 @@ use strict;
 use FindBin;
 use lib "$FindBin::Bin/mocks";
 use File::Path ();
+use File::Temp ();
 
 use Test::More tests => 39;
 use cPanel::TaskQueue;
 use cPanel::TaskQueue::Processor;
 
-my $tmpdir      = './tmp';
+my $tmpdir      = File::Temp->newdir();
 my $statedir    = "$tmpdir/statedir";
 my $missing_dir = "$tmpdir/task_queue_test";
 
@@ -43,10 +44,6 @@ my $missing_dir = "$tmpdir/task_queue_test";
 
 cPanel::TaskQueue->register_task_processor( 'mock', MockProcessor->new() );
 
-# In case the last test did not succeed.
-cleanup();
-File::Path::mkpath($tmpdir) or die "Unable to create tmpdir: $!";
-
 # Create the real TaskQueue
 my $queue = cPanel::TaskQueue->new( { name => 'tasks', state_dir => $statedir } );
 isa_ok( $queue, 'cPanel::TaskQueue', 'Correct object built.' );
@@ -109,9 +106,7 @@ ok( $queue->queue_task('mock all off'), 'queue override request' );
 is( $queue->how_many_queued(),            1,     'only one task exists' );
 is( $queue->peek_next_task()->get_arg(0), 'all', 'it is the override' );
 
-# perform cleanup.
-
-cleanup();
+exit;
 
 sub remove_and_check_tasks {
     my $q     = shift;
@@ -125,8 +120,3 @@ sub remove_and_check_tasks {
         ++$i;
     }
 }
-
-# Clean up after myself
-sub cleanup {
-    File::Path::rmtree($tmpdir) if -d $tmpdir;
-}

t/taskqueue_find_commands.t

@@ -4,18 +4,15 @@ use strict;
 use FindBin;
 use lib "$FindBin::Bin/mocks";
 use File::Path ();
+use File::Temp ();
 
 use Test::More tests => 10;
 use cPanel::TaskQueue;
 use cPanel::TaskQueue::PluginManager;
 
-my $tmpdir   = './tmp';
+my $tmpdir   = File::Temp->newdir();
 my $statedir = "$tmpdir/state_test";
 
-# In case the last test did not succeed.
-cleanup();
-File::Path::mkpath($tmpdir) or die "Unable to create tmpdir: $!";
-
 cPanel::TaskQueue::PluginManager::load_all_plugins(
     directories => ["$FindBin::Bin/mocks"],
     namespaces  => ['cPanel::ExampleTasks'],
@@ -58,9 +55,3 @@ is( $queue->how_many_queued(), scalar(@qids), 'Commands queued for further testi
     my @tasks = $queue->find_commands('hello');
     is_deeply( [ map { $_->uuid } @tasks ], [ $qids[5] ], 'Found only the substring command.' );
 }
-
-cleanup();
-
-sub cleanup {
-    File::Path::rmtree($tmpdir);
-}

t/taskqueue_find_task.t

@@ -7,17 +7,14 @@ use strict;
 use FindBin;
 use lib "$FindBin::Bin/mocks";
 use File::Path ();
+use File::Temp ();
 
 use Test::More tests => 20;
 use cPanel::TaskQueue;
 
-my $tmpdir   = './tmp';
+my $tmpdir   = File::Temp->newdir();
 my $statedir = "$tmpdir/statedir";
 
-# In case the last test did not succeed.
-cleanup();
-File::Path::mkpath($tmpdir) or die "Unable to create tmpdir: $!";
-
 {
 
     package SleepTask;
@@ -84,10 +81,3 @@ ok( !$queue->find_command('xyzzy'), 'Did not find non-existant command.' );
     ok( !$queue->find_task($tid), 'Can not find task that is not isn queue.' );
 }
 
-cleanup();
-
-# Clean up after myself
-sub cleanup {
-    File::Path::rmtree($tmpdir) if -d $tmpdir;
-}
-

t/taskqueue_logging_policy.t

@@ -6,6 +6,7 @@
 use FindBin;
 use lib "$FindBin::Bin/mocks";
 use File::Path ();
+use File::Temp ();
 
 use Test::More tests => 10;
 my $logger;
@@ -22,15 +23,11 @@ like( $@, qr/Policies already/, 'Cannot reset policies to defaults.' );
 eval "use cPanel::TaskQueue ();";
 ok( !$@, 'Can reload with import turned off.' );
 
-my $tmpdir = './tmp';
-
-# clean up if last run failed.
-cleanup();
-File::Path::mkpath($tmpdir) or die "Unable to create tmpdir: $!";
+my $tmpdir = File::Temp->newdir();
 
 # test bad new calls.
 eval { my $cf = cPanel::TaskQueue->new( {} ); };
-like( $@, qr/state directory/, 'Cannot create StateFile without parameters' );
+like( $@,                         qr/state directory/,         'Cannot create StateFile without parameters' );
 like( ( $logger->get_msgs() )[0], qr/throw.*?state directory/, 'Logged correctly.' );
 $logger->reset_msgs();
 
@@ -53,9 +50,3 @@ ok( !$queue->queue_task($task), 'Finished trying to queue a task with no retries
 like( ( $logger->get_msgs() )[0], qr/info.*?0 retries/, 'Infoed correctly.' );
 $logger->reset_msgs();
 
-cleanup();
-
-# Discard temporary files that we don't need any more.
-sub cleanup {
-    File::Path::rmtree($tmpdir) if -d $tmpdir;
-}