Custom Action for Fast MSI

This repository contains a WIX/MSI Custom Action that supports the Chef and Chef Workstation Omnibus 'FastMSI' packager for Windows.

The FastMSI packager speeds up installs by creating a zip archive that is simply unarchived to lay down the destination folder structure on install.

Acknowledgement

This custom action depends on 7zip to do the unzip.

Please see https://www.7-zip.org/ for more info.

Usage

Build

Habitat should be used to build the custom action binary. Running the build command inside of a Habitat Studio, will pull down all necessary build dependencies.

The built Habitat package will include a CustomActionFastMsi.CA.dll in its bin directory which will need to be packaged into the MSI by the WIX tools (see below).

WIX Integration

The following code snippet illustrates show to use the code from within a WIX source file:

First, define the custom action and properties it requires:

<SetProperty Id="FastUnzip"
             Value="FASTZIPDIR=[INSTALLLOCATION];FASTZIPAPPNAME=yourapp"
             Sequence="execute"
             Before="FastUnzip" />

 <CustomAction Id="FastUnzip"
               BinaryKey="CustomActionFastMsiDLL"
               DllEntry="FastUnzip"
               Execute="deferred"
               Return="check"
               Impersonate="no" />

 <Binary Id="CustomActionFastMsiDLL"
         SourceFile="CustomActionFastMsi.CA.dll" />

Then, add the custom action into the install sequence:

<InstallExecuteSequence>
  <Custom Action="FastUnzip" After="InstallFiles">NOT Installed or REINSTALL</Custom>
</InstallExecuteSequence>

Use the WIX tools (heat/candle/light) to build your MSI as usual. Make sure that the generated custom action dll is in your staging folder so that it can be included into your MSI package.

Troubleshooting

1. Use the Orca tool to check your generated MSI and make sure the custom action is present in the MSI.

2. Use verbose logging to check for errors, etc:

msiexec /i package.msi /l*v install.log

License

Copyright 2015 Chef Software, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.