refactor: cli e2e (#7211)

e2e/src/cli/specs/login.e2e-spec.ts

@@ -0,0 +1,58 @@
+import { stat } from 'node:fs/promises';
+import { apiUtils, app, dbUtils, immichCli } from 'src/utils';
+import { beforeEach, beforeAll, describe, expect, it } from 'vitest';
+
+describe(`immich login-key`, () => {
+  beforeAll(() => {
+    apiUtils.setup();
+  });
+
+  beforeEach(async () => {
+    await dbUtils.reset();
+  });
+
+  it('should require a url', async () => {
+    const { stderr, exitCode } = await immichCli(['login-key']);
+    expect(stderr).toBe("error: missing required argument 'url'");
+    expect(exitCode).toBe(1);
+  });
+
+  it('should require a key', async () => {
+    const { stderr, exitCode } = await immichCli(['login-key', app]);
+    expect(stderr).toBe("error: missing required argument 'key'");
+    expect(exitCode).toBe(1);
+  });
+
+  it('should require a valid key', async () => {
+    const { stderr, exitCode } = await immichCli([
+      'login-key',
+      app,
+      'immich-is-so-cool',
+    ]);
+    expect(stderr).toContain(
+      'Failed to connect to server http://127.0.0.1:2283/api: Error: 401'
+    );
+    expect(exitCode).toBe(1);
+  });
+
+  it('should login', async () => {
+    const admin = await apiUtils.adminSetup();
+    const key = await apiUtils.createApiKey(admin.accessToken);
+    const { stdout, stderr, exitCode } = await immichCli([
+      'login-key',
+      app,
+      `${key.secret}`,
+    ]);
+    expect(stdout.split('\n')).toEqual([
+      'Logging in...',
+      'Logged in as admin@immich.cloud',
+      'Wrote auth info to /tmp/immich/auth.yml',
+    ]);
+    expect(stderr).toBe('');
+    expect(exitCode).toBe(0);
+
+    const stats = await stat('/tmp/immich/auth.yml');
+    const mode = (stats.mode & 0o777).toString(8);
+    expect(mode).toEqual('600');
+  });
+});

e2e/src/cli/specs/server-info.e2e-spec.ts

@@ -0,0 +1,28 @@
+import { apiUtils, cliUtils, dbUtils, immichCli } from 'src/utils';
+import { beforeAll, beforeEach, describe, expect, it } from 'vitest';
+
+describe(`immich server-info`, () => {
+  beforeAll(() => {
+    apiUtils.setup();
+  });
+
+  beforeEach(async () => {
+    await dbUtils.reset();
+    await cliUtils.login();
+  });
+
+  it('should return the server info', async () => {
+    const { stderr, stdout, exitCode } = await immichCli(['server-info']);
+    expect(stdout.split('\n')).toEqual([
+      expect.stringContaining('Server Version:'),
+      expect.stringContaining('Image Types:'),
+      expect.stringContaining('Video Types:'),
+      'Statistics:',
+      '  Images: 0',
+      '  Videos: 0',
+      '  Total: 0',
+    ]);
+    expect(stderr).toBe('');
+    expect(exitCode).toBe(0);
+  });
+});

e2e/src/cli/specs/upload.e2e-spec.ts

@@ -0,0 +1,127 @@
+import { getAllAlbums, getAllAssets } from '@immich/sdk';
+import {
+  apiUtils,
+  asKeyAuth,
+  cliUtils,
+  dbUtils,
+  immichCli,
+  testAssetDir,
+} from 'src/utils';
+import { beforeAll, beforeEach, describe, expect, it } from 'vitest';
+
+describe(`immich upload`, () => {
+  let key: string;
+
+  beforeAll(() => {
+    apiUtils.setup();
+  });
+
+  beforeEach(async () => {
+    await dbUtils.reset();
+    key = await cliUtils.login();
+  });
+
+  describe('immich upload --recursive', () => {
+    it('should upload a folder recursively', async () => {
+      const { stderr, stdout, exitCode } = await immichCli([
+        'upload',
+        `${testAssetDir}/albums/nature/`,
+        '--recursive',
+      ]);
+      expect(stderr).toBe('');
+      expect(stdout.split('\n')).toEqual([
+        expect.stringContaining('Successfully uploaded 9 assets'),
+      ]);
+      expect(exitCode).toBe(0);
+
+      const assets = await getAllAssets({}, { headers: asKeyAuth(key) });
+      expect(assets.length).toBe(9);
+    });
+  });
+
+  describe('immich upload --recursive --album', () => {
+    it('should create albums from folder names', async () => {
+      const { stderr, stdout, exitCode } = await immichCli([
+        'upload',
+        `${testAssetDir}/albums/nature/`,
+        '--recursive',
+        '--album',
+      ]);
+      expect(stdout.split('\n')).toEqual([
+        expect.stringContaining('Successfully uploaded 9 assets'),
+      ]);
+      expect(stderr).toBe('');
+      expect(exitCode).toBe(0);
+
+      const assets = await getAllAssets({}, { headers: asKeyAuth(key) });
+      expect(assets.length).toBe(9);
+
+      const albums = await getAllAlbums({}, { headers: asKeyAuth(key) });
+      expect(albums.length).toBe(1);
+      expect(albums[0].albumName).toBe('nature');
+    });
+
+    it('should add existing assets to albums', async () => {
+      const response1 = await immichCli([
+        'upload',
+        `${testAssetDir}/albums/nature/`,
+        '--recursive',
+      ]);
+      expect(response1.stdout.split('\n')).toEqual([
+        expect.stringContaining('Successfully uploaded 9 assets'),
+      ]);
+      expect(response1.stderr).toBe('');
+      expect(response1.exitCode).toBe(0);
+
+      const assets1 = await getAllAssets({}, { headers: asKeyAuth(key) });
+      expect(assets1.length).toBe(9);
+
+      const albums1 = await getAllAlbums({}, { headers: asKeyAuth(key) });
+      expect(albums1.length).toBe(0);
+
+      const response2 = await immichCli([
+        'upload',
+        `${testAssetDir}/albums/nature/`,
+        '--recursive',
+        '--album',
+      ]);
+      expect(response2.stdout.split('\n')).toEqual([
+        expect.stringContaining(
+          'All assets were already uploaded, nothing to do.'
+        ),
+      ]);
+      expect(response2.stderr).toBe('');
+      expect(response2.exitCode).toBe(0);
+
+      const assets2 = await getAllAssets({}, { headers: asKeyAuth(key) });
+      expect(assets2.length).toBe(9);
+
+      const albums2 = await getAllAlbums({}, { headers: asKeyAuth(key) });
+      expect(albums2.length).toBe(1);
+      expect(albums2[0].albumName).toBe('nature');
+    });
+  });
+
+  describe('immich upload --recursive --album-name=e2e', () => {
+    it('should create a named album', async () => {
+      const { stderr, stdout, exitCode } = await immichCli([
+        'upload',
+        `${testAssetDir}/albums/nature/`,
+        '--recursive',
+        '--album-name=e2e',
+      ]);
+      expect(stdout.split('\n')).toEqual([
+        expect.stringContaining('Successfully uploaded 9 assets'),
+      ]);
+      expect(stderr).toBe('');
+      expect(exitCode).toBe(0);
+
+      const assets = await getAllAssets({}, { headers: asKeyAuth(key) });
+      expect(assets.length).toBe(9);
+
+      const albums = await getAllAlbums({}, { headers: asKeyAuth(key) });
+      expect(albums.length).toBe(1);
+      expect(albums[0].albumName).toBe('e2e');
+    });
+  });
+});

e2e/src/cli/specs/version.e2e-spec.ts

@@ -0,0 +1,29 @@
+import { readFileSync } from 'node:fs';
+import { apiUtils, immichCli } from 'src/utils';
+import { beforeAll, describe, expect, it } from 'vitest';
+
+const pkg = JSON.parse(readFileSync('../cli/package.json', 'utf8'));
+
+describe(`immich --version`, () => {
+  beforeAll(() => {
+    apiUtils.setup();
+  });
+
+  describe('immich --version', () => {
+    it('should print the cli version', async () => {
+      const { stdout, stderr, exitCode } = await immichCli(['--version']);
+      expect(stdout).toEqual(pkg.version);
+      expect(stderr).toEqual('');
+      expect(exitCode).toBe(0);
+    });
+  });
+
+  describe('immich -V', () => {
+    it('should print the cli version', async () => {
+      const { stdout, stderr, exitCode } = await immichCli(['-V']);
+      expect(stdout).toEqual(pkg.version);
+      expect(stderr).toEqual('');
+      expect(exitCode).toBe(0);
+    });
+  });
+});