Files
api/api/src/unraid-api/cli/__test__/developer.command.test.ts
Eli Bosley 3b00fec5fd chore: Remove legacy store modules and add new API key and reporting services (#1536)
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
* Added developer CLI tools for toggling GraphQL sandbox and modal
testing utilities.
* Introduced a "Show Activation Modal" developer component for UI
testing.
  * Added system initial setup detection and related GraphQL queries.
* Enhanced login and welcome pages with dynamic server info and initial
setup state.
  * Improved SSO button with internationalization and error handling.
* Added internal CLI admin API key management service and internal
GraphQL client service.
* Introduced comprehensive API report generation service for system and
service status.
* Added CLI commands and GraphQL mutations/queries for plugin and SSO
user management.
* Added new modal target components and improved teleport target
detection.

* **Enhancements**
* Refined modal dialog targeting and teleportation for flexible UI
placement.
* Updated modal components and stores for improved activation/welcome
modal control.
  * Improved plugin and SSO user management via CLI through GraphQL API.
* Refactored partner logo components to use props instead of store
dependencies.
  * Enhanced styling and accessibility for buttons and modals.
* Streamlined Tailwind CSS integration with shared styles and updated
theme variables.
* Improved GraphQL module configuration to avoid directive conflicts in
tests.
  * Adjusted Vite config for better dependency handling in test mode.
  * Improved error handling and logging in CLI commands and services.
* Reordered imports and refined component class bindings for UI
consistency.

* **Bug Fixes**
* Resolved issues with duplicate script tags and component registration
in the web UI.
* Fixed modal close button visibility and activation modal state
handling.
* Added error handling and logging improvements across CLI commands and
services.
  * Fixed newline issues in last-download-time fixture files.

* **Chores**
* Added and updated numerous tests for CLI commands, services, and UI
components.
* Updated translation files and localization resources for new UI
messages.
* Adjusted environment, configuration, and dependency files for improved
development and test workflows.
  * Cleaned up unused imports and mocks in tests.
  * Reorganized exports and barrel files in shared and UI modules.
  * Added integration and dependency resolution tests for core modules.

* **Removals & Refactoring**
* Removed legacy Redux state management, configuration, and UPnP logic
from the backend.
* Eliminated deprecated GraphQL subscriptions and client code related to
registration and mothership.
* Removed direct store manipulation and replaced with service-based
approaches in CLI commands.
  * Deleted unused or redundant test files and configuration listeners.
* Refactored SSO user service to consolidate add/remove operations into
a single update method.
* Simplified API key services with new methods for automatic key
management.
* Replaced direct plugin and SSO user service calls with GraphQL client
interactions in CLI commands.
* Removed complex theme fallback and dark mode CSS rules, replacing with
streamlined static theme variables.
* Cleaned up Tailwind CSS configuration and removed deprecated local
styles.
* Removed multiple internal utility files and replaced with simplified
or centralized implementations.
* Removed deprecated local configuration and synchronization files and
listeners.
  * Removed UPnP helper functions and job management classes.
* Refactored server resolver to dynamically construct local server data
internally.
* Removed CORS handler and replaced with simplified or externalized
logic.
* Removed store synchronization and registration event pubsub handling.
* Removed GraphQL client creation utilities for internal API
communication.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-07-25 15:07:37 -04:00

120 lines
4.2 KiB
TypeScript

import { Test, TestingModule } from '@nestjs/testing';
import { InquirerService } from 'nest-commander';
import { beforeEach, describe, expect, it, vi } from 'vitest';
import { DeveloperToolsService } from '@app/unraid-api/cli/developer/developer-tools.service.js';
import { DeveloperCommand } from '@app/unraid-api/cli/developer/developer.command.js';
import { LogService } from '@app/unraid-api/cli/log.service.js';
describe('DeveloperCommand', () => {
let module: TestingModule;
let command: DeveloperCommand;
let developerToolsService: DeveloperToolsService;
let logService: LogService;
let inquirerService: InquirerService;
beforeEach(async () => {
module = await Test.createTestingModule({
providers: [
DeveloperCommand,
{
provide: DeveloperToolsService,
useValue: {
setSandboxMode: vi.fn(),
enableModalTest: vi.fn(),
disableModalTest: vi.fn(),
getModalTestStatus: vi.fn().mockResolvedValue({ enabled: false }),
getModalTestingGuide: vi.fn().mockReturnValue(['test guide']),
},
},
{
provide: LogService,
useValue: {
info: vi.fn(),
error: vi.fn(),
warn: vi.fn(),
},
},
{
provide: InquirerService,
useValue: {
prompt: vi.fn(),
},
},
],
}).compile();
command = module.get<DeveloperCommand>(DeveloperCommand);
developerToolsService = module.get<DeveloperToolsService>(DeveloperToolsService);
logService = module.get<LogService>(LogService);
inquirerService = module.get<InquirerService>(InquirerService);
});
it('should handle sandbox option directly', async () => {
await command.run([], { sandbox: true });
expect(developerToolsService.setSandboxMode).toHaveBeenCalledWith(true);
});
it('should handle enable-modal option directly', async () => {
await command.run([], { 'enable-modal': true });
expect(developerToolsService.enableModalTest).toHaveBeenCalled();
expect(logService.info).toHaveBeenCalledWith('test guide');
});
it('should handle disable-modal option directly', async () => {
await command.run([], { 'disable-modal': true });
expect(developerToolsService.disableModalTest).toHaveBeenCalled();
});
it('should show modal test status', async () => {
vi.mocked(inquirerService.prompt).mockResolvedValue({
tool: 'modal-test',
modalAction: 'status',
});
await command.run([], {});
expect(developerToolsService.getModalTestStatus).toHaveBeenCalled();
expect(logService.info).toHaveBeenCalledWith('Modal Test Tool Status');
});
it('should handle sandbox selection in interactive mode', async () => {
vi.mocked(inquirerService.prompt).mockResolvedValue({
tool: 'sandbox',
sandboxEnabled: true,
});
await command.run([], {});
expect(developerToolsService.setSandboxMode).toHaveBeenCalledWith(true);
});
it('should handle modal test enable in interactive mode', async () => {
vi.mocked(inquirerService.prompt).mockResolvedValue({
tool: 'modal-test',
modalAction: 'enable',
});
await command.run([], {});
expect(developerToolsService.enableModalTest).toHaveBeenCalled();
});
it('should handle errors gracefully', async () => {
const mockExit = vi.spyOn(process, 'exit').mockImplementation(() => {
throw new Error('process.exit called');
});
vi.mocked(developerToolsService.setSandboxMode).mockRejectedValue(new Error('Test error'));
await expect(command.run([], { sandbox: true })).rejects.toThrow('process.exit called');
expect(mockExit).toHaveBeenCalledWith(1);
mockExit.mockRestore();
});
});