src/Utilities/TestClass.pm

#
# Test a documented perl class
#
# Interface
# ---------
# new($module,testdatadir) : module example - Utilities/urlhandler
# dotest(@args) : Start testing - arguments dependent on inheriting class
#
# newtest() : Initiate a testing sequence
# verify(actual_result_file, expected_result_file) : compare two files
# verifydir(dir) : Check existence of the directory
# verifyexists(file) : Verify the existence of file
# datadir([dir]) : return the current data directory (set it to dir if supplied)
# testfail(string) : report that current test has failed
# testpass(string) : report that current test has passed
# newfilename() : return a new filename that can be opened etc.
# temparea() : return a directory for building temporary stuff
# newobject(@args) : Set up a new object to be tested
# testinterface($name,@args) : perform interface tests for $name with @args
# expect(string) : tell the testinterface of any expected return values
# clearexpect()  : Reset any expect variables.
#cleantemp()    : delete the temporary area

package TestClass;
require 5.004;
$bold  = "\033[1m";
$normal = "\033[0m";

# -------------------- Front line Interface methods ---------------------
sub new {
        my $class=shift;
        my $fullmodule=shift;
        chomp $fullmodule;
        my $datadir=shift;

        # The usual Object blessing
        $self={};
        bless $self,$class;

        #some local working variables
        my $testmodule;
        my $module;
        my $dir="";
#       if ( $fullmodule=~/\// ) {
#         ($dir=$fullmodule)=~s/(.*\/)(.*)/$1/;
#       }
        if ( $fullmodule=~/::/ ) {
          ($dir=$fullmodule)=~s/(.*::)(.*)/$1/;
        }
        else { $dir="" } 
        ($testmodule=$fullmodule)=~s/(.*\/)(.*)/$1test::test_$2/;
        ($testmodule=$fullmodule)=~s/${dir}(.*)/${dir}test::test_$1/;
        ($module=$testmodule)=~s/.*\///g;

        $self->{class}=$module;
        $self->{"datadir"}=$datadir;
        $self->{filenumber}=0;
        $self->{temparea}="/tmp/SCRAMtest++";
        use File::Path;
        mkpath ($self->{temparea},0, 0777);

        # Now setup a new testobject of the appropriate type
        eval "require $testmodule";
        die $@ if $@;
        $self->{testobj}=$module->_new($self, $fullmodule);

        return $self;
}

#
# Call the test routine of our inheriting class
#
sub dotest {
        $self=shift;
        $self->{testobj}->test(@_);
        $self->{testobj}->checktests();
}


# A virtual method to be overridden
sub init {
        my $self=shift;
}

#
# initiate a new test sequence
#
sub newtest {
        my $self=shift;
        my $string=shift;
        $self->{testnumber}++;
        $self->_testout("");
        $self->_testout("---------------------------* Test $self->{testnumber}".
                                " *------------------------------");
        $self->_testout("|  $string ");
        $self->_testout("|");
        $self->_testout(
            "---------------------------------------------------------------");
        
}

sub verify {
        my $self=shift;
        my $file1=shift;
        my $file2=shift;
        my $same=1;

        $self->_testout(">Verifying files : $file1 \n".
                        "                   $file2");
        open ( FILE1, "<$file1" ) or die "Cannot Read Test Output $file1 $!\n";
        open ( FILE2, "<$file2" ) or die "Cannot Read Benchmark file ".
                                                        "$file2 $!\n";
        while ( $f1=<FILE2> ) {
         $f2=<FILE1>;
         if ( (!defined $f2 ) || ( ! defined $f1) || ($f2 ne $f1 )) {
           #print "T:\n$f1\nB:$f2\n";
           $same=0;
         }
        }
        close FILE1;
        close FILE2;
        if ( $same==0 ) {
          $self->testfail("File $file1 is not the same as $file2");
        }
}

sub verifydir {
        my $self=shift;
        my $name=shift;

        if ( -d "$name" ) {
           $self->testpass("Directory $name exists - test passed");
        }
        else {
           $self->testfail("Directory $name does not exist");
        }
}

sub verifyexists {
        my $self=shift;
        my $name=shift;

        if ( -e "$name" ) {
           $self->testpass("$name exists - test passed");
        }
        else {
           $self->testfail("$name does not exist");
        }
}

sub testfail {
        my $self=shift;
        my $string=shift;

        $self->_testout("$bold $string $normal");
        push @{$self->{failedtests}}, $self->{testnumber};
}

sub testpass {
        my $self=shift;
        my $string=shift;

        $self->_testout($string);
}

sub newfilename {
        my $self=shift;
        $self->{filenumber}++;
        return "temptest_$self->{filenumber}";
}

sub temparea {
        my $self=shift;
        return $self->{temparea};
}

#
# return the data directory ( and set if given an argument )
#
sub datadir {
        my $self=shift;
        my $dir=shift;
        if ( $dir ne "" ) {
                $self->{datadir}=$dir;
        }
        return $self->{datadir};
}

#
# -------------------- Private Methods ----------------------------
#       (only to be used by the inheriting class)

# 
# A basic new method for inheriting classes
#

sub _new {
        my $class=shift;
        my $testobject=shift;
        my $module=shift;


        # Bless this object and all those who inherit from her
        my $self={};
        bless $self, $class;

        # we want the dat members from the initialisation of our class in
        # here too
        foreach $key ( keys %$testobject ) {
         $self->{$key}=$testobject->{$key};
        }

        print "Initialising $class\n";

        # Data Initialisation
        $self->{testclass}=$class;
        ($self->{classname}=$module)=~s/::/\//g;
        ($self->{class}=$module)=~s/.*\///g;
        $self->{classfile}=$ENV{SCRAM_HOME}."/src/".$self->{classname}."\.pm";
        $self->init(@_);
        $self->analyseInterface();
        delete $self->{expect};
        return $self;
}

#
# Test the interface
#
sub testinterface {
        my $self=shift;
        my $subname=shift;
        my $myreturn;
        my $expected;

        $self->_checkdoc($subname);
        $self->{inttest}{$subname}++;
        $self->_testout(">Trying interface $subname ");
        my $args=join ', ', @_;
        $self->_testout( " (".$args.")" );
        $num=0;
        if ( exists $self->{expect} ) {
         @mylist=eval { $self->{object}->$subname(@_); };
          die "Test Failed $@\n" if $@; 
         if ( defined @mylist ) {
         # size check
         if ( $#mylist < $#{$self->{expect}} ) {
                $self->testfail("not enough returned values");
         }
         foreach $myreturn ( @mylist ) {
          if ( ! defined $myreturn ) {
                print "Undefined Value Passed Back\n";
          }
          elsif ( $myreturn=~/HASH/ ) {
             print "Hash Ref returned\n";
          }
          elsif ( $myreturn=~/CODE/ ) {
             print "Code Ref returned\n";
          }
          elsif ( $myreturn=~/ARRAY/ ) {
            print "Array Ref returned\n";
          }
          else {
            $expected=$self->{expect}[$num++];
            if ( $myreturn eq $expected ) { #simple return case
             $self->testpass("OK - returned as expected ($expected)");
            }
            else  {
              $self->testfail("Expecting $expected, got ".
                                                $myreturn);
            }
          }
        } # end foreach block
        }
          return @mylist;
        }
        else { 
          return ($self->{object}->$subname(@_));
        }
}

#
# expect - tell testinterface what returns to expect and fail/pass
#
sub expect {
        my $self=shift;

        push @{$self->{expect}}, @_;
}

sub clearexpect {
        my $self=shift;
        my $string=shift;

        delete $self->{expect};
}

#
# checktests
#
sub checktests {
        my $self=shift;
        $self->newtest(">Checking all documented Interfaces have been tested ");
        foreach $key ( keys %{$self->{interfaceargs}} ) {
          if ( ! exists $self->{inttest}{$key} ) {
            $self->testfail ("$key has not been tested");
          }
        }
        # Now see whats failed
        foreach $fail ( @{$self->{failedtests}} ) {
         $self->_testout("$bold Failed in $fail $normal");
        }
}

#
# Create a new object
#
sub newobject {
        my $self=shift;

        $self->_checkdoc("new");
        $self->_testout(">Creating new Object $self->{class}");
        $self->{object}=$self->{class}->new(@_);
        $self->_testout(" ( $self->{object} )");
        $self->{inttest}{"new"}++;
}

#
# check if interface has been documented
#
sub _checkdoc {
        my $self=shift;
        my $name=shift;
        
        if ( exists $self->{interfaceargs}{$name} ) {
        }
        else {
           $self->_testout
                ("Tester: Interface Method '$name' is not documented\n");
        }
}

#
# Output messages to screen/logs etc
#
sub _testout($) {
        my $self=shift;
        my $string=shift;

        print $string;  
        print "\n";
}
#
# Method to read the interface documentation
#

sub analyseInterface {
        my $self=shift;
        my $intregion=0;

        open ( SRCIN, $self->{"classfile"} ) 
                        or die "Unable to open $classfile $!\n";
        while ( <SRCIN> ) {
           if ( $_=~/#\s*Interface/g ) {
                $intregion=1;
                next;
           }
           if ( $intregion ) { # if we are in the interface documentation
            if ( ( $_!~/^#/ ) || ( $_=~/^#\s?-{40}/ ) ) { #moving out of Int doc
                $intregion=0;
                next;
            }
            if ( $_=~/^#\s*(.*)\((.*)\)?:(.*)/ ) {
             $interface=$1;
             $args=$2;
             $rest=$3;
             next if ($interface eq ""); 
             push @{$self->{'interfaces'}},$interface;
             $self->{interfaceargs}{$interface}=$args;
             print " Documented Interface $interface\n";
            }
           }
        }
        close SRCIN;
}

sub cleantemp {
        my $self=shift;
        use File::Path;
        rmtree($self->temparea());
}
Revision:	1.6
Committed:	Fri Dec 17 10:10:36 1999 UTC (25 years, 4 months ago) by williamc
Content type:	text/plain
Branch:	MAIN
Changes since 1.5:	+8 -5 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	williamc	1.1	#
2			# Test a documented perl class
3			#
4			# Interface
5			# ---------
6	williamc	1.4	# new($module,testdatadir) : module example - Utilities/urlhandler
7	williamc	1.1	# dotest(@args) : Start testing - arguments dependent on inheriting class
8			#
9			# newtest() : Initiate a testing sequence
10			# verify(actual_result_file, expected_result_file) : compare two files
11			# verifydir(dir) : Check existence of the directory
12	williamc	1.5	# verifyexists(file) : Verify the existence of file
13	williamc	1.1	# datadir([dir]) : return the current data directory (set it to dir if supplied)
14	williamc	1.5	# testfail(string) : report that current test has failed
15			# testpass(string) : report that current test has passed
16	williamc	1.1	# newfilename() : return a new filename that can be opened etc.
17			# temparea() : return a directory for building temporary stuff
18			# newobject(@args) : Set up a new object to be tested
19			# testinterface($name,@args) : perform interface tests for $name with @args
20			# expect(string) : tell the testinterface of any expected return values
21			# clearexpect() : Reset any expect variables.
22	williamc	1.5	#cleantemp() : delete the temporary area
23	williamc	1.1
24			package TestClass;
25			require 5.004;
26			$bold = "\033[1m";
27			$normal = "\033[0m";
28
29			# -------------------- Front line Interface methods ---------------------
30			sub new {
31			my $class=shift;
32			my $fullmodule=shift;
33			chomp $fullmodule;
34			my $datadir=shift;
35
36			# The usual Object blessing
37			$self={};
38			bless $self,$class;
39
40			#some local working variables
41			my $testmodule;
42			my $module;
43	williamc	1.2	my $dir="";
44	williamc	1.4	# if ( $fullmodule=~/\// ) {
45			# ($dir=$fullmodule)=~s/(.\/)(.)/$1/;
46			# }
47			if ( $fullmodule=~/::/ ) {
48			($dir=$fullmodule)=~s/(.::)(.)/$1/;
49			}
50	williamc	1.1	else { $dir="" }
51	williamc	1.4	($testmodule=$fullmodule)=~s/(.\/)(.)/$1test::test_$2/;
52			($testmodule=$fullmodule)=~s/${dir}(.*)/${dir}test::test_$1/;
53	williamc	1.1	($module=$testmodule)=~s/.*\///g;
54
55			$self->{class}=$module;
56			$self->{"datadir"}=$datadir;
57			$self->{filenumber}=0;
58	williamc	1.5	$self->{temparea}="/tmp/SCRAMtest++";
59	williamc	1.2	use File::Path;
60			mkpath ($self->{temparea},0, 0777);
61	williamc	1.1
62			# Now setup a new testobject of the appropriate type
63	williamc	1.4	eval "require $testmodule";
64			die $@ if $@;
65	williamc	1.1	$self->{testobj}=$module->_new($self, $fullmodule);
66
67			return $self;
68			}
69
70			#
71			# Call the test routine of our inheriting class
72			#
73			sub dotest {
74			$self=shift;
75			$self->{testobj}->test(@_);
76			$self->{testobj}->checktests();
77			}
78
79
80
81			# A virtual method to be overridden
82			sub init {
83			my $self=shift;
84			}
85
86			#
87			# initiate a new test sequence
88			#
89			sub newtest {
90			my $self=shift;
91			my $string=shift;
92			$self->{testnumber}++;
93	williamc	1.2	$self->_testout("");
94	williamc	1.1	$self->_testout("---------------------------* Test $self->{testnumber}".
95			" *------------------------------");
96			$self->_testout("\| $string ");
97			$self->_testout("\|");
98			$self->_testout(
99			"---------------------------------------------------------------");
100
101			}
102
103			sub verify {
104			my $self=shift;
105			my $file1=shift;
106			my $file2=shift;
107			my $same=1;
108
109			$self->_testout(">Verifying files : $file1 \n".
110			" $file2");
111			open ( FILE1, "<$file1" ) or die "Cannot Read Test Output $file1 $!\n";
112			open ( FILE2, "<$file2" ) or die "Cannot Read Benchmark file ".
113			"$file2 $!\n";
114	williamc	1.5	while ( $f1=<FILE2> ) {
115			$f2=<FILE1>;
116			if ( (!defined $f2 ) \|\| ( ! defined $f1) \|\| ($f2 ne $f1 )) {
117			#print "T:\n$f1\nB:$f2\n";
118	williamc	1.1	$same=0;
119			}
120			}
121			close FILE1;
122			close FILE2;
123			if ( $same==0 ) {
124			$self->testfail("File $file1 is not the same as $file2");
125			}
126			}
127
128			sub verifydir {
129			my $self=shift;
130			my $name=shift;
131
132			if ( -d "$name" ) {
133	williamc	1.5	$self->testpass("Directory $name exists - test passed");
134	williamc	1.1	}
135			else {
136			$self->testfail("Directory $name does not exist");
137			}
138			}
139
140	williamc	1.5	sub verifyexists {
141			my $self=shift;
142			my $name=shift;
143
144	williamc	1.6	if ( -e "$name" ) {
145			$self->testpass("$name exists - test passed");
146	williamc	1.5	}
147			else {
148	williamc	1.6	$self->testfail("$name does not exist");
149	williamc	1.5	}
150			}
151
152	williamc	1.1	sub testfail {
153			my $self=shift;
154			my $string=shift;
155
156			$self->_testout("$bold $string $normal");
157			push @{$self->{failedtests}}, $self->{testnumber};
158			}
159
160			sub testpass {
161			my $self=shift;
162			my $string=shift;
163
164			$self->_testout($string);
165			}
166
167			sub newfilename {
168			my $self=shift;
169			$self->{filenumber}++;
170			return "temptest_$self->{filenumber}";
171			}
172
173			sub temparea {
174			my $self=shift;
175			return $self->{temparea};
176			}
177
178			#
179			# return the data directory ( and set if given an argument )
180			#
181			sub datadir {
182			my $self=shift;
183			my $dir=shift;
184			if ( $dir ne "" ) {
185			$self->{datadir}=$dir;
186			}
187			return $self->{datadir};
188			}
189
190			#
191			# -------------------- Private Methods ----------------------------
192			# (only to be used by the inheriting class)
193
194			#
195			# A basic new method for inheriting classes
196			#
197
198			sub _new {
199			my $class=shift;
200			my $testobject=shift;
201			my $module=shift;
202
203
204			# Bless this object and all those who inherit from her
205			my $self={};
206			bless $self, $class;
207
208			# we want the dat members from the initialisation of our class in
209			# here too
210			foreach $key ( keys %$testobject ) {
211			$self->{$key}=$testobject->{$key};
212			}
213
214			print "Initialising $class\n";
215
216			# Data Initialisation
217			$self->{testclass}=$class;
218	williamc	1.4	($self->{classname}=$module)=~s/::/\//g;
219	williamc	1.1	($self->{class}=$module)=~s/.*\///g;
220			$self->{classfile}=$ENV{SCRAM_HOME}."/src/".$self->{classname}."\.pm";
221			$self->init(@_);
222			$self->analyseInterface();
223			delete $self->{expect};
224			return $self;
225			}
226
227			#
228			# Test the interface
229			#
230			sub testinterface {
231			my $self=shift;
232			my $subname=shift;
233			my $myreturn;
234	williamc	1.4	my $expected;
235	williamc	1.1
236			$self->_checkdoc($subname);
237			$self->{inttest}{$subname}++;
238			$self->_testout(">Trying interface $subname ");
239			my $args=join ', ', @_;
240			$self->_testout( " (".$args.")" );
241	williamc	1.2	$num=0;
242	williamc	1.1	if ( exists $self->{expect} ) {
243	williamc	1.2	@mylist=eval { $self->{object}->$subname(@_); };
244			die "Test Failed $@\n" if $@;
245	williamc	1.4	if ( defined @mylist ) {
246	williamc	1.6	# size check
247			if ( $#mylist < $#{$self->{expect}} ) {
248			$self->testfail("not enough returned values");
249			}
250	williamc	1.4	foreach $myreturn ( @mylist ) {
251			if ( ! defined $myreturn ) {
252			print "Undefined Value Passed Back\n";
253			}
254	williamc	1.5	elsif ( $myreturn=~/HASH/ ) {
255			print "Hash Ref returned\n";
256	williamc	1.1	}
257	williamc	1.5	elsif ( $myreturn=~/CODE/ ) {
258	williamc	1.2	print "Code Ref returned\n";
259			}
260	williamc	1.5	elsif ( $myreturn=~/ARRAY/ ) {
261	williamc	1.2	print "Array Ref returned\n";
262			}
263			else {
264	williamc	1.4	$expected=$self->{expect}[$num++];
265	williamc	1.2	if ( $myreturn eq $expected ) { #simple return case
266			$self->testpass("OK - returned as expected ($expected)");
267			}
268			else {
269			$self->testfail("Expecting $expected, got ".
270			$myreturn);
271			}
272			}
273	williamc	1.4	} # end foreach block
274			}
275	williamc	1.2	return @mylist;
276	williamc	1.1	}
277			else {
278			return ($self->{object}->$subname(@_));
279			}
280			}
281
282			#
283			# expect - tell testinterface what returns to expect and fail/pass
284			#
285			sub expect {
286			my $self=shift;
287
288	williamc	1.6	push @{$self->{expect}}, @_;
289	williamc	1.1	}
290
291			sub clearexpect {
292			my $self=shift;
293			my $string=shift;
294
295			delete $self->{expect};
296			}
297
298			#
299			# checktests
300			#
301			sub checktests {
302			my $self=shift;
303			$self->newtest(">Checking all documented Interfaces have been tested ");
304			foreach $key ( keys %{$self->{interfaceargs}} ) {
305			if ( ! exists $self->{inttest}{$key} ) {
306			$self->testfail ("$key has not been tested");
307			}
308			}
309			# Now see whats failed
310			foreach $fail ( @{$self->{failedtests}} ) {
311			$self->_testout("$bold Failed in $fail $normal");
312			}
313			}
314
315			#
316			# Create a new object
317			#
318			sub newobject {
319			my $self=shift;
320
321			$self->_checkdoc("new");
322			$self->_testout(">Creating new Object $self->{class}");
323			$self->{object}=$self->{class}->new(@_);
324			$self->_testout(" ( $self->{object} )");
325			$self->{inttest}{"new"}++;
326			}
327
328			#
329			# check if interface has been documented
330			#
331			sub _checkdoc {
332			my $self=shift;
333			my $name=shift;
334
335			if ( exists $self->{interfaceargs}{$name} ) {
336			}
337			else {
338			$self->_testout
339			("Tester: Interface Method '$name' is not documented\n");
340			}
341			}
342
343			#
344			# Output messages to screen/logs etc
345			#
346			sub _testout($) {
347			my $self=shift;
348			my $string=shift;
349
350			print $string;
351			print "\n";
352			}
353			#
354			# Method to read the interface documentation
355			#
356
357			sub analyseInterface {
358			my $self=shift;
359			my $intregion=0;
360
361			open ( SRCIN, $self->{"classfile"} )
362			or die "Unable to open $classfile $!\n";
363			while ( <SRCIN> ) {
364			if ( $_=~/#\s*Interface/g ) {
365			$intregion=1;
366			next;
367			}
368			if ( $intregion ) { # if we are in the interface documentation
369			if ( ( $_!~/^#/ ) \|\| ( $_=~/^#\s?-{40}/ ) ) { #moving out of Int doc
370			$intregion=0;
371			next;
372			}
373			if ( $_=~/^#\s(.)\((.)\)?:(.)/ ) {
374			$interface=$1;
375			$args=$2;
376			$rest=$3;
377			next if ($interface eq "");
378			push @{$self->{'interfaces'}},$interface;
379			$self->{interfaceargs}{$interface}=$args;
380			print " Documented Interface $interface\n";
381			}
382			}
383			}
384			close SRCIN;
385	williamc	1.5	}
386
387			sub cleantemp {
388			my $self=shift;
389			use File::Path;
390			rmtree($self->temparea());
391	williamc	1.1	}