/usr/lib/parrot/6.6.0/library/Test/Builder/Tester.pir is in parrot 6.6.0-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 | =head1 NAME
Test::Builder::Tester - Parrot extension for testing test modules
=head1 SYNOPSIS
# load this library
load_bytecode 'Test/Builder/Tester.pbc'
# grab the subroutines you want to use
.local pmc plan
.local pmc test_out
.local pmc test_diag
.local pmc test_test
plan = get_hll_global [ 'Test'; 'Builder'; 'Tester' ], 'plan'
test_out = get_hll_global [ 'Test'; 'Builder'; 'Tester' ], 'test_out'
test_diag = get_hll_global [ 'Test'; 'Builder'; 'Tester' ], 'test_diag'
test_test = get_hll_global [ 'Test'; 'Builder'; 'Tester' ], 'test_test'
# create a new Test::Builder object
.local pmc tb_args
.local pmc test
tb_args = new 'Hash'
test = new [ 'Test'; 'Builder' ], tb_args
# set your test plan
plan( 4 )
# test a passing test
test_out( 'ok 1 - hi' )
test.'ok'( 1, 'hi' )
test_test( 'passing test')
# test a test with some diagnostics
test_out( 'ok 3 - A message' )
test_diag( "some\nlines" )
test.ok( 1, 'A message' )
test.diag( 'some' )
test.diag( 'lines' )
test_test( 'passing test with diagnostics' )
# clean up
test.'finish'()
=head1 DESCRIPTION
Test::Builder::Tester is a pure-Parrot library for testing testing modules
built on L<Test::Builder>. It allows you to describe the TAP output that they
will produce, showing any differences in description, directive, and
diagnostics.
This is a procedural library.
=head1 FUNCTIONS
This module defines the following public functions:
=over 4
=cut
.namespace [ 'Test'; 'Builder'; 'Tester'; 'Output' ]
.sub _initialize :load
.local pmc tbto_class
newclass tbto_class, [ 'Test'; 'Builder'; 'Tester'; 'Output' ]
addattribute tbto_class, 'output'
addattribute tbto_class, 'diagnostics'
.end
.sub init :vtable :method
.local pmc output
.local pmc diagnostics
output = new 'ResizablePMCArray'
diagnostics = new 'ResizablePMCArray'
setattribute self, "output", output
setattribute self, "diagnostics", diagnostics
.end
.sub get_output :method
.local pmc output
getattribute output, self, "output"
.return( output )
.end
.sub get_diagnostics :method
.local pmc diagnostics
getattribute diagnostics, self, "diagnostics"
.return( diagnostics )
.end
.sub write :method
.param string message
.local pmc message_string
message_string = new 'String'
set message_string, message
.local pmc output
output = self.'get_output'()
push output, message_string
.end
.sub diag :method
.param string message
.local pmc message_string
message_string = new 'String'
set message_string, message
.local pmc diagnostics
diagnostics = self.'get_diagnostics'()
push diagnostics, message_string
.end
.sub output :method
.local pmc output
output = self.'get_output'()
unless_null output, JOIN_LINES
.return( '' )
JOIN_LINES:
.local string output_string
output_string = join "\n", output
set output, 0
.return( output_string )
.end
.sub diagnostics :method
.local pmc diagnostics
diagnostics = self.'get_diagnostics'()
unless_null diagnostics, JOIN_LINES
.return( '' )
JOIN_LINES:
.local string diag_string
diag_string = join "\n", diagnostics
diagnostics = 0
.return( diag_string )
.end
.namespace [ 'Test'; 'Builder'; 'Tester' ]
.sub _initialize :load
load_bytecode 'Test/Builder.pbc'
.local pmc test
.local pmc output
.local pmc test_output
.local pmc expect_out
.local pmc expect_diag
.local pmc default_test
.local pmc args
# set the default output for the Test::Builder singleton
test_output = new [ 'Test'; 'Builder'; 'Tester'; 'Output' ]
args = new 'Hash'
set args['output'], test_output
default_test = new [ 'Test'; 'Builder' ], args
default_test.'plan'( 'no_plan' )
test_output.'output'()
# create the Test::Builder object that this uses
.local pmc tb_create
tb_create = get_hll_global [ 'Test'; 'Builder' ], 'create'
args = new 'Hash'
output = new [ 'Test'; 'Builder'; 'Output' ], args
.local pmc results, testplan
results = new 'ResizablePMCArray'
testplan = new 'String'
testplan = ''
set args['output'], output
test = tb_create( args )
expect_out = new 'ResizablePMCArray'
expect_diag = new 'ResizablePMCArray'
set_hll_global [ 'Test'; 'Builder'; 'Tester' ], '_test', test
set_hll_global [ 'Test'; 'Builder'; 'Tester' ], '_default_test', default_test
set_hll_global [ 'Test'; 'Builder'; 'Tester' ], '_test_output', test_output
set_hll_global [ 'Test'; 'Builder'; 'Tester' ], '_expect_out', expect_out
set_hll_global [ 'Test'; 'Builder'; 'Tester' ], '_expect_diag', expect_diag
.end
=item C<plan( num_tests )>
Sets the number of tests you plan to run, where C<num_tests> is an int.
=cut
.sub plan
.param int tests
.local pmc test
test = get_hll_global [ 'Test'; 'Builder'; 'Tester' ], '_test'
test.'plan'( tests )
.end
.sub line_num
.end
=item C<test_pass( test_string )>
Sets the expectation for a test to pass. C<test_string> is the optional
description of the test.
=cut
.sub test_pass
.param string description :optional
.param int have_desc :opt_flag
set_output( 'ok', description )
.end
=item C<test_fail( test_string )>
Sets the expectation for a test to fail. C<test_string> is the optional
description of the test.
=cut
.sub test_fail
.param string description :optional
set_output( 'not ok', description )
.end
.sub set_output
.param string test_type
.param string description
.local pmc test
.local pmc results
.local int result_count
.local pmc next_result
test = get_hll_global [ 'Test'; 'Builder'; 'Tester' ], '_default_test'
results = test.'results'()
result_count = results
inc result_count
next_result = new 'String'
set next_result, result_count
.local pmc line_string
line_string = new 'String'
line_string = concat line_string, test_type
line_string = concat line_string, ' '
line_string = concat line_string, next_result
.local int string_defined
string_defined = length description
unless string_defined goto SET_EXPECT_OUTPUT
line_string = concat line_string, ' - '
line_string = concat line_string, description
SET_EXPECT_OUTPUT:
.local pmc expect_out
expect_out = get_hll_global [ 'Test'; 'Builder'; 'Tester' ], '_expect_out'
push expect_out, line_string
.end
=item C<test_out( test_string )>
Sets the expected output for this test to a string. This should be a line of
TAP output containing a combination of test number, status, description, and
directive.
=cut
.sub test_out
.param string line
.local pmc line_string
line_string = new 'String'
set line_string, line
.local pmc expect_out
expect_out = get_hll_global [ 'Test'; 'Builder'; 'Tester' ], '_expect_out'
push expect_out, line_string
.end
=item C<test_err( test_string )>
Sets the expected diagnostic output for this test to a string. This should be
a line of TAP output containing a test directive.
=cut
.sub test_err
.param string line
.local pmc line_string
line_string = new 'String'
set line_string, line
.local pmc expect_diag
expect_diag = get_hll_global [ 'Test'; 'Builder'; 'Tester' ], '_expect_diag'
push expect_diag, line_string
.end
=item C<test_diag( test_string )>
Sets the expected diagnostic output for this test to a string. This should be
a line of TAP output containing a test directive.
This and C<test_err()> are effectively the same.
=cut
.sub test_diag
.param string line
.local pmc line_string
line_string = new 'String'
set line_string, line
.local pmc expect_diag
expect_diag = get_hll_global [ 'Test'; 'Builder'; 'Tester' ], '_expect_diag'
push expect_diag, line_string
.end
=item C<test_test( test_description )>
Compares all of the expected test output and diagnostic output with the actual
test output. This reports success or failure, using the giving string for the
test description, and prints a diagnostic message with the divergent test
output or diagnostic output.
=cut
.sub test_test
.param string description
.local int string_defined
string_defined = length description
if string_defined goto FETCH_GLOBALS
description = ''
FETCH_GLOBALS:
.local pmc test
.local pmc expect_out
.local pmc expect_diag
.local pmc test_output
test = get_hll_global [ 'Test'; 'Builder'; 'Tester' ], '_test'
expect_out = get_hll_global [ 'Test'; 'Builder'; 'Tester' ], '_expect_out'
expect_diag = get_hll_global [ 'Test'; 'Builder'; 'Tester' ], '_expect_diag'
test_output = get_hll_global [ 'Test'; 'Builder'; 'Tester' ], '_test_output'
.local string received_out_string
.local string received_diag_string
.local string expected_out_string
.local string expected_diag_string
received_out_string = test_output.'output'()
received_diag_string = test_output.'diagnostics'()
MAKE_EXPECTED_OUTPUT_STRING:
.local int num_lines
num_lines = expect_out
ne num_lines, 0, JOIN_EO_STRING
goto MAKE_EXPECTED_DIAG_STRING
JOIN_EO_STRING:
expected_out_string = join "\n", expect_out
expect_out = 0
MAKE_EXPECTED_DIAG_STRING:
num_lines = expect_diag
ne num_lines, 0, JOIN_DIAG_STRING
goto COMPARE_OUT_STRINGS
JOIN_DIAG_STRING:
expected_diag_string = join "\n", expect_diag
expect_diag = 0
.local int diag_matches
.local int output_matches
diag_matches = 1
output_matches = 1
COMPARE_OUT_STRINGS:
eq received_out_string, expected_out_string, COMPARE_DIAG_STRINGS
output_matches = 0
goto FAIL_TEST
COMPARE_DIAG_STRINGS:
eq received_diag_string, expected_diag_string, PASS_TEST
diag_matches = 0
goto FAIL_TEST
PASS_TEST:
test.'ok'( 1, description )
.return( 1 )
FAIL_TEST:
test.'ok'( 0, description )
eq output_matches, 1, REPORT_DIAG_MISMATCH
REPORT_OUTPUT_MISMATCH:
.local string diagnostic
diagnostic = "output mismatch\nhave: "
diagnostic = concat diagnostic, received_out_string
diagnostic = concat diagnostic, "\nwant: "
diagnostic = concat diagnostic, expected_out_string
diagnostic = concat diagnostic, "\n"
test.'diag'( diagnostic )
eq diag_matches, 1, RETURN
REPORT_DIAG_MISMATCH:
diagnostic = "diagnostic mismatch\nhave: '"
diagnostic = concat diagnostic, received_diag_string
diagnostic = concat diagnostic, "'\nwant: '"
diagnostic = concat diagnostic, expected_diag_string
diagnostic = concat diagnostic, "'\n"
test.'diag'( diagnostic )
RETURN:
.return( 0 )
.end
=back
=head1 AUTHOR
Written and maintained by chromatic, C<< chromatic at wgz dot org >>, based on
the Perl 6 port he wrote, based on the original Perl 5 version written by Mark
Fowler. Please send patches, feedback, and suggestions to the Perl 6 internals
mailing list.
=head1 COPYRIGHT
Copyright (C) 2005-2008, Parrot Foundation.
=cut
# Local Variables:
# mode: pir
# fill-column: 100
# End:
# vim: expandtab shiftwidth=4 ft=pir:
|