public void FromChanges_CatalogChanged()
{
var targetFramework = new TargetFramework("tfm1");
var previousCatalogs = IProjectCatalogSnapshotFactory.Create();
var previousSnapshot = TargetedDependenciesSnapshot.CreateEmpty(targetFramework, previousCatalogs);
var updatedCatalogs = IProjectCatalogSnapshotFactory.Create();
var snapshot = TargetedDependenciesSnapshot.FromChanges(
previousSnapshot,
changes: null,
updatedCatalogs,
ImmutableArray <IDependenciesSnapshotFilter> .Empty,
new Dictionary <string, IProjectDependenciesSubTreeProvider>(),
null);
Assert.NotSame(previousSnapshot, snapshot);
Assert.Same(updatedCatalogs, snapshot.Catalogs);
Assert.Equal(previousSnapshot.Dependencies.Length, snapshot.Dependencies.Length);
for (int i = 0; i < previousSnapshot.Dependencies.Length; i++)
{
Assert.Same(previousSnapshot.Dependencies[i], snapshot.Dependencies[i]);
}
Assert.False(snapshot.HasVisibleUnresolvedDependency);
Assert.Empty(snapshot.Dependencies);
}
public void Constructor_ThrowsIfActiveTargetFrameworkNotEmptyAndNotInDependenciesByTargetFramework_WithTargets()
{
#if false
var tfm1 = new TargetFramework("tfm1");
var tfm2 = new TargetFramework("tfm2");
var tfm3 = new TargetFramework("tfm3");
var ex = Assert.Throws <ArgumentException>(() => new DependenciesSnapshot(
activeTargetFramework: tfm1,
dependenciesByTargetFramework: ImmutableDictionary <TargetFramework, TargetedDependenciesSnapshot> .Empty
.Add(tfm2, TargetedDependenciesSnapshot.CreateEmpty(tfm1, null))
.Add(tfm3, TargetedDependenciesSnapshot.CreateEmpty(tfm1, null))));
Assert.StartsWith("Value \"tfm1\" is unexpected. Must be a key in dependenciesByTargetFramework, which contains \"tfm2\", \"tfm3\".", ex.Message);
#else
var tfm1 = new TargetFramework("tfm1");
var tfm2 = new TargetFramework("tfm2");
var tfm3 = new TargetFramework("tfm3");
_ = new DependenciesSnapshot(
activeTargetFramework: tfm1,
dependenciesByTargetFramework: ImmutableDictionary <TargetFramework, TargetedDependenciesSnapshot> .Empty
.Add(tfm2, TargetedDependenciesSnapshot.CreateEmpty(tfm1, null))
.Add(tfm3, TargetedDependenciesSnapshot.CreateEmpty(tfm1, null)));
#endif
}
public void FromChanges_AddingToEmpty()
{
var targetFramework = new TargetFramework("tfm1");
var catalogs = IProjectCatalogSnapshotFactory.Create();
var previousSnapshot = TargetedDependenciesSnapshot.CreateEmpty(targetFramework, catalogs);
var resolved = new TestDependencyModel
{
ProviderType = "Xxx",
Id = "dependency1",
OriginalItemSpec = "Dependency1",
Caption = "Dependency1",
Resolved = true,
Flags = DependencyTreeFlags.Resolved,
Icon = KnownMonikers.Uninstall,
ExpandedIcon = KnownMonikers.Uninstall
};
var unresolved = new TestDependencyModel
{
ProviderType = "Xxx",
Id = "dependency2",
OriginalItemSpec = "Dependency2",
Caption = "Dependency2",
Resolved = false,
Flags = DependencyTreeFlags.Unresolved,
Icon = KnownMonikers.Uninstall,
ExpandedIcon = KnownMonikers.Uninstall
};
var changes = new DependenciesChangesBuilder();
changes.Added(resolved);
changes.Added(unresolved);
var snapshot = TargetedDependenciesSnapshot.FromChanges(
previousSnapshot,
changes.TryBuildChanges() !,
catalogs,
ImmutableArray <IDependenciesSnapshotFilter> .Empty,
new Dictionary <string, IProjectDependenciesSubTreeProvider>(),
null);
Assert.NotSame(previousSnapshot, snapshot);
Assert.Same(catalogs, snapshot.Catalogs);
Assert.True(snapshot.HasVisibleUnresolvedDependency);
AssertEx.CollectionLength(snapshot.Dependencies, 2);
Assert.Contains(snapshot.Dependencies, resolved.Matches);
Assert.Contains(snapshot.Dependencies, unresolved.Matches);
}
private static ImmutableDictionary <TargetFramework, TargetedDependenciesSnapshot> CreateDependenciesByTargetFramework(
IProjectCatalogSnapshot catalogs,
params TargetFramework[] targetFrameworks)
{
var dic = ImmutableDictionary <TargetFramework, TargetedDependenciesSnapshot> .Empty;
foreach (var targetFramework in targetFrameworks)
{
dic = dic.Add(targetFramework, TargetedDependenciesSnapshot.CreateEmpty(targetFramework, catalogs));
}
return(dic);
}
public void CreateEmpty()
{
var targetFramework = new TargetFramework("tfm1");
var catalogs = IProjectCatalogSnapshotFactory.Create();
var snapshot = TargetedDependenciesSnapshot.CreateEmpty(targetFramework, catalogs);
Assert.Same(targetFramework, snapshot.TargetFramework);
Assert.Same(catalogs, snapshot.Catalogs);
Assert.Equal(DiagnosticLevel.None, snapshot.MaximumVisibleDiagnosticLevel);
Assert.Empty(snapshot.Dependencies);
Assert.Equal(DiagnosticLevel.None, snapshot.GetMaximumVisibleDiagnosticLevelForProvider("foo"));
}
public void CreateEmpty()
{
var targetFramework = new TargetFramework("tfm1");
var catalogs = IProjectCatalogSnapshotFactory.Create();
var snapshot = TargetedDependenciesSnapshot.CreateEmpty(targetFramework, catalogs);
Assert.Same(targetFramework, snapshot.TargetFramework);
Assert.Same(catalogs, snapshot.Catalogs);
Assert.False(snapshot.HasVisibleUnresolvedDependency);
Assert.Empty(snapshot.Dependencies);
Assert.False(snapshot.CheckForUnresolvedDependencies("foo"));
}
public void FromChanges_NoChanges()
{
var targetFramework = new TargetFramework("tfm1");
var catalogs = IProjectCatalogSnapshotFactory.Create();
var previousSnapshot = TargetedDependenciesSnapshot.CreateEmpty(targetFramework, catalogs);
var snapshot = TargetedDependenciesSnapshot.FromChanges(
previousSnapshot,
changes: null,
catalogs,
ImmutableArray <IDependenciesSnapshotFilter> .Empty);
Assert.Same(previousSnapshot, snapshot);
}
public DependenciesSnapshot SetTargets(
ImmutableArray <ITargetFramework> targetFrameworks,
ITargetFramework activeTargetFramework)
{
bool activeChanged = !activeTargetFramework.Equals(ActiveTargetFramework);
ImmutableDictionary <ITargetFramework, TargetedDependenciesSnapshot> map = DependenciesByTargetFramework;
var diff = new SetDiff <ITargetFramework>(map.Keys, targetFrameworks);
map = map.RemoveRange(diff.Removed);
map = map.AddRange(
diff.Added.Select(
added => new KeyValuePair <ITargetFramework, TargetedDependenciesSnapshot>(
added,
TargetedDependenciesSnapshot.CreateEmpty(added, null))));
if (activeChanged || !ReferenceEquals(map, DependenciesByTargetFramework))
{
return(new DependenciesSnapshot(activeTargetFramework, map));
}
return(this);
}
public void FromChanges_CatalogChanged()
{
var targetFramework = new TargetFramework("tfm1");
var previousCatalogs = IProjectCatalogSnapshotFactory.Create();
var previousSnapshot = TargetedDependenciesSnapshot.CreateEmpty(targetFramework, previousCatalogs);
var updatedCatalogs = IProjectCatalogSnapshotFactory.Create();
var snapshot = TargetedDependenciesSnapshot.FromChanges(
previousSnapshot,
changes: null,
updatedCatalogs,
ImmutableArray <IDependenciesSnapshotFilter> .Empty);
Assert.NotSame(previousSnapshot, snapshot);
Assert.Same(updatedCatalogs, snapshot.Catalogs);
Assert.Equal(previousSnapshot.Dependencies.Length, snapshot.Dependencies.Length);
for (int i = 0; i < previousSnapshot.Dependencies.Length; i++)
{
Assert.Same(previousSnapshot.Dependencies[i], snapshot.Dependencies[i]);
}
Assert.Equal(DiagnosticLevel.None, snapshot.MaximumVisibleDiagnosticLevel);
Assert.Empty(snapshot.Dependencies);
}
/// <summary>
/// Updates the <see cref="TargetedDependenciesSnapshot"/> corresponding to <paramref name="changedTargetFramework"/>,
/// returning either:
/// <list type="bullet">
/// <item>An updated <see cref="DependenciesSnapshot"/> object, or</item>
/// <item>the immutable <paramref name="previousSnapshot"/> if no changes were made.</item>
/// </list>
/// </summary>
/// <remarks>
/// As part of the update, each <see cref="IDependenciesSnapshotFilter"/> in <paramref name="snapshotFilters"/>
/// is given a chance to influence the addition and removal of dependency data in the returned snapshot.
/// </remarks>
/// <returns>An updated snapshot, or <paramref name="previousSnapshot"/> if no changes occured.</returns>
public static DependenciesSnapshot FromChanges(
DependenciesSnapshot previousSnapshot,
ITargetFramework changedTargetFramework,
IDependenciesChanges?changes,
IProjectCatalogSnapshot?catalogs,
ImmutableArray <ITargetFramework> targetFrameworks,
ITargetFramework?activeTargetFramework,
ImmutableArray <IDependenciesSnapshotFilter> snapshotFilters,
IReadOnlyDictionary <string, IProjectDependenciesSubTreeProvider> subTreeProviderByProviderType,
IImmutableSet <string>?projectItemSpecs)
{
Requires.NotNull(previousSnapshot, nameof(previousSnapshot));
Requires.NotNull(changedTargetFramework, nameof(changedTargetFramework));
Requires.Argument(!snapshotFilters.IsDefault, nameof(snapshotFilters), "Cannot be default.");
Requires.NotNull(subTreeProviderByProviderType, nameof(subTreeProviderByProviderType));
var builder = previousSnapshot.DependenciesByTargetFramework.ToBuilder();
if (!builder.TryGetValue(changedTargetFramework, out TargetedDependenciesSnapshot previousTargetedSnapshot))
{
previousTargetedSnapshot = TargetedDependenciesSnapshot.CreateEmpty(changedTargetFramework, catalogs);
}
bool builderChanged = false;
var newTargetedSnapshot = TargetedDependenciesSnapshot.FromChanges(
previousTargetedSnapshot,
changes,
catalogs,
snapshotFilters,
subTreeProviderByProviderType,
projectItemSpecs);
if (!ReferenceEquals(previousTargetedSnapshot, newTargetedSnapshot))
{
builder[changedTargetFramework] = newTargetedSnapshot;
builderChanged = true;
}
SyncTargetFrameworks();
activeTargetFramework ??= previousSnapshot.ActiveTargetFramework;
if (builderChanged)
{
// Dependencies-by-target-framework has changed
return(new DependenciesSnapshot(
activeTargetFramework,
builder.ToImmutable()));
}
if (!activeTargetFramework.Equals(previousSnapshot.ActiveTargetFramework))
{
// The active target framework changed
return(new DependenciesSnapshot(
activeTargetFramework,
previousSnapshot.DependenciesByTargetFramework));
}
// Nothing has changed, so return the same snapshot
return(previousSnapshot);
void SyncTargetFrameworks()
{
// Only sync if a the full list of target frameworks has been provided
if (targetFrameworks.IsDefault)
{
return;
}
// This is a long-winded way of doing this that minimises allocations
// Ensure all required target frameworks are present
foreach (ITargetFramework targetFramework in targetFrameworks)
{
if (!builder.ContainsKey(targetFramework))
{
builder.Add(targetFramework, TargetedDependenciesSnapshot.CreateEmpty(targetFramework, catalogs));
builderChanged = true;
}
}
// Remove any extra target frameworks
if (builder.Count != targetFrameworks.Length)
{
// NOTE We need "ToList" here as "Except" is lazy, and attempts to remove from the builder
// while iterating will throw "Collection was modified"
IEnumerable <ITargetFramework> targetFrameworksToRemove = builder.Keys.Except(targetFrameworks).ToList();
foreach (ITargetFramework targetFramework in targetFrameworksToRemove)
{
builder.Remove(targetFramework);
}
builderChanged = true;
}
}
}