debian-mirror-gitlab/spec/frontend/search_settings/components/search_settings_spec.js

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

191 lines
5.8 KiB
JavaScript
Raw Normal View History

2021-03-08 18:12:59 +05:30
import { GlSearchBoxByType } from '@gitlab/ui';
import { shallowMount } from '@vue/test-utils';
2022-06-21 17:19:12 +05:30
import { setHTMLFixture } from 'helpers/fixtures';
2021-03-08 18:12:59 +05:30
import SearchSettings from '~/search_settings/components/search_settings.vue';
import { HIGHLIGHT_CLASS, HIDE_CLASS } from '~/search_settings/constants';
2021-03-11 19:13:27 +05:30
import { isExpanded, expandSection, closeSection } from '~/settings_panels';
2021-03-08 18:12:59 +05:30
describe('search_settings/components/search_settings.vue', () => {
const ROOT_ID = 'content-body';
const SECTION_SELECTOR = 'section.settings';
const SEARCH_TERM = 'Delete project';
const GENERAL_SETTINGS_ID = 'js-general-settings';
const ADVANCED_SETTINGS_ID = 'js-advanced-settings';
2021-03-11 19:13:27 +05:30
const EXTRA_SETTINGS_ID = 'js-extra-settings';
2022-06-21 17:19:12 +05:30
const TEXT_CONTAIN_SEARCH_TERM = `This text contain ${SEARCH_TERM}.`;
const TEXT_WITH_SIBLING_ELEMENTS = `${SEARCH_TERM} <a data-testid="sibling" href="#">Learn more</a>.`;
2021-03-11 19:13:27 +05:30
2021-03-08 18:12:59 +05:30
let wrapper;
const buildWrapper = () => {
wrapper = shallowMount(SearchSettings, {
propsData: {
searchRoot: document.querySelector(`#${ROOT_ID}`),
sectionSelector: SECTION_SELECTOR,
2021-03-11 19:13:27 +05:30
isExpandedFn: isExpanded,
},
// Add real listeners so we can simplify and strengthen some tests.
listeners: {
expand: expandSection,
collapse: closeSection,
2021-03-08 18:12:59 +05:30
},
});
};
const sections = () => Array.from(document.querySelectorAll(SECTION_SELECTOR));
const sectionsCount = () => sections().length;
const visibleSectionsCount = () =>
document.querySelectorAll(`${SECTION_SELECTOR}:not(.${HIDE_CLASS})`).length;
const highlightedElementsCount = () => document.querySelectorAll(`.${HIGHLIGHT_CLASS}`).length;
2021-11-18 22:05:49 +05:30
const highlightedTextNodes = () => {
const highlightedList = Array.from(document.querySelectorAll(`.${HIGHLIGHT_CLASS}`));
return highlightedList.every((element) => {
return element.textContent.toLowerCase() === SEARCH_TERM.toLowerCase();
});
};
2022-06-21 17:19:12 +05:30
const findMatchSiblingElement = () => document.querySelector(`[data-testid="sibling"]`);
2021-03-08 18:12:59 +05:30
const findSearchBox = () => wrapper.find(GlSearchBoxByType);
const search = (term) => {
findSearchBox().vm.$emit('input', term);
};
const clearSearch = () => search('');
beforeEach(() => {
2022-06-21 17:19:12 +05:30
setHTMLFixture(`
2021-03-08 18:12:59 +05:30
<div>
<div class="js-search-app"></div>
<div id="${ROOT_ID}">
<section id="${GENERAL_SETTINGS_ID}" class="settings">
<span>General</span>
</section>
2021-03-11 19:13:27 +05:30
<section id="${ADVANCED_SETTINGS_ID}" class="settings expanded">
<span>Advanced</span>
</section>
<section id="${EXTRA_SETTINGS_ID}" class="settings">
2021-03-08 18:12:59 +05:30
<span>${SEARCH_TERM}</span>
2021-11-18 22:05:49 +05:30
<span>${TEXT_CONTAIN_SEARCH_TERM}</span>
2022-06-21 17:19:12 +05:30
<span>${TEXT_WITH_SIBLING_ELEMENTS}</span>
2021-03-08 18:12:59 +05:30
</section>
</div>
</div>
`);
buildWrapper();
});
afterEach(() => {
wrapper.destroy();
});
it('hides sections that do not match the search term', () => {
const hiddenSection = document.querySelector(`#${GENERAL_SETTINGS_ID}`);
search(SEARCH_TERM);
expect(visibleSectionsCount()).toBe(1);
expect(hiddenSection.classList).toContain(HIDE_CLASS);
});
it('expands section that matches the search term', () => {
2021-03-11 19:13:27 +05:30
const section = document.querySelector(`#${EXTRA_SETTINGS_ID}`);
2021-03-08 18:12:59 +05:30
search(SEARCH_TERM);
2021-03-11 19:13:27 +05:30
expect(wrapper.emitted('expand')).toEqual([[section]]);
2021-03-08 18:12:59 +05:30
});
it('highlight elements that match the search term', () => {
search(SEARCH_TERM);
2022-06-21 17:19:12 +05:30
expect(highlightedElementsCount()).toBe(3);
2021-11-18 22:05:49 +05:30
});
it('highlight only search term and not the whole line', () => {
search(SEARCH_TERM);
expect(highlightedTextNodes()).toBe(true);
});
2022-06-21 17:19:12 +05:30
// Regression test for https://gitlab.com/gitlab-org/gitlab/-/issues/350494
it('preserves elements that are siblings of matches', () => {
const snapshot = `
<a
data-testid="sibling"
href="#"
>
Learn more
</a>
`;
expect(findMatchSiblingElement()).toMatchInlineSnapshot(snapshot);
2021-11-18 22:05:49 +05:30
search(SEARCH_TERM);
2022-06-21 17:19:12 +05:30
expect(findMatchSiblingElement()).toMatchInlineSnapshot(snapshot);
clearSearch();
expect(findMatchSiblingElement()).toMatchInlineSnapshot(snapshot);
2021-03-08 18:12:59 +05:30
});
2021-03-11 19:13:27 +05:30
describe('default', () => {
it('test setup starts with expansion state', () => {
expect(sections().map(isExpanded)).toEqual([false, true, false]);
2021-03-08 18:12:59 +05:30
});
2021-03-11 19:13:27 +05:30
describe('when searched and cleared', () => {
beforeEach(() => {
search('Test');
clearSearch();
});
it('displays all sections', () => {
expect(visibleSectionsCount()).toBe(sectionsCount());
});
it('removes the highlight from all elements', () => {
expect(highlightedElementsCount()).toBe(0);
});
it('should preserve original expansion state', () => {
expect(sections().map(isExpanded)).toEqual([false, true, false]);
});
it('should preserve state by emitting events', () => {
const [first, mid, last] = sections();
expect(wrapper.emitted()).toEqual({
expand: [[mid]],
collapse: [[first], [last]],
});
});
describe('after multiple searches and clear', () => {
beforeEach(() => {
search('Test');
search(SEARCH_TERM);
clearSearch();
});
it('should preserve last expansion state', () => {
expect(sections().map(isExpanded)).toEqual([false, true, false]);
});
});
describe('after user expands and collapses, search, and clear', () => {
beforeEach(() => {
const [first, mid] = sections();
closeSection(mid);
expandSection(first);
search(SEARCH_TERM);
clearSearch();
});
it('should preserve last expansion state', () => {
expect(sections().map(isExpanded)).toEqual([true, false, false]);
});
});
2021-03-08 18:12:59 +05:30
});
});
});