tstOVF.cpp@ 77590

Last change on this file since 77590 was 76553, checked in by vboxsync, 6 years ago
scm --update-copyright-year
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 13.9 KB

Line
1	/* $Id: tstOVF.cpp 76553 2019-01-01 01:45:53Z vboxsync $ */
2	/** @file
3	*
4	* tstOVF - testcases for OVF import and export
5	*/
6
7	/*
8	* Copyright (C) 2010-2019 Oracle Corporation
9	*
10	* This file is part of VirtualBox Open Source Edition (OSE), as
11	* available from http://www.virtualbox.org. This file is free software;
12	* you can redistribute it and/or modify it under the terms of the GNU
13	* General Public License (GPL) as published by the Free Software
14	* Foundation, in version 2 as it comes in the "COPYING" file of the
15	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
16	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
17	*/
18
19	#include <VBox/com/VirtualBox.h>
20
21	#include <VBox/com/com.h>
22	#include <VBox/com/array.h>
23	#include <VBox/com/string.h>
24	#include <VBox/com/ErrorInfo.h>
25	#include <VBox/com/errorprint.h>
26
27	#include <iprt/initterm.h>
28	#include <iprt/stream.h>
29	#include <iprt/file.h>
30	#include <iprt/path.h>
31	#include <iprt/param.h>
32
33	#include <list>
34
35	using namespace com;
36
37	// main
38	///////////////////////////////////////////////////////////////////////////////
39
40	/**
41	* Quick hack exception structure.
42	*
43	*/
44	struct MyError
45	{
46	MyError(HRESULT rc,
47	const char *pcsz,
48	IProgress *pProgress = NULL)
49	: m_rc(rc)
50	{
51	m_str = "ERROR: ";
52	m_str += pcsz;
53
54	if (pProgress)
55	{
56	com::ProgressErrorInfo info(pProgress);
57	com::GluePrintErrorInfo(info);
58	}
59	else if (rc)
60	{
61	com::ErrorInfo info;
62	if (!info.isFullAvailable() && !info.isBasicAvailable())
63	com::GluePrintRCMessage(rc);
64	else
65	com::GluePrintErrorInfo(info);
66	}
67	}
68
69	Utf8Str m_str;
70	HRESULT m_rc;
71	};
72
73	/**
74	* Imports the given OVF file, with all bells and whistles.
75	* Throws MyError on errors.
76	* @param pcszPrefix Descriptive short prefix string for console output.
77	* @param pVirtualBox VirtualBox instance.
78	* @param pcszOVF0 File to import.
79	* @param llMachinesCreated out: UUIDs of machines that were created so that caller can clean up.
80	*/
81	void importOVF(const char *pcszPrefix,
82	ComPtr<IVirtualBox> &pVirtualBox,
83	const char *pcszOVF0,
84	std::list<Guid> &llMachinesCreated)
85	{
86	char szAbsOVF[RTPATH_MAX];
87	RTPathExecDir(szAbsOVF, sizeof(szAbsOVF));
88	RTPathAppend(szAbsOVF, sizeof(szAbsOVF), pcszOVF0);
89
90	RTPrintf("%s: reading appliance \"%s\"...\n", pcszPrefix, szAbsOVF);
91	ComPtr<IAppliance> pAppl;
92	HRESULT rc = pVirtualBox->CreateAppliance(pAppl.asOutParam());
93	if (FAILED(rc)) throw MyError(rc, "failed to create appliance\n");
94
95	ComPtr<IProgress> pProgress;
96	rc = pAppl->Read(Bstr(szAbsOVF).raw(), pProgress.asOutParam());
97	if (FAILED(rc)) throw MyError(rc, "Appliance::Read() failed\n");
98	rc = pProgress->WaitForCompletion(-1);
99	if (FAILED(rc)) throw MyError(rc, "Progress::WaitForCompletion() failed\n");
100	LONG rc2;
101	pProgress->COMGETTER(ResultCode)(&rc2);
102	if (FAILED(rc2)) throw MyError(rc2, "Appliance::Read() failed\n", pProgress);
103
104	RTPrintf("%s: interpreting appliance \"%s\"...\n", pcszPrefix, szAbsOVF);
105	rc = pAppl->Interpret();
106	if (FAILED(rc)) throw MyError(rc, "Appliance::Interpret() failed\n");
107
108	com::SafeIfaceArray<IVirtualSystemDescription> aDescriptions;
109	rc = pAppl->COMGETTER(VirtualSystemDescriptions)(ComSafeArrayAsOutParam(aDescriptions));
110	for (uint32_t u = 0;
111	u < aDescriptions.size();
112	++u)
113	{
114	ComPtr<IVirtualSystemDescription> pVSys = aDescriptions[u];
115
116	com::SafeArray<VirtualSystemDescriptionType_T> aTypes;
117	com::SafeArray<BSTR> aRefs;
118	com::SafeArray<BSTR> aOvfValues;
119	com::SafeArray<BSTR> aVBoxValues;
120	com::SafeArray<BSTR> aExtraConfigValues;
121	rc = pVSys->GetDescription(ComSafeArrayAsOutParam(aTypes),
122	ComSafeArrayAsOutParam(aRefs),
123	ComSafeArrayAsOutParam(aOvfValues),
124	ComSafeArrayAsOutParam(aVBoxValues),
125	ComSafeArrayAsOutParam(aExtraConfigValues));
126	if (FAILED(rc)) throw MyError(rc, "VirtualSystemDescription::GetDescription() failed\n");
127
128	for (uint32_t u2 = 0;
129	u2 < aTypes.size();
130	++u2)
131	{
132	const char *pcszType;
133
134	VirtualSystemDescriptionType_T t = aTypes[u2];
135	switch (t)
136	{
137	case VirtualSystemDescriptionType_OS:
138	pcszType = "ostype";
139	break;
140
141	case VirtualSystemDescriptionType_Name:
142	pcszType = "name";
143	break;
144
145	case VirtualSystemDescriptionType_Product:
146	pcszType = "product";
147	break;
148
149	case VirtualSystemDescriptionType_ProductUrl:
150	pcszType = "producturl";
151	break;
152
153	case VirtualSystemDescriptionType_Vendor:
154	pcszType = "vendor";
155	break;
156
157	case VirtualSystemDescriptionType_VendorUrl:
158	pcszType = "vendorurl";
159	break;
160
161	case VirtualSystemDescriptionType_Version:
162	pcszType = "version";
163	break;
164
165	case VirtualSystemDescriptionType_Description:
166	pcszType = "description";
167	break;
168
169	case VirtualSystemDescriptionType_License:
170	pcszType = "license";
171	break;
172
173	case VirtualSystemDescriptionType_CPU:
174	pcszType = "cpu";
175	break;
176
177	case VirtualSystemDescriptionType_Memory:
178	pcszType = "memory";
179	break;
180
181	case VirtualSystemDescriptionType_HardDiskControllerIDE:
182	pcszType = "ide";
183	break;
184
185	case VirtualSystemDescriptionType_HardDiskControllerSATA:
186	pcszType = "sata";
187	break;
188
189	case VirtualSystemDescriptionType_HardDiskControllerSAS:
190	pcszType = "sas";
191	break;
192
193	case VirtualSystemDescriptionType_HardDiskControllerSCSI:
194	pcszType = "scsi";
195	break;
196
197	case VirtualSystemDescriptionType_HardDiskImage:
198	pcszType = "hd";
199	break;
200
201	case VirtualSystemDescriptionType_CDROM:
202	pcszType = "cdrom";
203	break;
204
205	case VirtualSystemDescriptionType_Floppy:
206	pcszType = "floppy";
207	break;
208
209	case VirtualSystemDescriptionType_NetworkAdapter:
210	pcszType = "net";
211	break;
212
213	case VirtualSystemDescriptionType_USBController:
214	pcszType = "usb";
215	break;
216
217	case VirtualSystemDescriptionType_SoundCard:
218	pcszType = "sound";
219	break;
220
221	default:
222	throw MyError(E_UNEXPECTED, "Invalid VirtualSystemDescriptionType\n");
223	break;
224	}
225
226	RTPrintf(" vsys %2u item %2u: type %2d (%s), ovf: \"%ls\", vbox: \"%ls\", extra: \"%ls\"\n",
227	u, u2, t, pcszType,
228	aOvfValues[u2],
229	aVBoxValues[u2],
230	aExtraConfigValues[u2]);
231	}
232	}
233
234	RTPrintf("%s: importing %d machine(s)...\n", pcszPrefix, aDescriptions.size());
235	SafeArray<ImportOptions_T> sfaOptions;
236	rc = pAppl->ImportMachines(ComSafeArrayAsInParam(sfaOptions), pProgress.asOutParam());
237	if (FAILED(rc)) throw MyError(rc, "Appliance::ImportMachines() failed\n");
238	rc = pProgress->WaitForCompletion(-1);
239	if (FAILED(rc)) throw MyError(rc, "Progress::WaitForCompletion() failed\n");
240	pProgress->COMGETTER(ResultCode)(&rc2);
241	if (FAILED(rc2)) throw MyError(rc2, "Appliance::ImportMachines() failed\n", pProgress);
242
243	com::SafeArray<BSTR> aMachineUUIDs;
244	rc = pAppl->COMGETTER(Machines)(ComSafeArrayAsOutParam(aMachineUUIDs));
245	if (FAILED(rc)) throw MyError(rc, "Appliance::GetMachines() failed\n");
246
247	for (size_t u = 0;
248	u < aMachineUUIDs.size();
249	++u)
250	{
251	RTPrintf("%s: created machine %u: %ls\n", pcszPrefix, u, aMachineUUIDs[u]);
252	llMachinesCreated.push_back(Guid(Bstr(aMachineUUIDs[u])));
253	}
254
255	RTPrintf("%s: success!\n", pcszPrefix);
256	}
257
258	/**
259	* Copies ovf-testcases/ovf-dummy.vmdk to the given target and appends that
260	* target as a string to the given list so that the caller can delete it
261	* again later.
262	* @param llFiles2Delete List of strings to append the target file path to.
263	* @param pcszDest Target for dummy VMDK.
264	*/
265	void copyDummyDiskImage(const char *pcszPrefix,
266	std::list<Utf8Str> &llFiles2Delete,
267	const char *pcszDest)
268	{
269	char szSrc[RTPATH_MAX];
270	char szDst[RTPATH_MAX];
271	RTPathExecDir(szSrc, sizeof(szSrc));
272	RTPathAppend(szSrc, sizeof(szSrc), "ovf-testcases/ovf-dummy.vmdk");
273	RTPathExecDir(szDst, sizeof(szDst));
274	RTPathAppend(szDst, sizeof(szDst), pcszDest);
275	RTPrintf("%s: copying ovf-dummy.vmdk to \"%s\"...\n", pcszPrefix, pcszDest);
276
277	int vrc = RTFileCopy(szSrc, szDst);
278	if (RT_FAILURE(vrc)) throw MyError(0, Utf8StrFmt("Cannot copy ovf-dummy.vmdk to %s: %Rra\n", pcszDest, vrc).c_str());
279	llFiles2Delete.push_back(szDst);
280	}
281
282	/**
283	*
284	* @param argc
285	* @param argv[]
286	* @return
287	*/
288	int main(int argc, char *argv[])
289	{
290	RTR3InitExe(argc, &argv, 0);
291
292	RTEXITCODE rcExit = RTEXITCODE_SUCCESS;
293	HRESULT rc = S_OK;
294
295	std::list<Utf8Str> llFiles2Delete;
296	std::list<Guid> llMachinesCreated;
297
298	ComPtr<IVirtualBoxClient> pVirtualBoxClient;
299	ComPtr<IVirtualBox> pVirtualBox;
300
301	try
302	{
303	RTPrintf("Initializing COM...\n");
304	rc = com::Initialize();
305	if (FAILED(rc)) throw MyError(rc, "failed to initialize COM!\n");
306
307	ComPtr<ISession> pSession;
308
309	RTPrintf("Creating VirtualBox object...\n");
310	rc = pVirtualBoxClient.createInprocObject(CLSID_VirtualBoxClient);
311	if (SUCCEEDED(rc))
312	rc = pVirtualBoxClient->COMGETTER(VirtualBox)(pVirtualBox.asOutParam());
313	if (FAILED(rc)) throw MyError(rc, "failed to create the VirtualBox object!\n");
314
315	rc = pSession.createInprocObject(CLSID_Session);
316	if (FAILED(rc)) throw MyError(rc, "failed to create a session object!\n");
317
318	// for each testcase, we will copy the dummy VMDK image to the subdirectory with the OVF testcase
319	// so that the import will find the disks it expects; this is just for testing the import since
320	// the imported machines will obviously not be usable.
321	// llFiles2Delete receives the paths of all the files that we need to clean up later.
322
323	// testcase 1: import ovf-joomla-0.9/joomla-1.1.4-ovf.ovf
324	copyDummyDiskImage("joomla-0.9", llFiles2Delete, "ovf-testcases/ovf-joomla-0.9/joomla-1.1.4-ovf-0.vmdk");
325	copyDummyDiskImage("joomla-0.9", llFiles2Delete, "ovf-testcases/ovf-joomla-0.9/joomla-1.1.4-ovf-1.vmdk");
326	importOVF("joomla-0.9", pVirtualBox, "ovf-testcases/ovf-joomla-0.9/joomla-1.1.4-ovf.ovf", llMachinesCreated);
327
328	// testcase 2: import ovf-winxp-vbox-sharedfolders/winxp.ovf
329	copyDummyDiskImage("winxp-vbox-sharedfolders", llFiles2Delete, "ovf-testcases/ovf-winxp-vbox-sharedfolders/Windows 5.1 XP 1 merged.vmdk");
330	copyDummyDiskImage("winxp-vbox-sharedfolders", llFiles2Delete, "ovf-testcases/ovf-winxp-vbox-sharedfolders/smallvdi.vmdk");
331	importOVF("winxp-vbox-sharedfolders", pVirtualBox, "ovf-testcases/ovf-winxp-vbox-sharedfolders/winxp.ovf", llMachinesCreated);
332
333	// testcase 3: import ovf-winxp-vbox-sharedfolders/winxp.ovf
334	importOVF("winhost-audio-nodisks", pVirtualBox, "ovf-testcases/ovf-winhost-audio-nodisks/WinXP.ovf", llMachinesCreated);
335
336	RTPrintf("Machine imports done, no errors. Cleaning up...\n");
337	}
338	catch (MyError &e)
339	{
340	rc = e.m_rc;
341	RTPrintf("%s", e.m_str.c_str());
342	rcExit = RTEXITCODE_FAILURE;
343	}
344
345	try
346	{
347	// clean up the machines created
348	for (std::list<Guid>::const_iterator it = llMachinesCreated.begin();
349	it != llMachinesCreated.end();
350	++it)
351	{
352	const Guid &uuid = *it;
353	Bstr bstrUUID(uuid.toUtf16());
354	ComPtr<IMachine> pMachine;
355	rc = pVirtualBox->FindMachine(bstrUUID.raw(), pMachine.asOutParam());
356	if (FAILED(rc)) throw MyError(rc, "VirtualBox::FindMachine() failed\n");
357
358	RTPrintf(" Deleting machine %ls...\n", bstrUUID.raw());
359	SafeIfaceArray<IMedium> sfaMedia;
360	rc = pMachine->Unregister(CleanupMode_DetachAllReturnHardDisksOnly,
361	ComSafeArrayAsOutParam(sfaMedia));
362	if (FAILED(rc)) throw MyError(rc, "Machine::Unregister() failed\n");
363
364	ComPtr<IProgress> pProgress;
365	rc = pMachine->DeleteConfig(ComSafeArrayAsInParam(sfaMedia), pProgress.asOutParam());
366	if (FAILED(rc)) throw MyError(rc, "Machine::DeleteSettings() failed\n");
367	rc = pProgress->WaitForCompletion(-1);
368	if (FAILED(rc)) throw MyError(rc, "Progress::WaitForCompletion() failed\n");
369	}
370	}
371	catch (MyError &e)
372	{
373	rc = e.m_rc;
374	RTPrintf("%s", e.m_str.c_str());
375	rcExit = RTEXITCODE_FAILURE;
376	}
377
378	// clean up the VMDK copies that we made in copyDummyDiskImage()
379	for (std::list<Utf8Str>::const_iterator it = llFiles2Delete.begin();
380	it != llFiles2Delete.end();
381	++it)
382	{
383	const Utf8Str &strFile = *it;
384	RTPrintf("Deleting file %s...\n", strFile.c_str());
385	RTFileDelete(strFile.c_str());
386	}
387
388	pVirtualBox.setNull();
389	pVirtualBoxClient.setNull();
390
391	RTPrintf("Shutting down COM...\n");
392	com::Shutdown();
393	RTPrintf("tstOVF all done: %s\n", rcExit ? "ERROR" : "SUCCESS");
394
395	return rcExit;
396	}
397

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Main/testcase/tstOVF.cpp@ 77590

Download in other formats: