Refactor Report Config

src/gmp/commands/__tests__/reportconfig.js

@@ -47,20 +47,20 @@ describe('ReportConfigCommand tests', () => {
       .create({
         name: 'foo',
         comment: 'bar',
-        report_format_id: 'baz',
+        reportFormatId: 'baz',
         params: {
           'param 1': 'value 1',
           'param 2': 'value 2',
           'param 3': ['report-format-1', 'report-format-2'],
           'param 4': ['option-1', 'option-2'],
         },
-        params_using_default: {
+        paramsUsingDefault: {
           'param 1': false,
           'param 2': true,
           'param 3': false,
           'param 4': false,
         },
-        param_types: {
+        paramTypes: {
           'param 1': 'string',
           'param 2': 'text',
           'param 3': 'report_format_list',
@@ -98,20 +98,20 @@ describe('ReportConfigCommand tests', () => {
       .save({
         name: 'foo',
         comment: 'bar',
-        report_format_id: 'should-be-ignored-in-save',
+        reportFormatId: 'should-be-ignored-in-save',
         params: {
           'param 1': 'value A',
           'param 2': 'value B',
           'param 3': ['report-format-A', 'report-format-B'],
           'param 4': ['option-1', 'option-2'],
         },
-        params_using_default: {
+        paramsUsingDefault: {
           'param 1': true,
           'param 2': false,
           'param 3': false,
           'param 4': false,
         },
-        param_types: {
+        paramTypes: {
           'param 1': 'string',
           'param 2': 'text',
           'param 3': 'report_format_list',

src/gmp/commands/reportconfigs.js

@@ -23,35 +23,35 @@ export class ReportConfigCommand extends EntityCommand {
     const {
       comment,
       name,
-      report_format_id,
+      reportFormatId,
       params = {},
-      params_using_default = {},
-      param_types = {},
+      paramsUsingDefault = {},
+      paramTypes = {},
     } = args;
 
     const data = {
       cmd: 'create_report_config',
       name,
       comment,
-      report_format_id,
+      report_format_id: reportFormatId,
     };
 
-    for (const prefname in params) {
-      let value = params[prefname];
+    for (const prefName in params) {
+      let value = params[prefName];
       if (isArray(value)) {
-        if (param_types[prefname] === 'report_format_list') {
-          value = params[prefname].join(',');
+        if (paramTypes[prefName] === 'report_format_list') {
+          value = params[prefName].join(',');
         } else {
-          value = JSON.stringify(params[prefname]);
+          value = JSON.stringify(params[prefName]);
         }
       }
-      data['param:' + prefname] = value;
+      data['param:' + prefName] = value;
     }
 
-    for (const param_name in params_using_default) {
-      if (params_using_default[param_name]) {
+    for (const param_name in paramsUsingDefault) {
+      if (paramsUsingDefault[param_name]) {
         data['param_using_default:' + param_name] = convertBoolean(
-          params_using_default[param_name],
+          paramsUsingDefault[param_name],
         );
       }
     }
@@ -66,8 +66,8 @@ export class ReportConfigCommand extends EntityCommand {
       comment,
       name,
       params = {},
-      params_using_default = {},
-      param_types = {},
+      paramsUsingDefault = {},
+      paramTypes = {},
     } = args;
 
     const data = {
@@ -77,24 +77,24 @@ export class ReportConfigCommand extends EntityCommand {
       comment,
     };
 
-    for (const param_name in params_using_default) {
-      if (params_using_default[param_name]) {
-        data['param_using_default:' + param_name] = convertBoolean(
-          params_using_default[param_name],
+    for (const paramName in paramsUsingDefault) {
+      if (paramsUsingDefault[paramName]) {
+        data['param_using_default:' + paramName] = convertBoolean(
+          paramsUsingDefault[paramName],
         );
       }
     }
 
-    for (const prefname in params) {
-      let value = params[prefname];
-      if (isArray(params[prefname])) {
-        if (param_types[prefname] === 'report_format_list') {
-          value = params[prefname].join(',');
+    for (const prefName in params) {
+      let value = params[prefName];
+      if (isArray(params[prefName])) {
+        if (paramTypes[prefName] === 'report_format_list') {
+          value = params[prefName].join(',');
         } else {
-          value = JSON.stringify(params[prefname]);
+          value = JSON.stringify(params[prefName]);
         }
       }
-      data['param:' + prefname] = value;
+      data['param:' + prefName] = value;
     }
 
     log.debug('Saving report config', args, data);

src/gmp/models/__tests__/reportconfig.js

@@ -19,8 +19,8 @@ describe('Report Config model tests', () => {
     };
     const reportConfig = ReportConfig.fromElement(elem);
 
-    expect(reportConfig.report_format.id).toEqual('foo');
-    expect(reportConfig.report_format.name).toEqual('bar');
+    expect(reportConfig.reportFormat.id).toEqual('foo');
+    expect(reportConfig.reportFormat.name).toEqual('bar');
   });
 
   test('should parse alerts', () => {
@@ -164,7 +164,7 @@ describe('Report Config model tests', () => {
       expect(reportConfig.params[0].name).toEqual('foo');
     });
 
-    test('should parse param value_using_default', () => {
+    test('should parse param valueUsingDefault', () => {
       const elem = {
         param: [
           {
@@ -192,9 +192,9 @@ describe('Report Config model tests', () => {
 
       const reportConfig = ReportConfig.fromElement(elem);
       expect(reportConfig.params[0].name).toEqual('foo');
-      expect(reportConfig.params[0].value_using_default).toEqual(true);
+      expect(reportConfig.params[0].valueUsingDefault).toEqual(true);
       expect(reportConfig.params[1].name).toEqual('bar');
-      expect(reportConfig.params[1].value_using_default).toEqual(false);
+      expect(reportConfig.params[1].valueUsingDefault).toEqual(false);
     });
 
     test('should parse value, default and type in string params', () => {
@@ -229,12 +229,12 @@ describe('Report Config model tests', () => {
       expect(reportConfig.params[0].type).toEqual('string');
       expect(reportConfig.params[0].value).toEqual('foo');
       expect(reportConfig.params[0].default).toEqual('bar');
-      expect(reportConfig.params[0].value_using_default).toEqual(false);
+      expect(reportConfig.params[0].valueUsingDefault).toEqual(false);
 
       expect(reportConfig.params[1].type).toEqual('string');
       expect(reportConfig.params[1].value).toEqual('baz');
       expect(reportConfig.params[1].default).toEqual('boo');
-      expect(reportConfig.params[0].value_using_default).toEqual(false);
+      expect(reportConfig.params[0].valueUsingDefault).toEqual(false);
     });
 
     test('should parse value, default and type in text params', () => {
@@ -269,12 +269,12 @@ describe('Report Config model tests', () => {
       expect(reportConfig.params[0].type).toEqual('text');
       expect(reportConfig.params[0].value).toEqual('foo');
       expect(reportConfig.params[0].default).toEqual('bar');
-      expect(reportConfig.params[0].value_using_default).toEqual(false);
+      expect(reportConfig.params[0].valueUsingDefault).toEqual(false);
 
       expect(reportConfig.params[1].type).toEqual('text');
       expect(reportConfig.params[1].value).toEqual('baz');
       expect(reportConfig.params[1].default).toEqual('boo');
-      expect(reportConfig.params[0].value_using_default).toEqual(false);
+      expect(reportConfig.params[0].valueUsingDefault).toEqual(false);
     });
 
     test('should parse value, default and type in integer params', () => {
@@ -309,12 +309,12 @@ describe('Report Config model tests', () => {
       expect(reportConfig.params[0].type).toEqual('integer');
       expect(reportConfig.params[0].value).toEqual(123);
       expect(reportConfig.params[0].default).toEqual(234);
-      expect(reportConfig.params[0].value_using_default).toEqual(false);
+      expect(reportConfig.params[0].valueUsingDefault).toEqual(false);
 
       expect(reportConfig.params[1].type).toEqual('integer');
       expect(reportConfig.params[1].value).toEqual(345);
       expect(reportConfig.params[1].default).toEqual(456);
-      expect(reportConfig.params[0].value_using_default).toEqual(false);
+      expect(reportConfig.params[0].valueUsingDefault).toEqual(false);
     });
 
     test('should parse value, default and type in boolean params', () => {
@@ -349,12 +349,12 @@ describe('Report Config model tests', () => {
       expect(reportConfig.params[0].type).toEqual('boolean');
       expect(reportConfig.params[0].value).toEqual(false);
       expect(reportConfig.params[0].default).toEqual(true);
-      expect(reportConfig.params[0].value_using_default).toEqual(false);
+      expect(reportConfig.params[0].valueUsingDefault).toEqual(false);
 
       expect(reportConfig.params[1].type).toEqual('boolean');
       expect(reportConfig.params[1].value).toEqual(true);
       expect(reportConfig.params[1].default).toEqual(true);
-      expect(reportConfig.params[0].value_using_default).toEqual(false);
+      expect(reportConfig.params[0].valueUsingDefault).toEqual(false);
     });
 
     test('should parse options, value, default and type in selection params', () => {
@@ -466,23 +466,23 @@ describe('Report Config model tests', () => {
 
       expect(reportConfig.params[0].type).toEqual('report_format_list');
       expect(reportConfig.params[0].value).toEqual(['42', '21']);
-      expect(reportConfig.params[0].value_labels).toEqual({
+      expect(reportConfig.params[0].valueLabels).toEqual({
         42: 'ABC',
         21: 'DEF',
       });
       expect(reportConfig.params[0].default).toEqual(['12', '34']);
-      expect(reportConfig.params[0].default_labels).toEqual({
+      expect(reportConfig.params[0].defaultLabels).toEqual({
         12: 'GHI',
         34: 'JKL',
       });
-      expect(reportConfig.params[0].value_using_default).toEqual(false);
+      expect(reportConfig.params[0].valueUsingDefault).toEqual(false);
 
       expect(reportConfig.params[1].type).toEqual('report_format_list');
       expect(reportConfig.params[1].value).toEqual(['123']);
-      expect(reportConfig.params[1].value_labels).toEqual({123: 'XYZ'});
+      expect(reportConfig.params[1].valueLabels).toEqual({123: 'XYZ'});
       expect(reportConfig.params[1].default).toEqual(['456']);
-      expect(reportConfig.params[1].default_labels).toEqual({456: 'UVW'});
-      expect(reportConfig.params[0].value_using_default).toEqual(false);
+      expect(reportConfig.params[1].defaultLabels).toEqual({456: 'UVW'});
+      expect(reportConfig.params[0].valueUsingDefault).toEqual(false);
     });
   });
 });

src/gmp/models/reportconfig.js

@@ -18,7 +18,7 @@ class Param {
     this.max = type.max;
     this.min = type.min;
     this.type = get_value(type);
-    this.value_using_default = parseBoolean(value?._using_default);
+    this.valueUsingDefault = parseBoolean(value?._using_default);
 
     if (isObject(options)) {
       this.options = map(options.option, opt => {
@@ -34,13 +34,13 @@ class Param {
     if (this.type === 'report_format_list') {
       this.value = map(value.report_format, format => format._id);
       this.default = map(other.default.report_format, format => format._id);
-      this.value_labels = {};
-      this.default_labels = {};
+      this.valueLabels = {};
+      this.defaultLabels = {};
       forEach(value.report_format, format => {
-        this.value_labels[format._id] = format.name;
+        this.valueLabels[format._id] = format.name;
       });
       forEach(other.default.report_format, format => {
-        this.default_labels[format._id] = format.name;
+        this.defaultLabels[format._id] = format.name;
       });
     } else if (this.type === 'multi_selection') {
       this.value = JSON.parse(get_value(value));
@@ -65,13 +65,14 @@ class ReportConfig extends Model {
     const ret = super.parseElement(element);
 
     if (isDefined(ret.report_format)) {
-      ret.report_format = {
+      ret.reportFormat = {
         id: ret.report_format._id,
         name: ret.report_format.name,
       };
     } else {
-      ret.report_format = {};
+      ret.reportFormat = {};
     }
+    delete ret.report_format;
 
     ret.params = map(ret.param, param => {
       return new Param(param);

src/web/pages/reportconfigs/__mocks__/mockreportconfig.jsx

@@ -3,7 +3,6 @@
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 
-
 export const mockReportConfig = {
   _id: '12345',
   name: 'foo',

src/web/pages/reportconfigs/__tests__/component.jsx

@@ -4,7 +4,6 @@
  */
 
 import {describe, test, expect, testing} from '@gsa/testing';
-import Capabilities from 'gmp/capabilities/capabilities';
 import ReportConfig from 'gmp/models/reportconfig';
 import {
   clickElement,
@@ -119,24 +118,19 @@ describe('Report Config Component tests', () => {
     fireEvent.click(saveButton);
 
     expect(saveReportConfig).toHaveBeenCalledWith({
-      alerts: [],
       comment: '',
-      entityType: 'reportconfig',
       id: 'rc123',
       name: 'test report config',
-      param_types: {
+      paramTypes: {
         'test param': 'string',
       },
       params: {
         'test param': 'ABC',
       },
-      params_using_default: {
+      paramsUsingDefault: {
         'test param': false,
       },
-      report_format: 'rf456',
-      report_format_id: undefined,
-      userCapabilities: new Capabilities(),
-      userTags: [],
+      reportFormatId: 'rf456',
     });
   });
 
@@ -210,16 +204,16 @@ describe('Report Config Component tests', () => {
     expect(createReportConfig).toHaveBeenCalledWith({
       name: 'Unnamed',
       comment: '',
-      param_types: {
+      paramTypes: {
         'test param': 'string',
       },
       params: {
         'test param': 'ABC',
       },
-      params_using_default: {
+      paramsUsingDefault: {
         'test param': true,
       },
-      report_format_id: 'rf456',
+      reportFormatId: 'rf456',
     });
   });