Skip to content

Add a hash of the VC profile executing to the telemetry output. #705

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
brdeyo merged 1 commit into from
May 12, 2026
Merged

Add a hash of the VC profile executing to the telemetry output. #705

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion VERSION
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
3.2.2
3.2.3
35 changes: 35 additions & 0 deletions src/VirtualClient/VirtualClient.Common/Extensions/CollectionExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ namespace VirtualClient.Common.Extensions
using System;
using System.Collections.Generic;
using System.Linq;
using System.Numerics;
using System.Security.Cryptography;
using System.Text;

/// <summary>
/// Extensions methods for collection classes used as part of the standard
Expand Down Expand Up @@ -78,6 +81,38 @@ public static void AddRange<T>(this HashSet<T> dictionary, IEnumerable<T> items)
}
}

/// <summary>
/// Computes a repeatable, predictable hash code for the byte array value provided.
/// </summary>
/// <param name="values">The string values from which to compute the hash code.</param>
/// <returns>A repeatable, predictable hash code.</returns>
public static BigInteger ComputeHashCode(this IEnumerable<string> values)
{
if (values?.Any() != true)
{
return -1;
}

byte[] hashBytes = SHA1.HashData(Encoding.UTF8.GetBytes(string.Join("|", values).ToUpperInvariant()));

// Normalize Endianness
// SHA-1 output is naturally Big-Endian.
// BigInteger constructor in .NET expects Little-Endian by default.
// To be safe across architectures, we force a specific order.
if (!BitConverter.IsLittleEndian)
{
Array.Reverse(hashBytes);
}

// Ensure the integer is interpreted as positive
// BigInteger uses the last bit for the sign (positive/negative).
// To ensure a positive number, we append a zero byte.
byte[] unsignedBytes = new byte[hashBytes.Length + 1];
Buffer.BlockCopy(hashBytes, 0, unsignedBytes, 0, hashBytes.Length);

return new BigInteger(unsignedBytes);
}

/// <summary>
/// Extensions returns true/false whether the two dictionary sets are semantically equal.
/// </summary>
Expand Down
301 changes: 301 additions & 0 deletions src/VirtualClient/VirtualClient.Contracts.UnitTests/ExecutionProfileElementTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,178 @@ public void ExecutionProfileElementIsJsonSerializableWithSequentialExecutionDefi
SerializationAssert.IsJsonSerializable<ExecutionProfileElement>(element);
}

[Test]
public void ExecutionProfileElementRepresentsStringConversionSemanticsCorrectly()
{
ExecutionProfileElement element = new ExecutionProfileElement(
"AnyType1",
new Dictionary<string, IConvertible>
{
{ "Parameter1", "ValueA" },
{ "Parameter2", 123.45 },
{ "Parameter3", true },
{ "Parameter4", "00:01:00" }
},
new Dictionary<string, IConvertible>
{
{ "Metadata1", "ValueB" },
{ "Metadata2", 6789.123 },
{ "Metadata3", false },
{ "Metadata4", "00:02:30" }
});

element.ComponentType = ComponentType.Monitor;

string expectedValue = "Type:AnyType1,,,ComponentType:Monitor,,,Metadata:[Metadata1=ValueB;Metadata2=6789.123;Metadata3=False;Metadata4=00:02:30],,,Parameters:[Parameter1=ValueA;Parameter2=123.45;Parameter3=True;Parameter4=00:01:00]";
string actualValue = element.ToString();

Assert.AreEqual(expectedValue, actualValue);
}

[Test]
public void ExecutionProfileElementRepresentsStringConversionSemanticsCorrectly_2()
{
ExecutionProfileElement element = new ExecutionProfileElement(
"AnyType1",
new Dictionary<string, IConvertible>
{
{ "Parameter1", "ValueA" }
},
new Dictionary<string, IConvertible>
{
{ "Metadata1", "ValueB" }
},
new List<ExecutionProfileElement>
{
new ExecutionProfileElement(
"AnyType2",
new Dictionary<string, IConvertible>
{
{ "Parameter1", "ValueC" }
},
new Dictionary<string, IConvertible>
{
{ "Metadata1", "ValueD" }
})
});

element.ComponentType = ComponentType.Action;
element.Components.First().ComponentType = ComponentType.Action;
element.Components.First().Extensions.Add("Extension1", JToken.FromObject("{ 'key1': 'value1', 'key2': [ 'one', 'two'], 'key3': { 'any': 'value', 'in': 'the', 'dictionary': 'true' } }"));

string expectedValue =
"Type:AnyType1,,,ComponentType:Action,,,Metadata:[Metadata1=ValueB],,,Parameters:[Parameter1=ValueA],,," +
"Components:[(Type:AnyType2,,,ComponentType:Action,,,Metadata:[Metadata1=ValueD],,,Parameters:[Parameter1=ValueC],,,Extensions:[(Extension1={'key1':'value1','key2':['one','two'],'key3':{'any':'value','in':'the','dictionary':'true'}})])]";

string actualValue = element.ToString();

Assert.AreEqual(expectedValue, actualValue);
}

[Test]
public void ExecutionProfileElementRepresentsStringConversionSemanticsCorrectly_3()
{
ExecutionProfileElement element = new ExecutionProfileElement(
"AnyType1",
new Dictionary<string, IConvertible>
{
{ "Parameter1", "ValueA" }
},
new Dictionary<string, IConvertible>
{
{ "Metadata1", "ValueB" }
},
new List<ExecutionProfileElement>
{
new ExecutionProfileElement(
"AnyType2",
new Dictionary<string, IConvertible>
{
{ "Parameter1", "ValueC" }
},
new Dictionary<string, IConvertible>
{
{ "Metadata1", "ValueD" }
},
new List<ExecutionProfileElement>
{
new ExecutionProfileElement(
"AnyType3",
new Dictionary<string, IConvertible>
{
{ "Parameter1", "ValueE" }
},
new Dictionary<string, IConvertible>
{
{ "Metadata1", "ValueF" }
})
})
});

element.ComponentType = ComponentType.Action;
string expectedValue =
"Type:AnyType1,,,ComponentType:Action,,,Metadata:[Metadata1=ValueB],,,Parameters:[Parameter1=ValueA],,," +
"Components:[(Type:AnyType2,,,ComponentType:Undefined,,,Metadata:[Metadata1=ValueD],,,Parameters:[Parameter1=ValueC],,,Components:[(Type:AnyType3,,,ComponentType:Undefined,,,Metadata:[Metadata1=ValueF],,,Parameters:[Parameter1=ValueE])])]";

string actualValue = element.ToString();

Assert.AreEqual(expectedValue, actualValue);
}

[Test]
public void ExecutionProfileElementRepresentsStringConversionSemanticsCorrectly_4()
{
ExecutionProfileElement element = new ExecutionProfileElement(
"AnyType1",
new Dictionary<string, IConvertible>
{
{ "Parameter1", "ValueA" }
},
new Dictionary<string, IConvertible>
{
{ "Metadata1", "ValueB" }
},
new List<ExecutionProfileElement>
{
new ExecutionProfileElement(
"AnyType2",
new Dictionary<string, IConvertible>
{
{ "Parameter1", "ValueC" }
},
new Dictionary<string, IConvertible>
{
{ "Metadata1", "ValueD" }
},
new List<ExecutionProfileElement>
{
new ExecutionProfileElement(
"AnyType3",
new Dictionary<string, IConvertible>
{
{ "Parameter1", "ValueE" }
},
new Dictionary<string, IConvertible>
{
{ "Metadata1", "ValueF" }
})
})
});

element.ComponentType = ComponentType.Dependency;
element.Extensions.Add("Extension1", JToken.FromObject("{ 'key1': 'value1', 'key2': [ 'one', 'two'], 'key3': { 'any': 'value', 'in': 'the', 'dictionary': 'true' } }"));

string expectedValue =
"Type:AnyType1,,,ComponentType:Dependency,,,Metadata:[Metadata1=ValueB],,,Parameters:[Parameter1=ValueA],,," +
"Components:[(Type:AnyType2,,,ComponentType:Undefined,,,Metadata:[Metadata1=ValueD],,,Parameters:[Parameter1=ValueC],,," +
"Components:[(Type:AnyType3,,,ComponentType:Undefined,,,Metadata:[Metadata1=ValueF],,,Parameters:[Parameter1=ValueE])])],,," +
"Extensions:[(Extension1={'key1':'value1','key2':['one','two'],'key3':{'any':'value','in':'the','dictionary':'true'}})]";

string actualValue = element.ToString();

Assert.AreEqual(expectedValue, actualValue);
}

[Test]
public void ExecutionProfileElementImplementsHashCodeSemanticsCorrectly()
{
Expand All @@ -104,6 +276,135 @@ public void ExecutionProfileElementImplementsHashCodeSemanticsCorrectly()
EqualityAssert.CorrectlyImplementsHashcodeSemantics<ExecutionProfileElement>(() => element, () => element2);
}

[Test]
public void ExecutionProfileElementImplementsHashCodeSemanticsCorrectly_2()
{
ExecutionProfileElement element1 = new ExecutionProfileElement(
"AnyType1",
new Dictionary<string, IConvertible>
{
{ "Parameter1", "ValueA" },
{ "Parameter2", 123.45 },
{ "Parameter3", true },
{ "Parameter4", "00:01:00" }
},
new Dictionary<string, IConvertible>
{
{ "Metadata1", "ValueB" },
{ "Metadata2", 6789.123 },
{ "Metadata3", false },
{ "Metadata4", "00:02:30" }
});

element1.ComponentType = ComponentType.Action;

ExecutionProfileElement element2 = new ExecutionProfileElement(
"AnyType2",
new Dictionary<string, IConvertible>
{
{ "Parameter5", "ValueC" },
{ "Parameter6", 987.65 },
{ "Parameter7", true },
{ "Parameter8", "00:03:00" }
},
new Dictionary<string, IConvertible>
{
{ "Metadata1", "ValueD" },
{ "Metadata2", 777.88 },
{ "Metadata3", false },
{ "Metadata4", "00:04:15" }
});

element2.ComponentType = ComponentType.Action;

EqualityAssert.CorrectlyImplementsHashcodeSemantics<ExecutionProfileElement>(() => element1, () => element2);
}

[Test]
public void ExecutionProfileElementImplementsHashCodeSemanticsCorrectly_3()
{
ExecutionProfileElement element1 = new ExecutionProfileElement(
"AnyType1",
new Dictionary<string, IConvertible>
{
{ "Parameter1", "ValueA" }
},
new Dictionary<string, IConvertible>
{
{ "Metadata1", "ValueB" }
},
new List<ExecutionProfileElement>
{
new ExecutionProfileElement(
"AnyType2",
new Dictionary<string, IConvertible>
{
{ "Parameter1", "ValueC" }
},
new Dictionary<string, IConvertible>
{
{ "Metadata1", "ValueD" }
},
new List<ExecutionProfileElement>
{
new ExecutionProfileElement(
"AnyType3",
new Dictionary<string, IConvertible>
{
{ "Parameter1", "ValueE" }
},
new Dictionary<string, IConvertible>
{
{ "Metadata1", "ValueF" }
})
})
});

element1.ComponentType = ComponentType.Action;
string here = element1.ToString();

ExecutionProfileElement element2 = new ExecutionProfileElement(
"AnyType4",
new Dictionary<string, IConvertible>
{
{ "Parameter1", "ValueG" }
},
new Dictionary<string, IConvertible>
{
{ "Metadata1", "ValueH" }
},
new List<ExecutionProfileElement>
{
new ExecutionProfileElement(
"AnyType5",
new Dictionary<string, IConvertible>
{
{ "Parameter1", "ValueI" }
},
new Dictionary<string, IConvertible>
{
{ "Metadata1", "ValueJ" }
},
new List<ExecutionProfileElement>
{
new ExecutionProfileElement(
"AnyType6",
new Dictionary<string, IConvertible>
{
{ "Parameter1", "ValueK" }
},
new Dictionary<string, IConvertible>
{
{ "Metadata1", "ValueL" }
})
})
});

element2.ComponentType = ComponentType.Action;

EqualityAssert.CorrectlyImplementsHashcodeSemantics<ExecutionProfileElement>(() => element1, () => element2);
}

[Test]
public void ExecutionProfileElementImplementsEqualitySemanticsCorrectly()
{
Expand Down
Loading
Loading