1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519
|
# frozen_string_literal: true
require "generators/generators_test_helper"
require "rails/generators/rails/app/app_generator"
require "generators/shared_generator_tests"
DEFAULT_APP_FILES = %w(
.dockerignore
.git
.gitattributes
.github/dependabot.yml
.github/workflows/ci.yml
.gitignore
.rubocop.yml
.ruby-version
Dockerfile
Gemfile
README.md
Rakefile
app/assets/config/manifest.js
app/assets/images/.keep
app/assets/stylesheets/application.css
app/channels/application_cable/channel.rb
app/channels/application_cable/connection.rb
app/controllers/application_controller.rb
app/controllers/concerns/.keep
app/helpers/application_helper.rb
app/jobs/application_job.rb
app/mailers/application_mailer.rb
app/models/application_record.rb
app/models/concerns/.keep
app/views/layouts/application.html.erb
app/views/layouts/mailer.html.erb
app/views/layouts/mailer.text.erb
app/views/pwa/manifest.json.erb
app/views/pwa/service-worker.js
bin/brakeman
bin/docker-entrypoint
bin/rails
bin/rake
bin/rubocop
bin/setup
config.ru
config/application.rb
config/boot.rb
config/cable.yml
config/credentials.yml.enc
config/database.yml
config/environment.rb
config/environments/development.rb
config/environments/production.rb
config/environments/test.rb
config/initializers/assets.rb
config/initializers/content_security_policy.rb
config/initializers/filter_parameter_logging.rb
config/initializers/inflections.rb
config/initializers/permissions_policy.rb
config/locales/en.yml
config/master.key
config/puma.rb
config/routes.rb
config/storage.yml
db/seeds.rb
lib/assets/.keep
lib/tasks/.keep
log/.keep
public/404.html
public/406-unsupported-browser.html
public/422.html
public/500.html
public/icon.png
public/icon.svg
public/robots.txt
storage/.keep
test/application_system_test_case.rb
test/channels/application_cable/connection_test.rb
test/controllers/.keep
test/fixtures/files/.keep
test/helpers/.keep
test/integration/.keep
test/mailers/.keep
test/models/.keep
test/system/.keep
test/test_helper.rb
tmp/.keep
tmp/pids/.keep
tmp/storage/.keep
vendor/.keep
)
class AppGeneratorTest < Rails::Generators::TestCase
include GeneratorsTestHelper
arguments [destination_root]
# brings setup, teardown, and some tests
include SharedGeneratorTests
def default_files
::DEFAULT_APP_FILES
end
def test_skip_bundle
generator([destination_root], skip_bundle: true)
run_generator_instance
assert_empty @bundle_commands
# skip_bundle is only about running bundle install so ensure the Gemfile is still generated
assert_file "Gemfile"
end
def test_invalid_javascript_option_raises_an_error
content = capture(:stderr) { run_generator([destination_root, "-j", "unknown"]) }
assert_match(/Expected '--javascript' to be one of/, content)
end
def test_invalid_asset_pipeline_option_raises_an_error
content = capture(:stderr) { run_generator([destination_root, "-a", "unknown"]) }
assert_match(/Expected '--asset-pipeline' to be one of/, content)
end
def test_invalid_css_option_raises_an_error
content = capture(:stderr) { run_generator([destination_root, "-c", "unknown"]) }
assert_match(/Expected '--css' to be one of/, content)
end
def test_invalid_application_name_raises_an_error
content = capture(:stderr) { run_generator [File.join(destination_root, "43-things")] }
assert_equal "Invalid application name 43-things. Please give a name which does not start with numbers.\n", content
end
def test_invalid_application_name_is_fixed
run_generator [File.join(destination_root, "things-43")]
assert_file "things-43/config/environment.rb", /Rails\.application\.initialize!/
assert_file "things-43/config/application.rb", /^module Things43$/
end
def test_application_new_exits_with_non_zero_code_on_invalid_application_name
quietly { system "#{File.expand_path("../../exe/rails", __dir__)} new test --no-rc" }
assert_equal false, $?.success?
end
def test_application_new_exits_with_message_and_non_zero_code_when_generating_inside_existing_rails_directory
run_generator
output = nil
Dir.chdir(destination_root) do
output = `#{File.expand_path("../../exe/rails", __dir__)} new mysecondapp`
end
assert_equal "Can't initialize a new Rails application within the directory of another, please change to a non-Rails directory first.\nType 'rails' for help.\n", output
assert_equal false, $?.success?
end
def test_application_new_show_help_message_inside_existing_rails_directory
run_generator
output = Dir.chdir(destination_root) do
`#{File.expand_path("../../exe/rails", __dir__)} new --help`
end
assert_match(/rails new APP_PATH \[options\]/, output)
assert_equal true, $?.success?
end
def test_application_name_is_detected_if_it_exists_and_app_folder_renamed
app_root = File.join(destination_root, "myapp")
app_moved_root = File.join(destination_root, "myapp_moved")
run_generator [app_root]
FileUtils.mv(app_root, app_moved_root)
run_app_update(app_moved_root)
assert_file "#{app_moved_root}/config/environment.rb", /Rails\.application\.initialize!/
end
def test_new_application_load_defaults
run_generator
assert_file "config/application.rb", /\s+config\.load_defaults #{Rails::VERSION::STRING.to_f}/
end
def test_app_update_create_new_framework_defaults
defaults_path = "config/initializers/new_framework_defaults_#{Rails::VERSION::MAJOR}_#{Rails::VERSION::MINOR}.rb"
run_generator
assert_no_file defaults_path
run_app_update
assert_file defaults_path
end
def test_app_update_supports_skip
run_generator
FileUtils.cd(destination_root) do
config = "config/application.rb"
File.open(config, "a") do |file|
file.puts "# some configuration"
end
assert_no_changes -> { File.readlines(config) } do
run_app_update(flags: "--skip")
end
end
end
def test_app_update_supports_pretend
run_generator
FileUtils.cd(destination_root) do
config = "config/application.rb"
File.open(config, "a") do |file|
file.puts "# some configuration"
end
assert_no_changes -> { File.readlines(config) } do
run_app_update(flags: "--pretend --force")
end
defaults_path = "config/initializers/new_framework_defaults_#{Rails::VERSION::MAJOR}_#{Rails::VERSION::MINOR}.rb"
assert_no_file defaults_path
end
end
def test_app_update_does_not_create_rack_cors
run_generator
run_app_update
assert_no_file "config/initializers/cors.rb"
end
def test_app_update_does_not_remove_rack_cors_if_already_present
run_generator
FileUtils.touch("#{destination_root}/config/initializers/cors.rb")
run_app_update
assert_file "config/initializers/cors.rb"
end
def test_app_update_generates_public_folders
run_generator
FileUtils.rm_rf("#{destination_root}/public/406-unsupported-browser.html")
run_app_update
assert_file "public/406-unsupported-browser.html"
end
def test_app_update_does_not_generate_assets_initializer_when_sprockets_and_propshaft_are_not_used
run_generator [destination_root, "-a", "none"]
run_app_update
assert_no_file "config/initializers/assets.rb"
assert_no_file "app/assets/config/manifest.js"
end
def test_app_update_does_not_generate_manifest_config_when_propshaft_is_used
run_generator [destination_root, "-a", "propshaft"]
run_app_update
assert_file "config/initializers/assets.rb"
assert_no_file "app/assets/config/manifest.js"
end
def test_app_update_does_not_generate_action_cable_contents_when_skip_action_cable_is_given
run_generator [destination_root, "--skip-action-cable"]
run_app_update
assert_no_file "config/cable.yml"
assert_file "config/environments/production.rb" do |content|
assert_no_match(/config\.action_cable/, content)
end
assert_no_file "test/channels/application_cable/connection_test.rb"
end
def test_app_update_does_not_generate_bootsnap_contents_when_skip_bootsnap_is_given
run_generator [destination_root, "--skip-bootsnap"]
run_app_update
assert_file "config/boot.rb" do |content|
assert_no_match(/require "bootsnap\/setup"/, content)
end
end
def test_app_update_preserves_skip_active_job
run_generator [ destination_root, "--skip-active-job" ]
FileUtils.cd(destination_root) do
config = "config/application.rb"
assert_no_changes -> { File.readlines(config).grep(/require /) } do
run_app_update
end
end
end
def test_app_update_preserves_skip_action_mailbox
run_generator [ destination_root, "--skip-action-mailbox" ]
FileUtils.cd(destination_root) do
config = "config/application.rb"
assert_no_changes -> { File.readlines(config).grep(/require /) } do
run_app_update
end
end
end
def test_app_update_preserves_skip_action_text
run_generator [ destination_root, "--skip-action-text" ]
FileUtils.cd(destination_root) do
config = "config/application.rb"
assert_no_changes -> { File.readlines(config).grep(/require /) } do
run_app_update
end
end
end
def test_app_update_preserves_skip_brakeman
run_generator [ destination_root, "--skip-brakeman" ]
FileUtils.cd(destination_root) do
assert_no_changes -> { File.exist?("bin/brakeman") } do
run_app_update
end
end
end
def test_app_update_preserves_skip_rubocop
run_generator [ destination_root, "--skip-rubocop" ]
FileUtils.cd(destination_root) do
assert_no_changes -> { File.exist?("bin/rubocop") } do
run_app_update
end
end
end
def test_app_update_preserves_skip_test
run_generator [ destination_root, "--skip-test" ]
FileUtils.cd(destination_root) do
config = "config/application.rb"
assert_no_changes -> { File.readlines(config).grep(/require /) } do
run_app_update
end
end
end
def test_app_update_preserves_skip_system_test
run_generator [ destination_root, "--skip-system-test" ]
FileUtils.cd(destination_root) do
config = "config/application.rb"
assert_file config, /generators\.system_tests/
assert_no_changes -> { File.readlines(config).grep(/generators\.system_tests/) } do
run_app_update
end
end
end
def test_app_update_preserves_propshaft
run_generator [destination_root, "-a", "propshaft"]
FileUtils.cd(destination_root) do
config = "config/environments/production.rb"
assert_no_changes -> { File.readlines(config).grep(/config\.assets/) } do
run_app_update
end
end
end
def test_gem_for_active_storage
run_generator
assert_file "Gemfile", /^# gem "image_processing"/
end
def test_gem_for_active_storage_when_skip_active_storage_is_given
run_generator [destination_root, "--skip-active-storage"]
assert_no_gem "image_processing"
assert_file "Dockerfile" do |content|
assert_no_match(/libvips/, content)
end
end
def test_app_update_does_not_generate_active_storage_contents_when_skip_active_storage_is_given
run_generator [destination_root, "--skip-active-storage"]
run_app_update
assert_file "config/environments/development.rb" do |content|
assert_no_match(/config\.active_storage/, content)
end
assert_file "config/environments/production.rb" do |content|
assert_no_match(/config\.active_storage/, content)
end
assert_file "config/environments/test.rb" do |content|
assert_no_match(/config\.active_storage/, content)
end
assert_no_file "config/storage.yml"
end
def test_app_update_does_not_generate_active_storage_contents_when_skip_active_record_is_given
run_generator [destination_root, "--skip-active-record"]
run_app_update
assert_file "config/environments/development.rb" do |content|
assert_no_match(/config\.active_storage/, content)
end
assert_file "config/environments/production.rb" do |content|
assert_no_match(/config\.active_storage/, content)
end
assert_file "config/environments/test.rb" do |content|
assert_no_match(/config\.active_storage/, content)
end
assert_no_file "config/storage.yml"
end
def test_generator_skips_action_mailbox_when_skip_action_mailbox_is_given
run_generator [destination_root, "--skip-action-mailbox"]
assert_file "#{application_path}/config/application.rb", /#\s+require\s+["']action_mailbox\/engine["']/
end
def test_generator_skips_action_mailbox_when_skip_active_record_is_given
run_generator [destination_root, "--skip-active-record"]
assert_file "#{application_path}/config/application.rb", /#\s+require\s+["']action_mailbox\/engine["']/
end
def test_generator_skips_action_mailbox_when_skip_active_storage_is_given
run_generator [destination_root, "--skip-active-storage"]
assert_file "#{application_path}/config/application.rb", /#\s+require\s+["']action_mailbox\/engine["']/
end
def test_generator_skips_action_text_when_skip_action_text_is_given
run_generator [destination_root, "--skip-action-text"]
assert_file "#{application_path}/config/application.rb", /#\s+require\s+["']action_text\/engine["']/
end
def test_generator_skips_action_text_when_skip_active_record_is_given
run_generator [destination_root, "--skip-active-record"]
assert_file "#{application_path}/config/application.rb", /#\s+require\s+["']action_text\/engine["']/
end
def test_generator_skips_action_text_when_skip_active_storage_is_given
run_generator [destination_root, "--skip-active-storage"]
assert_file "#{application_path}/config/application.rb", /#\s+require\s+["']action_text\/engine["']/
end
=begin
def test_app_update_does_not_change_config_target_version
run_generator
FileUtils.cd(destination_root) do
config = "config/application.rb"
content = File.read(config)
File.write(config, content.gsub(/config\.load_defaults #{Rails::VERSION::STRING.to_f}/, "config.load_defaults 5.1"))
end
run_app_update
assert_file "config/application.rb", /\s+config\.load_defaults 5\.1/
end
=end
def test_app_update_does_not_change_app_name_when_app_name_is_hyphenated_name
app_root = File.join(destination_root, "hyphenated-app")
run_generator [app_root, "-d", "postgresql"]
assert_file "#{app_root}/config/database.yml" do |content|
assert_match(/hyphenated_app_development/, content)
assert_no_match(/hyphenated-app_development/, content)
end
assert_file "#{app_root}/config/cable.yml" do |content|
assert_match(/hyphenated_app/, content)
assert_no_match(/hyphenated-app/, content)
end
run_app_update(app_root)
assert_file "#{app_root}/config/cable.yml" do |content|
assert_match(/hyphenated_app/, content)
assert_no_match(/hyphenated-app/, content)
end
end
def test_application_names_are_not_singularized
run_generator [File.join(destination_root, "hats")]
assert_file "hats/config/environment.rb", /Rails\.application\.initialize!/
end
def test_application_name_is_normalized_in_config
run_generator [File.join(destination_root, "MyWebSite"), "-d", "postgresql"]
assert_file "MyWebSite/app/views/layouts/application.html.erb", /content_for\(:title\) \|\| "My Web Site"/
assert_file "MyWebSite/config/database.yml", /my_web_site_production/
end
def test_gemfile_has_no_whitespace_errors
run_generator
absolute = File.expand_path("Gemfile", destination_root)
File.open(absolute, "r") do |f|
f.each_line do |line|
assert_no_match %r{/^[ \t]+$/}, line
end
end
end
def test_config_database_is_added_by_default
run_generator
assert_file "config/database.yml", /sqlite3/
assert_gem "sqlite3", '">= 1.4"'
end
def test_config_mysql_database
run_generator([destination_root, "-d", "mysql"])
assert_file "config/database.yml", /mysql/
assert_gem "mysql2", '"~> 0.5"'
end
def test_config_database_app_name_with_period
run_generator [File.join(destination_root, "common.usage.com"), "-d", "postgresql"]
assert_file "common.usage.com/config/database.yml", /common_usage_com/
end
def test_config_postgresql_database
run_generator([destination_root, "-d", "postgresql"])
assert_file "config/database.yml", /postgresql/
assert_gem "pg", '"~> 1.1"'
end
def test_generator_defaults_to_puma_version
run_generator [destination_root]
assert_gem "puma", /"\W+ \d/
end
def test_action_cable_redis_gems
run_generator
assert_file "Gemfile", /^# gem "redis"/
end
def test_generator_configures_decrypted_diffs_by_default
run_generator
assert_file ".gitattributes", /\.enc diff=/
end
def test_generator_does_not_configure_decrypted_diffs_when_skip_decrypted_diffs_is_given
run_generator [destination_root, "--skip-decrypted-diffs"]
assert_file ".gitattributes" do |content|
assert_no_match %r/\.enc diff=/, content
end
end
def test_generator_if_skip_test_is_given
run_generator [destination_root, "--skip-test"]
assert_file "config/application.rb", /#\s+require\s+["']rails\/test_unit\/railtie["']/
assert_no_gem "capybara"
assert_no_gem "selenium-webdriver"
assert_no_directory("test")
assert_file ".github/workflows/ci.yml" do |file|
assert_no_match(/test:.\s*runs-on/m, file)
end
end
def test_generator_if_skip_jbuilder_is_given
run_generator [destination_root, "--skip-jbuilder"]
assert_no_gem "jbuilder"
end
def test_generator_if_skip_active_job_is_given
run_generator [destination_root, "--skip-active-job"]
assert_no_file "app/jobs/application_job.rb"
assert_file "config/environments/production.rb" do |content|
assert_no_match(/config\.active_job/, content)
end
assert_file "config/application.rb" do |content|
assert_match(/#\s+require\s+["']active_job\/railtie["']/, content)
assert_match(/#\s+require\s+["']active_storage\/engine["']/, content)
assert_match(/#\s+require\s+["']action_mailer\/railtie["']/, content)
end
end
def test_generator_if_skip_system_test_is_given
run_generator [destination_root, "--skip-system-test"]
assert_no_gem "capybara"
assert_no_gem "selenium-webdriver"
assert_directory("test")
assert_no_directory("test/system")
end
def test_does_not_generate_system_test_files_if_skip_system_test_is_given
run_generator [destination_root, "--skip-system-test"]
Dir.chdir(destination_root) do
quietly { `./bin/rails g scaffold User` }
assert_no_file("test/application_system_test_case.rb")
assert_no_file("test/system/users_test.rb")
end
end
def test_viewport_meta_tag_is_present
run_generator [destination_root]
assert_file "app/views/layouts/application.html.erb" do |contents|
assert_match(/<meta name="viewport"/, contents)
end
end
def test_javascript_is_skipped_if_required
run_generator [destination_root, "--skip-javascript"]
assert_no_file "app/javascript"
assert_file "app/views/layouts/application.html.erb" do |contents|
assert_match(/stylesheet_link_tag\s+"application" %>/, contents)
end
end
def test_inclusion_of_jbuilder
run_generator
assert_gem "jbuilder"
end
def test_inclusion_of_a_debugger
run_generator
if defined?(JRUBY_VERSION)
assert_no_gem "debug"
else
assert_gem "debug"
end
end
def test_inclusion_of_rubocop
run_generator
assert_gem "rubocop-rails-omakase"
assert_file "config/environments/development.rb", %r|# Apply autocorrection by RuboCop to files generated by `bin/rails generate`\.|
end
def test_rubocop_is_skipped_if_required
run_generator [destination_root, "--skip-rubocop"]
assert_no_gem "rubocop-rails-omakase"
assert_no_file "bin/rubocop"
assert_no_file ".rubocop.yml"
assert_file "config/environments/development.rb" do |content|
assert_no_match(%r|# Apply autocorrection by RuboCop to files generated by `bin/rails generate`\.|, content)
end
end
def test_inclusion_of_brakeman
run_generator
assert_gem "brakeman"
end
def test_brakeman_is_skipped_if_required
run_generator [destination_root, "--skip-brakeman"]
assert_no_gem "brakeman"
assert_no_file "bin/brakeman"
end
def test_both_brakeman_and_rubocop_binstubs_are_skipped_if_required
run_generator [destination_root, "--skip-brakeman", "--skip-rubocop"]
assert_no_file "bin/rubocop"
assert_no_file "bin/brakeman"
end
def test_inclusion_of_ci_files
run_generator
assert_file ".github/workflows/ci.yml"
assert_file ".github/dependabot.yml"
end
def test_ci_files_are_skipped_if_required
run_generator [destination_root, "--skip-ci"]
assert_no_file ".github/workflows/ci.yml"
assert_no_file ".github/dependabot.yml"
end
def test_usage_read_from_file
assert_called(File, :read, returns: "USAGE FROM FILE") do
assert_equal "USAGE FROM FILE", Rails::Generators::AppGenerator.desc
end
end
def test_default_usage
assert_called(Rails::Generators::AppGenerator, :usage_path, returns: nil) do
assert_match(/Create rails files for app generator/, Rails::Generators::AppGenerator.desc)
end
end
def test_default_namespace
assert_match "rails:app", Rails::Generators::AppGenerator.namespace
end
def test_file_is_added_for_backwards_compatibility
action :file, "lib/test_file.rb", "here's test data"
assert_file "lib/test_file.rb", "here's test data"
end
def test_pretend_option
output = run_generator [File.join(destination_root, "myapp"), "--pretend"]
assert_no_match(/run bundle install/, output)
assert_no_match(/run git init/, output)
end
def test_quiet_option
output = run_generator [File.join(destination_root, "myapp"), "--quiet"]
assert_empty output
end
def test_force_option_overwrites_every_file_except_master_key
run_generator [File.join(destination_root, "myapp")]
output = run_generator [File.join(destination_root, "myapp"), "--force"]
assert_match(/force/, output)
assert_no_match("force config/master.key", output)
end
def test_application_name_with_spaces
path = File.join(destination_root, "foo bar")
# This also applies to MySQL apps but not with SQLite
run_generator [path, "-d", "postgresql"]
assert_file "foo bar/config/database.yml", /database: foo_bar_development/
end
def test_web_console
run_generator
assert_gem "web-console"
end
def test_generation_runs_bundle_install
generator([destination_root])
run_generator_instance
assert_not_empty @bundle_commands.grep(/^install/)
end
def test_generation_runs_bundle_lock_for_linux
generator([destination_root])
run_generator_instance
assert_not_empty @bundle_commands.grep(/\Alock --add-platform=\S+-linux/)
end
def test_generation_use_original_bundle_environment
generator([destination_root])
mock_original_env = -> do
{ "BUNDLE_RUBYONRAILS__ORG" => "user:pass" }
end
ensure_environment_is_set = -> *_args do
assert_equal "user:pass", ENV["BUNDLE_RUBYONRAILS__ORG"]
end
Bundler.stub :original_env, mock_original_env do
generator.stub :exec_bundle_command, ensure_environment_is_set do
quietly { generator.invoke_all }
end
end
end
def test_bundler_binstub
generator([destination_root])
run_generator_instance
assert_equal 1, @bundle_commands.count("binstubs bundler")
end
def test_skip_active_record_option
run_generator [destination_root, "--skip-active-record"]
assert_file ".gitattributes" do |content|
assert_no_match(/schema.rb/, content)
end
end
def test_skip_active_job_option
run_generator [destination_root, "--skip-active-job"]
["production", "development", "test"].each do |env|
assert_file "config/environments/#{env}.rb" do |content|
assert_no_match(/active_job/, content)
end
end
end
def test_skip_javascript_option
generator([destination_root], skip_javascript: true)
command_check = -> command, *_ do
if command == "importmap:install"
flunk "`importmap:install` expected to not be called."
end
end
generator.stub(:rails_command, command_check) do
run_generator_instance
end
assert_no_gem "importmap-rails"
assert_no_gem "jsbundling-rails"
assert_no_node_files
assert_file "config/initializers/content_security_policy.rb" do |content|
assert_no_match(/policy\.connect_src/, content)
end
assert_file ".gitattributes" do |content|
assert_no_match(/yarn\.lock/, content)
end
end
def test_webpack_option
generator([destination_root], javascript: "webpack")
webpack_called = 0
command_check = -> command, *_ do
case command
when "javascript:install:webpack"
webpack_called += 1
end
end
generator.stub(:rails_command, command_check) do
run_generator_instance
end
assert_equal 1, webpack_called, "`javascript:install:webpack` expected to be called once, but was called #{webpack_called} times."
assert_gem "jsbundling-rails"
assert_node_files
end
def test_esbuild_option
generator([destination_root], javascript: "esbuild")
esbuild_called = 0
command_check = -> command, *_ do
case command
when "javascript:install:esbuild"
esbuild_called += 1
end
end
generator.stub(:rails_command, command_check) do
run_generator_instance
end
assert_equal 1, esbuild_called, "`javascript:install:esbuild` expected to be called once, but was called #{esbuild_called} times."
assert_gem "jsbundling-rails"
assert_node_files
end
def test_esbuild_option_with_javacript_argument
run_generator [destination_root, "--javascript", "esbuild"]
assert_gem "jsbundling-rails"
end
def test_esbuild_option_with_j_argument
run_generator [destination_root, "-j", "esbuild"]
assert_gem "jsbundling-rails"
end
def test_esbuild_option_with_js_argument
run_generator [destination_root, "--js", "esbuild"]
assert_gem "jsbundling-rails"
end
def test_bun_option
generator([destination_root], javascript: "bun")
bun_called = 0
command_check = -> command, *_ do
case command
when "javascript:install:bun"
bun_called += 1
end
end
generator.stub(:rails_command, command_check) do
run_generator_instance
end
assert_equal 1, bun_called, "`javascript:install:bun` expected to be called once, but was called #{bun_called} times."
assert_gem "jsbundling-rails"
end
def test_bun_option_with_javacript_argument
run_generator [destination_root, "--javascript", "bun"]
assert_gem "jsbundling-rails"
end
def test_bun_option_with_j_argument
run_generator [destination_root, "-j", "bun"]
assert_gem "jsbundling-rails"
end
def test_bun_option_with_js_argument
run_generator [destination_root, "--js", "bun"]
assert_gem "jsbundling-rails"
end
def test_skip_javascript_option_with_skip_javascript_argument
run_generator [destination_root, "--skip-javascript"]
assert_no_gem "stimulus-rails"
assert_no_gem "turbo-rails"
assert_no_gem "importmap-rails"
end
def test_skip_javascript_option_with_J_argument
run_generator [destination_root, "-J"]
assert_no_gem "stimulus-rails"
assert_no_gem "turbo-rails"
assert_no_gem "importmap-rails"
end
def test_skip_javascript_option_with_skip_js_argument
run_generator [destination_root, "--skip-js"]
assert_no_gem "stimulus-rails"
assert_no_gem "turbo-rails"
assert_no_gem "importmap-rails"
end
def test_hotwire
run_generator_and_bundler [destination_root]
assert_gem "turbo-rails"
assert_gem "stimulus-rails"
assert_file "app/views/layouts/application.html.erb" do |content|
assert_match(/data-turbo-track/, content)
end
assert_file "app/javascript/application.js" do |content|
assert_match(/turbo/, content)
assert_match(/controllers/, content)
end
end
def test_skip_hotwire
run_generator [destination_root, "--skip-hotwire"]
assert_no_gem "turbo-rails"
assert_file "app/views/layouts/application.html.erb" do |content|
assert_no_match(/data-turbo-track/, content)
end
assert_no_file "app/javascript/application.js"
end
def test_css_option_with_asset_pipeline_tailwind
run_generator_and_bundler [destination_root, "--css=tailwind"]
assert_gem "tailwindcss-rails"
assert_file "app/views/layouts/application.html.erb" do |content|
assert_match(/tailwind/, content)
end
assert_no_node_files
end
def test_css_option_with_tailwind_uses_cssbundling_gem_when_using_node
run_generator [destination_root, "--css=tailwind", "--javascript=esbuild"]
assert_gem "cssbundling-rails"
assert_no_gem "tailwindcss-rails"
end
def test_css_option_with_asset_pipeline_sass
run_generator_and_bundler [destination_root, "--css=sass"]
assert_gem "dartsass-rails"
assert_file "app/assets/stylesheets/application.scss"
assert_no_node_files
end
def test_css_option_with_sass_uses_cssbundling_gem_when_using_node
run_generator [destination_root, "--css=sass", "--javascript=esbuild"]
assert_gem "cssbundling-rails"
assert_no_gem "dartsass-rails"
end
def test_css_option_with_cssbundling_gem
run_generator_and_bundler [destination_root, "--css=postcss"]
assert_gem "cssbundling-rails"
assert_file "app/assets/stylesheets/application.postcss.css"
assert_node_files
end
def test_css_option_with_cssbundling_gem_does_not_force_jsbundling_gem
run_generator [destination_root, "--css=postcss"]
assert_no_gem "jsbundling-rails"
assert_gem "importmap-rails"
end
def test_skip_dev_gems
run_generator [destination_root, "--skip-dev-gems"]
assert_no_gem "web-console"
end
def test_bootsnap
run_generator [destination_root, "--no-skip-bootsnap"]
unless defined?(JRUBY_VERSION)
assert_gem "bootsnap"
assert_file "config/boot.rb" do |content|
assert_match(/require "bootsnap\/setup"/, content)
end
else
assert_no_gem "bootsnap"
assert_file "config/boot.rb" do |content|
assert_no_match(/require "bootsnap\/setup"/, content)
end
end
end
def test_skip_bootsnap
run_generator [destination_root, "--skip-bootsnap"]
assert_no_gem "bootsnap"
assert_file "config/boot.rb" do |content|
assert_no_match(/require "bootsnap\/setup"/, content)
end
end
def test_bootsnap_with_dev_option
run_generator_using_prerelease [destination_root, "--dev"]
assert_no_gem "bootsnap"
assert_file "config/boot.rb" do |content|
assert_no_match(/require "bootsnap\/setup"/, content)
end
end
def test_inclusion_of_ruby_version
run_generator
ruby_version = "#{Gem::Version.new(Gem::VERSION) >= Gem::Version.new("3.3.13") ? Gem.ruby_version : RUBY_VERSION}"
assert_file "Dockerfile" do |content|
assert_match(/ARG RUBY_VERSION=#{ruby_version}/, content)
end
assert_file ".ruby-version" do |content|
if ENV["RBENV_VERSION"]
assert_match(/#{ENV["RBENV_VERSION"]}/, content)
elsif ENV["rvm_ruby_string"]
assert_match(/#{ENV["rvm_ruby_string"]}/, content)
else
assert_match(/#{RUBY_ENGINE}-#{RUBY_ENGINE_VERSION}/, content)
end
assert content.end_with?("\n"), "expected .ruby-version to end with newline"
end
end
def test_version_control_initializes_git_repo
run_generator [destination_root]
assert_directory ".git"
end
def test_default_branch_main_without_user_default
current_default_branch = `git config --global init.defaultBranch`
`git config --global --unset init.defaultBranch`
run_generator [destination_root]
assert_file ".git/HEAD", /main/
ensure
if !current_default_branch.strip.empty?
`git config --global init.defaultBranch #{current_default_branch}`
end
end
def test_version_control_initializes_git_repo_with_user_default_branch
git_version = `git --version`[/\d+.\d+.\d+/]
return if Gem::Version.new(git_version) < Gem::Version.new("2.28.0")
current_default_branch = `git config --global init.defaultBranch`
`git config --global init.defaultBranch master`
run_generator [destination_root]
assert_file ".git/HEAD", /master/
ensure
if current_default_branch && current_default_branch.strip.empty?
`git config --global --unset init.defaultBranch`
elsif current_default_branch
`git config --global init.defaultBranch #{current_default_branch}`
end
end
def test_create_keeps
run_generator
folders_with_keep = %w(
app/assets/images
app/controllers/concerns
app/models/concerns
lib/tasks
lib/assets
log
test/fixtures/files
test/controllers
test/mailers
test/models
test/helpers
test/integration
tmp
tmp/pids
)
folders_with_keep.each do |folder|
assert_file("#{folder}/.keep")
end
end
def test_principle_tasks_go_before_finish_template
tasks = generator.class.tasks.keys
assert_equal tasks.index("apply_rails_template") - 1, tasks.index("finish_template")
end
def test_after_bundle_callback
generator([destination_root]).send(:after_bundle) do
@bundle_commands_before_callback = @bundle_commands.dup
end
run_generator_instance
assert_not_empty @bundle_commands_before_callback
assert_equal @bundle_commands_before_callback, @bundle_commands
end
def test_apply_rails_template_class_method_runs_bundle_and_after_bundle_callbacks
run_generator
FileUtils.cd(destination_root) do
template = "lib/template.rb"
File.write(template, "after_bundle { create_file 'after_bundle_callback_ran' }")
generator_class.no_commands do
assert_called_on_instance_of(generator_class, :run_bundle) do
quietly { generator_class.apply_rails_template(template, destination_root) }
end
end
assert_file "after_bundle_callback_ran"
end
end
def test_apply_rails_template_class_method_does_not_add_bundler_platforms
run_generator
FileUtils.cd(destination_root) do
FileUtils.touch("lib/template.rb")
generator_class.no_commands do
# There isn't an easy way to access the generator instance in order to
# assert that we don't run `bundle lock --add-platform`, so the
# following assertion assumes that the sole call to `bundle_command` is
# for `bundle install`.
assert_called_on_instance_of(generator_class, :bundle_command, times: 1) do
quietly { generator_class.apply_rails_template("lib/template.rb", destination_root) }
end
end
end
end
def test_gitignore
run_generator
assert_file ".gitignore" do |content|
assert_match(/config\/master\.key/, content)
end
end
def test_dockerignore
run_generator
assert_file ".dockerignore" do |content|
assert_match(/config\/master\.key/, content)
end
end
def test_dockerfile
run_generator
assert_file "Dockerfile" do |content|
assert_match(/assets:precompile/, content)
assert_match(/libvips/, content)
assert_no_match(/yarn/, content)
assert_no_match(/node-gyp/, content)
end
end
def test_skip_docker
run_generator [destination_root, "--skip-docker"]
assert_no_file ".dockerignore"
assert_no_file "Dockerfile"
assert_no_file "bin/docker-entrypoint"
end
def test_system_tests_directory_generated
run_generator
assert_directory("test/system")
assert_file("test/system/.keep")
end
unless Gem.win_platform?
def test_master_key_is_only_readable_by_the_owner
run_generator
stat = File.stat("config/master.key")
assert_equal "100600", sprintf("%o", stat.mode)
end
end
def test_minimal_rails_app
generator([destination_root], ["--minimal"])
assert_option :minimal
assert_option :skip_action_cable
assert_option :skip_action_mailbox
assert_option :skip_action_mailer
assert_option :skip_action_text
assert_option :skip_active_job
assert_option :skip_active_storage
assert_option :skip_bootsnap
assert_option :skip_dev_gems
assert_option :skip_hotwire
assert_option :skip_javascript
assert_option :skip_jbuilder
assert_option :skip_system_test
end
def test_minimal_rails_app_with_no_skip_implied_option
generator([destination_root], ["--minimal", "--no-skip-action-text"])
assert_not_option :skip_action_text
assert_not_option :skip_active_storage
assert_not_option :skip_active_job
assert_option :skip_action_mailbox
assert_option :skip_action_mailer
assert_option :minimal
end
def test_minimal_rails_app_with_no_skip_intermediary_implied_option
generator([destination_root], ["--minimal", "--no-skip-active-storage"])
assert_not_option :skip_active_storage
assert_not_option :skip_active_job
assert_option :skip_action_text
assert_option :skip_action_mailbox
assert_option :skip_action_mailer
assert_option :minimal
end
def test_name_option
run_generator [destination_root, "--name=my-app"]
assert_file "config/application.rb", /^module MyApp$/
end
def test_devcontainer
run_generator [destination_root, "--devcontainer", "--name=my-app"]
assert_devcontainer_json_file do |content|
assert_equal "my_app", content["name"]
assert_equal "redis://redis:6379/1", content["containerEnv"]["REDIS_URL"]
assert_equal "45678", content["containerEnv"]["CAPYBARA_SERVER_PORT"]
assert_equal "selenium", content["containerEnv"]["SELENIUM_HOST"]
assert_includes content["features"].keys, "ghcr.io/rails/devcontainer/features/activestorage"
assert_includes content["features"].keys, "ghcr.io/devcontainers/features/github-cli:1"
assert_includes content["features"].keys, "ghcr.io/rails/devcontainer/features/sqlite3"
assert_includes(content["forwardPorts"], 3000)
assert_includes(content["forwardPorts"], 6379)
end
assert_file(".devcontainer/Dockerfile") do |content|
assert_match(/ARG RUBY_VERSION=#{RUBY_VERSION}/, content)
end
assert_file("test/application_system_test_case.rb") do |content|
assert_match(/^ served_by host: "rails-app", port: ENV\["CAPYBARA_SERVER_PORT"\]/, content)
assert_match(/^ driven_by :selenium, using: :headless_chrome, screen_size: \[ 1400, 1400 \], options: {$/, content)
assert_match(/^ browser: :remote,$/, content)
assert_match(/^ url: "http:\/\/\#{ENV\["SELENIUM_HOST"\]}:4444"$/, content)
end
assert_compose_file do |compose_config|
assert_equal "my_app", compose_config["name"]
expected_rails_app_config = {
"build" => {
"context" => "..",
"dockerfile" => ".devcontainer/Dockerfile"
},
"volumes" => ["../..:/workspaces:cached"],
"command" => "sleep infinity",
"depends_on" => ["selenium", "redis"]
}
assert_equal expected_rails_app_config, compose_config["services"]["rails-app"]
expected_selenium_conifg = {
"image" => "selenium/standalone-chromium",
"restart" => "unless-stopped",
}
assert_equal expected_selenium_conifg, compose_config["services"]["selenium"]
expected_redis_config = {
"image" => "redis:7.2",
"restart" => "unless-stopped",
"volumes" => ["redis-data:/data"]
}
assert_equal expected_redis_config, compose_config["services"]["redis"]
assert_equal ["redis-data"], compose_config["volumes"].keys
end
end
def test_devcontainer_no_redis_skipping_action_cable_and_active_job
run_generator [ destination_root, "--devcontainer", "--skip-action-cable", "--skip-active-job" ]
assert_compose_file do |compose_config|
assert_not_includes compose_config["services"]["rails-app"]["depends_on"], "redis"
assert_nil compose_config["services"]["redis"]
assert_nil compose_config["volumes"]
end
assert_devcontainer_json_file do |content|
assert_not_includes content["forwardPorts"], 6379
end
end
def test_devcontainer_postgresql
run_generator [ destination_root, "--devcontainer", "-d", "postgresql" ]
assert_compose_file do |compose_config|
assert_includes compose_config["services"]["rails-app"]["depends_on"], "postgres"
expected_postgres_config = {
"image" => "postgres:16.1",
"restart" => "unless-stopped",
"networks" => ["default"],
"volumes" => ["postgres-data:/var/lib/postgresql/data"],
"environment" => {
"POSTGRES_USER" => "postgres",
"POSTGRES_PASSWORD" => "postgres"
}
}
assert_equal expected_postgres_config, compose_config["services"]["postgres"]
assert_includes compose_config["volumes"].keys, "postgres-data"
end
assert_devcontainer_json_file do |content|
assert_equal "postgres", content["containerEnv"]["DB_HOST"]
assert_includes content["features"].keys, "ghcr.io/rails/devcontainer/features/postgres-client"
assert_includes content["forwardPorts"], 5432
end
assert_file("config/database.yml") do |content|
assert_match(/host: <%= ENV\["DB_HOST"\] %>/, content)
end
end
def test_devcontainer_mysql
run_generator [ destination_root, "--devcontainer", "-d", "mysql" ]
assert_compose_file do |compose_config|
assert_includes compose_config["services"]["rails-app"]["depends_on"], "mysql"
expected_mysql_config = {
"image" => "mysql/mysql-server:8.0",
"restart" => "unless-stopped",
"environment" => {
"MYSQL_ALLOW_EMPTY_PASSWORD" => "true",
"MYSQL_ROOT_HOST" => "%"
},
"volumes" => ["mysql-data:/var/lib/mysql"],
"networks" => ["default"],
}
assert_equal expected_mysql_config, compose_config["services"]["mysql"]
assert_includes compose_config["volumes"].keys, "mysql-data"
end
assert_devcontainer_json_file do |content|
assert_equal "mysql", content["containerEnv"]["DB_HOST"]
assert_includes content["features"].keys, "ghcr.io/rails/devcontainer/features/mysql-client"
assert_includes content["forwardPorts"], 3306
end
assert_file("config/database.yml") do |content|
assert_match(/host: <%= ENV.fetch\("DB_HOST"\) \{ "localhost" } %>/, content)
end
end
def test_devcontainer_mariadb
run_generator [ destination_root, "--devcontainer", "-d", "trilogy" ]
assert_compose_file do |compose_config|
assert_includes compose_config["services"]["rails-app"]["depends_on"], "mariadb"
expected_mariadb_config = {
"image" => "mariadb:10.5",
"restart" => "unless-stopped",
"networks" => ["default"],
"volumes" => ["mariadb-data:/var/lib/mysql"],
"environment" => {
"MARIADB_ALLOW_EMPTY_ROOT_PASSWORD" => "true",
},
}
assert_equal expected_mariadb_config, compose_config["services"]["mariadb"]
assert_includes compose_config["volumes"].keys, "mariadb-data"
end
assert_devcontainer_json_file do |content|
assert_equal "mariadb", content["containerEnv"]["DB_HOST"]
assert_includes(content["forwardPorts"], 3306)
end
assert_file("config/database.yml") do |content|
assert_match(/host: <%= ENV.fetch\("DB_HOST"\) \{ "localhost" } %>/, content)
end
end
def test_devcontainer_no_selenium_when_skipping_system_test
run_generator [ destination_root, "--devcontainer", "--skip-system-test" ]
assert_compose_file do |compose_config|
assert_not_includes compose_config["services"]["rails-app"]["depends_on"], "selenium"
assert_not_includes compose_config["services"].keys, "selenium"
end
assert_devcontainer_json_file do |content|
assert_nil content["containerEnv"]["CAPYBARA_SERVER_PORT"]
end
end
def test_devcontainer_no_feature_when_skipping_active_storage
run_generator [ destination_root, "--devcontainer", "--skip-active-storage" ]
assert_devcontainer_json_file do |content|
assert_nil content["features"]["ghcr.io/rails/devcontainer/features/activestorage"]
end
end
def test_devcontainer_no_depends_on_when_no_dependencies
run_generator [ destination_root, "--devcontainer", "--minimal" ]
assert_compose_file do |compose_config|
assert_not_includes compose_config["services"]["rails-app"].keys, "depends_on"
end
end
def test_devcontainer_adds_node_tooling_when_required
run_generator [destination_root, "--devcontainer", "--javascript=esbuild"]
assert_devcontainer_json_file do |devcontainer_config|
assert_includes devcontainer_config["features"].keys, "ghcr.io/devcontainers/features/node:1"
end
end
def test_devcontainer_does_not_add_node_tooling_when_not_required
run_generator [destination_root, "--devcontainer"]
assert_devcontainer_json_file do |devcontainer_config|
assert_not_includes devcontainer_config["features"].keys, "ghcr.io/devcontainers/features/node:1"
end
end
def test_devcontainer_dev_flag_mounts_local_rails_repo
run_generator_using_prerelease [ destination_root, "--devcontainer", "--dev" ]
assert_devcontainer_json_file do |devcontainer_config|
rails_mount = devcontainer_config["mounts"].sole
assert_equal "bind", rails_mount["type"]
assert_equal Rails::Generators::RAILS_DEV_PATH, rails_mount["source"]
assert_equal Rails::Generators::RAILS_DEV_PATH, rails_mount["target"]
end
end
def test_no_devcontainer_by_default
run_generator [ destination_root ]
assert_no_file(".devcontainer/devcontainer.json")
assert_no_file(".devcontainer/Dockerfile")
assert_no_file(".devcontainer/compose.yaml")
end
private
def assert_node_files
assert_file ".node-version" do |content|
assert_match %r/\d+\.\d+\.\d+/, content
end
assert_file "Dockerfile" do |content|
assert_match "yarn", content
assert_match "node-gyp", content
end
end
def assert_no_node_files
assert_no_file ".node-version"
assert_file "Dockerfile" do |content|
assert_no_match "yarn", content
assert_no_match "node-gyp", content
end
end
def run_generator_and_bundler(args)
option_args, positional_args = args.partition { |arg| arg.start_with?("--") }
option_args << "--no-skip-bundle"
generator(positional_args, option_args)
# Stub `rails_gemfile_entry` so that Bundler resolves `gem "rails"` to the
# current repository instead of searching for an invalid version number
# (for a version that hasn't been released yet).
rails_gemfile_entry = Rails::Generators::AppBase::GemfileEntry.path("rails", Rails::Generators::RAILS_DEV_PATH)
generator.stub(:rails_gemfile_entry, -> { rails_gemfile_entry }) do
quietly { run_generator_instance }
end
end
def action(*args, &block)
capture(:stdout) { generator.send(*args, &block) }
end
end
|