Files
api/web/__test__/components/UserProfile.test.ts

413 lines
13 KiB
TypeScript

import { ref } from 'vue';
import { setActivePinia } from 'pinia';
import { provideApolloClient } from '@vue/apollo-composable';
import { mount } from '@vue/test-utils';
import { ApolloClient, InMemoryCache } from '@apollo/client/core';
import { createTestingPinia } from '@pinia/testing';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import type { VueWrapper } from '@vue/test-utils';
import type { Server, ServerconnectPluginInstalled, ServerState } from '~/types/server';
import type { Pinia } from 'pinia';
import UserProfile from '~/components/UserProfile.standalone.vue';
import { useServerStore } from '~/store/server';
import { useThemeStore } from '~/store/theme';
const mockCopy = vi.fn();
const mockCopied = ref(false);
const mockIsSupported = ref(true);
vi.mock('@vueuse/core', () => ({
useClipboard: () => {
const actualCopy = (text: string) => {
if (mockIsSupported.value) {
mockCopy(text);
mockCopied.value = true;
} else {
mockCopied.value = false;
}
};
return {
copy: actualCopy,
copied: mockCopied,
isSupported: mockIsSupported,
};
},
useLocalStorage: <T>(key: string, initialValue: T) => {
const storage = new Map<string, T>();
if (!storage.has(key)) {
storage.set(key, initialValue);
}
return ref(storage.get(key) ?? initialValue);
},
createSharedComposable: (fn: unknown) => fn,
}));
vi.mock('@unraid/ui', () => ({
DropdownMenu: {
template: '<div data-testid="dropdown-menu"><slot name="trigger" /><slot /></div>',
},
Button: {
template: '<button><slot /></button>',
props: ['variant', 'size'],
},
cn: (...classes: string[]) => classes.filter(Boolean).join(' '),
isDarkModeActive: vi.fn(() => {
if (typeof document === 'undefined') return false;
const cssVar = getComputedStyle(document.documentElement)
.getPropertyValue('--theme-dark-mode')
.trim();
if (cssVar === '1') return true;
if (cssVar === '0') return false;
if (document.documentElement.classList.contains('dark')) return true;
if (document.body?.classList.contains('dark')) return true;
if (document.querySelector('.unapi.dark')) return true;
return false;
}),
}));
const mockWatcher = vi.fn();
vi.mock('~/store/callbackActions', () => ({
useCallbackActionsStore: vi.fn(() => ({
watcher: mockWatcher,
callbackData: ref(null),
})),
}));
const t = (key: string, args?: unknown[]) => (args ? `${key} ${JSON.stringify(args)}` : key);
vi.mock('vue-i18n', () => ({
useI18n: () => ({ t }),
}));
// Test Data
const initialServerData: Server = {
name: 'TestServer',
description: 'Test Description',
guid: 'TEST-GUID',
keyfile: 'keyfile.key',
lanIp: '192.168.1.100',
connectPluginInstalled: 'dynamix.unraid.net.plg' as ServerconnectPluginInstalled,
state: 'PRO' as ServerState,
dateTimeFormat: { date: 'YYYY-MM-DD', time: 'HH:mm' },
deviceCount: 5,
flashProduct: 'TestFlash',
flashVendor: 'TestVendor',
regGuid: 'REG-GUID',
regTm: 1678886400,
regTo: 'Test User',
regTy: 'Pro',
regExp: undefined,
regUpdatesExpired: false,
registered: true,
wanIp: '8.8.8.8',
};
// Component stubs for mount options
const stubs = {
UpcUptimeExpire: { template: '<div data-testid="uptime-expire"></div>' },
UpcServerState: { template: '<div data-testid="server-state"></div>' },
UpcServerStatus: {
template: '<div><div data-testid="uptime-expire"></div><div data-testid="server-state"></div></div>',
props: ['class'],
},
NotificationsSidebar: { template: '<div data-testid="notifications-sidebar"></div>' },
DropdownMenu: {
template: '<div data-testid="dropdown-menu"><slot name="trigger" /><slot name="content" /></div>',
},
UpcDropdownContent: { template: '<div data-testid="dropdown-content"></div>' },
UpcDropdownTrigger: { template: '<button data-testid="dropdown-trigger"></button>' },
};
describe('UserProfile.standalone.vue', () => {
let wrapper: VueWrapper<InstanceType<typeof UserProfile>>;
let pinia: Pinia;
let serverStore: ReturnType<typeof useServerStore>;
let themeStore: ReturnType<typeof useThemeStore>;
let consoleSpies: Array<ReturnType<typeof vi.spyOn>> = [];
beforeEach(() => {
// Mock window.location for server store
Object.defineProperty(window, 'location', {
value: {
hostname: 'localhost',
port: '3000',
pathname: '/',
protocol: 'http:',
href: 'http://localhost:3000/',
},
writable: true,
configurable: true,
});
// Create a mock Apollo Client
const mockApolloClient = new ApolloClient({
cache: new InMemoryCache(),
defaultOptions: {
query: {
fetchPolicy: 'no-cache',
},
watchQuery: {
fetchPolicy: 'no-cache',
},
},
});
// Provide the Apollo client globally
provideApolloClient(mockApolloClient);
// Suppress all console outputs
consoleSpies = [
vi.spyOn(console, 'log').mockImplementation(() => {}),
vi.spyOn(console, 'warn').mockImplementation(() => {}),
vi.spyOn(console, 'debug').mockImplementation(() => {}),
vi.spyOn(console, 'info').mockImplementation(() => {}),
vi.spyOn(console, 'error').mockImplementation(() => {}),
];
// Reset refs used by mocks
mockCopied.value = false;
mockIsSupported.value = true;
// Define simple mock Event objects instead of classes with only constructors
const MockEvent = vi.fn();
const MockMouseEvent = vi.fn();
// Set up window mocks
vi.stubGlobal('window', {
...global.window,
location: {
...global.window.location,
protocol: 'https:',
},
document: {
...global.window.document,
cookie: '',
},
Event: typeof global.window.Event === 'function' ? global.window.Event : MockEvent,
MouseEvent:
typeof global.window.MouseEvent === 'function' ? global.window.MouseEvent : MockMouseEvent,
});
pinia = createTestingPinia({
createSpy: vi.fn,
initialState: {
server: { ...initialServerData },
},
stubActions: false,
});
setActivePinia(pinia);
serverStore = useServerStore();
// Set CSS variables directly on document element for theme store
document.documentElement.style.setProperty('--theme-dark-mode', '0');
document.documentElement.style.setProperty(
'--banner-gradient',
'linear-gradient(90deg, rgba(0, 0, 0, 0) 0, rgba(0, 0, 0, 0.7) var(--banner-gradient-stop, 30%))'
);
themeStore = useThemeStore();
// Set the theme using setTheme method
themeStore.setTheme({
name: 'white',
banner: true,
bannerGradient: true,
descriptionShow: true,
textColor: '',
metaColor: '',
bgColor: '',
});
// Override the setServer method to prevent console logging
vi.spyOn(serverStore, 'setServer').mockImplementation((server) => {
Object.assign(serverStore, server);
return server;
});
vi.clearAllMocks();
// Mount the component
wrapper = mount(UserProfile, {
props: {
server: JSON.stringify(initialServerData),
},
global: {
plugins: [pinia],
stubs,
},
});
});
afterEach(() => {
wrapper?.unmount();
consoleSpies.forEach((spy) => spy.mockRestore());
vi.restoreAllMocks();
vi.unstubAllGlobals?.();
});
it('renders initial state correctly based on props and store', async () => {
expect(serverStore.description).toBe(initialServerData.description);
expect(themeStore.theme?.descriptionShow).toBe(true);
await wrapper.vm.$nextTick();
const nameButton = wrapper.find('button');
expect(nameButton.text()).toContain(initialServerData.name);
expect(wrapper.find('[data-testid="uptime-expire"]').exists()).toBe(true);
expect(wrapper.find('[data-testid="server-state"]').exists()).toBe(true);
expect(wrapper.find('[data-testid="notifications-sidebar"]').exists()).toBe(true);
expect(wrapper.find('[data-testid="dropdown-menu"]').exists()).toBe(true);
expect(wrapper.find('[data-testid="dropdown-trigger"]').exists()).toBe(true);
});
it('calls server store setServer and callback watcher on mount', () => {
expect(serverStore.setServer).toHaveBeenCalledTimes(1);
expect(serverStore.setServer).toHaveBeenCalledWith(JSON.parse(JSON.stringify(initialServerData)));
expect(mockWatcher).toHaveBeenCalledTimes(1);
});
it('handles server prop as object', () => {
const wrapperObjectProp = mount(UserProfile, {
props: {
server: initialServerData,
},
global: {
plugins: [pinia],
stubs,
},
});
expect(serverStore.setServer).toHaveBeenCalledTimes(2);
expect(serverStore.setServer).toHaveBeenLastCalledWith(initialServerData);
expect(wrapperObjectProp.find('button').text()).toContain(initialServerData.name);
wrapperObjectProp.unmount();
});
it('handles server prop not being present', () => {
const consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(() => {});
expect(() =>
mount(UserProfile, {
props: {},
global: {
plugins: [pinia],
stubs,
},
})
).toThrow('Server data not present');
consoleErrorSpy.mockRestore();
});
it('triggers clipboard copy when server name is clicked', async () => {
const copyLanIpSpy = vi.spyOn(wrapper.vm as unknown as { copyLanIp: () => void }, 'copyLanIp');
mockIsSupported.value = true;
const serverNameButton = wrapper.find('button');
await serverNameButton.trigger('click');
await wrapper.vm.$nextTick();
expect(copyLanIpSpy).toHaveBeenCalledTimes(1);
expect(mockCopy).toHaveBeenCalledTimes(1);
expect(mockCopy).toHaveBeenCalledWith(initialServerData.lanIp);
// We're not testing the toast message, just that the copy function was called
expect(mockCopied.value).toBe(true);
copyLanIpSpy.mockRestore();
});
it('shows copy not supported message correctly', async () => {
const copyLanIpSpy = vi.spyOn(wrapper.vm as unknown as { copyLanIp: () => void }, 'copyLanIp');
mockIsSupported.value = false;
const serverNameButton = wrapper.find('button');
await serverNameButton.trigger('click');
await wrapper.vm.$nextTick();
expect(copyLanIpSpy).toHaveBeenCalledTimes(1);
expect(mockCopy).not.toHaveBeenCalled();
// When clipboard is not supported, the copy function should not be called
expect(mockCopied.value).toBe(false);
copyLanIpSpy.mockRestore();
});
it('conditionally renders description based on theme store', async () => {
expect(serverStore.description).toBe(initialServerData.description);
expect(themeStore.theme?.descriptionShow).toBe(true);
serverStore.description = initialServerData.description!;
themeStore.setTheme({ ...themeStore.theme, descriptionShow: true });
await wrapper.vm.$nextTick();
// Look for the description in a span element with v-html directive
let descriptionElement = wrapper.find('span.hidden.text-center.text-base');
expect(descriptionElement.exists()).toBe(true);
expect(descriptionElement.html()).toContain(initialServerData.description);
themeStore.setTheme({ ...themeStore.theme, descriptionShow: false });
await wrapper.vm.$nextTick();
// When descriptionShow is false, the element should not exist
descriptionElement = wrapper.find('span.hidden.text-center.text-base');
expect(descriptionElement.exists()).toBe(false);
themeStore.setTheme({ ...themeStore.theme, descriptionShow: true });
await wrapper.vm.$nextTick();
descriptionElement = wrapper.find('span.hidden.text-center.text-base');
expect(descriptionElement.exists()).toBe(true);
expect(descriptionElement.html()).toContain(initialServerData.description);
});
it('always renders notifications sidebar, regardless of connectPluginInstalled', async () => {
expect(wrapper.find('[data-testid="notifications-sidebar"]').exists()).toBe(true);
serverStore.connectPluginInstalled = '';
await wrapper.vm.$nextTick();
expect(wrapper.find('[data-testid="notifications-sidebar"]').exists()).toBe(true);
});
it('conditionally renders banner based on theme store', async () => {
const bannerSelector = '.unraid-banner-gradient-layer';
themeStore.setTheme({
...themeStore.theme,
banner: true,
bannerGradient: true,
});
await wrapper.vm.$nextTick();
expect(themeStore.bannerGradient).toBe(true);
expect(wrapper.find(bannerSelector).exists()).toBe(true);
themeStore.setTheme({
...themeStore.theme,
bannerGradient: false,
});
await wrapper.vm.$nextTick();
expect(themeStore.bannerGradient).toBe(false);
expect(wrapper.find(bannerSelector).exists()).toBe(false);
themeStore.setTheme({
...themeStore.theme,
bannerGradient: true,
});
await wrapper.vm.$nextTick();
expect(themeStore.bannerGradient).toBe(true);
expect(wrapper.find(bannerSelector).exists()).toBe(true);
});
});