aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-web/design-system/src/components/__tests__/NavLink-test.tsx
blob: e40047658754de6acbb76c9d2f266937d992c1db (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
/*
 * SonarQube
 * Copyright (C) 2009-2024 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
import { screen } from '@testing-library/react';
// @ts-expect-error React is needed for <></> fragments
import React from 'react';
import { MemoryRouter, Route, Routes, useLocation } from 'react-router-dom';
import { render } from '../../helpers/testUtils';
import NavLink from '../NavLink';

beforeAll(() => {
  const { location } = window;
  delete (window as { location?: Location }).location;
  window.location = { ...location, href: '' };
});

beforeEach(() => {
  jest.clearAllMocks();
});

it('should remove focus after link is clicked', async () => {
  const { user } = setupWithMemoryRouter(<NavLink blurAfterClick to="/initial" />);

  await user.click(screen.getByRole('link'));

  expect(screen.getByRole('link')).not.toHaveFocus();
});

it('should prevent default when preventDefault is true', async () => {
  const { user } = setupWithMemoryRouter(<NavLink preventDefault to="/second" />);

  expect(screen.getByText('/initial')).toBeVisible();

  await user.click(screen.getByRole('link'));

  // prevent default behavior of page navigation
  expect(screen.getByText('/initial')).toBeVisible();
  expect(screen.queryByText('/second')).not.toBeInTheDocument();
});

it('should stop propagation when stopPropagation is true', async () => {
  const buttonOnClick = jest.fn();

  const { user } = setupWithMemoryRouter(
    <button onClick={buttonOnClick} type="button">
      <NavLink stopPropagation to="/second" />
    </button>,
  );

  await user.click(screen.getByRole('link'));

  expect(buttonOnClick).not.toHaveBeenCalled();
});

it('should call onClick when one is passed', async () => {
  const onClick = jest.fn();
  const { user } = setupWithMemoryRouter(
    <NavLink onClick={onClick} stopPropagation to="/second" />,
  );

  await user.click(screen.getByRole('link'));

  expect(onClick).toHaveBeenCalled();
});

it('NavLink should be clickable', async () => {
  const { user } = setupWithMemoryRouter(<NavLink to="/second">internal link</NavLink>);
  expect(screen.getByRole('link')).toBeVisible();

  await user.click(screen.getByRole('link'));

  expect(screen.getByText('/second')).toBeVisible();
});

function ShowPath() {
  const { pathname } = useLocation();
  return <pre>{pathname}</pre>;
}

const setupWithMemoryRouter = (component: JSX.Element, initialEntries = ['/initial']) => {
  return render(
    <MemoryRouter initialEntries={initialEntries}>
      <Routes>
        <Route
          element={
            <>
              {component}
              <ShowPath />
            </>
          }
          path="/initial"
        />
        <Route element={<ShowPath />} path="/second" />
      </Routes>
    </MemoryRouter>,
  );
};