testing

Author: jake-perkins

src/functions.test.ts

@@ -0,0 +1,15 @@
+import * as Functions from './functions';
+
+describe('func1', () => {
+    it('returns the mocked value of func2 when called', () => {
+        // Spy on func2 and mock its return value
+        const spy = jest.spyOn(Functions, 'func2').mockReturnValue("Mocked func2 value");
+
+        // Call func1, which internally calls the mocked func2
+        const result = Functions.func1();
+
+        // Verify that the mocked version of func2 is called
+        expect(result).toBe("Result: Mocked func2 value");
+        expect(spy).toHaveBeenCalled();
+    });
+});

src/functions.ts

@@ -0,0 +1,21 @@
+//WORKS
+// functions.js
+const functions = {
+    func2: () => "Original func2 value",
+    func1: function() {
+        return `Result: ${this.func2()}`;
+    }
+};
+export const { func1, func2 } = functions;
+
+/*
+DOESN'T WORK
+
+export function func2() {
+    return "Original func2 value";
+}
+
+export function func1() {
+    return `Result: ${func2()}`;
+}
+    */

src/update-changelog.test.ts

@@ -1,53 +1,61 @@
 import * as ChangeLogManager from './update-changelog';
 
-const uncategorizedChangelog = `# Changelog
+
+const emptyChangelog = `# Changelog
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
-## [1.0.0]
-### Uncategorized
-- fix: a commit of the type fix patches a bug in your codebase
-- feat: a commit of the type feat introduces a new feature to the codebase
-- unknown: a commit of the type unknown does not match any of the conventional commit types
-
 [Unreleased]: https://github.com/ExampleUsernameOrOrganization/ExampleRepository/
 `;
 
 describe('updateChangelog', () => {
-  it('should contain conventional support mappings categorization', async () => {
-    // Call updateChangelog, which internally calls the mocked getNewChangeEntries
+  let getNewChangeEntriesSpy: jest.SpyInstance;
+
+  beforeEach(() => {
+    // Setup the spy and mock before each test
+    // Assuming getNewChangeEntries returns a Promise<string[]>
+    getNewChangeEntriesSpy = jest.spyOn(ChangeLogManager, 'getNewChangeEntries')
+      .mockResolvedValue([
+        'fix: fixed a major bug',
+        'feat: introduced a new feature',
+        'unknown: some non-conventional commit'
+      ]);
+  });
+
+  afterEach(() => {
+    // Restore the original function after each test
+    getNewChangeEntriesSpy.mockRestore();
+  });
+
+  it('should contain conventional support mappings categorization when autoCategorize is true', async () => {
     const result = await ChangeLogManager.updateChangelog({
-      changelogContent: uncategorizedChangelog,
+      changelogContent: emptyChangelog,
       currentVersion: '1.0.0',
-      repoUrl:
-        'https://github.com/ExampleUsernameOrOrganization/ExampleRepository',
+      repoUrl: 'https://github.com/ExampleUsernameOrOrganization/ExampleRepository',
       isReleaseCandidate: true,
       autoCategorize: true,
     });
 
-    console.log(result);
-
-    // Verify that some of the commits are included in the result
     expect(result).toContain('### Fixed');
+    expect(result).toContain('### Added');
+    expect(result).not.toContain('### Uncategorized');
   });
 
-  it('should not contain conventional support mappings categorization', async () => {
-    // Call updateChangelog, which internally calls the mocked getNewChangeEntries
+  it('should not contain conventional support mappings categorization when autoCategorize is false', async () => {
     const result = await ChangeLogManager.updateChangelog({
-      changelogContent: uncategorizedChangelog,
+      changelogContent: emptyChangelog,
       currentVersion: '1.0.0',
-      repoUrl:
-        'https://github.com/ExampleUsernameOrOrganization/ExampleRepository',
+      repoUrl: 'https://github.com/ExampleUsernameOrOrganization/ExampleRepository',
       isReleaseCandidate: true,
       autoCategorize: false,
     });
 
-    // Verify that some of the commits are included in the result
     expect(result).toContain('### Uncategorized');
     expect(result).not.toContain('### Fixed');
+    expect(result).not.toContain('### Added');
   });
 });

src/update-changelog.ts

@@ -267,8 +267,6 @@ export async function updateChangelog({
     packageRename,
   });
 
-  console.log(`autoCategorize: ${autoCategorize}`);
-
   const mostRecentTag = await getMostRecentTag({
     tagPrefixes,
   });
@@ -308,8 +306,6 @@ export async function updateChangelog({
     projectRootDirectory,
   });
 
-  console.log(`count of newChangeEntries: ${newChangeEntries.length}`);
-
   for (const description of newChangeEntries.reverse()) {
     const category = autoCategorize
       ? getCategory(description)
@@ -349,24 +345,18 @@ async function runCommand(command: string, args: string[]): Promise<string[]> {
  * @returns The category of the change.
  */
 function getCategory(description: string): ChangeCategory {
-  console.log(`description: ${description}`);
   // Check if description contains a colon
   if (description.includes(':')) {
     const [prefix] = description.split(':').map((part) => part.trim());
     switch (prefix) {
       case ConventionalCommitType.Feat:
-        console.log(`mapping feat to Added`);
         return ChangeCategory.Added;
       case ConventionalCommitType.Fix:
-        console.log(`mapping fix to Fixed`);
         return ChangeCategory.Fixed;
       default:
-        console.log(`mapping ${prefix} to Uncategorized`);
         return ChangeCategory.Uncategorized;
     }
   }
-
-  console.log(`mapping as desc didn't contain : Uncategorized`);
   // Return 'Uncategorized' if no colon is found or prefix doesn't match
   return ChangeCategory.Uncategorized;
 }

src/update-changelogv2.test.ts

@@ -0,0 +1,70 @@
+// Place this at the very top of your test file
+jest.mock('./update-changelog', () => {
+  const originalModule = jest.requireActual('./update-changelog'); // Get the actual module
+  return {
+    ...originalModule, // spread all actual exports
+    getNewChangeEntries: jest.fn().mockResolvedValue([
+      'fix: Fixed a critical bug',
+      'feat: Added new feature [PR#123](https://github.com/ExampleUsernameOrOrganization/ExampleRepository/pull/123)'
+    ])
+  };
+});
+
+import * as ChangeLogManager from './update-changelog';
+
+
+const emptyChangelog = `# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+[Unreleased]: https://github.com/ExampleUsernameOrOrganization/ExampleRepository/
+`;
+
+describe('updateChangelog', () => {
+
+  it('should contain conventional support mappings categorization when autoCategorize is true', async () => {
+
+    // TRIED WITH AND WITHOUT THIS LINE
+    jest.spyOn(ChangeLogManager, 'getNewChangeEntries').mockResolvedValue([
+      'fix: Fixed a critical bug',
+'feat: Added new feature [PR#123](https://github.com/ExampleUsernameOrOrganization/ExampleRepository/pull/123)'
+]);
+
+    const result = await ChangeLogManager.updateChangelog({
+      changelogContent: emptyChangelog,
+      currentVersion: '1.0.0',
+      repoUrl: 'https://github.com/ExampleUsernameOrOrganization/ExampleRepository',
+      isReleaseCandidate: true,
+      autoCategorize: true,
+    });
+
+    expect(result).toContain('### Fixed');
+    expect(result).toContain('### Added');
+    expect(result).not.toContain('### Uncategorized');
+  });
+
+  it('should not contain conventional support mappings categorization when autoCategorize is false', async () => {
+    
+    // TRIED WITH AND WITHOUT THIS LINE
+    jest.spyOn(ChangeLogManager, 'getNewChangeEntries').mockResolvedValue([
+            'fix: Fixed a critical bug',
+      'feat: Added new feature [PR#123](https://github.com/ExampleUsernameOrOrganization/ExampleRepository/pull/123)'
+    ]);
+
+    const result = await ChangeLogManager.updateChangelog({
+      changelogContent: emptyChangelog,
+      currentVersion: '1.0.0',
+      repoUrl: 'https://github.com/ExampleUsernameOrOrganization/ExampleRepository',
+      isReleaseCandidate: true,
+      autoCategorize: false,
+    });
+
+    expect(result).toContain('### Uncategorized');
+    expect(result).not.toContain('### Fixed');
+    expect(result).not.toContain('### Added');
+  });
+});