From bcfcda57d7b6d4123c319e2c79487637d5e8c3ed Mon Sep 17 00:00:00 2001 From: Hrithik Katiyar Date: Sat, 27 Apr 2024 22:50:32 +0530 Subject: [PATCH 1/3] APS-10571 Added network_logs_options capability for capture_content --- bin/helpers/utils.js | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/bin/helpers/utils.js b/bin/helpers/utils.js index 4f5438d0..bcc1cd73 100644 --- a/bin/helpers/utils.js +++ b/bin/helpers/utils.js @@ -1217,12 +1217,37 @@ exports.getNetworkErrorMessage = (dashboard_url) => { } exports.setNetworkLogs = (bsConfig) => { - if(bsConfig.run_settings.networkLogs == 'true' || bsConfig.run_settings.networkLogs == true) { + if( + (bsConfig.run_settings.networkLogs == 'true' || bsConfig.run_settings.networkLogs == true) + || (bsConfig.run_settings.network_logs == 'true' || bsConfig.run_settings.network_logs == true) + ) { bsConfig.run_settings.networkLogs = 'true' + bsConfig.run_settings.network_logs = 'true' + if ( + this.isNotUndefined(bsConfig.run_settings.networkLogsOptions) + && typeof(bsConfig.run_settings.networkLogsOptions) === "object" + ){ + bsConfig.run_settings.networkLogsOptions = {capture_content: (bsConfig.run_settings.networkLogsOptions.captureContent || bsConfig.run_settings.networkLogsOptions.capture_content)} + bsConfig.run_settings.network_logs_options = {capture_content: (bsConfig.run_settings.networkLogsOptions.captureContent || bsConfig.run_settings.networkLogsOptions.capture_content)} + } else { + if( + this.isNotUndefined(bsConfig.run_settings.network_logs_options) + && typeof(bsConfig.run_settings.network_logs_options) === "object") { + bsConfig.run_settings.networkLogsOptions = {capture_content: (bsConfig.run_settings.network_logs_options.captureContent || bsConfig.run_settings.network_logs_options.capture_content)} + bsConfig.run_settings.network_logs_options = {capture_content: (bsConfig.run_settings.network_logs_options.captureContent || bsConfig.run_settings.network_logs_options.capture_content)} + } else { + bsConfig.run_settings.networkLogsOptions = null + bsConfig.run_settings.network_logs_options = null + } + } } else { bsConfig.run_settings.networkLogs = 'false' + bsConfig.run_settings.network_logs = 'false' + bsConfig.run_settings.networkLogsOptions = null + bsConfig.run_settings.network_logs_options = null } - logger.debug(`Networks logs value: ${bsConfig.run_settings.networkLogs}`); + logger.debug(`Networks logs value: ${bsConfig.run_settings.network_logs}`); + logger.debug(`Networks logs options value: ${JSON.stringify(bsConfig.run_settings.network_logs_options)}`); } exports.versionChangedMessage = (preferredVersion, actualVersion, frameworkUpgradeMessage = '') => { From 1b5d5c7b4efee4f693334823e27818bcee583ae1 Mon Sep 17 00:00:00 2001 From: Hrithik Katiyar Date: Mon, 29 Apr 2024 12:19:43 +0530 Subject: [PATCH 2/3] APS-10571 Handled camel case and invalid values for capture content --- bin/helpers/utils.js | 29 +++++++++++++++++++++++++---- 1 file changed, 25 insertions(+), 4 deletions(-) diff --git a/bin/helpers/utils.js b/bin/helpers/utils.js index bcc1cd73..a55d7578 100644 --- a/bin/helpers/utils.js +++ b/bin/helpers/utils.js @@ -1217,6 +1217,7 @@ exports.getNetworkErrorMessage = (dashboard_url) => { } exports.setNetworkLogs = (bsConfig) => { + let capture_content = null if( (bsConfig.run_settings.networkLogs == 'true' || bsConfig.run_settings.networkLogs == true) || (bsConfig.run_settings.network_logs == 'true' || bsConfig.run_settings.network_logs == true) @@ -1227,14 +1228,34 @@ exports.setNetworkLogs = (bsConfig) => { this.isNotUndefined(bsConfig.run_settings.networkLogsOptions) && typeof(bsConfig.run_settings.networkLogsOptions) === "object" ){ - bsConfig.run_settings.networkLogsOptions = {capture_content: (bsConfig.run_settings.networkLogsOptions.captureContent || bsConfig.run_settings.networkLogsOptions.capture_content)} - bsConfig.run_settings.network_logs_options = {capture_content: (bsConfig.run_settings.networkLogsOptions.captureContent || bsConfig.run_settings.networkLogsOptions.capture_content)} + if ( + bsConfig.run_settings.networkLogsOptions.captureContent == 'true' + || bsConfig.run_settings.networkLogsOptions.captureContent == true + || bsConfig.run_settings.networkLogsOptions.capture_content == 'true' + || bsConfig.run_settings.networkLogsOptions.capture_content == true + ) { + capture_content = 'true' + } else { + capture_content = 'false' + } + bsConfig.run_settings.networkLogsOptions = {capture_content: capture_content} + bsConfig.run_settings.network_logs_options = {capture_content: capture_content} } else { if( this.isNotUndefined(bsConfig.run_settings.network_logs_options) && typeof(bsConfig.run_settings.network_logs_options) === "object") { - bsConfig.run_settings.networkLogsOptions = {capture_content: (bsConfig.run_settings.network_logs_options.captureContent || bsConfig.run_settings.network_logs_options.capture_content)} - bsConfig.run_settings.network_logs_options = {capture_content: (bsConfig.run_settings.network_logs_options.captureContent || bsConfig.run_settings.network_logs_options.capture_content)} + if ( + bsConfig.run_settings.network_logs_options.captureContent == 'true' + || bsConfig.run_settings.network_logs_options.captureContent == true + || bsConfig.run_settings.network_logs_options.capture_content == 'true' + || bsConfig.run_settings.network_logs_options.capture_content == true + ) { + capture_content = 'true' + } else { + capture_content = 'false' + } + bsConfig.run_settings.networkLogsOptions = {capture_content: capture_content} + bsConfig.run_settings.network_logs_options = {capture_content: capture_content} } else { bsConfig.run_settings.networkLogsOptions = null bsConfig.run_settings.network_logs_options = null From 96fda66cc3a777a3233bf637ad327299dae386ad Mon Sep 17 00:00:00 2001 From: Hrithik Katiyar Date: Mon, 29 Apr 2024 20:23:24 +0530 Subject: [PATCH 3/3] APS-10571 Added test cases for the changes done --- bin/helpers/utils.js | 41 +++++++------ test/unit/bin/helpers/utils.js | 106 +++++++++++++++++++++++++++++++-- 2 files changed, 122 insertions(+), 25 deletions(-) diff --git a/bin/helpers/utils.js b/bin/helpers/utils.js index a55d7578..d7639ee7 100644 --- a/bin/helpers/utils.js +++ b/bin/helpers/utils.js @@ -1238,28 +1238,27 @@ exports.setNetworkLogs = (bsConfig) => { } else { capture_content = 'false' } - bsConfig.run_settings.networkLogsOptions = {capture_content: capture_content} - bsConfig.run_settings.network_logs_options = {capture_content: capture_content} + bsConfig.run_settings.networkLogsOptions = {capture_content} + bsConfig.run_settings.network_logs_options = {capture_content} + } else if ( + this.isNotUndefined(bsConfig.run_settings.network_logs_options) + && typeof(bsConfig.run_settings.network_logs_options) === "object" + ) { + if ( + bsConfig.run_settings.network_logs_options.captureContent == 'true' + || bsConfig.run_settings.network_logs_options.captureContent == true + || bsConfig.run_settings.network_logs_options.capture_content == 'true' + || bsConfig.run_settings.network_logs_options.capture_content == true + ){ + capture_content = 'true' + } else { + capture_content = 'false' + } + bsConfig.run_settings.networkLogsOptions = {capture_content} + bsConfig.run_settings.network_logs_options = {capture_content} } else { - if( - this.isNotUndefined(bsConfig.run_settings.network_logs_options) - && typeof(bsConfig.run_settings.network_logs_options) === "object") { - if ( - bsConfig.run_settings.network_logs_options.captureContent == 'true' - || bsConfig.run_settings.network_logs_options.captureContent == true - || bsConfig.run_settings.network_logs_options.capture_content == 'true' - || bsConfig.run_settings.network_logs_options.capture_content == true - ) { - capture_content = 'true' - } else { - capture_content = 'false' - } - bsConfig.run_settings.networkLogsOptions = {capture_content: capture_content} - bsConfig.run_settings.network_logs_options = {capture_content: capture_content} - } else { - bsConfig.run_settings.networkLogsOptions = null - bsConfig.run_settings.network_logs_options = null - } + bsConfig.run_settings.networkLogsOptions = null + bsConfig.run_settings.network_logs_options = null } } else { bsConfig.run_settings.networkLogs = 'false' diff --git a/test/unit/bin/helpers/utils.js b/test/unit/bin/helpers/utils.js index b4cd5297..c863a3ae 100644 --- a/test/unit/bin/helpers/utils.js +++ b/test/unit/bin/helpers/utils.js @@ -3716,7 +3716,7 @@ describe('utils', () => { run_settings: { networkLogs: true } }; let expectResult = { - run_settings: { networkLogs: 'true' } + run_settings: { networkLogs: 'true', network_logs: 'true', networkLogsOptions: null, network_logs_options: null } } utils.setNetworkLogs(bsConfig); expect(bsConfig).to.be.eql(expectResult); @@ -3727,7 +3727,7 @@ describe('utils', () => { run_settings: { networkLogs: "true" } }; let expectResult = { - run_settings: { networkLogs: "true" } + run_settings: { networkLogs: "true", network_logs: 'true', networkLogsOptions: null, network_logs_options: null } } utils.setNetworkLogs(bsConfig); expect(bsConfig).to.be.eql(expectResult); @@ -3738,7 +3738,7 @@ describe('utils', () => { run_settings: { networkLogs: "abc" } }; let expectResult = { - run_settings: { networkLogs: "false" } + run_settings: { networkLogs: "false", network_logs: 'false', networkLogsOptions: null, network_logs_options: null } } utils.setNetworkLogs(bsConfig); expect(bsConfig).to.be.eql(expectResult); @@ -3749,7 +3749,105 @@ describe('utils', () => { run_settings: { } }; let expectResult = { - run_settings: { networkLogs: "false" } + run_settings: { networkLogs: "false", network_logs: 'false', networkLogsOptions: null, network_logs_options: null } + } + utils.setNetworkLogs(bsConfig); + expect(bsConfig).to.be.eql(expectResult); + }); + + it('should return true if networkLogsOptions.captureContent is passed as boolean true', () => { + let bsConfig = { + run_settings: { networkLogs: true, networkLogsOptions: {captureContent: true} } + }; + let expectResult = { + run_settings: { networkLogs: 'true', network_logs: 'true', networkLogsOptions: {capture_content: 'true'}, network_logs_options: {capture_content: 'true'} } + } + utils.setNetworkLogs(bsConfig); + expect(bsConfig).to.be.eql(expectResult); + }); + + it('should return true if networkLogsOptions.captureContent is passed as string true', () => { + let bsConfig = { + run_settings: { networkLogs: true, networkLogsOptions: {captureContent: 'true'} } + }; + let expectResult = { + run_settings: { networkLogs: 'true', network_logs: 'true', networkLogsOptions: {capture_content: 'true'}, network_logs_options: {capture_content: 'true'} } + } + utils.setNetworkLogs(bsConfig); + expect(bsConfig).to.be.eql(expectResult); + }); + + it('should return false if networkLogsOptions.captureContent is passed as any other non true value', () => { + let bsConfig = { + run_settings: { networkLogs: true, networkLogsOptions: {captureContent: 'abc'} } + }; + let expectResult = { + run_settings: { networkLogs: 'true', network_logs: 'true', networkLogsOptions: {capture_content: 'false'}, network_logs_options: {capture_content: 'false'} } + } + utils.setNetworkLogs(bsConfig); + expect(bsConfig).to.be.eql(expectResult); + }); + + it('should return null if networkLogsOptions.captureContent is not passed', () => { + let bsConfig = { + run_settings: {networkLogs: true, } + }; + let expectResult = { + run_settings: { networkLogs: 'true', network_logs: 'true', networkLogsOptions: null, network_logs_options: null } + } + utils.setNetworkLogs(bsConfig); + expect(bsConfig).to.be.eql(expectResult); + }); + it('should return null if networkLogs is false', () => { + let bsConfig = { + run_settings: { networkLogs: false, networkLogsOptions: {captureContent: true} } + }; + let expectResult = { + run_settings: { networkLogs: 'false', network_logs: 'false', networkLogsOptions: null, network_logs_options: null } + } + utils.setNetworkLogs(bsConfig); + expect(bsConfig).to.be.eql(expectResult); + }); + + it('should return true if network_logs_options.capture_content is passed as boolean true', () => { + let bsConfig = { + run_settings: { network_logs: true, network_logs_options: {capture_content: true} } + }; + let expectResult = { + run_settings: { network_logs: 'true', networkLogs: 'true', network_logs_options: {capture_content: 'true'}, networkLogsOptions: {capture_content: 'true'} } + } + utils.setNetworkLogs(bsConfig); + expect(bsConfig).to.be.eql(expectResult); + }); + + it('should return true if network_logs_options.capture_content is passed as string true', () => { + let bsConfig = { + run_settings: { network_logs: true, network_logs_options: {capture_content: 'true'} } + }; + let expectResult = { + run_settings: { network_logs: 'true', networkLogs: 'true', network_logs_options: {capture_content: 'true'}, networkLogsOptions: {capture_content: 'true'} } + } + utils.setNetworkLogs(bsConfig); + expect(bsConfig).to.be.eql(expectResult); + }); + + it('should return false if network_logs_options.capture_content is passed as any other non true value', () => { + let bsConfig = { + run_settings: { network_logs: true, network_logs_options: {capture_content: 'abc'} } + }; + let expectResult = { + run_settings: { network_logs: 'true', networkLogs: 'true', network_logs_options: {capture_content: 'false'}, networkLogsOptions: {capture_content: 'false'} } + } + utils.setNetworkLogs(bsConfig); + expect(bsConfig).to.be.eql(expectResult); + }); + + it('should return null if network_logs is false', () => { + let bsConfig = { + run_settings: { network_logs: false, network_logs_options: {capture_content: 'true'} } + }; + let expectResult = { + run_settings: { network_logs: 'false', networkLogs: 'false', networkLogsOptions: null, network_logs_options: null } } utils.setNetworkLogs(bsConfig); expect(bsConfig).to.be.eql(expectResult);