[p5sagit/p5-mst-13.2.git] / ext / B / t / optree_check.t

#!perl

BEGIN {
    unshift @INC, 't';
    require Config;
    if (($Config::Config{'extensions'} !~ /\bB\b/) ){
        print "1..0 # Skip -- Perl configured without B module\n";
        exit 0;
    }
    # require 'test.pl'; # now done by OptreeCheck
}

use OptreeCheck;

=head1 OptreeCheck selftest harness

This file is primarily to test services of OptreeCheck itself, ie
checkOptree().  %gOpts provides test-state info, it is 'exported' into
main::  

doing use OptreeCheck runs import(), which processes @ARGV to process
cmdline args in 'standard' way across all clients of OptreeCheck.

=cut

my $tests = 5 + 15 + 16 * $gOpts{selftest};	# pass()s + $#tests
plan tests => $tests;

SKIP: {
    skip "no perlio in this build", $tests
    unless $Config::Config{useperlio};


pass("REGEX TEST HARNESS SELFTEST");

checkOptree ( name	=> "bare minimum opcode search",
	      bcopts	=> '-exec',
	      code	=> sub {my $a},
	      noanchors	=> 1, # unanchored match
	      expect	=> 'leavesub',
	      expect_nt	=> 'leavesub');

checkOptree ( name	=> "found print opcode",
	      bcopts	=> '-exec',
	      code	=> sub {print 1},
	      noanchors	=> 1, # unanchored match
	      expect	=> 'print',
	      expect_nt	=> 'leavesub');

checkOptree ( name	=> 'test skip itself',
	      skip	=> 'this is skip-reason',
	      bcopts	=> '-exec',
	      code	=> sub {print 1},
	      expect	=> 'dont-care, skipping',
	      expect_nt	=> 'this insures failure');

# This test 'unexpectedly succeeds', but that is "expected".  Theres
# no good way to expect a successful todo, and inducing a failure
# causes the harness to print verbose errors, which is NOT helpful.

checkOptree ( name	=> 'test todo itself',
	      todo	=> "your excuse here ;-)",
	      bcopts	=> '-exec',
	      code	=> sub {print 1},
	      noanchors	=> 1, # unanchored match
	      expect	=> 'print',
	      expect_nt	=> 'print') if 0;

checkOptree ( name	=> 'impossible match, remove skip to see failure',
	      todo	=> "see! it breaks!",
	      skip	=> 'skip the failure',
	      code	=> sub {print 1},
	      expect	=> 'look out ! Boy Wonder',
	      expect_nt	=> 'holy near earth asteroid Batman !');

pass ("TEST FATAL ERRS");

if (1) {
    # test for fatal errors. Im unsettled on fail vs die.
    # calling fail isnt good enough by itself.

    $@='';
    eval {
	checkOptree ( name	=> 'test against empty expectations',
		      bcopts	=> '-exec',
		      code	=> sub {print 1},
		      expect	=> '',
		      expect_nt	=> '');
    };
    like($@, /no '\w+' golden-sample found/, "empty expectations prevented");
    
    $@='';
    eval {
	checkOptree ( name	=> 'prevent whitespace only expectations',
		      bcopts	=> '-exec',
		      code	=> sub {my $a},
		      #skip	=> 1,
		      expect_nt	=> "\n",
		      expect	=> "\n");
    };
    like($@, /no '\w+' golden-sample found/,
	 "just whitespace expectations prevented");
}
    
pass ("TEST -e \$srcCode");

checkOptree ( name	=> 'empty code or prog',
	      skip	=> 'or fails',
	      todo	=> "your excuse here ;-)",
	      code	=> '',
	      prog	=> '',
	      );
    
checkOptree
    (  name	=> "self strict, catch err",
       prog	=> 'use strict; bogus',
       errs	=> 'Bareword "bogus" not allowed while "strict subs" in use at -e line 1.',
       expect	=> "nextstate",	# simple expectations
       expect_nt => "nextstate",
       noanchors => 1,		# allow them to work
       );
    
checkOptree ( name	=> "sort lK - flag specific search",
	      prog	=> 'our (@a,@b); @b = sort @a',
	      noanchors	=> 1,
	      expect	=> '<@> sort lK ',
	      expect_nt	=> '<@> sort lK ');

checkOptree ( name	=> "sort vK - flag specific search",
	      prog	=> 'sort our @a',
	      errs	=> 'Useless use of sort in void context at -e line 1.',
	      noanchors	=> 1,
	      expect	=> '<@> sort vK',
	      expect_nt	=> '<@> sort vK');

checkOptree ( name	=> "'code' => 'sort our \@a'",
	      code	=> 'sort our @a',
	      noanchors	=> 1,
	      expect	=> '<@> sort K',
	      expect_nt	=> '<@> sort K');

pass ("REFTEXT FIXUP TESTS");

checkOptree ( name	=> 'fixup nextstate (in reftext)',
	      bcopts	=> '-exec',
	      code	=> sub {my $a},
	      strip_open_hints => 1,
	      expect	=> <<'EOT_EOT', expect_nt => <<'EONT_EONT');
# 1  <;> nextstate( NOTE THAT THIS CAN BE ANYTHING ) v:>,<,%
# 2  <0> padsv[$a:54,55] M/LVINTRO
# 3  <1> leavesub[1 ref] K/REFC,1
EOT_EOT
# 1  <;> nextstate(main 54 optree_concise.t:84) v:>,<,%
# 2  <0> padsv[$a:54,55] M/LVINTRO
# 3  <1> leavesub[1 ref] K/REFC,1
EONT_EONT

checkOptree ( name	=> 'fixup opcode args',
	      bcopts	=> '-exec',
	      #fail	=> 1, # uncomment to see real padsv args: [$a:491,492] 
	      code	=> sub {my $a},
	      strip_open_hints => 1,
	      expect	=> <<'EOT_EOT', expect_nt => <<'EONT_EONT');
# 1  <;> nextstate(main 56 optree_concise.t:96) v:>,<,%
# 2  <0> padsv[$a:56,57] M/LVINTRO
# 3  <1> leavesub[1 ref] K/REFC,1
EOT_EOT
# 1  <;> nextstate(main 56 optree_concise.t:96) v:>,<,%
# 2  <0> padsv[$a:56,57] M/LVINTRO
# 3  <1> leavesub[1 ref] K/REFC,1
EONT_EONT

#################################
pass("CANONICAL B::Concise EXAMPLE");

checkOptree ( name	=> 'canonical example w -basic',
	      bcopts	=> '-basic',
	      code	=>  sub{$a=$b+42},
	      crossfail => 1,
	      debug	=> 1,
	      strip_open_hints => 1,
	      expect	=> <<'EOT_EOT', expect_nt => <<'EONT_EONT');
# 7  <1> leavesub[1 ref] K/REFC,1 ->(end)
# -     <@> lineseq KP ->7
# 1        <;> nextstate(main 380 optree_selftest.t:139) v:>,<,%,{ ->2
# 6        <2> sassign sKS/2 ->7
# 4           <2> add[t3] sK/2 ->5
# -              <1> ex-rv2sv sK/1 ->3
# 2                 <#> gvsv[*b] s ->3
# 3              <$> const[IV 42] s ->4
# -           <1> ex-rv2sv sKRM*/1 ->6
# 5              <#> gvsv[*a] s ->6
EOT_EOT
# 7  <1> leavesub[1 ref] K/REFC,1 ->(end)
# -     <@> lineseq KP ->7
# 1        <;> nextstate(main 60 optree_concise.t:122) v:>,<,%,{ ->2
# 6        <2> sassign sKS/2 ->7
# 4           <2> add[t1] sK/2 ->5
# -              <1> ex-rv2sv sK/1 ->3
# 2                 <$> gvsv(*b) s ->3
# 3              <$> const(IV 42) s ->4
# -           <1> ex-rv2sv sKRM*/1 ->6
# 5              <$> gvsv(*a) s ->6
EONT_EONT

checkOptree ( code	=> '$a=$b+42',
	      bcopts	=> '-exec',
	      expect	=> <<'EOT_EOT', expect_nt => <<'EONT_EONT');
# 1  <;> nextstate(main 837 (eval 24):1) v:{
# 2  <#> gvsv[*b] s
# 3  <$> const[IV 42] s
# 4  <2> add[t3] sK/2
# 5  <#> gvsv[*a] s
# 6  <2> sassign sKS/2
# 7  <1> leavesub[1 ref] K/REFC,1
EOT_EOT
# 1  <;> nextstate(main 837 (eval 24):1) v:{
# 2  <$> gvsv(*b) s
# 3  <$> const(IV 42) s
# 4  <2> add[t1] sK/2
# 5  <$> gvsv(*a) s
# 6  <2> sassign sKS/2
# 7  <1> leavesub[1 ref] K/REFC,1
EONT_EONT

} # skip

__END__
Commit	Line	Data
724aa791	1	#!perl
	2
	3	BEGIN {
74517a3a	4	unshift @INC, 't';
9cd8f857	5	require Config;
	6	if (($Config::Config{'extensions'} !~ /\bB\b/) ){
	7	print "1..0 # Skip -- Perl configured without B module\n";
	8	exit 0;
	9	}
19e169bf	10	# require 'test.pl'; # now done by OptreeCheck
724aa791	11	}
	12
	13	use OptreeCheck;
	14
	15	=head1 OptreeCheck selftest harness
	16
	17	This file is primarily to test services of OptreeCheck itself, ie
	18	checkOptree(). %gOpts provides test-state info, it is 'exported' into
	19	main::
	20
	21	doing use OptreeCheck runs import(), which processes @ARGV to process
	22	cmdline args in 'standard' way across all clients of OptreeCheck.
	23
	24	=cut
	25
b37cb821	26	my $tests = 5 + 15 + 16 * $gOpts{selftest}; # pass()s + $#tests
b37cb821	27	plan tests => $tests;
724aa791	28
2ce64696	29	SKIP: {
b37cb821	30	skip "no perlio in this build", $tests
2ce64696	31	unless $Config::Config{useperlio};
	32
	33
724aa791	34	pass("REGEX TEST HARNESS SELFTEST");
	35
	36	checkOptree ( name => "bare minimum opcode search",
	37	bcopts => '-exec',
	38	code => sub {my $a},
cc02ea56	39	noanchors => 1, # unanchored match
724aa791	40	expect => 'leavesub',
	41	expect_nt => 'leavesub');
	42
	43	checkOptree ( name => "found print opcode",
	44	bcopts => '-exec',
	45	code => sub {print 1},
cc02ea56	46	noanchors => 1, # unanchored match
724aa791	47	expect => 'print',
	48	expect_nt => 'leavesub');
	49
	50	checkOptree ( name => 'test skip itself',
19e169bf	51	skip => 'this is skip-reason',
724aa791	52	bcopts => '-exec',
	53	code => sub {print 1},
	54	expect => 'dont-care, skipping',
	55	expect_nt => 'this insures failure');
	56
181f6ff5	57	# This test 'unexpectedly succeeds', but that is "expected". Theres
	58	# no good way to expect a successful todo, and inducing a failure
	59	# causes the harness to print verbose errors, which is NOT helpful.
	60
724aa791	61	checkOptree ( name => 'test todo itself',
	62	todo => "your excuse here ;-)",
	63	bcopts => '-exec',
	64	code => sub {print 1},
cc02ea56	65	noanchors => 1, # unanchored match
724aa791	66	expect => 'print',
19e169bf	67	expect_nt => 'print') if 0;
724aa791	68
	69	checkOptree ( name => 'impossible match, remove skip to see failure',
	70	todo => "see! it breaks!",
19e169bf	71	skip => 'skip the failure',
724aa791	72	code => sub {print 1},
	73	expect => 'look out ! Boy Wonder',
	74	expect_nt => 'holy near earth asteroid Batman !');
	75
	76	pass ("TEST FATAL ERRS");
	77
	78	if (1) {
	79	# test for fatal errors. Im unsettled on fail vs die.
	80	# calling fail isnt good enough by itself.
19e169bf	81
724aa791	82	$@='';
	83	eval {
	84	checkOptree ( name => 'test against empty expectations',
	85	bcopts => '-exec',
	86	code => sub {print 1},
	87	expect => '',
	88	expect_nt => '');
	89	};
19e169bf	90	like($@, /no '\w+' golden-sample found/, "empty expectations prevented");
724aa791	91
	92	$@='';
	93	eval {
	94	checkOptree ( name => 'prevent whitespace only expectations',
	95	bcopts => '-exec',
	96	code => sub {my $a},
	97	#skip => 1,
	98	expect_nt => "\n",
	99	expect => "\n");
	100	};
19e169bf	101	like($@, /no '\w+' golden-sample found/,
19e169bf	102	"just whitespace expectations prevented");
724aa791	103	}
19e169bf	104
724aa791	105	pass ("TEST -e \$srcCode");
724aa791	106
19e169bf	107	checkOptree ( name => 'empty code or prog',
	108	skip => 'or fails',
	109	todo => "your excuse here ;-)",
	110	code => '',
	111	prog => '',
	112	);
5e251bf1	113
	114	checkOptree
	115	( name => "self strict, catch err",
	116	prog => 'use strict; bogus',
	117	errs => 'Bareword "bogus" not allowed while "strict subs" in use at -e line 1.',
19e169bf	118	expect => "nextstate", # simple expectations
	119	expect_nt => "nextstate",
	120	noanchors => 1, # allow them to work
5e251bf1	121	);
5e251bf1	122
19e169bf	123	checkOptree ( name => "sort lK - flag specific search",
19e169bf	124	prog => 'our (@a,@b); @b = sort @a',
cc02ea56	125	noanchors => 1,
19e169bf	126	expect => '<@> sort lK ',
19e169bf	127	expect_nt => '<@> sort lK ');
724aa791	128
19e169bf	129	checkOptree ( name => "sort vK - flag specific search",
724aa791	130	prog => 'sort our @a',
19e169bf	131	errs => 'Useless use of sort in void context at -e line 1.',
cc02ea56	132	noanchors => 1,
724aa791	133	expect => '<@> sort vK',
	134	expect_nt => '<@> sort vK');
	135
	136	checkOptree ( name => "'code' => 'sort our \@a'",
	137	code => 'sort our @a',
cc02ea56	138	noanchors => 1,
724aa791	139	expect => '<@> sort K',
	140	expect_nt => '<@> sort K');
	141
	142	pass ("REFTEXT FIXUP TESTS");
	143
	144	checkOptree ( name => 'fixup nextstate (in reftext)',
	145	bcopts => '-exec',
	146	code => sub {my $a},
be2b1c74	147	strip_open_hints => 1,
724aa791	148	expect => <<'EOT_EOT', expect_nt => <<'EONT_EONT');
be2b1c74	149	# 1 <;> nextstate( NOTE THAT THIS CAN BE ANYTHING ) v:>,<,%
724aa791	150	# 2 <0> padsv[$a:54,55] M/LVINTRO
	151	# 3 <1> leavesub[1 ref] K/REFC,1
	152	EOT_EOT
be2b1c74	153	# 1 <;> nextstate(main 54 optree_concise.t:84) v:>,<,%
724aa791	154	# 2 <0> padsv[$a:54,55] M/LVINTRO
	155	# 3 <1> leavesub[1 ref] K/REFC,1
	156	EONT_EONT
	157
181f6ff5	158	checkOptree ( name => 'fixup opcode args',
724aa791	159	bcopts => '-exec',
181f6ff5	160	#fail => 1, # uncomment to see real padsv args: [$a:491,492]
724aa791	161	code => sub {my $a},
be2b1c74	162	strip_open_hints => 1,
724aa791	163	expect => <<'EOT_EOT', expect_nt => <<'EONT_EONT');
be2b1c74	164	# 1 <;> nextstate(main 56 optree_concise.t:96) v:>,<,%
724aa791	165	# 2 <0> padsv[$a:56,57] M/LVINTRO
	166	# 3 <1> leavesub[1 ref] K/REFC,1
	167	EOT_EOT
be2b1c74	168	# 1 <;> nextstate(main 56 optree_concise.t:96) v:>,<,%
724aa791	169	# 2 <0> padsv[$a:56,57] M/LVINTRO
	170	# 3 <1> leavesub[1 ref] K/REFC,1
	171	EONT_EONT
	172
724aa791	173	#################################
	174	pass("CANONICAL B::Concise EXAMPLE");
	175
	176	checkOptree ( name => 'canonical example w -basic',
	177	bcopts => '-basic',
	178	code => sub{$a=$b+42},
	179	crossfail => 1,
	180	debug => 1,
be2b1c74	181	strip_open_hints => 1,
724aa791	182	expect => <<'EOT_EOT', expect_nt => <<'EONT_EONT');
	183	# 7 <1> leavesub[1 ref] K/REFC,1 ->(end)
	184	# - <@> lineseq KP ->7
be2b1c74	185	# 1 <;> nextstate(main 380 optree_selftest.t:139) v:>,<,%,{ ->2
724aa791	186	# 6 <2> sassign sKS/2 ->7
	187	# 4 <2> add[t3] sK/2 ->5
	188	# - <1> ex-rv2sv sK/1 ->3
	189	# 2 <#> gvsv[*b] s ->3
	190	# 3 <$> const[IV 42] s ->4
	191	# - <1> ex-rv2sv sKRM*/1 ->6
	192	# 5 <#> gvsv[*a] s ->6
	193	EOT_EOT
	194	# 7 <1> leavesub[1 ref] K/REFC,1 ->(end)
	195	# - <@> lineseq KP ->7
be2b1c74	196	# 1 <;> nextstate(main 60 optree_concise.t:122) v:>,<,%,{ ->2
724aa791	197	# 6 <2> sassign sKS/2 ->7
	198	# 4 <2> add[t1] sK/2 ->5
	199	# - <1> ex-rv2sv sK/1 ->3
	200	# 2 <$> gvsv(*b) s ->3
	201	# 3 <$> const(IV 42) s ->4
	202	# - <1> ex-rv2sv sKRM*/1 ->6
	203	# 5 <$> gvsv(*a) s ->6
	204	EONT_EONT
	205
19e169bf	206	checkOptree ( code => '$a=$b+42',
724aa791	207	bcopts => '-exec',
724aa791	208	expect => <<'EOT_EOT', expect_nt => <<'EONT_EONT');
be2b1c74	209	# 1 <;> nextstate(main 837 (eval 24):1) v:{
724aa791	210	# 2 <#> gvsv[*b] s
	211	# 3 <$> const[IV 42] s
	212	# 4 <2> add[t3] sK/2
	213	# 5 <#> gvsv[*a] s
	214	# 6 <2> sassign sKS/2
	215	# 7 <1> leavesub[1 ref] K/REFC,1
	216	EOT_EOT
be2b1c74	217	# 1 <;> nextstate(main 837 (eval 24):1) v:{
724aa791	218	# 2 <$> gvsv(*b) s
	219	# 3 <$> const(IV 42) s
	220	# 4 <2> add[t1] sK/2
	221	# 5 <$> gvsv(*a) s
	222	# 6 <2> sassign sKS/2
	223	# 7 <1> leavesub[1 ref] K/REFC,1
	224	EONT_EONT
	225
2ce64696	226	} # skip
724aa791	227
	228	__END__
	229