grafana/public/app/features/dashboard/api/v2.test.ts

import { DashboardV2Spec, defaultDashboardV2Spec } from '@grafana/schema/dist/esm/schema/dashboard/v2alpha0';
import { backendSrv } from 'app/core/services/backend_srv';
import {
  AnnoKeyFolder,
  AnnoKeyFolderId,
  AnnoKeyFolderTitle,
  AnnoKeyFolderUrl,
  DeprecatedInternalId,
} from 'app/features/apiserver/types';

import { DashboardWithAccessInfo } from './types';
import { K8sDashboardV2API } from './v2';

const mockDashboardDto: DashboardWithAccessInfo<DashboardV2Spec> = {
  kind: 'DashboardWithAccessInfo',
  apiVersion: 'v0alpha1',

  metadata: {
    name: 'dash-uid',
    resourceVersion: '1',
    creationTimestamp: '1',
    annotations: {
      [AnnoKeyFolder]: 'new-folder',
    },
  },
  spec: {
    ...defaultDashboardV2Spec(),
  },
  access: {},
};

// Create a mock put function that we can spy on
const mockPut = jest.fn().mockImplementation((url, data) => {
  return {
    apiVersion: 'dashboard.grafana.app/v2alpha1',
    kind: 'Dashboard',
    metadata: {
      name: data.metadata?.name,
      resourceVersion: '2',
      creationTimestamp: new Date().toISOString(),
      labels: data.metadata?.labels,
      annotations: data.metadata?.annotations,
    },
    spec: data.spec,
  };
});

jest.mock('@grafana/runtime', () => ({
  ...jest.requireActual('@grafana/runtime'),
  getBackendSrv: () => ({
    get: () => mockDashboardDto,
    put: mockPut,
  }),
  config: {
    ...jest.requireActual('@grafana/runtime').config,
  },
}));

jest.mock('app/features/live/dashboard/dashboardWatcher', () => ({
  ignoreNextSave: jest.fn(),
}));

describe('v2 dashboard API', () => {
  beforeEach(() => {
    jest.clearAllMocks();
  });

  it('should provide folder annotations', async () => {
    jest.spyOn(backendSrv, 'getFolderByUid').mockResolvedValue({
      id: 1,
      uid: 'new-folder',
      title: 'New Folder',
      url: '/folder/url',
      canAdmin: true,
      canDelete: true,
      canEdit: true,
      canSave: true,
      created: '',
      createdBy: '',
      hasAcl: false,
      updated: '',
      updatedBy: '',
    });

    const api = new K8sDashboardV2API(false);
    // because the API can currently return both DashboardDTO and DashboardWithAccessInfo<DashboardV2Spec> based on the
    // parameter convertToV1, we need to cast the result to DashboardWithAccessInfo<DashboardV2Spec> to be able to
    // access
    const result = (await api.getDashboardDTO('test')) as DashboardWithAccessInfo<DashboardV2Spec>;
    expect(result.metadata.annotations![AnnoKeyFolderId]).toBe(1);
    expect(result.metadata.annotations![AnnoKeyFolderTitle]).toBe('New Folder');
    expect(result.metadata.annotations![AnnoKeyFolderUrl]).toBe('/folder/url');
    expect(result.metadata.annotations![AnnoKeyFolder]).toBe('new-folder');
  });

  it('throws an error if folder is not found', async () => {
    jest.spyOn(backendSrv, 'getFolderByUid').mockRejectedValue({ message: 'folder not found', status: 'not-found' });

    const api = new K8sDashboardV2API(false);
    await expect(api.getDashboardDTO('test')).rejects.toThrow('Failed to load folder');
  });
});

describe('v2 dashboard API - Save', () => {
  beforeEach(() => {
    jest.clearAllMocks();
  });

  const defaultSaveCommand = {
    dashboard: defaultDashboardV2Spec(),
    message: 'test save',
    folderUid: 'test-folder',
    k8s: {
      name: 'test-dash',
      labels: {
        [DeprecatedInternalId]: 123,
      },

      annotations: {
        [AnnoKeyFolder]: 'new-folder',
      },
    },
  };

  it('should create new dashboard', async () => {
    const api = new K8sDashboardV2API(false);
    const result = await api.saveDashboard({
      ...defaultSaveCommand,
      dashboard: {
        ...defaultSaveCommand.dashboard,
        title: 'test-dashboard',
      },
    });

    expect(result).toEqual({
      id: 123,
      uid: 'test-dash',
      url: '/d/test-dash/testdashboard',
      slug: '',
      status: 'success',
      version: 2,
    });
  });

  it('should update existing dashboard', async () => {
    const api = new K8sDashboardV2API(false);

    const result = await api.saveDashboard({
      ...defaultSaveCommand,
      dashboard: {
        ...defaultSaveCommand.dashboard,
        title: 'chaing-title-dashboard',
      },
      k8s: {
        ...defaultSaveCommand.k8s,
        name: 'existing-dash',
      },
    });
    expect(result.version).toBe(2);
  });

  it('should update existing dashboard that is store in a folder', async () => {
    const api = new K8sDashboardV2API(false);
    await api.saveDashboard({
      dashboard: {
        ...defaultSaveCommand.dashboard,
        title: 'chaing-title-dashboard',
      },
      folderUid: 'folderUidXyz',
      k8s: {
        name: 'existing-dash',
        annotations: {
          [AnnoKeyFolder]: 'folderUidXyz',
          [AnnoKeyFolderUrl]: 'url folder used in the client',
          [AnnoKeyFolderId]: 42,
          [AnnoKeyFolderTitle]: 'title folder used in the client',
        },
      },
    });
    expect(mockPut).toHaveBeenCalledTimes(1);
    expect(mockPut).toHaveBeenCalledWith(
      '/apis/dashboard.grafana.app/v2alpha1/namespaces/default/dashboards/existing-dash',
      {
        metadata: {
          name: 'existing-dash',
          annotations: {
            [AnnoKeyFolder]: 'folderUidXyz',
          },
        },
        spec: {
          ...defaultSaveCommand.dashboard,
          title: 'chaing-title-dashboard',
        },
      }
    );
  });
});