Changeset 4246 in vbox for trunk/src/VBox/Main/testcase

Timestamp:

Aug 20, 2007 6:57:44 PM (17 years ago)

Author:

vboxsync

Message:

Main: Resurrected and extended XPCOM testcase.

Location:

trunk/src/VBox/Main/testcase

Files:

• Makefile.kmk (modified) (2 diffs)
• tstVBoxAPILinux.cpp (modified) (17 diffs)

trunk/src/VBox/Main/testcase/Makefile.kmk

@@ -24 +24 @@
 else ifeq ($(USERNAME),dmik)
  PROGRAMS       = tstAPI
+ PROGRAMS.linux = tstVBoxAPILinux
+ PROGRAMS.win   = tstVBoxAPIWin
 endif # VBOX_WITH_TESTCASES
 
@@ -56 +58 @@
 tstVBoxAPILinux_TEMPLATE = VBOXR3
 tstVBoxAPILinux_SOURCES  = tstVBoxAPILinux.cpp
-tstVBoxAPILinux_CXXFLAGS = -Wno-non-virtual-dtor
+tstVBoxAPILinux_CXXFLAGS = -Wno-non-virtual-dtor -fshort-wchar
 tstVBoxAPILinux_INCS     = \
         $(VBOX_XPCOM_INCS) \

trunk/src/VBox/Main/testcase/tstVBoxAPILinux.cpp

@@ -29 +29 @@
  * Include the XPCOM headers
  */
-#include <nsIServiceManager.h>
-#include <nsIComponentRegistrar.h>
 #include <nsXPCOMGlue.h>
 #include <nsMemory.h>
 #include <nsString.h>
-#include <nsIProgrammingLanguage.h>
-#include <ipcIService.h>
-#include <ipcCID.h>
-#include <ipcIDConnectService.h>
-#include <nsIEventQueueService.h>
-
-/*
- * Some XPCOM declarations that haven't made it
- * into the official headers yet
- */
-#define IPC_DCONNECTSERVICE_CONTRACTID \
-    "@mozilla.org/ipc/dconnect-service;1"
-static NS_DEFINE_CID(kEventQueueServiceCID, NS_EVENTQUEUESERVICE_CID);
-static nsIEventQueue* gEventQ = nsnull;
-
+#include <nsIServiceManager.h>
+#include <nsEventQueueUtils.h>
+
+#include <nsIExceptionService.h>
 
 /*
@@ -60 +47 @@
  */
 char *nsIDToString(nsID *guid);
-
+void printErrorInfo();
 
 
@@ -150 +137 @@
     nsresult rc;
     /*
-     * First create a new VM. It will be unconfigured and not be saved
+     * First create a unnamed new VM. It will be unconfigured and not be saved
      * in the configuration until we explicitely choose to do so.
      */
-    IMachine *machine;
-    rc = virtualBox->CreateMachine(nsnull, NS_LITERAL_STRING("A brand new VM").get(), &machine);
+    nsCOMPtr <IMachine> machine;
+    rc = virtualBox->CreateMachine(nsnull, NS_LITERAL_STRING("A brand new name").get(),
+                                   getter_AddRefs(machine));
+    if (NS_FAILED(rc))
+    {
+        printf("Error: could not create machine! rc=%08X\n", rc);
+        return;
+    }
 
     /*
@@ -160 +153 @@
      */
     /* alternative to illustrate the use of string classes */
-    char vmName[] = "A new name";
-    rc = machine->SetName(NS_ConvertUTF8toUTF16((char*)vmName).get());
+    rc = machine->SetName(NS_ConvertUTF8toUTF16("A new name").get());
     rc = machine->SetMemorySize(128);
 
@@ -174 +166 @@
      * guest OS type collection and enumerating it.
      */
-    IGuestOSType *osType = nsnull;
-    char win2k[] = "win2k";
-    rc = virtualBox->GetGuestOSType(NS_ConvertUTF8toUTF16((char*) win2k).get(), &osType);
-    if (NS_FAILED(rc) || !osType)
-    {
-        printf("Error: could not find guest OS type! rc = 0x%x\n", rc);
+    nsCOMPtr <IGuestOSType> osType;
+    rc = virtualBox->GetGuestOSType(NS_LITERAL_STRING("win2k").get(),
+                                    getter_AddRefs(osType));
+    if (NS_FAILED(rc))
+    {
+        printf("Error: could not find guest OS type! rc=%08X\n", rc);
     }
     else
     {
-        machine->SetOSTypeId (NS_ConvertUTF8toUTF16((char*) win2k).get());
-        osType->Release();
+        machine->SetOSTypeId (NS_LITERAL_STRING("win2k").get());
+    }
+
+    /*
+     * Register the VM. Note that this call also saves the VM config
+     * to disk. It is also possible to save the VM settings but not
+     * register the VM.
+     *
+     * Also note that due to current VirtualBox limitations, the machine
+     * must be registered *before* we can attach hard disks to it.
+     */
+    rc = virtualBox->RegisterMachine(machine);
+    if (NS_FAILED(rc))
+    {
+        printf("Error: could not register machine! rc=%08X\n", rc);
+        printErrorInfo();
+        return;
+    }
+
+    /*
+     * In order to manipulate the registered machine, we must open a session
+     * for that machine. Do it now.
+     */
+    nsCOMPtr<ISession> session;
+    {
+        nsCOMPtr<nsIComponentManager> manager;
+        rc = NS_GetComponentManager (getter_AddRefs (manager));
+        if (NS_FAILED(rc))
+        {
+            printf("Error: could not get component manager! rc=%08X\n", rc);
+            return;
+        }
+        rc = manager->CreateInstanceByContractID (NS_SESSION_CONTRACTID,
+                                                  nsnull,
+                                                  NS_GET_IID(ISession),
+                                                  getter_AddRefs(session));
+        if (NS_FAILED(rc))
+        {
+            printf("Error, could not instantiate Session object! rc=0x%x\n", rc);
+            return;
+        }
+
+        nsID *machineUUID = nsnull;
+        machine->GetId(&machineUUID);
+        rc = virtualBox->OpenSession(session, *machineUUID);
+        nsMemory::Free(machineUUID);
+        if (NS_FAILED(rc))
+        {
+            printf("Error, could not open session! rc=0x%x\n", rc);
+            return;
+        }
+
+        /*
+         * After the machine is registered, the initial machine object becomes
+         * immutable. In order to get a mutable machine object, we must query
+         * it from the opened session object.
+         */
+        rc = session->GetMachine(getter_AddRefs(machine));
+        if (NS_FAILED(rc))
+        {
+            printf("Error, could not get sessioned machine! rc=0x%x\n", rc);
+            return;
+        }
     }
 
@@ -190 +243 @@
      * Create a virtual harddisk
      */
-    IHardDisk *hardDisk = 0;
-    IVirtualDiskImage *vdi = 0;
-    char vdiName[] = "TestHardDisk.vdi";
+    nsCOMPtr<IHardDisk> hardDisk = 0;
+    nsCOMPtr<IVirtualDiskImage> vdi = 0;
     rc = virtualBox->CreateHardDisk(HardDiskStorageType::VirtualDiskImage,
-                                    &hardDisk);
+                                    getter_AddRefs(hardDisk));
     if (NS_SUCCEEDED (rc))
     {
-        rc = hardDisk->QueryInterface(NS_GET_IID(IVirtualDiskImage), (void **)&vdi);
+        rc = hardDisk->QueryInterface(NS_GET_IID(IVirtualDiskImage),
+                                      (void **)(getter_AddRefs(vdi)));
         if (NS_SUCCEEDED (rc))
-            rc = vdi->SetFilePath(NS_ConvertUTF8toUTF16((char*)vdiName).get());
-    }
-
-    if (NS_FAILED(rc) || !hardDisk || !vdi)
-    {
-        printf("Failed creating a hard disk object!\n");
+            rc = vdi->SetFilePath(NS_LITERAL_STRING("TestHardDisk.vdi").get());
+    }
+
+    if (NS_FAILED(rc))
+    {
+        printf("Failed creating a hard disk object! rc=%08X\n", rc);
     }
     else
@@ -213 +266 @@
          * a dynamically expanding image.
          */
-        IProgress *progress;
+        nsCOMPtr <IProgress> progress;
         rc = vdi->CreateDynamicImage(100,                                             // size in megabytes
-                                     &progress);                                      // optional progress object
-        if (NS_FAILED(rc) || !progress)
-        {
-            printf("Failed creating hard disk image!\n");
+                                     getter_AddRefs(progress));                       // optional progress object
+        if (NS_FAILED(rc))
+        {
+            printf("Failed creating hard disk image! rc=%08X\n", rc);
         }
         else
@@ -230 +283 @@
             nsresult resultCode;
             progress->GetResultCode(&resultCode);
-            progress->Release();
-            if (NS_FAILED(rc) || (resultCode != 0))
+            if (NS_FAILED(rc) || NS_FAILED(resultCode))
             {
-                printf("Error: could not create hard disk!\n");
+                printf("Error: could not create hard disk! rc=%08X\n",
+                       NS_FAILED(rc) ? rc : resultCode);
             }
             else
@@ -243 +296 @@
                 if (NS_FAILED(rc))
                 {
-                    printf("Error: could not register hard disk!\n");
+                    printf("Error: could not register hard disk! rc=%08X\n", rc);
                 }
                 else
@@ -260 +313 @@
                     if (NS_FAILED(rc))
                     {
-                        printf("Error: could not attach hard disk!\n");
+                        printf("Error: could not attach hard disk! rc=%08X\n", rc);
                     }
                 }
@@ -266 +319 @@
         }
     }
-    if (vdi)
-        vdi->Release();
-    if (hardDisk)
-        hardDisk->Release();
 
     /*
@@ -278 +327 @@
      */
     nsID uuid = {0};
-    IDVDImage *dvdImage = nsnull;
-    char isoFile[] = "/home/achimha/isoimages/winnt4ger.iso";
-
-    rc = virtualBox->OpenDVDImage(NS_ConvertUTF8toUTF16((char*)isoFile).get(),
+    nsCOMPtr<IDVDImage> dvdImage;
+
+    rc = virtualBox->OpenDVDImage(NS_LITERAL_STRING("/home/achimha/isoimages/winnt4ger.iso").get(),
                                   uuid, /* NULL UUID, i.e. a new one will be created */
-                                  &dvdImage);
-    if (NS_FAILED(rc) || !dvdImage)
-    {
-        printf("Error: could not open CD image!\n");
+                                  getter_AddRefs(dvdImage));
+    if (NS_FAILED(rc))
+    {
+        printf("Error: could not open CD image! rc=%08X\n", rc);
     }
     else
@@ -294 +342 @@
          */
         rc = virtualBox->RegisterDVDImage(dvdImage);
-        if (NS_FAILED(rc) || !dvdImage)
-        {
-            printf("Error: could not register CD image!\n");
+        if (NS_FAILED(rc))
+        {
+            printf("Error: could not register CD image! rc=%08X\n", rc);
         }
         else
@@ -305 +353 @@
             nsID *isoUUID = nsnull;
             dvdImage->GetId(&isoUUID);
-            IDVDDrive *dvdDrive = nsnull;
-            machine->GetDVDDrive(&dvdDrive);
+            nsCOMPtr<IDVDDrive> dvdDrive;
+            machine->GetDVDDrive(getter_AddRefs(dvdDrive));
             rc = dvdDrive->MountImage(*isoUUID);
             nsMemory::Free(isoUUID);
             if (NS_FAILED(rc))
             {
-                printf("Error: could not mount ISO image!\n");
+                printf("Error: could not mount ISO image! rc=%08X\n", rc);
             }
             else
@@ -321 +369 @@
                 if (NS_FAILED(rc))
                 {
-                    printf("Could not set boot device!\n");
+                    printf("Could not set boot device! rc=%08X\n", rc);
                 }
             }
-            dvdDrive->Release();
-            dvdImage->Release();
-        }
-    }
-
-    /*
-     * Register the VM. Note that this call also saves the VM config
-     * to disk. It is also possible to save the VM settings but not
-     * register the VM.
-     */
-    virtualBox->RegisterMachine(machine);
-
-    machine->Release();
+        }
+    }
+
+    /*
+     * Save all changes we've just made.
+     */
+    rc = machine->SaveSettings();
+    if (NS_FAILED(rc))
+    {
+        printf("Could not save machine settings! rc=%08X\n", rc);
+    }
+
+    /*
+     * It is always important to close the open session when it becomes not
+     * necessary any more.
+     */
+    session->Close();
 }
 
@@ -344 +396 @@
 int main(int argc, char *argv[])
 {
+    /*
+     * Check that PRUnichar is equal in size to what compiler composes L""
+     * strings from; otherwise NS_LITERAL_STRING macros won't work correctly
+     * and we will get a meaningless SIGSEGV. This, of course, must be checked
+     * at compile time in xpcom/string/nsTDependentString.h, but XPCOM lacks
+     * compile-time assert macros and I'm not going to add them now.
+     */
+    if (sizeof(PRUnichar) != sizeof(wchar_t))
+    {
+        printf("Error: sizeof(PRUnichar) {%d} != sizeof(wchar_t) {%d}!\n"
+               "Probably, you forgot the -fshort-wchar compiler option.\n",
+               sizeof(PRUnichar), sizeof(wchar_t));
+        return -1;
+    }
+
     nsresult rc;
 
     /*
-     * This is the standard XPCOM init processing.
+     * This is the standard XPCOM init procedure.
      * What we do is just follow the required steps to get an instance
-     * of our main interface, which is IVirtualBox
+     * of our main interface, which is IVirtualBox.
      */
     XPCOMGlueStartup(nsnull);
-    nsCOMPtr<nsIServiceManager> serviceManager;
-    rc = NS_InitXPCOM2(getter_AddRefs(serviceManager), nsnull, nsnull);
-    if (NS_FAILED(rc))
-    {
-        printf("Error: XPCOM could not be initialized! rc=0x%x\n", rc);
-        return -1;
-    }
-
-    // register our component
-    nsCOMPtr<nsIComponentRegistrar> registrar = do_QueryInterface(serviceManager);
-    if (!registrar)
-    {
-        printf("Error: could not query nsIComponentRegistrar interface!\n");
-        return -1;
-    }
-    registrar->AutoRegister(nsnull);
-
-    // Create the Event Queue for this thread
-    nsCOMPtr<nsIEventQueueService> eqs = do_GetService(kEventQueueServiceCID, &rc);
-    if (NS_FAILED( rc ))
-    {
-        printf("Error: could not get event queue service! rc=%08X\n", rc);
-        return -1;
-    }
-
-    rc = eqs->CreateThreadEventQueue();
-    if (NS_FAILED( rc ))
-    {
-        printf("Error: could not create thread event queue! rc=%08X\n", rc);
-        return -1;
-    }
-
-    rc = eqs->GetThreadEventQueue(NS_CURRENT_THREAD, &gEventQ);
-    if (NS_FAILED( rc ))
-    {
-        printf("Error: could not get tread event queue! rc=%08X\n", rc);
-        return -1;
-    }
-
-    // get ipc service
-    nsCOMPtr<ipcIService> ipcServ = do_GetService(IPC_SERVICE_CONTRACTID, &rc);
-    if (NS_FAILED( rc ))
-    {
-        printf("Error: could not get ipc service! rc=%08X\n", rc);
-        return -1;
-    }
-
-    // get dconnect service
-    nsCOMPtr<ipcIDConnectService> dcon = do_GetService(IPC_DCONNECTSERVICE_CONTRACTID, &rc);
-    if (NS_FAILED( rc ))
-    {
-        printf("Error: could not get dconnect service! rc=%08X\n", rc);
-        return -1;
-    }
-
-    PRUint32 serverID = 0;
-    rc = ipcServ->ResolveClientName("VirtualBoxServer", &serverID);
-    if (NS_FAILED( rc ))
-    {
-        printf("Error: could not get VirtualBox server ID! rc=%08X\n", rc);
-        return -1;
-    }
-
-    nsCOMPtr<nsIComponentManager> manager = do_QueryInterface(registrar);
-    if (!manager)
-    {
-        printf("Error: could not query nsIComponentManager interface!\n");
-        return -1;
-    }
-
-    /*
-     * Now XPCOM is ready and we can start to do real work.
-     * IVirtualBox is the root interface of VirtualBox and will be
-     * retrieved from the XPCOM component registrar. We use the
-     * XPCOM provided smart pointer nsCOMPtr for all objects because
-     * that's very convenient and removes the need deal with reference
-     * counting and freeing.
-     */
-    nsCOMPtr<IVirtualBox> virtualBox;
-    rc = dcon->CreateInstanceByContractID(serverID, NS_VIRTUALBOX_CONTRACTID,
-                                          NS_GET_IID(IVirtualBox),
-                                          getter_AddRefs(virtualBox));
-    if (NS_FAILED(rc))
-    {
-        printf("Error, could not instantiate VirtualBox object! rc=0x%x\n", rc);
-        return -1;
-    }
-    printf("VirtualBox object created\n");
-
-    ////////////////////////////////////////////////////////////////////////////////
-    ////////////////////////////////////////////////////////////////////////////////
-    ////////////////////////////////////////////////////////////////////////////////
-
-
-    listVMs(virtualBox);
-
-    createVM(virtualBox);
-
-
-    ////////////////////////////////////////////////////////////////////////////////
-    ////////////////////////////////////////////////////////////////////////////////
-    ////////////////////////////////////////////////////////////////////////////////
-
-    /* this is enough to free the IVirtualBox instance -- smart pointers rule! */
-    virtualBox = nsnull;
-
-    /*
-     * Process events that might have queued up in the XPCOM event
-     * queue. If we don't process them, the server might hang.
-     */
-    gEventQ->ProcessPendingEvents();
-
-    /*
-     * Perform the standard XPCOM shutdown procedure
+
+    /*
+     * Note that we scope all nsCOMPtr variables in order to have all XPCOM
+     * objects automatically released before we call NS_ShutdownXPCOM at the
+     * end. This is an XPCOM requirement.
+     */
+    {
+        nsCOMPtr<nsIServiceManager> serviceManager;
+        rc = NS_InitXPCOM2(getter_AddRefs(serviceManager), nsnull, nsnull);
+        if (NS_FAILED(rc))
+        {
+            printf("Error: XPCOM could not be initialized! rc=0x%x\n", rc);
+            return -1;
+        }
+
+#if 0
+        /*
+         * Register our components. This step is only necessary if this executable
+         * implements XPCOM components itself which is not the case for this
+         * simple example.
+         */
+        nsCOMPtr<nsIComponentRegistrar> registrar = do_QueryInterface(serviceManager);
+        if (!registrar)
+        {
+            printf("Error: could not query nsIComponentRegistrar interface!\n");
+            return -1;
+        }
+        registrar->AutoRegister(nsnull);
+#endif
+
+        /*
+         * Make sure the main event queue is created. This event queue is
+         * responsible for dispatching incoming XPCOM IPC messages. The main
+         * thread should run this event queue's loop during lengthy non-XPCOM
+         * operations to ensure messages from the VirtualBox server and other
+         * XPCOM IPC clients are processed. This use case doesn't perform such
+         * operations so it doesn't run the event loop.
+         */
+        nsCOMPtr<nsIEventQueue> eventQ;
+        rc = NS_GetMainEventQ(getter_AddRefs (eventQ));
+        if (NS_FAILED(rc))
+        {
+            printf("Error: could not get main event queue! rc=%08X\n", rc);
+            return -1;
+        }
+
+        /*
+         * Now XPCOM is ready and we can start to do real work.
+         * IVirtualBox is the root interface of VirtualBox and will be
+         * retrieved from the XPCOM component manager. We use the
+         * XPCOM provided smart pointer nsCOMPtr for all objects because
+         * that's very convenient and removes the need deal with reference
+         * counting and freeing.
+         */
+        nsCOMPtr<nsIComponentManager> manager;
+        rc = NS_GetComponentManager (getter_AddRefs (manager));
+        if (NS_FAILED(rc))
+        {
+            printf("Error: could not get component manager! rc=%08X\n", rc);
+            return -1;
+        }
+
+        nsCOMPtr<IVirtualBox> virtualBox;
+        rc = manager->CreateInstanceByContractID (NS_VIRTUALBOX_CONTRACTID,
+                                                  nsnull,
+                                                  NS_GET_IID(IVirtualBox),
+                                                  getter_AddRefs(virtualBox));
+        if (NS_FAILED(rc))
+        {
+            printf("Error, could not instantiate VirtualBox object! rc=0x%x\n", rc);
+            return -1;
+        }
+        printf("VirtualBox object created\n");
+
+        ////////////////////////////////////////////////////////////////////////////////
+        ////////////////////////////////////////////////////////////////////////////////
+        ////////////////////////////////////////////////////////////////////////////////
+
+
+        listVMs(virtualBox);
+
+        createVM(virtualBox);
+
+
+        ////////////////////////////////////////////////////////////////////////////////
+        ////////////////////////////////////////////////////////////////////////////////
+        ////////////////////////////////////////////////////////////////////////////////
+
+        /* this is enough to free the IVirtualBox instance -- smart pointers rule! */
+        virtualBox = nsnull;
+
+        /*
+         * Process events that might have queued up in the XPCOM event
+         * queue. If we don't process them, the server might hang.
+         */
+        eventQ->ProcessPendingEvents();
+    }
+
+    /*
+     * Perform the standard XPCOM shutdown procedure.
      */
     NS_ShutdownXPCOM(nsnull);
@@ -498 +551 @@
     return res;
 }
+
+/**
+ * Helper function to print XPCOM exception information set on the current
+ * thread after a failed XPCOM method call. This function will also print
+ * extended VirtualBox error info if it is available.
+ */
+void printErrorInfo()
+{
+    nsresult rc;
+
+    nsCOMPtr <nsIExceptionService> es;
+    es = do_GetService (NS_EXCEPTIONSERVICE_CONTRACTID, &rc);
+    if (NS_SUCCEEDED (rc))
+    {
+        nsCOMPtr <nsIExceptionManager> em;
+        rc = es->GetCurrentExceptionManager (getter_AddRefs (em));
+        if (NS_SUCCEEDED (rc))
+        {
+            nsCOMPtr<nsIException> ex;
+            rc = em->GetCurrentException (getter_AddRefs (ex));
+            if (NS_SUCCEEDED (rc) && ex)
+            {
+                nsCOMPtr <IVirtualBoxErrorInfo> info;
+                info = do_QueryInterface(ex, &rc);
+                if (NS_SUCCEEDED(rc) && info)
+                {
+                    /* got extended error info */
+                    printf ("Extended error info (IVirtualBoxErrorInfo):\n");
+                    nsresult resultCode = NS_OK;
+                    info->GetResultCode (&resultCode);
+                    printf ("  resultCode=%08X\n", resultCode);
+                    nsXPIDLString component;
+                    info->GetComponent (getter_Copies (component));
+                    printf ("  component=%s\n", NS_ConvertUTF16toUTF8(component).get());
+                    nsXPIDLString text;
+                    info->GetText (getter_Copies (text));
+                    printf ("  text=%s\n", NS_ConvertUTF16toUTF8(text).get());
+                }
+                else
+                {
+                    /* got basic error info */
+                    printf ("Basic error info (nsIException):\n");
+                    nsresult resultCode = NS_OK;
+                    ex->GetResult (&resultCode);
+                    printf ("  resultCode=%08X\n", resultCode);
+                    nsXPIDLCString message;
+                    ex->GetMessage (getter_Copies (message));
+                    printf ("  message=%s\n", message.get());
+                }
+
+                /* reset the exception to NULL to indicate we've processed it */
+                em->SetCurrentException (NULL);
+
+                rc = NS_OK;
+            }
+        }
+    }
+}