@elisra-devops/docgen-data-provider 1.63.12 → 1.63.13

package/src/modules/test/gitDataProvider.test.ts

@@ -24,7 +24,7 @@ describe('GitDataProvider - GetCommitForPipeline', () => {
     const mockResponse = {
       id: mockBuildId,
       sourceVersion: mockCommitSha,
-      status: 'completed'
+      status: 'completed',
     };
 
     (TFSServices.getItemContent as jest.Mock).mockResolvedValueOnce(mockResponse);
@@ -47,8 +47,9 @@ describe('GitDataProvider - GetCommitForPipeline', () => {
     (TFSServices.getItemContent as jest.Mock).mockRejectedValueOnce(expectedError);
 
     // Act & Assert
-    await expect(gitDataProvider.GetCommitForPipeline(mockProjectId, mockBuildId))
-      .rejects.toThrow('API call failed');
+    await expect(gitDataProvider.GetCommitForPipeline(mockProjectId, mockBuildId)).rejects.toThrow(
+      'API call failed'
+    );
 
     expect(TFSServices.getItemContent).toHaveBeenCalledWith(
       `${mockOrgUrl}${mockProjectId}/_apis/build/builds/${mockBuildId}`,
@@ -61,7 +62,7 @@ describe('GitDataProvider - GetCommitForPipeline', () => {
     // Arrange
     const mockResponse = {
       id: mockBuildId,
-      status: 'completed'
+      status: 'completed',
       // No sourceVersion property
     };
 
@@ -135,8 +136,8 @@ describe('GitDataProvider - GetTeamProjectGitReposList', () => {
       value: [
         { id: 'repo2', name: 'ZRepo' },
         { id: 'repo1', name: 'ARepo' },
-        { id: 'repo3', name: 'MRepo' }
-      ]
+        { id: 'repo3', name: 'MRepo' },
+      ],
     };
     (TFSServices.getItemContent as jest.Mock).mockResolvedValueOnce(mockRepos);
 
@@ -176,8 +177,7 @@ describe('GitDataProvider - GetTeamProjectGitReposList', () => {
     (TFSServices.getItemContent as jest.Mock).mockRejectedValueOnce(mockError);
 
     // Act & Assert
-    await expect(gitDataProvider.GetTeamProjectGitReposList(mockTeamProject))
-      .rejects.toThrow('API Error');
+    await expect(gitDataProvider.GetTeamProjectGitReposList(mockTeamProject)).rejects.toThrow('API Error');
   });
 });
 
@@ -228,12 +228,7 @@ describe('GitDataProvider - GetFileFromGitRepo', () => {
     (TFSServices.getItemContent as jest.Mock).mockResolvedValueOnce(mockResponse);
 
     // Act
-    await gitDataProvider.GetFileFromGitRepo(
-      mockProjectName,
-      mockRepoId,
-      mockFileName,
-      specialVersion
-    );
+    await gitDataProvider.GetFileFromGitRepo(mockProjectName, mockRepoId, mockFileName, specialVersion);
 
     // Assert
     expect(TFSServices.getItemContent).toHaveBeenCalledWith(
@@ -328,11 +323,7 @@ describe('GitDataProvider - CheckIfItemExist', () => {
     (TFSServices.getItemContent as jest.Mock).mockResolvedValueOnce(mockResponse);
 
     // Act
-    const result = await gitDataProvider.CheckIfItemExist(
-      mockGitApiUrl,
-      mockItemPath,
-      mockVersion
-    );
+    const result = await gitDataProvider.CheckIfItemExist(mockGitApiUrl, mockItemPath, mockVersion);
 
     // Assert
     expect(TFSServices.getItemContent).toHaveBeenCalledWith(
@@ -351,11 +342,7 @@ describe('GitDataProvider - CheckIfItemExist', () => {
     (TFSServices.getItemContent as jest.Mock).mockRejectedValueOnce(new Error('Not found'));
 
     // Act
-    const result = await gitDataProvider.CheckIfItemExist(
-      mockGitApiUrl,
-      mockItemPath,
-      mockVersion
-    );
+    const result = await gitDataProvider.CheckIfItemExist(mockGitApiUrl, mockItemPath, mockVersion);
 
     // Assert
     expect(result).toBe(false);
@@ -366,11 +353,7 @@ describe('GitDataProvider - CheckIfItemExist', () => {
     (TFSServices.getItemContent as jest.Mock).mockResolvedValueOnce(null);
 
     // Act
-    const result = await gitDataProvider.CheckIfItemExist(
-      mockGitApiUrl,
-      mockItemPath,
-      mockVersion
-    );
+    const result = await gitDataProvider.CheckIfItemExist(mockGitApiUrl, mockItemPath, mockVersion);
 
     // Assert
     expect(result).toBe(false);
@@ -383,11 +366,7 @@ describe('GitDataProvider - CheckIfItemExist', () => {
     (TFSServices.getItemContent as jest.Mock).mockResolvedValueOnce(mockResponse);
 
     // Act
-    await gitDataProvider.CheckIfItemExist(
-      mockGitApiUrl,
-      mockItemPath,
-      specialVersion
-    );
+    await gitDataProvider.CheckIfItemExist(mockGitApiUrl, mockItemPath, specialVersion);
 
     // Assert
     expect(TFSServices.getItemContent).toHaveBeenCalledWith(
@@ -416,10 +395,7 @@ describe('GitDataProvider - GetPullRequestsInCommitRangeWithoutLinkedItems', ()
   it('should return filtered pull requests matching commit ids', async () => {
     // Arrange
     const mockCommits = {
-      value: [
-        { commitId: 'commit-1' },
-        { commitId: 'commit-2' }
-      ]
+      value: [{ commitId: 'commit-1' }, { commitId: 'commit-2' }],
     };
 
     const mockPullRequests = {
@@ -432,7 +408,7 @@ describe('GitDataProvider - GetPullRequestsInCommitRangeWithoutLinkedItems', ()
           creationDate: '2023-01-01',
           closedDate: '2023-01-02',
           description: 'Description 1',
-          lastMergeCommit: { commitId: 'commit-1' }
+          lastMergeCommit: { commitId: 'commit-1' },
         },
         {
           pullRequestId: 102,
@@ -441,7 +417,7 @@ describe('GitDataProvider - GetPullRequestsInCommitRangeWithoutLinkedItems', ()
           creationDate: '2023-02-01',
           closedDate: '2023-02-02',
           description: 'Description 2',
-          lastMergeCommit: { commitId: 'commit-3' } // Not in our commit range
+          lastMergeCommit: { commitId: 'commit-3' }, // Not in our commit range
         },
         {
           pullRequestId: 103,
@@ -450,9 +426,9 @@ describe('GitDataProvider - GetPullRequestsInCommitRangeWithoutLinkedItems', ()
           creationDate: '2023-03-01',
           closedDate: '2023-03-02',
           description: 'Description 3',
-          lastMergeCommit: { commitId: 'commit-2' }
-        }
-      ]
+          lastMergeCommit: { commitId: 'commit-2' },
+        },
+      ],
     };
 
     (TFSServices.getItemContent as jest.Mock).mockResolvedValueOnce(mockPullRequests);
@@ -466,7 +442,9 @@ describe('GitDataProvider - GetPullRequestsInCommitRangeWithoutLinkedItems', ()
 
     // Assert
     expect(TFSServices.getItemContent).toHaveBeenCalledWith(
-      expect.stringContaining(`${mockOrgUrl}${mockProjectId}/_apis/git/repositories/${mockRepoId}/pullrequests`),
+      expect.stringContaining(
+        `${mockOrgUrl}${mockProjectId}/_apis/git/repositories/${mockRepoId}/pullrequests`
+      ),
       mockToken,
       'get'
     );
@@ -482,8 +460,8 @@ describe('GitDataProvider - GetPullRequestsInCommitRangeWithoutLinkedItems', ()
     // Arrange
     const mockCommits = {
       value: [
-        { commitId: 'commit-999' } // Not matching any PRs
-      ]
+        { commitId: 'commit-999' }, // Not matching any PRs
+      ],
     };
 
     const mockPullRequests = {
@@ -491,13 +469,13 @@ describe('GitDataProvider - GetPullRequestsInCommitRangeWithoutLinkedItems', ()
       value: [
         {
           pullRequestId: 101,
-          lastMergeCommit: { commitId: 'commit-1' }
+          lastMergeCommit: { commitId: 'commit-1' },
         },
         {
           pullRequestId: 102,
-          lastMergeCommit: { commitId: 'commit-2' }
-        }
-      ]
+          lastMergeCommit: { commitId: 'commit-2' },
+        },
+      ],
     };
 
     (TFSServices.getItemContent as jest.Mock).mockResolvedValueOnce(mockPullRequests);
@@ -520,11 +498,9 @@ describe('GitDataProvider - GetPullRequestsInCommitRangeWithoutLinkedItems', ()
     (TFSServices.getItemContent as jest.Mock).mockRejectedValueOnce(mockError);
 
     // Act & Assert
-    await expect(gitDataProvider.GetPullRequestsInCommitRangeWithoutLinkedItems(
-      mockProjectId,
-      mockRepoId,
-      mockCommits
-    )).rejects.toThrow('API Error');
+    await expect(
+      gitDataProvider.GetPullRequestsInCommitRangeWithoutLinkedItems(mockProjectId, mockRepoId, mockCommits)
+    ).rejects.toThrow('API Error');
   });
 });
 
@@ -546,21 +522,17 @@ describe('GitDataProvider - GetRepoReferences', () => {
       count: 2,
       value: [
         { name: 'refs/tags/v1.0.0', objectId: 'tag-1' },
-        { name: 'refs/tags/v2.0.0', objectId: 'tag-2' }
-      ]
+        { name: 'refs/tags/v2.0.0', objectId: 'tag-2' },
+      ],
     };
     (TFSServices.getItemContent as jest.Mock).mockResolvedValueOnce(mockTags);
 
     // Act
-    const result = await gitDataProvider.GetRepoReferences(
-      mockProjectId,
-      mockRepoId,
-      'tag'
-    );
+    const result = await gitDataProvider.GetRepoReferences(mockProjectId, mockRepoId, 'tag');
 
     // Assert
     expect(TFSServices.getItemContent).toHaveBeenCalledWith(
-      `${mockOrgUrl}${mockProjectId}/_apis/git/repositories/${mockRepoId}/refs/tags?api-version=5.1`,
+      `${mockOrgUrl}${mockProjectId}/_apis/git/repositories/${mockRepoId}/refs/tags?peelTags=true&api-version=5.1`,
       mockToken,
       'get'
     );
@@ -577,17 +549,13 @@ describe('GitDataProvider - GetRepoReferences', () => {
       count: 2,
       value: [
         { name: 'refs/heads/main', objectId: 'branch-1' },
-        { name: 'refs/heads/develop', objectId: 'branch-2' }
-      ]
+        { name: 'refs/heads/develop', objectId: 'branch-2' },
+      ],
     };
     (TFSServices.getItemContent as jest.Mock).mockResolvedValueOnce(mockBranches);
 
     // Act
-    const result = await gitDataProvider.GetRepoReferences(
-      mockProjectId,
-      mockRepoId,
-      'branch'
-    );
+    const result = await gitDataProvider.GetRepoReferences(mockProjectId, mockRepoId, 'branch');
 
     // Assert
     expect(TFSServices.getItemContent).toHaveBeenCalledWith(
@@ -604,11 +572,9 @@ describe('GitDataProvider - GetRepoReferences', () => {
 
   it('should throw error for unsupported git object type', async () => {
     // Act & Assert
-    await expect(gitDataProvider.GetRepoReferences(
-      mockProjectId,
-      mockRepoId,
-      'invalid-type'
-    )).rejects.toThrow('Unsupported git object type: invalid-type');
+    await expect(
+      gitDataProvider.GetRepoReferences(mockProjectId, mockRepoId, 'invalid-type')
+    ).rejects.toThrow('Unsupported git object type: invalid-type');
   });
 
   it('should return empty array when no references exist', async () => {
@@ -617,11 +583,7 @@ describe('GitDataProvider - GetRepoReferences', () => {
     (TFSServices.getItemContent as jest.Mock).mockResolvedValueOnce(mockEmptyRefs);
 
     // Act
-    const result = await gitDataProvider.GetRepoReferences(
-      mockProjectId,
-      mockRepoId,
-      'branch'
-    );
+    const result = await gitDataProvider.GetRepoReferences(mockProjectId, mockRepoId, 'branch');
 
     // Assert
     expect(result).toEqual([]);
@@ -648,11 +610,7 @@ describe('GitDataProvider - GetJsonFileFromGitRepo', () => {
     (TFSServices.getItemContent as jest.Mock).mockResolvedValueOnce(mockResponse);
 
     // Act
-    const result = await gitDataProvider.GetJsonFileFromGitRepo(
-      mockProjectName,
-      mockRepoName,
-      mockFilePath
-    );
+    const result = await gitDataProvider.GetJsonFileFromGitRepo(mockProjectName, mockRepoName, mockFilePath);
 
     // Assert
     expect(TFSServices.getItemContent).toHaveBeenCalledWith(
@@ -669,11 +627,9 @@ describe('GitDataProvider - GetJsonFileFromGitRepo', () => {
     (TFSServices.getItemContent as jest.Mock).mockResolvedValueOnce(mockInvalidJson);
 
     // Act & Assert
-    await expect(gitDataProvider.GetJsonFileFromGitRepo(
-      mockProjectName,
-      mockRepoName,
-      mockFilePath
-    )).rejects.toThrow(SyntaxError);
+    await expect(
+      gitDataProvider.GetJsonFileFromGitRepo(mockProjectName, mockRepoName, mockFilePath)
+    ).rejects.toThrow(SyntaxError);
   });
 
   it('should handle API errors appropriately', async () => {
@@ -682,10 +638,8 @@ describe('GitDataProvider - GetJsonFileFromGitRepo', () => {
     (TFSServices.getItemContent as jest.Mock).mockRejectedValueOnce(mockError);
 
     // Act & Assert
-    await expect(gitDataProvider.GetJsonFileFromGitRepo(
-      mockProjectName,
-      mockRepoName,
-      mockFilePath
-    )).rejects.toThrow('API Error');
+    await expect(
+      gitDataProvider.GetJsonFileFromGitRepo(mockProjectName, mockRepoName, mockFilePath)
+    ).rejects.toThrow('API Error');
   });
-});
+});

package/src/modules/test/managmentDataProvider.test.ts

@@ -1,7 +1,9 @@
 import { TFSServices } from '../../helpers/tfs';
 import MangementDataProvider from '../MangementDataProvider';
+import logger from '../../utils/logger';
 
 jest.mock('../../helpers/tfs');
+jest.mock('../../utils/logger');
 
 describe('MangementDataProvider', () => {
   let managementDataProvider: MangementDataProvider;
@@ -19,8 +21,8 @@ describe('MangementDataProvider', () => {
       const mockResponse = {
         value: [
           { id: 'link-1', name: 'Child' },
-          { id: 'link-2', name: 'Related' }
-        ]
+          { id: 'link-2', name: 'Related' },
+        ],
       };
       (TFSServices.getItemContent as jest.Mock).mockResolvedValueOnce(mockResponse);
 
@@ -44,8 +46,7 @@ describe('MangementDataProvider', () => {
       (TFSServices.getItemContent as jest.Mock).mockRejectedValueOnce(expectedError);
 
       // Act & Assert
-      await expect(managementDataProvider.GetCllectionLinkTypes())
-        .rejects.toThrow('API call failed');
+      await expect(managementDataProvider.GetCllectionLinkTypes()).rejects.toThrow('API call failed');
 
       expect(TFSServices.getItemContent).toHaveBeenCalledWith(
         `${mockOrgUrl}_apis/wit/workitemrelationtypes`,
@@ -64,8 +65,8 @@ describe('MangementDataProvider', () => {
         count: 2,
         value: [
           { id: 'project-1', name: 'Project One' },
-          { id: 'project-2', name: 'Project Two' }
-        ]
+          { id: 'project-2', name: 'Project Two' },
+        ],
       };
       (TFSServices.getItemContent as jest.Mock).mockResolvedValueOnce(mockResponse);
 
@@ -86,8 +87,7 @@ describe('MangementDataProvider', () => {
       (TFSServices.getItemContent as jest.Mock).mockRejectedValueOnce(expectedError);
 
       // Act & Assert
-      await expect(managementDataProvider.GetProjects())
-        .rejects.toThrow('Projects API call failed');
+      await expect(managementDataProvider.GetProjects()).rejects.toThrow('Projects API call failed');
 
       expect(TFSServices.getItemContent).toHaveBeenCalledWith(
         `${mockOrgUrl}_apis/projects?$top=1000`,
@@ -103,8 +103,8 @@ describe('MangementDataProvider', () => {
         count: 2,
         value: [
           { id: 'project-1', name: 'Project One' },
-          { id: 'project-2', name: 'Project Two' }
-        ]
+          { id: 'project-2', name: 'Project Two' },
+        ],
       };
       const expectedProject = { id: 'project-2', name: 'Project Two' };
 
@@ -125,8 +125,8 @@ describe('MangementDataProvider', () => {
         count: 2,
         value: [
           { id: 'project-1', name: 'Project One' },
-          { id: 'project-2', name: 'Project Two' }
-        ]
+          { id: 'project-2', name: 'Project Two' },
+        ],
       };
 
       // Mock GetProjects to return our mock data
@@ -147,15 +147,15 @@ describe('MangementDataProvider', () => {
       // Mock GetProjects to throw an error
       jest.spyOn(managementDataProvider, 'GetProjects').mockRejectedValueOnce(expectedError);
 
-      // Mock console.log to capture the error
-      const consoleLogSpy = jest.spyOn(console, 'log');
+      // Mock logger.error to capture the error
+      const loggerErrorSpy = jest.spyOn(logger, 'error');
 
       // Act
       const result = await managementDataProvider.GetProjectByName('Any Project');
 
       // Assert
       expect(managementDataProvider.GetProjects).toHaveBeenCalledTimes(1);
-      expect(consoleLogSpy).toHaveBeenCalledWith(expectedError);
+      expect(loggerErrorSpy).toHaveBeenCalledWith(expectedError);
       expect(result).toEqual({});
     });
   });
@@ -185,8 +185,9 @@ describe('MangementDataProvider', () => {
       (TFSServices.getItemContent as jest.Mock).mockRejectedValueOnce(expectedError);
 
       // Act & Assert
-      await expect(managementDataProvider.GetProjectByID(projectId))
-        .rejects.toThrow('Project API call failed');
+      await expect(managementDataProvider.GetProjectByID(projectId)).rejects.toThrow(
+        'Project API call failed'
+      );
 
       expect(TFSServices.getItemContent).toHaveBeenCalledWith(
         `${mockOrgUrl}_apis/projects/${projectId}`,
@@ -201,7 +202,7 @@ describe('MangementDataProvider', () => {
       const mockResponse = {
         id: 'user-123',
         displayName: 'Test User',
-        emailAddress: 'test@example.com'
+        emailAddress: 'test@example.com',
       };
       (TFSServices.getItemContent as jest.Mock).mockResolvedValueOnce(mockResponse);
 
@@ -222,8 +223,7 @@ describe('MangementDataProvider', () => {
       (TFSServices.getItemContent as jest.Mock).mockRejectedValueOnce(expectedError);
 
       // Act & Assert
-      await expect(managementDataProvider.GetUserProfile())
-        .rejects.toThrow('User profile API call failed');
+      await expect(managementDataProvider.GetUserProfile()).rejects.toThrow('User profile API call failed');
 
       expect(TFSServices.getItemContent).toHaveBeenCalledWith(
         `${mockOrgUrl}_api/_common/GetUserProfile?__v=5`,
@@ -245,6 +245,7 @@ describe('MangementDataProvider', () => {
     expect(provider.token).toBe(customToken);
   });
 });
+
 describe('MangementDataProvider - Additional Tests', () => {
   let managementDataProvider: MangementDataProvider;
   const mockOrgUrl = 'https://dev.azure.com/organization/';
@@ -260,7 +261,7 @@ describe('MangementDataProvider - Additional Tests', () => {
       // Arrange
       const mockEmptyProjects = {
         count: 0,
-        value: []
+        value: [],
       };
       jest.spyOn(managementDataProvider, 'GetProjects').mockResolvedValueOnce(mockEmptyProjects);
 
@@ -275,29 +276,27 @@ describe('MangementDataProvider - Additional Tests', () => {
     it('should handle projects response with missing value property', async () => {
       // Arrange
       const mockInvalidProjects = {
-        count: 0
+        count: 0,
         // no value property
       };
       jest.spyOn(managementDataProvider, 'GetProjects').mockResolvedValueOnce(mockInvalidProjects);
 
-      // Mock console.log to capture the error
-      const consoleLogSpy = jest.spyOn(console, 'log');
+      // Mock logger.error to capture the error
+      const loggerErrorSpy = jest.spyOn(logger, 'error');
 
       // Act
       const result = await managementDataProvider.GetProjectByName('Any Project');
 
       // Assert
       expect(result).toEqual({});
-      expect(consoleLogSpy).toHaveBeenCalled();
+      expect(loggerErrorSpy).toHaveBeenCalled();
     });
 
     it('should be case sensitive when matching project names', async () => {
       // Arrange
       const mockProjects = {
         count: 1,
-        value: [
-          { id: 'project-1', name: 'Project One' }
-        ]
+        value: [{ id: 'project-1', name: 'Project One' }],
       };
       jest.spyOn(managementDataProvider, 'GetProjects').mockResolvedValueOnce(mockProjects);
 
@@ -379,8 +378,8 @@ describe('MangementDataProvider - Additional Tests', () => {
         // Contains unexpected fields
         unusualField: 'unusual value',
         nestedData: {
-          someProperty: 'some value'
-        }
+          someProperty: 'some value',
+        },
       };
       (TFSServices.getItemContent as jest.Mock).mockResolvedValueOnce(unusualProfileData);
 
@@ -391,4 +390,4 @@ describe('MangementDataProvider - Additional Tests', () => {
       expect(result).toEqual(unusualProfileData);
     });
   });
-});
+});