add test case for the validate service

Author: asyncapi-bot

.changeset/1875.md

@@ -0,0 +1,9 @@
+---
+'@asyncapi/cli': minor
+---
+
+feat: add new custom resolver to fetch the reference from private repo
+
+- 88ceb3d:  add new custom resolver to fetch the reference from private repo
+
+

test/unit/services/validation.service.test.ts

@@ -1,6 +1,10 @@
 import { expect } from 'chai';
 import { ValidationService } from '../../../src/domains/services/validation.service';
 import { Specification } from '../../../src/domains/models/SpecificationFile';
+import { ConfigService } from '../../../src/domains/services/config.service';
+import { promises as fs } from 'fs';
+import path from 'path';
+import os from 'os';
 
 const validAsyncAPI = `{
   "asyncapi": "2.6.0",
@@ -24,6 +28,45 @@ const completelyInvalidDocument = `{
   "document": true
 }`;
 
+// Test AsyncAPI documents with external references
+const asyncAPIWithPrivateGitHubRef = `{
+  "asyncapi": "2.6.0",
+  "info": {
+    "title": "Test Service with Private GitHub Ref",
+    "version": "1.0.0"
+  },
+  "channels": {
+    "user/private": {
+      "publish": {
+        "message": {
+          "payload": {
+            "$ref": "https://github.com/private-org/private-repo/blob/main/schema.yaml#/payload"
+          }
+        }
+      }
+    }
+  }
+}`;
+
+const asyncAPIWithPublicHTTPRef = `{
+  "asyncapi": "2.6.0",
+  "info": {
+    "title": "Test Service with Public HTTP Ref",
+    "version": "1.0.0"
+  },
+  "channels": {
+    "user/event": {
+      "publish": {
+        "message": {
+          "payload": {
+            "$ref": "https://raw.githubusercontent.com/asyncapi/spec/master/examples/streetlights.yml#/channels/light/measured/message/payload"
+          }
+        }
+      }
+    }
+  }
+}`;
+
 describe('ValidationService', () => {
   let validationService: ValidationService;
 
@@ -129,4 +172,81 @@ describe('ValidationService', () => {
       }
     });
   });
-});
+
+  describe('validateDocument() with external URLs', () => {
+    let originalConfig: any;
+    const CONFIG_DIR = path.join(os.homedir(), '.asyncapi');
+    const CONFIG_FILE = path.join(CONFIG_DIR, 'config.json');
+
+    beforeEach(async () => {
+      // Backup original config
+      try {
+        const content = await fs.readFile(CONFIG_FILE, 'utf8');
+        originalConfig = JSON.parse(content);
+      } catch (err) {
+        originalConfig = null;
+      }
+    });
+
+    afterEach(async () => {
+      // Restore original config
+      if (originalConfig) {
+        await fs.writeFile(CONFIG_FILE, JSON.stringify(originalConfig, null, 2), 'utf8');
+      } else {
+        try {
+          await fs.unlink(CONFIG_FILE);
+        } catch (err) {
+          // File doesn't exist, ignore
+        }
+      }
+    });
+
+    it('should fail to validate document with private GitHub reference when not properly configured', async () => {
+      // Ensure no auth config exists for private GitHub repository
+      try {
+        await fs.unlink(CONFIG_FILE);
+      } catch (err) {
+        // File doesn't exist, ignore
+      }
+
+      const specFile = new Specification(asyncAPIWithPrivateGitHubRef);
+      const options = {
+        'diagnostics-format': 'stylish' as const
+      };
+
+      const result = await validationService.validateDocument(specFile, options);
+
+      // The validation succeeds but the document is invalid due to unresolved ref
+      expect(result.success).to.equal(true);
+      if (result.success) {
+        expect(result.data).to.have.property('status');
+        expect(result.data?.status).to.equal('invalid');
+        expect(result.data).to.have.property('diagnostics');
+        expect(result.data?.diagnostics).to.be.an('array');
+        
+        // Should have an invalid-ref diagnostic for the private GitHub URL
+        const invalidRefDiagnostic = result.data?.diagnostics?.find((d: any) => d.code === 'invalid-ref');
+        // eslint-disable-next-line no-unused-expressions
+        expect(invalidRefDiagnostic).to.exist;
+        expect(invalidRefDiagnostic?.message).to.include('Page not found');
+        expect(invalidRefDiagnostic?.message).to.include('https://github.com/private-org/private-repo/blob/main/schema.yaml');
+      }
+    });
+
+    it('should validate document with public HTTP reference', async () => {
+      const specFile = new Specification(asyncAPIWithPublicHTTPRef);
+      const options = {
+        'diagnostics-format': 'stylish' as const
+      };
+
+      const result = await validationService.validateDocument(specFile, options);
+
+      expect(result.success).to.equal(true);
+      if (result.success) {
+        expect(result.data).to.have.property('status');
+        expect(result.data).to.have.property('diagnostics');
+        expect(result.data?.diagnostics).to.be.an('array');
+      }
+    });
+  });
+});