Changeset 68024 in vbox for trunk/src/VBox/Main

Timestamp:

Jul 18, 2017 1:54:10 PM (8 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

117044

Message:

IUnattended,IMachine: Changed IUnattended to a pure action object with a factory method instead of an attribute. Added more attributes: scriptTemplatePath, validationKitIsoPath, installTestExecService, and (readonly) machine. Only the first and also of those actually do anything at the moment.

Location:

trunk/src/VBox/Main

Files:

• idl/VirtualBox.xidl (modified) (7 diffs)
• include/MachineImpl.h (modified) (3 diffs)
• src-server/MachineImpl.cpp (modified) (4 diffs)

trunk/src/VBox/Main/idl/VirtualBox.xidl

@@ -3767 +3767 @@
   <interface
     name="IUnattended" extends="$unknown"
-    uuid="a6ba3585-5fc3-4465-d61d-5b70540690af"
+    uuid="b365bb45-267f-44fa-c32a-cad265372f8e"
     wsmap="managed"
     reservedMethods="4" reservedAttributes="16"
@@ -3776 +3776 @@
       the Guest OS for fully automated install.
 
-      It is based on the IMachine:
-      <link to="IMachine::unattended"/> attribute.
+      The typical workflow is:
+      <ol>
+        <li>Call <link to="IMachine::createUnattendedInstaller"/> to create the object</li>
+        <li>Set the IUnattended attributes.</li>
+        <li>Call <link to="IUnattended::prepare"/> for the object to check the
+            attribute values and create an internal installer instance.</li>
+        <li>Call <link to="IUnattended::constructMedia"/> to create additional
+            media files (ISO/floppy) needed.</li>
+        <li>Call <link to="IUnattended::reconfigureVM"/> to reconfigure the VM
+            with the installation ISO, additional media files and whatnot </li>
+        <li>Optionally call <link to="IUnattended::done"/> to destroy the internal
+            installer and allow restarting from the second step.</li>
+      </ol>
     </desc>
 
@@ -3815 +3826 @@
     <attribute name="additionsIsoPath" type="wstring">
       <desc>
-        Guest Additions ISO image path
+        Guest Additions ISO image path.  This defaults to
+        <link to="ISystemProperties::defaultAdditionsISO"/> when the Unattended
+        object is instantiated.
+
+        This property is ignored when <link to="IUnattended::installGuestAdditions"/> is false.
       </desc>
     </attribute>
@@ -3826 +3841 @@
         distribution, only the installation of additions pointed to by
         <link to="IUnattended::additionsIsoPath"/>.
+      </desc>
+    </attribute>
+
+    <attribute name="validationKitIsoPath" type="wstring">
+      <desc>
+        VirtualBox ValidationKit ISO image path.  This is used when
+        <link to="IUnattended::installTestExecService"/> is set to true.
+      </desc>
+    </attribute>
+
+    <attribute name="installTestExecService" type="boolean">
+      <desc>
+        Indicates whether the test execution service (TXS) from the VBox
+        ValidationKit should be installed.
+
+        The TXS binary will be taken from the ISO indicated by
+        <link to="IUnattended::validationKitIsoPath"/>.
       </desc>
     </attribute>
@@ -3846 +3878 @@
         Used only with Windows installation CD/DVD:
         https://technet.microsoft.com/en-us/library/cc766022%28v=ws.10%29.aspx
+      </desc>
+    </attribute>
+
+    <attribute name="machine" type="IMachine" readonly="yes">
+      <desc>
+        The associated machine object.
+      </desc>
+    </attribute>
+
+    <attribute name="scriptTemplatePath" type="wstring">
+      <desc>
+        The unattended installation script template file.
+
+        The template default is based on the guest OS type and is determined by the
+        internal installer when when <link to="IUnattended::prepare"/> is invoked.
+        Most users will want the defaults.
+
+        After <link to="IUnattended::prepare"/> is called, it can be read to see
+        which file is being used.
       </desc>
     </attribute>
@@ -5386 +5437 @@
     </attribute>
 
-    <attribute name="unattended" type="IUnattended" readonly="yes">
-      <desc>Associated unattended install class, always present.</desc>
-    </attribute>
-
     <method name="lockMachine">
       <desc>
@@ -7968 +8015 @@
       <param name="progress" type="IProgress" dir="return">
         <desc>Progress object to track the operation completion.</desc>
+      </param>
+    </method>
+
+    <method name="createUnattendedInstaller">
+      <desc>
+        Creates a new <link to="IUnattended"/> guest installation object.
+      </desc>
+      <param name="unattended" type="IUnattended" dir="return">
+        <desc>New unattended object.</desc>
       </param>
     </method>

trunk/src/VBox/Main/include/MachineImpl.h

@@ -776 +776 @@
     const ComObjPtr<BIOSSettings>      mBIOSSettings;
     const ComObjPtr<BandwidthControl>  mBandwidthControl;
-#ifdef VBOX_WITH_UNATTENDED
-    const ComObjPtr<Unattended>        mUnattended;
-#endif
 
     typedef std::vector<ComObjPtr<NetworkAdapter> > NetworkAdapterVector;
@@ -984 +981 @@
     HRESULT getVMProcessPriority(com::Utf8Str &aVMProcessPriority);
     HRESULT setVMProcessPriority(const com::Utf8Str &aVMProcessPriority);
-    HRESULT getUnattended(ComPtr<IUnattended> &aUnattended);
 
     // wrapped IMachine methods
@@ -1202 +1198 @@
     HRESULT restoreSnapshot(const ComPtr<ISnapshot> &aSnapshot,
                             ComPtr<IProgress> &aProgress);
+    HRESULT createUnattendedInstaller(ComPtr<IUnattended> &aUnattended);
     HRESULT applyDefaults(const com::Utf8Str &aFlags);
 

trunk/src/VBox/Main/src-server/MachineImpl.cpp

@@ -7184 +7184 @@
 }
 
-HRESULT Machine::getUnattended(ComPtr<IUnattended> &aUnattended)
-{
-#ifdef VBOX_WITH_UNATTENDED
-    AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
-    if (mUnattended.isNotNull())
-        aUnattended = mUnattended;
-    else
-    {
-        /* Do on-demand creation. */
-        alock.release();
-        AutoWriteLock wlock(this COMMA_LOCKVAL_SRC_POS);
-        if (mUnattended.isNull())
-        {
-            unconst(mUnattended).createObject();
-            HRESULT hrc = mUnattended->init(this);
-            if (FAILED(hrc))
-            {
-                mUnattended->uninit();
-                unconst(mUnattended).setNull();
-                return hrc;
-            }
-        }
-        aUnattended = mUnattended;
-    }
-    return S_OK;
-#else
-    NOREF(aUnattended);
-    return E_NOTIMPL;
-#endif
-}
-
 HRESULT Machine::cloneTo(const ComPtr<IMachine> &aTarget, CloneMode_T aMode, const std::vector<CloneOptions_T> &aOptions,
                          ComPtr<IProgress> &aProgress)
@@ -8445 +8414 @@
     mBandwidthControl->init(this);
 
-#ifdef VBOX_WITH_UNATTENDED
-    Assert(mUnattended.isNull()); /* Created on-demand. */
-#endif
-
     return S_OK;
 }
@@ -8525 +8490 @@
         unconst(mBIOSSettings).setNull();
     }
-
-#ifdef VBOX_WITH_UNATTENDED
-    if (mUnattended)
-    {
-        mUnattended->uninit();
-        unconst(mUnattended).setNull();
-    }
-#endif
 
     /* Deassociate media (only when a real Machine or a SnapshotMachine
@@ -15158 +15115 @@
 }
 
+HRESULT Machine::createUnattendedInstaller(ComPtr<IUnattended> &aUnattended)
+{
+#ifdef VBOX_WITH_UNATTENDED
+    ComObjPtr<Unattended> ptrUnattended;
+    HRESULT hrc = ptrUnattended.createObject();
+    if (SUCCEEDED(hrc))
+    {
+        AutoReadLock wlock(this COMMA_LOCKVAL_SRC_POS);
+        hrc = ptrUnattended->init(this);
+        if (SUCCEEDED(hrc))
+            hrc = ptrUnattended.queryInterfaceTo(aUnattended.asOutParam());
+    }
+    return hrc;
+#else
+    NOREF(aUnattended);
+    return E_NOTIMPL;
+#endif
+}
+
 HRESULT Machine::applyDefaults(const com::Utf8Str &aFlags)
 {