Merge pull request #170 from pactumjs/169-data-template-removes

feat: add removes property in data templates
pactumjs · Jun 13, 2022 · 36f52eb · 36f52eb
2 parents a61d428 + 83e66d0
commit 36f52eb
Show file tree

Hide file tree

Showing 4 changed files with 93 additions and 2 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "pactum",
-  "version": "3.1.9",
+  "version": "3.1.10",
   "description": "REST API Testing Tool for all levels in a Test Pyramid",
   "main": "./src/index.js",
   "types": "./src/index.d.ts",

diff --git a/src/helpers/dataProcessor.js b/src/helpers/dataProcessor.js
@@ -54,6 +54,7 @@ const dataProcessor = {
     if (!data) return data;
     const templateName = data['@DATA:TEMPLATE@'];
     const overrides = data['@OVERRIDES@'];
+    const removes = data['@REMOVES@'] || [];
     if (templateName) {
       const templateValue = this.template[templateName];
       if (templateValue) {
@@ -63,6 +64,7 @@ const dataProcessor = {
           override(data, overrides);
           data = this.processDataTemplates(data);
         }
+        removes.forEach(_key => delete data[_key]);
       } else {
         log.warn(`Template Not Found - ${templateName}`);
       }

diff --git a/test/unit/dataProcessor.spec.js b/test/unit/dataProcessor.spec.js
@@ -160,6 +160,95 @@ describe('Data Processing - Templates', () => {
     expect(config.data.template.processed).equals(true);
   });
 
+  it('processTemplates - removes single property', () => {
+    stash.addDataTemplate({
+      'User': {
+        'Name': 'Snow',
+        'Address': {
+          '@DATA:TEMPLATE@': 'Address',
+          '@REMOVES@': ['Zip']
+        }
+      },
+      'Address': {
+        'Street': 'Main',
+        'Zip': '524004'
+      }
+    });
+    dp.processTemplates();
+    expect(dp.template).deep.equals({
+      'User': {
+        'Name': 'Snow',
+        'Address': {
+          'Street': 'Main'
+        }
+      },
+      'Address': {
+        'Street': 'Main',
+        'Zip': '524004'
+      }
+    });
+    expect(config.data.template.enabled).equals(true);
+    expect(config.data.template.processed).equals(true);
+  });
+
+  it('processTemplates - removes multiple properties', () => {
+    stash.addDataTemplate({
+      'User': {
+        'Name': 'Snow',
+        'Address': {
+          '@DATA:TEMPLATE@': 'Address',
+          '@REMOVES@': ['Zip', 'Street']
+        }
+      },
+      'Address': {
+        'Street': 'Main',
+        'Zip': '524004'
+      }
+    });
+    dp.processTemplates();
+    expect(dp.template).deep.equals({
+      'User': {
+        'Name': 'Snow',
+        'Address': {}
+      },
+      'Address': {
+        'Street': 'Main',
+        'Zip': '524004'
+      }
+    });
+    expect(config.data.template.enabled).equals(true);
+    expect(config.data.template.processed).equals(true);
+  });
+
+  it('processTemplates - removes non existing properties', () => {
+    stash.addDataTemplate({
+      'User': {
+        'Name': 'Snow',
+        'Address': {
+          '@DATA:TEMPLATE@': 'Address',
+          '@REMOVES@': ['Zip', 'Street', 'Pin']
+        }
+      },
+      'Address': {
+        'Street': 'Main',
+        'Zip': '524004'
+      }
+    });
+    dp.processTemplates();
+    expect(dp.template).deep.equals({
+      'User': {
+        'Name': 'Snow',
+        'Address': {}
+      },
+      'Address': {
+        'Street': 'Main',
+        'Zip': '524004'
+      }
+    });
+    expect(config.data.template.enabled).equals(true);
+    expect(config.data.template.processed).equals(true);
+  });
+
   afterEach(() => {
     config.data.template.enabled = false;
     config.data.template.processed = false;