test(cli): e2e testing (#5101)

* Allow building and installing cli

* feat: add format fix

* docs: remove cli folder

* feat: use immich scoped package

* feat: rewrite cli readme

* docs: add info on running without building

* cleanup

* chore: remove import functionality from cli

* feat: add logout to cli

* docs: add todo for file format from server

* docs: add compilation step to cli

* fix: success message spacing

* feat: can create albums

* fix: add check step to cli

* fix: typos

* feat: pull file formats from server

* chore: use crawl service from server

* chore: fix lint

* docs: add cli documentation

* chore: rename ignore pattern

* chore: add version number to cli

* feat: use sdk

* fix: cleanup

* feat: album name on windows

* chore: remove skipped asset field

* feat: add more info to server-info command

* chore: cleanup

* wip

* chore: remove unneeded packages

* e2e test can start

* git ignore for geocode in cli

* add cli e2e to github actions

* can do e2e tests in the cli

* simplify e2e test

* cleanup

* set matrix strategy in workflow

* run npm ci in server

* choose different working directory

* check out submodules too

* increase test timeout

* set node version

* cli docker e2e tests

* fix cli docker file

* run cli e2e in correct folder

* set docker context

* correct docker build

* remove cli from dockerignore

* chore: fix docs links

* feat: add cli v2 milestone

* fix: set correct cli date

* remove submodule

* chore: add npmignore

* chore(cli): push to npm

* fix: server e2e

* run npm ci in server

* remove state from e2e

* run npm ci in server

* reshuffle docker compose files

* use new e2e composes in makefile

* increase test timeout to 10 minutes

* make github actions run makefile e2e tests

* cleanup github test names

* assert on server version

* chore: split cli e2e tests into one file per command

* chore: set cli release working dir

* chore: add repo url to npmjs

* chore: bump node setup to v4

* chore: normalize the github url

* check e2e code in lint

* fix lint

* test key login flow

* feat: allow configurable config dir

* fix session service tests

* create missing dir

* cleanup

* bump cli version to 2.0.4

* remove form-data

* feat: allow single files as argument

* add version option

* bump dependencies

* fix lint

* wip use axios as upload

* version bump

* cApiTALiZaTiON

* don't touch package lock

* wip: don't use job queues

* don't use make for cli e2e

* fix server e2e

* chore: remove old gha step

* add npm ci to server

---------

Co-authored-by: Alex <alex.tran1502@gmail.com>
Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>

.dockerignore

@@ -1,5 +1,5 @@
 .vscode/
-cli/
+
 design/
 docker/
 docs/
@@ -18,3 +18,8 @@ web/node_modules/
 web/coverage/
 web/.svelte-kit
 web/build/
+
+cli/node_modules
+cli/.reverse-geocoding-dump/
+cli/upload/
+cli/dist/

.github/workflows/test.yml

@@ -21,7 +21,7 @@ jobs:
           submodules: "recursive"
 
       - name: Run e2e tests
-        run: docker compose -f ./docker/docker-compose.test.yml up --renew-anon-volumes --abort-on-container-exit --exit-code-from immich-server --remove-orphans --build
+        run: make test-server-e2e
 
   doc-tests:
     name: Docs
@@ -90,9 +90,13 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
 
-      - name: Run npm install
+      - name: Run npm install in cli
         run: npm ci
 
+      - name: Run npm install in server
+        run: npm ci
+        working-directory: ./server
+
       - name: Run linter
         run: npm run lint
         if: ${{ !cancelled() }}
@@ -109,6 +113,29 @@ jobs:
         run: npm run test:cov
         if: ${{ !cancelled() }}
 
+  cli-e2e-tests:
+    name: CLI (e2e)
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./cli
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          submodules: "recursive"
+
+      - name: Run npm install in cli
+        run: npm ci
+
+      - name: Run npm install in server
+        run: npm ci
+        working-directory: ./server
+
+      - name: Run e2e tests
+        run: npm run test:e2e
+
   web-unit-tests:
     name: Web
     runs-on: ubuntu-latest

Makefile

@@ -16,8 +16,8 @@ stage:
 pull-stage:
 	docker compose -f ./docker/docker-compose.staging.yml pull
 
-test-e2e:
-	docker compose -f ./docker/docker-compose.test.yml up --renew-anon-volumes --abort-on-container-exit --exit-code-from immich-server --remove-orphans --build
+test-server-e2e:
+	docker compose -f ./server/test/docker-compose.server-e2e.yml up --renew-anon-volumes --abort-on-container-exit --exit-code-from immich-server --remove-orphans --build
 
 prod:
 	docker compose -f ./docker/docker-compose.prod.yml up --build -V --remove-orphans

cli/.gitignore

@@ -10,4 +10,6 @@ oclif.manifest.json
 
 .vscode
 .idea
-/coverage/
+/coverage/
+.reverse-geocoding-dump/
+upload/

cli/.npmignore

@@ -1,4 +1,6 @@
 **/*.spec.js
+test/**
+upload/**
 .editorconfig
 .eslintignore
 .eslintrc.js

cli/Dockerfile

@@ -0,0 +1,19 @@
+FROM ghcr.io/immich-app/base-server-dev:20231109 as test
+
+WORKDIR /usr/src/app/server
+COPY server/package.json server/package-lock.json ./
+RUN npm ci
+COPY ./server/ .
+
+WORKDIR /usr/src/app/cli
+COPY cli/package.json cli/package-lock.json ./
+RUN npm ci
+COPY ./cli/ .
+
+FROM ghcr.io/immich-app/base-server-prod:20231109
+
+VOLUME /usr/src/app/upload
+
+EXPOSE 3001
+
+ENTRYPOINT ["tini", "--", "/bin/sh"]

cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@immich/cli",
-  "version": "2.0.4",
+  "version": "2.0.5",
   "description": "Command Line Interface (CLI) for Immich",
   "main": "dist/index.js",
   "bin": {
@@ -21,6 +21,7 @@
     "yaml": "^2.3.1"
   },
   "devDependencies": {
+    "@testcontainers/postgresql": "^10.4.0",
     "@types/byte-size": "^8.1.0",
     "@types/chai": "^4.3.5",
     "@types/cli-progress": "^3.11.0",
@@ -37,6 +38,7 @@
     "eslint-plugin-jest": "^27.2.2",
     "eslint-plugin-prettier": "^5.0.0",
     "eslint-plugin-unicorn": "^49.0.0",
+    "immich": "file:../server",
     "jest": "^29.5.0",
     "jest-extended": "^4.0.0",
     "jest-message-util": "^29.5.0",
@@ -50,13 +52,15 @@
   },
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
-    "lint": "eslint \"src/**/*.ts\" --max-warnings 0",
+    "lint": "eslint \"src/**/*.ts\" \"test/**/*.ts\" --max-warnings 0",
+    "lint:fix": "npm run lint -- --fix",
     "prepack": "npm run build",
     "test": "jest",
     "test:cov": "jest --coverage",
     "format": "prettier --check .",
     "format:fix": "prettier --write .",
-    "check": "tsc --noEmit"
+    "check": "tsc --noEmit",
+    "test:e2e": "NODE_OPTIONS='--experimental-vm-modules' jest --config test/e2e/jest-e2e.json --runInBand"
   },
   "jest": {
     "clearMocks": true,
@@ -71,10 +75,15 @@
       "^.+\\.ts$": "ts-jest"
     },
     "collectCoverageFrom": [
-      "<rootDir>/src/**/*.(t|j)s"
+      "<rootDir>/src/**/*.(t|j)s",
+      "!**/open-api/**"
     ],
     "moduleNameMapper": {
-      "^@api(|/.*)$": "<rootDir>/src/api/$1"
+      "^@api(|/.*)$": "<rootDir>/src/api/$1",
+      "^@test(|/.*)$": "<rootDir>../server/test/$1",
+      "^@app/immich(|/.*)$": "<rootDir>../server/src/immich/$1",
+      "^@app/infra(|/.*)$": "<rootDir>../server/src/infra/$1",
+      "^@app/domain(|/.*)$": "<rootDir>../server/src/domain/$1"
     },
     "coverageDirectory": "./coverage",
     "testEnvironment": "node"

cli/src/cli/base-command.ts

@@ -1,10 +1,9 @@
 import { ImmichApi } from '../api/client';
-import path from 'node:path';
 import { SessionService } from '../services/session.service';
 import { LoginError } from '../cores/errors/login-error';
 import { exit } from 'node:process';
-import os from 'os';
 import { ServerVersionResponseDto, UserResponseDto } from 'src/api/open-api';
+import { BaseOptionsDto } from 'src/cores/dto/base-options-dto';
 
 export abstract class BaseCommand {
   protected sessionService!: SessionService;
@@ -12,14 +11,11 @@ export abstract class BaseCommand {
   protected user!: UserResponseDto;
   protected serverVersion!: ServerVersionResponseDto;
 
-  protected configDir;
-  protected authPath;
-
-  constructor() {
-    const userHomeDir = os.homedir();
-    this.configDir = path.join(userHomeDir, '.config/immich/');
-    this.sessionService = new SessionService(this.configDir);
-    this.authPath = path.join(this.configDir, 'auth.yml');
+  constructor(options: BaseOptionsDto) {
+    if (!options.config) {
+      throw new Error('Config directory is required');
+    }
+    this.sessionService = new SessionService(options.config);
   }
 
   public async connect(): Promise<void> {

cli/src/commands/upload.ts

@@ -2,7 +2,7 @@ import { Asset } from '../cores/models/asset';
 import { CrawlService } from '../services';
 import { UploadOptionsDto } from '../cores/dto/upload-options-dto';
 import { CrawlOptionsDto } from '../cores/dto/crawl-options-dto';
-
+import fs from 'node:fs';
 import cliProgress from 'cli-progress';
 import byteSize from 'byte-size';
 import { BaseCommand } from '../cli/base-command';
@@ -15,8 +15,6 @@ export default class Upload extends BaseCommand {
   public async run(paths: string[], options: UploadOptionsDto): Promise<void> {
     await this.connect();
 
-    const deviceId = 'CLI';
-
     const formatResponse = await this.immichApi.serverInfoApi.getSupportedMediaTypes();
     const crawlService = new CrawlService(formatResponse.data.image, formatResponse.data.video);
 
@@ -25,14 +23,26 @@ export default class Upload extends BaseCommand {
     crawlOptions.recursive = options.recursive;
     crawlOptions.exclusionPatterns = options.exclusionPatterns;
 
+    const files: string[] = [];
+
+    for (const pathArgument of paths) {
+      const fileStat = await fs.promises.lstat(pathArgument);
+
+      if (fileStat.isFile()) {
+        files.push(pathArgument);
+      }
+    }
+
     const crawledFiles: string[] = await crawlService.crawl(crawlOptions);
 
+    crawledFiles.push(...files);
+
     if (crawledFiles.length === 0) {
       console.log('No assets found, exiting');
       return;
     }
 
-    const assetsToUpload = crawledFiles.map((path) => new Asset(path, deviceId));
+    const assetsToUpload = crawledFiles.map((path) => new Asset(path));
 
     const uploadProgress = new cliProgress.SingleBar(
       {

cli/src/constants.ts

@@ -0,0 +1,37 @@
+import pkg from '../package.json';
+
+export interface ICLIVersion {
+  major: number;
+  minor: number;
+  patch: number;
+}
+
+export class CLIVersion implements ICLIVersion {
+  constructor(
+    public readonly major: number,
+    public readonly minor: number,
+    public readonly patch: number,
+  ) {}
+
+  toString() {
+    return `${this.major}.${this.minor}.${this.patch}`;
+  }
+
+  toJSON() {
+    const { major, minor, patch } = this;
+    return { major, minor, patch };
+  }
+
+  static fromString(version: string): CLIVersion {
+    const regex = /(?:v)?(?<major>\d+)\.(?<minor>\d+)\.(?<patch>\d+)/i;
+    const matchResult = version.match(regex);
+    if (matchResult) {
+      const [, major, minor, patch] = matchResult.map(Number);
+      return new CLIVersion(major, minor, patch);
+    } else {
+      throw new Error(`Invalid version format: ${version}`);
+    }
+  }
+}
+
+export const cliVersion = CLIVersion.fromString(pkg.version);

cli/src/cores/dto/base-options-dto.ts

@@ -0,0 +1,3 @@
+export class BaseOptionsDto {
+  config?: string;
+}

cli/src/cores/dto/upload-options-dto.ts

@@ -1,9 +1,8 @@
 export class UploadOptionsDto {
-  recursive = false;
-  exclusionPatterns!: string[];
-  dryRun = false;
-  skipHash = false;
-  delete = false;
-  readOnly = true;
-  album = false;
+  recursive? = false;
+  exclusionPatterns?: string[] = [];
+  dryRun? = false;
+  skipHash? = false;
+  delete? = false;
+  album? = false;
 }

cli/src/cores/errors/login-error.ts

@@ -2,10 +2,8 @@ export class LoginError extends Error {
   constructor(message: string) {
     super(message);
 
-    // assign the error class name in your custom error (as a shortcut)
     this.name = this.constructor.name;
 
-    // capturing the stack trace keeps the reference to your error class
     Error.captureStackTrace(this, this.constructor);
   }
 }

cli/src/cores/models/asset.ts

@@ -17,9 +17,8 @@ export class Asset {
   fileSize!: number;
   albumName?: string;
 
-  constructor(path: string, deviceId: string) {
+  constructor(path: string) {
     this.path = path;
-    this.deviceId = deviceId;
   }
 
   async process() {
@@ -45,12 +44,11 @@ export class Asset {
     if (!this.deviceAssetId) throw new Error('Device asset id not set');
     if (!this.fileCreatedAt) throw new Error('File created at not set');
     if (!this.fileModifiedAt) throw new Error('File modified at not set');
-    if (!this.deviceId) throw new Error('Device id not set');
 
     const data: any = {
       assetData: this.assetData as any,
       deviceAssetId: this.deviceAssetId,
-      deviceId: this.deviceId,
+      deviceId: 'CLI',
       fileCreatedAt: this.fileCreatedAt,
       fileModifiedAt: this.fileModifiedAt,
       isFavorite: String(false),

cli/src/index.ts

@@ -1,13 +1,23 @@
 #! /usr/bin/env node
 
-import { program, Option } from 'commander';
+import { Option, Command } from 'commander';
 import Upload from './commands/upload';
 import ServerInfo from './commands/server-info';
 import LoginKey from './commands/login/key';
 import Logout from './commands/logout';
 import { version } from '../package.json';
 
-program.name('immich').description('Immich command line interface').version(version);
+import path from 'node:path';
+import os from 'os';
+
+const userHomeDir = os.homedir();
+const configDir = path.join(userHomeDir, '.config/immich/');
+
+const program = new Command()
+  .name('immich')
+  .version(version)
+  .description('Command line interface for Immich')
+  .addOption(new Option('-d, --config', 'Configuration directory').env('IMMICH_CONFIG_DIR').default(configDir));
 
 program
   .command('upload')
@@ -30,14 +40,14 @@ program
   .argument('[paths...]', 'One or more paths to assets to be uploaded')
   .action(async (paths, options) => {
     options.exclusionPatterns = options.ignore;
-    await new Upload().run(paths, options);
+    await new Upload(program.opts()).run(paths, options);
   });
 
 program
   .command('server-info')
   .description('Display server information')
   .action(async () => {
-    await new ServerInfo().run();
+    await new ServerInfo(program.opts()).run();
   });
 
 program
@@ -46,14 +56,14 @@ program
   .argument('[instanceUrl]')
   .argument('[apiKey]')
   .action(async (paths, options) => {
-    await new LoginKey().run(paths, options);
+    await new LoginKey(program.opts()).run(paths, options);
   });
 
 program
   .command('logout')
   .description('Remove stored credentials')
   .action(async () => {
-    await new Logout().run();
+    await new Logout(program.opts()).run();
   });
 
 program.parse(process.argv);

cli/src/services/session.service.spec.ts

@@ -1,8 +1,17 @@
 import { SessionService } from './session.service';
-import mockfs from 'mock-fs';
 import fs from 'node:fs';
 import yaml from 'yaml';
 import { LoginError } from '../cores/errors/login-error';
+import {
+  TEST_AUTH_FILE,
+  TEST_CONFIG_DIR,
+  TEST_IMMICH_API_KEY,
+  TEST_IMMICH_INSTANCE_URL,
+  createTestAuthFile,
+  deleteAuthFile,
+  readTestAuthFile,
+  spyOnConsole,
+} from '../../test/cli-test-utils';
 
 const mockPingServer = jest.fn(() => Promise.resolve({ data: { res: 'pong' } }));
 const mockUserInfo = jest.fn(() => Promise.resolve({ data: { email: 'admin@example.com' } }));
@@ -22,74 +31,85 @@ jest.mock('../api/open-api', () => {
 
 describe('SessionService', () => {
   let sessionService: SessionService;
+  let consoleSpy: jest.SpyInstance;
+
   beforeAll(() => {
-    // Write a dummy output before mock-fs to prevent some annoying errors
-    console.log();
+    consoleSpy = spyOnConsole();
   });
 
   beforeEach(() => {
-    const configDir = '/config';
-    sessionService = new SessionService(configDir);
+    deleteAuthFile();
+    sessionService = new SessionService(TEST_CONFIG_DIR);
+  });
+
+  afterEach(() => {
+    deleteAuthFile();
   });
 
   it('should connect to immich', async () => {
-    mockfs({
-      '/config/auth.yml': 'apiKey: pNussssKSYo5WasdgalvKJ1n9kdvaasdfbluPg\ninstanceUrl: https://test/api',
-    });
+    await createTestAuthFile(
+      JSON.stringify({
+        apiKey: TEST_IMMICH_API_KEY,
+        instanceUrl: TEST_IMMICH_INSTANCE_URL,
+      }),
+    );
+
     await sessionService.connect();
     expect(mockPingServer).toHaveBeenCalledTimes(1);
   });
 
   it('should error if no auth file exists', async () => {
-    mockfs();
     await sessionService.connect().catch((error) => {
       expect(error.message).toEqual('No auth file exist. Please login first');
     });
   });
 
   it('should error if auth file is missing instance URl', async () => {
-    mockfs({
-      '/config/auth.yml': 'foo: pNussssKSYo5WasdgalvKJ1n9kdvaasdfbluPg\napiKey: https://test/api',
-    });
+    await createTestAuthFile(
+      JSON.stringify({
+        apiKey: TEST_IMMICH_API_KEY,
+      }),
+    );
     await sessionService.connect().catch((error) => {
       expect(error).toBeInstanceOf(LoginError);
-      expect(error.message).toEqual('Instance URL missing in auth config file /config/auth.yml');
+      expect(error.message).toEqual(`Instance URL missing in auth config file ${TEST_AUTH_FILE}`);
     });
   });
 
   it('should error if auth file is missing api key', async () => {
-    mockfs({
-      '/config/auth.yml': 'instanceUrl: pNussssKSYo5WasdgalvKJ1n9kdvaasdfbluPg\nbar: https://test/api',
-    });
-    await sessionService.connect().catch((error) => {
-      expect(error).toBeInstanceOf(LoginError);
-      expect(error.message).toEqual('API key missing in auth config file /config/auth.yml');
-    });
+    await createTestAuthFile(
+      JSON.stringify({
+        instanceUrl: TEST_IMMICH_INSTANCE_URL,
+      }),
+    );
+
+    await expect(sessionService.connect()).rejects.toThrow(
+      new LoginError(`API key missing in auth config file ${TEST_AUTH_FILE}`),
+    );
   });
 
-  it.skip('should create auth file when logged in', async () => {
-    mockfs();
+  it('should create auth file when logged in', async () => {
+    await sessionService.keyLogin(TEST_IMMICH_INSTANCE_URL, TEST_IMMICH_API_KEY);
 
-    await sessionService.keyLogin('https://test/api', 'pNussssKSYo5WasdgalvKJ1n9kdvaasdfbluPg');
-
-    const data: string = await fs.promises.readFile('/config/auth.yml', 'utf8');
+    const data: string = await readTestAuthFile();
     const authConfig = yaml.parse(data);
-    expect(authConfig.instanceUrl).toBe('https://test/api');
-    expect(authConfig.apiKey).toBe('pNussssKSYo5WasdgalvKJ1n9kdvaasdfbluPg');
+    expect(authConfig.instanceUrl).toBe(TEST_IMMICH_INSTANCE_URL);
+    expect(authConfig.apiKey).toBe(TEST_IMMICH_API_KEY);
   });
 
   it('should delete auth file when logging out', async () => {
-    mockfs({
-      '/config/auth.yml': 'apiKey: pNussssKSYo5WasdgalvKJ1n9kdvaasdfbluPg\ninstanceUrl: https://test/api',
-    });
+    await createTestAuthFile(
+      JSON.stringify({
+        apiKey: TEST_IMMICH_API_KEY,
+        instanceUrl: TEST_IMMICH_INSTANCE_URL,
+      }),
+    );
     await sessionService.logout();
 
-    await fs.promises.access('/auth.yml', fs.constants.F_OK).catch((error) => {
+    await fs.promises.access(TEST_AUTH_FILE, fs.constants.F_OK).catch((error) => {
       expect(error.message).toContain('ENOENT');
     });
-  });
 
-  afterEach(() => {
-    mockfs.restore();
+    expect(consoleSpy.mock.calls).toEqual([[`Removed auth file ${TEST_AUTH_FILE}`]]);
   });
 });

cli/src/services/session.service.ts

@@ -5,33 +5,39 @@ import { ImmichApi } from '../api/client';
 import { LoginError } from '../cores/errors/login-error';
 
 export class SessionService {
-  readonly configDir: string;
+  readonly configDir!: string;
   readonly authPath!: string;
   private api!: ImmichApi;
 
   constructor(configDir: string) {
     this.configDir = configDir;
-    this.authPath = path.join(this.configDir, 'auth.yml');
+    this.authPath = path.join(configDir, '/auth.yml');
   }
 
   public async connect(): Promise<ImmichApi> {
-    await fs.promises.access(this.authPath, fs.constants.F_OK).catch((error) => {
-      if (error.code === 'ENOENT') {
-        throw new LoginError('No auth file exist. Please login first');
+    let instanceUrl = process.env.IMMICH_INSTANCE_URL;
+    let apiKey = process.env.IMMICH_API_KEY;
+
+    if (!instanceUrl || !apiKey) {
+      await fs.promises.access(this.authPath, fs.constants.F_OK).catch((error) => {
+        if (error.code === 'ENOENT') {
+          throw new LoginError('No auth file exist. Please login first');
+        }
+      });
+
+      const data: string = await fs.promises.readFile(this.authPath, 'utf8');
+      const parsedConfig = yaml.parse(data);
+
+      instanceUrl = parsedConfig.instanceUrl;
+      apiKey = parsedConfig.apiKey;
+
+      if (!instanceUrl) {
+        throw new LoginError(`Instance URL missing in auth config file ${this.authPath}`);
       }
-    });
 
-    const data: string = await fs.promises.readFile(this.authPath, 'utf8');
-    const parsedConfig = yaml.parse(data);
-    const instanceUrl: string = parsedConfig.instanceUrl;
-    const apiKey: string = parsedConfig.apiKey;
-
-    if (!instanceUrl) {
-      throw new LoginError('Instance URL missing in auth config file ' + this.authPath);
-    }
-
-    if (!apiKey) {
-      throw new LoginError('API key missing in auth config file ' + this.authPath);
+      if (!apiKey) {
+        throw new LoginError(`API key missing in auth config file ${this.authPath}`);
+      }
     }
 
     this.api = new ImmichApi(instanceUrl, apiKey);
@@ -59,10 +65,6 @@ export class SessionService {
       }
     }
 
-    if (!fs.existsSync(this.configDir)) {
-      console.error('waah');
-    }
-
     fs.writeFileSync(this.authPath, yaml.stringify({ instanceUrl, apiKey }));
 
     console.log('Wrote auth info to ' + this.authPath);
@@ -82,7 +84,7 @@ export class SessionService {
     });
 
     if (pingResponse.res !== 'pong') {
-      throw new Error('Unexpected ping reply');
+      throw new Error(`Could not parse response. Is Immich listening on ${this.api.apiConfiguration.instanceUrl}?`);
     }
   }
 }

cli/test/cli-test-utils.ts

@@ -0,0 +1,38 @@
+import { BaseOptionsDto } from 'src/cores/dto/base-options-dto';
+import fs from 'node:fs';
+import path from 'node:path';
+
+export const TEST_CONFIG_DIR = '/tmp/immich/';
+export const TEST_AUTH_FILE = path.join(TEST_CONFIG_DIR, 'auth.yml');
+export const TEST_IMMICH_INSTANCE_URL = 'https://test/api';
+export const TEST_IMMICH_API_KEY = 'pNussssKSYo5WasdgalvKJ1n9kdvaasdfbluPg';
+
+export const CLI_BASE_OPTIONS: BaseOptionsDto = { config: TEST_CONFIG_DIR };
+
+export const spyOnConsole = () => jest.spyOn(console, 'log').mockImplementation();
+
+export const createTestAuthFile = async (contents: string) => {
+  if (!fs.existsSync(TEST_CONFIG_DIR)) {
+    // Create config folder if it doesn't exist
+    const created = await fs.promises.mkdir(TEST_CONFIG_DIR, { recursive: true });
+    if (!created) {
+      throw new Error(`Failed to create config folder ${TEST_CONFIG_DIR}`);
+    }
+  }
+
+  fs.writeFileSync(TEST_AUTH_FILE, contents);
+};
+
+export const readTestAuthFile = async (): Promise<string> => {
+  return await fs.promises.readFile(TEST_AUTH_FILE, 'utf8');
+};
+
+export const deleteAuthFile = () => {
+  try {
+    fs.unlinkSync(TEST_AUTH_FILE);
+  } catch (error: any) {
+    if (error.code !== 'ENOENT') {
+      throw error;
+    }
+  }
+};

cli/test/e2e/jest-e2e.json

@@ -0,0 +1,24 @@
+{
+  "moduleFileExtensions": ["js", "json", "ts"],
+  "modulePaths": ["<rootDir>"],
+  "rootDir": "../..",
+  "globalSetup": "<rootDir>/test/e2e/setup.ts",
+  "testEnvironment": "node",
+  "testRegex": ".e2e-spec.ts$",
+  "testTimeout": 6000000,
+  "transform": {
+    "^.+\\.(t|j)s$": "ts-jest"
+  },
+  "collectCoverageFrom": [
+    "<rootDir>/src/**/*.(t|j)s",
+    "!<rootDir>/src/**/*.spec.(t|s)s",
+    "!<rootDir>/src/infra/migrations/**"
+  ],
+  "coverageDirectory": "./coverage",
+  "moduleNameMapper": {
+    "^@test(|/.*)$": "<rootDir>../server/test/$1",
+    "^@app/immich(|/.*)$": "<rootDir>../server/src/immich/$1",
+    "^@app/infra(|/.*)$": "<rootDir>../server/src/infra/$1",
+    "^@app/domain(|/.*)$": "<rootDir>/../server/src/domain/$1"
+  }
+}

cli/test/e2e/login-key.e2e-spec.ts

@@ -0,0 +1,48 @@
+import { api } from '@test/api';
+import { restoreTempFolder, testApp } from 'immich/test/test-utils';
+import { LoginResponseDto } from 'src/api/open-api';
+import { APIKeyCreateResponseDto } from '@app/domain';
+import LoginKey from 'src/commands/login/key';
+import { LoginError } from 'src/cores/errors/login-error';
+import { CLI_BASE_OPTIONS, spyOnConsole } from 'test/cli-test-utils';
+
+describe(`login-key (e2e)`, () => {
+  let server: any;
+  let admin: LoginResponseDto;
+  let apiKey: APIKeyCreateResponseDto;
+  let instanceUrl: string;
+  spyOnConsole();
+
+  beforeAll(async () => {
+    server = (await testApp.create()).getHttpServer();
+    if (!process.env.IMMICH_INSTANCE_URL) {
+      throw new Error('IMMICH_INSTANCE_URL environment variable not set');
+    } else {
+      instanceUrl = process.env.IMMICH_INSTANCE_URL;
+    }
+  });
+
+  afterAll(async () => {
+    await testApp.teardown();
+    await restoreTempFolder();
+  });
+
+  beforeEach(async () => {
+    await testApp.reset();
+    await restoreTempFolder();
+    await api.authApi.adminSignUp(server);
+    admin = await api.authApi.adminLogin(server);
+    apiKey = await api.apiKeyApi.createApiKey(server, admin.accessToken);
+    process.env.IMMICH_API_KEY = apiKey.secret;
+  });
+
+  it('should error when providing an invalid API key', async () => {
+    await expect(async () => await new LoginKey(CLI_BASE_OPTIONS).run(instanceUrl, 'invalid')).rejects.toThrow(
+      new LoginError(`Failed to connect to server ${instanceUrl}: Request failed with status code 401`),
+    );
+  });
+
+  it('should log in when providing the correct API key', async () => {
+    await new LoginKey(CLI_BASE_OPTIONS).run(instanceUrl, apiKey.secret);
+  });
+});

cli/test/e2e/server-info.e2e-spec.ts

@@ -0,0 +1,42 @@
+import { api } from '@test/api';
+import { restoreTempFolder, testApp } from 'immich/test/test-utils';
+import { LoginResponseDto } from 'src/api/open-api';
+import ServerInfo from 'src/commands/server-info';
+import { APIKeyCreateResponseDto } from '@app/domain';
+import { CLI_BASE_OPTIONS, spyOnConsole } from 'test/cli-test-utils';
+
+describe(`server-info (e2e)`, () => {
+  let server: any;
+  let admin: LoginResponseDto;
+  let apiKey: APIKeyCreateResponseDto;
+  const consoleSpy = spyOnConsole();
+
+  beforeAll(async () => {
+    server = (await testApp.create()).getHttpServer();
+  });
+
+  afterAll(async () => {
+    await testApp.teardown();
+    await restoreTempFolder();
+  });
+
+  beforeEach(async () => {
+    await testApp.reset();
+    await restoreTempFolder();
+    await api.authApi.adminSignUp(server);
+    admin = await api.authApi.adminLogin(server);
+    apiKey = await api.apiKeyApi.createApiKey(server, admin.accessToken);
+    process.env.IMMICH_API_KEY = apiKey.secret;
+  });
+
+  it('should show server version', async () => {
+    await new ServerInfo(CLI_BASE_OPTIONS).run();
+
+    expect(consoleSpy.mock.calls).toEqual([
+      [expect.stringMatching(new RegExp('Server is running version \\d+.\\d+.\\d+'))],
+      [expect.stringMatching('Supported image types: .*')],
+      [expect.stringMatching('Supported video types: .*')],
+      ['Images: 0, Videos: 0, Total: 0'],
+    ]);
+  });
+});

cli/test/e2e/setup.ts

@@ -0,0 +1,43 @@
+import path from 'path';
+import { PostgreSqlContainer } from '@testcontainers/postgresql';
+import { access } from 'fs/promises';
+
+export default async () => {
+  let IMMICH_TEST_ASSET_PATH: string = '';
+
+  if (process.env.IMMICH_TEST_ASSET_PATH === undefined) {
+    IMMICH_TEST_ASSET_PATH = path.normalize(`${__dirname}/../../../server/test/assets/`);
+    process.env.IMMICH_TEST_ASSET_PATH = IMMICH_TEST_ASSET_PATH;
+  } else {
+    IMMICH_TEST_ASSET_PATH = process.env.IMMICH_TEST_ASSET_PATH;
+  }
+
+  const directoryExists = async (dirPath: string) =>
+    await access(dirPath)
+      .then(() => true)
+      .catch(() => false);
+
+  if (!(await directoryExists(`${IMMICH_TEST_ASSET_PATH}/albums`))) {
+    throw new Error(
+      `Test assets not found. Please checkout https://github.com/immich-app/test-assets into ${IMMICH_TEST_ASSET_PATH} before testing`,
+    );
+  }
+
+  if (process.env.DB_HOSTNAME === undefined) {
+    // DB hostname not set which likely means we're not running e2e through docker compose. Start a local postgres container.
+    const pg = await new PostgreSqlContainer('tensorchord/pgvecto-rs:pg14-v0.1.11')
+      .withExposedPorts(5432)
+      .withDatabase('immich')
+      .withUsername('postgres')
+      .withPassword('postgres')
+      .withReuse()
+      .start();
+
+    process.env.DB_URL = pg.getConnectionUri();
+  }
+
+  process.env.NODE_ENV = 'development';
+  process.env.IMMICH_TEST_ENV = 'true';
+  process.env.IMMICH_CONFIG_FILE = path.normalize(`${__dirname}/../../../server/test/e2e/immich-e2e-config.json`);
+  process.env.TZ = 'Z';
+};

cli/test/e2e/upload.e2e-spec.ts

@@ -0,0 +1,49 @@
+import { api } from '@test/api';
+import { IMMICH_TEST_ASSET_PATH, restoreTempFolder, testApp } from 'immich/test/test-utils';
+import { LoginResponseDto } from 'src/api/open-api';
+import Upload from 'src/commands/upload';
+import { APIKeyCreateResponseDto } from '@app/domain';
+import { CLI_BASE_OPTIONS, spyOnConsole } from 'test/cli-test-utils';
+
+describe(`upload (e2e)`, () => {
+  let server: any;
+  let admin: LoginResponseDto;
+  let apiKey: APIKeyCreateResponseDto;
+  spyOnConsole();
+
+  beforeAll(async () => {
+    server = (await testApp.create()).getHttpServer();
+  });
+
+  afterAll(async () => {
+    await testApp.teardown();
+    await restoreTempFolder();
+  });
+
+  beforeEach(async () => {
+    await testApp.reset();
+    await restoreTempFolder();
+    await api.authApi.adminSignUp(server);
+    admin = await api.authApi.adminLogin(server);
+    apiKey = await api.apiKeyApi.createApiKey(server, admin.accessToken);
+    process.env.IMMICH_API_KEY = apiKey.secret;
+  });
+
+  it('should upload a folder recursively', async () => {
+    await new Upload(CLI_BASE_OPTIONS).run([`${IMMICH_TEST_ASSET_PATH}/albums/nature/`], { recursive: true });
+    const assets = await api.assetApi.getAllAssets(server, admin.accessToken);
+    expect(assets.length).toBeGreaterThan(4);
+  });
+
+  it('should create album from folder name', async () => {
+    await new Upload(CLI_BASE_OPTIONS).run([`${IMMICH_TEST_ASSET_PATH}/albums/nature/`], {
+      recursive: true,
+      album: true,
+    });
+
+    const albums = await api.albumApi.getAllAlbums(server, admin.accessToken);
+    expect(albums.length).toEqual(1);
+    const natureAlbum = albums[0];
+    expect(natureAlbum.albumName).toEqual('nature');
+  });
+});

cli/test/global-setup.js

@@ -0,0 +1,3 @@
+module.exports = async () => {
+  process.env.TZ = 'UTC';
+};

cli/tsconfig.json

@@ -8,17 +8,24 @@
     "experimentalDecorators": true,
     "allowSyntheticDefaultImports": true,
     "resolveJsonModule": true,
-    "target": "es2022",
+    "target": "es2021",
     "moduleResolution": "node16",
     "sourceMap": true,
     "outDir": "./dist",
     "incremental": true,
     "skipLibCheck": true,
     "esModuleInterop": true,
+    "rootDirs": ["src", "../server/src"],
     "baseUrl": "./",
     "paths": {
-      "@test": ["test"],
-      "@test/*": ["test/*"]
+      "@test": ["../server/test"],
+      "@test/*": ["../server/test/*"],
+      "@app/immich": ["../server/src/immich"],
+      "@app/immich/*": ["../server/src/immich/*"],
+      "@app/infra": ["../server/src/infra"],
+      "@app/infra/*": ["../server/src/infra/*"],
+      "@app/domain": ["../server/src/domain"],
+      "@app/domain/*": ["../server/src/domain/*"]
     }
   },
   "exclude": ["dist", "node_modules", "upload"]

server/src/infra/infra.config.ts

@@ -5,6 +5,7 @@ import { RedisOptions } from 'ioredis';
 
 function parseRedisConfig(): RedisOptions {
   if (process.env.IMMICH_TEST_ENV == 'true') {
+    // Currently running e2e tests, do not use redis
     return {};
   }
 

server/src/infra/infra.module.ts

@@ -101,6 +101,7 @@ const imports = [
 const moduleExports = [...providers];
 
 if (process.env.IMMICH_TEST_ENV !== 'true') {
+  // Currently not running e2e tests, set up redis and bull queues
   imports.push(BullModule.forRoot(bullConfig));
   imports.push(BullModule.registerQueue(...bullQueues));
   moduleExports.push(BullModule);

server/test/api/album-api.ts

@@ -20,4 +20,9 @@ export const albumApi = {
     expect(res.status).toEqual(200);
     return res.body as AlbumResponseDto;
   },
+  getAllAlbums: async (server: any, accessToken: string) => {
+    const res = await request(server).get(`/album/`).set('Authorization', `Bearer ${accessToken}`).send();
+    expect(res.status).toEqual(200);
+    return res.body as AlbumResponseDto[];
+  },
 };

server/test/api/api-key-api.ts

@@ -0,0 +1,16 @@
+import { APIKeyCreateResponseDto } from '@app/domain';
+import { apiKeyCreateStub } from '@test';
+import request from 'supertest';
+
+export const apiKeyApi = {
+  createApiKey: async (server: any, accessToken: string) => {
+    const { status, body } = await request(server)
+      .post('/api-key')
+      .set('Authorization', `Bearer ${accessToken}`)
+      .send(apiKeyCreateStub);
+
+    expect(status).toBe(201);
+
+    return body as APIKeyCreateResponseDto;
+  },
+};

server/test/api/index.ts

@@ -1,5 +1,6 @@
 import { activityApi } from './activity-api';
 import { albumApi } from './album-api';
+import { apiKeyApi } from './api-key-api';
 import { assetApi } from './asset-api';
 import { authApi } from './auth-api';
 import { libraryApi } from './library-api';
@@ -10,6 +11,7 @@ import { userApi } from './user-api';
 export const api = {
   activityApi,
   authApi,
+  apiKeyApi,
   assetApi,
   libraryApi,
   sharedLinkApi,

server/test/docker-compose.server-e2e.yml

@@ -1,18 +1,17 @@
-version: "3.8"
+version: '3.8'
 
-name: "immich-test-e2e"
+name: 'immich-test-e2e'
 
 services:
   immich-server:
     image: immich-server-dev:latest
     build:
-      context: ../
+      context: ../../
       dockerfile: server/Dockerfile
       target: dev
-    entrypoint: [ "/usr/local/bin/npm", "run" ]
+    entrypoint: ['/usr/local/bin/npm', 'run']
     command: test:e2e
     volumes:
-      - ../server:/usr/src/app
       - /usr/src/app/node_modules
     environment:
       - DB_HOSTNAME=database

server/test/e2e/activity.e2e-spec.ts

@@ -15,7 +15,7 @@ describe(`${ActivityController.name} (e2e)`, () => {
   let nonOwner: LoginResponseDto;
 
   beforeAll(async () => {
-    [server] = await testApp.create();
+    server = (await testApp.create()).getHttpServer();
     await testApp.reset();
     await api.authApi.adminSignUp(server);
     admin = await api.authApi.adminLogin(server);

server/test/e2e/album.e2e-spec.ts

@@ -24,7 +24,7 @@ describe(`${AlbumController.name} (e2e)`, () => {
   let user2Albums: AlbumResponseDto[];
 
   beforeAll(async () => {
-    [server] = await testApp.create();
+    server = (await testApp.create()).getHttpServer();
   });
 
   afterAll(async () => {

server/test/e2e/asset.e2e-spec.ts

@@ -63,7 +63,8 @@ describe(`${AssetController.name} (e2e)`, () => {
   };
 
   beforeAll(async () => {
-    [server, app] = await testApp.create();
+    app = await testApp.create();
+    server = app.getHttpServer();
     assetRepository = app.get<IAssetRepository>(IAssetRepository);
 
     await testApp.reset();

server/test/e2e/auth.e2e-spec.ts

@@ -39,8 +39,7 @@ describe(`${AuthController.name} (e2e)`, () => {
   let accessToken: string;
 
   beforeAll(async () => {
-    await testApp.reset();
-    [server] = await testApp.create();
+    server = (await testApp.create()).getHttpServer();
   });
 
   afterAll(async () => {

server/test/e2e/formats.e2e-spec.ts

@@ -90,10 +90,7 @@ describe(`Supported file formats (e2e)`, () => {
         iso: 20,
         focalLength: 3.99,
         fNumber: 1.8,
-        state: 'Douglas County, Nebraska',
         timeZone: 'America/Chicago',
-        city: 'Ralston',
-        country: 'United States of America',
       },
     },
     {
@@ -168,7 +165,7 @@ describe(`Supported file formats (e2e)`, () => {
   const testsToRun = formatTests.filter((formatTest) => formatTest.runTest);
 
   beforeAll(async () => {
-    [server] = await testApp.create({ jobs: true });
+    server = (await testApp.create({ jobs: true })).getHttpServer();
   });
 
   afterAll(async () => {

server/test/e2e/immich-e2e-config.json

@@ -0,0 +1,11 @@
+{
+  "reverseGeocoding": {
+    "enabled": false
+  },
+  "machineLearning": {
+    "enabled": false
+  },
+  "logging": {
+    "enabled": false
+  }
+}

server/test/e2e/library.e2e-spec.ts

@@ -13,7 +13,7 @@ describe(`${LibraryController.name} (e2e)`, () => {
   let admin: LoginResponseDto;
 
   beforeAll(async () => {
-    [server] = await testApp.create({ jobs: true });
+    server = (await testApp.create({ jobs: true })).getHttpServer();
   });
 
   afterAll(async () => {

server/test/e2e/oauth.e2e-spec.ts

@@ -8,7 +8,7 @@ describe(`${OAuthController.name} (e2e)`, () => {
   let server: any;
 
   beforeAll(async () => {
-    [server] = await testApp.create();
+    server = (await testApp.create()).getHttpServer();
   });
 
   afterAll(async () => {

server/test/e2e/partner.e2e-spec.ts

@@ -12,7 +12,7 @@ describe(`${PartnerController.name} (e2e)`, () => {
   let user3: LoginResponseDto;
 
   beforeAll(async () => {
-    [server] = await testApp.create();
+    server = (await testApp.create()).getHttpServer();
 
     await testApp.reset();
     await api.authApi.adminSignUp(server);

server/test/e2e/person.e2e-spec.ts

@@ -17,7 +17,8 @@ describe(`${PersonController.name}`, () => {
   let hiddenPerson: PersonEntity;
 
   beforeAll(async () => {
-    [server, app] = await testApp.create();
+    app = await testApp.create();
+    server = app.getHttpServer();
     personRepository = app.get<IPersonRepository>(IPersonRepository);
   });
 

server/test/e2e/search.e2e-spec.ts

@@ -24,7 +24,8 @@ describe(`${SearchController.name}`, () => {
   let asset1: AssetResponseDto;
 
   beforeAll(async () => {
-    [server, app] = await testApp.create();
+    app = await testApp.create();
+    server = app.getHttpServer();
     assetRepository = app.get<IAssetRepository>(IAssetRepository);
     smartInfoRepository = app.get<ISmartInfoRepository>(ISmartInfoRepository);
   });

server/test/e2e/server-info.e2e-spec.ts

@@ -11,7 +11,7 @@ describe(`${ServerInfoController.name} (e2e)`, () => {
   let nonAdmin: LoginResponseDto;
 
   beforeAll(async () => {
-    [server] = await testApp.create();
+    server = (await testApp.create()).getHttpServer();
 
     await testApp.reset();
     await api.authApi.adminSignUp(server);
@@ -74,10 +74,10 @@ describe(`${ServerInfoController.name} (e2e)`, () => {
       expect(status).toBe(200);
       expect(body).toEqual({
         clipEncode: false,
-        configFile: false,
+        configFile: true,
         facialRecognition: false,
         map: true,
-        reverseGeocoding: true,
+        reverseGeocoding: false,
         oauth: false,
         oauthAutoLaunch: false,
         passwordLogin: true,

server/test/e2e/setup.ts

@@ -8,8 +8,8 @@ export default async () => {
   if (!allTests) {
     console.warn(
       `\n\n
-      *** Not running all e2e tests. Run 'make test-e2e' to run all tests inside Docker (recommended)\n
-      *** or set 'IMMICH_RUN_ALL_TESTS=true' to run all tests(requires dependencies to be installed)\n`,
+      *** Not running all server e2e tests. Run 'make test-e2e' to run all tests inside Docker (recommended)\n
+      *** or set 'IMMICH_RUN_ALL_TESTS=true' to run all tests (requires dependencies to be installed)\n`,
     );
   }
 
@@ -47,7 +47,7 @@ export default async () => {
   }
 
   process.env.NODE_ENV = 'development';
-  process.env.IMMICH_MACHINE_LEARNING_ENABLED = 'false';
   process.env.IMMICH_TEST_ENV = 'true';
+  process.env.IMMICH_CONFIG_FILE = path.normalize(`${__dirname}/immich-e2e-config.json`);
   process.env.TZ = 'Z';
 };

server/test/e2e/shared-link.e2e-spec.ts

@@ -33,7 +33,8 @@ describe(`${SharedLinkController.name} (e2e)`, () => {
   let app: INestApplication<any>;
 
   beforeAll(async () => {
-    [server, app] = await testApp.create();
+    app = await testApp.create();
+    server = app.getHttpServer();
     const assetRepository = app.get<IAssetRepository>(IAssetRepository);
 
     await testApp.reset();

server/test/e2e/system-config.e2e-spec.ts

@@ -11,7 +11,7 @@ describe(`${SystemConfigController.name} (e2e)`, () => {
   let nonAdmin: LoginResponseDto;
 
   beforeAll(async () => {
-    [server] = await testApp.create();
+    server = (await testApp.create()).getHttpServer();
 
     await testApp.reset();
     await api.authApi.adminSignUp(server);

server/test/e2e/user.e2e-spec.ts

@@ -18,7 +18,8 @@ describe(`${UserController.name}`, () => {
   let userRepository: Repository<UserEntity>;
 
   beforeAll(async () => {
-    [server, app] = await testApp.create();
+    app = await testApp.create();
+    server = app.getHttpServer();
     userRepository = app.select(AppModule).get(getRepositoryToken(UserEntity));
   });
 

server/test/fixtures/api-key.stub.ts

@@ -11,3 +11,7 @@ export const keyStub = {
     user: userStub.admin,
   } as APIKeyEntity),
 };
+
+export const apiKeyCreateStub = {
+  name: 'API Key',
+};

server/test/test-utils.ts

@@ -4,10 +4,12 @@ import { dataSource, databaseChecks } from '@app/infra';
 import { AssetEntity, AssetType, LibraryType } from '@app/infra/entities';
 import { INestApplication } from '@nestjs/common';
 import { Test } from '@nestjs/testing';
+
 import { randomBytes } from 'crypto';
 import * as fs from 'fs';
 import { DateTime } from 'luxon';
 import path from 'path';
+import { Server } from 'tls';
 import { EntityTarget, ObjectLiteral } from 'typeorm';
 import { AppService } from '../src/microservices/app.service';
 
@@ -61,7 +63,7 @@ interface TestAppOptions {
 let app: INestApplication;
 
 export const testApp = {
-  create: async (options?: TestAppOptions): Promise<[any, INestApplication]> => {
+  create: async (options?: TestAppOptions): Promise<INestApplication> => {
     const { jobs } = options || { jobs: false };
 
     const moduleFixture = await Test.createTestingModule({ imports: [AppModule], providers: [AppService] })
@@ -84,20 +86,27 @@ export const testApp = {
       .compile();
 
     app = await moduleFixture.createNestApplication().init();
+    await app.listen(0);
 
     if (jobs) {
       await app.get(AppService).init();
     }
 
-    return [app.getHttpServer(), app];
+    const port = app.getHttpServer().address().port;
+    const protocol = app instanceof Server ? 'https' : 'http';
+    process.env.IMMICH_INSTANCE_URL = protocol + '://127.0.0.1:' + port;
+
+    return app;
   },
   reset: async (options?: ResetOptions) => {
     await db.reset(options);
   },
   teardown: async () => {
-    await app.get(AppService).teardown();
+    if (app) {
+      await app.get(AppService).teardown();
+      await app.close();
+    }
     await db.disconnect();
-    await app.close();
   },
 };