/* * SonarQube * Copyright (C) 2009-2023 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'; import userEvent from '@testing-library/user-event'; import { renderWithContext } from '../../helpers/testUtils'; import { SpotlightTour, SpotlightTourProps } from '../SpotlightTour'; it('should display the spotlight tour', async () => { const user = userEvent.setup(); const callback = jest.fn(); renderSpotlightTour({ callback }); expect(await screen.findByRole('alertdialog')).toBeInTheDocument(); expect(screen.getByRole('alertdialog')).toHaveTextContent( 'Trust The FooFoo bar is bazstep 1 of 5next' ); await user.click(screen.getByRole('button', { name: 'next' })); expect(screen.getByRole('alertdialog')).toHaveTextContent( 'Trust The BazBaz foo is barstep 2 of 5go_backnext' ); expect(callback).toHaveBeenCalled(); await user.click(screen.getByRole('button', { name: 'next' })); expect(screen.getByRole('alertdialog')).toHaveTextContent( 'Trust The BarBar baz is foostep 3 of 5go_backnext' ); await user.click(screen.getByRole('button', { name: 'next' })); expect(screen.getByRole('alertdialog')).toHaveTextContent( 'Trust The Foo 2Foo baz is barstep 4 of 5go_backnext' ); await user.click(screen.getByRole('button', { name: 'go_back' })); expect(screen.getByRole('alertdialog')).toHaveTextContent( 'Trust The BarBar baz is foostep 3 of 5go_backnext' ); await user.click(screen.getByRole('button', { name: 'next' })); await user.click(screen.getByRole('button', { name: 'next' })); expect(screen.getByRole('alertdialog')).toHaveTextContent( 'Trust The Baz 2Baz bar is foostep 5 of 5go_backclose' ); expect(screen.queryByRole('button', { name: 'next' })).not.toBeInTheDocument(); await user.click(screen.getByRole('button', { name: 'close' })); expect(screen.queryByRole('alertdialog')).not.toBeInTheDocument(); }); it('should not show the spotlight tour if run is false', () => { renderSpotlightTour({ run: false }); expect(screen.queryByRole('alertdialog')).not.toBeInTheDocument(); }); it('should allow the customization of button labels', async () => { const user = userEvent.setup(); renderSpotlightTour({ nextLabel: 'forward', backLabel: 'backward', closeLabel: 'close_me', skipLabel: "just don't", showSkipButton: true, }); expect(await screen.findByRole('alertdialog')).toBeInTheDocument(); expect(screen.getByRole('button', { name: 'forward' })).toBeInTheDocument(); expect(screen.getByRole('button', { name: "just don't" })).toBeInTheDocument(); await user.click(screen.getByRole('button', { name: 'forward' })); expect(screen.getByRole('button', { name: 'backward' })).toBeInTheDocument(); await user.click(screen.getByRole('button', { name: 'forward' })); await user.click(screen.getByRole('button', { name: 'forward' })); await user.click(screen.getByRole('button', { name: 'forward' })); expect(screen.getByRole('button', { name: 'close_me' })).toBeInTheDocument(); }); function renderSpotlightTour(props: Partial = {}) { return renderWithContext(
This is step 1
This is step 2
This is step 3
This is step 4
This is step 5
`step ${x} of ${y}`} steps={[ { target: '#step1', content: 'Foo bar is baz', title: 'Trust The Foo', placement: 'top', }, { target: '#step2', content: 'Baz foo is bar', title: 'Trust The Baz', placement: 'right', }, { target: '#step3', content: 'Bar baz is foo', title: 'Trust The Bar', placement: 'bottom', }, { target: '#step4', content: 'Foo baz is bar', title: 'Trust The Foo 2', placement: 'left', }, { target: '#step5', content: 'Baz bar is foo', title: 'Trust The Baz 2', placement: 'center', }, ]} {...props} />
); }