Skip to content

Fix problems running E2E tests locally #957

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
DaveTryon merged 11 commits into from
Mar 19, 2025
Merged

Fix problems running E2E tests locally #957

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
fb81c2e
Create a Temporary BuildDropFolder for E2E tests
DaveTryon Mar 4, 2025
0fccdd0
Merge branch 'main' into DaveTryon/fix-local-unit-tests
DaveTryon Mar 7, 2025
262d733
Dynamically find solution folder path
DaveTryon Mar 8, 2025
36fe299
Merge branch 'main' into DaveTryon/fix-local-unit-tests
DaveTryon Mar 18, 2025
f515f06
Reliably find the solution directory
DaveTryon Mar 18, 2025
535a43e
Run tests in temp folder to avoid changing the state
DaveTryon Mar 18, 2025
1e359d8
Sort using blocks alphabetically
DaveTryon Mar 18, 2025
c15314b
Standardize logging a bit
DaveTryon Mar 18, 2025
cd8836c
Delay E2E tests until after build is done
DaveTryon Mar 18, 2025
3e1b7f3
Improve a comment
DaveTryon Mar 18, 2025
d06e119
Fix spacing issue
DaveTryon Mar 18, 2025
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
3 changes: 3 additions & 0 deletions Microsoft.Sbom.sln
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,9 @@ EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.Sbom.Targets.Tests", "test\Microsoft.Sbom.Targets.Tests\Microsoft.Sbom.Targets.Tests.csproj", "{E31B914C-F24B-4DC8-ACC7-CAEA952563B8}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.Sbom.Tool.Tests", "test\Microsoft.Sbom.Tool.Tests\Microsoft.Sbom.Tool.Tests.csproj", "{FC5A9799-7C44-4BFA-BA22-55DCAF1A1B9F}"
ProjectSection(ProjectDependencies) = postProject
{6C27560E-B0B0-44E3-B4AE-6FB92CE9FE4A} = {6C27560E-B0B0-44E3-B4AE-6FB92CE9FE4A}
EndProjectSection
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Microsoft.Sbom.Targets.E2E.Tests", "test\Microsoft.Sbom.Targets.E2E.Tests\Microsoft.Sbom.Targets.E2E.Tests.csproj", "{3FDE7800-F61F-4C45-93AB-648A4C7979C7}"
EndProject
Expand Down
104 changes: 74 additions & 30 deletions test/Microsoft.Sbom.Targets.Tests/AbstractGenerateSbomTaskInputTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,22 +18,40 @@ namespace Microsoft.Sbom.Targets.Tests;
[TestClass]
public abstract class AbstractGenerateSbomTaskInputTests
{
internal abstract string SbomSpecification { get; }

internal static readonly string CurrentDirectory = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
internal static readonly string DefaultManifestDirectory = Path.Combine(CurrentDirectory, "_manifest");
internal static readonly string TemporaryDirectory = Path.Combine(CurrentDirectory, "_temporary");
internal static readonly string BuildComponentPath = Path.Combine(CurrentDirectory, "..", "..", "..");
internal static readonly string ExternalDocumentListFile = Path.GetRandomFileName();
internal static string SbomToolPath = Path.Combine(Directory.GetCurrentDirectory(), "sbom-tool");
internal virtual string SbomSpecification { get; }

internal static string TestBuildDropPath;
internal static string DefaultManifestDirectory;
internal static string TemporaryDirectory;
internal static string ExternalDocumentListFile;
internal static string SbomToolPath;

internal const string PackageSupplier = "Test-Microsoft";
internal const string PackageName = "CoseSignTool";
internal const string PackageVersion = "0.0.1";
internal const string NamespaceBaseUri = "https://base0.uri";

#if NET472
private const string TargetFramework = "net472";
#else
private const string TargetFramework = "net80";
#endif

private Mock<IBuildEngine> buildEngine;
private List<BuildErrorEventArgs> errors;
private List<BuildMessageEventArgs> messages;

protected static void ClassSetup(string testDirectoryName)
{
var executingDirectory = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
TestBuildDropPath = Path.GetFullPath(Path.Combine(executingDirectory, "..", $"{testDirectoryName}_{TargetFramework}"));
DefaultManifestDirectory = Path.Combine(TestBuildDropPath, "_manifest");
TemporaryDirectory = Path.Combine(TestBuildDropPath, "_temp");
ExternalDocumentListFile = Path.GetRandomFileName();
SbomToolPath = Path.Combine(TestBuildDropPath, "sbom-tool");
Xcopy(executingDirectory, TestBuildDropPath);
}

[TestInitialize]
public void Startup()
{
Expand All @@ -46,7 +64,8 @@ public void Startup()
}

[TestCleanup]
public void Cleanup() {
public void Cleanup()
{
// Clean up the manifest directory
if (Directory.Exists(DefaultManifestDirectory))
{
Expand All @@ -60,6 +79,18 @@ public void Cleanup() {
}
}

protected static void ClassTearDown()
{
// Clean up the TestBuildDropPath directory
if (TestBuildDropPath is not null)
{
if (Directory.Exists(TestBuildDropPath))
{
Directory.Delete(TestBuildDropPath, true);
}
}
}

/// <summary>
/// Test for ensuring the GenerateSbom fails for null or empty inputs for
/// required params, which includes BuildDropPath, PackageSupplier, PackageName,
Expand Down Expand Up @@ -102,36 +133,36 @@ public void Sbom_Fails_With_Null_Empty_And_WhiteSpace_Required_Params(
private static IEnumerable<object[]> GetNullRequiredParamsData()
{
yield return new object[] { null, PackageSupplier, PackageName, PackageVersion, NamespaceBaseUri, SbomToolPath };
yield return new object[] { CurrentDirectory, null, PackageName, PackageVersion, NamespaceBaseUri, SbomToolPath };
yield return new object[] { CurrentDirectory, PackageSupplier, null, PackageVersion, NamespaceBaseUri, SbomToolPath };
yield return new object[] { CurrentDirectory, PackageSupplier, PackageName, null, NamespaceBaseUri, SbomToolPath };
yield return new object[] { CurrentDirectory, PackageSupplier, PackageName, PackageVersion, null, SbomToolPath };
yield return new object[] { TestBuildDropPath, null, PackageName, PackageVersion, NamespaceBaseUri, SbomToolPath };
yield return new object[] { TestBuildDropPath, PackageSupplier, null, PackageVersion, NamespaceBaseUri, SbomToolPath };
yield return new object[] { TestBuildDropPath, PackageSupplier, PackageName, null, NamespaceBaseUri, SbomToolPath };
yield return new object[] { TestBuildDropPath, PackageSupplier, PackageName, PackageVersion, null, SbomToolPath };
#if NET472
yield return new object[] { CurrentDirectory, PackageSupplier, PackageName, PackageVersion, NamespaceBaseUri, null };
yield return new object[] { TestBuildDropPath, PackageSupplier, PackageName, PackageVersion, NamespaceBaseUri, null };
#endif
}

private static IEnumerable<object[]> GetEmptyRequiredParamsData()
{
yield return new object[] { string.Empty, PackageSupplier, PackageName, PackageVersion, NamespaceBaseUri, SbomToolPath };
yield return new object[] { CurrentDirectory, string.Empty, PackageName, PackageVersion, NamespaceBaseUri, SbomToolPath };
yield return new object[] { CurrentDirectory, PackageSupplier, string.Empty, PackageVersion, NamespaceBaseUri, SbomToolPath };
yield return new object[] { CurrentDirectory, PackageSupplier, PackageName, string.Empty, NamespaceBaseUri, SbomToolPath };
yield return new object[] { CurrentDirectory, PackageSupplier, PackageName, PackageVersion, string.Empty, SbomToolPath };
yield return new object[] { TestBuildDropPath, string.Empty, PackageName, PackageVersion, NamespaceBaseUri, SbomToolPath };
yield return new object[] { TestBuildDropPath, PackageSupplier, string.Empty, PackageVersion, NamespaceBaseUri, SbomToolPath };
yield return new object[] { TestBuildDropPath, PackageSupplier, PackageName, string.Empty, NamespaceBaseUri, SbomToolPath };
yield return new object[] { TestBuildDropPath, PackageSupplier, PackageName, PackageVersion, string.Empty, SbomToolPath };
#if NET472
yield return new object[] { CurrentDirectory, PackageSupplier, PackageName, PackageVersion, NamespaceBaseUri, string.Empty };
yield return new object[] { TestBuildDropPath, PackageSupplier, PackageName, PackageVersion, NamespaceBaseUri, string.Empty };
#endif
}

private static IEnumerable<object[]> GetWhiteSpace_Tabs_NewLineParamsData()
{
yield return new object[] { " ", PackageSupplier, PackageName, PackageVersion, NamespaceBaseUri, SbomToolPath };
yield return new object[] { CurrentDirectory, "\n", PackageName, PackageVersion, NamespaceBaseUri, SbomToolPath };
yield return new object[] { CurrentDirectory, PackageSupplier, "\t", PackageVersion, NamespaceBaseUri, SbomToolPath };
yield return new object[] { CurrentDirectory, PackageSupplier, PackageName, " \n \t \n \t \n ", NamespaceBaseUri, SbomToolPath };
yield return new object[] { CurrentDirectory, PackageSupplier, PackageName, PackageVersion, "\t \t \t ", SbomToolPath };
yield return new object[] { TestBuildDropPath, "\n", PackageName, PackageVersion, NamespaceBaseUri, SbomToolPath };
yield return new object[] { TestBuildDropPath, PackageSupplier, "\t", PackageVersion, NamespaceBaseUri, SbomToolPath };
yield return new object[] { TestBuildDropPath, PackageSupplier, PackageName, " \n \t \n \t \n ", NamespaceBaseUri, SbomToolPath };
yield return new object[] { TestBuildDropPath, PackageSupplier, PackageName, PackageVersion, "\t \t \t ", SbomToolPath };
#if NET472
yield return new object[] { CurrentDirectory, PackageSupplier, PackageName, PackageVersion, NamespaceBaseUri, "\t \t \t " };
yield return new object[] { TestBuildDropPath, PackageSupplier, PackageName, PackageVersion, NamespaceBaseUri, "\t \t \t " };
#endif
}

Expand All @@ -151,7 +182,7 @@ public void Sbom_Fails_With_Invalid_NamespaceBaseUri(string namespaceBaseUri)
// Arrange
var task = new GenerateSbom
{
BuildDropPath = CurrentDirectory,
BuildDropPath = TestBuildDropPath,
PackageSupplier = PackageSupplier,
PackageName = PackageName,
PackageVersion = PackageVersion,
Expand Down Expand Up @@ -189,7 +220,7 @@ public void Sbom_Generation_Fails_For_Invalid_NamespaceUriUniquePart(string name
// Arrange
var task = new GenerateSbom
{
BuildDropPath = CurrentDirectory,
BuildDropPath = TestBuildDropPath,
PackageSupplier = PackageSupplier,
PackageName = PackageName,
PackageVersion = PackageVersion,
Expand Down Expand Up @@ -224,7 +255,7 @@ public void Sbom_Generation_Succeeds_For_Null_Verbosity()
Console.SetOut(stringWriter);
var task = new GenerateSbom
{
BuildDropPath = CurrentDirectory,
BuildDropPath = TestBuildDropPath,
PackageSupplier = PackageSupplier,
PackageName = PackageName,
PackageVersion = PackageVersion,
Expand Down Expand Up @@ -265,7 +296,7 @@ public void Sbom_Generation_Succeeds_For_Invalid_Verbosity()
Console.SetOut(stringWriter);
var task = new GenerateSbom
{
BuildDropPath = CurrentDirectory,
BuildDropPath = TestBuildDropPath,
PackageSupplier = PackageSupplier,
PackageName = PackageName,
PackageVersion = PackageVersion,
Expand Down Expand Up @@ -316,7 +347,7 @@ public void Sbom_Generation_Assigns_Correct_Verbosity_IgnoreCase(string inputVer
Console.SetOut(stringWriter);
var task = new GenerateSbom
{
BuildDropPath = CurrentDirectory,
BuildDropPath = TestBuildDropPath,
PackageSupplier = PackageSupplier,
PackageName = PackageName,
PackageVersion = PackageVersion,
Expand Down Expand Up @@ -354,7 +385,7 @@ public void Sbom_Generation_Assigns_Correct_Verbosity_IgnoreCase(string inputVer
Console.SetOut(stringWriter);
var task = new GenerateSbom
{
BuildDropPath = CurrentDirectory,
BuildDropPath = TestBuildDropPath,
PackageSupplier = PackageSupplier,
PackageName = PackageName,
PackageVersion = PackageVersion,
Expand All @@ -374,4 +405,17 @@ public void Sbom_Generation_Assigns_Correct_Verbosity_IgnoreCase(string inputVer
Assert.AreEqual(messageShouldBeLogged, this.messages.Any(msg => pattern.IsMatch(msg.Message)));
}
#endif

private static void Xcopy(string sourceDir, string targetDir)
{
foreach (var dirPath in Directory.GetDirectories(sourceDir, "*.*", SearchOption.AllDirectories))
{
Directory.CreateDirectory(dirPath.Replace(sourceDir, targetDir));
}

foreach (var newPath in Directory.GetFiles(sourceDir, "*.*", SearchOption.AllDirectories))
{
File.Copy(newPath, newPath.Replace(sourceDir, targetDir), true);
}
}
}
Loading