public void CheckForSpecificMetadataOnParent()
{
Reference reference = new Reference(isWinMDFile, fileExists, getRuntimeVersion);
ITaskItem taskItem = new TaskItem("TestReference");
taskItem.SetMetadata("SpecificVersion", "true");
reference.MakePrimaryAssemblyReference(taskItem, true, ".dll");
Assert.True(reference.CheckForSpecificVersionMetadataOnParentsReference(false));
}
public void CheckForSpecificMetadataOnParentNotAllParentsHaveMetadata()
{
Reference primaryReference1 = new Reference(isWinMDFile, fileExists, getRuntimeVersion);
ITaskItem taskItem = new TaskItem("TestPrimary1");
taskItem.SetMetadata("SpecificVersion", "false");
primaryReference1.MakePrimaryAssemblyReference(taskItem, false, ".dll");
primaryReference1.FullPath = "FullPath";
Reference primaryReference2 = new Reference(isWinMDFile, fileExists, getRuntimeVersion);
ITaskItem taskItem2 = new TaskItem("TestPrimary2");
taskItem2.SetMetadata("SpecificVersion", "true");
primaryReference2.MakePrimaryAssemblyReference(taskItem2, true, ".dll");
primaryReference2.FullPath = "FullPath";
Reference dependentReference = new Reference(isWinMDFile, fileExists, getRuntimeVersion);
dependentReference.FullPath = "FullPath";
dependentReference.MakeDependentAssemblyReference(primaryReference1);
dependentReference.MakeDependentAssemblyReference(primaryReference2);
Assert.False(dependentReference.CheckForSpecificVersionMetadataOnParentsReference(false)); // "Expected check to return false but it returned true."
}
/// <summary>
/// Given an item that refers to a file name, make it a primary reference.
/// </summary>
/// <param name="referenceAssemblyFile"></param>
private void SetPrimaryFileItem(ITaskItem referenceAssemblyFile)
{
try
{
// Create the reference.
Reference reference = new Reference(_isWinMDFile, _fileExists, _getRuntimeVersion);
bool hasSpecificVersionMetadata = MetadataConversionUtilities.TryConvertItemMetadataToBool(referenceAssemblyFile, ItemMetadataNames.specificVersion);
reference.MakePrimaryAssemblyReference
(
referenceAssemblyFile,
hasSpecificVersionMetadata,
Path.GetExtension(referenceAssemblyFile.ItemSpec)
);
AssemblyNameExtension assemblyName = NameAssemblyFileReference
(
reference,
referenceAssemblyFile.ItemSpec // Contains the assembly file name.
);
// Embed Interop Types aka "NOPIAs" support is not available for Fx < 4.0
// So, we just ignore this setting on down-level platforms
if (_projectTargetFramework >= s_targetFrameworkVersion_40)
{
reference.EmbedInteropTypes = MetadataConversionUtilities.TryConvertItemMetadataToBool
(
referenceAssemblyFile,
ItemMetadataNames.embedInteropTypes
);
}
AddReference(assemblyName, reference);
}
catch (Exception e) // Catching Exception, but rethrowing unless it's an IO related exception.
{
if (ExceptionHandling.NotExpectedException(e))
throw;
// Invalid file path.
throw new InvalidParameterValueException("AssemblyFiles", referenceAssemblyFile.ItemSpec, e.Message);
}
}
/// <summary>
/// Given an item that refers to a assembly name, make it a primary reference.
/// </summary>
/// <param name="referenceAssemblyNames">The task item which contain fusion names to add.</param>
/// <returns>Resulting exception containing resolution failure details, if any: too costly to throw it.</returns>
private Exception SetPrimaryAssemblyReferenceItem
(
ITaskItem referenceAssemblyName
)
{
// Get the desired executable extension.
string executableExtension = referenceAssemblyName.GetMetadata(ItemMetadataNames.executableExtension);
// Get the assembly name, if possible.
string rawFileNameCandidate = referenceAssemblyName.ItemSpec;
AssemblyNameExtension assemblyName = null;
string itemSpec = referenceAssemblyName.ItemSpec;
string fusionName = referenceAssemblyName.GetMetadata(ItemMetadataNames.fusionName);
bool metadataFound = false;
bool result = MetadataConversionUtilities.TryConvertItemMetadataToBool(referenceAssemblyName, ItemMetadataNames.IgnoreVersionForFrameworkReference, out metadataFound);
bool ignoreVersionForFrameworkReference = false;
if (metadataFound)
{
ignoreVersionForFrameworkReference = result;
}
else
{
ignoreVersionForFrameworkReference = _ignoreVersionForFrameworkReferences;
}
TryConvertToAssemblyName(itemSpec, fusionName, ref assemblyName);
// Figure out the specific version value.
bool foundSpecificVersionMetadata = false;
bool wantSpecificVersion = MetadataConversionUtilities.TryConvertItemMetadataToBool(referenceAssemblyName, ItemMetadataNames.specificVersion, out foundSpecificVersionMetadata);
bool isSimpleName = (assemblyName != null && assemblyName.IsSimpleName);
// Create the reference.
Reference reference = new Reference(_isWinMDFile, _fileExists, _getRuntimeVersion);
reference.MakePrimaryAssemblyReference(referenceAssemblyName, wantSpecificVersion, executableExtension);
// Escape simple names.
// 1) If the itemSpec for the task is already a simple name
// 2) We have found the metadata and it is specifically set to false
if (assemblyName != null && (isSimpleName || (foundSpecificVersionMetadata && !wantSpecificVersion)))
{
assemblyName = new AssemblyNameExtension
(
AssemblyNameExtension.EscapeDisplayNameCharacters(assemblyName.Name)
);
isSimpleName = assemblyName.IsSimpleName;
}
// Set the HintPath if there is one.
reference.HintPath = referenceAssemblyName.GetMetadata(ItemMetadataNames.hintPath);
if (assemblyName != null && !wantSpecificVersion && !isSimpleName && reference.HintPath.Length == 0)
{
// Check to see if the assemblyname is in the framework list just use that fusion name
if (_installedAssemblies != null && ignoreVersionForFrameworkReference)
{
AssemblyEntry entry = _installedAssemblies.FindHighestVersionInRedistList(assemblyName);
if (entry != null)
{
assemblyName = entry.AssemblyNameExtension.Clone();
}
}
}
if (assemblyName != null && _installedAssemblies != null && !wantSpecificVersion && reference.HintPath.Length == 0)
{
AssemblyNameExtension remappedExtension = _installedAssemblies.RemapAssemblyExtension(assemblyName);
if (remappedExtension != null)
{
reference.AddRemapping(assemblyName.CloneImmutable(), remappedExtension.CloneImmutable());
assemblyName = remappedExtension;
}
}
// Embed Interop Types aka "NOPIAs" support is not available for Fx < 4.0
// So, we just ignore this setting on down-level platforms
if (_projectTargetFramework != null && _projectTargetFramework >= s_targetFrameworkVersion_40)
{
reference.EmbedInteropTypes = MetadataConversionUtilities.TryConvertItemMetadataToBool
(
referenceAssemblyName,
ItemMetadataNames.embedInteropTypes
);
}
// Set the AssemblyFolderKey if there is one.
reference.AssemblyFolderKey = referenceAssemblyName.GetMetadata(ItemMetadataNames.assemblyFolderKey);
// It's possible, especially in cases where the fusion name was passed in through the item
// that we'll have a better (more information) fusion name once we know the assembly path.
try
{
ResolveReference(assemblyName, rawFileNameCandidate, reference);
if (reference.IsResolved)
{
AssemblyNameExtension possiblyBetterAssemblyName = null;
try
{
// This may throw if, for example, the culture embedded in the assembly's manifest
// is not recognised by AssemblyName.GetAssemblyName
possiblyBetterAssemblyName = _getAssemblyName(reference.FullPath);
}
catch (ArgumentException)
{
// Give up trying to get a better name
possiblyBetterAssemblyName = null;
}
// Use the better name if it exists.
if (possiblyBetterAssemblyName != null && possiblyBetterAssemblyName.Name != null)
{
assemblyName = possiblyBetterAssemblyName;
}
}
}
catch (BadImageFormatException e)
{
// If this isn't a valid assembly, then record the exception and continue on
reference.AddError(new BadImageReferenceException(e.Message, e));
}
catch (FileNotFoundException e) // Why isn't this covered in NotExpectedException?
{
reference.AddError(new BadImageReferenceException(e.Message, e));
}
catch (FileLoadException e)
{
// Managed assembly was found but could not be loaded.
reference.AddError(new BadImageReferenceException(e.Message, e));
}
catch (Exception e) // Catching Exception, but rethrowing unless it's an IO related exception.
{
if (ExceptionHandling.NotExpectedException(e))
throw;
reference.AddError(new BadImageReferenceException(e.Message, e));
}
// If there is still no assembly name then this is a case where the assembly metadata
// just doesn't contain an assembly name. We want to try to tolerate this because
// mscorlib.dll (sometimes?) doesn't contain an assembly name.
if (assemblyName == null)
{
if (!reference.IsResolved)
{
// The file doesn't exist and the reference was unresolved, there's nothing we can do at this point.
// Return, rather than throw, the exception, as in some situations it can happen thousands of times.
return new InvalidReferenceAssemblyNameException(referenceAssemblyName.ItemSpec);
}
assemblyName = new AssemblyNameExtension
(
AssemblyNameExtension.EscapeDisplayNameCharacters(reference.FileNameWithoutExtension)
);
}
// Check to see if this is a prereq assembly.
if (_installedAssemblies == null)
{
reference.IsPrerequisite = false;
}
else
{
Version unifiedVersion = null;
bool isPrerequisite = false;
bool? isRedistRoot = null;
string redistName = null;
_installedAssemblies.GetInfo
(
assemblyName,
out unifiedVersion,
out isPrerequisite,
out isRedistRoot,
out redistName
);
reference.IsPrerequisite = isPrerequisite;
reference.IsRedistRoot = isRedistRoot;
reference.RedistName = redistName;
}
AddReference(assemblyName, reference);
return null;
}
private void SetPrimaryFileItem(ITaskItem referenceAssemblyFile)
{
try
{
Reference reference = new Reference();
bool wantSpecificVersionValue = MetadataConversionUtilities.TryConvertItemMetadataToBool(referenceAssemblyFile, "SpecificVersion");
reference.MakePrimaryAssemblyReference(referenceAssemblyFile, wantSpecificVersionValue, Path.GetExtension(referenceAssemblyFile.ItemSpec));
AssemblyNameExtension assemblyName = this.NameAssemblyFileReference(reference, referenceAssemblyFile.ItemSpec);
if (this.projectTargetFramework >= TargetFrameworkVersion_40)
{
reference.EmbedInteropTypes = MetadataConversionUtilities.TryConvertItemMetadataToBool(referenceAssemblyFile, "EmbedInteropTypes");
}
this.AddReference(assemblyName, reference);
}
catch (Exception exception)
{
if (Microsoft.Build.Shared.ExceptionHandling.NotExpectedException(exception))
{
throw;
}
throw new InvalidParameterValueException("AssemblyFiles", referenceAssemblyFile.ItemSpec, exception.Message);
}
}
private void SetPrimaryAssemblyReferenceItem(ITaskItem referenceAssemblyName)
{
string metadata = referenceAssemblyName.GetMetadata("ExecutableExtension");
string itemSpec = referenceAssemblyName.ItemSpec;
AssemblyNameExtension assemblyName = null;
string str3 = referenceAssemblyName.ItemSpec;
string fusionName = referenceAssemblyName.GetMetadata("FusionName");
TryConvertToAssemblyName(str3, fusionName, ref assemblyName);
bool metadataFound = false;
bool wantSpecificVersionValue = MetadataConversionUtilities.TryConvertItemMetadataToBool(referenceAssemblyName, "SpecificVersion", out metadataFound);
bool flag3 = (assemblyName != null) && assemblyName.IsSimpleName;
Reference reference = new Reference();
reference.MakePrimaryAssemblyReference(referenceAssemblyName, wantSpecificVersionValue, metadata);
if ((assemblyName != null) && (flag3 || (metadataFound && !wantSpecificVersionValue)))
{
assemblyName = new AssemblyNameExtension(AssemblyNameExtension.EscapeDisplayNameCharacters(assemblyName.Name));
}
reference.HintPath = referenceAssemblyName.GetMetadata("HintPath");
if ((this.projectTargetFramework != null) && (this.projectTargetFramework >= TargetFrameworkVersion_40))
{
reference.EmbedInteropTypes = MetadataConversionUtilities.TryConvertItemMetadataToBool(referenceAssemblyName, "EmbedInteropTypes");
}
reference.AssemblyFolderKey = referenceAssemblyName.GetMetadata("AssemblyFolderKey");
try
{
this.ResolveReference(assemblyName, itemSpec, reference);
if (reference.IsResolved)
{
AssemblyNameExtension extension2 = null;
try
{
extension2 = this.getAssemblyName(reference.FullPath);
}
catch (ArgumentException)
{
extension2 = null;
}
if ((extension2 != null) && (extension2.Name != null))
{
assemblyName = extension2;
}
}
}
catch (BadImageFormatException exception)
{
reference.AddError(new BadImageReferenceException(exception.Message, exception));
}
catch (FileNotFoundException exception2)
{
reference.AddError(new BadImageReferenceException(exception2.Message, exception2));
}
catch (FileLoadException exception3)
{
reference.AddError(new BadImageReferenceException(exception3.Message, exception3));
}
catch (Exception exception4)
{
if (Microsoft.Build.Shared.ExceptionHandling.NotExpectedException(exception4))
{
throw;
}
reference.AddError(new BadImageReferenceException(exception4.Message, exception4));
}
if (assemblyName == null)
{
if (!reference.IsResolved)
{
throw new InvalidReferenceAssemblyNameException(referenceAssemblyName.ItemSpec);
}
assemblyName = new AssemblyNameExtension(AssemblyNameExtension.EscapeDisplayNameCharacters(reference.FileNameWithoutExtension));
}
if (this.installedAssemblies == null)
{
reference.IsPrerequisite = false;
}
else
{
Version unifiedVersion = null;
bool isPrerequisite = false;
bool? isRedistRoot = null;
string redistName = null;
this.installedAssemblies.GetInfo(assemblyName, out unifiedVersion, out isPrerequisite, out isRedistRoot, out redistName);
reference.IsPrerequisite = isPrerequisite;
reference.IsRedistRoot = isRedistRoot;
reference.RedistName = redistName;
}
this.AddReference(assemblyName, reference);
}
public void ReferenceTablePrimaryToPrimaryToDependencyWithOneInBlackList()
{
ReferenceTable referenceTable;
MockEngine mockEngine;
ResolveAssemblyReference rar;
Hashtable blackList;
AssemblyNameExtension engineAssemblyName = new AssemblyNameExtension("Microsoft.Build.Engine, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a");
AssemblyNameExtension xmlAssemblyName = new AssemblyNameExtension("System.Xml, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a");
AssemblyNameExtension dataAssemblyName = new AssemblyNameExtension("System.Data, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a");
Reference enginePrimaryReference = new Reference(isWinMDFile, fileExists, getRuntimeVersion);
Reference xmlPrimaryReference = new Reference(isWinMDFile, fileExists, getRuntimeVersion);
Reference dataDependencyReference = new Reference(isWinMDFile, fileExists, getRuntimeVersion);
TaskItem taskItem = new TaskItem("Microsoft.Build.Engine");
enginePrimaryReference.MakePrimaryAssemblyReference(taskItem, false, ".dll");
enginePrimaryReference.FullPath = "FullPath";
ITaskItem taskItem2 = new TaskItem("System.Xml");
xmlPrimaryReference.FullPath = "FullPath";
xmlPrimaryReference.MakePrimaryAssemblyReference(taskItem2, false, ".dll");
// Make engine depend on xml primary when xml primary is a primary reference as well
xmlPrimaryReference.AddSourceItems(enginePrimaryReference.GetSourceItems());
xmlPrimaryReference.AddDependee(enginePrimaryReference);
dataDependencyReference.FullPath = "FullPath";
dataDependencyReference.MakeDependentAssemblyReference(xmlPrimaryReference);
InitializeMockEngine(out referenceTable, out mockEngine, out rar);
AddReferencesToReferenceTable(referenceTable, engineAssemblyName, dataAssemblyName, null, xmlAssemblyName, enginePrimaryReference, dataDependencyReference, null, xmlPrimaryReference);
InitializeExclusionList(referenceTable, new AssemblyNameExtension[] { dataAssemblyName }, out blackList);
string subsetName = ResolveAssemblyReference.GenerateSubSetName(new string[] { "Client" }, null);
string warningMessage = rar.Log.FormatResourceString("ResolveAssemblyReference.FailBecauseDependentAssemblyInExclusionList", taskItem.ItemSpec, dataAssemblyName.FullName, subsetName);
string warningMessage2 = rar.Log.FormatResourceString("ResolveAssemblyReference.FailBecauseDependentAssemblyInExclusionList", taskItem2.ItemSpec, dataAssemblyName.FullName, subsetName);
mockEngine.AssertLogContains(warningMessage);
mockEngine.AssertLogContains(warningMessage2);
Dictionary<AssemblyNameExtension, Reference> table = referenceTable.References;
Assert.False(table.ContainsKey(xmlAssemblyName)); // "Expected to not find the xmlAssemblyName in the referenceList"
Assert.False(table.ContainsKey(engineAssemblyName)); // "Expected to not find the engineAssemblyName in the referenceList"
Assert.False(table.ContainsKey(dataAssemblyName)); // "Expected to not find the dataAssemblyName in the referenceList"
}
public void ReferenceTablePrimaryItemInBlackListRemoveOnlyNoWarn()
{
MockEngine mockEngine = new MockEngine();
ResolveAssemblyReference rar = new ResolveAssemblyReference();
rar.BuildEngine = mockEngine;
ReferenceTable referenceTable = MakeEmptyReferenceTable(rar.Log);
Dictionary<AssemblyNameExtension, Reference> table = referenceTable.References;
AssemblyNameExtension engineAssemblyName = new AssemblyNameExtension("Microsoft.Build.Engine, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a");
AssemblyNameExtension xmlAssemblyName = new AssemblyNameExtension("System.Xml, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a");
Reference reference = new Reference(isWinMDFile, fileExists, getRuntimeVersion);
TaskItem taskItem = new TaskItem("Microsoft.Build.Engine");
reference.MakePrimaryAssemblyReference(taskItem, false, ".dll");
table.Add(engineAssemblyName, reference);
table.Add(xmlAssemblyName, new Reference(isWinMDFile, fileExists, getRuntimeVersion));
Hashtable blackList = new Hashtable(StringComparer.OrdinalIgnoreCase);
blackList[engineAssemblyName.FullName] = null;
referenceTable.MarkReferencesForExclusion(blackList);
referenceTable.RemoveReferencesMarkedForExclusion(true, String.Empty);
Dictionary<AssemblyNameExtension, Reference> table2 = referenceTable.References;
string subSetName = ResolveAssemblyReference.GenerateSubSetName(new string[] { }, null);
string warningMessage = rar.Log.FormatResourceString("ResolveAssemblyReference.FailedToResolveReferenceBecausePrimaryAssemblyInExclusionList", taskItem.ItemSpec, subSetName);
Assert.False(Object.ReferenceEquals(table, table2)); // "Expected hashtable to be a different instance"
Assert.Equal(1, table2.Count); // "Expected there to be one elements in the hashtable"
Assert.False(table2.ContainsKey(engineAssemblyName)); // "Expected to not find the engineAssemblyName in the referenceList"
Assert.True(table2.ContainsKey(xmlAssemblyName)); // "Expected to find the xmlssemblyName in the referenceList"
Assert.True(String.IsNullOrEmpty(mockEngine.Log));
}
/// <summary>
/// Generate a fake reference which has been resolved from the gac. We will use it to verify the creation of the exclusion list.
/// </summary>
/// <returns></returns>
private ReferenceTable GenerateTableWithAssemblyFromTheGlobalLocation(string location)
{
ReferenceTable referenceTable = new ReferenceTable(null, false, false, false, false, new string[0], null, null, null, null, null, null, ProcessorArchitecture.None, fileExists, null, null, null, null, null, null, null, null, null, new Version("4.0"), null, null, null, true, false, null, null, false, null, WarnOrErrorOnTargetArchitectureMismatchBehavior.None, false, false);
AssemblyNameExtension assemblyNameExtension = new AssemblyNameExtension(new AssemblyName("Microsoft.VisualStudio.Interopt, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"));
TaskItem taskItem = new TaskItem("Microsoft.VisualStudio.Interopt, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089");
Reference reference = new Reference(isWinMDFile, fileExists, getRuntimeVersion);
reference.MakePrimaryAssemblyReference(taskItem, false, ".dll");
// "Resolve the assembly from the gac"
reference.FullPath = "c:\\Microsoft.VisualStudio.Interopt.dll";
reference.ResolvedSearchPath = location;
referenceTable.AddReference(assemblyNameExtension, reference);
assemblyNameExtension = new AssemblyNameExtension(new AssemblyName("Team.System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"));
taskItem = new TaskItem("Team, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089");
reference = new Reference(isWinMDFile, fileExists, getRuntimeVersion);
reference.MakePrimaryAssemblyReference(taskItem, false, ".dll");
// "Resolve the assembly from the gac"
reference.FullPath = "c:\\Team.System.dll";
reference.ResolvedSearchPath = location;
referenceTable.AddReference(assemblyNameExtension, reference);
return referenceTable;
}
public void ParentAssemblyResolvedFromAForGac()
{
Hashtable parentReferenceFolderHash = new Hashtable();
List<string> parentReferenceFolders = new List<string>();
List<Reference> referenceList = new List<Reference>();
TaskItem taskItem = new TaskItem("Microsoft.VisualStudio.Interopt, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089");
Reference reference = new Reference(isWinMDFile, fileExists, getRuntimeVersion);
reference.MakePrimaryAssemblyReference(taskItem, false, ".dll");
reference.FullPath = "c:\\AssemblyFolders\\Microsoft.VisualStudio.Interopt.dll";
reference.ResolvedSearchPath = "{AssemblyFolders}";
Reference reference2 = new Reference(isWinMDFile, fileExists, getRuntimeVersion);
reference2.MakePrimaryAssemblyReference(taskItem, false, ".dll");
reference2.FullPath = "c:\\SomeOtherFolder\\Microsoft.VisualStudio.Interopt2.dll";
reference2.ResolvedSearchPath = "c:\\SomeOtherFolder";
Reference reference3 = new Reference(isWinMDFile, fileExists, getRuntimeVersion);
reference3.MakePrimaryAssemblyReference(taskItem, false, ".dll");
reference3.FullPath = "c:\\SomeOtherFolder\\Microsoft.VisualStudio.Interopt3.dll";
reference3.ResolvedSearchPath = "{GAC}";
referenceList.Add(reference);
referenceList.Add(reference2);
referenceList.Add(reference3);
foreach (Reference parentReference in referenceList)
{
ReferenceTable.CalcuateParentAssemblyDirectories(parentReferenceFolderHash, parentReferenceFolders, parentReference);
}
Assert.Equal(1, parentReferenceFolders.Count);
Assert.True(parentReferenceFolders[0].Equals(reference2.ResolvedSearchPath, StringComparison.OrdinalIgnoreCase));
}