Changelog unit tests

Author: cesarParra

src/core/changelog/__test__/helpers/custom-field-metadata-builder.ts

@@ -0,0 +1,28 @@
+import { CustomFieldMetadata } from '../../../reflection/sobject/reflect-custom-field-source';
+
+export default class CustomFieldMetadataBuilder {
+  name: string = 'MyField';
+  description: string | null = null;
+
+  withName(name: string): CustomFieldMetadataBuilder {
+    this.name = name;
+    return this;
+  }
+
+  withDescription(testDescription: string) {
+    this.description = testDescription;
+    return this;
+  }
+
+  build(): CustomFieldMetadata {
+    return {
+      type: 'Text',
+      type_name: 'customfield',
+      label: 'MyField',
+      name: this.name,
+      description: this.description,
+      parentName: 'MyObject',
+      required: false,
+    };
+  }
+}

src/core/changelog/__test__/helpers/custom-metadata-metadata-builder.ts

@@ -0,0 +1,22 @@
+import { CustomMetadataMetadata } from '../../../reflection/sobject/reflect-custom-metadata-source';
+
+export default class CustomMetadataMetadataBuilder {
+  parentName: string = 'MyObject';
+  name: string = 'FieldName__c';
+
+  withName(name: string): CustomMetadataMetadataBuilder {
+    this.name = name;
+    return this;
+  }
+
+  build(): CustomMetadataMetadata {
+    return {
+      type_name: 'custommetadata',
+      apiName: `${this.parentName}.${this.name}`,
+      protected: false,
+      label: 'MyMetadata',
+      name: this.name,
+      parentName: this.parentName,
+    };
+  }
+}

src/core/changelog/__test__/helpers/custom-object-metadata-builder.ts

@@ -0,0 +1,32 @@
+import { CustomFieldMetadata } from '../../../reflection/sobject/reflect-custom-field-source';
+import { CustomObjectMetadata } from '../../../reflection/sobject/reflect-custom-object-sources';
+import { CustomMetadataMetadata } from '../../../reflection/sobject/reflect-custom-metadata-source';
+
+export default class CustomObjectMetadataBuilder {
+  label: string = 'MyObject';
+  fields: CustomFieldMetadata[] = [];
+  metadataRecords: CustomMetadataMetadata[] = [];
+
+  withField(field: CustomFieldMetadata): CustomObjectMetadataBuilder {
+    this.fields.push(field);
+    return this;
+  }
+
+  withMetadataRecord(metadataRecord: CustomMetadataMetadata): CustomObjectMetadataBuilder {
+    this.metadataRecords.push(metadataRecord);
+    return this;
+  }
+
+  build(): CustomObjectMetadata {
+    return {
+      type_name: 'customobject',
+      deploymentStatus: 'Deployed',
+      visibility: 'Public',
+      label: this.label,
+      name: 'MyObject',
+      description: null,
+      fields: this.fields,
+      metadataRecords: this.metadataRecords,
+    };
+  }
+}

src/core/changelog/__test__/processing-changelog.spec.ts

@@ -1,7 +1,8 @@
 import { processChangelog } from '../process-changelog';
 import { reflect, Type } from '@cparra/apex-reflection';
-import { CustomObjectMetadata } from '../../reflection/sobject/reflect-custom-object-sources';
-import { CustomFieldMetadata } from '../../reflection/sobject/reflect-custom-field-source';
+import CustomFieldMetadataBuilder from './helpers/custom-field-metadata-builder';
+import CustomObjectMetadataBuilder from './helpers/custom-object-metadata-builder';
+import CustomMetadataMetadataBuilder from './helpers/custom-metadata-metadata-builder';
 
 function apexTypeFromRawString(raw: string): Type {
   const result = reflect(raw);
@@ -12,56 +13,6 @@ function apexTypeFromRawString(raw: string): Type {
   return result.typeMirror!;
 }
 
-class CustomFieldMetadataBuilder {
-  name: string = 'MyField';
-  description: string | null = null;
-
-  withName(name: string): CustomFieldMetadataBuilder {
-    this.name = name;
-    return this;
-  }
-
-  withDescription(testDescription: string) {
-    this.description = testDescription;
-    return this;
-  }
-
-  build(): CustomFieldMetadata {
-    return {
-      type: 'Text',
-      type_name: 'customfield',
-      label: 'MyField',
-      name: this.name,
-      description: this.description,
-      parentName: 'MyObject',
-      required: false,
-    };
-  }
-}
-
-class CustomObjectMetadataBuilder {
-  label: string = 'MyObject';
-  fields: CustomFieldMetadata[] = [];
-
-  withField(field: CustomFieldMetadata): CustomObjectMetadataBuilder {
-    this.fields.push(field);
-    return this;
-  }
-
-  build(): CustomObjectMetadata {
-    return {
-      type_name: 'customobject',
-      deploymentStatus: 'Deployed',
-      visibility: 'Public',
-      label: this.label,
-      name: 'MyObject',
-      description: null,
-      fields: this.fields,
-      metadataRecords: [],
-    };
-  }
-}
-
 describe('when generating a changelog', () => {
   it('has no new types when both the old and new versions are empty', () => {
     const oldVersion = { types: [] };
@@ -669,4 +620,71 @@ describe('when generating a changelog', () => {
       ]);
     });
   });
+
+  describe('with custom metadata records', () => {
+    it('does not list custom metadata records that are the same in both versions', () => {
+      // The record uniqueness is determined by its api name.
+
+      const oldCustomMetadata = new CustomMetadataMetadataBuilder().build();
+      const newCustomMetadata = new CustomMetadataMetadataBuilder().build();
+
+      const oldManifest = { types: [oldCustomMetadata] };
+      const newManifest = { types: [newCustomMetadata] };
+
+      const changeLog = processChangelog(oldManifest, newManifest);
+
+      expect(changeLog.customObjectModifications).toEqual([]);
+    });
+
+    it('lists new records of a custom object', () => {
+      const oldObject = new CustomObjectMetadataBuilder()
+        .withMetadataRecord(new CustomMetadataMetadataBuilder().build())
+        .build();
+      const newObject = new CustomObjectMetadataBuilder()
+        .withMetadataRecord(new CustomMetadataMetadataBuilder().build())
+        .withMetadataRecord(new CustomMetadataMetadataBuilder().withName('NewField__c').build())
+        .build();
+
+      const oldManifest = { types: [oldObject] };
+      const newManifest = { types: [newObject] };
+
+      const changeLog = processChangelog(oldManifest, newManifest);
+
+      expect(changeLog.customObjectModifications).toEqual([
+        {
+          typeName: newObject.name,
+          modifications: [
+            {
+              __typename: 'NewCustomMetadataRecord',
+              name: 'NewField__c',
+            },
+          ],
+        },
+      ]);
+    });
+
+    it('lists removed records of a custom object', () => {
+      const oldObject = new CustomObjectMetadataBuilder()
+        .withMetadataRecord(new CustomMetadataMetadataBuilder().withName('OldField__c').build())
+        .build();
+      const newObject = new CustomObjectMetadataBuilder().build();
+
+      const oldManifest = { types: [oldObject] };
+      const newManifest = { types: [newObject] };
+
+      const changeLog = processChangelog(oldManifest, newManifest);
+
+      expect(changeLog.customObjectModifications).toEqual([
+        {
+          typeName: oldObject.name,
+          modifications: [
+            {
+              __typename: 'RemovedCustomMetadataRecord',
+              name: 'OldField__c',
+            },
+          ],
+        },
+      ]);
+    });
+  });
 });