Bug 33831 - Build fails on Android projects with Multi-Dex enabled using Visual Studio due to empty multidex.keep file
Summary: Build fails on Android projects with Multi-Dex enabled using Visual Studio du...
Status: RESOLVED FIXED
Alias: None
Product: Visual Studio Extensions
Classification: Xamarin
Component: Android ()
Version: 3.11 (C5)
Hardware: PC Windows
: --- normal
Target Milestone: ---
Assignee: Ashley Gazich [MSFT]
URL:
Depends on:
Blocks:
 
Reported: 2015-09-09 19:45 UTC by Ashley Gazich [MSFT]
Modified: 2016-05-19 17:53 UTC (History)
6 users (show)

Tags:
Is this bug a regression?: ---
Last known good build:

Notice (2018-05-24): bugzilla.xamarin.com is now in read-only mode.

Please join us on Visual Studio Developer Community and in the Xamarin and Mono organizations on GitHub to continue tracking issues. Bugzilla will remain available for reference in read-only mode. We will continue to work on open Bugzilla bugs, copy them to the new locations as needed for follow-up, and add the new items under Related Links.

Our sincere thanks to everyone who has contributed on this bug tracker over the years. Thanks also for your understanding as we make these adjustments and improvements for the future.


Please create a new report on Developer Community with your current version information, steps to reproduce, and relevant error messages or log files if you are hitting an issue that looks similar to this resolved bug and you do not yet see a matching new report.

Related Links:
Status:
RESOLVED FIXED

Description Ashley Gazich [MSFT] 2015-09-09 19:45:56 UTC
Build fails on Android projects with Multi-Dex enabled using Visual Studio due to empty multidex.keep file.

##Steps to reproduce

1. Open new Android app in Visual Studios
2. Go to Project properties > Android Options
3. Check “Enable Multi-Dex”
4. Build project
5. Observe build failure

##Results

Customer build output: https://drive.google.com/open?id=0B_5pvct1AELzdi1Yb2lLcTZFaTQ
Build output [Windows 8.1 VM via Parallels] (Xamarin support): https://gist.github.com/ashley-marie/4cc34e1ba97b70f67fb5
Builds successfully on Mac (Xamarin support): https://gist.github.com/ashley-marie/2911ada84fde89368576
Non-empty multidex.keep on Mac (Xamarin support): https://gist.github.com/ashley-marie/b98840b6be7a7d55c556


##Customer Version info

Microsoft Visual Studio Professional 2013
Version 12.0.31101.00 Update 4
Microsoft .NET Framework
Version 4.5.51650

Installed Version: Professional

LightSwitch for Visual Studio 2013 06177-004-0447006-02468
Microsoft LightSwitch for Visual Studio 2013

Team Explorer for Visual Studio 2013 06177-004-0447006-02468
Microsoft Team Explorer for Visual Studio 2013

Visual Basic 2013 06177-004-0447006-02468
Microsoft Visual Basic 2013

Visual C# 2013 06177-004-0447006-02468
Microsoft Visual C# 2013

Visual C++ 2013 06177-004-0447006-02468
Microsoft Visual C++ 2013

Visual F# 2013 06177-004-0447006-02468
Microsoft Visual F# 2013

Visual Studio 2013 Code Analysis Spell Checker 06177-004-0447006-02468
Microsoft® Visual Studio® 2013 Code Analysis Spell Checker

Portions of International CorrectSpell™ spelling correction system © 1993 by Lernout & Hauspie Speech Products N.V. All rights reserved.

The American Heritage® Dictionary of the English Language, Third Edition Copyright © 1992 Houghton Mifflin Company. Electronic version licensed from Lernout & Hauspie Speech Products N.V. All rights reserved.

Windows Phone SDK 8.0 - ENU 06177-004-0447006-02468
Windows Phone SDK 8.0 - ENU

Application Insights Tools for Visual Studio Package 1.0
Application Insights Tools for Visual Studio

ASP.NET and Web Tools 12.4.51016.0
Microsoft Web Developer Tools contains the following components:
Support for creating and opening ASP.NET web projects
Browser Link: A communication channel between Visual Studio and browsers
Editor extensions for HTML, CSS, and JavaScript
Page Inspector: Inspection tool for ASP.NET web projects
Scaffolding: A framework for building and running code generators
Server Explorer extensions for Microsoft Azure Websites
Web publishing: Extensions for publishing ASP.NET web projects to hosting providers, on-premises servers, or Microsoft Azure

ASP.NET Web Frameworks and Tools 2012.2 4.1.21001.0
For additional information, visit http://go.microsoft.com/fwlink/?LinkID=309563

ASP.NET Web Frameworks and Tools 2013 5.2.21010.0
For additional information, visit http://www.asp.net/

Common Azure Tools 1.3
Provides common services for use by Azure Mobile Services and Microsoft Azure Tools.

JetBrains ReSharper Ultimate 2015.1 Build 102.0.20150408.145317
JetBrains ReSharper Ultimate package for Microsoft Visual Studio. For more information about ReSharper Ultimate, visit http://www.jetbrains.com/resharper. Copyright © 2015 JetBrains, Inc.

Microsoft Azure Mobile Services Tools 1.3
Microsoft Azure Mobile Services Tools

NuGet Package Manager 2.8.60318.734
NuGet Package Manager in Visual Studio. For more information about NuGet, visit http://docs.nuget.org/.

Office Developer Tools for Visual Studio 2013 ENU 12.0.30626
Microsoft Office Developer Tools for Visual Studio 2013 ENU

PowerShell Tools 1.3
Provides file classification services using PowerShell

PreEmptive Analytics Visualizer 1.2
Microsoft Visual Studio extension to visualize aggregated summaries from the PreEmptive Analytics product.

SQL Server Data Tools 12.0.41012.0
Microsoft SQL Server Data Tools

Windows Phone 8.1 SDK Integration 1.0
This package integrates the tools for the Windows Phone 8.1 SDK into the menus and controls of Visual Studio.

Workflow Manager Tools 1.0 1.0
This package contains the necessary Visual Studio integration components for Workflow Manager.

Xamarin 3.11.666.0 (ebae43a)
Visual Studio extension to enable development for Xamarin.iOS and Xamarin.Android.

Xamarin.Android 5.1.4.16 (5f55a9ef61c11b6ce0890bc91e4c71b1b92be214)
Visual Studio plugin to enable development for Xamarin.Android.

Xamarin.Forms Intellisense 1.0
Provides intellisense for Xamarin.Forms in the XML editor.

Xamarin.iOS 8.10.2.0 (67b390d0d1bd741582cf7b7fd3ffea08583a3f83)
Visual Studio extension to enable development for Xamarin.iOS.

Xamarin.iOS Unified Migration 1.0
Automated migration for Xamarin iOS Classic projects to Unified

Xamarin.TestCloud.Integration 1.0
Early preview of Xamarin Test Cloud integration
Comment 1 Enzo Heredia 2015-09-10 10:51:23 UTC
this is not reproducible with 4.0.0.1276. Can you verify please?
Comment 2 Jon Douglas [MSFT] 2016-05-19 17:53:18 UTC
I believe this is a bug with Android's build-tools on windows which generates an empty multidex.keep file. Known workaround:

Open the directory: android-sdk\build-tools\23.0.3

There should be a mainDexClasses.bat file inside on Windows. Let's make a copy of this just in case something goes wrong.

Let's open up the mainDexClasses.bat file in an editor and let's add an addition here:

Change:

if DEFINED output goto redirect
call "%java_exe%" -Djava.ext.dirs="%frameworkdir%" com.android.multidex.MainDexListBuilder "%disableKeepAnnotated%" "%tmpJar%" "%params%"
goto afterClassReferenceListBuilder
:redirect
call "%java_exe%" -Djava.ext.dirs="%frameworkdir%" com.android.multidex.MainDexListBuilder "%disableKeepAnnotated%" "%tmpJar%" "%params%" 1>"%output%"
:afterClassReferenceListBuilder

to:

SET params=%params:'=%
if DEFINED output goto redirect
call "%java_exe%" -Djava.ext.dirs="%frameworkdir%" com.android.multidex.MainDexListBuilder %disableKeepAnnotated% "%tmpJar%" %params%
goto afterClassReferenceListBuilder
:redirect
call "%java_exe%" -Djava.ext.dirs="%frameworkdir%" com.android.multidex.MainDexListBuilder %disableKeepAnnotated% "%tmpJar%" %params% 1>"%output%"
:afterClassReferenceListBuilder

You could optionally just set the "params" item to the correct params defined above(There's other definitions). At least in my personal params, it's an empty definition.

After this is completed, you should get a multidex.keep file that actually is defined.

i.e.

md5acddc4e03c5d54923c9959e2bbaa85d7/CustomApplication.class
android/support/multidex/ZipUtil$CentralDirectory.class
android/support/multidex/MultiDex$V4.class
mono/android/app/Application$NotifyTimeZoneChanges.class
android/support/multidex/MultiDex$V14.class
mono/MonoPackageManager.class
mono/android/TypeManager.class
android/support/multidex/MultiDex.class
md5acddc4e03c5d54923c9959e2bbaa85d7/MainActivity.class
android/support/multidex/MultiDexApplication.class
android/support/multidex/MultiDex$V19.class
android/support/multidex/ZipUtil.class
mono/android/app/Application.class
mono/android/Runtime.class
android/support/multidex/MultiDexExtractor$1.class
android/support/multidex/MultiDexExtractor.class
mono/android/IGCUserPeer.class
mono/MonoRuntimeProvider.class
mono/android/app/IntentService.class

This is a bug on google's end in the build-tools <= 23.0.3 (https://code.google.com/p/android/issues/detail?id=187721)