Merge branch 'frozen_string_spec_support' into 'master'

Add frozen_string_literal to spec/support

See merge request gitlab-org/gitlab-ce!31132

lib/gitlab/auth/o_auth/auth_hash.rb

@@ -60,8 +60,7 @@ module Gitlab
 
         def get_info(key)
           value = info[key]
-          Gitlab::Utils.force_utf8(value) if value
-          value
+          value.is_a?(String) ? Gitlab::Utils.force_utf8(value) : value
         end
 
         def username_and_email

lib/gitlab/utils.rb

@@ -22,7 +22,7 @@ module Gitlab
     end
 
     def force_utf8(str)
-      str.force_encoding(Encoding::UTF_8)
+      str.dup.force_encoding(Encoding::UTF_8)
     end
 
     def ensure_utf8_size(str, bytes:)

spec/features/projects/commits/user_browses_commits_spec.rb

@@ -13,7 +13,7 @@ describe 'User browses commits' do
   it 'renders commit' do
     visit project_commit_path(project, sample_commit.id)
 
-    expect(page).to have_content(sample_commit.message.gsub!(/\s+/, ' '))
+    expect(page).to have_content(sample_commit.message.gsub(/\s+/, ' '))
       .and have_content("Showing #{sample_commit.files_changed_count} changed files")
       .and have_content('Side-by-side')
   end

spec/lib/gitlab/auth/o_auth/auth_hash_spec.rb

@@ -40,7 +40,11 @@ describe Gitlab::Auth::OAuth::AuthHash do
       last_name:  last_name_ascii,
       name:       name_ascii,
       nickname:   nickname_ascii,
-      uid:        uid_ascii
+      uid:        uid_ascii,
+      address: {
+        locality: 'some locality',
+        country: 'some country'
+      }
     }
   end
 
@@ -51,6 +55,7 @@ describe Gitlab::Auth::OAuth::AuthHash do
     it { expect(auth_hash.username).to eql nickname_utf8 }
     it { expect(auth_hash.name).to eql name_utf8 }
     it { expect(auth_hash.password).not_to be_empty }
+    it { expect(auth_hash.location).to eq 'some locality, some country' }
   end
 
   context 'email not provided' do

spec/support/api/boards_shared_examples.rb

+# frozen_string_literal: true
+
 shared_examples_for 'group and project boards' do |route_definition, ee = false|
   let(:root_url) { route_definition.gsub(":id", board_parent.id.to_s) }
 

spec/support/api/issues_resolving_discussions_shared_examples.rb

+# frozen_string_literal: true
+
 shared_examples 'creating an issue resolving discussions through the API' do
   it 'creates a new project issue' do
     expect(response).to have_gitlab_http_status(:created)

spec/support/api/members_shared_examples.rb

+# frozen_string_literal: true
+
 shared_examples 'a 404 response when source is private' do
   before do
     source.update_column(:visibility_level, Gitlab::VisibilityLevel::PRIVATE)

spec/support/api/milestones_shared_examples.rb

+# frozen_string_literal: true
+
 shared_examples_for 'group and project milestones' do |route_definition|
   let(:resource_route) { "#{route}/#{milestone.id}" }
   let(:label_1) { create(:label, title: 'label_1', project: project, priority: 1) }

spec/support/api/repositories_shared_context.rb

+# frozen_string_literal: true
+
 shared_context 'disabled repository' do
   before do
     project.project_feature.update!(

spec/support/api/schema_matcher.rb

+# frozen_string_literal: true
+
 module SchemaPath
   def self.expand(schema, dir = nil)
     if Gitlab.ee? && dir.nil?

spec/support/api/scopes/read_user_shared_examples.rb

+# frozen_string_literal: true
+
 shared_examples_for 'allows the "read_user" scope' do |api_version|
   let(:version) { api_version || 'v4' }
 

spec/support/api/time_tracking_shared_examples.rb

+# frozen_string_literal: true
+
 shared_examples 'an unauthorized API user' do
   it { is_expected.to eq(403) }
 end

spec/support/banzai/reference_filter_shared_examples.rb

+# frozen_string_literal: true
+
 # Specs for reference links containing HTML.
 #
 # Requires a reference:

spec/support/batch_loader.rb

+# frozen_string_literal: true
+
 RSpec.configure do |config|
   config.after do
     BatchLoader::Executor.clear_current

spec/support/capybara.rb

+# frozen_string_literal: true
+
 # rubocop:disable Style/GlobalVars
 require 'capybara/rails'
 require 'capybara/rspec'

spec/support/carrierwave.rb

+# frozen_string_literal: true
+
 CarrierWave.root = File.expand_path('tmp/tests/public', Rails.root)
 
 RSpec.configure do |config|

spec/support/chunked_io/chunked_io_helpers.rb

+# frozen_string_literal: true
+
 module ChunkedIOHelpers
   def sample_trace_raw
     @sample_trace_raw ||= File.read(expand_fixture_path('trace/sample_trace'))

spec/support/commit_trailers_spec_helper.rb

+# frozen_string_literal: true
+
 module CommitTrailersSpecHelper
   extend ActiveSupport::Concern
 

spec/support/controllers/githubish_import_controller_shared_context.rb

+# frozen_string_literal: true
+
 shared_context 'a GitHub-ish import controller' do
   let(:user) { create(:user) }
   let(:token) { "asdasd12345" }

spec/support/controllers/githubish_import_controller_shared_examples.rb

+# frozen_string_literal: true
+
 # Specifications for behavior common to all objects with an email attribute.
 # Takes a list of email-format attributes and requires:
 # - subject { "the object with a attribute= setter"  }

spec/support/controllers/ldap_omniauth_callbacks_controller_shared_context.rb

+# frozen_string_literal: true
+
 require 'spec_helper'
 
 shared_context 'Ldap::OmniauthCallbacksController' do

spec/support/controllers/sessionless_auth_controller_shared_examples.rb

+# frozen_string_literal: true
+
 shared_examples 'authenticates sessionless user' do |path, format, params|
   params ||= {}
 

spec/support/cycle_analytics_helpers/test_generation.rb

+# frozen_string_literal: true
+
 # rubocop:disable Metrics/AbcSize
 
 # Note: The ABC size is large here because we have a method generating test cases with

spec/support/db_cleaner.rb

+# frozen_string_literal: true
+
 module DbCleaner
   def delete_from_all_tables!(except: nil)
     DatabaseCleaner.clean_with(:deletion, cache_tables: false, except: except)

spec/support/external_authorization_service_helpers.rb

+# frozen_string_literal: true
+
 module ExternalAuthorizationServiceHelpers
   def enable_external_authorization_service_check
     stub_application_setting(external_authorization_service_enabled: true)

spec/support/features/discussion_comments_shared_example.rb

+# frozen_string_literal: true
+
 shared_examples 'thread comments' do |resource_name|
   let(:form_selector) { '.js-main-target-form' }
   let(:dropdown_selector) { "#{form_selector} .comment-type-dropdown" }

spec/support/features/reportable_note_shared_examples.rb

+# frozen_string_literal: true
+
 require 'spec_helper'
 
 shared_examples 'reportable note' do |type|

spec/support/features/resolving_discussions_in_issues_shared_examples.rb

+# frozen_string_literal: true
+
 shared_examples 'creating an issue for a thread' do
   it 'shows an issue with the title filled in' do
     title_field = page.find_field('issue[title]')

spec/support/features/rss_shared_examples.rb

+# frozen_string_literal: true
+
 shared_examples "an autodiscoverable RSS feed with current_user's feed token" do
   it "has an RSS autodiscovery link tag with current_user's feed token" do
     expect(page).to have_css("link[type*='atom+xml'][href*='feed_token=#{user.feed_token}']", visible: false)

spec/support/features/variable_list_shared_examples.rb

+# frozen_string_literal: true
+
 shared_examples 'variable list' do
   it 'shows list of variables' do
     page.within('.js-ci-variable-list-section') do

spec/support/forgery_protection.rb

+# frozen_string_literal: true
+
 module ForgeryProtection
   def with_forgery_protection
     ActionController::Base.allow_forgery_protection = true

spec/support/google_api/cloud_platform_helpers.rb

+# frozen_string_literal: true
+
 module GoogleApi
   module CloudPlatformHelpers
     def stub_google_api_validate_token

spec/support/helpers/api_helpers.rb

+# frozen_string_literal: true
+
 module ApiHelpers
   # Public: Prepend a request path with the path to the API
   #
@@ -30,12 +32,13 @@ module ApiHelpers
     end
 
     if query_string
-      full_path << (path.index('?') ? '&' : '?')
-      full_path << query_string
-    end
+      separator = path.index('?') ? '&' : '?'
 
+      full_path + separator + query_string
+    else
       full_path
     end
+  end
 
   def expect_paginated_array_response(items)
     expect(response).to have_gitlab_http_status(200)

spec/support/helpers/assets_helpers.rb

+# frozen_string_literal: true
+
 module AssetsHelpers
   # In a CI environment the assets are not compiled, as there is a CI job
   # `compile-assets` that compiles them in the prepare stage for all following

spec/support/helpers/bare_repo_operations.rb

+# frozen_string_literal: true
+
 require 'zlib'
 
 class BareRepoOperations

spec/support/helpers/board_helpers.rb

+# frozen_string_literal: true
+
 module BoardHelpers
   def click_card(card)
     within card do

spec/support/helpers/capybara_helpers.rb

+# frozen_string_literal: true
+
 module CapybaraHelpers
   # Execute a block a certain number of times before considering it a failure
   #

spec/support/helpers/ci_artifact_metadata_generator.rb

+# frozen_string_literal: true
+
 # frozen_sting_literal: true
 
 # This generates fake CI metadata .gz for testing

spec/support/helpers/cookie_helper.rb

+# frozen_string_literal: true
+
 # Helper for setting cookies in Selenium/WebDriver
 #
 module CookieHelper

spec/support/helpers/cycle_analytics_helpers.rb

+# frozen_string_literal: true
+
 module CycleAnalyticsHelpers
   include GitHelpers
 

spec/support/helpers/database_connection_helpers.rb

+# frozen_string_literal: true
+
 module DatabaseConnectionHelpers
   def run_with_new_database_connection
     pool = ActiveRecord::Base.connection_pool

spec/support/helpers/devise_helpers.rb

+# frozen_string_literal: true
+
 module DeviseHelpers
   # explicitly tells Devise which mapping to use
   # this is needed when we are testing a Devise controller bypassing the router

spec/support/helpers/drag_to_helper.rb

+# frozen_string_literal: true
+
 module DragTo
   def drag_to(list_from_index: 0, from_index: 0, to_index: 0, list_to_index: 0, selector: '', scrollable: 'body', duration: 1000)
     evaluate_script("simulateDrag({scrollable: $('#{scrollable}').get(0), duration: #{duration}, from: {el: $('#{selector}').eq(#{list_from_index}).get(0), index: #{from_index}}, to: {el: $('#{selector}').eq(#{list_to_index}).get(0), index: #{to_index}}});")

spec/support/helpers/dropzone_helper.rb

+# frozen_string_literal: true
+
 module DropzoneHelper
   # Provides a way to perform `attach_file` for a Dropzone-based file input
   #

spec/support/helpers/email_helpers.rb

+# frozen_string_literal: true
+
 module EmailHelpers
   def sent_to_user(user, recipients: email_recipients)
     recipients.count { |to| to == user.notification_email }

spec/support/helpers/exclusive_lease_helpers.rb

+# frozen_string_literal: true
+
 module ExclusiveLeaseHelpers
   def stub_exclusive_lease(key = nil, uuid = 'uuid', renew: false, timeout: nil)
     key     ||= instance_of(String)

spec/support/helpers/expect_next_instance_of.rb

+# frozen_string_literal: true
+
 module ExpectNextInstanceOf
   def expect_next_instance_of(klass, *new_args)
     receive_new = receive(:new)

spec/support/helpers/expect_offense.rb

+# frozen_string_literal: true
+
 require 'rubocop/rspec/support'
 
 # https://github.com/backus/rubocop-rspec/blob/master/spec/support/expect_offense.rb

spec/support/helpers/fake_blob_helpers.rb

+# frozen_string_literal: true
+
 module FakeBlobHelpers
   class FakeBlob
     include BlobLike

spec/support/helpers/fake_migration_classes.rb

+# frozen_string_literal: true
+
 class FakeRenameReservedPathMigrationV1 < ActiveRecord::Migration[4.2]
   include Gitlab::Database::RenameReservedPathsMigration::V1
 

spec/support/helpers/fake_u2f_device.rb

+# frozen_string_literal: true
+
 class FakeU2fDevice
   attr_reader :name
 

spec/support/helpers/features/branches_helpers.rb

+# frozen_string_literal: true
+
 # These helpers allow you to manipulate with sorting features.
 #
 # Usage:

spec/support/helpers/features/notes_helpers.rb

+# frozen_string_literal: true
+
 # These helpers allow you to manipulate with notes.
 #
 # Usage:

spec/support/helpers/features/sorting_helpers.rb

+# frozen_string_literal: true
+
 # These helpers allow you to manipulate with sorting features.
 #
 # Usage:

spec/support/helpers/filter_spec_helper.rb

+# frozen_string_literal: true
+
 # Helper methods for Banzai filter specs
 #
 # Must be included into specs manually

spec/support/helpers/filtered_search_helpers.rb

+# frozen_string_literal: true
+
 module FilteredSearchHelpers
   def filtered_search
     page.find('.filtered-search')

spec/support/helpers/fixture_helpers.rb

+# frozen_string_literal: true
+
 module FixtureHelpers
   def fixture_file(filename, dir: '')
     return '' if filename.blank?

spec/support/helpers/git_http_helpers.rb

+# frozen_string_literal: true
+
 require_relative 'workhorse_helpers'
 
 module GitHttpHelpers

spec/support/helpers/gitlab_verify_helpers.rb

+# frozen_string_literal: true
+
 module GitlabVerifyHelpers
   def collect_ranges(args = {})
     verifier = described_class.new(args.merge(batch_size: 1))

spec/support/helpers/graphql_helpers.rb

+# frozen_string_literal: true
+
 module GraphqlHelpers
   MutationDefinition = Struct.new(:query, :variables)
 

spec/support/helpers/import_spec_helper.rb

+# frozen_string_literal: true
+
 require 'ostruct'
 
 # Helper methods for controller specs in the Import namespace

spec/support/helpers/input_helper.rb

+# frozen_string_literal: true
+
 # see app/assets/javascripts/test_utils/simulate_input.js
 
 module InputHelper

spec/support/helpers/inspect_requests.rb

+# frozen_string_literal: true
+
 require_relative './wait_for_requests'
 
 module InspectRequests

spec/support/helpers/issue_helpers.rb

+# frozen_string_literal: true
+
 module IssueHelpers
   def visit_issues(project, opts = {})
     visit project_issues_path project, opts

spec/support/helpers/javascript_fixtures_helpers.rb

+# frozen_string_literal: true
+
 require 'action_dispatch/testing/test_request'
 require 'fileutils'
 

spec/support/helpers/jira_service_helper.rb

+# frozen_string_literal: true
+
 module JiraServiceHelper
   JIRA_URL = "http://jira.example.net".freeze
   JIRA_API = JIRA_URL + "/rest/api/2"

spec/support/helpers/key_generator_helper.rb

+# frozen_string_literal: true
+
 module Spec
   module Support
     module Helpers

spec/support/helpers/kubernetes_helpers.rb

+# frozen_string_literal: true
+
 module KubernetesHelpers
   include Gitlab::Kubernetes
 

spec/support/helpers/ldap_helpers.rb

+# frozen_string_literal: true
+
 module LdapHelpers
   def ldap_adapter(provider = 'ldapmain', ldap = double(:ldap))
     ::Gitlab::Auth::LDAP::Adapter.new(provider, ldap)

spec/support/helpers/live_debugger.rb

+# frozen_string_literal: true
+
 require 'io/console'
 
 module LiveDebugger

spec/support/helpers/login_helpers.rb

+# frozen_string_literal: true
+
 require_relative 'devise_helpers'
 
 module LoginHelpers

spec/support/helpers/markdown_feature.rb

+# frozen_string_literal: true
+
 # This is a helper class used by the GitLab Markdown feature spec
 #
 # Because the feature spec only cares about the output of the Markdown, and the

spec/support/helpers/merge_request_diff_helpers.rb

+# frozen_string_literal: true
+
 module MergeRequestDiffHelpers
   def click_diff_line(line_holder, diff_side = nil)
     line = get_line_components(line_holder, diff_side)

spec/support/helpers/merge_request_helpers.rb

+# frozen_string_literal: true
+
 module MergeRequestHelpers
   def visit_merge_requests(project, opts = {})
     visit project_merge_requests_path project, opts

spec/support/helpers/migrations_helpers.rb

+# frozen_string_literal: true
+
 module MigrationsHelpers
   def active_record_base
     ActiveRecord::Base

spec/support/helpers/mobile_helpers.rb

+# frozen_string_literal: true
+
 module MobileHelpers
   def resize_screen_xs
     resize_window(575, 768)

spec/support/helpers/note_interaction_helpers.rb

+# frozen_string_literal: true
+
 module NoteInteractionHelpers
   def open_more_actions_dropdown(note)
     note_element = find("#note_#{note.id}")

spec/support/helpers/notification_helpers.rb

+# frozen_string_literal: true
+
 module NotificationHelpers
   extend self
 

spec/support/helpers/project_forks_helper.rb

+# frozen_string_literal: true
+
 module ProjectForksHelper
   def fork_project(project, user = nil, params = {})
     Gitlab::GitalyClient.allow_n_plus_1_calls do

spec/support/helpers/prometheus_helpers.rb

+# frozen_string_literal: true
+
 module PrometheusHelpers
   def prometheus_memory_query(environment_slug)
     %{avg(container_memory_usage_bytes{container_name!="POD",environment="#{environment_slug}"}) / 2^20}

spec/support/helpers/query_recorder.rb

+# frozen_string_literal: true
+
 module ActiveRecord
   class QueryRecorder
     attr_reader :log, :skip_cached, :cached

spec/support/helpers/quick_actions_helpers.rb

+# frozen_string_literal: true
+
 module QuickActionsHelpers
   def write_note(text)
     Sidekiq::Testing.fake! do

spec/support/helpers/rake_helpers.rb

+# frozen_string_literal: true
+
 module RakeHelpers
   def run_rake_task(task_name, *args)
     Rake::Task[task_name].reenable

spec/support/helpers/reactive_caching_helpers.rb

+# frozen_string_literal: true
+
 module ReactiveCachingHelpers
   def reactive_cache_key(subject, *qualifiers)
     ([subject.class.reactive_cache_key.call(subject)].flatten + qualifiers).join(':')

spec/support/helpers/redis_without_keys.rb

+# frozen_string_literal: true
+
 class Redis
   ForbiddenCommand = Class.new(StandardError)
 

spec/support/helpers/reference_parser_helpers.rb

+# frozen_string_literal: true
+
 module ReferenceParserHelpers
   def empty_html_link
     Nokogiri::HTML.fragment('<a></a>').children[0]

spec/support/helpers/repo_helpers.rb

+# frozen_string_literal: true
+
 module RepoHelpers
   extend self
 

spec/support/helpers/routes_helpers.rb

+# frozen_string_literal: true
+
 module RoutesHelpers
   def fake_routes(&block)
     @routes = @routes.dup

spec/support/helpers/search_helpers.rb

+# frozen_string_literal: true
+
 module SearchHelpers
   def select_filter(name)
     find(:xpath, "//ul[contains(@class, 'search-filter')]//a[contains(.,'#{name}')]").click

spec/support/helpers/seed_repo.rb

+# frozen_string_literal: true
+
 # This file is generated by generate-seed-repo-rb. Do not edit this file manually.
 #
 # Seed repo:

spec/support/helpers/select2_helper.rb

+# frozen_string_literal: true
+
 require_relative 'wait_for_requests'
 
 # Select2 ajax programmatic helper

spec/support/helpers/selection_helper.rb

+# frozen_string_literal: true
+
 module SelectionHelper
   def select_element(selector)
     find(selector)

spec/support/helpers/sorting_helper.rb

+# frozen_string_literal: true
+
 # Helper allows you to sort items
 #
 # Params

spec/support/helpers/stub_configuration.rb

+# frozen_string_literal: true
+
 require 'active_support/core_ext/hash/transform_values'
 require 'active_support/hash_with_indifferent_access'
 require 'active_support/dependencies'

spec/support/helpers/stub_env.rb

+# frozen_string_literal: true
+
 # Inspired by https://github.com/ljkbennett/stub_env/blob/master/lib/stub_env/helpers.rb
 module StubENV
   def stub_env(key_or_hash, value = nil)

spec/support/helpers/stub_feature_flags.rb

+# frozen_string_literal: true
+
 module StubFeatureFlags
   # Stub Feature flags with `flag_name: true/false`
   #

spec/support/helpers/stub_gitlab_calls.rb

+# frozen_string_literal: true
+
 module StubGitlabCalls
   def stub_gitlab_calls
     stub_user

spec/support/helpers/stub_gitlab_data.rb

+# frozen_string_literal: true
+
 module StubGitlabData
   def gitlab_ci_yaml
     File.read(Rails.root.join('spec/support/gitlab_stubs/gitlab_ci.yml'))

spec/support/helpers/stub_metrics.rb

+# frozen_string_literal: true
+
 module StubMetrics
   def authentication_metrics
     Gitlab::Auth::Activity

spec/support/helpers/stub_object_storage.rb

+# frozen_string_literal: true
+
 module StubObjectStorage
   def stub_object_storage_uploader(
         config:,