aboutsummaryrefslogtreecommitdiffstats
path: root/gui-clamp/ui-react/src/utils/CsvToJson.test.js
blob: e36e85554cc07c7b4c392cf8b272e0b60e98571f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
/*-
 * ============LICENSE_START=======================================================
 * ONAP CLAMP
 * ================================================================================
 * Copyright (C) 2019 AT&T Intellectual Property. All rights
 *                             reserved.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * ============LICENSE_END============================================
 * ===================================================================
 *
 */

import CsvToJson from './CsvToJson'

describe('Verify CsvToJson', () => {

  const hdrNames = [
    "Element Short Name",
    "Element Name",
    "Element Description",
    "Element Type",
    "Sub-Dictionary"
  ];

  const jsonKeyNames = [
    "shortName",
    "name",
    "description",
    "type",
    "subDictionary"
  ];

  const mandatory = [true, true, true, true, false];

  it('Test CsvToJson No Error Case, Quoted Columns', () => {

    let rawCsv = '"Element Short Name","Element Name","Element Description","Element Type","Sub-Dictionary"\n';
    rawCsv += '"alertType","Alert Type","Type of Alert","string","","admin","2020-06-11T13:56:14.927437Z"';

    let expectedResult = {
      errorMessages: '',
      jsonObjArray: [
        {
          description: "Type of Alert",
          name: "Alert Type",
          shortName: "alertType",
          subDictionary: "",
          type: "string"
        }
      ]
    };

    expect(CsvToJson(rawCsv, ',', '|', hdrNames, jsonKeyNames, mandatory)).toEqual(expectedResult);
  });

  it('Test CsvToJson No Error Case, Unquoted Columns', () => {

    let rawCsv = 'Element Short Name,Element Name,Element Description,Element Type,Sub-Dictionary\n';
    rawCsv += 'alertType,Alert Type,Type of Alert,string,,admin,2020-06-11T13:56:14.927437Z';

    let expectedResult = {
      errorMessages: '',
      jsonObjArray: [
        {
          description: "Type of Alert",
          name: "Alert Type",
          shortName: "alertType",
          subDictionary: "",
          type: "string"
        }
      ]
    };

    expect(CsvToJson(rawCsv, ',', '|', hdrNames, jsonKeyNames, mandatory)).toEqual(expectedResult);
  });

  it('Test CsvToJson Properly Escaped Double Quote and Delimiter', () => {

    let rawCsv = '"Element Short Name","Element Name","Element Description","Element Type","Sub-Dictionary"\n';
    rawCsv += '"alertType","Alert ""Type""","Type of Alert, Varies","string","","admin","2020-06-11T13:56:14.927437Z"';

    let errorMessage = '';

    let expectedResult = {
      errorMessages: errorMessage,
      jsonObjArray: [
        {
          description: "Type of Alert, Varies",
          name: 'Alert "Type"',
          shortName: 'alertType',
          subDictionary: "",
          type: "string",
        }

      ]
    };

    expect(CsvToJson(rawCsv, ',', '|', hdrNames, jsonKeyNames, mandatory)).toEqual(expectedResult);
  });


  it('Test CsvToJson Error Header Mismatch Error Case', () => {

    let rawCsv = '"Element Short Names","Element Name","Element Description","Element Type","Sub-Dictionary"\n';
    rawCsv += '"alertType","Alert Type","Type of Alert","string","","admin","2020-06-11T13:56:14.927437Z"';

    let errorMessage = 'Row 1 header key at column #1 is a mismatch. Expected row header must contain at least:\n';
    errorMessage += 'Element Short Name,Element Name,Element Description,Element Type,Sub-Dictionary';

    let expectedResult = {
      errorMessages: errorMessage,
      jsonObjArray: []
    };

    expect(CsvToJson(rawCsv, ',', '|', hdrNames, jsonKeyNames, mandatory)).toEqual(expectedResult);
  });

  it('Test CsvToJson Error Mismatched Double Quotes in Column', () => {

    let rawCsv = '"Element Short Name","Element Name","Element Description","Element Type","Sub-Dictionary"\n';
    rawCsv += '"alert"Type","Alert Type","Type of Alert","string","","admin","2020-06-11T13:56:14.927437Z"';

    let errorMessage = '\nRow #2 is badly formatted at column #1. Perhaps an unescaped double quote.'

    let expectedResult = {
      errorMessages: errorMessage,
      jsonObjArray: []
    };

    expect(CsvToJson(rawCsv, ',', '|', hdrNames, jsonKeyNames, mandatory)).toEqual(expectedResult);
  });

  it('Test CsvToJson Error Illegal Whitespace', () => {

    let rawCsv = '"Element Short Name","Element Name","Element Description","Element Type","Sub-Dictionary"\n';
    rawCsv += 'alertType ,  "Alert Type","Type of Alert","string","","admin","2020-06-11T13:56:14.927437Z"';

    let errorMessage = '\nMismatched double quotes or illegal whitespace around delimiter at row #2 near column #2';

    let expectedResult = {
      errorMessages: errorMessage,
      jsonObjArray: []
    };

    expect(CsvToJson(rawCsv, ',', '|', hdrNames, jsonKeyNames, mandatory)).toEqual(expectedResult);
  });

  it('Test CsvToJson Error Too Few Data Columns', () => {

    let rawCsv = '"Element Short Name","Element Name","Element Description","Element Type","Sub-Dictionary"\n';
    rawCsv += '"alertType","Alert Type","Type of Alert"';

    let errorMessage = '\nNot enough columns (5) at row #2';

    let expectedResult = {
      errorMessages: errorMessage,
      jsonObjArray: []
    };

    expect(CsvToJson(rawCsv, ',', '|', hdrNames, jsonKeyNames, mandatory)).toEqual(expectedResult);
  });

  it('Test CsvToJson Error Wrong Header Column Order', () => {

    let rawCsv = '"Element Name","Element Short Name","Element Description","Element Type","Sub-Dictionary"\n';
    rawCsv += '"alertType","Alert Type","Type of Alert","string","","admin","2020-06-11T13:56:14.927437Z"';

    let errorMessage = 'Row 1 header key at column #1 is a mismatch. Expected row header must contain at least:\n';
    errorMessage += 'Element Short Name,Element Name,Element Description,Element Type,Sub-Dictionary';

    let expectedResult = {
      errorMessages: errorMessage,
      jsonObjArray: []
    };

    expect(CsvToJson(rawCsv, ',', '|', hdrNames, jsonKeyNames, mandatory)).toEqual(expectedResult);
  });

  it('Test CsvToJson Error Not Enough Rows', () => {

    let rawCsv = '"Element Short Name","Element Name","Element Description","Element Type","Sub-Dictionary"\n';

    let errorMessage = '\nNot enough row data found in import file. Need at least a header row and one row of data';

    let expectedResult = {
      errorMessages: errorMessage,
      jsonObjArray: []
    };

    expect(CsvToJson(rawCsv, ',', '|', hdrNames, jsonKeyNames, mandatory)).toEqual(expectedResult);
  });

  it('Test CsvToJson Error Mandatory Field Is Empty', () => {

    let rawCsv = '"Element Short Name","Element Name","Element Description","Element Type","Sub-Dictionary"\n';
    rawCsv += '"","Alert Type","Type of Alert","string","","admin","2020-06-11T13:56:14.927437Z"';

    let expectedResult = {
      errorMessages: '\nElement Short Name at row #2 is empty but requires a value.',
      jsonObjArray: []
    };

    expect(CsvToJson(rawCsv, ',', '|', hdrNames, jsonKeyNames, mandatory)).toEqual(expectedResult);
  });

  it('Test CsvToJson Error Mismatched Double Quotes At End', () => {

    let rawCsv = '"Element Short Name","Element Name","Element Description","Element Type","Sub-Dictionary"\n';
    rawCsv += '"alertType","Alert Type","Alert Type Description","string","admin","2020-06-11T13:56:14.927437Z';

    let expectedResult = {
      errorMessages: '\nMismatched double quotes at row #2',
      jsonObjArray: []
    };

    expect(CsvToJson(rawCsv, ',', '||', hdrNames, jsonKeyNames, mandatory)).toEqual(expectedResult);
  });

  it('Test CsvToJson Error Mismatched Mandatory Array Parameters', () => {

    let rawCsv = '"Element Short Name","Element Name","Element Description","Element Type","Sub-Dictionary"\n';
    rawCsv += '"alertType","Alert Type","Alert Type Description","string","admin","2020-06-11T13:56:14.927437Z';

    let expectedResult = {
      errorMessages: 'interanl error: csvHeaderNames, jsonKeyNames, and mandatory arrays parameters are not the same length',
      jsonObjArray: []
    };

    expect(CsvToJson(rawCsv, ',', '||', hdrNames, jsonKeyNames, [true])).toEqual(expectedResult);
  });

  it('Test CsvToJson Error Empty Mandatory Array Parameters', () => {

    let rawCsv = '"Element Short Name","Element Name","Element Description","Element Type","Sub-Dictionary"\n';
    rawCsv += '"alertType","Alert Type","Alert Type Description","string","admin","2020-06-11T13:56:14.927437Z';

    let expectedResult = {
      errorMessages: 'interanl error: csvHeaderNames, jsonKeyNames, and mandatory arrays have no entries',
      jsonObjArray: []
    };

    expect(CsvToJson(rawCsv, ',', '||', [], [], [])).toEqual(expectedResult);
  });

  it('Test CsvToJson Error Illegal Data Contains Internal Delimiter', () => {

    let rawCsv = '"Element Short Name","Element Name","Element Description","Element Type","Sub-Dictionary"\n';
    rawCsv += '"alertType","Alert Type","Alert Type||Description","string","admin","2020-06-11T13:56:14.927437Z';

    let expectedResult = {
      errorMessages: '\nRow #1 contains illegal sequence of characters (||)',
      jsonObjArray: []
    };

    expect(CsvToJson(rawCsv, ',', '||', hdrNames, jsonKeyNames, mandatory)).toEqual(expectedResult);
  });
})