Merge branch '198161-clearly-explain-unknown-means-no-severity-data-within-the-ui' into 'master'

Add tooltip to "unknown" severity badge icon

See merge request gitlab-org/gitlab!33131

ee/app/assets/javascripts/vue_shared/security_reports/components/severity_badge.vue

 <script>
+import { s__ } from '~/locale';
 import { SEVERITY_LEVELS } from 'ee/security_dashboard/store/constants';
-import { GlIcon } from '@gitlab/ui';
+import { GlIcon, GlTooltipDirective } from '@gitlab/ui';
 
 export const CLASS_NAME_MAP = {
   critical: 'text-danger-800',
@@ -11,11 +12,20 @@ export const CLASS_NAME_MAP = {
   unknown: 'text-secondary-400',
 };
 
+export const TOOLTIP_TITLE_MAP = {
+  unknown: s__(
+    `SecurityReports|The rating "unknown" indicates that the underlying scanner doesn’t contain or provide a severity rating.`,
+  ),
+};
+
 export default {
   name: 'SeverityBadge',
   components: {
     GlIcon,
   },
+  directives: {
+    tooltip: GlTooltipDirective,
+  },
   props: {
     severity: {
       type: String,
@@ -38,13 +48,18 @@ export default {
     severityTitle() {
       return SEVERITY_LEVELS[this.severityKey] || this.severity;
     },
+    tooltipTitle() {
+      return TOOLTIP_TITLE_MAP[this.severityKey];
+    },
   },
 };
 </script>
 
 <template>
   <div v-if="hasSeverityBadge" class="severity-badge text-left text-nowrap gl-text-gray-900">
-    <span :class="className"><gl-icon :name="iconName" :size="12" class="gl-mr-3"/></span
-    >{{ severityTitle }}
+    <span :class="className"
+      ><gl-icon v-tooltip="tooltipTitle" :name="iconName" :size="12" class="gl-mr-3"
+    /></span>
+    {{ severityTitle }}
   </div>
 </template>

ee/changelogs/unreleased/198161-clearly-explain-unknown-means-no-severity-data-within-the-ui.yml

+---
+title: Add tooltip with description to unknown severity badge icon
+merge_request: 33131
+author:
+type: changed

ee/spec/frontend/vue_shared/components/security_reports/severity_badge_spec.js

 import { shallowMount } from '@vue/test-utils';
 import SeverityBadge, {
   CLASS_NAME_MAP,
+  TOOLTIP_TITLE_MAP,
 } from 'ee/vue_shared/security_reports/components/severity_badge.vue';
 import { GlIcon } from '@gitlab/ui';
+import { createMockDirective, getBinding } from 'helpers/vue_mock_directive';
 
 describe('Severity Badge', () => {
+  const SEVERITY_LEVELS = ['critical', 'high', 'medium', 'low', 'info', 'unknown'];
+
   let wrapper;
 
-  const factory = (propsData = {}) =>
-    shallowMount(SeverityBadge, {
+  const createWrapper = (propsData = {}) => {
+    wrapper = shallowMount(SeverityBadge, {
       propsData: { ...propsData },
+      directives: {
+        tooltip: createMockDirective(),
+      },
+    });
+  };
+
+  afterEach(() => {
+    wrapper.destroy();
+    wrapper = null;
+  });
+
+  const findIcon = () => wrapper.find(GlIcon);
+  const findTooltip = () => getBinding(findIcon().element, 'tooltip').value;
+
+  describe.each(SEVERITY_LEVELS)('given a valid severity "%s"', severity => {
+    beforeEach(() => {
+      createWrapper({ severity });
     });
 
-  describe.each(Object.keys(CLASS_NAME_MAP))('given a valid severity %s', severity => {
     const className = CLASS_NAME_MAP[severity];
 
     it(`renders the component with ${severity} badge`, () => {
-      wrapper = factory({ severity });
-
       expect(wrapper.find(`.${className}`).exists()).toBe(true);
     });
 
     it('renders gl-icon with correct name', () => {
-      wrapper = factory({ severity });
-      const icon = wrapper.find(GlIcon);
-      expect(icon.props('name')).toBe(`severity-${severity}`);
+      expect(findIcon().props('name')).toBe(`severity-${severity}`);
     });
 
     it(`renders the component label`, () => {
-      wrapper = factory({ severity });
+      const severityFirstLetterUpper = `${severity.charAt(0).toUpperCase()}${severity.slice(1)}`;
+      expect(wrapper.text()).toBe(severityFirstLetterUpper);
+    });
 
-      expect(wrapper.text()).toMatch(new RegExp(severity, 'i'));
+    it('renders tooltip', () => {
+      expect(findTooltip()).toBe(TOOLTIP_TITLE_MAP[severity]);
     });
   });
 
   describe.each(['foo', '', ' '])('given an invalid severity "%s"', invalidSeverity => {
-    it(`renders an empty component`, () => {
-      wrapper = factory({ severity: invalidSeverity });
+    beforeEach(() => {
+      createWrapper({ severity: invalidSeverity });
+    });
 
+    it(`renders an empty component`, () => {
       expect(wrapper.isEmpty()).toBe(true);
     });
   });

locale/gitlab.pot

@@ -19444,6 +19444,9 @@ msgstr ""
 msgid "SecurityReports|Status"
 msgstr ""
 
+msgid "SecurityReports|The rating \"unknown\" indicates that the underlying scanner doesn’t contain or provide a severity rating."
+msgstr ""
+
 msgid "SecurityReports|The security dashboard displays the latest security findings for projects you wish to monitor. Select \"Edit dashboard\" to add and remove projects."
 msgstr ""