summaryrefslogtreecommitdiffstats
path: root/src/usr/targeting/test/testTargetUtil.H
blob: 1cfc8412ff1adcd21c379872c87a4ccff87ea017 (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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/targeting/test/testTargetUtil.H $                     */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* Contributors Listed Below - COPYRIGHT 2011,2019                        */
/* [+] International Business Machines Corp.                              */
/*                                                                        */
/*                                                                        */
/* 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.                         */
/*                                                                        */
/* IBM_PROLOG_END_TAG                                                     */

#ifndef __TEST_TARGETING_UTIL_H
#define __TEST_TARGETING_UTIL_H

/**
 *  @file targeting/test/testTargetUtil.H
 *
 *  @brief Unit test for the templates makeAttribute
 *         and makeAttributeStdArr
 */

//******************************************************************************
// Includes
//******************************************************************************

// CXX TEST
#include <cxxtest/TestSuite.H>

#include <targeting/common/targetUtil.H>

using namespace TARGETING;

//******************************************************************************
// class MakeAttributeTest
//******************************************************************************
class MakeAttributeTest: public CxxTest::TestSuite
{
public:

    /**
     *  @test Test the Make Attribute template
     */
    void testMakeAttribute(void);

    /**
     *  @test Test the Make Attribute for Standard Array template
     */
    void  testMakeAttributeStdArr(void);

};  //  end class MakeAttributeTest

// testMakeAttribute
void MakeAttributeTest::testMakeAttribute(void)
{
    TRACFCOMP( g_trac_test, ENTER_MRK "testMakeAttribute" );

    // Test stats
    uint8_t l_numTests(0);
    uint8_t l_numFails(0);

    if (!TARGETING::targetService().isInitialized())
    {
        TS_FAIL("testMakeAttribute: Target Service is not initialized, "
                "cannot perform test, exiting");

        TRACFCOMP( g_trac_test, EXIT_MRK "testMakeAttribute "
               "num tests = 1  / num fails = 1");
        return;
    }

    // Get the top level target
    TARGETING::Target * l_sys(nullptr);
    TARGETING::targetService().getTopLevelTarget( l_sys );

    if(!l_sys)
    {
        TS_FAIL("testMakeAttribute: Get Top Level Target failed, "
                "unable to get top level target, cannot perform "
                "test, exiting");

        TRACFCOMP( g_trac_test, EXIT_MRK "testMakeAttribute "
               "num tests = 1  / num fails = 1");
        return;
    }

    // Save initial value to restore later
    uint8_t l_simpleTypeRestoreValue =
                       l_sys->getAttr<TARGETING::ATTR_IS_SIMULATION>();

    // Test 1, test a simple attribute with known data
    ++l_numTests;
    do
    {
        // Set the attribute 'Is Simulation' to a known value to
        // facilitate testing
        uint8_t l_isSimulationSet = 1;
        l_sys->setAttr<TARGETING::ATTR_IS_SIMULATION>(l_isSimulationSet);
        uint8_t l_isSimulationReturn =
                       l_sys->getAttr<TARGETING::ATTR_IS_SIMULATION>();

        // Verify setting the attribute worked
        if (l_isSimulationSet != l_isSimulationReturn)
        {
            TS_FAIL("testMakeAttribute: Test 1 - Setting attribute failed "
                    "to initialize attribute to %d but retained "
                    "value at %d, cannot perform test, exiting",
                    l_isSimulationSet,
                    l_isSimulationReturn);
            ++l_numFails;
            break;
        }

        // Retrieve that set attribute back via the 'make attribute' call
        TARGETING::AttributeTank::Attribute l_attribute;
        bool l_return =
                TARGETING::makeAttribute<TARGETING::ATTR_IS_SIMULATION>
                                                  (l_sys, l_attribute);

        // Verify the called worked
        if (true != l_return)
        {
            TS_INFO("testMakeAttribute: Test 1 - Make attribute call failed");
            ++l_numFails;
            break;
        }

        // Get a pointer to the attribute created in make attribute call,
        // to get to the data.
        const uint8_t* l_attributeValue =
                        static_cast<const uint8_t*>(l_attribute.getValue());

        // If the pointer to the data is NULL, then the make attribute did fail
        if (l_attributeValue == nullptr)
        {
            TS_INFO("testMakeAttribute: Test 1 - Getting attribute value "
                    "failed, NULL pointer returned when getting value.");
            ++l_numFails;
            break;
        }

        // Verify the returned attribute matches it's set value
        if (*l_attributeValue != l_isSimulationSet)
        {
           TS_INFO("testMakeAttribute: Test 1 - Retrieved attribute value "
                    "failed, retrieved attribute value(%d) does not "
                    "match set attribute value(%d)",
                    l_isSimulationSet,
                    *l_attributeValue);
            ++l_numFails;
            break;
        }
    }
    while (0);

    // Test 2, test the same simple attribute but with different data
    ++l_numTests;
    do
    {
        // Set the attribute 'Is Simulation' to a known value to
        // facilitate testing
        uint8_t l_isSimulationSet = 5;
        l_sys->setAttr<TARGETING::ATTR_IS_SIMULATION>(l_isSimulationSet);
        uint8_t l_isSimulationReturn =
                       l_sys->getAttr<TARGETING::ATTR_IS_SIMULATION>();

        // Verify setting the attribute worked
        if (l_isSimulationSet != l_isSimulationReturn)
        {
            TS_FAIL("testMakeAttribute: Test 2 - Setting attribute failed "
                    "to initialize attribute to %d but retained "
                    "value at %d, cannot perform test, exiting",
                    l_isSimulationSet,
                    l_isSimulationReturn);
            ++l_numFails;
            break;
        }

        // Retrieve that set attribute back via the 'make attribute' call
        TARGETING::AttributeTank::Attribute l_attribute;
        bool l_return =
                TARGETING::makeAttribute<TARGETING::ATTR_IS_SIMULATION>
                                                  (l_sys, l_attribute);

        // Verify the called worked
        if (true != l_return)
        {
            TS_INFO("testMakeAttribute: Test 2 - Make attribute call failed");
            ++l_numFails;
            break;
        }

        // Get a pointer to the attribute created in make attribute call,
        // to get to the data.
        const uint8_t* l_attributeValue =
                        static_cast<const uint8_t*>(l_attribute.getValue());

        // If the pointer to the data is NULL, then the make attribute did fail
        if (l_attributeValue == nullptr)
        {
            TS_INFO("testMakeAttribute: Test 1 - Getting attribute value "
                    "failed, NULL pointer returned when getting value.");
            ++l_numFails;
            break;
        }

        // Verify the returned attribute matches it's set value
        if (*l_attributeValue != l_isSimulationSet)
        {
           TS_INFO("testMakeAttribute: Test 2 - Retrieved attribute value "
                    "failed, retrieved attribute value(%d) does not "
                    "match set attribute value(%d)",
                    l_isSimulationSet,
                    *l_attributeValue);
            ++l_numFails;
            break;
        }
    }
    while (0);

    // Restore value
    l_sys->setAttr<TARGETING::ATTR_IS_SIMULATION>(l_simpleTypeRestoreValue);

    TRACFCOMP( g_trac_test, EXIT_MRK "testMakeAttribute "
               "num tests = %d  / num fails = %d", l_numTests, l_numFails);
}  // end testMakeAttribute

// testMakeAttributeStdArr
void MakeAttributeTest::testMakeAttributeStdArr(void)
{
    TRACFCOMP( g_trac_test, ENTER_MRK "testMakeAttributeStdArr" );

    // Test stats
    uint8_t l_numTests(0);
    uint8_t l_numFails(0);


    if (!TARGETING::targetService().isInitialized())
    {
        TS_FAIL("testMakeAttributeStdArr: Target Service is not initialized, "
                "cannot perform test, exiting");

        TRACFCOMP( g_trac_test, EXIT_MRK "testMakeAttributeStdArr: "
               "num tests = 1  / num fails = 1");
        return;
    }

    // Get the top level target
    TARGETING::Target * l_sys(nullptr);
    TARGETING::targetService().getTopLevelTarget( l_sys );

    if(!l_sys)
    {
        TS_FAIL("testMakeAttributeStdArr: Get Top Level Target failed, "
                "unable to get top level target, cannot perform "
                "test, exiting");

        TRACFCOMP( g_trac_test, EXIT_MRK "testMakeAttributeStdArr: "
               "num tests = 1  / num fails = 1");
        return;
    }

    // Save initial value to restore later
    TARGETING::ATTR_IPC_NODE_BUFFER_GLOBAL_ADDRESS_typeStdArr
            l_complexTypeRestoreValue;

    // Test 1, test a complex attribute with known data
    ++l_numTests;
    do
    {
        // Set the attribute 'IPC Node Buffer Global Address' to a
        // known value to facilitate testing
        TARGETING::ATTR_IPC_NODE_BUFFER_GLOBAL_ADDRESS_typeStdArr
            l_complexTypeSet = {9, 6, 3, 1, 5, 1, 7, 3};

        if ( !l_sys->trySetAttr<TARGETING::ATTR_IPC_NODE_BUFFER_GLOBAL_ADDRESS>(
                         l_complexTypeSet) )
        {
            TS_FAIL("testMakeAttributeStdArr: Test 1 - can't set "
                    "TARGETING::ATTR_IPC_NODE_BUFFER_GLOBAL_ADDRESS ");
            ++l_numFails;
            break;
        }

        // Do a sanity check and make sure we can set/get attribute via
        // trySetAttr/tryGetAttr
        TARGETING::ATTR_IPC_NODE_BUFFER_GLOBAL_ADDRESS_typeStdArr
            l_complexTypeGet;

        if ( !l_sys->tryGetAttr<TARGETING::ATTR_IPC_NODE_BUFFER_GLOBAL_ADDRESS>(
                         l_complexTypeGet) )
        {
            TS_FAIL("testMakeAttributeStdArr: Test 1 - can't get "
                    "TARGETING::ATTR_IPC_NODE_BUFFER_GLOBAL_ADDRESS ");
            ++l_numFails;
            break;
        }

        // Verify setting the attribute worked
        if (0 != memcmp(&l_complexTypeGet, &l_complexTypeSet,
                         sizeof(l_complexTypeSet)) )
        {
            TS_FAIL("testMakeAttributeStdArr: Test 1 - Setting "
                    "attribute failed, cannot perform test, exiting");
            ++l_numFails;
            break;
        }

        // Retrieved that set attribute back via the 'make attribute' call
        TARGETING::AttributeTank::Attribute l_attribute;
        bool l_return =
                TARGETING::makeAttributeStdArr
                               <TARGETING::ATTR_IPC_NODE_BUFFER_GLOBAL_ADDRESS>
                               (l_sys, l_attribute);

        // Verify the called worked
        if (l_return == false)
        {
            TS_FAIL("testMakeAttributeStdArr: Test 1 - Make "
                    "attribute call failed");
            ++l_numFails;
            break;
        }

        // Get a pointer to the attribute created in make attribute call,
        // to get to the data.
        const uint8_t* l_attributeValue =
                        static_cast<const uint8_t*>(l_attribute.getValue());

        // If the pointer to the data is NULL, then the make attribute did fail
        if (l_attributeValue == nullptr)
        {
            TS_INFO("testMakeAttributeStdArr: Test 1 - Getting attribute value "
                    "failed, NULL pointer returned when getting value.");
            ++l_numFails;
        }

        // Verify the returned attribute matches it's set value
        if (0 != memcmp(l_attributeValue, &l_complexTypeSet,
                         sizeof(l_complexTypeSet)) )
        {
           TS_INFO("testMakeAttributeStdArr: Test 1 - Retrieved attribute "
                   "value failed, expected value and retrieved value do "
                   "not match");
            ++l_numFails;
            break;
        }
    }
    while (0);


    // Test 2, test the same complex attribute but with different data
    ++l_numTests;
    do
    {
        // Set the attribute 'IPC Node Buffer Global Address' to a
        // known value to facilitate testing
        TARGETING::ATTR_IPC_NODE_BUFFER_GLOBAL_ADDRESS_typeStdArr
            l_complexTypeSet = {1, 2, 6, 8, 3, 2, 9, 3};

        if ( !l_sys->trySetAttr<TARGETING::ATTR_IPC_NODE_BUFFER_GLOBAL_ADDRESS>(
                         l_complexTypeSet) )
        {
            TS_FAIL("testMakeAttributeStdArr: Test 2 - can't set "
                    "TARGETING::ATTR_IPC_NODE_BUFFER_GLOBAL_ADDRESS ");
            ++l_numFails;
            break;
        }

        // Do a sanity check and make sure we can set/get attribute via
        // trySetAttr/tryGetAttr
        TARGETING::ATTR_IPC_NODE_BUFFER_GLOBAL_ADDRESS_typeStdArr
            l_complexTypeGet;

        if ( !l_sys->tryGetAttr<TARGETING::ATTR_IPC_NODE_BUFFER_GLOBAL_ADDRESS>(
                         l_complexTypeGet) )
        {
            TS_FAIL("testMakeAttributeStdArr: Test 2 - can't get "
                    "TARGETING::ATTR_IPC_NODE_BUFFER_GLOBAL_ADDRESS ");
            ++l_numFails;
            break;
        }

        // Verify setting the attribute worked
        if (0 != memcmp(&l_complexTypeGet, &l_complexTypeSet,
                         sizeof(l_complexTypeSet)) )
        {
            TS_FAIL("testMakeAttributeStdArr: Test 2 - Setting "
                    "attribute failed, cannot perform test, exiting");
            ++l_numFails;
            break;
        }

        // Retrieved that set attribute back via the 'make attribute' call
        TARGETING::AttributeTank::Attribute l_attribute;
        bool l_return =
                TARGETING::makeAttributeStdArr
                               <TARGETING::ATTR_IPC_NODE_BUFFER_GLOBAL_ADDRESS>
                               (l_sys, l_attribute);

        // Verify the called worked
        if (l_return == false)
        {
            TS_FAIL("testMakeAttributeStdArr: Test 2 - Make "
                    "attribute call failed");
            ++l_numFails;
            break;
        }

        // Get a pointer to the attribute created in make attribute call,
        // to get to the data.
        const uint8_t* l_attributeValue =
                        static_cast<const uint8_t*>(l_attribute.getValue());

        // If the pointer to the data is NULL, then the make attribute did fail
        if (l_attributeValue == nullptr)
        {
            TS_INFO("testMakeAttributeStdArr: Test 2 - Getting attribute value "
                    "failed, NULL pointer returned when getting value.");
            ++l_numFails;
        }

        // Verify the returned attribute matches it's set value
        if (0 != memcmp(l_attributeValue, &l_complexTypeSet,
                         sizeof(l_complexTypeSet)) )
        {
           TS_INFO("testMakeAttributeStdArr: Test 2 - Retrieved attribute "
                   "value failed, expected value and retrieved value do "
                   "not match");
            ++l_numFails;
            break;
        }
    }
    while (0);

    // Restore value
    l_sys->trySetAttr<TARGETING::ATTR_IPC_NODE_BUFFER_GLOBAL_ADDRESS>(
                         l_complexTypeRestoreValue);

    TRACFCOMP( g_trac_test, EXIT_MRK "testMakeAttributeStdArr "
               "num tests = %d  / num fails = %d", l_numTests, l_numFails);

}  // end testMakeAttributeStdArr

#endif  // end __TEST_ATTRIBUTE_H
OpenPOWER on IntegriCloud