t/relationship/core.t

   1 use strict;
   2 use warnings;
   3
   4 use Test::More;
   5 use Test::Exception;
   6 use lib qw(t/lib);
   7 use DBICTest;
   8 use DBIC::SqlMakerTest;
   9
  10 my $schema = DBICTest->init_schema();
  11 my $sdebug = $schema->storage->debug;
  12
  13 # has_a test
  14 my $cd = $schema->resultset("CD")->find(4);
  15 my ($artist) = ($INC{'DBICTest/HelperRels'}
  16                   ? $cd->artist
  17                   : $cd->search_related('artist'));
  18 is($artist->name, 'Random Boy Band', 'has_a search_related ok');
  19
  20 # has_many test with an order_by clause defined
  21 $artist = $schema->resultset("Artist")->find(1);
  22 my @cds = ($INC{'DBICTest/HelperRels'}
  23              ? $artist->cds
  24              : $artist->search_related('cds'));
  25 is( $cds[1]->title, 'Spoonful of bees', 'has_many search_related with order_by ok' );
  26
  27 # search_related with additional abstract query
  28 @cds = ($INC{'DBICTest/HelperRels'}
  29           ? $artist->cds({ title => { like => '%of%' } })
  30           : $artist->search_related('cds', { title => { like => '%of%' } } )
  31        );
  32 is( $cds[1]->title, 'Forkful of bees', 'search_related with abstract query ok' );
  33
  34 # creating a related object
  35 if ($INC{'DBICTest/HelperRels.pm'}) {
  36   $artist->add_to_cds({ title => 'Big Flop', year => 2005 });
  37 } else {
  38   my $big_flop = $artist->create_related( 'cds', {
  39       title => 'Big Flop',
  40       year => 2005,
  41   } );
  42
  43  TODO: {
  44     local $TODO = "Can't fix right now" if $DBIx::Class::VERSION < 0.09;
  45     lives_ok { $big_flop->genre} "Don't throw exception when col is not loaded after insert";
  46   };
  47 }
  48
  49 my $big_flop_cd = ($artist->search_related('cds'))[3];
  50 is( $big_flop_cd->title, 'Big Flop', 'create_related ok' );
  51
  52 { # make sure we are not making pointless select queries when a FK IS NULL
  53   my $queries = 0;
  54   $schema->storage->debugcb(sub { $queries++; });
  55   $schema->storage->debug(1);
  56   $big_flop_cd->genre; #should not trigger a select query
  57   is($queries, 0, 'No SELECT made for belongs_to if key IS NULL');
  58   $big_flop_cd->genre_inefficient; #should trigger a select query
  59   is($queries, 1, 'SELECT made for belongs_to if key IS NULL when undef_on_null_fk disabled');
  60   $schema->storage->debug($sdebug);
  61   $schema->storage->debugcb(undef);
  62 }
  63
  64 my( $rs_from_list ) = $artist->search_related_rs('cds');
  65 isa_ok( $rs_from_list, 'DBIx::Class::ResultSet', 'search_related_rs in list context returns rs' );
  66
  67 ( $rs_from_list ) = $artist->cds_rs();
  68 isa_ok( $rs_from_list, 'DBIx::Class::ResultSet', 'relation_rs in list context returns rs' );
  69
  70 # count_related
  71 is( $artist->count_related('cds'), 4, 'count_related ok' );
  72
  73 # set_from_related
  74 my $track = $schema->resultset("Track")->create( {
  75   trackid => 1,
  76   cd => 3,
  77   position => 98,
  78   title => 'Hidden Track'
  79 } );
  80 $track->set_from_related( cd => $cd );
  81
  82 # has_relationship
  83 ok(! $track->has_relationship( 'foo' ), 'Track has no relationship "foo"');
  84 ok($track->has_relationship( 'disc' ), 'Track has relationship "disk"' );
  85
  86 is($track->disc->cdid, 4, 'set_from_related ok, including alternative accessor' );
  87
  88 $track->set_from_related( cd => undef );
  89
  90 ok( !defined($track->cd), 'set_from_related with undef ok');
  91
  92 TODO: {
  93     local $TODO = 'accessing $object->rel and set_from_related';
  94     my $track = $schema->resultset("Track")->new( {} );
  95     $track->cd;
  96     $track->set_from_related( cd => $cd );
  97     ok ($track->cd, 'set_from_related ok after using the accessor' );
  98 };
  99
 100 # update_from_related, the same as set_from_related, but it calls update afterwards
 101 $track = $schema->resultset("Track")->create( {
 102   trackid => 2,
 103   cd => 3,
 104   title => 'Hidden Track 2'
 105 } );
 106 $track->update_from_related( cd => $cd );
 107
 108 my $t_cd = ($schema->resultset("Track")->search( cd => 4, title => 'Hidden Track 2' ))[0]->cd;
 109
 110 is( $t_cd->cdid, 4, 'update_from_related ok' );
 111
 112 # find_or_create_related with an existing record
 113 $cd = $artist->find_or_create_related( 'cds', { title => 'Big Flop' } );
 114 is( $cd->year, 2005, 'find_or_create_related on existing record ok' );
 115
 116 # find_or_create_related creating a new record
 117 $cd = $artist->find_or_create_related( 'cds', {
 118   title => 'Greatest Hits',
 119   year => 2006,
 120 } );
 121 is( $cd->title, 'Greatest Hits', 'find_or_create_related new record ok' );
 122
 123 @cds = $artist->search_related('cds');
 124 is( ($artist->search_related('cds'))[4]->title, 'Greatest Hits', 'find_or_create_related new record search ok' );
 125
 126 $artist->delete_related( cds => { title => 'Greatest Hits' });
 127 cmp_ok( $schema->resultset("CD")->search( title => 'Greatest Hits' ), '==', 0, 'delete_related ok' );
 128
 129 # find_or_new_related with an existing record
 130 $cd = $artist->find_or_new_related( 'cds', { title => 'Big Flop' } );
 131 is( $cd->year, 2005, 'find_or_new_related on existing record ok' );
 132 ok( $cd->in_storage, 'find_or_new_related on existing record: is in_storage' );
 133
 134 # find_or_new_related instantiating a new record
 135 $cd = $artist->find_or_new_related( 'cds', {
 136   title => 'Greatest Hits 2: Louder Than Ever',
 137   year => 2007,
 138 } );
 139 is( $cd->title, 'Greatest Hits 2: Louder Than Ever', 'find_or_new_related new record ok' );
 140 is( $cd->in_storage, 0, 'find_or_new_related on a new record: not in_storage' );
 141
 142 $cd->artist(undef);
 143 my $newartist = $cd->find_or_new_related( 'artist', {
 144   name => 'Random Boy Band Two',
 145   artistid => 200,
 146 } );
 147 is($newartist->name, 'Random Boy Band Two', 'find_or_new_related new artist record with id');
 148 is($newartist->id, 200, 'find_or_new_related new artist id set');
 149
 150 lives_ok(
 151     sub {
 152         my $new_bookmark = $schema->resultset("Bookmark")->new_result( {} );
 153         my $new_related_link = $new_bookmark->new_related( 'link', {} );
 154     },
 155     'No back rel'
 156 );
 157
 158
 159 TODO: {
 160   local $TODO = "relationship checking needs fixing";
 161   # try to add a bogus relationship using the wrong cols
 162   throws_ok {
 163       DBICTest::Schema::Artist->add_relationship(
 164           tracks => 'DBICTest::Schema::Track',
 165           { 'foreign.cd' => 'self.cdid' }
 166       );
 167   } qr/Unknown column/, 'failed when creating a rel with invalid key, ok';
 168 }
 169
 170 # another bogus relationship using no join condition
 171 throws_ok {
 172     DBICTest::Schema::Artist->add_relationship( tracks => 'DBICTest::Track' );
 173 } qr/join condition/, 'failed when creating a rel without join condition, ok';
 174
 175 # many_to_many helper tests
 176 $cd = $schema->resultset("CD")->find(1);
 177 my @producers = $cd->producers();
 178 is( $producers[0]->name, 'Matt S Trout', 'many_to_many ok' );
 179 is( $cd->producers_sorted->next->name, 'Bob The Builder',
 180     'sorted many_to_many ok' );
 181 is( $cd->producers_sorted(producerid => 3)->next->name, 'Fred The Phenotype',
 182     'sorted many_to_many with search condition ok' );
 183
 184 $cd = $schema->resultset('CD')->find(2);
 185 my $prod_rs = $cd->producers();
 186 my $prod_before_count = $schema->resultset('Producer')->count;
 187 is( $prod_rs->count, 0, "CD doesn't yet have any producers" );
 188 my $prod = $schema->resultset('Producer')->find(1);
 189 $cd->add_to_producers($prod);
 190 is( $prod_rs->count(), 1, 'many_to_many add_to_$rel($obj) count ok' );
 191 is( $prod_rs->first->name, 'Matt S Trout',
 192     'many_to_many add_to_$rel($obj) ok' );
 193 $cd->remove_from_producers($prod);
 194 $cd->add_to_producers($prod, {attribute => 1});
 195 is( $prod_rs->count(), 1, 'many_to_many add_to_$rel($obj, $link_vals) count ok' );
 196 is( $cd->cd_to_producer->first->attribute, 1, 'many_to_many $link_vals ok');
 197 $cd->remove_from_producers($prod);
 198 $cd->set_producers([$prod], {attribute => 2});
 199 is( $prod_rs->count(), 1, 'many_to_many set_$rel($obj, $link_vals) count ok' );
 200 is( $cd->cd_to_producer->first->attribute, 2, 'many_to_many $link_vals ok');
 201 $cd->remove_from_producers($prod);
 202 is( $schema->resultset('Producer')->find(1)->name, 'Matt S Trout',
 203     "producer object exists after remove of link" );
 204 is( $prod_rs->count, 0, 'many_to_many remove_from_$rel($obj) ok' );
 205 $cd->add_to_producers({ name => 'Testy McProducer' });
 206 is( $schema->resultset('Producer')->count, $prod_before_count+1,
 207     'add_to_$rel($hash) inserted a new producer' );
 208 is( $prod_rs->count(), 1, 'many_to_many add_to_$rel($hash) count ok' );
 209 is( $prod_rs->first->name, 'Testy McProducer',
 210     'many_to_many add_to_$rel($hash) ok' );
 211 $cd->add_to_producers({ name => 'Jack Black' });
 212 is( $prod_rs->count(), 2, 'many_to_many add_to_$rel($hash) count ok' );
 213 $cd->set_producers($schema->resultset('Producer')->all);
 214 is( $cd->producers->count(), $prod_before_count+2,
 215     'many_to_many set_$rel(@objs) count ok' );
 216 $cd->set_producers($schema->resultset('Producer')->find(1));
 217 is( $cd->producers->count(), 1, 'many_to_many set_$rel($obj) count ok' );
 218 $cd->set_producers([$schema->resultset('Producer')->all]);
 219 is( $cd->producers->count(), $prod_before_count+2,
 220     'many_to_many set_$rel(\@objs) count ok' );
 221 $cd->set_producers([$schema->resultset('Producer')->find(1)]);
 222 is( $cd->producers->count(), 1, 'many_to_many set_$rel([$obj]) count ok' );
 223
 224 throws_ok {
 225   $cd->remove_from_producers({ fake => 'hash' })
 226 } qr/needs an object/, 'remove_from_$rel($hash) dies correctly';
 227
 228 throws_ok {
 229   $cd->add_to_producers()
 230 } qr/needs an object or hashref/, 'add_to_$rel(undef) dies correctly';
 231
 232 # many_to_many stresstest
 233 my $twokey = $schema->resultset('TwoKeys')->find(1,1);
 234 my $fourkey = $schema->resultset('FourKeys')->find(1,2,3,4);
 235
 236 is( $twokey->fourkeys->count, 0, 'twokey has no fourkeys' );
 237 $twokey->add_to_fourkeys($fourkey, { autopilot => 'engaged' });
 238 my $got_fourkey = $twokey->fourkeys({ sensors => 'online' })->first;
 239 is( $twokey->fourkeys->count, 1, 'twokey has one fourkey' );
 240 is( $got_fourkey->$_, $fourkey->$_,
 241     'fourkeys row has the correct value for column '.$_ )
 242   for (qw(foo bar hello goodbye sensors));
 243 $twokey->remove_from_fourkeys($fourkey);
 244 is( $twokey->fourkeys->count, 0, 'twokey has no fourkeys' );
 245 is( $twokey->fourkeys_to_twokeys->count, 0,
 246     'twokey has no links to fourkey' );
 247
 248
 249 my $undef_artist_cd = $schema->resultset("CD")->new_result({ 'title' => 'badgers', 'year' => 2007 });
 250 is($undef_artist_cd->has_column_loaded('artist'), '', 'FK not loaded');
 251 is($undef_artist_cd->search_related('artist')->count, 0, '0=1 search when FK does not exist and object not yet in db');
 252 lives_ok {
 253      $undef_artist_cd->related_resultset('artist')->new({name => 'foo'});
 254 } 'Object created on a resultset related to not yet inserted object';
 255 lives_ok{
 256   $schema->resultset('Artwork')->new_result({})->cd;
 257 } 'undef_on_null_fk does not choke on empty conds';
 258
 259 my $def_artist_cd = $schema->resultset("CD")->new_result({ 'title' => 'badgers', 'year' => 2007, artist => undef });
 260 is($def_artist_cd->has_column_loaded('artist'), 1, 'FK loaded');
 261 is($def_artist_cd->search_related('artist')->count, 0, 'closed search on null FK');
 262
 263 # test undirected many-to-many relationship (e.g. "related artists")
 264 my $undir_maps = $schema->resultset("Artist")
 265                           ->search ({artistid => 1})
 266                             ->search_related ('artist_undirected_maps');
 267 is($undir_maps->count, 1, 'found 1 undirected map for artist 1');
 268 is_same_sql_bind (
 269   $undir_maps->as_query,
 270   '(
 271     SELECT artist_undirected_maps.id1, artist_undirected_maps.id2
 272       FROM artist me
 273       JOIN artist_undirected_map artist_undirected_maps
 274         ON artist_undirected_maps.id1 = me.artistid OR artist_undirected_maps.id2 = me.artistid
 275     WHERE ( artistid = ? )
 276   )',
 277   [[artistid => 1]],
 278   'expected join sql produced',
 279 );
 280
 281 $undir_maps = $schema->resultset("Artist")->find(2)->artist_undirected_maps;
 282 is($undir_maps->count, 1, 'found 1 undirected map for artist 2');
 283
 284 my $mapped_rs = $undir_maps->search_related('mapped_artists');
 285
 286 my @art = $mapped_rs->all;
 287
 288 cmp_ok(@art, '==', 2, "Both artist returned from map");
 289
 290 my $searched = $mapped_rs->search({'mapped_artists.artistid' => {'!=', undef}});
 291
 292 cmp_ok($searched->count, '==', 2, "Both artist returned from map after adding another condition");
 293
 294 # check join through cascaded has_many relationships (also empty has_many rels)
 295 $artist = $schema->resultset("Artist")->find(1);
 296 my $trackset = $artist->cds->search_related('tracks');
 297 is($trackset->count, 10, "Correct number of tracks for artist");
 298 is($trackset->all, 10, "Correct number of track objects for artist");
 299
 300 # now see about updating eveything that belongs to artist 2 to artist 3
 301 $artist = $schema->resultset("Artist")->find(2);
 302 my $nartist = $schema->resultset("Artist")->find(3);
 303 cmp_ok($artist->cds->count, '==', 1, "Correct orig #cds for artist");
 304 cmp_ok($nartist->cds->count, '==', 1, "Correct orig #cds for artist");
 305 $artist->cds->update({artist => $nartist->id});
 306 cmp_ok($artist->cds->count, '==', 0, "Correct new #cds for artist");
 307 cmp_ok($nartist->cds->count, '==', 2, "Correct new #cds for artist");
 308
 309 # check if is_foreign_key_constraint attr is set
 310 my $rs_normal = $schema->source('Track');
 311 my $relinfo = $rs_normal->relationship_info ('cd');
 312 cmp_ok($relinfo->{attrs}{is_foreign_key_constraint}, '==', 1, "is_foreign_key_constraint defined for belongs_to relationships.");
 313
 314 my $rs_overridden = $schema->source('ForceForeign');
 315 my $relinfo_with_attr = $rs_overridden->relationship_info ('cd_3');
 316 cmp_ok($relinfo_with_attr->{attrs}{is_foreign_key_constraint}, '==', 0, "is_foreign_key_constraint defined for belongs_to relationships with attr.");
 317
 318 # check that relationships below left join relationships are forced to left joins
 319 # when traversing multiple belongs_to
 320 my $cds = $schema->resultset("CD")->search({ 'me.cdid' => 5 }, { join => { single_track => 'cd' } });
 321 is($cds->count, 1, "subjoins under left joins force_left (string)");
 322
 323 $cds = $schema->resultset("CD")->search({ 'me.cdid' => 5 }, { join => { single_track => ['cd'] } });
 324 is($cds->count, 1, "subjoins under left joins force_left (arrayref)");
 325
 326 $cds = $schema->resultset("CD")->search({ 'me.cdid' => 5 }, { join => { single_track => { cd => {} } } });
 327 is($cds->count, 1, "subjoins under left joins force_left (hashref)");
 328
 329 done_testing;