#841: code review improvements

Author: JoernBerkefeld

@types/lib/metadataTypes/DataFilter.d.ts.map

@@ -94,7 +94,7 @@ class FileLocation extends MetadataType {
     }
 
     /**
-     * helper for {@link parseResponseBody} that creates a custom key field for this type based on mobileCode and keyword
+     * helper for {@link MetadataType.parseResponseBody} that creates a custom key field for this type based on mobileCode and keyword
      *
      * @param {MetadataTypeItem} metadata single item
      */

lib/metadataTypes/FileLocation.js

@@ -2,7 +2,7 @@
     "fileTransferLocation": {
         "customerKey": "testExisting_fileLocation_aws",
         "name": "testExisting_fileLocation_aws_name",
-        "description": "",
+        "description": "updated via deploy",
         "locationType": "AmazonSimpleStorage",
         "awsFileTransferLocation": {
             "regionName": "eucentral1",

test/resources/9999999/data/v1/filetransferlocation/testExisting_fileLocation_aws/patch-response.json

@@ -1,6 +1,6 @@
 {
     "customerKey": "testExisting_fileLocation_aws",
-    "description": "",
+    "description": "updated via deploy",
     "name": "testExisting_fileLocation_aws_name",
     "awsFileTransferLocation": {
         "accessKeyId": "key-id",

test/resources/9999999/fileLocation/patch-aws-expected.json

@@ -45,20 +45,15 @@ describe('type: fileLocation', () => {
                 'returned JSON was not equal expected'
             );
             assert.deepEqual(
-                await testUtils.getActualJson('testExisting_fileLocation_gcp', 'fileLocation'),
-                await testUtils.getExpectedJson('9999999', 'fileLocation', 'get-gcp'),
+                await testUtils.getActualJson('testExisting_fileLocation_azure', 'fileLocation'),
+                await testUtils.getExpectedJson('9999999', 'fileLocation', 'get-azure'),
                 'returned JSON was not equal expected'
             );
             assert.deepEqual(
                 await testUtils.getActualJson('testExisting_fileLocation_aws', 'fileLocation'),
                 await testUtils.getExpectedJson('9999999', 'fileLocation', 'get-aws'),
                 'returned JSON was not equal expected'
             );
-            assert.deepEqual(
-                await testUtils.getActualJson('testExisting_fileLocation_azure', 'fileLocation'),
-                await testUtils.getExpectedJson('9999999', 'fileLocation', 'get-azure'),
-                'returned JSON was not equal expected'
-            );
             assert.deepEqual(
                 await testUtils.getActualJson('testExisting_fileLocation_exsftp', 'fileLocation'),
                 await testUtils.getExpectedJson('9999999', 'fileLocation', 'get-exsftp'),
@@ -138,9 +133,13 @@ describe('type: fileLocation', () => {
 
         it('Should update fileLocations', async () => {
             // WHEN
-            const deployed = await handler.deploy('testInstance/testBU', ['fileLocation']);
+            const deployed = await handler.deploy(
+                'testInstance/testBU',
+                ['fileLocation'],
+                ['testExisting_fileLocation_exsftp', 'testExisting_fileLocation_aws']
+            );
             // THEN
-            assert.equal(process.exitCode, 1, 'deploy should not have thrown an error');
+            assert.equal(process.exitCode, 0, 'deploy should not have thrown an error');
             // get results from cache
             const result = cache.getCache();
             assert.equal(
@@ -156,6 +155,9 @@ describe('type: fileLocation', () => {
                 'unexpected number of fileLocations deployed'
             );
             // confirm created item
+            // TODO
+
+            // confirm updated item
             assert.deepEqual(
                 await testUtils.getActualJson('testExisting_fileLocation_exsftp', 'fileLocation'),
                 await testUtils.getExpectedJson('9999999', 'fileLocation', 'patch-exsftp'),
@@ -175,6 +177,39 @@ describe('type: fileLocation', () => {
             );
             return;
         });
+
+        it('Should not update fileLocations', async () => {
+            // WHEN
+            const deployed = await handler.deploy(
+                'testInstance/testBU',
+                ['fileLocation'],
+                ['ExactTarget Enhanced FTP']
+            );
+            // THEN
+            assert.equal(process.exitCode, 1, 'deploy should have thrown an error');
+            // get results from cache
+            const result = cache.getCache();
+            assert.equal(
+                result.fileLocation ? Object.keys(result.fileLocation).length : 0,
+                6,
+                'unexpected number of fileLocations in cache'
+            );
+            assert.equal(
+                deployed?.['testInstance/testBU']?.fileLocation
+                    ? Object.keys(deployed['testInstance/testBU'].fileLocation).length
+                    : 0,
+                0,
+                'unexpected number of fileLocations deployed'
+            );
+
+            // check number of API calls
+            assert.equal(
+                testUtils.getAPIHistoryLength(),
+                2,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
+            );
+            return;
+        });
     });
 
     describe('Templating ================', () => {