Merge branch '199431-run-workhorse-in-feature-specs' into 'master'

Run workhorse in feature specs

Closes #199431

See merge request gitlab-org/gitlab!24000

config/gitlab.yml.example

@@ -1226,6 +1226,8 @@ test:
   gitaly:
     client_path: tmp/tests/gitaly
     token: secret
+  workhorse:
+    secret_file: tmp/tests/gitlab_workhorse_secret
   backup:
     path: tmp/tests/backups
   pseudonymizer:

spec/features/issues/user_creates_issue_spec.rb

@@ -156,7 +156,7 @@ describe "User creates issue" do
         expect(page.find_field("issue_description").value).not_to match /\n\n$/
       end
 
-      it "cancels a file upload correctly" do
+      it "cancels a file upload correctly", :capybara_ignore_server_errors do
         slow_requests do
           dropzone_file([Rails.root.join('spec', 'fixtures', 'dk.png')], 0, false)
 

spec/features/projects/tags/user_edits_tags_spec.rb

@@ -68,7 +68,7 @@ describe 'Project > Tags', :js do
         end
       end
 
-      it 'shows "Attaching a file" message on uploading 1 file', :js do
+      it 'shows "Attaching a file" message on uploading 1 file', :js, :capybara_ignore_server_errors do
         slow_requests do
           dropzone_file([Rails.root.join('spec', 'fixtures', 'dk.png')], 0, false)
 

spec/features/uploads/user_uploads_file_to_note_spec.rb

@@ -22,7 +22,7 @@ describe 'User uploads file to note' do
     end
   end
 
-  context 'uploading is in progress' do
+  context 'uploading is in progress', :capybara_ignore_server_errors do
     it 'cancels uploading on clicking to "Cancel" button', :js do
       slow_requests do
         dropzone_file([Rails.root.join('spec', 'fixtures', 'dk.png')], 0, false)

spec/support/capybara.rb

@@ -23,6 +23,18 @@ JS_CONSOLE_FILTER = Regexp.union([
 
 CAPYBARA_WINDOW_SIZE = [1366, 768].freeze
 
+# Run Workhorse on the given host and port, proxying to Puma on a UNIX socket,
+# for a closer-to-production experience
+Capybara.register_server :puma_via_workhorse do |app, port, host, **options|
+  file = Tempfile.new
+  socket_path = file.path
+  file.close! # We just want the filename
+
+  TestEnv.with_workhorse(TestEnv.workhorse_dir, host, port, socket_path) do
+    Capybara.servers[:puma].call(app, nil, socket_path, **options)
+  end
+end
+
 Capybara.register_driver :chrome do |app|
   capabilities = Selenium::WebDriver::Remote::Capabilities.chrome(
     # This enables access to logs with `page.driver.manage.get_log(:browser)`
@@ -60,7 +72,7 @@ Capybara.register_driver :chrome do |app|
   )
 end
 
-Capybara.server = :puma
+Capybara.server = :puma_via_workhorse
 Capybara.javascript_driver = :chrome
 Capybara.default_max_wait_time = timeout
 Capybara.ignore_hidden_elements = true
@@ -101,6 +113,18 @@ RSpec.configure do |config|
     end
   end
 
+  # The :capybara_ignore_server_errors metadata means unhandled exceptions raised
+  # by the application under test will not necessarily fail the server. This is
+  # useful when testing conditions that are expected to raise a 500 error in
+  # production; it should not be used on the happy path.
+  config.around(:each, :capybara_ignore_server_errors) do |example|
+    Capybara.raise_server_errors = false
+
+    example.run
+  ensure
+    Capybara.raise_server_errors = true
+  end
+
   config.after(:example, :js) do |example|
     # when a test fails, display any messages in the browser's console
     # but fail don't add the message if the failure is a pending test that got

spec/support/helpers/test_env.rb

@@ -104,6 +104,9 @@ module TestEnv
 
     setup_gitaly
 
+    # Feature specs are run through Workhorse
+    setup_workhorse
+
     # Create repository for FactoryBot.create(:project)
     setup_factory_repo
 
@@ -218,6 +221,52 @@ module TestEnv
     ENV.fetch('GITALY_REPO_URL', nil)
   end
 
+  def setup_workhorse
+    install_workhorse_args = [workhorse_dir, workhorse_url].compact.join(',')
+
+    component_timed_setup(
+      'GitLab Workhorse',
+      install_dir: workhorse_dir,
+      version: Gitlab::Workhorse.version,
+      task: "gitlab:workhorse:install[#{install_workhorse_args}]"
+    )
+  end
+
+  def workhorse_dir
+    @workhorse_path ||= File.join('tmp', 'tests', 'gitlab-workhorse')
+  end
+
+  def with_workhorse(workhorse_dir, host, port, upstream, &blk)
+    host = "[#{host}]" if host.include?(':')
+    listen_addr = [host, port].join(':')
+
+    workhorse_pid = spawn(
+      File.join(workhorse_dir, 'gitlab-workhorse'),
+      '-authSocket', upstream,
+      '-documentRoot', Rails.root.join('public').to_s,
+      '-listenAddr', listen_addr,
+      '-secretPath', Gitlab::Workhorse.secret_path.to_s,
+      # TODO: Needed for workhorse + redis features.
+      # https://gitlab.com/gitlab-org/gitlab/-/issues/209245
+      #
+      # '-config', '',
+      '-logFile', 'log/workhorse-test.log',
+      '-logFormat', 'structured',
+      '-developmentMode' # to serve assets and rich error messages
+    )
+
+    begin
+      yield
+    ensure
+      Process.kill('TERM', workhorse_pid)
+      Process.wait(workhorse_pid)
+    end
+  end
+
+  def workhorse_url
+    ENV.fetch('GITLAB_WORKHORSE_URL', nil)
+  end
+
   def setup_factory_repo
     setup_repo(factory_repo_path, factory_repo_path_bare, factory_repo_name,
                BRANCH_SHA)
@@ -347,6 +396,8 @@ module TestEnv
       gitlab-test_bare
       gitlab-test-fork
       gitlab-test-fork_bare
+      gitlab-workhorse
+      gitlab_workhorse_secret
     ]
   end
 

spec/support/shared_examples/features/wiki_file_attachments_shared_examples.rb

@@ -20,7 +20,7 @@ RSpec.shared_examples 'wiki file attachments' do
       end
     end
 
-    context 'uploading is in progress' do
+    context 'uploading is in progress', :capybara_ignore_server_errors do
       it 'cancels uploading on clicking to "Cancel" button' do
         slow_requests do
           attach_with_dropzone