Test Cleanup: Improve test setup

stevepolitodesign · stevepolitodesign · commit f2782508b5ff · 2024-04-05T13:27:57.000-04:00
Use `touch` test helper instead of directly working with the `File` class during the setup phase. Also create [file_fixtures][] to simplify test setup. Because the newly added file fixtures are processed with standard, I needed to adjust the testing generator to account for a minor violation. [file_fixtures]: https://api.rubyonrails.org/classes/ActiveSupport/Testing/FileFixtures.html#method-i-file_fixture
diff --git a/lib/generators/suspenders/testing_generator.rb b/lib/generators/suspenders/testing_generator.rb
@@ -43,7 +43,7 @@ def modify_spec_helper
             allow_localhost: true,
             allow: [
               /(chromedriver|storage).googleapis.com/,
-              "googlechromelabs.github.io",
+              "googlechromelabs.github.io"
             ]
           )
         RUBY
diff --git a/test/fixtures/files/Rakefile b/test/fixtures/files/Rakefile
@@ -0,0 +1,5 @@
+require_relative "config/application"
+require "bundler/audit/task"
+Bundler::Audit::Task.new
+
+Rails.application.load_tasks
diff --git a/test/fixtures/files/_flashes.html.erb b/test/fixtures/files/_flashes.html.erb
@@ -0,0 +1,7 @@
+<% if flash.any? %>
+  <div class="flashes">
+    <% flash.each do |type, message| -%>
+      <div class="flash-<%= type %>"><%= message %></div>
+    <% end -%>
+  </div>
+<% end %>
diff --git a/test/fixtures/files/action_mailer.rb b/test/fixtures/files/action_mailer.rb
@@ -0,0 +1,5 @@
+RSpec.configure do |config|
+  config.before(:each) do
+    ActionMailer::Base.deliveries.clear
+  end
+end
diff --git a/test/fixtures/files/active_job.rb b/test/fixtures/files/active_job.rb
@@ -0,0 +1,14 @@
+require "active_job/logging"
+require "active_job/log_subscriber"
+
+ActiveSupport::Notifications.unsubscribe("enqueue.active_job")
+
+module ActiveJob
+  module Logging
+    class EnqueueLogSubscriber < LogSubscriber
+      define_method :enqueue, instance_method(:enqueue)
+    end
+  end
+end
+
+ActiveJob::Logging::EnqueueLogSubscriber.attach_to(:active_job)
diff --git a/test/fixtures/files/better_html.rb b/test/fixtures/files/better_html.rb
@@ -0,0 +1,9 @@
+Rails.configuration.to_prepare do
+  if Rails.env.test?
+    require "better_html"
+
+    BetterHtml.config = BetterHtml::Config.new(Rails.configuration.x.better_html)
+
+    BetterHtml.config.template_exclusion_filter = proc { |filename| !filename.start_with?(Rails.root.to_s) }
+  end
+end
diff --git a/test/fixtures/files/driver.rb b/test/fixtures/files/driver.rb
@@ -0,0 +1,5 @@
+RSpec.configure do |config|
+  config.before(:each, type: :system) do
+    driven_by :selenium, using: :headless_chrome, screen_size: [1400, 1400]
+  end
+end
diff --git a/test/fixtures/files/email_interceptor.rb b/test/fixtures/files/email_interceptor.rb
@@ -0,0 +1,11 @@
+class EmailInterceptor
+  include ActiveSupport::Configurable
+
+  config_accessor :interceptor_addresses, default: []
+
+  def self.delivering_email(message)
+    to = interceptor_addresses
+
+    message.to = to if to.any?
+  end
+end
diff --git a/test/fixtures/files/email_interceptor_initializer.rb b/test/fixtures/files/email_interceptor_initializer.rb
@@ -0,0 +1,5 @@
+Rails.application.configure do
+  if ENV["INTERCEPTOR_ADDRESSES"].present?
+    config.action_mailer.interceptors = %w[EmailInterceptor]
+  end
+end
diff --git a/test/fixtures/files/erb-lint.yml b/test/fixtures/files/erb-lint.yml
@@ -0,0 +1,63 @@
+---
+glob: "app/views/**/*.{html,turbo_stream}{+*,}.erb"
+
+linters:
+  AllowedScriptType:
+    enabled: true
+    allowed_types:
+      - "module"
+      - "text/javascript"
+  ErbSafety:
+    enabled: true
+    better_html_config: "config/better_html.yml"
+  GitHub::Accessibility::AvoidBothDisabledAndAriaDisabledCounter:
+    enabled: true
+  GitHub::Accessibility::AvoidGenericLinkTextCounter:
+    enabled: true
+  GitHub::Accessibility::DisabledAttributeCounter:
+    enabled: true
+  GitHub::Accessibility::IframeHasTitleCounter:
+    enabled: true
+  GitHub::Accessibility::ImageHasAltCounter:
+    enabled: true
+  GitHub::Accessibility::LandmarkHasLabelCounter:
+    enabled: true
+  GitHub::Accessibility::LinkHasHrefCounter:
+    enabled: true
+  GitHub::Accessibility::NestedInteractiveElementsCounter:
+    enabled: true
+  GitHub::Accessibility::NoAriaLabelMisuseCounter:
+    enabled: true
+  GitHub::Accessibility::NoPositiveTabIndexCounter:
+    enabled: true
+  GitHub::Accessibility::NoRedundantImageAltCounter:
+    enabled: true
+  GitHub::Accessibility::NoTitleAttributeCounter:
+    enabled: true
+  GitHub::Accessibility::SvgHasAccessibleTextCounter:
+    enabled: true
+  Rubocop:
+    enabled: true
+    rubocop_config:
+      inherit_from:
+        - .rubocop.yml
+
+      Lint/EmptyBlock:
+        Enabled: false
+      Layout/InitialIndentation:
+        Enabled: false
+      Layout/TrailingEmptyLines:
+        Enabled: false
+      Layout/TrailingWhitespace:
+        Enabled: false
+      Layout/LeadingEmptyLines:
+        Enabled: false
+      Style/FrozenStringLiteralComment:
+        Enabled: false
+      Style/MultilineTernaryOperator:
+        Enabled: false
+      Lint/UselessAssignment:
+        Exclude:
+          - "app/views/**/*"
+
+EnableDefaultLinters: true
diff --git a/test/fixtures/files/eslintrc.json b/test/fixtures/files/eslintrc.json
@@ -0,0 +1,7 @@
+{
+  "extends": ["@thoughtbot/eslint-config/prettier"],
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  }
+}
diff --git a/test/fixtures/files/factories.rb b/test/fixtures/files/factories.rb
@@ -0,0 +1,2 @@
+FactoryBot.define do
+end
diff --git a/test/fixtures/files/factories_spec.rb b/test/fixtures/files/factories_spec.rb
@@ -0,0 +1,7 @@
+require "rails_helper"
+
+RSpec.describe "Factories" do
+  it "has valid factoties" do
+    FactoryBot.lint traits: true
+  end
+end
diff --git a/test/fixtures/files/factories_test.rb b/test/fixtures/files/factories_test.rb
@@ -0,0 +1,9 @@
+require "test_helper"
+
+class FactoryBotsTest < ActiveSupport::TestCase
+  class FactoryLintingTest < FactoryBotsTest
+    test "linting of factories" do
+      FactoryBot.lint traits: true
+    end
+  end
+end
diff --git a/test/fixtures/files/i18n.rb b/test/fixtures/files/i18n.rb
@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.include ActionView::Helpers::TranslationHelper
+end
diff --git a/test/fixtures/files/inline_svg.rb b/test/fixtures/files/inline_svg.rb
@@ -0,0 +1,3 @@
+InlineSvg.configure do |config|
+  config.raise_on_file_not_found = true
+end
diff --git a/test/fixtures/files/prettierignore b/test/fixtures/files/prettierignore
@@ -0,0 +1 @@
+vendor/bundle/**
diff --git a/test/fixtures/files/prettierrc.json b/test/fixtures/files/prettierrc.json
@@ -0,0 +1,11 @@
+{
+  "singleQuote": true,
+  "overrides": [
+    {
+      "files": ["**/*.css", "**/*.scss", "**/*.html"],
+      "options": {
+        "singleQuote": false
+      }
+    }
+  ]
+}
diff --git a/test/fixtures/files/shoulda_matchers.rb b/test/fixtures/files/shoulda_matchers.rb
@@ -0,0 +1,6 @@
+Shoulda::Matchers.configure do |config|
+  config.integrate do |with|
+    with.test_framework :rspec
+    with.library :rails
+  end
+end
diff --git a/test/fixtures/files/spec_helper.rb b/test/fixtures/files/spec_helper.rb
@@ -0,0 +1,23 @@
+require "webmock/rspec"
+
+RSpec.configure do |config|
+  config.example_status_persistence_file_path = "tmp/rspec_examples.txt"
+  config.order = :random
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+end
+
+WebMock.disable_net_connect!(
+  allow_localhost: true,
+  allow: [
+    /(chromedriver|storage).googleapis.com/,
+    "googlechromelabs.github.io"
+  ]
+)
diff --git a/test/fixtures/files/stylelintrc.json b/test/fixtures/files/stylelintrc.json
@@ -0,0 +1,3 @@
+{
+  "extends": "@thoughtbot/stylelint-config"
+}
diff --git a/test/fixtures/files/test_helper.rb b/test/fixtures/files/test_helper.rb
@@ -0,0 +1,15 @@
+ENV["RAILS_ENV"] ||= "test"
+require_relative "../config/environment"
+require "rails/test_help"
+
+module ActiveSupport
+  class TestCase
+    # Run tests in parallel with specified workers
+    parallelize(workers: :number_of_processors)
+
+    # Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order.
+    fixtures :all
+
+    # Add more helper methods to be used by all tests here...
+  end
+end
diff --git a/test/generators/suspenders/advisories_generator_test.rb b/test/generators/suspenders/advisories_generator_test.rb
@@ -43,20 +43,12 @@ class AdvisoriesGeneratorTest < Rails::Generators::TestCase
       end
 
       test "modifies Rakefile" do
-        touch "Rakefile"
-        content = <<~TEXT
+        touch "Rakefile", content: <<~TEXT
           require_relative "config/application"
 
           Rails.application.load_tasks
         TEXT
-        File.open(app_root("Rakefile"), "w") { _1.write content }
-        expected_rakefile = <<~TEXT
-          require_relative "config/application"
-          require "bundler/audit/task"
-          Bundler::Audit::Task.new
-
-          Rails.application.load_tasks
-        TEXT
+        expected_rakefile = file_fixture("Rakefile").read
 
         run_generator
 
diff --git a/test/generators/suspenders/email_generator_test.rb b/test/generators/suspenders/email_generator_test.rb
@@ -12,19 +12,7 @@ class EmailGeneratorTest < Rails::Generators::TestCase
       teardown :restore_destination
 
       test "creates a mailer intercepter" do
-        expected = <<~RUBY
-          class EmailInterceptor
-            include ActiveSupport::Configurable
-
-            config_accessor :interceptor_addresses, default: []
-
-            def self.delivering_email(message)
-              to = interceptor_addresses
-
-              message.to = to if to.any?
-            end
-          end
-        RUBY
+        expected = file_fixture("email_interceptor.rb").read
 
         run_generator
 
@@ -34,13 +22,7 @@ def self.delivering_email(message)
       end
 
       test "creates initializer" do
-        expected = <<~RUBY
-          Rails.application.configure do
-            if ENV["INTERCEPTOR_ADDRESSES"].present?
-              config.action_mailer.interceptors = %w[EmailInterceptor]
-            end
-          end
-        RUBY
+        expected = file_fixture("email_interceptor_initializer.rb").read
 
         run_generator
 
diff --git a/test/generators/suspenders/factories_generator_test.rb b/test/generators/suspenders/factories_generator_test.rb
diff --git a/test/generators/suspenders/inline_svg_generator_test.rb b/test/generators/suspenders/inline_svg_generator_test.rb
diff --git a/test/generators/suspenders/jobs_generator_test.rb b/test/generators/suspenders/jobs_generator_test.rb
diff --git a/test/generators/suspenders/lint_generator_test.rb b/test/generators/suspenders/lint_generator_test.rb
diff --git a/test/generators/suspenders/testing_generator_test.rb b/test/generators/suspenders/testing_generator_test.rb
diff --git a/test/generators/suspenders/views_generator_test.rb b/test/generators/suspenders/views_generator_test.rb
diff --git a/test/test_helper.rb b/test/test_helper.rb

Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ def modify_spec_helper`
`43`	`43`	`allow_localhost: true,`
`44`	`44`	`allow: [`
`45`	`45`	`/(chromedriver\|storage).googleapis.com/,`
`46`		`- "googlechromelabs.github.io",`
	`46`	`+ "googlechromelabs.github.io"`
`47`	`47`	`]`
`48`	`48`	`)`
`49`	`49`	`RUBY`