source.dussan.org Git - sonarqube.git/blob

   1 /*
   2  * SonarQube
   3  * Copyright (C) 2009-2022 SonarSource SA
   4  * mailto:info AT sonarsource DOT com
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 3 of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  */
  20 import { shallow } from 'enzyme';
  21 import { range, times } from 'lodash';
  22 import * as React from 'react';
  23 import { FormattedMessage } from 'react-intl';
  24 import { getSources } from '../../../../api/components';
  25 import IssueMessageBox from '../../../../components/issue/IssueMessageBox';
  26 import { mockBranch, mockMainBranch } from '../../../../helpers/mocks/branch-like';
  27 import {
  28   mockSnippetsByComponent,
  29   mockSourceLine,
  30   mockSourceViewerFile,
  31 } from '../../../../helpers/mocks/sources';
  32 import { mockFlowLocation, mockIssue } from '../../../../helpers/testMocks';
  33 import { waitAndUpdate } from '../../../../helpers/testUtils';
  34 import { ComponentQualifier } from '../../../../types/component';
  35 import { IssueStatus } from '../../../../types/issues';
  36 import { SnippetGroup } from '../../../../types/types';
  37 import ComponentSourceSnippetGroupViewer from '../ComponentSourceSnippetGroupViewer';
  38 import SnippetViewer from '../SnippetViewer';
  39
  40 jest.mock('../../../../api/components', () => ({
  41   getSources: jest.fn().mockResolvedValue([]),
  42 }));
  43
  44 beforeEach(() => {
  45   jest.clearAllMocks();
  46 });
  47
  48 it('should render correctly', () => {
  49   expect(shallowRender()).toMatchSnapshot();
  50 });
  51
  52 it('should render correctly with secondary locations', () => {
  53   // issue with secondary locations but no flows
  54   const issue = mockIssue(true, {
  55     component: 'project:main.js',
  56     flows: [],
  57     textRange: { startLine: 7, endLine: 7, startOffset: 5, endOffset: 10 },
  58   });
  59
  60   const snippetGroup: SnippetGroup = {
  61     locations: [
  62       mockFlowLocation({
  63         component: issue.component,
  64         textRange: { startLine: 34, endLine: 34, startOffset: 0, endOffset: 0 },
  65       }),
  66       mockFlowLocation({
  67         component: issue.component,
  68         textRange: { startLine: 74, endLine: 74, startOffset: 0, endOffset: 0 },
  69       }),
  70     ],
  71     ...mockSnippetsByComponent('main.js', 'project', [
  72       ...range(2, 17),
  73       ...range(29, 39),
  74       ...range(69, 79),
  75     ]),
  76   };
  77   const wrapper = shallowRender({ issue, snippetGroup });
  78   expect(wrapper.state('snippets')).toHaveLength(3);
  79   expect(wrapper.state('snippets')[0]).toEqual({ index: 0, start: 2, end: 16 });
  80   expect(wrapper.state('snippets')[1]).toEqual({ index: 2, start: 29, end: 39 });
  81   expect(wrapper.state('snippets')[2]).toEqual({ index: 3, start: 69, end: 79 });
  82 });
  83
  84 it('should render correctly with flows', () => {
  85   // issue with flows but no secondary locations
  86   const issue = mockIssue(true, {
  87     component: 'project:main.js',
  88     secondaryLocations: [],
  89     textRange: { startLine: 7, endLine: 7, startOffset: 5, endOffset: 10 },
  90   });
  91
  92   const snippetGroup: SnippetGroup = {
  93     locations: [
  94       mockFlowLocation({
  95         component: issue.component,
  96         textRange: { startLine: 34, endLine: 34, startOffset: 0, endOffset: 0 },
  97       }),
  98       mockFlowLocation({
  99         component: issue.component,
 100         textRange: { startLine: 74, endLine: 74, startOffset: 0, endOffset: 0 },
 101       }),
 102     ],
 103     ...mockSnippetsByComponent('main.js', 'project', [
 104       ...range(2, 17),
 105       ...range(29, 39),
 106       ...range(69, 79),
 107     ]),
 108   };
 109   const wrapper = shallowRender({ issue, snippetGroup });
 110   expect(wrapper.state('snippets')).toHaveLength(3);
 111   expect(wrapper.state('snippets')[0]).toEqual({ index: 0, start: 2, end: 16 });
 112   expect(wrapper.state('snippets')[1]).toEqual({ index: 1, start: 29, end: 39 });
 113   expect(wrapper.state('snippets')[2]).toEqual({ index: 2, start: 69, end: 79 });
 114
 115   // Check that locationsByLine is defined when isLastOccurenceOfPrimaryComponent
 116   expect(wrapper.find(SnippetViewer).at(0).props().locationsByLine).not.toEqual({});
 117
 118   // If not, it should be an empty object:
 119   const snippets = shallowRender({
 120     isLastOccurenceOfPrimaryComponent: false,
 121     issue,
 122     snippetGroup,
 123   }).find(SnippetViewer);
 124
 125   expect(snippets.at(0).props().locationsByLine).toEqual({});
 126   expect(snippets.at(1).props().locationsByLine).toEqual({});
 127 });
 128
 129 it('should render file-level issue correctly', () => {
 130   // issue with secondary locations and no primary location
 131   const issue = mockIssue(true, {
 132     component: 'project:main.js',
 133     flows: [],
 134     textRange: undefined,
 135   });
 136
 137   const wrapper = shallowRender({
 138     issue,
 139     snippetGroup: {
 140       locations: [
 141         mockFlowLocation({
 142           component: issue.component,
 143           textRange: { startLine: 34, endLine: 34, startOffset: 0, endOffset: 0 },
 144         }),
 145       ],
 146       ...mockSnippetsByComponent('main.js', 'project', range(29, 39)),
 147     },
 148   });
 149
 150   expect(wrapper.find('ContextConsumer').dive().find(IssueMessageBox).exists()).toBe(true);
 151 });
 152
 153 it.each([
 154   ['file-level', ComponentQualifier.File, 'issue.closed.file_level'],
 155   ['project-level', ComponentQualifier.Project, 'issue.closed.project_level'],
 156 ])(
 157   'should render a closed %s issue correctly',
 158   async (_level, componentQualifier, expectedLabel) => {
 159     // issue with secondary locations and no primary location
 160     const issue = mockIssue(true, {
 161       component: 'project:main.js',
 162       componentQualifier,
 163       flows: [],
 164       textRange: undefined,
 165       status: IssueStatus.Closed,
 166     });
 167
 168     const wrapper = shallowRender({
 169       issue,
 170       snippetGroup: {
 171         locations: [],
 172         ...mockSnippetsByComponent('main.js', 'project', range(1, 10)),
 173       },
 174     });
 175
 176     await waitAndUpdate(wrapper);
 177
 178     expect(wrapper.find<FormattedMessage>(FormattedMessage).prop('id')).toEqual(expectedLabel);
 179     expect(wrapper.find('ContextConsumer').exists()).toBe(false);
 180   }
 181 );
 182
 183 it('should expand block', async () => {
 184   (getSources as jest.Mock).mockResolvedValueOnce(
 185     Object.values(mockSnippetsByComponent('a', 'project', range(6, 59)).sources)
 186   );
 187   const issue = mockIssue(true, {
 188     textRange: { startLine: 74, endLine: 74, startOffset: 5, endOffset: 10 },
 189   });
 190   const snippetGroup: SnippetGroup = {
 191     locations: [
 192       mockFlowLocation({
 193         component: 'a',
 194         textRange: { startLine: 74, endLine: 74, startOffset: 0, endOffset: 0 },
 195       }),
 196       mockFlowLocation({
 197         component: 'a',
 198         textRange: { startLine: 107, endLine: 107, startOffset: 0, endOffset: 0 },
 199       }),
 200     ],
 201     ...mockSnippetsByComponent('a', 'project', [...range(69, 83), ...range(102, 112)]),
 202   };
 203
 204   const wrapper = shallowRender({ issue, snippetGroup });
 205
 206   wrapper.instance().expandBlock(0, 'up');
 207   await waitAndUpdate(wrapper);
 208
 209   expect(getSources).toHaveBeenCalledWith({ from: 9, key: 'project:a', to: 68 });
 210   expect(wrapper.state('snippets')).toHaveLength(2);
 211   expect(wrapper.state('snippets')[0]).toEqual({ index: 0, start: 19, end: 83 });
 212   expect(Object.keys(wrapper.state('additionalLines'))).toHaveLength(53);
 213 });
 214
 215 it('should expand full component', async () => {
 216   (getSources as jest.Mock).mockResolvedValueOnce(
 217     Object.values(mockSnippetsByComponent('a', 'project', times(14)).sources)
 218   );
 219   const snippetGroup: SnippetGroup = {
 220     locations: [
 221       mockFlowLocation({
 222         component: 'a',
 223         textRange: { startLine: 3, endLine: 3, startOffset: 0, endOffset: 0 },
 224       }),
 225       mockFlowLocation({
 226         component: 'a',
 227         textRange: { startLine: 12, endLine: 12, startOffset: 0, endOffset: 0 },
 228       }),
 229     ],
 230     ...mockSnippetsByComponent('a', 'project', [1, 2, 3, 4, 5, 10, 11, 12, 13, 14]),
 231   };
 232
 233   const wrapper = shallowRender({ snippetGroup });
 234
 235   wrapper.instance().expandComponent();
 236   await waitAndUpdate(wrapper);
 237
 238   expect(getSources).toHaveBeenCalledWith({ key: 'project:a' });
 239   expect(wrapper.state('snippets')).toHaveLength(1);
 240   expect(wrapper.state('snippets')[0]).toEqual({ index: -1, start: 0, end: 13 });
 241 });
 242
 243 it('should get the right branch when expanding', async () => {
 244   (getSources as jest.Mock).mockResolvedValueOnce(
 245     Object.values(
 246       mockSnippetsByComponent('a', 'project', [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17])
 247         .sources
 248     )
 249   );
 250   const snippetGroup: SnippetGroup = {
 251     locations: [mockFlowLocation()],
 252     ...mockSnippetsByComponent('a', 'project', [1, 2, 3, 4, 5, 6, 7]),
 253   };
 254
 255   const wrapper = shallowRender({
 256     branchLike: mockBranch({ name: 'asdf' }),
 257     snippetGroup,
 258   });
 259
 260   wrapper.instance().expandBlock(0, 'down');
 261   await waitAndUpdate(wrapper);
 262
 263   expect(getSources).toHaveBeenCalledWith({ branch: 'asdf', from: 36, key: 'project:a', to: 95 });
 264 });
 265
 266 it('should handle symbol highlighting', () => {
 267   const wrapper = shallowRender();
 268   expect(wrapper.state('highlightedSymbols')).toEqual([]);
 269   wrapper.instance().handleSymbolClick(['foo']);
 270   expect(wrapper.state('highlightedSymbols')).toEqual(['foo']);
 271   wrapper.instance().handleSymbolClick(['foo']);
 272   expect(wrapper.state('highlightedSymbols')).toEqual([]);
 273 });
 274
 275 it('should correctly handle lines actions', () => {
 276   const snippetGroup: SnippetGroup = {
 277     locations: [
 278       mockFlowLocation({
 279         component: 'my-project:foo/bar.ts',
 280         textRange: { startLine: 34, endLine: 34, startOffset: 0, endOffset: 0 },
 281       }),
 282       mockFlowLocation({
 283         component: 'my-project:foo/bar.ts',
 284         textRange: { startLine: 54, endLine: 54, startOffset: 0, endOffset: 0 },
 285       }),
 286     ],
 287     ...mockSnippetsByComponent(
 288       'foo/bar.ts',
 289       'my-project',
 290       [32, 33, 34, 35, 36, 52, 53, 54, 55, 56]
 291     ),
 292   };
 293   const loadDuplications = jest.fn();
 294   const renderDuplicationPopup = jest.fn();
 295
 296   const wrapper = shallowRender({
 297     loadDuplications,
 298     renderDuplicationPopup,
 299     snippetGroup,
 300   });
 301
 302   const line = mockSourceLine();
 303   wrapper.find('SnippetViewer').first().prop<Function>('loadDuplications')(line);
 304   expect(loadDuplications).toHaveBeenCalledWith('my-project:foo/bar.ts', line);
 305
 306   wrapper.find('SnippetViewer').first().prop<Function>('renderDuplicationPopup')(1, 13);
 307   expect(renderDuplicationPopup).toHaveBeenCalledWith(
 308     mockSourceViewerFile('foo/bar.ts', 'my-project'),
 309     1,
 310     13
 311   );
 312 });
 313
 314 function shallowRender(props: Partial<ComponentSourceSnippetGroupViewer['props']> = {}) {
 315   const snippetGroup: SnippetGroup = {
 316     component: mockSourceViewerFile(),
 317     locations: [],
 318     sources: [],
 319   };
 320   return shallow<ComponentSourceSnippetGroupViewer>(
 321     <ComponentSourceSnippetGroupViewer
 322       branchLike={mockMainBranch()}
 323       highlightedLocationMessage={{ index: 0, text: '' }}
 324       isLastOccurenceOfPrimaryComponent={true}
 325       issue={mockIssue()}
 326       issuesByLine={{}}
 327       lastSnippetGroup={false}
 328       loadDuplications={jest.fn()}
 329       locations={[]}
 330       onIssueSelect={jest.fn()}
 331       onLocationSelect={jest.fn()}
 332       renderDuplicationPopup={jest.fn()}
 333       snippetGroup={snippetGroup}
 334       {...props}
 335     />
 336   );
 337 }