Merge pull request rails#52752 from thejonroberts/devcontainer-generator-tests

Test DevcontainerGenerator

Author: rafaelfranca

railties/lib/rails/generators/rails/devcontainer/devcontainer_generator.rb

@@ -38,9 +38,11 @@ def create_devcontainer
 
       def update_application_system_test_case
         return unless options[:system_test]
-        return unless File.exist?("test/application_system_test_case.rb")
 
-        gsub_file("test/application_system_test_case.rb", /^\s*driven_by\b.*/, system_test_configuration)
+        system_test_case_path = File.expand_path "test/application_system_test_case.rb", destination_root
+        return unless File.exist? system_test_case_path
+
+        gsub_file(system_test_case_path, /^\s*driven_by\b.*/, system_test_configuration)
       end
 
       def update_database_yml

railties/test/fixtures/test/application_system_test_case.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
+  driven_by :selenium, using: :headless_chrome, screen_size: [ 1400, 1400 ]
+end

railties/test/generators/devcontainer_generator_test.rb

@@ -8,25 +8,220 @@ module Generators
     class DevcontainerGeneratorTest < Rails::Generators::TestCase
       include GeneratorsTestHelper
 
-      def test_generates_devcontainer_files
+      def test_creates_devcontainer_files
         run_generator
 
         assert_file ".devcontainer/compose.yaml"
         assert_file ".devcontainer/Dockerfile"
         assert_file ".devcontainer/devcontainer.json"
+        test_common_config
       end
 
-      def test_default_json_has_no_mounts
+      def test_active_storage_option_default
         run_generator
 
-        assert_devcontainer_json_file do |devcontainer_config|
-          assert_nil devcontainer_config["mounts"]
+        assert_devcontainer_json_file do |devcontainer_json|
+          assert_includes devcontainer_json["features"].keys, "ghcr.io/rails/devcontainer/features/activestorage"
+        end
+      end
+
+      def test_active_storage_option_skip
+        run_generator [ "--skip-active-storage" ]
+
+        test_common_config
+        assert_devcontainer_json_file do |devcontainer_json|
+          assert_nil devcontainer_json["features"]["ghcr.io/rails/devcontainer/features/activestorage"]
+        end
+      end
+
+      def test_app_name_option_default
+        run_generator
+
+        assert_devcontainer_json_file do |devcontainer_json|
+          assert_equal "rails_app", devcontainer_json["name"]
+        end
+
+        assert_compose_file do |compose|
+          assert_equal "rails_app", compose["name"]
+        end
+      end
+
+      def test_app_name_option
+        run_generator ["--app-name", "my-TestApp_name"]
+
+        test_common_config
+        assert_devcontainer_json_file do |devcontainer_json|
+          assert_equal "my-TestApp_name", devcontainer_json["name"]
+        end
+
+        assert_compose_file do |compose|
+          assert_equal "my-TestApp_name", compose["name"]
+        end
+      end
+
+      def test_database_default_sqlite3
+        run_generator
+
+        assert_no_file "config/database.yml"
+        assert_devcontainer_json_file do |devcontainer_json|
+          assert_includes devcontainer_json["features"].keys, "ghcr.io/rails/devcontainer/features/sqlite3"
+        end
+      end
+
+      def test_database_mariadb_mysql
+        run_generator [ "--database", "mariadb-mysql" ]
+
+        test_common_config
+        assert_no_file "config/database.yml"
+        assert_compose_file do |compose|
+          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["services"]["mariadb"]
+          assert_includes compose["volumes"].keys, "mariadb-data"
+          assert_includes compose["services"]["rails-app"]["depends_on"], "mariadb"
+        end
+
+        assert_devcontainer_json_file do |devcontainer_json|
+          assert_equal "mariadb", devcontainer_json["containerEnv"]["DB_HOST"]
+          assert_includes devcontainer_json["features"].keys, "ghcr.io/rails/devcontainer/features/mysql-client"
+          assert_includes devcontainer_json["forwardPorts"], 3306
+        end
+      end
+
+      def test_database_mariadb_trilogy
+        run_generator [ "--database", "mariadb-trilogy" ]
+
+        test_common_config
+        assert_no_file "config/database.yml"
+        assert_compose_file do |compose|
+          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["services"]["mariadb"]
+          assert_includes compose["volumes"].keys, "mariadb-data"
+          assert_includes compose["services"]["rails-app"]["depends_on"], "mariadb"
+        end
+
+        assert_devcontainer_json_file do |devcontainer_json|
+          assert_equal "mariadb", devcontainer_json["containerEnv"]["DB_HOST"]
+          assert_includes devcontainer_json["forwardPorts"], 3306
+        end
+      end
+
+      def test_database_mysql
+        run_generator [ "--database", "mysql" ]
+
+        test_common_config
+        assert_no_file "config/database.yml"
+        assert_compose_file do |compose|
+          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["services"]["mysql"]
+          assert_includes compose["volumes"].keys, "mysql-data"
+          assert_includes compose["services"]["rails-app"]["depends_on"], "mysql"
+        end
+
+        assert_devcontainer_json_file do |devcontainer_json|
+          assert_equal "mysql", devcontainer_json["containerEnv"]["DB_HOST"]
+          assert_includes devcontainer_json["features"].keys, "ghcr.io/rails/devcontainer/features/mysql-client"
+          assert_includes devcontainer_json["forwardPorts"], 3306
         end
       end
 
-      def test_dev_option_devcontainer_json_mounts_local_rails
+      def test_database_postgresql
+        run_generator [ "--database", "postgresql" ]
+
+        test_common_config
+
+        assert_file("config/database.yml") do |db_config|
+          assert_match(/host: <%= ENV\["DB_HOST"\] %>/, db_config)
+          assert_match(/username: postgres/, db_config)
+          assert_match(/password: postgres/, db_config)
+        end
+
+        assert_compose_file do |compose|
+          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["services"]["postgres"]
+          assert_includes compose["volumes"].keys, "postgres-data"
+          assert_includes compose["services"]["rails-app"]["depends_on"], "postgres"
+        end
+
+        assert_devcontainer_json_file do |devcontainer_json|
+          assert_equal "postgres", devcontainer_json["containerEnv"]["DB_HOST"]
+          assert_includes devcontainer_json["features"].keys, "ghcr.io/rails/devcontainer/features/postgres-client"
+          assert_includes devcontainer_json["forwardPorts"], 5432
+        end
+      end
+
+      def test_database_trilogy
+        run_generator [ "--database", "trilogy" ]
+
+        test_common_config
+        assert_no_file "config/database.yml"
+        assert_compose_file do |compose|
+          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["services"]["mysql"]
+          assert_includes compose["volumes"].keys, "mysql-data"
+          assert_includes compose["services"]["rails-app"]["depends_on"], "mysql"
+        end
+
+        assert_devcontainer_json_file do |content|
+          assert_equal "mysql", content["containerEnv"]["DB_HOST"]
+          assert_includes content["forwardPorts"], 3306
+        end
+      end
+
+      def test_dev_option_default
+        run_generator
+
+        assert_devcontainer_json_file do |devcontainer_json|
+          assert_nil devcontainer_json["mounts"]
+        end
+      end
+
+      def test_dev_option
         run_generator ["--dev"]
 
+        test_common_config
         assert_devcontainer_json_file do |devcontainer_json|
           mounts = devcontainer_json["mounts"].sole
 
@@ -35,6 +230,124 @@ def test_dev_option_devcontainer_json_mounts_local_rails
           assert_equal Rails::Generators::RAILS_DEV_PATH, mounts["target"]
         end
       end
+
+      def test_node_option_default
+        run_generator
+
+        assert_devcontainer_json_file do |devcontainer_json|
+          assert_not_includes devcontainer_json["features"].keys, "ghcr.io/devcontainers/features/node:1"
+        end
+      end
+
+      def test_node_option
+        run_generator ["--node"]
+
+        test_common_config
+        assert_devcontainer_json_file do |devcontainer_json|
+          assert_includes devcontainer_json["features"].keys, "ghcr.io/devcontainers/features/node:1"
+        end
+      end
+
+      def test_redis_option_default
+        run_generator
+
+        assert_compose_file do |compose|
+          assert_includes compose["services"]["rails-app"]["depends_on"], "redis"
+          expected_redis_config = {
+            "image" => "redis:7.2",
+            "restart" => "unless-stopped",
+            "volumes" => ["redis-data:/data"]
+          }
+          assert_equal expected_redis_config, compose["services"]["redis"]
+          assert_equal ["redis-data"], compose["volumes"].keys
+        end
+
+        assert_devcontainer_json_file do |devcontainer_json|
+          assert_equal "redis://redis:6379/1", devcontainer_json["containerEnv"]["REDIS_URL"]
+          assert_includes devcontainer_json["forwardPorts"], 6379
+        end
+      end
+
+      def test_redis_option_skip
+        run_generator ["--skip-redis"]
+
+        test_common_config
+        assert_compose_file do |compose|
+          assert_not_includes compose["services"]["rails-app"]["depends_on"], "redis"
+          assert_nil compose["services"]["redis"]
+          assert_nil compose["volumes"]
+        end
+
+        assert_devcontainer_json_file do |devcontainer_json|
+          assert_not_includes devcontainer_json["forwardPorts"], 6379
+        end
+      end
+
+      def test_system_test_option_default
+        copy_application_system_test_case
+
+        run_generator
+
+        assert_devcontainer_json_file do |devcontainer_json|
+          assert_equal "45678", devcontainer_json["containerEnv"]["CAPYBARA_SERVER_PORT"]
+          assert_equal "selenium", devcontainer_json["containerEnv"]["SELENIUM_HOST"]
+        end
+
+        assert_file("test/application_system_test_case.rb") do |system_test_case|
+          assert_match(/^  if ENV\["CAPYBARA_SERVER_PORT"\]/, system_test_case)
+          assert_match(/^    served_by host: "rails-app", port: ENV\["CAPYBARA_SERVER_PORT"\]/, system_test_case)
+          assert_match(/^    driven_by :selenium, using: :headless_chrome, screen_size: \[ 1400, 1400 \], options: {$/, system_test_case)
+          assert_match(/^      browser: :remote,$/, system_test_case)
+          assert_match(/^      url: "http:\/\/\#{ENV\["SELENIUM_HOST"\]}:4444"$/, system_test_case)
+        end
+      end
+
+      def test_system_test_option_does_not_create_new_file
+        run_generator ["--system-test"]
+
+        test_common_config
+        assert_no_file "test/application_system_test_case.rb"
+      end
+
+      def test_system_test_option_skip
+        copy_application_system_test_case
+
+        run_generator [ "--skip-system-test", "--force" ]
+
+        test_common_config
+        assert_compose_file do |compose|
+          assert_not_includes compose["services"]["rails-app"]["depends_on"], "selenium"
+          assert_not_includes compose["services"].keys, "selenium"
+        end
+        assert_devcontainer_json_file do |devcontainer_json|
+          assert_nil devcontainer_json["containerEnv"]["CAPYBARA_SERVER_PORT"]
+        end
+      end
+
+      private
+        def test_common_config
+          assert_file(".devcontainer/Dockerfile") do |dockerfile|
+            assert_match(/ARG RUBY_VERSION=#{RUBY_VERSION}/, dockerfile)
+          end
+
+          assert_devcontainer_json_file do |devcontainer_json|
+            assert_includes devcontainer_json["features"].keys, "ghcr.io/devcontainers/features/github-cli:1"
+            assert_includes devcontainer_json["forwardPorts"], 3000
+          end
+
+          assert_compose_file do |compose|
+            expected_app_config = {
+              "build" => {
+                "context" => "..",
+                "dockerfile" => ".devcontainer/Dockerfile"
+              },
+              "volumes" => ["../..:/workspaces:cached"],
+              "command" => "sleep infinity"
+            }
+            actual_independent_config = compose["services"]["rails-app"].except("depends_on")
+            assert_equal expected_app_config, actual_independent_config
+          end
+        end
     end
   end
 end

railties/test/generators/generators_test_helper.rb

@@ -78,6 +78,13 @@ def copy_gemfile(*gemfile_entries)
     File.write File.join(destination, "Gemfile"), gemfile
   end
 
+  def copy_application_system_test_case
+    content = File.read(File.expand_path("../fixtures/test/application_system_test_case.rb", __dir__))
+    destination = File.join(destination_root, "test")
+    mkdir_p(destination)
+    File.write File.join(destination, "application_system_test_case.rb"), content
+  end
+
   def copy_dockerfile
     dockerfile = File.expand_path("../fixtures/Dockerfile.test", __dir__)
     dockerfile = evaluate_template_docker(dockerfile)