1 #ifndef __DALI_TEST_SUITE_UTILS_H__
2 #define __DALI_TEST_SUITE_UTILS_H__
5 * Copyright (c) 2015 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
26 #include <dali/public-api/dali-core.h>
28 void tet_infoline(const char*str);
29 void tet_printf(const char *format, ...);
31 #include "test-application.h"
32 #include "test-actor-utils.h"
36 #define STRINGIZE_I(text) #text
37 #define STRINGIZE(text) STRINGIZE_I(text)
39 // the following is the other compilers way of token pasting, gcc seems to just concatenate strings automatically
40 //#define TOKENPASTE(x,y) x ## y
41 #define TOKENPASTE(x,y) x y
42 #define TOKENPASTE2(x,y) TOKENPASTE( x, y )
43 #define TEST_LOCATION TOKENPASTE2( "Test failed in ", TOKENPASTE2( __FILE__, TOKENPASTE2( ", line ", STRINGIZE(__LINE__) ) ) )
49 extern int test_return_value;
51 void tet_result(int value);
54 return ((test_return_value>0)?1:0)
56 void tet_infoline(const char* str);
57 void tet_printf(const char *format, ...);
60 * DALI_TEST_CHECK is a wrapper for tet_result.
61 * If the condition evaluates to false, the test is stopped.
62 * @param[in] The boolean expression to check
64 #define DALI_TEST_CHECK(condition) \
67 tet_result(TET_PASS); \
71 fprintf(stderr, "%s Failed in %s at line %d\n", __PRETTY_FUNCTION__, __FILE__, __LINE__); \
72 tet_result(TET_FAIL); \
76 template <typename Type>
77 inline bool CompareType(Type value1, Type value2, float epsilon);
80 * A helper for fuzzy-comparing Vector2 objects
81 * @param[in] vector1 the first object
82 * @param[in] vector2 the second object
83 * @param[in] epsilon difference threshold
84 * @returns true if difference is smaller than epsilon threshold, false otherwise
87 inline bool CompareType<float>(float value1, float value2, float epsilon)
89 return fabsf(value1 - value2) < epsilon;
93 * A helper for fuzzy-comparing Vector2 objects
94 * @param[in] vector1 the first object
95 * @param[in] vector2 the second object
96 * @param[in] epsilon difference threshold
97 * @returns true if difference is smaller than epsilon threshold, false otherwise
100 inline bool CompareType<Vector2>(Vector2 vector1, Vector2 vector2, float epsilon)
102 return fabsf(vector1.x - vector2.x)<epsilon && fabsf(vector1.y - vector2.y)<epsilon;
106 * A helper for fuzzy-comparing Vector3 objects
107 * @param[in] vector1 the first object
108 * @param[in] vector2 the second object
109 * @param[in] epsilon difference threshold
110 * @returns true if difference is smaller than epsilon threshold, false otherwise
113 inline bool CompareType<Vector3>(Vector3 vector1, Vector3 vector2, float epsilon)
115 return fabsf(vector1.x - vector2.x)<epsilon &&
116 fabsf(vector1.y - vector2.y)<epsilon &&
117 fabsf(vector1.z - vector2.z)<epsilon;
122 * A helper for fuzzy-comparing Vector4 objects
123 * @param[in] vector1 the first object
124 * @param[in] vector2 the second object
125 * @param[in] epsilon difference threshold
126 * @returns true if difference is smaller than epsilon threshold, false otherwise
129 inline bool CompareType<Vector4>(Vector4 vector1, Vector4 vector2, float epsilon)
131 return fabsf(vector1.x - vector2.x)<epsilon &&
132 fabsf(vector1.y - vector2.y)<epsilon &&
133 fabsf(vector1.z - vector2.z)<epsilon &&
134 fabsf(vector1.w - vector2.w)<epsilon;
138 inline bool CompareType<Quaternion>(Quaternion q1, Quaternion q2, float epsilon)
140 Quaternion q2N = -q2; // These quaternions represent the same rotation
141 return CompareType<Vector4>(q1.mVector, q2.mVector, epsilon) || CompareType<Vector4>(q1.mVector, q2N.mVector, epsilon);
145 inline bool CompareType<Radian>(Radian q1, Radian q2, float epsilon)
147 return CompareType<float>(q1.radian, q2.radian, epsilon);
151 inline bool CompareType<Degree>(Degree q1, Degree q2, float epsilon)
153 return CompareType<float>(q1.degree, q2.degree, epsilon);
157 inline bool CompareType<Property::Value>(Property::Value q1, Property::Value q2, float epsilon)
159 Property::Type type = q1.GetType();
160 if( type != q2.GetType() )
167 case Property::BOOLEAN:
175 case Property::INTEGER:
183 case Property::FLOAT:
188 return CompareType<float>(a, b, epsilon);
191 case Property::VECTOR2:
196 return CompareType<Vector2>(a, b, epsilon);
199 case Property::VECTOR3:
204 return CompareType<Vector3>(a, b, epsilon);
207 case Property::RECTANGLE:
208 case Property::VECTOR4:
213 return CompareType<Vector4>(a, b, epsilon);
216 case Property::ROTATION:
221 return CompareType<Quaternion>(a, b, epsilon);
232 bool operator==(TimePeriod a, TimePeriod b);
233 std::ostream& operator<<( std::ostream& ostream, TimePeriod value );
234 std::ostream& operator<<( std::ostream& ostream, Radian angle );
235 std::ostream& operator<<( std::ostream& ostream, Degree angle );
238 * Test whether two values are equal.
239 * @param[in] value1 The first value
240 * @param[in] value2 The second value
241 * @param[in] location The TEST_LOCATION macro should be used here
243 template<typename Type>
244 inline void DALI_TEST_EQUALS(Type value1, Type value2, const char* location)
246 if (!(value1 == value2))
248 std::ostringstream o;
249 o << value1 << " == " << value2 << std::endl;
250 fprintf(stderr, "%s, checking %s", location, o.str().c_str());
251 tet_result(TET_FAIL);
255 tet_result(TET_PASS);
259 template<typename Type>
260 inline void DALI_TEST_EQUALS(Type value1, Type value2, float epsilon, const char* location)
262 if( !CompareType<Type>(value1, value2, epsilon) )
264 std::ostringstream o;
265 o << value1 << " == " << value2 << std::endl;
266 fprintf(stderr, "%s, checking %s", location, o.str().c_str());
267 tet_result(TET_FAIL);
271 tet_result(TET_PASS);
275 template<typename Type>
276 inline void DALI_TEST_NOT_EQUALS(Type value1, Type value2, float epsilon, const char* location)
278 if( CompareType<Type>(value1, value2, epsilon) )
280 std::ostringstream o;
281 o << value1 << " != " << value2 << std::endl;
282 fprintf(stderr, "%s, checking %s", location, o.str().c_str());
283 tet_result(TET_FAIL);
287 tet_result(TET_PASS);
293 * Test whether two TimePeriods are within a certain distance of each other.
294 * @param[in] value1 The first value
295 * @param[in] value2 The second value
296 * @param[in] epsilon The values must be within this distance of each other
297 * @param[in] location The TEST_LOCATION macro should be used here
300 inline void DALI_TEST_EQUALS<TimePeriod>( TimePeriod value1, TimePeriod value2, float epsilon, const char* location)
302 if ((fabs(value1.durationSeconds - value2.durationSeconds) > epsilon))
304 fprintf(stderr, "%s, checking durations %f == %f, epsilon %f\n", location, value1.durationSeconds, value2.durationSeconds, epsilon);
305 tet_result(TET_FAIL);
307 else if ((fabs(value1.delaySeconds - value2.delaySeconds) > epsilon))
309 fprintf(stderr, "%s, checking delays %f == %f, epsilon %f\n", location, value1.delaySeconds, value2.delaySeconds, epsilon);
310 tet_result(TET_FAIL);
314 tet_result(TET_PASS);
319 * Test whether two base handles are equal.
320 * @param[in] baseHandle1 The first value
321 * @param[in] baseHandle2 The second value
322 * @param[in] location The TEST_LOCATION macro should be used here
324 void DALI_TEST_EQUALS( const BaseHandle& baseHandle1, const BaseHandle& baseHandle2, const char* location );
327 * Test whether a size_t value and an unsigned int are equal.
328 * @param[in] value1 The first value
329 * @param[in] value2 The second value
330 * @param[in] location The TEST_LOCATION macro should be used here
332 void DALI_TEST_EQUALS( const size_t value1, const unsigned int value2, const char* location );
335 * Test whether an unsigned int and a size_t value and are equal.
336 * @param[in] value1 The first value
337 * @param[in] value2 The second value
338 * @param[in] location The TEST_LOCATION macro should be used here
340 void DALI_TEST_EQUALS( const unsigned int value1, const size_t value2, const char* location );
343 * Test whether two Matrix3 objects are equal.
344 * @param[in] matrix1 The first object
345 * @param[in] matrix2 The second object
346 * @param[in] location The TEST_LOCATION macro should be used here
348 void DALI_TEST_EQUALS( const Matrix3& matrix1, const Matrix3& matrix2, const char* location);
350 /** Test whether two Matrix3 objects are equal (fuzzy compare).
351 * @param[in] matrix1 The first object
352 * @param[in] matrix2 The second object
353 * @param[in] epsilon The epsilon to use for comparison
354 * @param[in] location The TEST_LOCATION macro should be used here
356 void DALI_TEST_EQUALS( const Matrix3& matrix1, const Matrix3& matrix2, float epsilon, const char* location);
359 * Test whether two Matrix objects are equal.
360 * @param[in] matrix1 The first object
361 * @param[in] matrix2 The second object
362 * @param[in] location The TEST_LOCATION macro should be used here
364 void DALI_TEST_EQUALS( const Matrix& matrix1, const Matrix& matrix2, const char* location);
367 * Test whether two Matrix objects are equal (fuzzy-compare).
368 * @param[in] matrix1 The first object
369 * @param[in] matrix2 The second object
370 * @param[in] location The TEST_LOCATION macro should be used here
372 void DALI_TEST_EQUALS( const Matrix& matrix1, const Matrix& matrix2, float epsilon, const char* location);
375 * Test whether two strings are equal.
376 * @param[in] str1 The first string
377 * @param[in] str2 The second string
378 * @param[in] location The TEST_LOCATION macro should be used here
381 inline void DALI_TEST_EQUALS<const char*>( const char* str1, const char* str2, const char* location)
383 if (strcmp(str1, str2))
385 fprintf(stderr, "%s, checking '%s' == '%s'\n", location, str1, str2);
386 tet_result(TET_FAIL);
390 tet_result(TET_PASS);
395 * Test whether two strings are equal.
396 * @param[in] str1 The first string
397 * @param[in] str2 The second string
398 * @param[in] location The TEST_LOCATION macro should be used here
401 inline void DALI_TEST_EQUALS<const std::string&>( const std::string &str1, const std::string &str2, const char* location)
403 DALI_TEST_EQUALS(str1.c_str(), str2.c_str(), location);
407 * Test whether two strings are equal.
408 * @param[in] str1 The first string
409 * @param[in] str2 The second string
410 * @param[in] location The TEST_LOCATION macro should be used here
412 void DALI_TEST_EQUALS( Property::Value& str1, const char* str2, const char* location);
415 * Test whether two strings are equal.
416 * @param[in] str1 The first string
417 * @param[in] str2 The second string
418 * @param[in] location The TEST_LOCATION macro should be used here
420 void DALI_TEST_EQUALS( const std::string &str1, const char* str2, const char* location);
423 * Test whether two strings are equal.
424 * @param[in] str1 The first string
425 * @param[in] str2 The second string
426 * @param[in] location The TEST_LOCATION macro should be used here
428 void DALI_TEST_EQUALS( const char* str1, const std::string &str2, const char* location);
431 * Test whether one unsigned integer value is greater than another.
432 * Test succeeds if value1 > value2
433 * @param[in] value1 The first value
434 * @param[in] value2 The second value
435 * @param[in] location The TEST_LOCATION macro should be used here
437 template< typename T >
438 void DALI_TEST_GREATER( T value1, T value2, const char* location)
440 if (!(value1 > value2))
442 std::cerr << location << ", checking " << value1 <<" > " << value2 << "\n";
443 tet_result(TET_FAIL);
447 tet_result(TET_PASS);
452 * Test whether the assertion condition that failed and thus triggered the
453 * exception \b e contained a given substring.
454 * @param[in] e The exception that we expect was fired by a runtime assertion failure.
455 * @param[in] conditionSubString The text that we expect to be present in an
456 * assertion which triggered the exception.
457 * @param[in] location The TEST_LOCATION macro should be used here.
459 void DALI_TEST_ASSERT( DaliException& e, std::string conditionSubString, const char* location );
463 * @param[in] e The exception that we expect was fired by a runtime assertion failure.
465 inline void DALI_TEST_PRINT_ASSERT( DaliException& e )
467 tet_printf("Assertion %s failed at %s\n", e.condition, e.location );
470 // Functor to test whether an Applied signal is emitted
471 struct ConstraintAppliedCheck
473 ConstraintAppliedCheck( bool& signalReceived );
474 void operator()( Constraint& constraint );
476 void CheckSignalReceived();
477 void CheckSignalNotReceived();
478 bool& mSignalReceived; // owned by individual tests
482 * A Helper to test default functions
484 template <typename T>
485 struct DefaultFunctionCoverage
487 DefaultFunctionCoverage()
498 // Helper to Create buffer image
499 BufferImage CreateBufferImage();
500 BufferImage CreateBufferImage(int width, int height, const Vector4& color);
502 // Test namespace to prevent pollution of Dali namespace, add Test helper functions here
508 * Helper to check object destruction occurred
509 * 1) In main part of code create an ObjectDestructionTracker
510 * 2) Within sub section of main create object Actor test and call Start with Actor to test for destruction
511 * 3) Perform code which is expected to destroy Actor
512 * 4) Back in main part of code use IsDestroyed() to test if Actor was destroyed
514 class ObjectDestructionTracker : public ConnectionTracker
521 * Call in main part of code
523 ObjectDestructionTracker();
526 * @brief Call in sub bock of code where the Actor being checked is still alive.
528 * @param[in] actor Actor to be checked for destruction
530 void Start( Actor actor );
533 * @brief Call to check if Actor alive or destroyed.
534 * @return bool true if Actor was destroyed
539 bool mRefObjectDestroyed;
544 #endif // __DALI_TEST_SUITE_UTILS_H__