Merge branch '342135-move-presenters' into 'master'

Move Security ConfigurationPresenter to FOSS

See merge request gitlab-org/gitlab!75472

ee/app/presenters/projects/security/configuration_presenter.rb → app/presenters/projects/security/configuration_presenter.rb

@@ -17,14 +17,14 @@ module Projects
           features: features,
           help_page_path: help_page_path('user/application_security/index'),
           latest_pipeline_path: latest_pipeline_path,
-          auto_fix_enabled: autofix_enabled,
-          can_toggle_auto_fix_settings: auto_fix_permission,
           # TODO: gitlab_ci_present will incorrectly report `false` if the CI/CD configuration file name
           # has been customized and a file with the given custom name exists in the repo. This edge case
           # will be addressed in https://gitlab.com/gitlab-org/gitlab/-/issues/342465
           gitlab_ci_present: project.repository.gitlab_ci_yml.present?,
           gitlab_ci_history_path: gitlab_ci_history_path,
-          auto_fix_user_path: '/' # TODO: real link will be updated with https://gitlab.com/gitlab-org/gitlab/-/issues/215669
+          auto_fix_enabled: autofix_enabled,
+          can_toggle_auto_fix_settings: can_toggle_autofix,
+          auto_fix_user_path: auto_fix_user_path
         }
       end
 
@@ -38,12 +38,9 @@ module Projects
 
       private
 
-      def autofix_enabled
-        {
-          dependency_scanning: project_settings&.auto_fix_dependency_scanning,
-          container_scanning: project_settings&.auto_fix_container_scanning
-        }
-      end
+      def autofix_enabled; end
+
+      def auto_fix_user_path; end
 
       def can_enable_auto_devops?
         feature_available?(:builds, current_user) &&
@@ -51,11 +48,13 @@ module Projects
           !archived?
       end
 
+      def can_toggle_autofix; end
+
       def gitlab_ci_history_path
         return '' if project.empty_repo?
 
-        gitlab_ci = Gitlab::FileDetector::PATTERNS[:gitlab_ci]
-        Gitlab::Routing.url_helpers.project_blame_path(project, File.join(project.default_branch_or_main, gitlab_ci))
+        gitlab_ci = ::Gitlab::FileDetector::PATTERNS[:gitlab_ci]
+        ::Gitlab::Routing.url_helpers.project_blame_path(project, File.join(project.default_branch_or_main, gitlab_ci))
       end
 
       def features
@@ -75,11 +74,13 @@ module Projects
       end
 
       def scan(type, configured: false)
+        scan = ::Gitlab::Security::ScanConfiguration.new(project: project, type: type, configured: configured)
+
         {
-          type: type,
-          configured: configured,
-          configuration_path: configuration_path(type),
-          available: feature_available(type)
+          type: scan.type,
+          configured: scan.configured?,
+          configuration_path: scan.configuration_path,
+          available: scan.available?
         }
       end
 
@@ -90,23 +91,8 @@ module Projects
       def project_settings
         project.security_setting
       end
-
-      def configuration_path(type)
-        {
-          sast: project_security_configuration_sast_path(project),
-          dast: project_security_configuration_dast_path(project),
-          dast_profiles: project_security_configuration_dast_scans_path(project),
-          api_fuzzing: project_security_configuration_api_fuzzing_path(project),
-          corpus_management: (project_security_configuration_corpus_management_path(project) if ::Feature.enabled?(:corpus_management, project, default_enabled: :yaml) && scanner_enabled?(:coverage_fuzzing))
-        }[type]
-      end
-
-      def feature_available(type)
-        # SAST and Secret Detection are always available, but this isn't
-        # reflected by our license model yet.
-        # TODO: https://gitlab.com/gitlab-org/gitlab/-/issues/333113
-        %w[sast secret_detection].include?(type) || project.licensed_feature_available?(type)
-      end
     end
   end
 end
+
+Projects::Security::ConfigurationPresenter.prepend_mod_with('Projects::Security::ConfigurationPresenter')

ee/app/presenters/ee/projects/security/configuration_presenter.rb

+# frozen_string_literal: true
+
+module EE
+  module Projects
+    module Security
+      module ConfigurationPresenter
+        extend ::Gitlab::Utils::Override
+
+        private
+
+        override :can_toggle_autofix
+        def can_toggle_autofix
+          try(:auto_fix_permission)
+        end
+
+        override :autofix_enabled
+        def autofix_enabled
+          {
+            dependency_scanning: project_settings&.auto_fix_dependency_scanning,
+            container_scanning: project_settings&.auto_fix_container_scanning
+          }
+        end
+
+        override :auto_fix_user_path
+        def auto_fix_user_path
+          '/' # TODO: real link will be updated with https://gitlab.com/gitlab-org/gitlab/-/issues/348463
+        end
+      end
+    end
+  end
+end

ee/lib/ee/gitlab/security/scan_configuration.rb

+# frozen_string_literal: true
+
+module EE
+  module Gitlab
+    module Security
+      module ScanConfiguration
+        extend ::Gitlab::Utils::Override
+
+        override :available?
+        def available?
+          super || project.licensed_feature_available?(type)
+        end
+
+        override :configuration_path
+        def configuration_path
+          super if available? || always_available?
+        end
+
+        private
+
+        override :configurable_scans
+        def configurable_scans
+          strong_memoize(:configurable_scans) do
+            {
+              dast: project_security_configuration_dast_path(project),
+              dast_profiles: project_security_configuration_dast_scans_path(project),
+              api_fuzzing: project_security_configuration_api_fuzzing_path(project),
+              corpus_management: (project_security_configuration_corpus_management_path(project) if ::Feature.enabled?(:corpus_management, project, default_enabled: :yaml))
+            }.merge(super)
+          end
+        end
+
+        def always_available?
+          [:corpus_management, :dast_profiles].include?(type)
+        end
+      end
+    end
+  end
+end

ee/lib/gitlab/graphql/aggregations/security_orchestration_policies/lazy_dast_profile_aggregate.rb

@@ -39,7 +39,7 @@ module Gitlab
             # The record hasn't been loaded yet, so
             # hit the database with all pending IDs to prevent N+1
             profiles_by_project_id = @lazy_state[:dast_pending_profiles].group_by(&:project_id)
-            policy_configurations = Security::OrchestrationPolicyConfiguration.for_project(profiles_by_project_id.keys).index_by(&:project_id)
+            policy_configurations = ::Security::OrchestrationPolicyConfiguration.for_project(profiles_by_project_id.keys).index_by(&:project_id)
 
             profiles_by_project_id.each do |project_id, dast_pending_profiles|
               dast_pending_profiles.each do |profile|

ee/spec/features/projects/security/user_views_security_configuration_spec.rb

@@ -8,7 +8,7 @@ RSpec.describe 'User sees Security Configuration table', :js do
   let_it_be(:pipeline) { create(:ci_pipeline, project: project) }
 
   before_all do
-    project.add_developer(user)
+    project.add_maintainer(user)
   end
 
   before do
@@ -17,12 +17,14 @@ RSpec.describe 'User sees Security Configuration table', :js do
 
   context 'with security_dashboard feature available' do
     before do
-      stub_licensed_features(security_dashboard: true, sast: true, sast_iac: true, dast: true)
+      stub_licensed_features(security_dashboard: true, sast: true, sast_iac: true, dast: true,
+                             dependency_scanning: true, container_scanning: true, coverage_fuzzing: true,
+                             cluster_image_scanning: true, api_fuzzing: true)
     end
 
     context 'with no SAST report' do
       it 'shows SAST is not enabled' do
-        visit(project_security_configuration_path(project))
+        visit_configuration_page
 
         within_sast_card do
           expect(page).to have_text('SAST')
@@ -38,7 +40,7 @@ RSpec.describe 'User sees Security Configuration table', :js do
       end
 
       it 'shows SAST is enabled' do
-        visit(project_security_configuration_path(project))
+        visit_configuration_page
 
         within_sast_card do
           expect(page).to have_text('SAST')
@@ -50,7 +52,7 @@ RSpec.describe 'User sees Security Configuration table', :js do
 
     context 'enabling SAST IaC' do
       it 'redirects to new MR page' do
-        visit(project_security_configuration_path(project))
+        visit_configuration_page
 
         within_sast_iac_card do
           expect(page).to have_text('Infrastructure as Code (IaC) Scanning')
@@ -67,12 +69,13 @@ RSpec.describe 'User sees Security Configuration table', :js do
 
     context 'with no DAST report' do
       it 'shows DAST is not enabled' do
-        visit(project_security_configuration_path(project))
+        visit_configuration_page
 
         within_dast_card do
           expect(page).to have_text('DAST')
           expect(page).to have_text('Not enabled')
           expect(page).to have_link('Enable DAST')
+          expect(page).to have_link('Manage scans')
         end
       end
     end
@@ -83,17 +86,110 @@ RSpec.describe 'User sees Security Configuration table', :js do
       end
 
       it 'shows DAST is enabled' do
-        visit(project_security_configuration_path(project))
+        visit_configuration_page
 
         within_dast_card do
           expect(page).to have_text('DAST')
           expect(page).to have_text('Enabled')
           expect(page).to have_link('Configure DAST')
+          expect(page).to have_link('Manage scans')
+        end
+      end
+    end
+
+    context 'with no Dependency Scanning report' do
+      it 'shows Dependency Scanning is disabled' do
+        visit_configuration_page
+
+        within_dependency_scanning_card do
+          expect(page).to have_text('Dependency Scanning')
+          expect(page).to have_text('Not enabled')
+          expect(page).to have_button('Configure with a merge request')
+        end
+      end
+    end
+
+    context 'with Dependency Scanning report' do
+      before do
+        create(:ci_build, :dependency_scanning, pipeline: pipeline, status: 'success')
+      end
+
+      it 'shows Dependency Scanning is enabled' do
+        visit_configuration_page
+
+        within_dependency_scanning_card do
+          expect(page).to have_text('Dependency Scanning')
+          expect(page).to have_text('Enabled')
+          expect(page).to have_link('Configuration guide')
+        end
+      end
+    end
+
+    context 'with no Container Scanning report' do
+      it 'shows Container Scanning is disabled' do
+        visit_configuration_page
+
+        within_container_scanning_card do
+          expect(page).to have_text('Container Scanning')
+          expect(page).to have_text('Not enabled')
+          expect(page).to have_link('Configuration guide')
+        end
+      end
+    end
+
+    context 'with no Cluster Image scanning report' do
+      it 'shows Cluster Image scanning is disabled' do
+        visit_configuration_page
+
+        within_cluster_image_card do
+          expect(page).to have_text('Cluster Image Scanning')
+          expect(page).to have_text('Not enabled')
+          expect(page).to have_link('Configuration guide')
+        end
+      end
     end
+
+    context 'with no Secret Detection report' do
+      it 'shows Secret Detection is disabled' do
+        visit_configuration_page
+
+        within_secret_detection_card do
+          expect(page).to have_text('Secret Detection')
+          expect(page).to have_text('Not enabled')
+          expect(page).to have_button('Configure with a merge request')
         end
       end
     end
 
+    context 'with no API Fuzzing report' do
+      it 'shows API Fuzzing is disabled' do
+        visit_configuration_page
+
+        within_api_fuzzing_card do
+          expect(page).to have_text('API Fuzzing')
+          expect(page).to have_text('Not enabled')
+          expect(page).to have_link('Enable API Fuzzing')
+        end
+      end
+    end
+
+    context 'with no Coverage Fuzzing' do
+      it 'shows Coverage Fuzzing is disabled' do
+        visit_configuration_page
+
+        within_coverage_fuzzing_card do
+          expect(page).to have_text('Coverage Fuzzing')
+          expect(page).to have_text('Not enabled')
+          expect(page).to have_link('Configuration guide')
+        end
+      end
+    end
+  end
+
+  def visit_configuration_page
+    visit(project_security_configuration_path(project))
+  end
+
   def within_sast_card
     within '[data-testid="security-testing-card"]:nth-of-type(1)' do
       yield
@@ -111,4 +207,40 @@ RSpec.describe 'User sees Security Configuration table', :js do
       yield
     end
   end
+
+  def within_dependency_scanning_card
+    within '[data-testid="security-testing-card"]:nth-of-type(4)' do
+      yield
+    end
+  end
+
+  def within_container_scanning_card
+    within '[data-testid="security-testing-card"]:nth-of-type(5)' do
+      yield
+    end
+  end
+
+  def within_cluster_image_card
+    within '[data-testid="security-testing-card"]:nth-of-type(6)' do
+      yield
+    end
+  end
+
+  def within_secret_detection_card
+    within '[data-testid="security-testing-card"]:nth-of-type(7)' do
+      yield
+    end
+  end
+
+  def within_api_fuzzing_card
+    within '[data-testid="security-testing-card"]:nth-of-type(8)' do
+      yield
+    end
+  end
+
+  def within_coverage_fuzzing_card
+    within '[data-testid="security-testing-card"]:nth-of-type(9)' do
+      yield
+    end
+  end
 end

ee/spec/lib/ee/gitlab/security/scan_configuration_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::Gitlab::Security::ScanConfiguration do
+  let_it_be(:project) { create(:project, :repository) }
+
+  let(:scan) { described_class.new(project: project, type: type, configured: configured) }
+
+  describe '#available?' do
+    subject { scan.available? }
+
+    let(:configured) { true }
+
+    context 'with a core scanner' do
+      let(:type) { :sast }
+
+      before do
+        stub_licensed_features(sast: false)
+      end
+
+      it 'core scanners (SAST, Secret Detection) are always available' do
+        is_expected.to be_truthy
+      end
+    end
+
+    context 'with licensed scanner that is available' do
+      let(:type) { :api_fuzzing }
+
+      before do
+        stub_licensed_features(api_fuzzing: true)
+      end
+
+      it { is_expected.to be_truthy }
+    end
+
+    context 'with licensed scanner that is not available' do
+      let(:type) { :api_fuzzing }
+
+      before do
+        stub_licensed_features(api_fuzzing: false)
+      end
+
+      it { is_expected.to be_falsey }
+    end
+
+    context 'with custom scanner' do
+      let(:type) { :my_scanner }
+
+      it { is_expected.to be_falsey }
+    end
+  end
+
+  describe '#configuration_path' do
+    subject { scan.configuration_path }
+
+    let(:configured) { true }
+
+    context 'with licensed scanner' do
+      let(:type) { :dast }
+      let(:configuration_path) { "/#{project.namespace.path}/#{project.name}/-/security/configuration/dast" }
+
+      before do
+        stub_licensed_features(dast: true)
+      end
+
+      it { is_expected.to eq(configuration_path) }
+    end
+
+    context 'with always available scanner' do
+      let(:type) { :dast_profiles }
+      let(:configuration_path) { "/#{project.namespace.path}/#{project.name}/-/security/configuration/dast_scans" }
+
+      it { is_expected.to eq(configuration_path) }
+    end
+
+    context 'with a scanner under feature flag' do
+      let(:type) { :corpus_management }
+      let(:configuration_path) { "/#{project.namespace.path}/#{project.name}/-/security/configuration/corpus_management" }
+
+      it { is_expected.to eq(configuration_path) }
+
+      context 'when feature flag is disabled' do
+        before do
+          stub_feature_flags(corpus_management: false)
+        end
+
+        it { is_expected.to be_nil }
+      end
+    end
+  end
+end

ee/spec/presenters/ee/projects/security/configuration_presenter_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Projects::Security::ConfigurationPresenter do
+  include Gitlab::Routing.url_helpers
+
+  let_it_be(:project) { create(:project, :repository) }
+  let_it_be(:current_user) { create(:user) }
+
+  describe '#to_h' do
+    subject(:result) { described_class.new(project, auto_fix_permission: true, current_user: current_user).to_h }
+
+    it 'includes settings for auto_fix feature' do
+      auto_fix = result[:auto_fix_enabled]
+
+      expect(auto_fix[:dependency_scanning]).to be_truthy
+      expect(auto_fix[:container_scanning]).to be_truthy
+    end
+
+    it 'reports auto_fix permissions' do
+      expect(result[:can_toggle_auto_fix_settings]).to be_truthy
+    end
+  end
+end

lib/gitlab/security/scan_configuration.rb

+# frozen_string_literal: true
+
+module Gitlab
+  module Security
+    class ScanConfiguration
+      include ::Gitlab::Utils::StrongMemoize
+      include Gitlab::Routing.url_helpers
+
+      attr_reader :type
+
+      def initialize(project:, type:, configured: false)
+        @project = project
+        @type = type
+        @configured = configured
+      end
+
+      def available?
+        # SAST and Secret Detection are always available, but this isn't
+        # reflected by our license model yet.
+        # TODO: https://gitlab.com/gitlab-org/gitlab/-/issues/333113
+        %i[sast secret_detection].include?(type)
+      end
+
+      def configured?
+        configured
+      end
+
+      def configuration_path
+        configurable_scans[type]
+      end
+
+      private
+
+      attr_reader :project, :configured
+
+      def configurable_scans
+        strong_memoize(:configurable_scans) do
+          {
+            sast: project_security_configuration_sast_path(project)
+          }
+        end
+      end
+    end
+  end
+end
+
+Gitlab::Security::ScanConfiguration.prepend_mod_with('Gitlab::Security::ScanConfiguration')

spec/lib/gitlab/security/scan_configuration_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ::Gitlab::Security::ScanConfiguration do
+  let_it_be(:project) { create(:project, :repository) }
+
+  let(:scan) { described_class.new(project: project, type: type, configured: configured) }
+
+  describe '#available?' do
+    subject { scan.available? }
+
+    let(:configured) { true }
+
+    context 'with a core scanner' do
+      let(:type) { :sast }
+
+      it { is_expected.to be_truthy }
+    end
+
+    context 'with custom scanner' do
+      let(:type) { :my_scanner }
+
+      it { is_expected.to be_falsey }
+    end
+  end
+
+  describe '#configured?' do
+    subject { scan.configured? }
+
+    let(:type) { :sast }
+    let(:configured) { false }
+
+    it { is_expected.to be_falsey }
+  end
+
+  describe '#configuration_path' do
+    subject { scan.configuration_path }
+
+    let(:configured) { true }
+
+    context 'with a non configurable scanner' do
+      let(:type) { :secret_detection }
+
+      it { is_expected.to be_nil }
+    end
+
+    context 'with licensed scanner for FOSS environment' do
+      let(:type) { :dast }
+
+      before do
+        stub_env('FOSS_ONLY', '1')
+      end
+
+      it { is_expected.to be_nil }
+    end
+
+    context 'with custom scanner' do
+      let(:type) { :my_scanner }
+
+      it { is_expected.to be_nil }
+    end
+  end
+end