test: add branching to compare command

Author: zomp

src/client/errorFromLoadable.ts

@@ -43,6 +43,10 @@ export const errorFromLoadable = (loadable: LoadableData) => {
         loadable
       )}`;
 
+    // Not found (e.g. branch in project)
+    case 404:
+      return `Requested data not found. Please check your inputs ${addErrorDetails(loadable)}`;
+
     // Rate limited
     case 429:
       return `You've been rate limited. Please try again later ${addErrorDetails(

src/utils/branch.ts

@@ -1,3 +1,3 @@
 export function appendBranch(branch?: string) {
-  return branch ? ` (branch "${branch}")` : ' (no or default branch)';
+  return branch ? ` (branch "${branch}")` : ' (none or default branch)';
 }

test/e2e/compare.test.ts

@@ -3,6 +3,8 @@ import { run } from './utils/run.js';
 import { TolgeeClient } from '#cli/client/TolgeeClient.js';
 import { PROJECT_2 } from './utils/api/project2.js';
 import {
+  createBranch,
+  createKey,
   createPak,
   createProjectWithClient,
   deleteProject,
@@ -34,7 +36,7 @@ const CODE_UNORDERED = fileURLToPathSlash(
 let client: TolgeeClient;
 let pak: string;
 
-describe('Project 1', () => {
+describe('Project 2', () => {
   beforeEach(async () => {
     client = await createProjectWithClient('Project 2', PROJECT_2);
     pak = await createPak(client);
@@ -106,12 +108,12 @@ describe('Project 1', () => {
     expect(out.code).toBe(0);
 
     // Test all added keys
-    expect(out.stdout).toContain('section-content');
-    expect(out.stdout).toContain('section-title');
-    expect(out.stdout).toContain('copyright-notice');
-    expect(out.stdout).toContain('privacy-policy');
-    expect(out.stdout).toContain('terms-of-service');
-    expect(out.stdout).toContain('welcome');
+    expect(out.stdout).toContain('+ section-content');
+    expect(out.stdout).toContain('+ section-title');
+    expect(out.stdout).toContain('+ copyright-notice');
+    expect(out.stdout).toContain('+ privacy-policy');
+    expect(out.stdout).toContain('+ terms-of-service');
+    expect(out.stdout).toContain('+ welcome');
 
     expect(out.stdout.indexOf('section-content')).toBeLessThan(
       out.stdout.indexOf('section-title')
@@ -130,12 +132,12 @@ describe('Project 1', () => {
     );
 
     // Test all removed keys
-    expect(out.stdout).toContain('bird-name');
-    expect(out.stdout).toContain('bird-sound');
-    expect(out.stdout).toContain('cat-name');
-    expect(out.stdout).toContain('cat-sound');
-    expect(out.stdout).toContain('dog-name');
-    expect(out.stdout).toContain('dog-sound');
+    expect(out.stdout).toContain('- bird-name');
+    expect(out.stdout).toContain('- bird-sound');
+    expect(out.stdout).toContain('- cat-name');
+    expect(out.stdout).toContain('- cat-sound');
+    expect(out.stdout).toContain('- dog-name');
+    expect(out.stdout).toContain('- dog-sound');
 
     expect(out.stdout.indexOf('bird-name')).toBeLessThan(
       out.stdout.indexOf('bird-sound')
@@ -155,6 +157,78 @@ describe('Project 1', () => {
   }, 30e3);
 });
 
+describe('Branching', () => {
+  beforeEach(async () => {
+    client = await createProjectWithClient('Project 2', PROJECT_2);
+    pak = await createPak(client);
+
+    await createBranch(client, 'feature-branch');
+
+    await createKey(client, 'mouse-name', {
+      branch: 'feature-branch',
+      translations: { en: 'Mouse' },
+    });
+    await createKey(client, 'mouse-sound', {
+      branch: 'feature-branch',
+      translations: { en: 'Squeek' },
+    });
+  });
+
+  afterEach(async () => {
+    await deleteProject(client);
+  });
+
+  it('contains added keys in new branch', async () => {
+    const out = await run(
+      [
+        'compare',
+        '--api-key',
+        pak,
+        '--patterns',
+        CODE_PROJECT_2_ADDED,
+        '--branch',
+        'feature-branch',
+      ],
+      undefined,
+      20e3
+    );
+
+    expect(out.code).toBe(0);
+    expect(out.stdout).toContain('is in sync');
+  });
+
+  it('does not contain the added keys in main branch', async () => {
+    const out = await run(
+      ['compare', '--api-key', pak, '--patterns', CODE_PROJECT_2_ADDED],
+      undefined,
+      20e3
+    );
+
+    expect(out.code).toBe(0);
+    expect(out.stdout).toContain('out of sync');
+    expect(out.stdout).toContain('2 new keys found');
+  }, 30e3);
+
+  it('fails when branch does not exist', async () => {
+    const out = await run(
+      [
+        'compare',
+        '--api-key',
+        pak,
+        '--patterns',
+        CODE_PROJECT_2_COMPLETE,
+        '--branch',
+        'missing-branch',
+      ],
+      undefined,
+      20e3
+    );
+
+    expect(out.code).not.toBe(0);
+    expect(out.stderr + out.stdout).toContain('branch_not_found');
+  }, 30e3);
+});
+
 describe('Project 3', () => {
   beforeEach(async () => {
     client = await createProjectWithClient('Project 3', PROJECT_3);

test/e2e/utils/api/common.ts

@@ -53,7 +53,9 @@ export async function createProjectWithClient(
 ) {
   const userToken = await userLogin();
   let client = createClient(userToken!);
-  const organizations = await client.GET('/v2/organizations');
+  const organizations = await client.GET('/v2/organizations', {
+    params: { query: { filterCurrentUserOwner: true } },
+  });
   const { languages, ...editOptions } = options ?? {};
 
   const project = await client.POST('/v2/projects', {
@@ -91,6 +93,58 @@ export async function createProjectWithClient(
   return client;
 }
 
+type CreateBranchOptions = {
+  originBranchId?: number;
+};
+
+export async function createBranch(
+  client: TolgeeClient,
+  name: string,
+  options?: CreateBranchOptions
+) {
+  let originBranchId = options?.originBranchId;
+  if (!originBranchId) {
+    const branches = await client.GET('/v2/projects/{projectId}/branches', {
+      params: {
+        path: { projectId: client.getProjectId() },
+        query: { page: 0, size: 100 },
+      },
+    });
+
+    const origin = branches.data?._embedded?.branches?.find((b) => b.isDefault); ///TODO verify
+    originBranchId = origin?.id;
+  }
+
+  if (!originBranchId) {
+    throw new Error('Default branch not found');
+  }
+
+  await client.POST('/v2/projects/{projectId}/branches', {
+    params: { path: { projectId: client.getProjectId() } },
+    body: { name, originBranchId },
+  });
+}
+
+type CreateKeyOptions = Partial<
+  Omit<components['schemas']['CreateKeyDto'], 'name'>
+>;
+
+export async function createKey(
+  client: TolgeeClient,
+  name: string,
+  options: CreateKeyOptions = {}
+) {
+  const { isPlural = false, ...rest } = options;
+  return await client.POST('/v2/projects/{projectId}/keys', {
+    params: { path: { projectId: client.getProjectId() } },
+    body: {
+      name,
+      isPlural,
+      ...rest,
+    },
+  });
+}
+
 export const DEFAULT_SCOPES = [
   'keys.view',
   'translations.view',