fix: enhance Azure DevOps configuration validation for linking and work item checks (#124)

* fix: enhance Azure DevOps configuration validation for linking and work item checks

* fix: update coverage badge to reflect new coverage percentage of 81.38%

* fix: update error messages to clarify required inputs for Azure DevOps validation features

Author: joshjohanning

__tests__/index.test.js

@@ -226,7 +226,7 @@ describe('Azure DevOps Commit Validator', () => {
       await run();
 
       expect(mockSetFailed).toHaveBeenCalledWith(
-        'Azure DevOps organization is required when link-commits-to-pull-request is true'
+        'The following input is required when link-commits-to-pull-request is enabled: azure-devops-organization'
       );
     });
 
@@ -249,11 +249,11 @@ describe('Azure DevOps Commit Validator', () => {
       await run();
 
       expect(mockSetFailed).toHaveBeenCalledWith(
-        'Azure DevOps token is required when link-commits-to-pull-request is true'
+        'The following input is required when link-commits-to-pull-request is enabled: azure-devops-token'
       );
     });
 
-    it('should pass when link-commits-to-pull-request is false even if azure-devops config is missing', async () => {
+    it('should pass when link-commits-to-pull-request is false and validate-work-item-exists is false even if azure-devops config is missing', async () => {
       mockGetInput.mockImplementation(name => {
         const defaults = {
           'check-pull-request': 'false',
@@ -264,7 +264,7 @@ describe('Azure DevOps Commit Validator', () => {
           'azure-devops-organization': '',
           'github-token': 'github-token',
           'comment-on-failure': 'true',
-          'validate-work-item-exists': 'false'
+          'validate-work-item-exists': 'false' // Validation disabled
         };
         return defaults[name] || '';
       });
@@ -278,9 +278,55 @@ describe('Azure DevOps Commit Validator', () => {
 
       await run();
 
-      // Should not call setFailed for missing Azure DevOps config since linking is disabled
+      // Should not call setFailed for missing Azure DevOps config since both features are disabled
       expect(mockSetFailed).not.toHaveBeenCalled();
     });
+
+    it('should fail when validate-work-item-exists is true but azure-devops credentials are missing', async () => {
+      mockGetInput.mockImplementation(name => {
+        const defaults = {
+          'check-pull-request': 'false',
+          'check-commits': 'true',
+          'fail-if-missing-workitem-commit-link': 'true',
+          'link-commits-to-pull-request': 'false', // Linking disabled
+          'azure-devops-token': '',
+          'azure-devops-organization': '',
+          'github-token': 'github-token',
+          'comment-on-failure': 'true',
+          'validate-work-item-exists': 'true' // Validation enabled but no credentials
+        };
+        return defaults[name] || '';
+      });
+
+      await run();
+
+      expect(mockSetFailed).toHaveBeenCalledWith(
+        'The following inputs are required when validate-work-item-exists is enabled: azure-devops-organization, azure-devops-token'
+      );
+    });
+
+    it('should fail when both link-commits-to-pull-request and validate-work-item-exists are true but credentials are missing', async () => {
+      mockGetInput.mockImplementation(name => {
+        const defaults = {
+          'check-pull-request': 'false',
+          'check-commits': 'true',
+          'fail-if-missing-workitem-commit-link': 'true',
+          'link-commits-to-pull-request': 'true', // Linking enabled
+          'azure-devops-token': '',
+          'azure-devops-organization': '',
+          'github-token': 'github-token',
+          'comment-on-failure': 'true',
+          'validate-work-item-exists': 'true' // Validation also enabled
+        };
+        return defaults[name] || '';
+      });
+
+      await run();
+
+      expect(mockSetFailed).toHaveBeenCalledWith(
+        'The following inputs are required when link-commits-to-pull-request or validate-work-item-exists are enabled: azure-devops-organization, azure-devops-token'
+      );
+    });
   });
 
   describe('Commit validation', () => {
@@ -1277,9 +1323,9 @@ describe('Azure DevOps Commit Validator', () => {
 
       await run();
 
-      // Should fail due to missing Azure DevOps organization
+      // Should fail due to missing Azure DevOps organization and token
       expect(mockSetFailed).toHaveBeenCalledWith(
-        'Azure DevOps organization is required when link-commits-to-pull-request is true'
+        'The following inputs are required when link-commits-to-pull-request is enabled: azure-devops-organization, azure-devops-token'
       );
       // Should not call linkWorkItem since validation failed
       expect(mockLinkWorkItem).not.toHaveBeenCalled();

badges/coverage.svg

@@ -56,14 +56,19 @@ export async function run() {
       return;
     }
 
-    // Validate Azure DevOps configuration if linking is enabled
-    if (linkCommitsToPullRequest) {
-      if (!azureDevopsOrganization) {
-        core.setFailed('Azure DevOps organization is required when link-commits-to-pull-request is true');
-        return;
-      }
-      if (!azureDevopsToken) {
-        core.setFailed('Azure DevOps token is required when link-commits-to-pull-request is true');
+    // Validate Azure DevOps configuration if linking or work item validation is enabled
+    if (linkCommitsToPullRequest || validateWorkItemExistsFlag) {
+      const missingConfig = [];
+      if (!azureDevopsOrganization) missingConfig.push('azure-devops-organization');
+      if (!azureDevopsToken) missingConfig.push('azure-devops-token');
+
+      if (missingConfig.length > 0) {
+        const features = [];
+        if (linkCommitsToPullRequest) features.push('link-commits-to-pull-request');
+        if (validateWorkItemExistsFlag) features.push('validate-work-item-exists');
+        core.setFailed(
+          `The following input${missingConfig.length === 1 ? ' is' : 's are'} required when ${features.join(' or ')} ${features.length === 1 ? 'is' : 'are'} enabled: ${missingConfig.join(', ')}`
+        );
         return;
       }
     }