t/unit_core_component_loading.t

   1 # 2 initial tests, and 6 per component in the loop below
   2 # (do not forget to update the number of components in test 3 as well)
   3 # 5 extra tests for the loading options
   4 use Test::More tests => 2 + 6 * 24 + 5;
   5
   6 use strict;
   7 use warnings;
   8
   9 use File::Spec;
  10 use File::Path;
  11
  12 my $libdir = 'test_trash';
  13 unshift(@INC, $libdir);
  14
  15 my $appclass = 'TestComponents';
  16 my @components = (
  17     { type => 'Controller', prefix => 'C', name => 'Bar' },
  18     { type => 'Controller', prefix => 'C', name => 'Foo::Bar' },
  19     { type => 'Controller', prefix => 'C', name => 'Foo::Foo::Bar' },
  20     { type => 'Controller', prefix => 'C', name => 'Foo::Foo::Foo::Bar' },
  21     { type => 'Controller', prefix => 'Controller', name => 'Bar::Bar::Bar::Foo' },
  22     { type => 'Controller', prefix => 'Controller', name => 'Bar::Bar::Foo' },
  23     { type => 'Controller', prefix => 'Controller', name => 'Bar::Foo' },
  24     { type => 'Controller', prefix => 'Controller', name => 'Foo' },
  25     { type => 'Model', prefix => 'M', name => 'Bar' },
  26     { type => 'Model', prefix => 'M', name => 'Foo::Bar' },
  27     { type => 'Model', prefix => 'M', name => 'Foo::Foo::Bar' },
  28     { type => 'Model', prefix => 'M', name => 'Foo::Foo::Foo::Bar' },
  29     { type => 'Model', prefix => 'Model', name => 'Bar::Bar::Bar::Foo' },
  30     { type => 'Model', prefix => 'Model', name => 'Bar::Bar::Foo' },
  31     { type => 'Model', prefix => 'Model', name => 'Bar::Foo' },
  32     { type => 'Model', prefix => 'Model', name => 'Foo' },
  33     { type => 'View', prefix => 'V', name => 'Bar' },
  34     { type => 'View', prefix => 'V', name => 'Foo::Bar' },
  35     { type => 'View', prefix => 'V', name => 'Foo::Foo::Bar' },
  36     { type => 'View', prefix => 'V', name => 'Foo::Foo::Foo::Bar' },
  37     { type => 'View', prefix => 'View', name => 'Bar::Bar::Bar::Foo' },
  38     { type => 'View', prefix => 'View', name => 'Bar::Bar::Foo' },
  39     { type => 'View', prefix => 'View', name => 'Bar::Foo' },
  40     { type => 'View', prefix => 'View', name => 'Foo' },
  41 );
  42
  43 sub write_component_file {
  44   my ($dir_list, $module_name, $content) = @_;
  45
  46   my $dir  = File::Spec->catdir(@$dir_list);
  47   my $file = File::Spec->catfile($dir, $module_name . '.pm');
  48
  49   mkpath(join(q{/}, @$dir_list) );
  50   open(my $fh, '>', $file) or die "Could not open file $file for writing: $!";
  51   print $fh $content;
  52   close $fh;
  53 }
  54
  55 sub make_component_file {
  56     my ($type, $prefix, $name) = @_;
  57
  58     my $compbase = "Catalyst::${type}";
  59     my $fullname = "${appclass}::${prefix}::${name}";
  60     my @namedirs = split(/::/, $name);
  61     my $name_final = pop(@namedirs);
  62     my @dir_list = ($libdir, $appclass, $prefix, @namedirs);
  63
  64     write_component_file(\@dir_list, $name_final, <<EOF);
  65 package $fullname;
  66 use NEXT;
  67 use base '$compbase';
  68 sub COMPONENT {
  69     my \$self = shift->NEXT::COMPONENT(\@_);
  70     no strict 'refs';
  71     *{\__PACKAGE__ . "::whoami"} = sub { return \__PACKAGE__; };
  72     \$self;
  73 }
  74 1;
  75
  76 EOF
  77 }
  78
  79 foreach my $component (@components) {
  80     make_component_file($component->{type},
  81                         $component->{prefix},
  82                         $component->{name});
  83 }
  84
  85 eval "package $appclass; use Catalyst; __PACKAGE__->setup";
  86
  87 can_ok( $appclass, 'components');
  88
  89 my $complist = $appclass->components;
  90
  91 # the +1 below is for the app class itself
  92 is(scalar keys %$complist, 24+1, "Correct number of components loaded");
  93
  94 foreach (keys %$complist) {
  95
  96     # Skip the component which happens to be the app itself
  97     next if $_ eq $appclass;
  98
  99     my $instance = $appclass->component($_);
 100     isa_ok($instance, $_);
 101     can_ok($instance, 'whoami');
 102     is($instance->whoami, $_);
 103
 104     if($_ =~ /^${appclass}::(?:V|View)::(.*)/) {
 105         my $moniker = $1;
 106         isa_ok($instance, 'Catalyst::View');
 107         can_ok($appclass->view($moniker), 'whoami');
 108         is($appclass->view($moniker)->whoami, $_);
 109     }
 110     elsif($_ =~ /^${appclass}::(?:M|Model)::(.*)/) {
 111         my $moniker = $1;
 112         isa_ok($instance, 'Catalyst::Model');
 113         can_ok($appclass->model($moniker), 'whoami');
 114         is($appclass->model($moniker)->whoami, $_);
 115     }
 116     elsif($_ =~ /^${appclass}::(?:C|Controller)::(.*)/) {
 117         my $moniker = $1;
 118         isa_ok($instance, 'Catalyst::Controller');
 119         can_ok($appclass->controller($moniker), 'whoami');
 120         is($appclass->controller($moniker)->whoami, $_);
 121     }
 122     else {
 123         die "Something is wrong with this test, this should"
 124             . " have been unreachable";
 125     }
 126 }
 127
 128 rmtree($libdir);
 129
 130 # test extra component loading options
 131
 132 $appclass = 'ExtraOptions';
 133 push @components, { type => 'View', prefix => 'Extra', name => 'Foo' };
 134
 135 foreach my $component (@components) {
 136     make_component_file($component->{type},
 137                         $component->{prefix},
 138                         $component->{name});
 139 }
 140
 141 eval qq(
 142 package $appclass;
 143 use Catalyst;
 144 __PACKAGE__->config->{ setup_components } = {
 145     search_extra => [ '::Extra' ],
 146     except       => [ "${appclass}::Controller::Foo" ]
 147 };
 148 __PACKAGE__->setup;
 149 );
 150
 151 can_ok( $appclass, 'components');
 152
 153 $complist = $appclass->components;
 154
 155 is(scalar keys %$complist, 24+1, "Correct number of components loaded");
 156
 157 ok( !exists $complist->{ "${appclass}::Controller::Foo" }, 'Controller::Foo was skipped' );
 158 ok( exists $complist->{ "${appclass}::Extra::Foo" }, 'Extra::Foo was loaded' );
 159
 160 rmtree($libdir);
 161
 162 $appclass = "ComponentOnce";
 163
 164 write_component_file([$libdir, $appclass, 'Model'], 'TopLevel', <<EOF);
 165 package ${appclass}::Model::TopLevel;
 166 use base 'Catalyst::Model';
 167 sub COMPONENT {
 168
 169     my \$self = shift->NEXT::COMPONENT(\@_);
 170     no strict 'refs';
 171     *{\__PACKAGE__ . "::whoami"} = sub { return \__PACKAGE__; };
 172     \$self;
 173 }
 174
 175 package ${appclass}::Model::TopLevel::Nested;
 176
 177 sub COMPONENT { die "COMPONENT called in the wrong order!"; }
 178
 179 1;
 180
 181 EOF
 182
 183 write_component_file([$libdir, $appclass, 'Model', 'TopLevel'], 'Nested', <<EOF);
 184 package ${appclass}::Model::TopLevel::Nested;
 185 use base 'Catalyst::Model';
 186
 187 no warnings 'redefine';
 188 sub COMPONENT { return shift->NEXT::COMPONENT(\@_); }
 189 1;
 190
 191 EOF
 192
 193 eval "package $appclass; use Catalyst; __PACKAGE__->setup";
 194
 195 is($@, '', "Didn't load component twice");
 196
 197 rmtree($libdir);