Improve tests for getBackportBranchName

Author: sorenlouv

src/lib/cherrypickAndCreateTargetPullRequest/getBackportBranchName.test.ts

@@ -2,28 +2,78 @@ import { Commit } from '../../entrypoint.api';
 import { ValidConfigOptions } from '../../options/options';
 import { getBackportBranchName } from './getBackportBranchName';
 
-const commit = { sourcePullRequest: { number: 1234 } } as Commit;
-
 describe('getBackportBranchName', () => {
-  it('returns the default name', () => {
-    const name = getBackportBranchName({
-      options: {
-        backportBranchName: undefined,
-      } as ValidConfigOptions,
-      targetBranch: '7.x',
-      commits: [commit],
+  describe('when options.backportBranchName is not set', () => {
+    it('returns the default name with PR number', () => {
+      const commits = [{ sourcePullRequest: { number: 1234 } }] as Commit[];
+      const name = getBackportBranchName({
+        options: { backportBranchName: undefined } as ValidConfigOptions,
+        targetBranch: '7.x',
+        commits,
+      });
+      expect(name).toBe('backport/7.x/pr-1234');
+    });
+
+    it('returns the default name with commit sha', () => {
+      const commits = [{ sourceCommit: { sha: 'abcde' } }] as Commit[];
+      const name = getBackportBranchName({
+        options: { backportBranchName: undefined } as ValidConfigOptions,
+        targetBranch: '7.x',
+        commits,
+      });
+      expect(name).toBe('backport/7.x/commit-abcde');
     });
-    expect(name).toBe('backport/7.x/pr-1234');
   });
 
-  it('returns a custom name', () => {
-    const name = getBackportBranchName({
-      options: {
-        backportBranchName: 'bp/pull-{{sourcePullRequest.number}}',
-      } as ValidConfigOptions,
-      targetBranch: '7.x',
-      commits: [commit],
+  describe('template variables are supported when using options.backportBranchName', () => {
+    it('{{targetBranch}}', () => {
+      const commits = [{ sourcePullRequest: { number: 1234 } }] as Commit[];
+      const name = getBackportBranchName({
+        options: {
+          backportBranchName: 'bp/target-{{targetBranch}}',
+        } as ValidConfigOptions,
+        targetBranch: '7.x',
+        commits,
+      });
+      expect(name).toBe('bp/target-7.x');
+    });
+
+    it('{{refValues}}', () => {
+      const commits = [{ sourcePullRequest: { number: 1234 } }] as Commit[];
+      const name = getBackportBranchName({
+        options: {
+          backportBranchName: 'bp/ref-{{refValues}}',
+        } as ValidConfigOptions,
+        targetBranch: '7.x',
+        commits,
+      });
+      expect(name).toBe('bp/ref-pr-1234');
+    });
+
+    it('{{sourcePullRequest.number}}', () => {
+      const commits = [{ sourcePullRequest: { number: 1234 } }] as Commit[];
+      const name = getBackportBranchName({
+        options: {
+          backportBranchName: 'bp/pr-{{sourcePullRequest.number}}',
+        } as ValidConfigOptions,
+        targetBranch: '7.x',
+        commits,
+      });
+      expect(name).toBe('bp/pr-1234');
+    });
+
+    it('{{sourcePullRequest.title}}', () => {
+      const commits = [
+        { sourcePullRequest: { title: 'My PR title', number: 1234 } },
+      ] as Commit[];
+      const name = getBackportBranchName({
+        options: {
+          backportBranchName: 'bp/pr-{{sourcePullRequest.title}}',
+        } as ValidConfigOptions,
+        targetBranch: '7.x',
+        commits,
+      });
+      expect(name).toBe('bp/pr-My PR title');
     });
-    expect(name).toBe('bp/pull-1234');
   });
 });

src/lib/cherrypickAndCreateTargetPullRequest/getBackportBranchName.ts

@@ -29,13 +29,15 @@ export function getBackportBranchName({
     .join('_')
     .slice(0, 200);
 
+  const sourcePullRequest = commits[0].sourcePullRequest; // assume that all commits are from the same PR
   const defaultBackportBranchName = 'backport/{{targetBranch}}/{{refValues}}';
-  const template = Handlebars.compile(
-    options.backportBranchName ?? defaultBackportBranchName,
-  );
 
+  const backportBranchName =
+    options.backportBranchName ?? defaultBackportBranchName;
+
+  const template = Handlebars.compile(backportBranchName);
   return template({
-    sourcePullRequest: commits[0].sourcePullRequest, // assume that all commits are from the same PR
+    sourcePullRequest,
     targetBranch,
     refValues,
   });

src/lib/github/v3/getPullRequest/getPullRequestBody.test.ts

@@ -449,7 +449,7 @@ Please refer to the [Backport tool documentation](https://github.com/sorenlouv/b
   });
 
   describe('handlebars', () => {
-    it('should throw an error if Handlebars compilation fails', () => {
+    it('should return default description if handlebars compilation fails', () => {
       const compileError = new Error('Simulated compile error');
 
       // Stub Handlebars.compile to throw an error.

src/lib/github/v3/getPullRequest/getTitle.test.ts

@@ -1,3 +1,4 @@
+import Handlebars from 'handlebars';
 import { Commit } from '../../../../entrypoint.api';
 import { ValidConfigOptions } from '../../../../options/options';
 import { getTitle } from './getTitle';
@@ -114,4 +115,26 @@ describe('getTitle', () => {
       getTitle({ options, commits, targetBranch: '7.x' }),
     ).not.toThrow();
   });
+
+  it('should return default description if handlebars compilation fails', () => {
+    const compileError = new Error('Simulated compile error');
+
+    // Stub Handlebars.compile to throw an error.
+    const compileSpy = jest
+      .spyOn(Handlebars, 'compile')
+      .mockImplementation(() => {
+        throw compileError;
+      });
+
+    const options = {} as ValidConfigOptions;
+
+    expect(
+      getTitle({ options, commits, targetBranch: '7.x' }),
+    ).toMatchInlineSnapshot(
+      `"[7.x] My commit message (#55) | Another commit message (#56)"`,
+    );
+
+    // Restore the stubs.
+    compileSpy.mockRestore();
+  });
 });