debian-mirror-gitlab/spec/frontend/monitoring/components/dashboard_spec.js

1114 lines
34 KiB
JavaScript
Raw Normal View History

2020-04-22 19:07:51 +05:30
import { shallowMount, mount } from '@vue/test-utils';
import Tracking from '~/tracking';
2020-05-24 23:13:21 +05:30
import { ESC_KEY, ESC_KEY_IE11 } from '~/lib/utils/keys';
import { GlModal, GlDropdownItem, GlDeprecatedButton, GlIcon } from '@gitlab/ui';
import { objectToQuery } from '~/lib/utils/url_utility';
2020-03-13 15:44:24 +05:30
import VueDraggable from 'vuedraggable';
import MockAdapter from 'axios-mock-adapter';
import axios from '~/lib/utils/axios_utils';
import { metricStates } from '~/monitoring/constants';
import Dashboard from '~/monitoring/components/dashboard.vue';
2020-06-23 00:09:42 +05:30
import DashboardHeader from '~/monitoring/components/dashboard_header.vue';
2020-03-13 15:44:24 +05:30
import DateTimePicker from '~/vue_shared/components/date_time_picker/date_time_picker.vue';
2020-04-22 19:07:51 +05:30
import CustomMetricsFormFields from '~/custom_metrics/components/custom_metrics_form_fields.vue';
2020-03-13 15:44:24 +05:30
import DashboardsDropdown from '~/monitoring/components/dashboards_dropdown.vue';
2020-05-24 23:13:21 +05:30
import EmptyState from '~/monitoring/components/empty_state.vue';
2020-03-13 15:44:24 +05:30
import GroupEmptyState from '~/monitoring/components/group_empty_state.vue';
2020-05-24 23:13:21 +05:30
import DashboardPanel from '~/monitoring/components/dashboard_panel.vue';
2020-06-23 00:09:42 +05:30
import LinksSection from '~/monitoring/components/links_section.vue';
2020-03-13 15:44:24 +05:30
import { createStore } from '~/monitoring/stores';
import * as types from '~/monitoring/stores/mutation_types';
2020-05-24 23:13:21 +05:30
import {
setupAllDashboards,
setupStoreWithDashboard,
setMetricResult,
setupStoreWithData,
setupStoreWithVariable,
2020-06-23 00:09:42 +05:30
setupStoreWithLinks,
2020-05-24 23:13:21 +05:30
} from '../store_utils';
2020-04-22 19:07:51 +05:30
import { environmentData, dashboardGitResponse, propsData } from '../mock_data';
import { metricsDashboardViewModel, metricsDashboardPanelCount } from '../fixture_data';
2020-05-24 23:13:21 +05:30
import createFlash from '~/flash';
jest.mock('~/flash');
2020-03-13 15:44:24 +05:30
describe('Dashboard', () => {
let store;
let wrapper;
let mock;
2020-06-23 00:09:42 +05:30
const findDashboardHeader = () => wrapper.find(DashboardHeader);
const findEnvironmentsDropdown = () =>
findDashboardHeader().find({ ref: 'monitorEnvironmentsDropdown' });
2020-03-13 15:44:24 +05:30
const findAllEnvironmentsDropdownItems = () => findEnvironmentsDropdown().findAll(GlDropdownItem);
const setSearchTerm = searchTerm => {
2020-05-24 23:13:21 +05:30
store.commit(`monitoringDashboard/${types.SET_ENVIRONMENTS_FILTER}`, searchTerm);
2020-03-13 15:44:24 +05:30
};
const createShallowWrapper = (props = {}, options = {}) => {
wrapper = shallowMount(Dashboard, {
propsData: { ...propsData, ...props },
store,
2020-06-23 00:09:42 +05:30
stubs: {
DashboardHeader,
},
2020-03-13 15:44:24 +05:30
...options,
});
};
const createMountedWrapper = (props = {}, options = {}) => {
wrapper = mount(Dashboard, {
propsData: { ...propsData, ...props },
store,
2020-06-23 00:09:42 +05:30
stubs: {
'graph-group': true,
'dashboard-panel': true,
'dashboard-header': DashboardHeader,
},
2020-03-13 15:44:24 +05:30
...options,
});
};
beforeEach(() => {
store = createStore();
mock = new MockAdapter(axios);
2020-05-24 23:13:21 +05:30
jest.spyOn(store, 'dispatch').mockResolvedValue();
2020-03-13 15:44:24 +05:30
});
afterEach(() => {
mock.restore();
2020-05-24 23:13:21 +05:30
if (store.dispatch.mockReset) {
store.dispatch.mockReset();
}
2020-03-13 15:44:24 +05:30
});
describe('no metrics are available yet', () => {
beforeEach(() => {
createShallowWrapper();
});
it('shows the environment selector', () => {
expect(findEnvironmentsDropdown().exists()).toBe(true);
});
});
describe('no data found', () => {
beforeEach(() => {
createShallowWrapper();
return wrapper.vm.$nextTick();
});
it('shows the environment selector dropdown', () => {
expect(findEnvironmentsDropdown().exists()).toBe(true);
});
});
describe('request information to the server', () => {
it('calls to set time range and fetch data', () => {
2020-05-24 23:13:21 +05:30
createShallowWrapper({ hasMetrics: true });
2020-03-13 15:44:24 +05:30
return wrapper.vm.$nextTick().then(() => {
expect(store.dispatch).toHaveBeenCalledWith(
'monitoringDashboard/setTimeRange',
expect.any(Object),
);
expect(store.dispatch).toHaveBeenCalledWith('monitoringDashboard/fetchData', undefined);
});
});
it('shows up a loading state', () => {
2020-05-24 23:13:21 +05:30
store.state.monitoringDashboard.emptyState = 'loading';
createShallowWrapper({ hasMetrics: true });
2020-03-13 15:44:24 +05:30
return wrapper.vm.$nextTick().then(() => {
2020-05-24 23:13:21 +05:30
expect(wrapper.find(EmptyState).exists()).toBe(true);
expect(wrapper.find(EmptyState).props('selectedState')).toBe('loading');
2020-03-13 15:44:24 +05:30
});
});
it('hides the group panels when showPanels is false', () => {
2020-05-24 23:13:21 +05:30
createMountedWrapper({ hasMetrics: true, showPanels: false });
2020-03-13 15:44:24 +05:30
2020-05-24 23:13:21 +05:30
setupStoreWithData(store);
2020-03-13 15:44:24 +05:30
return wrapper.vm.$nextTick().then(() => {
expect(wrapper.vm.showEmptyState).toEqual(false);
expect(wrapper.findAll('.prometheus-panel')).toHaveLength(0);
});
});
it('fetches the metrics data with proper time window', () => {
jest.spyOn(store, 'dispatch');
2020-05-24 23:13:21 +05:30
createMountedWrapper({ hasMetrics: true });
2020-03-13 15:44:24 +05:30
2020-05-24 23:13:21 +05:30
store.commit(
2020-03-13 15:44:24 +05:30
`monitoringDashboard/${types.RECEIVE_ENVIRONMENTS_DATA_SUCCESS}`,
environmentData,
);
return wrapper.vm.$nextTick().then(() => {
expect(store.dispatch).toHaveBeenCalled();
});
});
});
2020-05-24 23:13:21 +05:30
describe('when the URL contains a reference to a panel', () => {
let location;
const setSearch = search => {
window.location = { ...location, search };
};
beforeEach(() => {
location = window.location;
delete window.location;
});
afterEach(() => {
window.location = location;
});
it('when the URL points to a panel it expands', () => {
const panelGroup = metricsDashboardViewModel.panelGroups[0];
const panel = panelGroup.panels[0];
setSearch(
objectToQuery({
group: panelGroup.group,
title: panel.title,
y_label: panel.y_label,
}),
);
createMountedWrapper({ hasMetrics: true });
setupStoreWithData(store);
return wrapper.vm.$nextTick().then(() => {
expect(store.dispatch).toHaveBeenCalledWith('monitoringDashboard/setExpandedPanel', {
group: panelGroup.group,
panel: expect.objectContaining({
title: panel.title,
y_label: panel.y_label,
}),
});
});
});
it('when the URL does not link to any panel, no panel is expanded', () => {
setSearch('');
createMountedWrapper({ hasMetrics: true });
setupStoreWithData(store);
return wrapper.vm.$nextTick().then(() => {
expect(store.dispatch).not.toHaveBeenCalledWith(
'monitoringDashboard/setExpandedPanel',
expect.anything(),
);
});
});
it('when the URL points to an incorrect panel it shows an error', () => {
const panelGroup = metricsDashboardViewModel.panelGroups[0];
const panel = panelGroup.panels[0];
setSearch(
objectToQuery({
group: panelGroup.group,
title: 'incorrect',
y_label: panel.y_label,
}),
);
createMountedWrapper({ hasMetrics: true });
setupStoreWithData(store);
return wrapper.vm.$nextTick().then(() => {
expect(createFlash).toHaveBeenCalled();
expect(store.dispatch).not.toHaveBeenCalledWith(
'monitoringDashboard/setExpandedPanel',
expect.anything(),
);
});
});
});
describe('when the panel is expanded', () => {
let group;
let panel;
const expandPanel = (mockGroup, mockPanel) => {
store.commit(`monitoringDashboard/${types.SET_EXPANDED_PANEL}`, {
group: mockGroup,
panel: mockPanel,
});
};
beforeEach(() => {
setupStoreWithData(store);
const { panelGroups } = store.state.monitoringDashboard.dashboard;
group = panelGroups[0].group;
[panel] = panelGroups[0].panels;
jest.spyOn(window.history, 'pushState').mockImplementation();
});
afterEach(() => {
window.history.pushState.mockRestore();
});
it('URL is updated with panel parameters', () => {
createMountedWrapper({ hasMetrics: true });
expandPanel(group, panel);
const expectedSearch = objectToQuery({
group,
title: panel.title,
y_label: panel.y_label,
});
return wrapper.vm.$nextTick(() => {
expect(window.history.pushState).toHaveBeenCalledTimes(1);
expect(window.history.pushState).toHaveBeenCalledWith(
expect.anything(), // state
expect.any(String), // document title
expect.stringContaining(`${expectedSearch}`),
);
});
});
it('URL is updated with panel parameters and custom dashboard', () => {
const dashboard = 'dashboard.yml';
2020-06-23 00:09:42 +05:30
store.commit(`monitoringDashboard/${types.SET_INITIAL_STATE}`, {
currentDashboard: dashboard,
});
createMountedWrapper({ hasMetrics: true });
2020-05-24 23:13:21 +05:30
expandPanel(group, panel);
const expectedSearch = objectToQuery({
dashboard,
group,
title: panel.title,
y_label: panel.y_label,
});
return wrapper.vm.$nextTick(() => {
expect(window.history.pushState).toHaveBeenCalledTimes(1);
expect(window.history.pushState).toHaveBeenCalledWith(
expect.anything(), // state
expect.any(String), // document title
expect.stringContaining(`${expectedSearch}`),
);
});
});
it('URL is updated with no parameters', () => {
expandPanel(group, panel);
createMountedWrapper({ hasMetrics: true });
expandPanel(null, null);
return wrapper.vm.$nextTick(() => {
expect(window.history.pushState).toHaveBeenCalledTimes(1);
expect(window.history.pushState).toHaveBeenCalledWith(
expect.anything(), // state
expect.any(String), // document title
expect.not.stringMatching(/group|title|y_label/), // no panel params
);
});
});
});
2020-03-13 15:44:24 +05:30
describe('when all requests have been commited by the store', () => {
beforeEach(() => {
2020-06-23 00:09:42 +05:30
store.commit(`monitoringDashboard/${types.SET_INITIAL_STATE}`, {
currentEnvironmentName: 'production',
});
2020-05-24 23:13:21 +05:30
createMountedWrapper({ hasMetrics: true });
setupStoreWithData(store);
2020-03-13 15:44:24 +05:30
return wrapper.vm.$nextTick();
});
it('renders the environments dropdown with a number of environments', () => {
expect(findAllEnvironmentsDropdownItems().length).toEqual(environmentData.length);
findAllEnvironmentsDropdownItems().wrappers.forEach((itemWrapper, index) => {
const anchorEl = itemWrapper.find('a');
if (anchorEl.exists() && environmentData[index].metrics_path) {
const href = anchorEl.attributes('href');
expect(href).toBe(environmentData[index].metrics_path);
}
});
});
2020-06-23 00:09:42 +05:30
// Note: This test is not working, .active does not show the active environment
// eslint-disable-next-line jest/no-disabled-tests
it.skip('renders the environments dropdown with a single active element', () => {
2020-03-13 15:44:24 +05:30
const activeItem = findAllEnvironmentsDropdownItems().wrappers.filter(itemWrapper =>
itemWrapper.find('.active').exists(),
);
expect(activeItem.length).toBe(1);
});
});
2020-05-24 23:13:21 +05:30
describe('star dashboards', () => {
2020-06-23 00:09:42 +05:30
const findToggleStar = () => wrapper.find(DashboardHeader).find({ ref: 'toggleStarBtn' });
2020-05-24 23:13:21 +05:30
const findToggleStarIcon = () => findToggleStar().find(GlIcon);
beforeEach(() => {
createShallowWrapper();
setupAllDashboards(store);
});
it('toggle star button is shown', () => {
expect(findToggleStar().exists()).toBe(true);
expect(findToggleStar().props('disabled')).toBe(false);
});
it('toggle star button is disabled when starring is taking place', () => {
store.commit(`monitoringDashboard/${types.REQUEST_DASHBOARD_STARRING}`);
return wrapper.vm.$nextTick(() => {
expect(findToggleStar().exists()).toBe(true);
expect(findToggleStar().props('disabled')).toBe(true);
});
});
describe('when the dashboard list is loaded', () => {
// Tooltip element should wrap directly
const getToggleTooltip = () => findToggleStar().element.parentElement.getAttribute('title');
beforeEach(() => {
setupAllDashboards(store);
jest.spyOn(store, 'dispatch');
});
it('dispatches a toggle star action', () => {
findToggleStar().vm.$emit('click');
return wrapper.vm.$nextTick().then(() => {
expect(store.dispatch).toHaveBeenCalledWith(
'monitoringDashboard/toggleStarredValue',
undefined,
);
});
});
describe('when dashboard is not starred', () => {
beforeEach(() => {
store.commit(`monitoringDashboard/${types.SET_INITIAL_STATE}`, {
currentDashboard: dashboardGitResponse[0].path,
});
return wrapper.vm.$nextTick();
});
it('toggle star button shows "Star dashboard"', () => {
expect(getToggleTooltip()).toBe('Star dashboard');
});
it('toggle star button shows an unstarred state', () => {
expect(findToggleStarIcon().attributes('name')).toBe('star-o');
});
});
describe('when dashboard is starred', () => {
beforeEach(() => {
store.commit(`monitoringDashboard/${types.SET_INITIAL_STATE}`, {
currentDashboard: dashboardGitResponse[1].path,
});
return wrapper.vm.$nextTick();
});
it('toggle star button shows "Star dashboard"', () => {
expect(getToggleTooltip()).toBe('Unstar dashboard');
});
it('toggle star button shows a starred state', () => {
expect(findToggleStarIcon().attributes('name')).toBe('star');
});
});
});
});
2020-03-13 15:44:24 +05:30
it('hides the environments dropdown list when there is no environments', () => {
2020-05-24 23:13:21 +05:30
createMountedWrapper({ hasMetrics: true });
2020-03-13 15:44:24 +05:30
2020-05-24 23:13:21 +05:30
setupStoreWithDashboard(store);
2020-03-13 15:44:24 +05:30
return wrapper.vm.$nextTick().then(() => {
expect(findAllEnvironmentsDropdownItems()).toHaveLength(0);
});
});
it('renders the datetimepicker dropdown', () => {
2020-05-24 23:13:21 +05:30
createMountedWrapper({ hasMetrics: true });
2020-03-13 15:44:24 +05:30
2020-05-24 23:13:21 +05:30
setupStoreWithData(store);
2020-03-13 15:44:24 +05:30
return wrapper.vm.$nextTick().then(() => {
expect(wrapper.find(DateTimePicker).exists()).toBe(true);
});
});
2020-04-08 14:13:33 +05:30
it('renders the refresh dashboard button', () => {
2020-05-24 23:13:21 +05:30
createMountedWrapper({ hasMetrics: true });
2020-04-08 14:13:33 +05:30
2020-05-24 23:13:21 +05:30
setupStoreWithData(store);
2020-04-08 14:13:33 +05:30
return wrapper.vm.$nextTick().then(() => {
2020-06-23 00:09:42 +05:30
const refreshBtn = wrapper.find(DashboardHeader).findAll({ ref: 'refreshDashboardBtn' });
2020-04-08 14:13:33 +05:30
expect(refreshBtn).toHaveLength(1);
2020-04-22 19:07:51 +05:30
expect(refreshBtn.is(GlDeprecatedButton)).toBe(true);
2020-04-08 14:13:33 +05:30
});
});
2020-05-24 23:13:21 +05:30
describe('variables section', () => {
2020-03-13 15:44:24 +05:30
beforeEach(() => {
createShallowWrapper({ hasMetrics: true });
2020-05-24 23:13:21 +05:30
setupStoreWithData(store);
setupStoreWithVariable(store);
return wrapper.vm.$nextTick();
});
it('shows the variables section', () => {
expect(wrapper.vm.shouldShowVariablesSection).toBe(true);
});
});
2020-06-23 00:09:42 +05:30
describe('links section', () => {
beforeEach(() => {
createShallowWrapper({ hasMetrics: true });
setupStoreWithData(store);
setupStoreWithLinks(store);
return wrapper.vm.$nextTick();
});
it('shows the links section', () => {
expect(wrapper.vm.shouldShowLinksSection).toBe(true);
expect(wrapper.find(LinksSection)).toExist();
});
});
2020-05-24 23:13:21 +05:30
describe('single panel expands to "full screen" mode', () => {
const findExpandedPanel = () => wrapper.find({ ref: 'expandedPanel' });
2020-04-22 19:07:51 +05:30
2020-05-24 23:13:21 +05:30
describe('when the panel is not expanded', () => {
beforeEach(() => {
createShallowWrapper({ hasMetrics: true });
setupStoreWithData(store);
return wrapper.vm.$nextTick();
});
it('expanded panel is not visible', () => {
expect(findExpandedPanel().isVisible()).toBe(false);
});
it('can set a panel as expanded', () => {
const panel = wrapper.findAll(DashboardPanel).at(1);
jest.spyOn(store, 'dispatch');
panel.vm.$emit('expand');
const groupData = metricsDashboardViewModel.panelGroups[0];
expect(store.dispatch).toHaveBeenCalledWith('monitoringDashboard/setExpandedPanel', {
group: groupData.group,
panel: expect.objectContaining({
id: groupData.panels[0].id,
}),
});
});
});
describe('when the panel is expanded', () => {
let group;
let panel;
const mockKeyup = key => window.dispatchEvent(new KeyboardEvent('keyup', { key }));
const MockPanel = {
template: `<div><slot name="topLeft"/></div>`,
};
beforeEach(() => {
createShallowWrapper({ hasMetrics: true }, { stubs: { DashboardPanel: MockPanel } });
setupStoreWithData(store);
const { panelGroups } = store.state.monitoringDashboard.dashboard;
group = panelGroups[0].group;
[panel] = panelGroups[0].panels;
store.commit(`monitoringDashboard/${types.SET_EXPANDED_PANEL}`, {
group,
panel,
});
jest.spyOn(store, 'dispatch');
return wrapper.vm.$nextTick();
});
2020-04-22 19:07:51 +05:30
2020-05-24 23:13:21 +05:30
it('displays a single panel and others are hidden', () => {
const panels = wrapper.findAll(MockPanel);
const visiblePanels = panels.filter(w => w.isVisible());
expect(findExpandedPanel().isVisible()).toBe(true);
// v-show for hiding panels is more performant than v-if
// check for panels to be hidden.
expect(panels.length).toBe(metricsDashboardPanelCount + 1);
expect(visiblePanels.length).toBe(1);
});
it('sets a link to the expanded panel', () => {
const searchQuery =
'?dashboard=config%2Fprometheus%2Fcommon_metrics.yml&group=System%20metrics%20(Kubernetes)&title=Memory%20Usage%20(Total)&y_label=Total%20Memory%20Used%20(GB)';
expect(findExpandedPanel().attributes('clipboard-text')).toEqual(
expect.stringContaining(searchQuery),
);
});
it('restores full dashboard by clicking `back`', () => {
wrapper.find({ ref: 'goBackBtn' }).vm.$emit('click');
expect(store.dispatch).toHaveBeenCalledWith(
'monitoringDashboard/clearExpandedPanel',
undefined,
);
});
it('restores dashboard from full screen by typing the Escape key', () => {
mockKeyup(ESC_KEY);
expect(store.dispatch).toHaveBeenCalledWith(
`monitoringDashboard/clearExpandedPanel`,
undefined,
);
});
it('restores dashboard from full screen by typing the Escape key on IE11', () => {
mockKeyup(ESC_KEY_IE11);
expect(store.dispatch).toHaveBeenCalledWith(
`monitoringDashboard/clearExpandedPanel`,
undefined,
);
});
});
});
describe('when one of the metrics is missing', () => {
beforeEach(() => {
createShallowWrapper({ hasMetrics: true });
setupStoreWithDashboard(store);
setMetricResult({ store, result: [], panel: 2 });
2020-03-13 15:44:24 +05:30
return wrapper.vm.$nextTick();
});
it('shows a group empty area', () => {
const emptyGroup = wrapper.findAll({ ref: 'empty-group' });
expect(emptyGroup).toHaveLength(1);
expect(emptyGroup.is(GroupEmptyState)).toBe(true);
});
it('group empty area displays a NO_DATA state', () => {
expect(
wrapper
.findAll({ ref: 'empty-group' })
.at(0)
.props('selectedState'),
).toEqual(metricStates.NO_DATA);
});
});
describe('searchable environments dropdown', () => {
beforeEach(() => {
2020-05-24 23:13:21 +05:30
createMountedWrapper({ hasMetrics: true }, { attachToDocument: true });
2020-03-13 15:44:24 +05:30
2020-05-24 23:13:21 +05:30
setupStoreWithData(store);
2020-03-13 15:44:24 +05:30
return wrapper.vm.$nextTick();
});
2020-05-24 23:13:21 +05:30
afterEach(() => {
wrapper.destroy();
});
2020-03-13 15:44:24 +05:30
it('renders a search input', () => {
2020-06-23 00:09:42 +05:30
expect(
wrapper
.find(DashboardHeader)
.find({ ref: 'monitorEnvironmentsDropdownSearch' })
.exists(),
).toBe(true);
2020-03-13 15:44:24 +05:30
});
it('renders dropdown items', () => {
findAllEnvironmentsDropdownItems().wrappers.forEach((itemWrapper, index) => {
const anchorEl = itemWrapper.find('a');
if (anchorEl.exists()) {
expect(anchorEl.text()).toBe(environmentData[index].name);
}
});
});
it('filters rendered dropdown items', () => {
const searchTerm = 'production';
const resultEnvs = environmentData.filter(({ name }) => name.indexOf(searchTerm) !== -1);
setSearchTerm(searchTerm);
return wrapper.vm.$nextTick().then(() => {
expect(findAllEnvironmentsDropdownItems().length).toEqual(resultEnvs.length);
});
});
it('does not filter dropdown items if search term is empty string', () => {
const searchTerm = '';
setSearchTerm(searchTerm);
return wrapper.vm.$nextTick(() => {
expect(findAllEnvironmentsDropdownItems().length).toEqual(environmentData.length);
});
});
it("shows error message if search term doesn't match", () => {
const searchTerm = 'does-not-exist';
setSearchTerm(searchTerm);
return wrapper.vm.$nextTick(() => {
2020-06-23 00:09:42 +05:30
expect(
wrapper
.find(DashboardHeader)
.find({ ref: 'monitorEnvironmentsDropdownMsg' })
.isVisible(),
).toBe(true);
2020-03-13 15:44:24 +05:30
});
});
it('shows loading element when environments fetch is still loading', () => {
2020-05-24 23:13:21 +05:30
store.commit(`monitoringDashboard/${types.REQUEST_ENVIRONMENTS_DATA}`);
2020-03-13 15:44:24 +05:30
return wrapper.vm
.$nextTick()
.then(() => {
2020-06-23 00:09:42 +05:30
expect(
wrapper
.find(DashboardHeader)
.find({ ref: 'monitorEnvironmentsDropdownLoading' })
.exists(),
).toBe(true);
2020-03-13 15:44:24 +05:30
})
.then(() => {
2020-05-24 23:13:21 +05:30
store.commit(
2020-03-13 15:44:24 +05:30
`monitoringDashboard/${types.RECEIVE_ENVIRONMENTS_DATA_SUCCESS}`,
environmentData,
);
})
.then(() => {
2020-06-23 00:09:42 +05:30
expect(
wrapper
.find(DashboardHeader)
.find({ ref: 'monitorEnvironmentsDropdownLoading' })
.exists(),
).toBe(false);
2020-03-13 15:44:24 +05:30
});
});
});
describe('drag and drop function', () => {
const findDraggables = () => wrapper.findAll(VueDraggable);
const findEnabledDraggables = () => findDraggables().filter(f => !f.attributes('disabled'));
const findDraggablePanels = () => wrapper.findAll('.js-draggable-panel');
const findRearrangeButton = () => wrapper.find('.js-rearrange-button');
beforeEach(() => {
2020-05-24 23:13:21 +05:30
// call original dispatch
store.dispatch.mockRestore();
2020-03-13 15:44:24 +05:30
2020-05-24 23:13:21 +05:30
createShallowWrapper({ hasMetrics: true });
setupStoreWithData(store);
2020-03-13 15:44:24 +05:30
return wrapper.vm.$nextTick();
});
it('wraps vuedraggable', () => {
expect(findDraggablePanels().exists()).toBe(true);
2020-04-22 19:07:51 +05:30
expect(findDraggablePanels().length).toEqual(metricsDashboardPanelCount);
2020-03-13 15:44:24 +05:30
});
it('is disabled by default', () => {
expect(findRearrangeButton().exists()).toBe(false);
expect(findEnabledDraggables().length).toBe(0);
});
describe('when rearrange is enabled', () => {
beforeEach(() => {
wrapper.setProps({ rearrangePanelsAvailable: true });
return wrapper.vm.$nextTick();
});
it('displays rearrange button', () => {
expect(findRearrangeButton().exists()).toBe(true);
});
describe('when rearrange button is clicked', () => {
const findFirstDraggableRemoveButton = () =>
findDraggablePanels()
.at(0)
.find('.js-draggable-remove');
beforeEach(() => {
findRearrangeButton().vm.$emit('click');
return wrapper.vm.$nextTick();
});
it('it enables draggables', () => {
expect(findRearrangeButton().attributes('pressed')).toBeTruthy();
expect(findEnabledDraggables()).toEqual(findDraggables());
});
it('metrics can be swapped', () => {
const firstDraggable = findDraggables().at(0);
2020-04-08 14:13:33 +05:30
const mockMetrics = [...metricsDashboardViewModel.panelGroups[0].panels];
2020-03-13 15:44:24 +05:30
const firstTitle = mockMetrics[0].title;
const secondTitle = mockMetrics[1].title;
// swap two elements and `input` them
[mockMetrics[0], mockMetrics[1]] = [mockMetrics[1], mockMetrics[0]];
firstDraggable.vm.$emit('input', mockMetrics);
return wrapper.vm.$nextTick(() => {
2020-04-08 14:13:33 +05:30
const { panels } = wrapper.vm.dashboard.panelGroups[0];
2020-03-13 15:44:24 +05:30
expect(panels[1].title).toEqual(firstTitle);
expect(panels[0].title).toEqual(secondTitle);
});
});
it('shows a remove button, which removes a panel', () => {
expect(findFirstDraggableRemoveButton().isEmpty()).toBe(false);
2020-04-22 19:07:51 +05:30
expect(findDraggablePanels().length).toEqual(metricsDashboardPanelCount);
2020-03-13 15:44:24 +05:30
findFirstDraggableRemoveButton().trigger('click');
return wrapper.vm.$nextTick(() => {
2020-04-22 19:07:51 +05:30
expect(findDraggablePanels().length).toEqual(metricsDashboardPanelCount - 1);
2020-03-13 15:44:24 +05:30
});
});
it('it disables draggables when clicked again', () => {
findRearrangeButton().vm.$emit('click');
return wrapper.vm.$nextTick(() => {
expect(findRearrangeButton().attributes('pressed')).toBeFalsy();
expect(findEnabledDraggables().length).toBe(0);
});
});
});
});
});
2020-06-23 00:09:42 +05:30
describe('dashboard timezone', () => {
const setupWithTimezone = value => {
store = createStore({ dashboardTimezone: value });
setupStoreWithData(store);
createShallowWrapper({ hasMetrics: true });
return wrapper.vm.$nextTick;
};
describe('local timezone is enabled by default', () => {
beforeEach(() => {
return setupWithTimezone();
});
it('shows the data time picker in local timezone', () => {
expect(
findDashboardHeader()
.find(DateTimePicker)
.props('utc'),
).toBe(false);
});
});
describe('when LOCAL timezone is enabled', () => {
beforeEach(() => {
return setupWithTimezone('LOCAL');
});
it('shows the data time picker in local timezone', () => {
expect(
findDashboardHeader()
.find(DateTimePicker)
.props('utc'),
).toBe(false);
});
});
describe('when UTC timezone is enabled', () => {
beforeEach(() => {
return setupWithTimezone('UTC');
});
it('shows the data time picker in UTC format', () => {
expect(
findDashboardHeader()
.find(DateTimePicker)
.props('utc'),
).toBe(true);
});
});
});
2020-03-13 15:44:24 +05:30
describe('cluster health', () => {
beforeEach(() => {
createShallowWrapper({ hasMetrics: true, showHeader: false });
// all_dashboards is not defined in health dashboards
2020-05-24 23:13:21 +05:30
store.commit(`monitoringDashboard/${types.SET_ALL_DASHBOARDS}`, undefined);
2020-03-13 15:44:24 +05:30
return wrapper.vm.$nextTick();
});
it('hides dashboard header by default', () => {
expect(wrapper.find({ ref: 'prometheusGraphsHeader' }).exists()).toEqual(false);
});
it('renders correctly', () => {
expect(wrapper.isVueInstance()).toBe(true);
expect(wrapper.exists()).toBe(true);
});
});
describe('dashboard edit link', () => {
const findEditLink = () => wrapper.find('.js-edit-link');
beforeEach(() => {
createShallowWrapper({ hasMetrics: true });
2020-05-24 23:13:21 +05:30
setupAllDashboards(store);
2020-03-13 15:44:24 +05:30
return wrapper.vm.$nextTick();
});
it('is not present for the default dashboard', () => {
expect(findEditLink().exists()).toBe(false);
});
it('is present for a custom dashboard, and links to its edit_path', () => {
2020-05-24 23:13:21 +05:30
const dashboard = dashboardGitResponse[1];
store.commit(`monitoringDashboard/${types.SET_INITIAL_STATE}`, {
currentDashboard: dashboard.path,
});
2020-03-13 15:44:24 +05:30
return wrapper.vm.$nextTick().then(() => {
expect(findEditLink().exists()).toBe(true);
expect(findEditLink().attributes('href')).toBe(dashboard.project_blob_path);
});
});
});
2020-06-23 00:09:42 +05:30
describe('document title', () => {
const originalTitle = 'Original Title';
const defaultDashboardName = dashboardGitResponse[0].display_name;
beforeEach(() => {
document.title = originalTitle;
createShallowWrapper({ hasMetrics: true });
});
afterAll(() => {
document.title = '';
});
it('is prepended with default dashboard name by default', () => {
setupAllDashboards(store);
return wrapper.vm.$nextTick().then(() => {
expect(document.title.startsWith(`${defaultDashboardName} · `)).toBe(true);
});
});
it('is prepended with dashboard name if path is known', () => {
const dashboard = dashboardGitResponse[1];
const currentDashboard = dashboard.path;
setupAllDashboards(store, currentDashboard);
return wrapper.vm.$nextTick().then(() => {
expect(document.title.startsWith(`${dashboard.display_name} · `)).toBe(true);
});
});
it('is prepended with default dashboard name is path is not known', () => {
setupAllDashboards(store, 'unknown/path');
return wrapper.vm.$nextTick().then(() => {
expect(document.title.startsWith(`${defaultDashboardName} · `)).toBe(true);
});
});
it('is not modified when dashboard name is not provided', () => {
const dashboard = { ...dashboardGitResponse[1], display_name: null };
const currentDashboard = dashboard.path;
store.commit(`monitoringDashboard/${types.SET_ALL_DASHBOARDS}`, [dashboard]);
store.commit(`monitoringDashboard/${types.SET_INITIAL_STATE}`, {
currentDashboard,
});
return wrapper.vm.$nextTick().then(() => {
expect(document.title).toBe(originalTitle);
});
});
});
2020-03-13 15:44:24 +05:30
describe('Dashboard dropdown', () => {
beforeEach(() => {
2020-05-24 23:13:21 +05:30
createMountedWrapper({ hasMetrics: true });
setupAllDashboards(store);
2020-03-13 15:44:24 +05:30
return wrapper.vm.$nextTick();
});
it('shows the dashboard dropdown', () => {
const dashboardDropdown = wrapper.find(DashboardsDropdown);
expect(dashboardDropdown.exists()).toBe(true);
});
});
describe('external dashboard link', () => {
beforeEach(() => {
2020-05-24 23:13:21 +05:30
createMountedWrapper({
hasMetrics: true,
showPanels: false,
showTimeWindowDropdown: false,
externalDashboardUrl: '/mockUrl',
});
2020-03-13 15:44:24 +05:30
return wrapper.vm.$nextTick();
});
it('shows the link', () => {
const externalDashboardButton = wrapper.find('.js-external-dashboard-link');
expect(externalDashboardButton.exists()).toBe(true);
2020-04-22 19:07:51 +05:30
expect(externalDashboardButton.is(GlDeprecatedButton)).toBe(true);
2020-03-13 15:44:24 +05:30
expect(externalDashboardButton.text()).toContain('View full dashboard');
});
});
describe('Clipboard text in panels', () => {
2020-05-24 23:13:21 +05:30
const currentDashboard = dashboardGitResponse[1].path;
const panelIndex = 1; // skip expanded panel
2020-03-13 15:44:24 +05:30
2020-05-24 23:13:21 +05:30
const getClipboardTextFirstPanel = () =>
2020-03-13 15:44:24 +05:30
wrapper
2020-05-24 23:13:21 +05:30
.findAll(DashboardPanel)
.at(panelIndex)
2020-03-13 15:44:24 +05:30
.props('clipboardText');
beforeEach(() => {
2020-05-24 23:13:21 +05:30
setupStoreWithData(store);
2020-06-23 00:09:42 +05:30
store.commit(`monitoringDashboard/${types.SET_INITIAL_STATE}`, {
currentDashboard,
});
createShallowWrapper({ hasMetrics: true });
2020-03-13 15:44:24 +05:30
return wrapper.vm.$nextTick();
});
it('contains a link to the dashboard', () => {
2020-05-24 23:13:21 +05:30
const dashboardParam = `dashboard=${encodeURIComponent(currentDashboard)}`;
2020-03-13 15:44:24 +05:30
2020-05-24 23:13:21 +05:30
expect(getClipboardTextFirstPanel()).toContain(dashboardParam);
expect(getClipboardTextFirstPanel()).toContain(`group=`);
expect(getClipboardTextFirstPanel()).toContain(`title=`);
expect(getClipboardTextFirstPanel()).toContain(`y_label=`);
2020-03-13 15:44:24 +05:30
});
});
2020-04-22 19:07:51 +05:30
describe('add custom metrics', () => {
2020-06-23 00:09:42 +05:30
const findAddMetricButton = () => wrapper.find(DashboardHeader).find({ ref: 'addMetricBtn' });
2020-04-22 19:07:51 +05:30
describe('when not available', () => {
beforeEach(() => {
createShallowWrapper({
hasMetrics: true,
customMetricsPath: '/endpoint',
});
});
it('does not render add button on the dashboard', () => {
2020-06-23 00:09:42 +05:30
expect(findAddMetricButton().exists()).toBe(false);
2020-04-22 19:07:51 +05:30
});
});
describe('when available', () => {
let origPage;
beforeEach(done => {
jest.spyOn(Tracking, 'event').mockReturnValue();
createShallowWrapper({
hasMetrics: true,
customMetricsPath: '/endpoint',
customMetricsAvailable: true,
});
2020-05-24 23:13:21 +05:30
setupStoreWithData(store);
2020-04-22 19:07:51 +05:30
origPage = document.body.dataset.page;
document.body.dataset.page = 'projects:environments:metrics';
wrapper.vm.$nextTick(done);
});
afterEach(() => {
document.body.dataset.page = origPage;
});
it('renders add button on the dashboard', () => {
expect(findAddMetricButton()).toBeDefined();
});
it('uses modal for custom metrics form', () => {
expect(wrapper.find(GlModal).exists()).toBe(true);
expect(wrapper.find(GlModal).attributes().modalid).toBe('add-metric');
});
it('adding new metric is tracked', done => {
2020-06-23 00:09:42 +05:30
const submitButton = wrapper
.find(DashboardHeader)
.find({ ref: 'submitCustomMetricsFormBtn' }).vm;
2020-04-22 19:07:51 +05:30
wrapper.vm.$nextTick(() => {
submitButton.$el.click();
wrapper.vm.$nextTick(() => {
expect(Tracking.event).toHaveBeenCalledWith(
document.body.dataset.page,
'click_button',
{
label: 'add_new_metric',
property: 'modal',
value: undefined,
},
);
done();
});
});
});
it('renders custom metrics form fields', () => {
expect(wrapper.find(CustomMetricsFormFields).exists()).toBe(true);
});
});
});
2020-03-13 15:44:24 +05:30
});