fix(cicero-core): setReadme() now preserves logo in Metadata (#874)

Author: Divyansh2992

packages/cicero-core/src/template.js

@@ -78,7 +78,7 @@ class Template {
         if (options.verifySignature) {
             this.verifyTemplateSignature();
         }
-        if(options && options.offline) {
+        if (options && options.offline) {
             this.getModelManager().validateModelFiles();
         }
         else {
@@ -153,7 +153,7 @@ class Template {
      * @private
      */
     _normalize(str) {
-        if(str && typeof str === 'string') {
+        if (str && typeof str === 'string') {
             return str.replace(/\r/g, '');
         }
         return str;
@@ -183,7 +183,7 @@ class Template {
             });
         }
 
-        if(this.getTemplate()) {
+        if (this.getTemplate()) {
             content.grammar = this._normalize(this.getTemplate());
         }
         content.models = {};
@@ -300,7 +300,7 @@ class Template {
      * @param {Object} [options] - an optional set of options to configure the instance.
      * @return {Promise<Template>} a Promise to the instantiated template
      */
-    static async fromDirectory(path, options=null) {
+    static async fromDirectory(path, options = null) {
         return TemplateLoader.fromDirectory(Template, path, options);
     }
 
@@ -310,7 +310,7 @@ class Template {
      * @param {Object} [options] - an optional set of options to configure the instance.
      * @return {Promise<Template>} a Promise to the template
      */
-    static async fromArchive(buffer, options=null) {
+    static async fromArchive(buffer, options = null) {
         return TemplateLoader.fromArchive(Template, buffer, options);
     }
 
@@ -320,7 +320,7 @@ class Template {
      * @param {Object} [options] - an optional set of options to configure the instance.
      * @return {Promise} a Promise to the template
      */
-    static async fromUrl(url, options=null) {
+    static async fromUrl(url, options = null) {
         return TemplateLoader.fromUrl(Template, url, options);
     }
 
@@ -426,7 +426,7 @@ class Template {
      * @private
      */
     setReadme(readme) {
-        this.metadata = new Metadata(this.metadata.getPackageJson(), readme, this.metadata.getSamples(), this.metadata.getRequest());
+        this.metadata = new Metadata(this.metadata.getPackageJson(), readme, this.metadata.getSamples(), this.metadata.getRequest(), this.metadata.getLogo());
     }
 
     /**

packages/cicero-core/test/template.js

@@ -444,13 +444,43 @@ describe('Template', () => {
     });
 
     describe('#setReadme', () => {
+        it('should preserve the logo after calling setReadme', async () => {
+            const template = await Template.fromDirectory('./test/data/template-logo', options);
+            template.getMetadata().getLogo().should.be.an.instanceof(Buffer);
+            template.setReadme('new readme text');
+            template.getMetadata().getLogo().should.be.an.instanceof(Buffer);
+        });
 
         it('should not throw for valid readme text', async () => {
             const template = await Template.fromDirectory('./test/data/latedeliveryandpenalty', options);
             return (() => template.setReadme('readme text')).should.not.throw();
         });
     });
 
+    describe('Metadata regression tests', () => {
+        it('should preserve the logo after calling setSamples', async () => {
+            const template = await Template.fromDirectory('./test/data/template-logo', options);
+            template.getMetadata().getLogo().should.be.an.instanceof(Buffer);
+            template.setSamples({ default: 'new sample' });
+            template.getMetadata().getLogo().should.be.an.instanceof(Buffer);
+        });
+
+        it('should preserve the logo after calling setRequest', async () => {
+            const template = await Template.fromDirectory('./test/data/template-logo', options);
+            const newRequest = { $class: 'logo@0.0.1.Request' };
+            template.setRequest(newRequest);
+            template.getMetadata().getLogo().should.be.an.instanceof(Buffer);
+        });
+
+        it('should preserve the logo after calling setPackageJson', async () => {
+            const template = await Template.fromDirectory('./test/data/template-logo', options);
+            const pkg = template.getMetadata().getPackageJson();
+            pkg.name = 'new_name';
+            template.setPackageJson(pkg);
+            template.getMetadata().getLogo().should.be.an.instanceof(Buffer);
+        });
+    });
+
     describe('#getRequestTypes', () => {
 
         it('should return request types for single accordclauselogic function', async () => {