@simplens/onboard 1.0.1 → 1.0.3

package/src/__tests__/errors.test.ts

@@ -1,187 +1,187 @@
-import { describe, it, expect } from 'vitest';
-import {
-    OnboardingError,
-    DockerNotInstalledError,
-    DockerNotRunningError,
-    DockerPermissionError,
-    DockerComposeError,
-    FileSystemError,
-    DirectoryNotWritableError,
-    isOnboardingError,
-    formatErrorForUser,
-} from '../types/errors.js';
-
-describe('error types', () => {
-    describe('OnboardingError', () => {
-        it('should create error with code and message', () => {
-            const error = new OnboardingError('TEST_CODE', 'Test message');
-
-            expect(error.code).toBe('TEST_CODE');
-            expect(error.message).toBe('Test message');
-            expect(error.name).toBe('OnboardingError');
-        });
-
-        it('should include troubleshooting when provided', () => {
-            const error = new OnboardingError(
-                'TEST_CODE',
-                'Test message',
-                'Try this fix'
-            );
-
-            expect(error.troubleshooting).toBe('Try this fix');
-        });
-
-        it('should have proper stack trace', () => {
-            const error = new OnboardingError('TEST', 'message');
-
-            expect(error.stack).toBeDefined();
-            expect(error.stack).toContain('OnboardingError');
-        });
-    });
-
-    describe('DockerNotInstalledError', () => {
-        it('should have correct message and troubleshooting', () => {
-            const error = new DockerNotInstalledError();
-
-            expect(error.message).toContain('not installed');
-            expect(error.troubleshooting).toContain('https://docs.docker.com/get-docker/');
-            expect(error.name).toBe('DockerNotInstalledError');
-        });
-    });
-
-    describe('DockerNotRunningError', () => {
-        it('should have correct message and troubleshooting', () => {
-            const error = new DockerNotRunningError();
-
-            expect(error.message).toContain('not running');
-            expect(error.troubleshooting).toContain('Docker daemon');
-            expect(error.name).toBe('DockerNotRunningError');
-        });
-    });
-
-    describe('DockerPermissionError', () => {
-        it('should have correct message and troubleshooting', () => {
-            const error = new DockerPermissionError();
-
-            expect(error.message).toContain('Permission denied');
-            expect(error.troubleshooting).toContain('usermod');
-            expect(error.name).toBe('DockerPermissionError');
-        });
-    });
-
-    describe('DockerComposeError', () => {
-        it('should include operation in message', () => {
-            const error = new DockerComposeError('start services');
-
-            expect(error.message).toContain('start services');
-            expect(error.name).toBe('DockerComposeError');
-        });
-
-        it('should use custom troubleshooting when provided', () => {
-            const error = new DockerComposeError('pull images', 'Check network connection');
-
-            expect(error.troubleshooting).toBe('Check network connection');
-        });
-
-        it('should have default troubleshooting', () => {
-            const error = new DockerComposeError('operation');
-
-            expect(error.troubleshooting).toContain('docker-compose logs');
-        });
-    });
-
-    describe('FileSystemError', () => {
-        it('should include path in error', () => {
-            const error = new FileSystemError(
-                'Cannot write',
-                '/path/to/file',
-                'Check permissions'
-            );
-
-            expect(error.path).toBe('/path/to/file');
-            expect(error.troubleshooting).toBe('Check permissions');
-        });
-    });
-
-    describe('DirectoryNotWritableError', () => {
-        it('should include path in message and error', () => {
-            const error = new DirectoryNotWritableError('/opt/app');
-
-            expect(error.message).toContain('/opt/app');
-            expect(error.path).toBe('/opt/app');
-            expect(error.troubleshooting).toContain('permissions');
-        });
-    });
-
-    describe('isOnboardingError', () => {
-        it('should return true for OnboardingError instances', () => {
-            const error = new OnboardingError('CODE', 'message');
-
-            expect(isOnboardingError(error)).toBe(true);
-        });
-
-        it('should return true for subclasses of OnboardingError', () => {
-            const error = new DockerNotInstalledError();
-
-            expect(isOnboardingError(error)).toBe(true);
-        });
-
-        it('should return false for regular Error', () => {
-            const error = new Error('regular error');
-
-            expect(isOnboardingError(error)).toBe(false);
-        });
-
-        it('should return false for non-error values', () => {
-            expect(isOnboardingError('string')).toBe(false);
-            expect(isOnboardingError(null)).toBe(false);
-            expect(isOnboardingError(undefined)).toBe(false);
-            expect(isOnboardingError({})).toBe(false);
-        });
-    });
-
-    describe('formatErrorForUser', () => {
-        it('should format OnboardingError with troubleshooting', () => {
-            const error = new OnboardingError(
-                'TEST',
-                'Something went wrong',
-                'Try this fix'
-            );
-
-            const formatted = formatErrorForUser(error);
-
-            expect(formatted).toContain('❌ Something went wrong');
-            expect(formatted).toContain('💡 Troubleshooting:');
-            expect(formatted).toContain('Try this fix');
-        });
-
-        it('should format OnboardingError without troubleshooting', () => {
-            const error = new OnboardingError('TEST', 'Something went wrong');
-
-            const formatted = formatErrorForUser(error);
-
-            expect(formatted).toBe('❌ Something went wrong');
-            expect(formatted).not.toContain('Troubleshooting');
-        });
-
-        it('should format regular Error', () => {
-            const error = new Error('Regular error message');
-
-            const formatted = formatErrorForUser(error);
-
-            expect(formatted).toContain('Unexpected error');
-            expect(formatted).toContain('Regular error message');
-        });
-
-        it('should handle non-Error values', () => {
-            const formatted = formatErrorForUser('some string');
-
-            expect(formatted).toBe('❌ An unknown error occurred');
-        });
-
-        it('should handle null/undefined', () => {
-            expect(formatErrorForUser(null)).toBe('❌ An unknown error occurred');
-            expect(formatErrorForUser(undefined)).toBe('❌ An unknown error occurred');
-        });
-    });
-});
+import { describe, it, expect } from 'vitest';
+import {
+    OnboardingError,
+    DockerNotInstalledError,
+    DockerNotRunningError,
+    DockerPermissionError,
+    DockerComposeError,
+    FileSystemError,
+    DirectoryNotWritableError,
+    isOnboardingError,
+    formatErrorForUser,
+} from '../types/errors.js';
+
+describe('error types', () => {
+    describe('OnboardingError', () => {
+        it('should create error with code and message', () => {
+            const error = new OnboardingError('TEST_CODE', 'Test message');
+
+            expect(error.code).toBe('TEST_CODE');
+            expect(error.message).toBe('Test message');
+            expect(error.name).toBe('OnboardingError');
+        });
+
+        it('should include troubleshooting when provided', () => {
+            const error = new OnboardingError(
+                'TEST_CODE',
+                'Test message',
+                'Try this fix'
+            );
+
+            expect(error.troubleshooting).toBe('Try this fix');
+        });
+
+        it('should have proper stack trace', () => {
+            const error = new OnboardingError('TEST', 'message');
+
+            expect(error.stack).toBeDefined();
+            expect(error.stack).toContain('OnboardingError');
+        });
+    });
+
+    describe('DockerNotInstalledError', () => {
+        it('should have correct message and troubleshooting', () => {
+            const error = new DockerNotInstalledError();
+
+            expect(error.message).toContain('not installed');
+            expect(error.troubleshooting).toContain('https://docs.docker.com/get-docker/');
+            expect(error.name).toBe('DockerNotInstalledError');
+        });
+    });
+
+    describe('DockerNotRunningError', () => {
+        it('should have correct message and troubleshooting', () => {
+            const error = new DockerNotRunningError();
+
+            expect(error.message).toContain('not running');
+            expect(error.troubleshooting).toContain('Docker daemon');
+            expect(error.name).toBe('DockerNotRunningError');
+        });
+    });
+
+    describe('DockerPermissionError', () => {
+        it('should have correct message and troubleshooting', () => {
+            const error = new DockerPermissionError();
+
+            expect(error.message).toContain('Permission denied');
+            expect(error.troubleshooting).toContain('usermod');
+            expect(error.name).toBe('DockerPermissionError');
+        });
+    });
+
+    describe('DockerComposeError', () => {
+        it('should include operation in message', () => {
+            const error = new DockerComposeError('start services');
+
+            expect(error.message).toContain('start services');
+            expect(error.name).toBe('DockerComposeError');
+        });
+
+        it('should use custom troubleshooting when provided', () => {
+            const error = new DockerComposeError('pull images', 'Check network connection');
+
+            expect(error.troubleshooting).toBe('Check network connection');
+        });
+
+        it('should have default troubleshooting', () => {
+            const error = new DockerComposeError('operation');
+
+            expect(error.troubleshooting).toContain('docker-compose logs');
+        });
+    });
+
+    describe('FileSystemError', () => {
+        it('should include path in error', () => {
+            const error = new FileSystemError(
+                'Cannot write',
+                '/path/to/file',
+                'Check permissions'
+            );
+
+            expect(error.path).toBe('/path/to/file');
+            expect(error.troubleshooting).toBe('Check permissions');
+        });
+    });
+
+    describe('DirectoryNotWritableError', () => {
+        it('should include path in message and error', () => {
+            const error = new DirectoryNotWritableError('/opt/app');
+
+            expect(error.message).toContain('/opt/app');
+            expect(error.path).toBe('/opt/app');
+            expect(error.troubleshooting).toContain('permissions');
+        });
+    });
+
+    describe('isOnboardingError', () => {
+        it('should return true for OnboardingError instances', () => {
+            const error = new OnboardingError('CODE', 'message');
+
+            expect(isOnboardingError(error)).toBe(true);
+        });
+
+        it('should return true for subclasses of OnboardingError', () => {
+            const error = new DockerNotInstalledError();
+
+            expect(isOnboardingError(error)).toBe(true);
+        });
+
+        it('should return false for regular Error', () => {
+            const error = new Error('regular error');
+
+            expect(isOnboardingError(error)).toBe(false);
+        });
+
+        it('should return false for non-error values', () => {
+            expect(isOnboardingError('string')).toBe(false);
+            expect(isOnboardingError(null)).toBe(false);
+            expect(isOnboardingError(undefined)).toBe(false);
+            expect(isOnboardingError({})).toBe(false);
+        });
+    });
+
+    describe('formatErrorForUser', () => {
+        it('should format OnboardingError with troubleshooting', () => {
+            const error = new OnboardingError(
+                'TEST',
+                'Something went wrong',
+                'Try this fix'
+            );
+
+            const formatted = formatErrorForUser(error);
+
+            expect(formatted).toContain('❌ Something went wrong');
+            expect(formatted).toContain('💡 Troubleshooting:');
+            expect(formatted).toContain('Try this fix');
+        });
+
+        it('should format OnboardingError without troubleshooting', () => {
+            const error = new OnboardingError('TEST', 'Something went wrong');
+
+            const formatted = formatErrorForUser(error);
+
+            expect(formatted).toBe('❌ Something went wrong');
+            expect(formatted).not.toContain('Troubleshooting');
+        });
+
+        it('should format regular Error', () => {
+            const error = new Error('Regular error message');
+
+            const formatted = formatErrorForUser(error);
+
+            expect(formatted).toContain('Unexpected error');
+            expect(formatted).toContain('Regular error message');
+        });
+
+        it('should handle non-Error values', () => {
+            const formatted = formatErrorForUser('some string');
+
+            expect(formatted).toBe('❌ An unknown error occurred');
+        });
+
+        it('should handle null/undefined', () => {
+            expect(formatErrorForUser(null)).toBe('❌ An unknown error occurred');
+            expect(formatErrorForUser(undefined)).toBe('❌ An unknown error occurred');
+        });
+    });
+});

package/src/__tests__/infra-prompts.test.ts

@@ -0,0 +1,54 @@
+import { describe, it, expect, vi, beforeEach } from 'vitest';
+
+// Mock @clack/prompts
+vi.mock('@clack/prompts', () => ({
+    multiselect: vi.fn(),
+    spinner: vi.fn(() => ({
+        start: vi.fn(),
+        stop: vi.fn(),
+        error: vi.fn(),
+        message: vi.fn(),
+    })),
+}));
+
+// Mock the ui.js module
+vi.mock('../ui.js', () => ({
+    handleCancel: vi.fn(),
+}));
+
+import { multiselect } from '@clack/prompts';
+import { promptInfraServicesWithBasePath } from '../infra.js';
+
+describe('promptInfraServicesWithBasePath', () => {
+    beforeEach(() => {
+        vi.clearAllMocks();
+    });
+
+    it('includes nginx when allowNginx is true', async () => {
+        const mockMultiselect = vi.mocked(multiselect);
+        mockMultiselect.mockResolvedValue(['mongo', 'redis', 'nginx']);
+
+        const result = await promptInfraServicesWithBasePath({ allowNginx: true });
+
+        // Should include nginx in options
+        const callArgs = mockMultiselect.mock.calls[0][0] as any;
+        const values = callArgs.options.map((o: any) => o.value);
+        expect(values).toContain('nginx');
+
+        expect(result).toContain('nginx');
+    });
+
+    it('excludes nginx when allowNginx is false', async () => {
+        const mockMultiselect = vi.mocked(multiselect);
+        mockMultiselect.mockResolvedValue(['mongo', 'redis']);
+
+        const result = await promptInfraServicesWithBasePath({ allowNginx: false });
+
+        // Should NOT include nginx in options
+        const callArgs = mockMultiselect.mock.calls[0][0] as any;
+        const values = callArgs.options.map((o: any) => o.value);
+        expect(values).not.toContain('nginx');
+
+        expect(result).not.toContain('nginx');
+    });
+});

package/src/__tests__/infra.test.ts

@@ -0,0 +1,15 @@
+import { describe, expect, it } from 'vitest';
+import { buildAppComposeContent } from '../infra.js';
+
+describe('infra app compose generation', () => {
+    it('does not include nginx when disabled', () => {
+        const compose = buildAppComposeContent(false);
+        expect(compose).not.toContain('  nginx:');
+    });
+
+    it('includes nginx service when enabled', () => {
+        const compose = buildAppComposeContent(true);
+        expect(compose).toContain('  nginx:');
+        expect(compose).toContain('./nginx.conf:/etc/nginx/conf.d/default.conf:ro');
+    });
+});