t/25backcompat_v4.t

   1 use strict;
   2 use warnings;
   3 use Test::More;
   4 use Test::Exception;
   5 use File::Path qw/rmtree make_path/;
   6 use Class::Unload;
   7 use File::Temp qw/tempfile tempdir/;
   8 use IO::File;
   9 use File::Slurp 'slurp';
  10 use DBIx::Class::Schema::Loader ();
  11 use Lingua::EN::Inflect::Number ();
  12 use lib qw(t/lib);
  13 use make_dbictest_db_with_unique;
  14
  15 my $DUMP_DIR = './t/_common_dump';
  16 rmtree $DUMP_DIR;
  17 my $SCHEMA_CLASS = 'DBIXCSL_Test::Schema';
  18
  19 sub class_content_like;
  20
  21 # test dynamic schema in 0.04006 mode
  22 {
  23     my $res = run_loader();
  24     my $warning = $res->{warnings}[0];
  25
  26     like $warning, qr/dynamic schema/i,
  27         'dynamic schema in backcompat mode detected';
  28     like $warning, qr/run in 0\.04006 mode/i,
  29         'dynamic schema in 0.04006 mode warning';
  30     like $warning, qr/DBIx::Class::Schema::Loader::Manual::UpgradingFromV4/,
  31         'warning refers to upgrading doc';
  32
  33     run_v4_tests($res);
  34 }
  35
  36 # setting naming accessor on dynamic schema should disable warning (even when
  37 # we're setting it to 'v4' .)
  38 {
  39     my $res = run_loader(naming => 'v4');
  40     is_deeply $res->{warnings}, [], 'no warnings with naming attribute set';
  41     run_v4_tests($res);
  42 }
  43
  44 # test upgraded dynamic schema
  45 {
  46     my $res = run_loader(naming => 'current');
  47     is_deeply $res->{warnings}, [], 'no warnings with naming attribute set';
  48     run_v5_tests($res);
  49 }
  50
  51 # test upgraded dynamic schema with external content loaded
  52 {
  53     my $temp_dir = setup_load_external({
  54         Quuxs => 'Bazs',
  55         Bar   => 'Foos',
  56     });
  57
  58     my $res = run_loader(naming => 'current');
  59     my $schema = $res->{schema};
  60
  61     is scalar @{ $res->{warnings} }, 1,
  62 'correct nummber of warnings for upgraded dynamic schema with external ' .
  63 'content for unsingularized Result.';
  64
  65     my $warning = $res->{warnings}[0];
  66     like $warning, qr/Detected external content/i,
  67         'detected external content warning';
  68
  69     lives_and { is $schema->resultset('Quux')->find(1)->a_method, 'hlagh' }
  70 'external custom content for unsingularized Result was loaded by upgraded ' .
  71 'dynamic Schema';
  72
  73     lives_and { isa_ok $schema->resultset('Quux')->find(1)->bazrel,
  74         $res->{classes}{bazs} }
  75         'unsingularized class names in external content are translated';
  76
  77     lives_and { is $schema->resultset('Bar')->find(1)->a_method, 'hlagh' }
  78 'external content from unchanged Result class';
  79
  80     lives_and { isa_ok $schema->resultset('Bar')->find(1)->foorel,
  81         $res->{classes}{foos} }
  82 'unsingularized class names in external content from unchanged Result class ' .
  83 'names are translated';
  84
  85     run_v5_tests($res);
  86 }
  87
  88 # test upgraded dynamic schema with use_namespaces with external content loaded
  89 {
  90     my $temp_dir = setup_load_external({
  91         Quuxs => 'Bazs',
  92         Bar   => 'Foos',
  93     });
  94
  95     my $res = run_loader(naming => 'current', use_namespaces => 1);
  96     my $schema = $res->{schema};
  97
  98     is scalar @{ $res->{warnings} }, 2,
  99 'correct nummber of warnings for upgraded dynamic schema with external ' .
 100 'content for unsingularized Result with use_namespaces.';
 101
 102     my $warning = $res->{warnings}[0];
 103     like $warning, qr/Detected external content/i,
 104         'detected external content warning';
 105
 106     lives_and { is $schema->resultset('Quux')->find(1)->a_method, 'hlagh' }
 107 'external custom content for unsingularized Result was loaded by upgraded ' .
 108 'dynamic Schema';
 109
 110     lives_and { isa_ok $schema->resultset('Quux')->find(1)->bazrel,
 111         $res->{classes}{bazs} }
 112         'unsingularized class names in external content are translated';
 113
 114     lives_and { isa_ok $schema->resultset('Bar')->find(1)->foorel,
 115         $res->{classes}{foos} }
 116 'unsingularized class names in external content from unchanged Result class ' .
 117 'names are translated';
 118
 119     run_v5_tests($res);
 120 }
 121
 122 # test upgraded static schema with external content loaded
 123 {
 124     clean_dumpdir();
 125
 126     my $temp_dir = setup_load_external({
 127         Quuxs => 'Bazs',
 128         Bar   => 'Foos',
 129     });
 130
 131     write_v4_schema_pm();
 132
 133     my $res = run_loader(static => 1, naming => 'current');
 134     my $schema = $res->{schema};
 135
 136     run_v5_tests($res);
 137
 138     lives_and { is $schema->resultset('Quux')->find(1)->a_method, 'hlagh' }
 139 'external custom content for unsingularized Result was loaded by upgraded ' .
 140 'static Schema';
 141
 142     lives_and { isa_ok $schema->resultset('Quux')->find(1)->bazrel,
 143         $res->{classes}{bazs} }
 144         'unsingularized class names in external content are translated';
 145
 146     lives_and { isa_ok $schema->resultset('Bar')->find(1)->foorel,
 147         $res->{classes}{foos} }
 148 'unsingularized class names in external content from unchanged Result class ' .
 149 'names are translated in static schema';
 150
 151     class_content_like $schema, $res->{classes}{quuxs}, qr/package ${SCHEMA_CLASS}::Quux;/,
 152 'package line translated correctly from external custom content in static dump';
 153
 154     class_content_like $schema, $res->{classes}{quuxs}, qr/sub a_method { 'hlagh' }/,
 155 'external custom content loaded into static dump correctly';
 156 }
 157
 158 # test running against v4 schema without upgrade, twice, then upgrade
 159 {
 160     clean_dumpdir();
 161     write_v4_schema_pm();
 162     my $res = run_loader(static => 1);
 163     my $warning = $res->{warnings}[1];
 164
 165     like $warning, qr/static schema/i,
 166         'static schema in backcompat mode detected';
 167     like $warning, qr/0.04006/,
 168         'correct version detected';
 169     like $warning, qr/DBIx::Class::Schema::Loader::Manual::UpgradingFromV4/,
 170         'refers to upgrading doc';
 171
 172     is scalar @{ $res->{warnings} }, 4,
 173         'correct number of warnings for static schema in backcompat mode';
 174
 175     run_v4_tests($res);
 176
 177     add_custom_content($res->{schema}, {
 178         Quuxs => 'Bazs'
 179     });
 180
 181     # Rerun the loader in backcompat mode to make sure it's still in backcompat
 182     # mode.
 183     $res = run_loader(static => 1);
 184     run_v4_tests($res);
 185
 186     # now upgrade the schema
 187     $res = run_loader(
 188         static => 1,
 189         naming => 'current',
 190         use_namespaces => 1
 191     );
 192     my $schema = $res->{schema};
 193
 194     like $res->{warnings}[0], qr/Dumping manual schema/i,
 195         'correct warnings on upgrading static schema (with "naming" set)';
 196
 197     like $res->{warnings}[1], qr/dump completed/i,
 198         'correct warnings on upgrading static schema (with "naming" set)';
 199
 200     is scalar @{ $res->{warnings} }, 2,
 201 'correct number of warnings on upgrading static schema (with "naming" set)'
 202         or diag @{ $res->{warnings} };
 203
 204     run_v5_tests($res);
 205
 206     is result_count('Result'), 4,
 207         'un-singularized results were replaced during upgrade';
 208
 209     # check that custom content was preserved
 210     lives_and { is $schema->resultset('Quux')->find(1)->b_method, 'dongs' }
 211         'custom content was carried over from un-singularized Result';
 212
 213     lives_and { isa_ok $schema->resultset('Quux')->find(1)->bazrel,
 214         $res->{classes}{bazs} }
 215         'unsingularized class names in custom content are translated';
 216
 217     class_content_like $schema, $res->{classes}{quuxs}, qr/sub b_method { 'dongs' }/,
 218 'custom content from unsingularized Result loaded into static dump correctly';
 219 }
 220
 221 # test running against v4 schema without upgrade, then upgrade with
 222 # use_namespaces not explicitly set
 223 {
 224     clean_dumpdir();
 225     write_v4_schema_pm();
 226     my $res = run_loader(static => 1);
 227     my $warning = $res->{warnings}[1];
 228
 229     like $warning, qr/static schema/i,
 230         'static schema in backcompat mode detected';
 231     like $warning, qr/0.04006/,
 232         'correct version detected';
 233     like $warning, qr/DBIx::Class::Schema::Loader::Manual::UpgradingFromV4/,
 234         'refers to upgrading doc';
 235
 236     is scalar @{ $res->{warnings} }, 4,
 237         'correct number of warnings for static schema in backcompat mode';
 238
 239     run_v4_tests($res);
 240
 241     add_custom_content($res->{schema}, {
 242         Quuxs => 'Bazs'
 243     });
 244
 245     # now upgrade the schema
 246     $res = run_loader(
 247         static => 1,
 248         naming => 'current'
 249     );
 250     my $schema = $res->{schema};
 251
 252     like $res->{warnings}[0], qr/load_classes/i,
 253 'correct warnings on upgrading static schema (with "naming" set and ' .
 254 'use_namespaces not set)';
 255
 256     like $res->{warnings}[1], qr/Dumping manual schema/i,
 257 'correct warnings on upgrading static schema (with "naming" set and ' .
 258 'use_namespaces not set)';
 259
 260     like $res->{warnings}[2], qr/dump completed/i,
 261 'correct warnings on upgrading static schema (with "naming" set and ' .
 262 'use_namespaces not set)';
 263
 264     is scalar @{ $res->{warnings} }, 3,
 265 'correct number of warnings on upgrading static schema (with "naming" set)'
 266         or diag @{ $res->{warnings} };
 267
 268     run_v5_tests($res);
 269
 270     is result_count(), 4,
 271         'un-singularized results were replaced during upgrade';
 272
 273     # check that custom content was preserved
 274     lives_and { is $schema->resultset('Quux')->find(1)->b_method, 'dongs' }
 275         'custom content was carried over from un-singularized Result';
 276
 277     lives_and { isa_ok $schema->resultset('Quux')->find(1)->bazrel,
 278         $res->{classes}{bazs} }
 279         'unsingularized class names in custom content are translated';
 280
 281     class_content_like $schema, $res->{classes}{quuxs}, qr/sub b_method { 'dongs' }/,
 282 'custom content from unsingularized Result loaded into static dump correctly';
 283 }
 284
 285 # test running against v4 schema with load_namespaces, upgrade to v5 but
 286 # downgrade to load_classes, with external content
 287 {
 288     clean_dumpdir();
 289
 290     my $temp_dir = setup_load_external({
 291         Quuxs => 'Bazs',
 292         Bar   => 'Foos',
 293     }, { result_namespace => 'Result' });
 294
 295     write_v4_schema_pm(use_namespaces => 1);
 296
 297     my $res = run_loader(static => 1);
 298     my $warning = $res->{warnings}[0];
 299
 300     like $warning, qr/static schema/i,
 301         'static schema in backcompat mode detected';
 302     like $warning, qr/0.04006/,
 303         'correct version detected';
 304     like $warning, qr/DBIx::Class::Schema::Loader::Manual::UpgradingFromV4/,
 305         'refers to upgrading doc';
 306
 307     is scalar @{ $res->{warnings} }, 3,
 308         'correct number of warnings for static schema in backcompat mode';
 309
 310     run_v4_tests($res);
 311
 312     is $res->{classes}{quuxs}, 'DBIXCSL_Test::Schema::Result::Quuxs',
 313         'use_namespaces in backcompat mode';
 314
 315     add_custom_content($res->{schema}, {
 316         Quuxs => 'Bazs',
 317     }, {
 318         result_namespace => 'Result',
 319         rel_name_map => { QuuxBaz => 'bazrel2' },
 320     });
 321
 322     # now upgrade the schema to v5 but downgrade to load_classes
 323     $res = run_loader(
 324         static => 1,
 325         naming => 'current',
 326         use_namespaces => 0,
 327     );
 328     my $schema = $res->{schema};
 329
 330     like $res->{warnings}[0], qr/Dumping manual schema/i,
 331 'correct warnings on upgrading static schema (with "naming" set and ' .
 332 'use_namespaces => 0)';
 333
 334     like $res->{warnings}[1], qr/dump completed/i,
 335 'correct warnings on upgrading static schema (with "naming" set and ' .
 336 'use_namespaces => 0)';
 337
 338     is scalar @{ $res->{warnings} }, 2,
 339 'correct number of warnings on upgrading static schema (with "naming" set)'
 340         or diag @{ $res->{warnings} };
 341
 342     run_v5_tests($res);
 343
 344     is result_count(), 4,
 345 'un-singularized results were replaced during upgrade and Result dir removed';
 346
 347     ok ((not -d result_dir('Result')),
 348         'Result dir was removed for load_classes downgrade');
 349
 350     is $res->{classes}{quuxs}, 'DBIXCSL_Test::Schema::Quux',
 351         'load_classes in upgraded mode';
 352
 353     # check that custom and external content was preserved
 354     lives_and { is $schema->resultset('Quux')->find(1)->b_method, 'dongs' }
 355         'custom content was carried over from un-singularized Result';
 356
 357     lives_and { is $schema->resultset('Quux')->find(1)->a_method, 'hlagh' }
 358         'external content was carried over from un-singularized Result';
 359
 360     lives_and { isa_ok $schema->resultset('Quux')->find(1)->bazrel2,
 361         $res->{classes}{bazs} }
 362         'unsingularized class names in custom content are translated';
 363
 364     lives_and { isa_ok $schema->resultset('Quux')->find(1)->bazrel,
 365         $res->{classes}{bazs} }
 366         'unsingularized class names in external content are translated';
 367
 368     lives_and { isa_ok $schema->resultset('Bar')->find(1)->foorel,
 369         $res->{classes}{foos} }
 370 'unsingularized class names in external content from unchanged Result class ' .
 371 'names are translated in static schema';
 372
 373     class_content_like $schema, $res->{classes}{quuxs}, qr/sub a_method { 'hlagh' }/,
 374 'external content from unsingularized Result loaded into static dump correctly';
 375
 376     class_content_like $schema, $res->{classes}{quuxs}, qr/sub b_method { 'dongs' }/,
 377 'custom   content from unsingularized Result loaded into static dump correctly';
 378 }
 379
 380 # test a regular schema with use_namespaces => 0 upgraded to
 381 # use_namespaces => 1
 382 {
 383     my $res = run_loader(
 384         clean_dumpdir => 1,
 385         static => 1,
 386         use_namespaces => 0,
 387     );
 388
 389     like $res->{warnings}[0], qr/Dumping manual schema/i,
 390 'correct warnings on dumping static schema with use_namespaces => 0';
 391
 392     like $res->{warnings}[1], qr/dump completed/i,
 393 'correct warnings on dumping static schema with use_namespaces => 0';
 394
 395     is scalar @{ $res->{warnings} }, 2,
 396 'correct number of warnings on dumping static schema with use_namespaces => 0'
 397         or diag @{ $res->{warnings} };
 398
 399     run_v5_tests($res);
 400
 401     my $schema   = $res->{schema};
 402     add_custom_content($res->{schema}, {
 403         Quux => 'Baz'
 404     });
 405
 406     # test that with no use_namespaces option, there is a warning and
 407     # load_classes is preserved
 408     $res = run_loader(static => 1);
 409
 410     like $res->{warnings}[0], qr/load_classes/i,
 411 'correct warnings on re-dumping static schema with load_classes';
 412
 413     like $res->{warnings}[1], qr/Dumping manual schema/i,
 414 'correct warnings on re-dumping static schema with load_classes';
 415
 416     like $res->{warnings}[2], qr/dump completed/i,
 417 'correct warnings on re-dumping static schema with load_classes';
 418
 419     is scalar @{ $res->{warnings} }, 3,
 420 'correct number of warnings on re-dumping static schema with load_classes'
 421         or diag @{ $res->{warnings} };
 422
 423     is $res->{classes}{quuxs}, 'DBIXCSL_Test::Schema::Quux',
 424         'load_classes preserved on re-dump';
 425
 426     run_v5_tests($res);
 427
 428     # now upgrade the schema to use_namespaces
 429     $res = run_loader(
 430         static => 1,
 431         use_namespaces => 1,
 432     );
 433     $schema = $res->{schema};
 434
 435     like $res->{warnings}[0], qr/Dumping manual schema/i,
 436 'correct warnings on upgrading to use_namespaces';
 437
 438     like $res->{warnings}[1], qr/dump completed/i,
 439 'correct warnings on upgrading to use_namespaces';
 440
 441     is scalar @{ $res->{warnings} }, 2,
 442 'correct number of warnings on upgrading to use_namespaces'
 443         or diag @{ $res->{warnings} };
 444
 445     run_v5_tests($res);
 446
 447     my @schema_files = schema_files();
 448
 449     is 1, (scalar @schema_files),
 450         "schema dir contains only 1 entry";
 451
 452     like $schema_files[0], qr{/Result\z},
 453         "schema dir contains only a Result/ directory";
 454
 455     # check that custom content was preserved
 456     lives_and { is $schema->resultset('Quux')->find(1)->b_method, 'dongs' }
 457         'custom content was carried over during use_namespaces upgrade';
 458
 459     lives_and { isa_ok $schema->resultset('Quux')->find(1)->bazrel,
 460         $res->{classes}{bazs} }
 461         'un-namespaced class names in custom content are translated';
 462
 463     class_content_like $schema, $res->{classes}{quuxs}, qr/sub b_method { 'dongs' }/,
 464 'custom content from un-namespaced Result loaded into static dump correctly';
 465 }
 466
 467 # test a regular schema with default use_namespaces => 1, redump, and downgrade
 468 # to load_classes
 469 {
 470     my $res = run_loader(clean_dumpdir => 1, static => 1);
 471
 472     like $res->{warnings}[0], qr/Dumping manual schema/i,
 473 'correct warnings on dumping static schema';
 474
 475     like $res->{warnings}[1], qr/dump completed/i,
 476 'correct warnings on dumping static schema';
 477
 478     is scalar @{ $res->{warnings} }, 2,
 479 'correct number of warnings on dumping static schema'
 480         or diag @{ $res->{warnings} };
 481
 482     run_v5_tests($res);
 483
 484     is $res->{classes}{quuxs}, 'DBIXCSL_Test::Schema::Result::Quux',
 485         'defaults to use_namespaces on regular dump';
 486
 487     add_custom_content($res->{schema}, { Quux => 'Baz' }, { result_namespace => 'Result' });
 488
 489     # test that with no use_namespaces option, use_namespaces is preserved
 490     $res = run_loader(static => 1);
 491
 492     like $res->{warnings}[0], qr/Dumping manual schema/i,
 493 'correct warnings on re-dumping static schema';
 494
 495     like $res->{warnings}[1], qr/dump completed/i,
 496 'correct warnings on re-dumping static schema';
 497
 498     is scalar @{ $res->{warnings} }, 2,
 499 'correct number of warnings on re-dumping static schema'
 500         or diag @{ $res->{warnings} };
 501
 502     is $res->{classes}{quuxs}, 'DBIXCSL_Test::Schema::Result::Quux',
 503         'use_namespaces preserved on re-dump';
 504
 505     run_v5_tests($res);
 506
 507     # now downgrade the schema to load_classes
 508     $res = run_loader(
 509         static => 1,
 510         use_namespaces => 0,
 511     );
 512     my $schema = $res->{schema};
 513
 514     like $res->{warnings}[0], qr/Dumping manual schema/i,
 515 'correct warnings on downgrading to load_classes';
 516
 517     like $res->{warnings}[1], qr/dump completed/i,
 518 'correct warnings on downgrading to load_classes';
 519
 520     is scalar @{ $res->{warnings} }, 2,
 521 'correct number of warnings on downgrading to load_classes'
 522         or diag @{ $res->{warnings} };
 523
 524     run_v5_tests($res);
 525
 526     is $res->{classes}{quuxs}, 'DBIXCSL_Test::Schema::Quux',
 527         'load_classes downgrade correct';
 528
 529     is result_count(), 4,
 530 'correct number of Results after upgrade and Result dir removed';
 531
 532     ok ((not -d result_dir('Result')),
 533         'Result dir was removed for load_classes downgrade');
 534
 535     # check that custom content was preserved
 536     lives_and { is $schema->resultset('Quux')->find(1)->b_method, 'dongs' }
 537         'custom content was carried over during load_classes downgrade';
 538
 539     lives_and { isa_ok $schema->resultset('Quux')->find(1)->bazrel,
 540         $res->{classes}{bazs} }
 541 'namespaced class names in custom content are translated during load_classes '.
 542 'downgrade';
 543
 544     class_content_like $schema, $res->{classes}{quuxs}, qr/sub b_method { 'dongs' }/,
 545 'custom content from namespaced Result loaded into static dump correctly '.
 546 'during load_classes downgrade';
 547 }
 548
 549 # test a regular schema with use_namespaces => 1 and a custom result_namespace
 550 # downgraded to load_classes
 551 {
 552     my $res = run_loader(
 553         clean_dumpdir => 1,
 554         static => 1,
 555         result_namespace => 'MyResult',
 556     );
 557
 558     like $res->{warnings}[0], qr/Dumping manual schema/i,
 559 'correct warnings on dumping static schema';
 560
 561     like $res->{warnings}[1], qr/dump completed/i,
 562 'correct warnings on dumping static schema';
 563
 564     is scalar @{ $res->{warnings} }, 2,
 565 'correct number of warnings on dumping static schema'
 566         or diag @{ $res->{warnings} };
 567
 568     run_v5_tests($res);
 569
 570     is $res->{classes}{quuxs}, 'DBIXCSL_Test::Schema::MyResult::Quux',
 571         'defaults to use_namespaces and uses custom result_namespace';
 572
 573     add_custom_content($res->{schema}, { Quux => 'Baz' }, { result_namespace => 'MyResult' });
 574
 575     # test that with no use_namespaces option, use_namespaces is preserved, and
 576     # the custom result_namespace is preserved
 577     $res = run_loader(static => 1);
 578
 579     like $res->{warnings}[0], qr/Dumping manual schema/i,
 580 'correct warnings on re-dumping static schema';
 581
 582     like $res->{warnings}[1], qr/dump completed/i,
 583 'correct warnings on re-dumping static schema';
 584
 585     is scalar @{ $res->{warnings} }, 2,
 586 'correct number of warnings on re-dumping static schema'
 587         or diag @{ $res->{warnings} };
 588
 589     is $res->{classes}{quuxs}, 'DBIXCSL_Test::Schema::MyResult::Quux',
 590         'use_namespaces and custom result_namespace preserved on re-dump';
 591
 592     run_v5_tests($res);
 593
 594     # now downgrade the schema to load_classes
 595     $res = run_loader(
 596         static => 1,
 597         use_namespaces => 0,
 598     );
 599     my $schema = $res->{schema};
 600
 601     like $res->{warnings}[0], qr/Dumping manual schema/i,
 602 'correct warnings on downgrading to load_classes';
 603
 604     like $res->{warnings}[1], qr/dump completed/i,
 605 'correct warnings on downgrading to load_classes';
 606
 607     is scalar @{ $res->{warnings} }, 2,
 608 'correct number of warnings on downgrading to load_classes'
 609         or diag @{ $res->{warnings} };
 610
 611     run_v5_tests($res);
 612
 613     is $res->{classes}{quuxs}, 'DBIXCSL_Test::Schema::Quux',
 614         'load_classes downgrade correct';
 615
 616     is result_count(), 4,
 617 'correct number of Results after upgrade and Result dir removed';
 618
 619     ok ((not -d result_dir('MyResult')),
 620         'Result dir was removed for load_classes downgrade');
 621
 622     # check that custom content was preserved
 623     lives_and { is $schema->resultset('Quux')->find(1)->b_method, 'dongs' }
 624         'custom content was carried over during load_classes downgrade';
 625
 626     lives_and { isa_ok $schema->resultset('Quux')->find(1)->bazrel,
 627         $res->{classes}{bazs} }
 628 'namespaced class names in custom content are translated during load_classes '.
 629 'downgrade';
 630
 631     class_content_like $schema, $res->{classes}{quuxs}, qr/sub b_method { 'dongs' }/,
 632 'custom content from namespaced Result loaded into static dump correctly '.
 633 'during load_classes downgrade';
 634 }
 635
 636 # rewrite from one result_namespace to another, with external content
 637 {
 638     clean_dumpdir();
 639     my $temp_dir = setup_load_external({ Quux => 'Baz', Bar => 'Foo' }, { result_namespace => 'Result' });
 640
 641     my $res = run_loader(static => 1);
 642
 643     # add some custom content to a Result that will be replaced
 644     add_custom_content($res->{schema}, { Quux => 'Baz' }, { result_namespace => 'Result', rel_name_map => { QuuxBaz => 'bazrel2' } });
 645
 646     # Rewrite implicit 'Result' to 'MyResult'
 647     $res = run_loader(
 648         static => 1,
 649         result_namespace => 'MyResult',
 650     );
 651     my $schema = $res->{schema};
 652
 653     is $res->{classes}{quuxs}, 'DBIXCSL_Test::Schema::MyResult::Quux',
 654         'using new result_namespace';
 655
 656     is result_count('MyResult'), 4,
 657 'correct number of Results after rewritten result_namespace';
 658
 659     ok ((not -d schema_dir('Result')),
 660         'original Result dir was removed when rewriting result_namespace');
 661
 662     # check that custom content was preserved
 663     lives_and { is $schema->resultset('Quux')->find(1)->b_method, 'dongs' }
 664         'custom content was carried over when rewriting result_namespace';
 665
 666     lives_and { isa_ok $schema->resultset('Quux')->find(1)->bazrel2,
 667         $res->{classes}{bazs} }
 668 'class names in custom content are translated when rewriting result_namespace';
 669
 670     class_content_like $schema, $res->{classes}{quuxs}, qr/sub b_method { 'dongs' }/,
 671 'custom content from namespaced Result loaded into static dump correctly '.
 672 'when rewriting result_namespace';
 673
 674     # Now rewrite 'MyResult' to 'Mtfnpy'
 675     $res = run_loader(
 676         static => 1,
 677         result_namespace => 'Mtfnpy',
 678     );
 679     $schema = $res->{schema};
 680
 681     is $res->{classes}{quuxs}, 'DBIXCSL_Test::Schema::Mtfnpy::Quux',
 682         'using new result_namespace';
 683
 684     is result_count('Mtfnpy'), 4,
 685 'correct number of Results after rewritten result_namespace';
 686
 687     ok ((not -d result_dir('MyResult')),
 688         'original Result dir was removed when rewriting result_namespace');
 689
 690     # check that custom and external content was preserved
 691     lives_and { is $schema->resultset('Quux')->find(1)->a_method, 'hlagh' }
 692         'external content was carried over when rewriting result_namespace';
 693
 694     lives_and { is $schema->resultset('Quux')->find(1)->b_method, 'dongs' }
 695         'custom content was carried over when rewriting result_namespace';
 696
 697     lives_and { isa_ok $schema->resultset('Quux')->find(1)->bazrel2,
 698         $res->{classes}{bazs} }
 699 'class names in custom content are translated when rewriting result_namespace';
 700
 701     lives_and { isa_ok $schema->resultset('Quux')->find(1)->bazrel,
 702         $res->{classes}{bazs} }
 703 'class names in external content are translated when rewriting '.
 704 'result_namespace';
 705
 706     lives_and { isa_ok $schema->resultset('Bar')->find(1)->foorel,
 707         $res->{classes}{foos} }
 708 'class names in external content are translated when rewriting '.
 709 'result_namespace';
 710
 711     class_content_like $schema, $res->{classes}{quuxs}, qr/sub b_method { 'dongs' }/,
 712 'custom content from namespaced Result loaded into static dump correctly '.
 713 'when rewriting result_namespace';
 714
 715     class_content_like $schema, $res->{classes}{quuxs}, qr/sub a_method { 'hlagh' }/,
 716 'external content from unsingularized Result loaded into static dump correctly';
 717 }
 718
 719 # test upgrading a v4 schema, then check that the version string is correct
 720 {
 721     clean_dumpdir();
 722     write_v4_schema_pm();
 723     run_loader(static => 1);
 724     my $res = run_loader(static => 1, naming => 'current');
 725     my $schema = $res->{schema};
 726
 727     my $file = $schema->_loader->_get_dump_filename($SCHEMA_CLASS);
 728     my $code = slurp $file;
 729
 730     my ($dumped_ver) =
 731         $code =~ /^# Created by DBIx::Class::Schema::Loader v(\S+)/m;
 732
 733     is $dumped_ver, $DBIx::Class::Schema::Loader::VERSION,
 734         'correct version dumped after upgrade of v4 static schema';
 735 }
 736
 737 # Test upgrading an already singular result with custom content that refers to
 738 # old class names.
 739 {
 740     clean_dumpdir();
 741     write_v4_schema_pm();
 742     my $res = run_loader(static => 1);
 743     my $schema = $res->{schema};
 744     run_v4_tests($res);
 745
 746     # add some custom content to a Result that will be replaced
 747     add_custom_content($schema, { Bar => 'Foos' });
 748
 749     # now upgrade the schema
 750     $res = run_loader(static => 1, naming => 'current');
 751     $schema = $res->{schema};
 752     run_v5_tests($res);
 753
 754     # check that custom content was preserved
 755     lives_and { is $schema->resultset('Bar')->find(1)->b_method, 'dongs' }
 756         'custom content was preserved from Result pre-upgrade';
 757
 758     lives_and { isa_ok $schema->resultset('Bar')->find(1)->foorel,
 759         $res->{classes}{foos} }
 760 'unsingularized class names in custom content from Result with unchanged ' .
 761 'name are translated';
 762
 763     class_content_like $schema, $res->{classes}{bar}, qr/sub b_method { 'dongs' }/,
 764 'custom content from Result with unchanged name loaded into static dump ' .
 765 'correctly';
 766 }
 767
 768 done_testing;
 769
 770 END {
 771     rmtree $DUMP_DIR unless $ENV{SCHEMA_LOADER_TESTS_NOCLEANUP};
 772 }
 773
 774 sub clean_dumpdir {
 775     rmtree $DUMP_DIR;
 776     make_path $DUMP_DIR;
 777 }
 778
 779 sub run_loader {
 780     my %loader_opts = @_;
 781
 782     $loader_opts{dump_directory} = $DUMP_DIR if delete $loader_opts{static};
 783
 784     clean_dumpdir() if delete $loader_opts{clean_dumpdir};
 785
 786     eval {
 787         foreach my $source_name ($SCHEMA_CLASS->clone->sources) {
 788             Class::Unload->unload("${SCHEMA_CLASS}::${source_name}");
 789         }
 790
 791         Class::Unload->unload($SCHEMA_CLASS);
 792     };
 793     undef $@;
 794
 795     my @connect_info = $make_dbictest_db_with_unique::dsn;
 796     my @loader_warnings;
 797     local $SIG{__WARN__} = sub { push(@loader_warnings, $_[0]); };
 798     eval qq{
 799         package $SCHEMA_CLASS;
 800         use base qw/DBIx::Class::Schema::Loader/;
 801
 802         __PACKAGE__->loader_options(\%loader_opts);
 803         __PACKAGE__->connection(\@connect_info);
 804     };
 805
 806     ok(!$@, "Loader initialization") or diag $@;
 807
 808     my $schema = $SCHEMA_CLASS->clone;
 809     my (%monikers, %classes);
 810     foreach my $source_name ($schema->sources) {
 811         my $table_name = $schema->source($source_name)->from;
 812         $monikers{$table_name} = $source_name;
 813         $classes{$table_name}  = $schema->source($source_name)->result_class;
 814     }
 815
 816     return {
 817         schema => $schema,
 818         warnings => \@loader_warnings,
 819         monikers => \%monikers,
 820         classes => \%classes,
 821     };
 822 }
 823
 824 sub write_v4_schema_pm {
 825     my %opts = @_;
 826
 827     (my $schema_dir = "$DUMP_DIR/$SCHEMA_CLASS") =~ s/::[^:]+\z//;
 828     rmtree $schema_dir;
 829     make_path $schema_dir;
 830     my $schema_pm = "$schema_dir/Schema.pm";
 831     open my $fh, '>', $schema_pm or die $!;
 832     if (not $opts{use_namespaces}) {
 833         print $fh <<'EOF';
 834 package DBIXCSL_Test::Schema;
 835
 836 use strict;
 837 use warnings;
 838
 839 use base 'DBIx::Class::Schema';
 840
 841 __PACKAGE__->load_classes;
 842
 843
 844 # Created by DBIx::Class::Schema::Loader v0.04006 @ 2009-12-25 01:49:25
 845 # DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:ibIJTbfM1ji4pyD/lgSEog
 846
 847
 848 # You can replace this text with custom content, and it will be preserved on regeneration
 849 1;
 850 EOF
 851     }
 852     else {
 853         print $fh <<'EOF';
 854 package DBIXCSL_Test::Schema;
 855
 856 use strict;
 857 use warnings;
 858
 859 use base 'DBIx::Class::Schema';
 860
 861 __PACKAGE__->load_namespaces;
 862
 863
 864 # Created by DBIx::Class::Schema::Loader v0.04006 @ 2010-01-12 16:04:12
 865 # DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:d3wRVsHBNisyhxeaWJZcZQ
 866
 867
 868 # You can replace this text with custom content, and it will be preserved on
 869 # regeneration
 870 1;
 871 EOF
 872     }
 873 }
 874
 875 sub run_v4_tests {
 876     my $res = shift;
 877     my $schema = $res->{schema};
 878
 879     is_deeply [ @{ $res->{monikers} }{qw/foos bar bazs quuxs/} ],
 880         [qw/Foos Bar Bazs Quuxs/],
 881         'correct monikers in 0.04006 mode';
 882
 883     isa_ok ((my $bar = eval { $schema->resultset('Bar')->find(1) }),
 884         $res->{classes}{bar},
 885         'found a bar');
 886
 887     isa_ok eval { $bar->foo_id }, $res->{classes}{foos},
 888         'correct rel name in 0.04006 mode';
 889
 890     ok my $baz  = eval { $schema->resultset('Bazs')->find(1) };
 891
 892     isa_ok eval { $baz->quux }, 'DBIx::Class::ResultSet',
 893         'correct rel type and name for UNIQUE FK in 0.04006 mode';
 894 }
 895
 896 sub run_v5_tests {
 897     my $res = shift;
 898     my $schema = $res->{schema};
 899
 900     is_deeply [ @{ $res->{monikers} }{qw/foos bar bazs quuxs/} ],
 901         [qw/Foo Bar Baz Quux/],
 902         'correct monikers in current mode';
 903
 904     ok my $bar = eval { $schema->resultset('Bar')->find(1) };
 905
 906     isa_ok eval { $bar->foo }, $res->{classes}{foos},
 907         'correct rel name in current mode';
 908
 909     ok my $baz  = eval { $schema->resultset('Baz')->find(1) };
 910
 911     isa_ok eval { $baz->quux }, $res->{classes}{quuxs},
 912         'correct rel type and name for UNIQUE FK in current mode';
 913 }
 914
 915 {
 916     package DBICSL::Test::TempExtDir;
 917
 918     use overload '""' => sub { ${$_[0]} };
 919
 920     sub DESTROY {
 921         pop @INC;
 922         File::Path::rmtree ${$_[0]};
 923     }
 924 }
 925
 926 sub setup_load_external {
 927     my ($rels, $opts) = @_;
 928
 929     my $temp_dir = tempdir(CLEANUP => 1);
 930     push @INC, $temp_dir;
 931
 932     my $external_result_dir = join '/', $temp_dir, (split /::/, $SCHEMA_CLASS),
 933         ($opts->{result_namespace} || ());
 934
 935     make_path $external_result_dir;
 936
 937     while (my ($from, $to) = each %$rels) {
 938         write_ext_result($external_result_dir, $from, $to, $opts);
 939     }
 940
 941     my $guard = bless \$temp_dir, 'DBICSL::Test::TempExtDir';
 942
 943     return $guard;
 944 }
 945
 946 sub write_ext_result {
 947     my ($result_dir, $from, $to, $opts) = @_;
 948
 949     my $relname    = $opts->{rel_name_map}{_rel_key($from, $to)} || _relname($to);
 950     my $from_class = _qualify_class($from, $opts->{result_namespace});
 951     my $to_class   = _qualify_class($to,   $opts->{result_namespace});
 952     my $condition  = _rel_condition($from, $to);
 953
 954     IO::File->new(">$result_dir/${from}.pm")->print(<<"EOF");
 955 package ${from_class};
 956 sub a_method { 'hlagh' }
 957
 958 __PACKAGE__->has_one('$relname', '$to_class',
 959 { $condition });
 960
 961 1;
 962 EOF
 963
 964     return $relname;
 965 }
 966
 967 sub _relname {
 968     my $to = shift;
 969
 970     return Lingua::EN::Inflect::Number::to_S(lc $to) . 'rel';
 971 }
 972
 973 sub _qualify_class {
 974     my ($class, $result_namespace) = @_;
 975
 976     return $SCHEMA_CLASS . '::'
 977         . ($result_namespace ? $result_namespace . '::' : '')
 978         . $class;
 979 }
 980
 981 sub _rel_key {
 982     my ($from, $to) = @_;
 983
 984     return join '', map ucfirst(Lingua::EN::Inflect::Number::to_S(lc($_))), $from, $to;
 985 }
 986
 987 sub _rel_condition {
 988     my ($from, $to) = @_;
 989
 990     return +{
 991         QuuxBaz => q{'foreign.baz_num' => 'self.baz_id'},
 992         BarFoo  => q{'foreign.fooid'   => 'self.foo_id'},
 993     }->{_rel_key($from, $to)};
 994 }
 995
 996 sub class_content_like {
 997     my ($schema, $class, $re, $test_name) = @_;
 998
 999     my $file = $schema->_loader->_get_dump_filename($class);
1000     my $code = slurp $file;
1001
1002     like $code, $re, $test_name;
1003 }
1004
1005 sub add_custom_content {
1006     my ($schema, $rels, $opts) = @_;
1007
1008     while (my ($from, $to) = each %$rels) {
1009         my $relname    = $opts->{rel_name_map}{_rel_key($from, $to)} || _relname($to);
1010         my $from_class = _qualify_class($from, $opts->{result_namespace});
1011         my $to_class   = _qualify_class($to,   $opts->{result_namespace});
1012         my $condition  = _rel_condition($from, $to);
1013
1014         my $content = <<"EOF";
1015 package ${from_class};
1016 sub b_method { 'dongs' }
1017
1018 __PACKAGE__->has_one('$relname', '$to_class',
1019 { $condition });
1020
1021 1;
1022 EOF
1023
1024         _write_custom_content($schema, $from_class, $content);
1025     }
1026 }
1027
1028 sub _write_custom_content {
1029     my ($schema, $class, $content) = @_;
1030
1031     my $pm = $schema->_loader->_get_dump_filename($class);
1032     {
1033         local ($^I, @ARGV) = ('.bak', $pm);
1034         while (<>) {
1035             if (/DO NOT MODIFY THIS OR ANYTHING ABOVE/) {
1036                 print;
1037                 print $content;
1038             }
1039             else {
1040                 print;
1041             }
1042         }
1043         close ARGV;
1044         unlink "${pm}.bak" or die $^E;
1045     }
1046 }
1047
1048 sub result_count {
1049     my $path = shift || '';
1050
1051     my $dir = result_dir($path);
1052
1053     my $file_count =()= glob "$dir/*";
1054
1055     return $file_count;
1056 }
1057
1058 sub result_files {
1059     my $path = shift || '';
1060
1061     my $dir = result_dir($path);
1062
1063     return glob "$dir/*";
1064 }
1065
1066 sub schema_files { result_files(@_) }
1067
1068 sub result_dir {
1069     my $path = shift || '';
1070
1071     (my $dir = "$DUMP_DIR/$SCHEMA_CLASS/$path") =~ s{::}{/}g;
1072     $dir =~ s{/+\z}{};
1073
1074     return $dir;
1075 }
1076
1077 sub schema_dir { result_dir(@_) }