lib/App/Test/Generator/Emitter/Perl.pm

Structural Coverage (Approximate)

TER1 (Statement): 100.00%
TER2 (Branch): 100.00%
TER3 (LCSAJ): 100.0% (4/4)
Approximate LCSAJ segments: 45

LCSAJ Legend

● Covered — this LCSAJ path was executed during testing.

● Not covered — this LCSAJ path was never executed. These are the paths to focus on.

Multiple dots on a line indicate that multiple control-flow paths begin at that line. Hovering over any dot shows:

        start → end → jump

start – first line of the linear sequence
end – last line before control flow changes
jump – line execution jumps to next

Uncovered paths show [NOT COVERED] in the tooltip.

Mutant Testing Legend

Survived (tests missed this) Killed (tests detected this) No mutation

1: package App::Test::Generator::Emitter::Perl; 2: 3: use strict; 4: use warnings; 5: use Carp qw(croak); 6: use Readonly; 7: 8: # -------------------------------------------------- 9: # Plan key names â€” must match those emitted by 10: # App::Test::Generator::TestStrategy and 11: # App::Test::Generator::Planner 12: # -------------------------------------------------- 13: Readonly my $TEST_BASIC => 'basic_test'; 14: Readonly my $TEST_GETTER => 'getter_test'; 15: Readonly my $TEST_SETTER => 'setter_test'; 16: Readonly my $TEST_GETSET => 'getset_test'; 17: Readonly my $TEST_CHAINING => 'chaining_test'; 18: Readonly my $TEST_ERROR_HANDLING => 'error_handling_test'; 19: Readonly my $TEST_CONTEXT => 'context_tests'; 20: Readonly my $TEST_OBJECT_INJECT => 'object_injection_test'; 21: Readonly my $TEST_PREDICATE => 'predicate_test'; 22: Readonly my $TEST_BOOLEAN => 'boolean_test'; 23: Readonly my $TEST_VOID => 'void_context_test'; 24: Readonly my $TEST_BOUNDARY => 'boundary_tests'; 25: 26: # -------------------------------------------------- 27: # Input/output type strings from the schema 28: # -------------------------------------------------- 29: Readonly my $TYPE_OBJECT => 'object'; 30: Readonly my $TYPE_BOOLEAN => 'boolean'; 31: 32: our $VERSION = '0.41'; 33: 34: =head1 VERSION 35: 36: Version 0.41 37: 38: =head1 DESCRIPTION 39: 40: Emits Perl test code for a set of method schemas and their associated 41: test plans. Each method plan is translated into one or more test blocks 42: using L<Test::Most>. The emitted code is returned as a string ready to 43: be written to a C<.t> file. 44: 45: =head2 new 46: 47: Construct a new Perl emitter. 48: 49: my $emitter = App::Test::Generator::Emitter::Perl->new( 50: schema => \%schemas, 51: plans => \%plans, 52: package => 'My::Module', 53: ); 54: 55: =head3 Arguments 56: 57: =over 4 58: 59: =item * C<schema> 60: 61: A hashref of method name to schema hashref. Required. 62: 63: =item * C<plans> 64: 65: A hashref of method name to test plan hashref, as produced by 66: L<App::Test::Generator::TestStrategy> or 67: L<App::Test::Generator::Planner>. Required. 68: 69: =item * C<package> 70: 71: The Perl package name of the module under test. Required. 72: 73: =back 74: 75: =head3 Returns 76: 77: A blessed hashref. Croaks if any required argument is missing. 78: 79: =head3 API specification 80: 81: =head4 input 82: 83: { 84: schema => { type => HASHREF }, 85: plans => { type => HASHREF }, 86: package => { type => SCALAR }, 87: } 88: 89: =head4 output 90: 91: { 92: type => OBJECT, 93: isa => 'App::Test::Generator::Emitter::Perl', 94: } 95: 96: =cut 97: 98: sub new { 99: my ($class, %args) = @_; 100: 101: # All three arguments are required for meaningful emission 102: croak 'schema required' unless defined $args{schema}; 103: croak 'plans required' unless defined $args{plans}; 104: croak 'package required' unless defined $args{package}; 105: 106: # $args{package} is spliced unescaped into use_ok()/new_ok() calls 107: # in _emit_header() â€” reject anything that isn't a valid Perl 108: # package name now, rather than generating broken or injected code. 109: croak "package '$args{package}' is not a valid Perl package name" 110: unless $args{package} =~ /^[A-Za-z_]\w*(?:::[A-Za-z_]\w*)*\z/; 111: 112: return bless { 113: schema => $args{schema}, 114: plans => $args{plans}, 115: package => $args{package}, 116: }, $class; 117: } 118: 119: =head2 emit 120: 121: Generate and return the complete Perl test file source as a string, 122: including the file header, one test block per method, and the 123: C<done_testing()> footer. 124: 125: my $emitter = App::Test::Generator::Emitter::Perl->new( 126: schema => \%schemas, 127: plans => \%plans, 128: package => 'My::Module', 129: ); 130: my $test_code = $emitter->emit; 131: write_file('t/generated.t', $test_code); 132: 133: =head3 Arguments 134: 135: None beyond C<$self>. 136: 137: =head3 Returns 138: 139: A string containing the complete Perl test file source. 140: 141: =head3 Notes 142: 143: A method whose plan has the C<boundary_tests> flag set (because its 144: schema carries non-empty C<_yamltest_hints>) gets one smoke-test block 145: per hint value in C<boundary_values> and C<invalid_inputs>, calling 146: the method with that value and asserting only that the call does not 147: crash the test process. 148: 149: =head3 API specification 150: 151: =head4 input 152: 153: { 154: self => { type => OBJECT, isa => 'App::Test::Generator::Emitter::Perl' }, 155: } 156: 157: =head4 output 158: 159: { type => SCALAR } 160: 161: =cut 162: