Merge pull request #32 from cap-js/addDefaults

Adding default title and version

Author: RoshniNaveenaS

CHANGELOG.md

@@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
 ## Version 1.0.3 - TBD
 
+### Added
+
+- Added defaults for `@AsyncAPI.SchemaVersion` and `@AsyncAPI.Title`.
+
 ### Changed
 
 - Replaced `console.warn` statements with `cds.debug` logs for warning messages.

lib/compile/index.js

@@ -158,7 +158,8 @@ function getInfoObject(serviceCsn, mergedPresetObject = undefined) {
     }
 
     if (!serviceCsn['@AsyncAPI.SchemaVersion'] || !serviceCsn['@AsyncAPI.Title']) {
-        throw new Error(messages.TITLE_VERSION_ANNOTATIONS);
+        serviceCsn['@AsyncAPI.SchemaVersion'] = '1.0.0';
+        serviceCsn['@AsyncAPI.Title'] = `Use @title: '...' on your CDS service to provide a meaningful title.`;
     }
 
     isVersionValid(serviceCsn['@AsyncAPI.SchemaVersion']);

lib/compile/message.js

@@ -5,7 +5,6 @@ const errorMessages = {
     NAMESPACE_MISMATCH: 'ORD and AsyncAPI namespaces should be same.',
     TITLE_VERSION_MERGED: 'Preset for Title and Version info needs to be added when merged flag is used.',
     NO_EVENTS: 'No events found in the service.',
-    TITLE_VERSION_ANNOTATIONS: 'Title and Version info annotations needs to be added to the service(s).',
     UNSUPPORTED_VERSION: 'The version value provided is unsupported.',
     NO_SERVICES: 'There are no service definitions found in the given model(s).',
     MERGED_FLAG: 'Merged flag cannot be used with single service definition.',

test/lib/compile/asyncapiMetadata.test.js

@@ -81,10 +81,12 @@ describe('asyncapi export: presets and annotations', () => {
         expect(() => toAsyncAPI(csn)).toThrowError("There are no service definitions found in the given model(s).");
     });
 
-    test('Negative test for version', async () => {
+    test('Check for default title and version if not provided in the input', async () => {
         const inputCDS = await read(join(baseInputPath, 'invalid', 'noTitle.cds'));
         const csn = cds.compile.to.csn(inputCDS);
-        expect(() => toAsyncAPI(csn)).toThrowError("Title and Version info annotations needs to be added to the service(s).");
+        const generatedAsyncAPI = toAsyncAPI(csn);
+        expect(generatedAsyncAPI).toHaveProperty('info.title', `Use @title: '...' on your CDS service to provide a meaningful title.`);
+        expect(generatedAsyncAPI).toHaveProperty('info.version', '1.0.0');
     });
 
     test('Test for application namespace', async () => {