grafana/public/app/features/search/hooks/useManageDashboards.test.ts

import { renderHook } from '@testing-library/react-hooks';
import { Dispatch } from 'react';

import { setEchoSrv } from '@grafana/runtime/src';
import { Echo } from 'app/core/services/echo/Echo';

import { GENERAL_FOLDER_ID } from '../constants';
import { ManageDashboardsState } from '../reducers/manageDashboards';
import { DashboardQuery, DashboardSearchItemType, DashboardSection, SearchAction } from '../types';

import { useManageDashboards } from './useManageDashboards';
import * as useSearch from './useSearch';

describe('useManageDashboards', () => {
  const useSearchMock = jest.spyOn(useSearch, 'useSearch');
  const toggle = async (section: DashboardSection) => section;

  beforeAll(() => {
    setEchoSrv(new Echo());
  });

  function setupTestContext({ results = [] }: { results?: DashboardSection[] } = {}) {
    jest.clearAllMocks();

    const state: ManageDashboardsState = {
      results,
      loading: false,
      selectedIndex: 0,
      initialLoading: false,
      allChecked: false,
    };
    const dispatch: Dispatch<SearchAction> = null as unknown as Dispatch<SearchAction>;
    useSearchMock.mockReturnValue({ state, dispatch, onToggleSection: toggle });
    const dashboardQuery: DashboardQuery = {} as unknown as DashboardQuery;

    const { result } = renderHook(() => useManageDashboards(dashboardQuery, {}));

    return { result };
  }

  describe('when called and only General folder is selected', () => {
    it('then canDelete should be false', () => {
      const results: DashboardSection[] = [
        { id: 1, checked: false, items: [], title: 'One', type: DashboardSearchItemType.DashFolder, toggle, url: '/' },
        {
          id: GENERAL_FOLDER_ID,
          checked: true,
          items: [],
          title: 'General',
          type: DashboardSearchItemType.DashFolder,
          toggle,
          url: '/',
        },
        { id: 2, checked: false, items: [], title: 'Two', type: DashboardSearchItemType.DashFolder, toggle, url: '/' },
      ];

      const { result } = setupTestContext({ results });

      expect(result.current.canDelete).toBe(false);
    });
  });

  describe('when called and General folder and another folder are selected', () => {
    it('then canDelete should be false', () => {
      const results: DashboardSection[] = [
        {
          id: 1,
          checked: true,
          items: [
            {
              id: 11,
              checked: true,
              title: 'Eleven',
              type: DashboardSearchItemType.DashDB,
              url: '/',
              isStarred: false,
              tags: [],
              uri: '',
            },
          ],
          title: 'One',
          type: DashboardSearchItemType.DashFolder,
          toggle,
          url: '/',
        },
        {
          id: GENERAL_FOLDER_ID,
          checked: true,
          items: [
            {
              id: 10,
              checked: true,
              title: 'Ten',
              type: DashboardSearchItemType.DashDB,
              url: '/',
              isStarred: false,
              tags: [],
              uri: '',
            },
          ],
          title: 'General',
          type: DashboardSearchItemType.DashFolder,
          toggle,
          url: '/',
        },
        { id: 2, checked: false, items: [], title: 'Two', type: DashboardSearchItemType.DashFolder, toggle, url: '/' },
      ];

      const { result } = setupTestContext({ results });

      expect(result.current.canDelete).toBe(false);
    });
  });

  describe('when called on an empty General folder that is not selected but another folder is selected', () => {
    it('then canDelete should be true', () => {
      const results: DashboardSection[] = [
        {
          id: 1,
          checked: true,
          items: [
            {
              id: 11,
              checked: true,
              title: 'Eleven',
              type: DashboardSearchItemType.DashDB,
              url: '/',
              isStarred: false,
              tags: [],
              uri: '',
            },
          ],
          title: 'One',
          type: DashboardSearchItemType.DashFolder,
          toggle,
          url: '/',
        },
        {
          id: GENERAL_FOLDER_ID,
          checked: false,
          items: [],
          title: 'General',
          type: DashboardSearchItemType.DashFolder,
          toggle,
          url: '/',
        },
        { id: 2, checked: false, items: [], title: 'Two', type: DashboardSearchItemType.DashFolder, toggle, url: '/' },
      ];

      const { result } = setupTestContext({ results });

      expect(result.current.canDelete).toBe(true);
    });
  });

  describe('when called on a non empty General folder that is not selected dashboard in General folder is selected', () => {
    it('then canDelete should be true', () => {
      const results: DashboardSection[] = [
        {
          id: GENERAL_FOLDER_ID,
          checked: false,
          items: [
            {
              id: 10,
              checked: true,
              title: 'Ten',
              type: DashboardSearchItemType.DashDB,
              url: '/',
              isStarred: false,
              tags: [],
              uri: '',
            },
          ],
          title: 'General',
          type: DashboardSearchItemType.DashFolder,
          toggle,
          url: '/',
        },
      ];

      const { result } = setupTestContext({ results });

      expect(result.current.canDelete).toBe(true);
    });
  });

  describe('when called and no folder is selected', () => {
    it('then canDelete should be false', () => {
      const results: DashboardSection[] = [
        { id: 1, checked: false, items: [], title: 'One', type: DashboardSearchItemType.DashFolder, toggle, url: '/' },
        {
          id: GENERAL_FOLDER_ID,
          checked: false,
          items: [],
          title: 'General',
          type: DashboardSearchItemType.DashFolder,
          toggle,
          url: '/',
        },
        { id: 2, checked: false, items: [], title: 'Two', type: DashboardSearchItemType.DashFolder, toggle, url: '/' },
      ];

      const { result } = setupTestContext({ results });

      expect(result.current.canDelete).toBe(false);
    });
  });

  describe('when called on an empty folder', () => {
    it('then canDelete should be true', () => {
      const results: DashboardSection[] = [
        { id: 1, checked: true, items: [], title: 'One', type: DashboardSearchItemType.DashFolder, toggle, url: '/' },
        {
          id: GENERAL_FOLDER_ID,
          checked: false,
          items: [],
          title: 'General',
          type: DashboardSearchItemType.DashFolder,
          toggle,
          url: '/',
        },
        { id: 2, checked: false, items: [], title: 'Two', type: DashboardSearchItemType.DashFolder, toggle, url: '/' },
      ];

      const { result } = setupTestContext({ results });

      expect(result.current.canDelete).toBe(true);
    });
  });
});