r20807 - gnucash/trunk/src/libqof/qof/test - [GSOC2011 Unit Testing] Unit tests for QofInstance.

John Ralls jralls at code.gnucash.org
Thu Jun 30 13:06:35 EDT 2011


Author: jralls
Date: 2011-06-30 13:06:35 -0400 (Thu, 30 Jun 2011)
New Revision: 20807
Trac: http://svn.gnucash.org/trac/changeset/20807

Modified:
   gnucash/trunk/src/libqof/qof/test/test-qofinstance.c
Log:
[GSOC2011 Unit Testing] Unit tests for QofInstance.
Author: Muslim Chochlov

Modified: gnucash/trunk/src/libqof/qof/test/test-qofinstance.c
===================================================================
--- gnucash/trunk/src/libqof/qof/test/test-qofinstance.c	2011-06-27 21:13:21 UTC (rev 20806)
+++ gnucash/trunk/src/libqof/qof/test/test-qofinstance.c	2011-06-30 17:06:35 UTC (rev 20807)
@@ -41,11 +41,546 @@
 static void
 teardown( Fixture *fixture, gconstpointer pData )
 {
-    qof_book_destroy( qof_instance_get_book( fixture->instance ) );
-    g_object_unref(fixture->instance);
+    g_object_unref(fixture->inst);
 }
 
 static void
+test_instance_set_get_book( Fixture *fixture, gconstpointer pData )
+{
+    QofBook *book;
+    
+    /* set up */
+    book = qof_book_new();
+    
+    g_assert( QOF_IS_INSTANCE( fixture->inst ) );
+    
+    g_test_message( "Setting and getting book" );
+    qof_instance_set_book( fixture->inst, book );
+    g_assert( book == qof_instance_get_book( fixture->inst ) );
+    
+    g_test_message( "Getting book when instance is null" );
+    g_assert( qof_instance_get_book( NULL ) == NULL );
+    
+    /* Clean up */
+    qof_book_destroy( book );
+}
+
+static void
+test_instance_set_get_guid( Fixture *fixture, gconstpointer pData )
+{
+    GncGUID *gncGuid;
+    
+    /* on null instance deprecated getter returns empty guid
+     * while instance_get_guid returns null
+     */
+    g_assert( !qof_instance_get_guid( NULL ) );
+    g_assert( qof_entity_get_guid( NULL ) == guid_null() );
+    
+    /* set up */
+    gncGuid = guid_malloc();
+    guid_new( gncGuid );
+    g_assert( QOF_IS_INSTANCE( fixture->inst ) );
+    g_assert( gncGuid );
+    
+    /* guid already exists after instance init */
+    g_test_message( "Setting new guid" );
+    g_assert( qof_instance_get_guid( fixture->inst ) );
+    g_assert( !guid_equal( gncGuid, qof_instance_get_guid( fixture->inst ) ) );
+    qof_instance_set_guid( fixture->inst, gncGuid );
+    g_assert( guid_equal( gncGuid, qof_instance_get_guid( fixture->inst ) ) );
+    g_assert( guid_equal( gncGuid, qof_entity_get_guid( fixture->inst ) ) );
+    
+    /* Clean up */
+    guid_free( gncGuid );
+}
+
+static void
+test_instance_new_destroy( void )
+{
+    /* qofinstance var */
+    QofInstance *inst;
+    QofInstanceClass *klass;
+    /* test var */
+    Timespec timespec_priv;
+  
+    g_test_message( "Testing qofinstance object initialization" );
+    inst = g_object_new(QOF_TYPE_INSTANCE, NULL);
+    g_assert( QOF_IS_INSTANCE( inst ) );
+    /* test class fields */
+    klass = QOF_INSTANCE_GET_CLASS( inst );
+    g_assert( QOF_IS_INSTANCE_CLASS( klass ) );
+    g_assert( klass->get_display_name == NULL );
+    g_assert( klass->refers_to_object == NULL );
+    g_assert( klass->get_typed_referring_object_list == NULL );
+    /* testing initial values */
+    g_assert( qof_instance_get_guid( inst ) );
+    g_assert( !qof_instance_get_collection( inst ) );
+    g_assert( qof_instance_get_book( inst ) == NULL );
+    g_assert( inst->kvp_data );
+    timespec_priv = qof_instance_get_last_update( inst );
+    g_assert_cmpint( timespec_priv.tv_sec, ==, 0 );
+    g_assert_cmpint( timespec_priv.tv_nsec, ==, -1 );
+    g_assert_cmpint( qof_instance_get_editlevel( inst ), ==, 0 );
+    g_assert( !qof_instance_get_destroying( inst ) );
+    g_assert( !qof_instance_get_dirty_flag( inst ) );
+    g_assert( qof_instance_get_infant( inst ) );
+    g_assert_cmpint( qof_instance_get_version( inst ), ==, 0 );
+    g_assert_cmpint( qof_instance_get_version_check( inst ), ==, 0 );
+    g_assert_cmpint( qof_instance_get_idata( inst ), ==, 0 );
+    
+    g_test_message( "Testing object destruction" );
+    g_object_unref( inst );
+    /* test fields were deinitialized */
+    g_assert( inst );
+    g_assert( !QOF_IS_INSTANCE( inst ) );
+    /* set fatal handler */
+    g_test_log_set_fatal_handler ( ( GTestLogFatalFunc )fatal_handler, NULL );
+    g_assert( qof_instance_get_collection( inst ) == NULL );
+    g_assert( g_strrstr( error_message, "assertion `QOF_IS_INSTANCE(ptr)' failed" ) != NULL );
+    g_free( error_message );
+    
+    g_assert_cmpint( qof_instance_get_editlevel( inst ), ==, 0 );
+    g_assert( g_strrstr( error_message, "assertion `QOF_IS_INSTANCE(ptr)' failed" ) != NULL );
+    g_free( error_message );
+    
+    g_assert( !qof_instance_get_destroying( inst ) );
+    g_assert( g_strrstr( error_message, "assertion `QOF_IS_INSTANCE(ptr)' failed" ) != NULL );
+    g_free( error_message );
+    
+    g_assert( !qof_instance_get_dirty_flag( inst ) );
+    g_assert( g_strrstr( error_message, "assertion `QOF_IS_INSTANCE(ptr)' failed" ) != NULL );
+    g_free( error_message );
+}
+
+static void
+test_instance_init_data( void )
+{
+    QofInstance *inst;
+    QofIdType test_type = "test type";
+    QofBook *book;
+    QofCollection *col;
+    const GncGUID *gncguid;
+    char guid_id_before[GUID_ENCODING_LENGTH + 1];
+    char guid_id_after[GUID_ENCODING_LENGTH + 1];
+    
+    /* set up */
+    inst = g_object_new( QOF_TYPE_INSTANCE, NULL );
+    g_assert( QOF_IS_INSTANCE( inst ) );
+    book = qof_book_new();
+    g_assert( QOF_IS_BOOK( book ) );
+    /* set fatal handler */
+    g_test_log_set_fatal_handler ( ( GTestLogFatalFunc )fatal_handler, NULL );
+    
+    g_test_message( "Running test with correct initial data" );
+    gncguid = qof_instance_get_guid( inst );
+    g_assert( gncguid );
+    guid_to_string_buff( gncguid, guid_id_before );
+    g_assert( qof_instance_get_book( inst ) == NULL );
+    g_assert( qof_instance_get_collection( inst ) == NULL );
+    /* run init */
+    qof_instance_init_data( inst, test_type, book );
+    
+    g_assert( qof_instance_get_book( inst ) == book );
+    guid_to_string_buff( gncguid, guid_id_after );
+    g_assert_cmpstr( guid_id_before, !=, guid_id_after );
+    g_assert( qof_instance_get_collection( inst ) != NULL );
+    col = qof_book_get_collection( book, test_type );
+    g_assert( col );
+    g_assert( col == qof_instance_get_collection( inst ) );
+    g_assert_cmpstr( inst->e_type, ==, test_type );
+    g_assert( qof_collection_lookup_entity( qof_instance_get_collection( inst ), gncguid ) == inst );
+        
+    /* clean up */
+    g_object_unref( inst );
+    qof_book_destroy( book );
+}
+
+static void
+test_instance_get_set_slots( Fixture *fixture, gconstpointer pData )
+{
+    KvpFrame *kvp_frame, *kvp_frame2;
+    
+    /* set up */
+    g_assert( fixture->inst );
+    kvp_frame = qof_instance_get_slots( fixture->inst );
+    g_assert( kvp_frame );
+    
+    g_test_message( "Test when kvp frame is the same" );
+    qof_instance_set_slots( fixture->inst, kvp_frame );
+    g_assert( kvp_frame == qof_instance_get_slots( fixture->inst ) );
+    g_assert( qof_instance_get_dirty_flag( fixture->inst ) );
+
+    g_test_message( "Test when kvp frame is not the same" );
+    kvp_frame2 = kvp_frame_new();
+    g_assert( kvp_frame != kvp_frame2 );
+    qof_instance_set_slots( fixture->inst, kvp_frame2 );
+    g_assert( kvp_frame2 == qof_instance_get_slots( fixture->inst ) );
+    g_assert( qof_instance_get_dirty_flag( fixture->inst ) );
+    
+    g_test_message( "Test when kvp frame is null" );
+    qof_instance_set_slots( fixture->inst, NULL );
+    g_assert( NULL == qof_instance_get_slots( fixture->inst ) );
+    g_assert( qof_instance_get_dirty_flag( fixture->inst ) );
+    
+}
+
+static void
+test_instance_version_cmp( void )
+{
+    QofInstance *left, *right;
+    int result;
+    Timespec timespec_left, timespec_right;
+    
+    /* set up*/
+    left = g_object_new( QOF_TYPE_INSTANCE, NULL );
+    right = g_object_new( QOF_TYPE_INSTANCE, NULL );
+    
+    g_test_message( "Test both null" );
+    result = qof_instance_version_cmp( NULL, NULL );
+    g_assert_cmpint( result, ==, 0 );
+    
+    g_test_message( "Test left null" );
+    result = qof_instance_version_cmp( NULL, right );
+    g_assert_cmpint( result, ==, -1 );
+    
+    g_test_message( "Test right null" );
+    result = qof_instance_version_cmp( left, NULL );
+    g_assert_cmpint( result, ==, 1 );
+    
+    g_test_message( "Test left tv_sec lesser than right" );
+    timespec_left.tv_sec = 0;
+    timespec_right.tv_sec = 1;
+    qof_instance_set_last_update( left, timespec_left );
+    qof_instance_set_last_update( right, timespec_right );
+    result = qof_instance_version_cmp( left, right );
+    g_assert_cmpint( result, ==, -1 );
+    
+    g_test_message( "Test right tv_sec lesser than left" );
+    timespec_left.tv_sec = 1;
+    timespec_right.tv_sec = 0;
+    qof_instance_set_last_update( left, timespec_left );
+    qof_instance_set_last_update( right, timespec_right );
+    result = qof_instance_version_cmp( left, right );
+    g_assert_cmpint( result, ==, 1 );
+    
+    g_test_message( "Test left tv_nsec lesser than right" );
+    timespec_left.tv_sec = 1;
+    timespec_left.tv_nsec = 0;
+    timespec_right.tv_sec = 1;
+    timespec_right.tv_nsec = 1;
+    qof_instance_set_last_update( left, timespec_left );
+    qof_instance_set_last_update( right, timespec_right );
+    result = qof_instance_version_cmp( left, right );
+    g_assert_cmpint( result, ==, -1 );
+    
+    g_test_message( "Test right tv_sec lesser than left" );
+    timespec_left.tv_sec = 1;
+    timespec_left.tv_nsec = 1;
+    timespec_right.tv_sec = 1;
+    timespec_right.tv_nsec = 0;
+    qof_instance_set_last_update( left, timespec_left );
+    qof_instance_set_last_update( right, timespec_right );
+    result = qof_instance_version_cmp( left, right );
+    g_assert_cmpint( result, ==, 1 );
+    
+    g_test_message( "Test both equal" );
+    timespec_left.tv_sec = 1;
+    timespec_left.tv_nsec = 1;
+    timespec_right.tv_sec = 1;
+    timespec_right.tv_nsec = 1;
+    qof_instance_set_last_update( left, timespec_left );
+    qof_instance_set_last_update( right, timespec_right );
+    result = qof_instance_version_cmp( left, right );
+    g_assert_cmpint( result, ==, 0 );
+    
+    /* clear */
+    g_object_unref( left );
+    g_object_unref( right );
+}
+
+static void
+test_instance_get_set_dirty( Fixture *fixture, gconstpointer pData )
+{
+    QofIdType type = "test type";
+    QofCollection *col;
+    
+    /* setup */
+    col = qof_collection_new ( type );
+    qof_instance_set_collection( fixture->inst, col );
+    g_assert( qof_instance_get_collection( fixture->inst ) );
+    
+    g_test_message( "Test get_dirty on empty instance returns false" );
+    g_assert( qof_instance_get_dirty( NULL ) == FALSE );
+    
+    g_test_message( "Test dirty in normal mode" );
+    g_assert( !qof_get_alt_dirty_mode() ); 
+    g_assert( !qof_instance_get_dirty_flag( fixture->inst ) );
+    g_assert( !qof_collection_is_dirty( col ) );
+    g_assert( !qof_instance_get_dirty( fixture->inst ) );
+    qof_instance_set_dirty( fixture->inst );
+    g_assert( qof_instance_get_dirty_flag( fixture->inst ) );
+    g_assert( qof_collection_is_dirty( col ) );
+    g_assert( qof_instance_get_dirty( fixture->inst ) );
+    
+    
+    g_test_message( "Test dirty in alternate mode" );
+    qof_set_alt_dirty_mode ( TRUE );
+    /* restore */
+    qof_collection_mark_clean( col );
+    qof_instance_set_dirty_flag( fixture->inst, FALSE );
+    
+    g_assert( qof_get_alt_dirty_mode() ); 
+    g_assert( !qof_instance_get_dirty_flag( fixture->inst ) );
+    g_assert( !qof_collection_is_dirty( col ) );
+    g_assert( !qof_instance_get_dirty( fixture->inst ) );
+    qof_instance_set_dirty( fixture->inst );
+    g_assert( qof_instance_get_dirty_flag( fixture->inst ) );
+    g_assert( !qof_collection_is_dirty( col ) );
+    g_assert( qof_instance_get_dirty( fixture->inst ) );
+    
+    /* clean up */
+    qof_instance_set_collection( fixture->inst, NULL );
+    qof_collection_destroy( col );
+}
+
+static void
+test_instance_gemini_and_lookup( void )
+{
+    QofBook *to_book, *from_book;
+    KvpFrame *to_book_frame, *from_book_frame;
+    
+    /* setup books */
+    to_book = qof_book_new();
+    from_book = qof_book_new();
+    g_assert( QOF_IS_BOOK( to_book ) );
+    g_assert( QOF_IS_BOOK( from_book ) );
+    g_assert( to_book != from_book );
+    g_assert( to_book == qof_instance_get_book( QOF_INSTANCE( to_book ) ) );
+    g_assert( from_book == qof_instance_get_book( QOF_INSTANCE( from_book ) ) );
+    
+    g_test_message( "Test instances lookup has instance and book null protection" );
+    g_assert( qof_instance_lookup_twin( NULL, from_book ) == NULL );
+    g_assert( qof_instance_lookup_twin( QOF_INSTANCE( from_book ), NULL ) == NULL );
+    
+    g_test_message( "Test instances lookup which are not geminis should return null" );
+    g_assert( qof_instance_lookup_twin( QOF_INSTANCE( to_book ), from_book ) == NULL );
+    g_assert( qof_instance_lookup_twin( QOF_INSTANCE( from_book ), to_book ) == NULL );
+    
+    g_test_message( "Test instances with the same book are not paired" );
+    qof_instance_gemini (&to_book->inst, (QofInstance *) &to_book->inst);
+    g_assert( qof_instance_lookup_twin( QOF_INSTANCE( to_book ), to_book ) == NULL );
+    g_assert( qof_instance_lookup_twin( QOF_INSTANCE( from_book ), from_book ) == NULL );
+    
+    g_test_message( "Test instances with different books are paired" );
+    qof_instance_gemini (&to_book->inst, (QofInstance *) &from_book->inst);
+    g_assert( qof_instance_lookup_twin( QOF_INSTANCE( to_book ), from_book ) == &from_book->inst );
+    g_assert( qof_instance_lookup_twin( QOF_INSTANCE( from_book ), to_book ) == &to_book->inst );
+      
+    /* destroy books */
+    qof_book_destroy( to_book );
+    qof_book_destroy( from_book );
+}
+
+/* mock display name function */
+static gchar*
+mock_get_display_name(const QofInstance* inst)
+{
+    gchar *display_name;
+    
+    g_assert( inst );
+    g_assert( QOF_INSTANCE_GET_CLASS( inst )->get_display_name == mock_get_display_name );
+    is_called = TRUE;
+    display_name = g_strdup_printf("Mock display name %p", inst );
+    return display_name;
+}
+
+static void
+test_instance_display_name( Fixture *fixture, gconstpointer pData )
+{
+    QofIdType type = "test type";
+    QofCollection *col;
+    gchar *display_name, *default_display_name, *mock_display_name;
+  
+    /* setup */
+    g_assert( fixture->inst );
+    is_called = FALSE;
+    col = qof_collection_new ( type );
+    g_assert( col );
+    qof_instance_set_collection( fixture->inst, col );
+    g_assert( qof_instance_get_collection( fixture->inst ) );
+    default_display_name = g_strdup_printf( "Object %s %p", type, fixture->inst );
+    mock_display_name = g_strdup_printf( "Mock display name %p", fixture->inst );
+    
+    g_test_message( "Test instance when display name not set" );
+    g_assert( QOF_INSTANCE_GET_CLASS( fixture->inst )->get_display_name == NULL );
+    display_name = qof_instance_get_display_name( fixture->inst );
+    g_assert( !is_called );
+    g_assert_cmpstr( display_name, ==, default_display_name );
+    g_free( display_name );
+    
+    g_test_message( "Test instance when display name is set" );
+    QOF_INSTANCE_GET_CLASS( fixture->inst )->get_display_name = mock_get_display_name;
+    display_name = qof_instance_get_display_name( fixture->inst );
+    g_assert( is_called );
+    g_assert_cmpstr( display_name, ==, mock_display_name );
+    g_free( display_name );
+    
+    /* clean up */
+    g_free( default_display_name );
+    g_free( mock_display_name );
+    qof_instance_set_collection( fixture->inst, NULL );
+    qof_collection_destroy( col );
+}
+
+static void
+mock_backend_begin( QofBackend *be, QofInstance *inst )
+{
+    g_assert( be );
+    g_assert( inst );
+    g_assert( be->begin == mock_backend_begin );
+    g_assert_cmpstr( inst->e_type, ==, "test type" );
+    is_called = TRUE;
+}
+
+static void
+test_instance_begin_edit( Fixture *fixture, gconstpointer pData )
+{
+    QofBackend *be;
+    QofBook *book;
+    gboolean result;
+    
+    /* setup */
+    be = g_new0( QofBackend, 1 );
+    g_assert( be );
+    qof_backend_init( be );
+    book = qof_book_new();
+    g_assert( book );
+    g_assert( QOF_IS_BOOK( book ) );
+    qof_book_set_backend( book, be );
+    g_assert( fixture->inst );
+    fixture->inst->e_type = "test type";
+    g_assert( qof_instance_get_dirty_flag( fixture->inst ) == FALSE );
+    g_assert_cmpint( qof_instance_get_editlevel( fixture->inst ), ==, 0 );
+    
+    g_test_message( "Test when instance is null" );
+    result = qof_begin_edit( NULL );
+    g_assert( result == FALSE );
+    
+    g_test_message( "Test when instance's editlevel is >= 1" );
+    qof_instance_increase_editlevel( fixture->inst );
+    result = qof_begin_edit( fixture->inst );
+    g_assert( result == FALSE );
+    g_assert_cmpint( qof_instance_get_editlevel( fixture->inst ), ==, 2 );
+    
+    g_test_message( "Test when instance's editlevel is <= 0 and backend not set" );
+    qof_instance_reset_editlevel( fixture->inst );
+    result = qof_begin_edit( fixture->inst );
+    g_assert( result == TRUE );
+    g_assert_cmpint( qof_instance_get_editlevel( fixture->inst ), ==, 1 );
+    g_assert( qof_instance_get_dirty_flag( fixture->inst ) == TRUE );
+    
+    g_test_message( "Test when instance's editlevel is <= 0 and backend is set" );
+    result = FALSE;
+    is_called = FALSE;
+    qof_instance_reset_editlevel( fixture->inst );
+    qof_instance_set_dirty_flag( fixture->inst, FALSE );
+    qof_instance_set_book( fixture->inst, book );
+    be->begin = mock_backend_begin;
+    result = qof_begin_edit( fixture->inst );
+    g_assert( result == TRUE );
+    g_assert_cmpint( qof_instance_get_editlevel( fixture->inst ), ==, 1 );
+    g_assert( qof_instance_get_dirty_flag( fixture->inst ) == FALSE );
+    g_assert( is_called );
+    
+    /* clean up */
+    qof_book_set_backend( book, NULL );
+    qof_book_destroy( book );
+    qof_backend_destroy( be );
+    g_free( be );
+}
+
+static void
+test_instance_commit_edit( Fixture *fixture, gconstpointer pData )
+{
+    gboolean result;
+    
+    g_test_message( "Test when instance set to null" );
+    result = qof_commit_edit( NULL );
+    g_assert( !result );
+    
+    g_test_message( "Test when instance's editlevel >= 2" );
+    qof_instance_increase_editlevel( fixture->inst );
+    qof_instance_increase_editlevel( fixture->inst );
+    g_assert_cmpint( qof_instance_get_editlevel( fixture->inst ), ==, 2 );
+    result = qof_commit_edit( fixture->inst );
+    g_assert_cmpint( qof_instance_get_editlevel( fixture->inst ), ==, 1 );
+    g_assert( !result );
+    
+    g_test_message( "Test when instance's editlevel = 1" );
+    result = qof_commit_edit( fixture->inst );
+    g_assert_cmpint( qof_instance_get_editlevel( fixture->inst ), ==, 0 );
+    g_assert( result );
+    
+    g_test_message( "Test when instance's editlevel < 0" );
+    g_test_log_set_fatal_handler ( ( GTestLogFatalFunc )fatal_handler, NULL );
+    qof_instance_decrease_editlevel( fixture->inst );
+    g_assert_cmpint( qof_instance_get_editlevel( fixture->inst ), ==, -1 );
+    result = qof_commit_edit( fixture->inst );
+    g_assert_cmpint( qof_instance_get_editlevel( fixture->inst ), ==, 0 );
+    g_assert_cmpstr( error_message, ==, "[qof_commit_edit()] unbalanced call - resetting (was -2)" );
+    g_free( error_message );
+}
+
+/* backend commit test start */
+
+static struct
+{
+    gpointer inst;
+    gpointer be;
+    
+    gboolean commit_called;
+    gboolean commit_with_err_called;
+    gboolean on_error_called;
+    gboolean on_free_called;
+    gboolean on_done_called;
+    QofBackendError err;
+} commit_test_part2;
+
+static void
+mock_backend_commit( QofBackend *be, QofInstance *inst )
+{
+    g_assert( inst );
+    g_assert( be );
+    g_assert( QOF_IS_INSTANCE( inst ) );
+    g_assert( commit_test_part2.inst == inst );
+    g_assert( commit_test_part2.be == be );
+    commit_test_part2.commit_called = TRUE;
+}
+
+static void
+mock_backend_commit_with_error( QofBackend *be, QofInstance *inst )
+{
+    g_assert( inst );
+    g_assert( be );
+    g_assert( QOF_IS_INSTANCE( inst ) );
+    g_assert( commit_test_part2.inst == inst );
+    g_assert( commit_test_part2.be == be );
+    qof_backend_set_error( be, ERR_BACKEND_NO_HANDLER );
+    commit_test_part2.err = ERR_BACKEND_NO_HANDLER;
+    commit_test_part2.commit_with_err_called = TRUE;
+}
+
+
+static void
+mock_on_error( QofInstance *inst, QofBackendError be_error )
+{
+    g_assert( inst );
+    g_assert( QOF_IS_INSTANCE( inst ) );
+    g_assert( commit_test_part2.err == be_error );
+    commit_test_part2.on_error_called = TRUE;
+}
+
+static void
 test_book_readonly( Fixture *fixture, gconstpointer pData )
 {
     QofBook *book = qof_instance_get_book( fixture->instance );



More information about the gnucash-changes mailing list