dashboard_spec.js 17.3 KB
Newer Older
1 2 3 4 5 6 7 8
import { shallowMount, createLocalVue, mount } from '@vue/test-utils';
import { GlDropdownItem, GlButton, GlToast } from '@gitlab/ui';
import VueDraggable from 'vuedraggable';
import MockAdapter from 'axios-mock-adapter';
import axios from '~/lib/utils/axios_utils';
import statusCodes from '~/lib/utils/http_status';
import { metricStates } from '~/monitoring/constants';
import Dashboard from '~/monitoring/components/dashboard.vue';
9

10
import DateTimePicker from '~/vue_shared/components/date_time_picker/date_time_picker.vue';
11
import DashboardsDropdown from '~/monitoring/components/dashboards_dropdown.vue';
12 13 14 15 16
import GroupEmptyState from '~/monitoring/components/group_empty_state.vue';
import { createStore } from '~/monitoring/stores';
import * as types from '~/monitoring/stores/mutation_types';
import { setupComponentStore, propsData } from '../init_utils';
import {
17
  metricsDashboardPayload,
18 19 20 21 22 23 24 25 26 27 28 29 30
  mockedQueryResultPayload,
  environmentData,
  dashboardGitResponse,
} from '../mock_data';

const localVue = createLocalVue();
const expectedPanelCount = 2;

describe('Dashboard', () => {
  let store;
  let wrapper;
  let mock;

31 32 33
  const findEnvironmentsDropdown = () => wrapper.find({ ref: 'monitorEnvironmentsDropdown' });
  const findAllEnvironmentsDropdownItems = () => findEnvironmentsDropdown().findAll(GlDropdownItem);
  const setSearchTerm = searchTerm => {
34
    wrapper.vm.$store.commit(`monitoringDashboard/${types.SET_ENVIRONMENTS_FILTER}`, searchTerm);
35 36
  };

37
  const createShallowWrapper = (props = {}, options = {}) => {
38
    wrapper = shallowMount(Dashboard, {
39 40
      localVue,
      propsData: { ...propsData, ...props },
41 42 43
      methods: {
        fetchData: jest.fn(),
      },
44 45 46 47 48 49
      store,
      ...options,
    });
  };

  const createMountedWrapper = (props = {}, options = {}) => {
50
    wrapper = mount(Dashboard, {
51 52
      localVue,
      propsData: { ...propsData, ...props },
53 54 55
      methods: {
        fetchData: jest.fn(),
      },
56 57 58 59 60 61 62 63 64 65 66 67 68
      store,
      ...options,
    });
  };

  beforeEach(() => {
    store = createStore();
    mock = new MockAdapter(axios);
  });

  afterEach(() => {
    if (wrapper) {
      wrapper.destroy();
69
      wrapper = null;
70 71 72 73 74 75
    }
    mock.restore();
  });

  describe('no metrics are available yet', () => {
    beforeEach(() => {
76
      createShallowWrapper();
77 78 79
    });

    it('shows the environment selector', () => {
80
      expect(findEnvironmentsDropdown().exists()).toBe(true);
81 82 83 84 85
    });
  });

  describe('no data found', () => {
    beforeEach(done => {
86
      createShallowWrapper();
87 88 89 90 91

      wrapper.vm.$nextTick(done);
    });

    it('shows the environment selector dropdown', () => {
92
      expect(findEnvironmentsDropdown().exists()).toBe(true);
93 94 95 96 97
    });
  });

  describe('request information to the server', () => {
    it('shows up a loading state', done => {
98
      createShallowWrapper({ hasMetrics: true }, { methods: {} });
99 100 101 102 103 104 105 106 107 108 109 110 111 112

      wrapper.vm
        .$nextTick()
        .then(() => {
          expect(wrapper.vm.emptyState).toEqual('loading');

          done();
        })
        .catch(done.fail);
    });

    it('hides the group panels when showPanels is false', done => {
      createMountedWrapper(
        { hasMetrics: true, showPanels: false },
113
        { stubs: ['graph-group', 'panel-type'] },
114 115 116 117 118 119 120 121
      );

      setupComponentStore(wrapper);

      wrapper.vm
        .$nextTick()
        .then(() => {
          expect(wrapper.vm.showEmptyState).toEqual(false);
122
          expect(wrapper.findAll('.prometheus-panel')).toHaveLength(0);
123 124 125 126 127 128 129 130 131

          done();
        })
        .catch(done.fail);
    });

    it('fetches the metrics data with proper time window', done => {
      jest.spyOn(store, 'dispatch');

132
      createMountedWrapper({ hasMetrics: true }, { stubs: ['graph-group', 'panel-type'] });
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151

      wrapper.vm.$store.commit(
        `monitoringDashboard/${types.RECEIVE_ENVIRONMENTS_DATA_SUCCESS}`,
        environmentData,
      );

      wrapper.vm
        .$nextTick()
        .then(() => {
          expect(store.dispatch).toHaveBeenCalled();

          done();
        })
        .catch(done.fail);
    });
  });

  describe('when all requests have been commited by the store', () => {
    beforeEach(() => {
152
      createMountedWrapper({ hasMetrics: true }, { stubs: ['graph-group', 'panel-type'] });
153 154 155 156 157 158 159 160

      setupComponentStore(wrapper);
    });

    it('renders the environments dropdown with a number of environments', done => {
      wrapper.vm
        .$nextTick()
        .then(() => {
161
          expect(findAllEnvironmentsDropdownItems().length).toEqual(environmentData.length);
162

163
          findAllEnvironmentsDropdownItems().wrappers.forEach((itemWrapper, index) => {
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
            const anchorEl = itemWrapper.find('a');
            if (anchorEl.exists() && environmentData[index].metrics_path) {
              const href = anchorEl.attributes('href');
              expect(href).toBe(environmentData[index].metrics_path);
            }
          });

          done();
        })
        .catch(done.fail);
    });

    it('renders the environments dropdown with a single active element', done => {
      wrapper.vm
        .$nextTick()
        .then(() => {
180
          const activeItem = findAllEnvironmentsDropdownItems().wrappers.filter(itemWrapper =>
181 182 183 184 185 186 187 188 189 190 191
            itemWrapper.find('.active').exists(),
          );

          expect(activeItem.length).toBe(1);
          done();
        })
        .catch(done.fail);
    });
  });

  it('hides the environments dropdown list when there is no environments', done => {
192
    createMountedWrapper({ hasMetrics: true }, { stubs: ['graph-group', 'panel-type'] });
193 194 195

    wrapper.vm.$store.commit(
      `monitoringDashboard/${types.RECEIVE_METRICS_DATA_SUCCESS}`,
196
      metricsDashboardPayload,
197 198 199 200 201 202 203 204 205
    );
    wrapper.vm.$store.commit(
      `monitoringDashboard/${types.RECEIVE_METRIC_RESULT_SUCCESS}`,
      mockedQueryResultPayload,
    );

    wrapper.vm
      .$nextTick()
      .then(() => {
206
        expect(findAllEnvironmentsDropdownItems()).toHaveLength(0);
207 208 209 210 211 212
        done();
      })
      .catch(done.fail);
  });

  it('renders the datetimepicker dropdown', done => {
213
    createMountedWrapper({ hasMetrics: true }, { stubs: ['graph-group', 'panel-type'] });
214 215 216 217 218 219 220 221 222 223 224 225 226 227

    setupComponentStore(wrapper);

    wrapper.vm
      .$nextTick()
      .then(() => {
        expect(wrapper.find(DateTimePicker).exists()).toBe(true);
        done();
      })
      .catch(done.fail);
  });

  describe('when one of the metrics is missing', () => {
    beforeEach(done => {
228
      createShallowWrapper({ hasMetrics: true });
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
      setupComponentStore(wrapper);

      wrapper.vm.$nextTick(done);
    });

    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);
    });
  });

251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
  describe('searchable environments dropdown', () => {
    beforeEach(() => {
      createMountedWrapper(
        { hasMetrics: true },
        {
          attachToDocument: true,
          stubs: ['graph-group', 'panel-type'],
          provide: {
            glFeatures: { searchableEnvironmentsDropdown: true },
          },
        },
      );

      setupComponentStore(wrapper);

      return wrapper.vm.$nextTick();
    });

    afterEach(() => {
      wrapper.destroy();
    });

    it('renders a search input', () => {
      expect(wrapper.find({ ref: 'monitorEnvironmentsDropdownSearch' }).exists()).toBe(true);
    });

    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(() => {
        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(() => {
        expect(wrapper.find({ ref: 'monitorEnvironmentsDropdownMsg' }).isVisible()).toBe(true);
      });
    });
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331

    it('shows loading element when environments fetch is still loading', () => {
      wrapper.vm.$store.commit(`monitoringDashboard/${types.REQUEST_ENVIRONMENTS_DATA}`);

      return wrapper.vm
        .$nextTick()
        .then(() => {
          expect(wrapper.find({ ref: 'monitorEnvironmentsDropdownLoading' }).exists()).toBe(true);
        })
        .then(() => {
          wrapper.vm.$store.commit(
            `monitoringDashboard/${types.RECEIVE_ENVIRONMENTS_DATA_SUCCESS}`,
            environmentData,
          );
        })
        .then(() => {
          expect(wrapper.find({ ref: 'monitorEnvironmentsDropdownLoading' }).exists()).toBe(false);
        });
    });
332 333
  });

334 335 336 337 338 339 340
  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(done => {
341
      createShallowWrapper({ hasMetrics: true });
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385

      setupComponentStore(wrapper);

      wrapper.vm.$nextTick(done);
    });

    it('wraps vuedraggable', () => {
      expect(findDraggablePanels().exists()).toBe(true);
      expect(findDraggablePanels().length).toEqual(expectedPanelCount);
    });

    it('is disabled by default', () => {
      expect(findRearrangeButton().exists()).toBe(false);
      expect(findEnabledDraggables().length).toBe(0);
    });

    describe('when rearrange is enabled', () => {
      beforeEach(done => {
        wrapper.setProps({ rearrangePanelsAvailable: true });
        wrapper.vm.$nextTick(done);
      });

      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(done => {
          findRearrangeButton().vm.$emit('click');
          wrapper.vm.$nextTick(done);
        });

        it('it enables draggables', () => {
          expect(findRearrangeButton().attributes('pressed')).toBeTruthy();
          expect(findEnabledDraggables()).toEqual(findDraggables());
        });

        it('metrics can be swapped', done => {
          const firstDraggable = findDraggables().at(0);
386
          const mockMetrics = [...metricsDashboardPayload.panel_groups[1].panels];
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430

          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);

          wrapper.vm.$nextTick(() => {
            const { panels } = wrapper.vm.dashboard.panel_groups[1];

            expect(panels[1].title).toEqual(firstTitle);
            expect(panels[0].title).toEqual(secondTitle);
            done();
          });
        });

        it('shows a remove button, which removes a panel', done => {
          expect(findFirstDraggableRemoveButton().isEmpty()).toBe(false);

          expect(findDraggablePanels().length).toEqual(expectedPanelCount);
          findFirstDraggableRemoveButton().trigger('click');

          wrapper.vm.$nextTick(() => {
            expect(findDraggablePanels().length).toEqual(expectedPanelCount - 1);
            done();
          });
        });

        it('it disables draggables when clicked again', done => {
          findRearrangeButton().vm.$emit('click');
          wrapper.vm.$nextTick(() => {
            expect(findRearrangeButton().attributes('pressed')).toBeFalsy();
            expect(findEnabledDraggables().length).toBe(0);
            done();
          });
        });
      });
    });
  });

  describe('cluster health', () => {
    beforeEach(done => {
      mock.onGet(propsData.metricsEndpoint).reply(statusCodes.OK, JSON.stringify({}));
431
      createShallowWrapper({ hasMetrics: true, showHeader: false });
432 433 434 435 436 437

      // all_dashboards is not defined in health dashboards
      wrapper.vm.$store.commit(`monitoringDashboard/${types.SET_ALL_DASHBOARDS}`, undefined);
      wrapper.vm.$nextTick(done);
    });

438 439 440 441
    it('hides dashboard header by default', () => {
      expect(wrapper.find({ ref: 'prometheusGraphsHeader' }).exists()).toEqual(false);
    });

442 443 444 445 446 447 448 449 450 451
    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(done => {
452
      createShallowWrapper({ hasMetrics: true });
453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482

      wrapper.vm.$store.commit(
        `monitoringDashboard/${types.SET_ALL_DASHBOARDS}`,
        dashboardGitResponse,
      );
      wrapper.vm.$nextTick(done);
    });

    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', done => {
      const dashboard = dashboardGitResponse[1]; // non-default dashboard
      const currentDashboard = dashboard.path;

      wrapper.setProps({ currentDashboard });
      wrapper.vm
        .$nextTick()
        .then(() => {
          expect(findEditLink().exists()).toBe(true);
          expect(findEditLink().attributes('href')).toBe(dashboard.project_blob_path);
          done();
        })
        .catch(done.fail);
    });
  });

  describe('Dashboard dropdown', () => {
    beforeEach(() => {
483
      createMountedWrapper({ hasMetrics: true }, { stubs: ['graph-group', 'panel-type'] });
484 485 486 487 488 489 490 491 492 493 494

      wrapper.vm.$store.commit(
        `monitoringDashboard/${types.SET_ALL_DASHBOARDS}`,
        dashboardGitResponse,
      );
    });

    it('shows the dashboard dropdown', done => {
      wrapper.vm
        .$nextTick()
        .then(() => {
495
          const dashboardDropdown = wrapper.find(DashboardsDropdown);
496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512

          expect(dashboardDropdown.exists()).toBe(true);
          done();
        })
        .catch(done.fail);
    });
  });

  describe('external dashboard link', () => {
    beforeEach(() => {
      createMountedWrapper(
        {
          hasMetrics: true,
          showPanels: false,
          showTimeWindowDropdown: false,
          externalDashboardUrl: '/mockUrl',
        },
513
        { stubs: ['graph-group', 'panel-type'] },
514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
      );
    });

    it('shows the link', done => {
      wrapper.vm
        .$nextTick()
        .then(() => {
          const externalDashboardButton = wrapper.find('.js-external-dashboard-link');

          expect(externalDashboardButton.exists()).toBe(true);
          expect(externalDashboardButton.is(GlButton)).toBe(true);
          expect(externalDashboardButton.text()).toContain('View full dashboard');
          done();
        })
        .catch(done.fail);
    });
  });

  // https://gitlab.com/gitlab-org/gitlab-ce/issues/66922
  // eslint-disable-next-line jest/no-disabled-tests
  describe.skip('link to chart', () => {
    const currentDashboard = 'TEST_DASHBOARD';
    localVue.use(GlToast);
    const link = () => wrapper.find('.js-chart-link');
    const clipboardText = () => link().element.dataset.clipboardText;

    beforeEach(done => {
541
      createShallowWrapper({ hasMetrics: true, currentDashboard });
542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585

      setTimeout(done);
    });

    it('adds a copy button to the dropdown', () => {
      expect(link().text()).toContain('Generate link to chart');
    });

    it('contains a link to the dashboard', () => {
      expect(clipboardText()).toContain(`dashboard=${currentDashboard}`);
      expect(clipboardText()).toContain(`group=`);
      expect(clipboardText()).toContain(`title=`);
      expect(clipboardText()).toContain(`y_label=`);
    });

    it('undefined parameter is stripped', done => {
      wrapper.setProps({ currentDashboard: undefined });

      wrapper.vm.$nextTick(() => {
        expect(clipboardText()).not.toContain(`dashboard=`);
        expect(clipboardText()).toContain(`y_label=`);
        done();
      });
    });

    it('null parameter is stripped', done => {
      wrapper.setProps({ currentDashboard: null });

      wrapper.vm.$nextTick(() => {
        expect(clipboardText()).not.toContain(`dashboard=`);
        expect(clipboardText()).toContain(`y_label=`);
        done();
      });
    });

    it('creates a toast when clicked', () => {
      jest.spyOn(wrapper.vm.$toast, 'show').and.stub();

      link().vm.$emit('click');

      expect(wrapper.vm.$toast.show).toHaveBeenCalled();
    });
  });
});