xs::apitest(3pm) [osx man page]

XS::APItest(3pm)					 Perl Programmers Reference Guide					  XS::APItest(3pm)

NAME

       XS::APItest - Test the perl C API

SYNOPSIS

	 use XS::APItest;
	 print_double(4);

ABSTRACT

       This module tests the perl C API. Currently tests that "printf" works correctly.

DESCRIPTION

       This module can be used to check that the perl C API is behaving correctly. This module provides test functions and an associated test
       script that verifies the output.

       This module is not meant to be installed.

   EXPORT
       Exports all the test functions:

       print_double
	   Test that a double-precision floating point number is formatted correctly by "printf".

	     print_double( $val );

	   Output is sent to STDOUT.

       print_long_double
	   Test that a "long double" is formatted correctly by "printf". Takes no arguments - the test value is hard-wired into the function (as
	   "7").

	     print_long_double();

	   Output is sent to STDOUT.

       have_long_double
	   Determine whether a "long double" is supported by Perl.  This should be used to determine whether to test "print_long_double".

	     print_long_double() if have_long_double;

       print_nv
	   Test that an "NV" is formatted correctly by "printf".

	     print_nv( $val );

	   Output is sent to STDOUT.

       print_iv
	   Test that an "IV" is formatted correctly by "printf".

	     print_iv( $val );

	   Output is sent to STDOUT.

       print_uv
	   Test that an "UV" is formatted correctly by "printf".

	     print_uv( $val );

	   Output is sent to STDOUT.

       print_int
	   Test that an "int" is formatted correctly by "printf".

	     print_int( $val );

	   Output is sent to STDOUT.

       print_long
	   Test that an "long" is formatted correctly by "printf".

	     print_long( $val );

	   Output is sent to STDOUT.

       print_float
	   Test that a single-precision floating point number is formatted correctly by "printf".

	     print_float( $val );

	   Output is sent to STDOUT.

       call_sv, call_pv, call_method
	   These exercise the C calls of the same names. Everything after the flags arg is passed as the the args to the called function. They
	   return whatever the C function itself pushed onto the stack, plus the return value from the function; for example

	       call_sv( sub { @_, 'c' }, G_ARRAY,  'a', 'b'); # returns 'a', 'b', 'c', 3
	       call_sv( sub { @_ },	 G_SCALAR, 'a', 'b'); # returns 'b', 1

       eval_sv
	   Evaluates the passed SV. Result handling is done the same as for "call_sv()" etc.

       eval_pv
	   Exercises the C function of the same name in scalar context. Returns the same SV that the C function returns.

       require_pv
	   Exercises the C function of the same name. Returns nothing.

SEE ALSO

       XS::Typemap, perlapi.

AUTHORS

       Tim Jenness, <t.jenness@jach.hawaii.edu>, Christian Soeller, <csoelle@mph.auckland.ac.nz>, Hugo van der Sanden <hv@crypt.compulink.co.uk>

COPYRIGHT AND LICENSE

       Copyright (C) 2002,2004 Tim Jenness, Christian Soeller, Hugo van der Sanden.  All Rights Reserved.

       This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

perl v5.12.5							    2012-11-03							  XS::APItest(3pm)

Test::Object(3) 					User Contributed Perl Documentation					   Test::Object(3)

NAME

       Test::Object - Thoroughly testing objects via registered handlers

SYNOPSIS

	 ###################################################################
	 # In your test module, register test handlers again class names   #
	 ###################################################################

	 package My::ModuleTester;

	 use Test::More;
	 use Test::Object;

	 # Foo::Bar is a subclass of Foo
	 Test::Object->register(
	       class => 'Foo',
	       tests => 5,
	       code  => &foo_ok,
	       );
	 Test::Object->register(
	       class => 'Foo::Bar',
	       # No fixed number of tests
	       code  => &foobar_ok,
	       );

	 sub foo_ok {
	       my $object = shift;
	       ok( $object->foo, '->foo returns true' );
	 }

	 sub foobar_ok {
	       my $object = shift;
	       is( $object->foo, 'bar', '->foo returns "bar"' );
	 }

	 1;

	 ###################################################################
	 # In test script, test object against all registered classes	   #
	 ###################################################################

	 #!/usr/bin/perl -w

	 use Test::More 'no_plan';
	 use Test::Object;
	 use My::ModuleTester;

	 my $object = Foo::Bar->new;
	 isa_ok( $object, 'Foo::Bar' );
	 object_ok( $object );

DESCRIPTION

       In situations where you have deep trees of classes, there is a common situation in which you test a module 4 or 5 subclasses down, which
       should follow the correct behaviour of not just the subclass, but of all the parent classes.

       This should be done to ensure that the implementation of a subclass has not somehow "broken" the object's behaviour in a more general
       sense.

       "Test::Object" is a testing package designed to allow you to easily test what you believe is a valid object against the expected behaviour
       of all of the classes in its inheritance tree in one single call.

       To do this, you "register" tests (in the form of CODE or function references) with "Test::Object", with each test associated with a
       particular class.

       When you call "object_ok" in your test script, "Test::Object" will check the object against all registered tests. For each class that your
       object responds to "$object->isa($class)" for, the appropriate testing function will be called.

       Doing it this way allows adapter objects and other things that respond to "isa" differently that the default to still be tested against the
       classes that it is advertising itself as correctly.

       This also means that more than one test might be "counted" for each call to "object_ok". You should account for this correctly in your
       expected test count.

SUPPORT

       Bugs should be submitted via the CPAN bug tracker, located at

       <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test-Object>

       For other issues, contact the author.

AUTHOR

       Adam Kennedy <cpan@ali.as>

SEE ALSO

       <http://ali.as/>, Test::More, Test::Builder::Tester, Test::Class

COPYRIGHT

       Copyright 2005, 2006 Adam Kennedy. All rights reserved.

       This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

       The full text of the license can be found in the LICENSE file included with this module.

perl v5.18.2							    2006-09-06							   Test::Object(3)