Merge branch '391477_rename_project_param_to_container' into 'master'

Refactor initializer arguments for Issues::BuildService

See merge request https://gitlab.com/gitlab-org/gitlab/-/merge_requests/111907



Merged-by: Jan Provaznik <jprovaznik@gitlab.com>
Approved-by: Mario Celi <mcelicalderon@gitlab.com>
Approved-by: Jan Provaznik <jprovaznik@gitlab.com>
Reviewed-by: Michał Zając <mzajac@gitlab.com>
Co-authored-by: Alexandru Croitor <acroitor@gitlab.com>

app/controllers/projects/issues_controller.rb

@@ -128,7 +128,7 @@ def new
       discussion_to_resolve: params[:discussion_to_resolve],
       confidential: !!Gitlab::Utils.to_boolean(issue_params[:confidential])
     )
-    service = ::Issues::BuildService.new(project: project, current_user: current_user, params: build_params)
+    service = ::Issues::BuildService.new(container: project, current_user: current_user, params: build_params)
 
     @issue = @noteable = service.execute
 

app/services/issues/build_service.rb

@@ -4,6 +4,11 @@ module Issues
   class BuildService < Issues::BaseService
     include ResolveDiscussions
 
+    # TODO: this is to be removed once we get to rename the IssuableBaseService project param to container
+    def initialize(container:, current_user: nil, params: {})
+      super(project: container, current_user: current_user, params: params)
+    end
+
     def execute
       filter_resolve_discussion_params
 

app/services/issues/create_service.rb

@@ -17,7 +17,7 @@ def initialize(project:, spam_params:, current_user: nil, params: {}, build_serv
       @extra_params = params.delete(:extra_params) || {}
       super(project: project, current_user: current_user, params: params)
       @spam_params = spam_params
-      @build_service = build_service || BuildService.new(project: project, current_user: current_user, params: params)
+      @build_service = build_service || BuildService.new(container: project, current_user: current_user, params: params)
     end
 
     def execute(skip_system_notes: false)

app/services/tasks_to_be_done/base_service.rb

@@ -19,7 +19,7 @@ def execute
         update_service = Issues::UpdateService.new(project: project, current_user: current_user, params: { add_assignee_ids: params[:assignee_ids] })
         update_service.execute(issue)
       else
-        build_service = Issues::BuildService.new(project: project, current_user: current_user, params: params)
+        build_service = Issues::BuildService.new(container: project, current_user: current_user, params: params)
         create(build_service.execute)
       end
     end

app/services/work_items/create_service.rb

@@ -10,7 +10,7 @@ def initialize(project:, spam_params:, current_user: nil, params: {}, widget_par
         current_user: current_user,
         params: params,
         spam_params: spam_params,
-        build_service: ::WorkItems::BuildService.new(project: project, current_user: current_user, params: params)
+        build_service: ::WorkItems::BuildService.new(container: project, current_user: current_user, params: params)
       )
       @widget_params = widget_params
     end

ee/app/services/issues/build_from_vulnerability_service.rb

-# frozen_string_literal: true
-
-module Issues
-  class BuildFromVulnerabilityService < Issues::BuildService
-    def execute
-      vulnerability = params[:vulnerability]
-
-      params.merge!(
-        title: _("Investigate vulnerability: %{title}") % { title: vulnerability.title },
-        description: render_description(vulnerability),
-        confidential: true
-      )
-
-      super
-    end
-
-    private
-
-    def render_description(vulnerability)
-      ApplicationController.render(
-        template: 'vulnerabilities/issue_description',
-        formats: :md,
-        locals: { vulnerability: vulnerability.present }
-      )
-    end
-  end
-end

ee/spec/services/ee/issues/build_from_vulnerability_service_spec.rb

-# frozen_string_literal: true
-
-require 'spec_helper'
-
-RSpec.describe Issues::BuildFromVulnerabilityService do
-  describe '#execute' do
-    let_it_be(:group)   { create(:group) }
-    let_it_be(:project) { create(:project, :public, :repository, namespace: group) }
-    let_it_be(:user)    { create(:user) }
-
-    before_all do
-      group.add_developer(user)
-    end
-
-    before do
-      stub_licensed_features(security_dashboard: true)
-    end
-
-    it 'builds the issue with the given params' do
-      vulnerability = create(:vulnerability, :with_finding, project: project)
-      service = described_class.new(project: project, current_user: user, params: { vulnerability: vulnerability })
-
-      issue = service.execute
-
-      expect(issue).not_to be_persisted
-      expect(issue).to have_attributes(
-        project: project,
-        author: user,
-        title: "Investigate vulnerability: #{vulnerability.title}",
-        description:
-          <<~DESC
-            Issue created from vulnerability <a href="http://localhost/#{group.name}/#{project.name}/-/security/vulnerabilities/#{vulnerability.id}">#{vulnerability.id}</a>
-
-            ### Description:
-
-            Description of #{vulnerability.title}
-
-            * Severity: #{vulnerability.severity}
-            * Confidence: #{vulnerability.confidence}
-            * Location: [maven/src/main/java/com/gitlab/security_products/tests/App.java:29](http://localhost/#{project.full_path}/-/blob/master/maven/src/main/java/com/gitlab/security_products/tests/App.java#L29)
-
-            #### Evidence
-
-            * Method: `GET`
-            * URL: http://goat:8080/WebGoat/logout
-
-            ##### Request:
-
-            ```
-            Accept : */*
-            ```
-
-            ##### Response:
-
-            ```
-            Content-Length : 0
-            ```
-
-            ### Solution:
-
-            #{vulnerability.solution}
-
-            ### Identifiers:
-
-            * [CVE-2018-1234](http://cve.mitre.org/cgi-bin/cvename.cgi?name=2018-1234)
-
-            ### Links:
-
-            * [Cipher does not check for integrity first?](https://crypto.stackexchange.com/questions/31428/pbewithmd5anddes-cipher-does-not-check-for-integrity-first)
-
-            ### Scanner:
-
-            * Name: Find Security Bugs
-
-            /confidential
-          DESC
-      )
-    end
-
-    context 'when a vulnerability has remediations' do
-      it 'displays Remediations section with attached diff' do
-        vulnerability = create(:vulnerability, :with_remediation, project: project)
-        service = described_class.new(project: project, current_user: user, params: { vulnerability: vulnerability })
-
-        issue = service.execute
-
-        expect(issue.description).to match(/Remediations/)
-        expect(issue.description).to match(/This is a diff/)
-      end
-    end
-  end
-end

ee/spec/services/issues/build_service_spec.rb

@@ -15,7 +15,7 @@
   end
 
   def build_issue(issue_params = {})
-    described_class.new(project: project, current_user: user, params: issue_params).execute
+    described_class.new(container: project, current_user: user, params: issue_params).execute
   end
 
   context 'with an issue template' do

spec/services/issues/build_service_spec.rb

@@ -19,7 +19,7 @@
   end
 
   def build_issue(issue_params = {})
-    described_class.new(project: project, current_user: user, params: issue_params).execute
+    described_class.new(container: project, current_user: user, params: issue_params).execute
   end
 
   context 'for a single discussion' do
@@ -45,7 +45,7 @@ def build_issue(issue_params = {})
     describe '#items_for_discussions' do
       it 'has an item for each discussion' do
         create(:diff_note_on_merge_request, noteable: merge_request, project: merge_request.source_project, line_number: 13)
-        service = described_class.new(project: project, current_user: user, params: { merge_request_to_resolve_discussions_of: merge_request.iid })
+        service = described_class.new(container: project, current_user: user, params: { merge_request_to_resolve_discussions_of: merge_request.iid })
 
         service.execute
 
@@ -54,7 +54,7 @@ def build_issue(issue_params = {})
     end
 
     describe '#item_for_discussion' do
-      let(:service) { described_class.new(project: project, current_user: user, params: { merge_request_to_resolve_discussions_of: merge_request.iid }) }
+      let(:service) { described_class.new(container: project, current_user: user, params: { merge_request_to_resolve_discussions_of: merge_request.iid }) }
 
       it 'mentions the author of the note' do
         discussion = create(:diff_note_on_merge_request, author: create(:user, username: 'author')).to_discussion

spec/services/tasks_to_be_done/base_service_spec.rb

@@ -35,7 +35,7 @@
 
       expect(Issues::BuildService)
         .to receive(:new)
-        .with(project: project, current_user: current_user, params: params)
+        .with(container: project, current_user: current_user, params: params)
         .and_call_original
 
       expect { service.execute }.to change(Issue, :count).by(1)

spec/services/work_items/build_service_spec.rb

@@ -13,7 +13,7 @@
   end
 
   describe '#execute' do
-    subject { described_class.new(project: project, current_user: user, params: {}).execute }
+    subject { described_class.new(container: project, current_user: user, params: {}).execute }
 
     it { is_expected.to be_a(::WorkItem) }
   end