Merge lp:~smspillaz/compiz-libcompizconfig/compiz-libcompizconfig.context-mock into lp:~compiz-team/compiz-libcompizconfig/0.9.8

[Sam Spilsbury]

This is all about bug 990690.

!! - It probably isn't a good idea to test this branch in isolation, as it is part of a pipeline to get compiz-libcompizconfig under test. If you want to test the result of this work, you should probably look at testing

lp:~smspillaz/compiz-libcompizconfig/compiz-libcompizconfig.mock-context
lp:~smspillaz/compiz-compizconfig-python/compiz-compizconfig-python.setting-api
lp:~smspillaz/compiz-compizconfig-gconf/compiz-compizconfig-gconf.adapt-to-new-interfaces

.. that's all !!

This branch adds a mock for CCSContext, thunking the interface table in C to call a set of virtual functions on an interface class which then calls through to Google Mock. A small test demonstrating this behaviour is included.

Unmerged revisions

456. By Sam Spilsbury on 2012-04-28

Added a mock for CCSContext and a small test file to demo how it works

455. By Sam Spilsbury on 2012-04-28

Use CCSObjectFinalize

454. By Sam Spilsbury on 2012-04-28

Use CCSObject for CCSSetting

453. By Sam Spilsbury on 2012-04-28

Merged refactor-setting into setting-funcs-behind-interface.

452. By Sam Spilsbury on 2012-04-28

Merged refactor-setting into setting-funcs-behind-interface.

451. By Sam Spilsbury on 2012-04-28

Merged refactor-setting into setting-funcs-behind-interface.

450. By Sam Spilsbury on 2012-04-28

Merged refactor-setting into setting-funcs-behind-interface.

449. By Sam Spilsbury on 2012-04-28

Merged refactor-setting into setting-funcs-behind-interface.

448. By Sam Spilsbury on 2012-04-28

Merged refactor-setting into setting-funcs-behind-interface.

447. By Sam Spilsbury on 2012-04-28

Works with protocol buffers

=== modified file 'tests/CMakeLists.txt'
--- tests/CMakeLists.txt	2012-04-28 18:59:46 +0000
+++ tests/CMakeLists.txt	2012-04-28 18:59:46 +0000
@@ -36,15 +36,29 @@
 include_directories (${CMAKE_SOURCE_DIR}/include)
 link_directories (${CMAKE_INSTALL_PREFIX}/lib)
 
+add_library (context-mock
+	     ${CMAKE_CURRENT_SOURCE_DIR}/context-mock.cpp)
+
 add_executable (test-ccs-object
 		${CMAKE_CURRENT_SOURCE_DIR}/test-ccs-object.cpp)
 
+add_executable (test-context
+		${CMAKE_CURRENT_SOURCE_DIR}/test-context.cpp)
+
 if (HAVE_PROTOBUF)
     set (LIBCOMPIZCONFIG_LIBRARIES
 	 ${LIBCOMPIZCONFIG_LIBRARIES}
 	 protobuf)
 endif (HAVE_PROTOBUF)
 
+target_link_libraries (context-mock
+		       ${GTEST_BOTH_LIBRARIES}
+		       ${GMOCK_LIBRARY}
+		       ${GMOCK_MAIN_LIBRARY}
+		       ${CMAKE_THREAD_LIBS_INIT}
+		       ${LIBCOMPIZCONFIG_LIBRARIES}
+		       compizconfig)
+
 target_link_libraries (test-ccs-object
 		       ${GTEST_BOTH_LIBRARIES}
 		       ${GMOCK_LIBRARY}
@@ -53,4 +67,14 @@
 		       ${LIBCOMPIZCONFIG_LIBRARIES}
 		       compizconfig)
 
+target_link_libraries (test-context
+		       ${GTEST_BOTH_LIBRARIES}
+		       ${GMOCK_LIBRARY}
+		       ${GMOCK_MAIN_LIBRARY}
+		       ${CMAKE_THREAD_LIBS_INIT}
+		       ${LIBCOMPIZCONFIG_LIBRARIES}
+		       compizconfig
+		       context-mock)
+
 gtest_add_tests (test-ccs-object "" ${CMAKE_CURRENT_SOURCE_DIR}/test-ccs-object.cpp)
+gtest_add_tests (test-context "" ${CMAKE_CURRENT_SOURCE_DIR}/test-context.cpp)

=== added file 'tests/context-mock.cpp'
--- tests/context-mock.cpp	1970-01-01 00:00:00 +0000
+++ tests/context-mock.cpp	2012-04-28 18:59:46 +0000
@@ -0,0 +1,74 @@
+#include <gtest/gtest.h>
+#include <gmock/gmock.h>
+
+#include <ccs.h>
+
+#include "mock-context.h"
+
+CCSContextInterface CCSContextGMockInterface =
+{
+    CCSContextGMock::ccsContextGetPlugins,
+    CCSContextGMock::ccsContextGetCategories,
+    CCSContextGMock::ccsContextGetChangedSettings,
+    CCSContextGMock::ccsContextGetScreenNum,
+    CCSContextGMock::ccsContextAddChangedSetting,
+    CCSContextGMock::ccsContextClearChangedSettings,
+    CCSContextGMock::ccsContextStealChangedSettings,
+    CCSContextGMock::ccsContextGetPrivatePtr,
+    CCSContextGMock::ccsContextSetPrivatePtr,
+    CCSContextGMock::ccsLoadPlugin,
+    CCSContextGMock::ccsFindPlugin,
+    CCSContextGMock::ccsPluginIsActive,
+    CCSContextGMock::ccsGetActivePluginList,
+    CCSContextGMock::ccsGetSortedPluginStringList,
+    CCSContextGMock::ccsSetBackend,
+    CCSContextGMock::ccsGetBackend,
+    CCSContextGMock::ccsSetIntegrationEnabled,
+    CCSContextGMock::ccsSetProfile,
+    CCSContextGMock::ccsSetPluginListAutoSort,
+    CCSContextGMock::ccsGetProfile,
+    CCSContextGMock::ccsGetIntegrationEnabled,
+    CCSContextGMock::ccsGetPluginListAutoSort,
+    CCSContextGMock::ccsProcessEvents,
+    CCSContextGMock::ccsReadSettings,
+    CCSContextGMock::ccsWriteSettings,
+    CCSContextGMock::ccsWriteChangedSettings,
+    CCSContextGMock::ccsExportToFile,
+    CCSContextGMock::ccsImportFromFile,
+    CCSContextGMock::ccsCanEnablePlugin,
+    CCSContextGMock::ccsCanDisablePlugin,
+    CCSContextGMock::ccsGetExistingProfiles,
+    CCSContextGMock::ccsDeleteProfile,
+    CCSContextGMock::ccsCheckForSettingsUpgrade,
+    CCSContextGMock::ccsLoadPlugins
+};
+
+CCSContext *
+ccsMockContextNew ()
+{
+    CCSContext *context = (CCSContext *) calloc (1, sizeof (CCSContext));
+
+    if (!context)
+	return NULL;
+
+    CCSContextGMock *mock = new CCSContextGMock ();
+    ccsObjectSetPrivate ((CCSObject *) context, (CCSPrivate *) mock);
+    ccsObjectAddInterface ((CCSObject *) context, (CCSInterface *) &CCSContextGMockInterface, CCS_CONTEXT_INTERFACE_TYPE);
+
+    return context;
+}
+
+void
+ccsFreeMockContext (CCSContext *context)
+{
+    /* Need to delete the mock correctly */
+
+    CCSContextGMock *mock = (CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context);
+
+    delete mock;
+
+    ccsObjectSetPrivate ((CCSObject *) context, NULL);
+    ccsObjectFinalize ((CCSObject *) context);
+
+    free (context);
+}

=== added file 'tests/mock-context.h'
--- tests/mock-context.h	1970-01-01 00:00:00 +0000
+++ tests/mock-context.h	2012-04-28 18:59:46 +0000
@@ -0,0 +1,337 @@
+#include <gtest/gtest.h>
+#include <gmock/gmock.h>
+
+#include <ccs.h>
+
+class CCSContextGMockInterface
+{
+    public:
+
+	virtual ~CCSContextGMockInterface () {};
+
+	virtual CCSPluginList getPlugins () = 0;
+	virtual CCSPluginCategory * getCategories () = 0;
+	virtual CCSSettingList getChangedSettings () = 0;
+	virtual unsigned int getScreenNum () = 0;
+	virtual Bool addChangedSetting (CCSSetting *) = 0;
+	virtual Bool clearChangedSettings () = 0;
+	virtual CCSSettingList stealChangedSettings () = 0;
+	virtual void * getPrivatePtr () = 0;
+	virtual void setPrivatePtr (void *) = 0;
+	virtual Bool loadPlugin (char *name) = 0;
+	virtual CCSPlugin * findPlugin (const char *name) = 0;
+	virtual Bool pluginIsActive (char *name) = 0;
+	virtual CCSPluginList getActivePluginList () = 0;
+	virtual CCSStringList getSortedPluginStringList () = 0;
+	virtual char * getBackend () = 0;
+	virtual Bool setBackend (char *name) = 0;
+	virtual void setIntegrationEnabled (Bool value) = 0;
+	virtual void setProfile (char *name);
+	virtual void setPluginListAutoSort (Bool value) = 0;
+	virtual char * getProfile () = 0;
+	virtual Bool getIntegrationEnabled () = 0;
+	virtual Bool getPluginListAutoSort () = 0;
+	virtual void processEvents (unsigned int flags) = 0;
+	virtual void readSettings () = 0;
+	virtual void writeSettings () = 0;
+	virtual void writeChangedSettings () = 0;
+	virtual Bool exportToFile (const char *fileName, Bool skipDefaults) = 0;
+	virtual Bool importFromFile (const char *fileName, Bool overwriteNonDefaults) = 0;
+	virtual CCSPluginConflictList canEnablePlugin (CCSPlugin *) = 0;
+	virtual CCSPluginConflictList canDisablePlugin (CCSPlugin *) = 0;
+	virtual void deleteProfile (char *name) = 0;
+	virtual CCSStringList getExistingProfiles () = 0;
+	virtual Bool checkForSettingsUpgrade () = 0;
+	virtual void loadPlugins () = 0;
+};
+
+class CCSContextGMock
+{
+    public:
+
+	MOCK_METHOD0 (getPlugins, CCSPluginList ());
+	MOCK_METHOD0 (getCategories, CCSPluginCategory * ());
+	MOCK_METHOD0 (getChangedSettings, CCSSettingList ());
+	MOCK_METHOD0 (getScreenNum, unsigned int ());
+	MOCK_METHOD1 (addChangedSetting, Bool (CCSSetting *));
+	MOCK_METHOD0 (clearChangedSettings, Bool ());
+	MOCK_METHOD0 (stealChangedSettings, CCSSettingList ());
+	MOCK_METHOD0 (getPrivatePtr, void * ());
+	MOCK_METHOD1 (setPrivatePtr, void (void *));
+	MOCK_METHOD1 (loadPlugin, Bool (char *));
+	MOCK_METHOD1 (findPlugin, CCSPlugin * (char *));
+	MOCK_METHOD1 (pluginIsActive, Bool (char *));
+	MOCK_METHOD0 (getActivePluginList, CCSPluginList ());
+	MOCK_METHOD0 (getSortedPluginStringList, CCSStringList ());
+	MOCK_METHOD0 (getBackend, char * ());
+	MOCK_METHOD1 (setBackend, Bool (char *));
+	MOCK_METHOD1 (setIntegrationEnabled, void (Bool));
+	MOCK_METHOD1 (setProfile, void (char *));
+	MOCK_METHOD1 (setPluginListAutoSort, void (Bool));
+	MOCK_METHOD0 (getProfile, char * ());
+	MOCK_METHOD0 (getIntegrationEnabled, Bool ());
+	MOCK_METHOD0 (getPluginListAutoSort, Bool ());
+	MOCK_METHOD1 (processEvents, void (unsigned int));
+	MOCK_METHOD0 (readSettings, void ());
+	MOCK_METHOD0 (writeSettings, void ());
+	MOCK_METHOD0 (writeChangedSettings, void ());
+	MOCK_METHOD2 (exportToFile, Bool (const char *, Bool));
+	MOCK_METHOD2 (importFromFile, Bool (const char *, Bool));
+	MOCK_METHOD1 (canEnablePlugin, CCSPluginConflictList (CCSPlugin *));
+	MOCK_METHOD1 (canDisablePlugin, CCSPluginConflictList (CCSPlugin *));
+	MOCK_METHOD1 (deleteProfile, void (char *));
+	MOCK_METHOD0 (getExistingProfiles, CCSStringList ());
+	MOCK_METHOD0 (checkForSettingsUpgrade, Bool ());
+	MOCK_METHOD0 (loadPlugins, void ());
+
+    public:
+
+	/* Thunking from C interface callbacks to the virtual functions ... */
+	static CCSPluginList
+	ccsContextGetPlugins (CCSContext *context)
+	{
+	    return ((CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context))->getPlugins ();
+	}
+
+	static CCSPluginCategory *
+	ccsContextGetCategories (CCSContext *context)
+	{
+	    return ((CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context))->getCategories ();
+	}
+
+	static CCSSettingList
+	ccsContextGetChangedSettings (CCSContext *context)
+	{
+	    return ((CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context))->getChangedSettings ();
+	}
+
+	static unsigned int
+	ccsContextGetScreenNum (CCSContext *context)
+	{
+	    return ((CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context))->getScreenNum ();
+	}
+
+	static Bool
+	ccsContextAddChangedSetting (CCSContext *context, CCSSetting *setting)
+	{
+	    return ((CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context))->addChangedSetting (setting);
+	}
+
+	static Bool
+	ccsContextClearChangedSettings (CCSContext *context)
+	{
+	    return ((CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context))->clearChangedSettings ();
+	}
+
+	static CCSSettingList
+	ccsContextStealChangedSettings (CCSContext *context)
+	{
+	    return ((CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context))->stealChangedSettings ();
+	}
+
+	static void *
+	ccsContextGetPrivatePtr (CCSContext *context)
+	{
+	    return ((CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context))->getPrivatePtr ();
+	}
+
+	static void
+	ccsContextSetPrivatePtr (CCSContext *context, void *ptr)
+	{
+	    ((CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context))->setPrivatePtr (ptr);
+	}
+
+	static CCSPlugin *
+	ccsFindPlugin (CCSContext *context, const char *name)
+	{
+	    return ((CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context))->findPlugin ((char *) name);
+	}
+
+	static Bool
+	ccsPluginIsActive (CCSContext *context, char *name)
+	{
+	    return ((CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context))->pluginIsActive (name);
+	}
+
+	static Bool
+	ccsSetBackend (CCSContext *context, char *name)
+	{
+	    return ((CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context))->setBackend (name);
+	}
+
+	static CCSPluginList
+	ccsGetActivePluginList (CCSContext *context)
+	{
+	    return ((CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context))->getActivePluginList ();
+	}
+
+	static CCSStringList
+	ccsGetSortedPluginStringList (CCSContext *context)
+	{
+	    return ((CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context))->getSortedPluginStringList ();
+	}
+
+	static char *
+	ccsGetBackend (CCSContext *context)
+	{
+	    return ((CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context))->getBackend ();
+	}
+
+	static Bool
+	ccsGetIntegrationEnabled (CCSContext *context)
+	{
+	    if (!context)
+		return FALSE;
+
+	    return ((CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context))->getIntegrationEnabled ();
+	}
+
+	static char *
+	ccsGetProfile (CCSContext *context)
+	{
+	    if (!context)
+		return NULL;
+
+	    return ((CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context))->getProfile ();
+	}
+
+	static Bool
+	ccsGetPluginListAutoSort (CCSContext *context)
+	{
+	    if (!context)
+		return FALSE;
+
+	    return ((CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context))->getPluginListAutoSort ();
+	}
+
+	static void
+	ccsSetIntegrationEnabled (CCSContext *context, Bool value)
+	{
+	    ((CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context))->setIntegrationEnabled (value);
+	}
+
+	static void
+	ccsSetPluginListAutoSort (CCSContext *context, Bool value)
+	{
+	    ((CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context))->setPluginListAutoSort (value);
+	}
+
+	static void
+	ccsSetProfile (CCSContext *context, char *name)
+	{
+	    ((CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context))->setProfile (name);
+	}
+
+	static void
+	ccsProcessEvents (CCSContext *context, unsigned int flags)
+	{
+	    if (!context)
+		return;
+
+	    ((CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context))->processEvents (flags);
+	}
+
+	static void
+	ccsReadSettings (CCSContext *context)
+	{
+	    if (!context)
+		return;
+
+	    ((CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context))->readSettings ();
+	}
+
+	static void
+	ccsWriteSettings (CCSContext *context)
+	{
+	    if (!context)
+		return;
+
+	    ((CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context))->writeSettings ();
+	}
+
+	static void
+	ccsWriteChangedSettings (CCSContext *context)
+	{
+	    if (!context)
+		return;
+
+	    ((CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context))->writeChangedSettings ();
+	}
+
+	static CCSPluginConflictList
+	ccsCanEnablePlugin (CCSContext *context, CCSPlugin *plugin)
+	{
+	    return ((CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context))->canEnablePlugin (plugin);
+	}
+
+	static CCSPluginConflictList
+	ccsCanDisablePlugin (CCSContext *context, CCSPlugin *plugin)
+	{
+	    return ((CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context))->canDisablePlugin (plugin);
+	}
+
+	static CCSStringList
+	ccsGetExistingProfiles (CCSContext *context)
+	{
+	    if (!context)
+		return NULL;
+
+	    return ((CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context))->getExistingProfiles ();
+	}
+
+	static void
+	ccsDeleteProfile (CCSContext *context, char *name)
+	{
+	    if (!context)
+		return;
+
+	    ((CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context))->deleteProfile (name);
+	}
+
+	static Bool
+	ccsCheckForSettingsUpgrade (CCSContext *context)
+	{
+	    return ((CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context))->checkForSettingsUpgrade ();
+	}
+
+	static Bool
+	ccsImportFromFile (CCSContext *context, const char *fileName, Bool overwriteNonDefault)
+	{
+	    if (!context)
+		return FALSE;
+
+	    return ((CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context))->importFromFile (fileName, overwriteNonDefault);
+	}
+
+	static Bool
+	ccsLoadPlugin (CCSContext *context, char *name)
+	{
+	    if (!context)
+		return FALSE;
+
+	    return ((CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context))->loadPlugin (name);
+	}
+
+	static Bool
+	ccsExportToFile (CCSContext *context, const char *fileName, Bool skipDefaults)
+	{
+	    if (!context)
+		return FALSE;
+
+	    return ((CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context))->exportToFile (fileName, skipDefaults);
+	}
+
+	static void
+	ccsLoadPlugins (CCSContext *context)
+	{
+	    if (!context)
+		return;
+
+	    return ((CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context))->loadPlugins ();
+	}
+};
+
+extern CCSContextInterface CCSContextGMockInterface;
+
+CCSContext * ccsMockContextNew ();
+void ccsFreeMockContext (CCSContext *);

=== added file 'tests/test-context.cpp'
--- tests/test-context.cpp	1970-01-01 00:00:00 +0000
+++ tests/test-context.cpp	2012-04-28 18:59:46 +0000
@@ -0,0 +1,34 @@
+#include <gtest/gtest.h>
+#include <gmock/gmock.h>
+
+#include <ccs.h>
+
+#include "mock-context.h"
+
+using ::testing::_;
+using ::testing::Return;
+
+class CCSContextTest :
+    public ::testing::Test
+{
+};
+
+TEST(CCSContextTest, TestMock)
+{
+    CCSContext *context = ccsMockContextNew ();
+    CCSContextGMock *mock = (CCSContextGMock *) ccsObjectGetPrivate ((CCSObject *) context);
+
+    EXPECT_CALL (*mock, getPlugins ());
+    EXPECT_CALL (*mock, getCategories ());
+    EXPECT_CALL (*mock, getChangedSettings ());
+    EXPECT_CALL (*mock, getScreenNum ());
+    EXPECT_CALL (*mock, addChangedSetting (_));
+
+    ccsContextGetPlugins (context);
+    ccsContextGetCategories (context);
+    ccsContextGetChangedSettings (context);
+    ccsContextGetScreenNum (context);
+    ccsContextAddChangedSetting (context, NULL);
+
+    ccsFreeMockContext (context);
+}