Merge branch '323789-dast-profiles-branch-info' into 'master'

Show branch info in DAST profiles library

See merge request gitlab-org/gitlab!56019

ee/app/assets/javascripts/security_configuration/dast_profiles/components/dast_saved_scans_list.vue

@@ -3,16 +3,20 @@ import { GlButton } from '@gitlab/ui';
 import * as Sentry from '@sentry/browser';
 import { ERROR_RUN_SCAN, ERROR_MESSAGES } from 'ee/on_demand_scans/settings';
 import { redirectTo } from '~/lib/utils/url_utility';
+import glFeatureFlagsMixin from '~/vue_shared/mixins/gl_feature_flags_mixin';
 import dastProfileRunMutation from '../graphql/dast_profile_run.mutation.graphql';
 import ProfilesList from './dast_profiles_list.vue';
+import DastScanBranch from './dast_scan_branch.vue';
 import ScanTypeBadge from './dast_scan_type_badge.vue';
 
 export default {
   components: {
     GlButton,
     ProfilesList,
+    DastScanBranch,
     ScanTypeBadge,
   },
+  mixins: [glFeatureFlagsMixin()],
   props: {
     fullPath: {
       type: String,
@@ -101,6 +105,15 @@ export default {
     v-bind="$attrs"
     v-on="$listeners"
   >
+    <template #cell(name)="{ item: { name, branch, editPath } }">
+      {{ name }}
+      <dast-scan-branch
+        v-if="glFeatures.dastBranchSelection"
+        :branch="branch"
+        :edit-path="editPath"
+      />
+    </template>
+
     <!-- eslint-disable-next-line vue/valid-v-slot -->
     <template #cell(dastScannerProfile.scanType)="{ value }">
       <scan-type-badge :scan-type="value" />

ee/app/assets/javascripts/security_configuration/dast_profiles/components/dast_scan_branch.vue

+<script>
+import { GlLink, GlIcon } from '@gitlab/ui';
+import { isString, isBoolean } from 'lodash';
+
+export default {
+  name: 'DastScanBranch',
+  components: {
+    GlLink,
+    GlIcon,
+  },
+  props: {
+    branch: {
+      type: Object,
+      required: true,
+      validator: ({ name, exists }) => isString(name) && isBoolean(exists),
+    },
+    editPath: {
+      type: String,
+      required: true,
+    },
+  },
+};
+</script>
+
+<template>
+  <div>
+    <template v-if="branch.exists">
+      <gl-icon name="branch" />
+      {{ branch.name }}
+    </template>
+    <template v-else>
+      <span class="gl-text-red-500">
+        <gl-icon name="warning" />
+        {{ s__('DastProfiles|Branch missing') }}
+      </span>
+      • <gl-link :href="editPath">{{ s__('DastProfiles|Select branch') }}</gl-link>
+    </template>
+  </div>
+</template>

ee/app/assets/javascripts/security_configuration/dast_profiles/graphql/dast_profiles.query.graphql

@@ -18,6 +18,10 @@ query DastProfiles($fullPath: ID!, $after: String, $before: String, $first: Int,
             id
             scanType
           }
+          branch {
+            name
+            exists
+          }
           editPath
         }
       }

ee/app/controllers/projects/security/dast_profiles_controller.rb

@@ -9,6 +9,7 @@ module Projects
         authorize_read_on_demand_scans!
         push_frontend_feature_flag(:dast_saved_scans, @project, default_enabled: :yaml)
         push_frontend_feature_flag(:dast_failed_site_validations, @project, default_enabled: :yaml)
+        push_frontend_feature_flag(:dast_branch_selection, @project, default_enabled: :yaml)
       end
 
       feature_category :dynamic_application_security_testing

ee/spec/frontend/security_configuration/dast_profiles/components/dast_saved_scans_list_spec.js

@@ -3,6 +3,7 @@ import { merge } from 'lodash';
 import { ERROR_RUN_SCAN, ERROR_MESSAGES } from 'ee/on_demand_scans/settings';
 import ProfilesList from 'ee/security_configuration/dast_profiles/components/dast_profiles_list.vue';
 import Component from 'ee/security_configuration/dast_profiles/components/dast_saved_scans_list.vue';
+import DastScanBranch from 'ee/security_configuration/dast_profiles/components/dast_scan_branch.vue';
 import { extendedWrapper } from 'helpers/vue_test_utils_helper';
 import waitForPromises from 'helpers/wait_for_promises';
 import createFlash from '~/flash';
@@ -38,6 +39,11 @@ describe('EE - DastSavedScansList', () => {
         Component,
         merge(
           {
+            provide: {
+              glFeatures: {
+                dastBranchSelection: true,
+              },
+            },
             propsData: defaultProps,
           },
           options,
@@ -61,6 +67,14 @@ describe('EE - DastSavedScansList', () => {
     expect(findProfileList()).toExist();
   });
 
+  it('renders branch information for each profile', () => {
+    createFullComponent({
+      propsData: { profiles: savedScans },
+    });
+
+    expect(wrapper.findAll(DastScanBranch)).toHaveLength(savedScans.length);
+  });
+
   it('passes down the props properly', () => {
     createFullComponent();
 
@@ -181,4 +195,19 @@ describe('EE - DastSavedScansList', () => {
       expect(redirectTo).not.toHaveBeenCalled();
     });
   });
+
+  describe('dastBranchSelection feature flag disabled', () => {
+    it('does not render branch information', () => {
+      createFullComponent({
+        provide: {
+          glFeatures: {
+            dastBranchSelection: false,
+          },
+        },
+        propsData: { profiles: savedScans },
+      });
+
+      expect(wrapper.findAll(DastScanBranch)).toHaveLength(0);
+    });
+  });
 });

ee/spec/frontend/security_configuration/dast_profiles/components/dast_scan_branch_spec.js

+import { GlIcon, GlLink } from '@gitlab/ui';
+import { shallowMount } from '@vue/test-utils';
+import DastScanBranch from 'ee/security_configuration/dast_profiles/components/dast_scan_branch.vue';
+import { savedScans } from '../mocks/mock_data';
+
+const [scanWithExistingBranch, scanWithInexistingBranch] = savedScans;
+
+describe('EE - DastSavedScansList', () => {
+  let wrapper;
+
+  const createWrapper = (propsData = {}) => {
+    wrapper = shallowMount(DastScanBranch, {
+      propsData,
+    });
+  };
+
+  afterEach(() => {
+    wrapper.destroy();
+  });
+
+  it('renders branch information if it exists', () => {
+    const { branch, editPath } = scanWithExistingBranch;
+    createWrapper({ branch, editPath });
+
+    expect(wrapper.text()).toContain(branch.name);
+    expect(wrapper.find(GlIcon).props('name')).toBe('branch');
+  });
+
+  describe('branch does not exist', () => {
+    beforeEach(() => {
+      const { branch, editPath } = scanWithInexistingBranch;
+      createWrapper({ branch, editPath });
+    });
+    it('renders a warning message', () => {
+      expect(wrapper.text()).toContain('Branch missing');
+      expect(wrapper.find(GlIcon).props('name')).toBe('warning');
+    });
+
+    it('renders the edit link', () => {
+      const link = wrapper.find(GlLink);
+      expect(link.text()).toBe('Select branch');
+      expect(link.attributes('href')).toBe(scanWithInexistingBranch.editPath);
+    });
+  });
+});

ee/spec/frontend/security_configuration/dast_profiles/mocks/mock_data.js

@@ -69,6 +69,10 @@ export const savedScans = [
     dastSiteProfile: siteProfiles[0],
     dastScannerProfile: scannerProfiles[0],
     editPath: '/1/edit',
+    branch: {
+      name: 'main',
+      exists: true,
+    },
   },
   {
     id: 'gid://gitlab/DastProfile/2',
@@ -76,5 +80,9 @@ export const savedScans = [
     dastSiteProfile: siteProfiles[1],
     dastScannerProfile: scannerProfiles[1],
     editPath: '/2/edit',
+    branch: {
+      name: 'feature-branch',
+      exists: false,
+    },
   },
 ];

locale/gitlab.pot

@@ -9422,6 +9422,9 @@ msgstr ""
 msgid "DastProfiles|Authentication URL"
 msgstr ""
 
+msgid "DastProfiles|Branch missing"
+msgstr ""
+
 msgid "DastProfiles|Could not create the scanner profile. Please try again."
 msgstr ""
 
@@ -9593,6 +9596,9 @@ msgstr ""
 msgid "DastProfiles|Scanner name"
 msgstr ""
 
+msgid "DastProfiles|Select branch"
+msgstr ""
+
 msgid "DastProfiles|Show debug messages"
 msgstr ""