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

#!perl

BEGIN {
    if ($ENV{PERL_CORE}){
	chdir('t') if -d 't';
	@INC = ('.', '../lib', '../ext/B/t');
    } else {
	unshift @INC, 't';
	push @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

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

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