From 10bf545771664ebe2f01f7f7d287fc2cec9dfdd2 Mon Sep 17 00:00:00 2001 From: AliReZa Sabouri Date: Sun, 17 Dec 2023 02:51:23 +0100 Subject: [PATCH 1/5] test: add husky integration test project --- .dockerignore | 11 +++ Dockerfile | 48 +++++++++++ Husky.sln | 9 +- .../HuskyIntegrationTests.csproj | 32 +++++++ tests/HuskyIntegrationTests/TestProjectBase | 1 + tests/HuskyIntegrationTests/Tests.cs | 46 ++++++++++ .../Utilities/DockerFixture.cs | 86 +++++++++++++++++++ .../Utilities/DockerLogger.cs | 30 +++++++ .../Utilities/Extensions.cs | 23 +++++ .../Utilities/GlobalUsings.cs | 2 + 10 files changed, 287 insertions(+), 1 deletion(-) create mode 100644 .dockerignore create mode 100644 Dockerfile create mode 100644 tests/HuskyIntegrationTests/HuskyIntegrationTests.csproj create mode 160000 tests/HuskyIntegrationTests/TestProjectBase create mode 100644 tests/HuskyIntegrationTests/Tests.cs create mode 100644 tests/HuskyIntegrationTests/Utilities/DockerFixture.cs create mode 100644 tests/HuskyIntegrationTests/Utilities/DockerLogger.cs create mode 100644 tests/HuskyIntegrationTests/Utilities/Extensions.cs create mode 100644 tests/HuskyIntegrationTests/Utilities/GlobalUsings.cs diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..8be01ea --- /dev/null +++ b/.dockerignore @@ -0,0 +1,11 @@ +# Exclude everything +* + +# Include the src folder +!src +!README.md + +# Exclude build-related folders within src/Husky +src/Husky/bin/ +src/Husky/obj/ +src/Husky/nupkg/ diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..2cf2112 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,48 @@ +# This dockerfile is used in the integration tests + +# Use the official .NET SDK image as a base +FROM mcr.microsoft.com/dotnet/sdk:8.0 AS build-env +ARG RESOURCE_REAPER_SESSION_ID="00000000-0000-0000-0000-000000000000" +LABEL "org.testcontainers.resource-reaper-session"=$RESOURCE_REAPER_SESSION_ID + +# Set the working directory +WORKDIR /app + +# Copy the .csproj file to the container +COPY src/Husky/Husky.csproj ./ + +ENV HUSKY=0 + +# Copy the remaining files to the container +COPY . ./ + +# Restore dependencies +RUN dotnet restore /app/src/Husky + +# Build the application +RUN dotnet build --no-restore -c Release -f net8.0 /app/src/Husky + +# Create a NuGet package +RUN dotnet pack --no-build --no-restore -c Release -o out /app/src/Husky/Husky.csproj -p:TargetFrameworks=net8.0 + +# Use the same .NET SDK image for the final stage +FROM mcr.microsoft.com/dotnet/sdk:8.0 +ARG RESOURCE_REAPER_SESSION_ID="00000000-0000-0000-0000-000000000000" +LABEL "org.testcontainers.resource-reaper-session"=$RESOURCE_REAPER_SESSION_ID + +# Set the working directory +WORKDIR /app + +# Install Git +RUN apt-get update && \ + apt-get install -y git + +# Copy the NuGet package from the build-env to the runtime image +COPY --from=build-env /app/out/*.nupkg /app/nupkg/ + +# Install Husky tool and add the global tools path to the PATH +RUN dotnet tool install -g --no-cache --add-source /app/nupkg/ husky \ + && echo "export PATH=\$PATH:/root/.dotnet/tools" >> ~/.bashrc + +# Set the entry point to a simple shell +ENTRYPOINT ["/bin/bash"] diff --git a/Husky.sln b/Husky.sln index 18d53b6..1ee66cd 100644 --- a/Husky.sln +++ b/Husky.sln @@ -1,12 +1,14 @@  Microsoft Visual Studio Solution File, Format Version 12.00 -# +# Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Husky", "src\Husky\Husky.csproj", "{12AB4B33-47A6-49D5-872A-5BA6DD634E9C}" EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "tests", "tests", "{302A5F25-CB44-4ED0-A65E-06C04648D211}" EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "HuskyTest", "tests\HuskyTest\HuskyTest.csproj", "{57EE798B-0FE0-42A4-BDB9-D168109D3E7D}" EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "HuskyIntegrationTests", "tests\HuskyIntegrationTests\HuskyIntegrationTests.csproj", "{FAF049CD-6E45-4A66-A88F-C2EB007DFCC3}" +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU @@ -21,8 +23,13 @@ Global {57EE798B-0FE0-42A4-BDB9-D168109D3E7D}.Debug|Any CPU.Build.0 = Debug|Any CPU {57EE798B-0FE0-42A4-BDB9-D168109D3E7D}.Release|Any CPU.ActiveCfg = Release|Any CPU {57EE798B-0FE0-42A4-BDB9-D168109D3E7D}.Release|Any CPU.Build.0 = Release|Any CPU + {FAF049CD-6E45-4A66-A88F-C2EB007DFCC3}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {FAF049CD-6E45-4A66-A88F-C2EB007DFCC3}.Debug|Any CPU.Build.0 = Debug|Any CPU + {FAF049CD-6E45-4A66-A88F-C2EB007DFCC3}.Release|Any CPU.ActiveCfg = Release|Any CPU + {FAF049CD-6E45-4A66-A88F-C2EB007DFCC3}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(NestedProjects) = preSolution {57EE798B-0FE0-42A4-BDB9-D168109D3E7D} = {302A5F25-CB44-4ED0-A65E-06C04648D211} + {FAF049CD-6E45-4A66-A88F-C2EB007DFCC3} = {302A5F25-CB44-4ED0-A65E-06C04648D211} EndGlobalSection EndGlobal diff --git a/tests/HuskyIntegrationTests/HuskyIntegrationTests.csproj b/tests/HuskyIntegrationTests/HuskyIntegrationTests.csproj new file mode 100644 index 0000000..ce06fef --- /dev/null +++ b/tests/HuskyIntegrationTests/HuskyIntegrationTests.csproj @@ -0,0 +1,32 @@ + + + + net8.0 + enable + enable + + false + true + + + + + + + + + runtime; build; native; contentfiles; analyzers; buildtransitive + all + + + runtime; build; native; contentfiles; analyzers; buildtransitive + all + + + + + + + + + diff --git a/tests/HuskyIntegrationTests/TestProjectBase b/tests/HuskyIntegrationTests/TestProjectBase new file mode 160000 index 0000000..a415e6d --- /dev/null +++ b/tests/HuskyIntegrationTests/TestProjectBase @@ -0,0 +1 @@ +Subproject commit a415e6d7941e09998d2984d14857dc4365d08b99 diff --git a/tests/HuskyIntegrationTests/Tests.cs b/tests/HuskyIntegrationTests/Tests.cs new file mode 100644 index 0000000..534cd5a --- /dev/null +++ b/tests/HuskyIntegrationTests/Tests.cs @@ -0,0 +1,46 @@ +using FluentAssertions; + +namespace HuskyIntegrationTests; + +public class Tests : IClassFixture +{ + private readonly DockerFixture _docker; + private readonly ITestOutputHelper _output; + + public Tests(DockerFixture docker, ITestOutputHelper output) + { + _docker = docker; + _output = output; + // TestcontainersSettings.Logger = new DockerLogger(output); + } + + [Fact] + public async Task IntegrationTestCopyFolder() + { + var c = await _docker.CopyAndStartAsync(nameof(TestProjectBase)); + + await c.BashAsync("git init"); + await c.BashAsync("dotnet tool restore"); + await c.BashAsync("dotnet husky install"); + var result = await c.BashAsync(_output, "dotnet husky run"); + + result.Stdout.Should().Contain("✔ Successfully executed"); + result.ExitCode.Should().Be(0); + } + + [Fact] + public async Task IntegrationTest() + { + var c = await _docker.StartAsync(); + + await c.BashAsync("dotnet new classlib"); + await c.BashAsync("dotnet new tool-manifest"); + await c.BashAsync("dotnet tool install Husky"); + await c.BashAsync("git init"); + await c.BashAsync("dotnet husky install"); + var result = await c.BashAsync(_output, "dotnet husky run"); + + result.Stdout.Should().Contain("✔ Successfully executed"); + result.ExitCode.Should().Be(0); + } +} diff --git a/tests/HuskyIntegrationTests/Utilities/DockerFixture.cs b/tests/HuskyIntegrationTests/Utilities/DockerFixture.cs new file mode 100644 index 0000000..a7e1190 --- /dev/null +++ b/tests/HuskyIntegrationTests/Utilities/DockerFixture.cs @@ -0,0 +1,86 @@ +using System.Runtime.CompilerServices; +using DotNet.Testcontainers.Builders; +using DotNet.Testcontainers.Containers; +using DotNet.Testcontainers.Images; + +public class DockerFixture : IAsyncDisposable +{ + public IFutureDockerImage? Image { get; set; } + + private void BuildImage() + { + Image = new ImageFromDockerfileBuilder() + .WithBuildArgument("RESOURCE_REAPER_SESSION_ID", ResourceReaper.DefaultSessionId.ToString("D")) + .WithDockerfileDirectory(CommonDirectoryPath.GetSolutionDirectory(), string.Empty) + .WithDockerfile("Dockerfile") + .WithName("husky") + .WithCleanUp(false) + .Build(); + + Image.CreateAsync().GetAwaiter().GetResult(); + } + + public async Task CopyAndStartAsync(string folderNameToCopy, [CallerMemberName] string name = null!) + { + var container = new ContainerBuilder() + .WithResourceMapping(GetTestFolderPath(folderNameToCopy), "/test/") + .WithName(GenerateContainerName(name)) + .WithImage("husky") + .WithWorkingDirectory("/test/") + .WithEntrypoint("/bin/bash", "-c") + .WithCommand("tail -f /dev/null") + .WithImagePullPolicy(response => + { + if (response == null) + { + BuildImage(); + } + + return false; + }) + .Build(); + + await container.StartAsync(); + return container; + } + + public async Task StartAsync([CallerMemberName] string name = null!) + { + var container = new ContainerBuilder() + .WithName(GenerateContainerName(name)) + .WithImage("husky") + .WithWorkingDirectory("/test/") + .WithEntrypoint("/bin/bash", "-c") + .WithCommand("tail -f /dev/null") + .WithImagePullPolicy(response => + { + if (response == null) + { + BuildImage(); + } + + return false; + }) + .Build(); + + await container.StartAsync(); + return container; + } + + private static string GenerateContainerName(string name) + { + return $"{name}-{Guid.NewGuid().ToString("N")[..4]}"; + } + + + private static string GetTestFolderPath(string folderName) + { + var baseDirectory = CommonDirectoryPath.GetProjectDirectory().DirectoryPath; + return Path.Combine(baseDirectory, folderName); + } + + public ValueTask DisposeAsync() + { + return Image?.DisposeAsync() ?? ValueTask.CompletedTask; + } +} diff --git a/tests/HuskyIntegrationTests/Utilities/DockerLogger.cs b/tests/HuskyIntegrationTests/Utilities/DockerLogger.cs new file mode 100644 index 0000000..fd4da4a --- /dev/null +++ b/tests/HuskyIntegrationTests/Utilities/DockerLogger.cs @@ -0,0 +1,30 @@ +using Microsoft.Extensions.Logging; + +namespace HuskyIntegrationTests; + +public class DockerLogger(ITestOutputHelper output) : ILogger +{ + public IDisposable BeginScope(TState state) +{ + return null!; // You can implement if needed +} + +public bool IsEnabled(LogLevel logLevel) +{ + // Adjust the log level as needed + return true; +} + +public void Log(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func formatter) +{ + if (!IsEnabled(logLevel)) + { + return; + } + + var logMessage = formatter(state, exception); + + // Write to ITestOutputHelper + output.WriteLine($"[{logLevel}] {logMessage}"); +} +} diff --git a/tests/HuskyIntegrationTests/Utilities/Extensions.cs b/tests/HuskyIntegrationTests/Utilities/Extensions.cs new file mode 100644 index 0000000..63f7048 --- /dev/null +++ b/tests/HuskyIntegrationTests/Utilities/Extensions.cs @@ -0,0 +1,23 @@ +using DotNet.Testcontainers.Containers; + +namespace HuskyIntegrationTests; + +public static class Extensions +{ + public static Task BashAsync(this IContainer container, params string[] command) + { + return container.ExecAsync(["/bin/bash", "-c", ..command]); + } + + public static async Task BashAsync(this IContainer container, ITestOutputHelper output, params string[] command) + { + var result = await container.ExecAsync(["/bin/bash", "-c", ..command]); + if (!string.IsNullOrEmpty(result.Stderr)) + output.WriteLine(result.Stderr); + + if (!string.IsNullOrEmpty(result.Stdout)) + output.WriteLine(result.Stdout); + + return result; + } +} diff --git a/tests/HuskyIntegrationTests/Utilities/GlobalUsings.cs b/tests/HuskyIntegrationTests/Utilities/GlobalUsings.cs new file mode 100644 index 0000000..8970211 --- /dev/null +++ b/tests/HuskyIntegrationTests/Utilities/GlobalUsings.cs @@ -0,0 +1,2 @@ +global using Xunit; +global using Xunit.Abstractions; From 9d1f041c3802f7a8003ee1c6dff2b6c3824a6a19 Mon Sep 17 00:00:00 2001 From: AliReZa Sabouri Date: Sun, 17 Dec 2023 03:07:07 +0100 Subject: [PATCH 2/5] chore: Remove unused "Issue99" folder from HuskyIntegrationTests The "Issue99" folder is not being used anymore in the HuskyIntegrationTests project. This commit removes the redundant folder reference from the project file to keep the project structure clean and accurate. --- tests/HuskyIntegrationTests/HuskyIntegrationTests.csproj | 1 - 1 file changed, 1 deletion(-) diff --git a/tests/HuskyIntegrationTests/HuskyIntegrationTests.csproj b/tests/HuskyIntegrationTests/HuskyIntegrationTests.csproj index ce06fef..20e4701 100644 --- a/tests/HuskyIntegrationTests/HuskyIntegrationTests.csproj +++ b/tests/HuskyIntegrationTests/HuskyIntegrationTests.csproj @@ -25,7 +25,6 @@ - From f9ebb54baa0e465bee66deef9425efd4ce8b2434 Mon Sep 17 00:00:00 2001 From: AliReZa Sabouri Date: Sun, 17 Dec 2023 03:21:02 +0100 Subject: [PATCH 3/5] fix: add integration Test base project template --- .gitmodules | 0 tests/HuskyIntegrationTests/TestProjectBase | 1 - .../TestProjectBase/.config/dotnet-tools.json | 12 + .../TestProjectBase/.gitignore | 484 ++++++++++++++++++ .../TestProjectBase/.husky/task-runner.json | 13 + .../TestProjectBase/Class1.cs | 6 + .../TestProjectBase/TestProjectBase.csproj | 9 + 7 files changed, 524 insertions(+), 1 deletion(-) create mode 100644 .gitmodules delete mode 160000 tests/HuskyIntegrationTests/TestProjectBase create mode 100644 tests/HuskyIntegrationTests/TestProjectBase/.config/dotnet-tools.json create mode 100644 tests/HuskyIntegrationTests/TestProjectBase/.gitignore create mode 100644 tests/HuskyIntegrationTests/TestProjectBase/.husky/task-runner.json create mode 100644 tests/HuskyIntegrationTests/TestProjectBase/Class1.cs create mode 100644 tests/HuskyIntegrationTests/TestProjectBase/TestProjectBase.csproj diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..e69de29 diff --git a/tests/HuskyIntegrationTests/TestProjectBase b/tests/HuskyIntegrationTests/TestProjectBase deleted file mode 160000 index a415e6d..0000000 --- a/tests/HuskyIntegrationTests/TestProjectBase +++ /dev/null @@ -1 +0,0 @@ -Subproject commit a415e6d7941e09998d2984d14857dc4365d08b99 diff --git a/tests/HuskyIntegrationTests/TestProjectBase/.config/dotnet-tools.json b/tests/HuskyIntegrationTests/TestProjectBase/.config/dotnet-tools.json new file mode 100644 index 0000000..4dae900 --- /dev/null +++ b/tests/HuskyIntegrationTests/TestProjectBase/.config/dotnet-tools.json @@ -0,0 +1,12 @@ +{ + "version": 1, + "isRoot": true, + "tools": { + "husky": { + "version": "0.6.3", + "commands": [ + "husky" + ] + } + } +} \ No newline at end of file diff --git a/tests/HuskyIntegrationTests/TestProjectBase/.gitignore b/tests/HuskyIntegrationTests/TestProjectBase/.gitignore new file mode 100644 index 0000000..104b544 --- /dev/null +++ b/tests/HuskyIntegrationTests/TestProjectBase/.gitignore @@ -0,0 +1,484 @@ +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. +## +## Get latest from `dotnet new gitignore` + +# dotenv files +.env + +# User-specific files +*.rsuser +*.suo +*.user +*.userosscache +*.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Mono auto generated files +mono_crash.* + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +[Ww][Ii][Nn]32/ +[Aa][Rr][Mm]/ +[Aa][Rr][Mm]64/ +bld/ +[Bb]in/ +[Oo]bj/ +[Ll]og/ +[Ll]ogs/ + +# Visual Studio 2015/2017 cache/options directory +.vs/ +# Uncomment if you have tasks that create the project's static files in wwwroot +#wwwroot/ + +# Visual Studio 2017 auto generated files +Generated\ Files/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUnit +*.VisualState.xml +TestResult.xml +nunit-*.xml + +# Build Results of an ATL Project +[Dd]ebugPS/ +[Rr]eleasePS/ +dlldata.c + +# Benchmark Results +BenchmarkDotNet.Artifacts/ + +# .NET +project.lock.json +project.fragment.lock.json +artifacts/ + +# Tye +.tye/ + +# ASP.NET Scaffolding +ScaffoldingReadMe.txt + +# StyleCop +StyleCopReport.xml + +# Files built by Visual Studio +*_i.c +*_p.c +*_h.h +*.ilk +*.meta +*.obj +*.iobj +*.pch +*.pdb +*.ipdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*_wpftmp.csproj +*.log +*.tlog +*.vspscc +*.vssscc +.builds +*.pidb +*.svclog +*.scc + +# Chutzpah Test files +_Chutzpah* + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile +*.VC.db +*.VC.VC.opendb + +# Visual Studio profiler +*.psess +*.vsp +*.vspx +*.sap + +# Visual Studio Trace Files +*.e2e + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper +*.DotSettings.user + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# AxoCover is a Code Coverage Tool +.axoCover/* +!.axoCover/settings.json + +# Coverlet is a free, cross platform Code Coverage Tool +coverage*.json +coverage*.xml +coverage*.info + +# Visual Studio code coverage results +*.coverage +*.coveragexml + +# NCrunch +_NCrunch_* +.*crunch*.local.xml +nCrunchTemp_* + +# MightyMoose +*.mm.* +AutoTest.Net/ + +# Web workbench (sass) +.sass-cache/ + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.[Pp]ublish.xml +*.azurePubxml +# Note: Comment the next line if you want to checkin your web deploy settings, +# but database connection strings (with potential passwords) will be unencrypted +*.pubxml +*.publishproj + +# Microsoft Azure Web App publish settings. Comment the next line if you want to +# checkin your Azure Web App publish settings, but sensitive information contained +# in these scripts will be unencrypted +PublishScripts/ + +# NuGet Packages +*.nupkg +# NuGet Symbol Packages +*.snupkg +# The packages folder can be ignored because of Package Restore +**/[Pp]ackages/* +# except build/, which is used as an MSBuild target. +!**/[Pp]ackages/build/ +# Uncomment if necessary however generally it will be regenerated when needed +#!**/[Pp]ackages/repositories.config +# NuGet v3's project.json files produces more ignorable files +*.nuget.props +*.nuget.targets + +# Microsoft Azure Build Output +csx/ +*.build.csdef + +# Microsoft Azure Emulator +ecf/ +rcf/ + +# Windows Store app package directories and files +AppPackages/ +BundleArtifacts/ +Package.StoreAssociation.xml +_pkginfo.txt +*.appx +*.appxbundle +*.appxupload + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!?*.[Cc]ache/ + +# Others +ClientBin/ +~$* +*~ +*.dbmdl +*.dbproj.schemaview +*.jfm +*.pfx +*.publishsettings +orleans.codegen.cs + +# Including strong name files can present a security risk +# (https://github.com/github/gitignore/pull/2483#issue-259490424) +#*.snk + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +#bower_components/ + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm +ServiceFabricBackup/ +*.rptproj.bak + +# SQL Server files +*.mdf +*.ldf +*.ndf + +# Business Intelligence projects +*.rdl.data +*.bim.layout +*.bim_*.settings +*.rptproj.rsuser +*- [Bb]ackup.rdl +*- [Bb]ackup ([0-9]).rdl +*- [Bb]ackup ([0-9][0-9]).rdl + +# Microsoft Fakes +FakesAssemblies/ + +# GhostDoc plugin setting file +*.GhostDoc.xml + +# Node.js Tools for Visual Studio +.ntvs_analysis.dat +node_modules/ + +# Visual Studio 6 build log +*.plg + +# Visual Studio 6 workspace options file +*.opt + +# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) +*.vbw + +# Visual Studio 6 auto-generated project file (contains which files were open etc.) +*.vbp + +# Visual Studio 6 workspace and project file (working project files containing files to include in project) +*.dsw +*.dsp + +# Visual Studio 6 technical files +*.ncb +*.aps + +# Visual Studio LightSwitch build output +**/*.HTMLClient/GeneratedArtifacts +**/*.DesktopClient/GeneratedArtifacts +**/*.DesktopClient/ModelManifest.xml +**/*.Server/GeneratedArtifacts +**/*.Server/ModelManifest.xml +_Pvt_Extensions + +# Paket dependency manager +.paket/paket.exe +paket-files/ + +# FAKE - F# Make +.fake/ + +# CodeRush personal settings +.cr/personal + +# Python Tools for Visual Studio (PTVS) +__pycache__/ +*.pyc + +# Cake - Uncomment if you are using it +# tools/** +# !tools/packages.config + +# Tabs Studio +*.tss + +# Telerik's JustMock configuration file +*.jmconfig + +# BizTalk build output +*.btp.cs +*.btm.cs +*.odx.cs +*.xsd.cs + +# OpenCover UI analysis results +OpenCover/ + +# Azure Stream Analytics local run output +ASALocalRun/ + +# MSBuild Binary and Structured Log +*.binlog + +# NVidia Nsight GPU debugger configuration file +*.nvuser + +# MFractors (Xamarin productivity tool) working folder +.mfractor/ + +# Local History for Visual Studio +.localhistory/ + +# Visual Studio History (VSHistory) files +.vshistory/ + +# BeatPulse healthcheck temp database +healthchecksdb + +# Backup folder for Package Reference Convert tool in Visual Studio 2017 +MigrationBackup/ + +# Ionide (cross platform F# VS Code tools) working folder +.ionide/ + +# Fody - auto-generated XML schema +FodyWeavers.xsd + +# VS Code files for those working on multiple tools +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json +*.code-workspace + +# Local History for Visual Studio Code +.history/ + +# Windows Installer files from build outputs +*.cab +*.msi +*.msix +*.msm +*.msp + +# JetBrains Rider +*.sln.iml +.idea + +## +## Visual studio for Mac +## + + +# globs +Makefile.in +*.userprefs +*.usertasks +config.make +config.status +aclocal.m4 +install-sh +autom4te.cache/ +*.tar.gz +tarballs/ +test-results/ + +# Mac bundle stuff +*.dmg +*.app + +# content below from: https://github.com/github/gitignore/blob/master/Global/macOS.gitignore +# General +.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + +# content below from: https://github.com/github/gitignore/blob/master/Global/Windows.gitignore +# Windows thumbnail cache files +Thumbs.db +ehthumbs.db +ehthumbs_vista.db + +# Dump file +*.stackdump + +# Folder config file +[Dd]esktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Windows Installer files +*.cab +*.msi +*.msix +*.msm +*.msp + +# Windows shortcuts +*.lnk + +# Vim temporary swap files +*.swp diff --git a/tests/HuskyIntegrationTests/TestProjectBase/.husky/task-runner.json b/tests/HuskyIntegrationTests/TestProjectBase/.husky/task-runner.json new file mode 100644 index 0000000..2a016c4 --- /dev/null +++ b/tests/HuskyIntegrationTests/TestProjectBase/.husky/task-runner.json @@ -0,0 +1,13 @@ +{ + "tasks": [ + { + "name": "welcome-message-example", + "command": "bash", + "args": [ "-c", "echo Husky.Net is awesome!" ], + "windows": { + "command": "cmd", + "args": ["/c", "echo Husky.Net is awesome!" ] + } + } + ] +} diff --git a/tests/HuskyIntegrationTests/TestProjectBase/Class1.cs b/tests/HuskyIntegrationTests/TestProjectBase/Class1.cs new file mode 100644 index 0000000..f4a8091 --- /dev/null +++ b/tests/HuskyIntegrationTests/TestProjectBase/Class1.cs @@ -0,0 +1,6 @@ +namespace TestProjectBase; + +public class Class1 +{ + +} diff --git a/tests/HuskyIntegrationTests/TestProjectBase/TestProjectBase.csproj b/tests/HuskyIntegrationTests/TestProjectBase/TestProjectBase.csproj new file mode 100644 index 0000000..fa71b7a --- /dev/null +++ b/tests/HuskyIntegrationTests/TestProjectBase/TestProjectBase.csproj @@ -0,0 +1,9 @@ + + + + net8.0 + enable + enable + + + From 037af159b62c4bde67b8bbb1789e8a16ead28702 Mon Sep 17 00:00:00 2001 From: AliReZa Sabouri Date: Sun, 17 Dec 2023 13:50:55 +0100 Subject: [PATCH 4/5] test: Add new method in DockerFixture and modify tests A new method `StartWithInstalledHusky` has been added to `DockerFixture`, this method provides an easier way to get a container with Husky installed. Some code rearrangement and wording modifications were made in the `Extensions` and `Tests` classes to make test cases clearer and more understandable. The newly created TestProjectBase solution was also added. --- .../TestProjectBase/TestProjectBase.sln | 22 +++++++ tests/HuskyIntegrationTests/Tests.cs | 61 ++++++++----------- .../Utilities/DockerFixture.cs | 14 +++++ .../Utilities/Extensions.cs | 12 +++- 4 files changed, 72 insertions(+), 37 deletions(-) create mode 100644 tests/HuskyIntegrationTests/TestProjectBase/TestProjectBase.sln diff --git a/tests/HuskyIntegrationTests/TestProjectBase/TestProjectBase.sln b/tests/HuskyIntegrationTests/TestProjectBase/TestProjectBase.sln new file mode 100644 index 0000000..b006a46 --- /dev/null +++ b/tests/HuskyIntegrationTests/TestProjectBase/TestProjectBase.sln @@ -0,0 +1,22 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 17 +VisualStudioVersion = 17.0.31903.59 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TestProjectBase", "TestProjectBase.csproj", "{A53CD1DD-6DB6-4ADD-82E5-F75A15514523}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {A53CD1DD-6DB6-4ADD-82E5-F75A15514523}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {A53CD1DD-6DB6-4ADD-82E5-F75A15514523}.Debug|Any CPU.Build.0 = Debug|Any CPU + {A53CD1DD-6DB6-4ADD-82E5-F75A15514523}.Release|Any CPU.ActiveCfg = Release|Any CPU + {A53CD1DD-6DB6-4ADD-82E5-F75A15514523}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection +EndGlobal diff --git a/tests/HuskyIntegrationTests/Tests.cs b/tests/HuskyIntegrationTests/Tests.cs index 534cd5a..180395f 100644 --- a/tests/HuskyIntegrationTests/Tests.cs +++ b/tests/HuskyIntegrationTests/Tests.cs @@ -2,45 +2,36 @@ namespace HuskyIntegrationTests; -public class Tests : IClassFixture +public class Tests(DockerFixture docker, ITestOutputHelper output) : IClassFixture { - private readonly DockerFixture _docker; - private readonly ITestOutputHelper _output; - - public Tests(DockerFixture docker, ITestOutputHelper output) - { - _docker = docker; - _output = output; - // TestcontainersSettings.Logger = new DockerLogger(output); - } [Fact] - public async Task IntegrationTestCopyFolder() - { - var c = await _docker.CopyAndStartAsync(nameof(TestProjectBase)); +public async Task IntegrationTestCopyFolder() +{ + var c = await docker.CopyAndStartAsync(nameof(TestProjectBase)); - await c.BashAsync("git init"); - await c.BashAsync("dotnet tool restore"); - await c.BashAsync("dotnet husky install"); - var result = await c.BashAsync(_output, "dotnet husky run"); + await c.BashAsync("git init"); + await c.BashAsync("dotnet tool restore"); + await c.BashAsync("dotnet husky install"); + var result = await c.BashAsync(output, "dotnet husky run"); - result.Stdout.Should().Contain("✔ Successfully executed"); - result.ExitCode.Should().Be(0); - } + result.Stdout.Should().Contain(Extensions.SuccessfullyExecuted); + result.ExitCode.Should().Be(0); +} - [Fact] - public async Task IntegrationTest() - { - var c = await _docker.StartAsync(); - - await c.BashAsync("dotnet new classlib"); - await c.BashAsync("dotnet new tool-manifest"); - await c.BashAsync("dotnet tool install Husky"); - await c.BashAsync("git init"); - await c.BashAsync("dotnet husky install"); - var result = await c.BashAsync(_output, "dotnet husky run"); - - result.Stdout.Should().Contain("✔ Successfully executed"); - result.ExitCode.Should().Be(0); - } +[Fact] +public async Task IntegrationTest() +{ + var c = await docker.StartAsync(); + + await c.BashAsync("dotnet new classlib"); + await c.BashAsync("dotnet new tool-manifest"); + await c.BashAsync("dotnet tool install Husky"); + await c.BashAsync("git init"); + await c.BashAsync("dotnet husky install"); + var result = await c.BashAsync(output, "dotnet husky run"); + + result.Stdout.Should().Contain(Extensions.SuccessfullyExecuted); + result.ExitCode.Should().Be(0); +} } diff --git a/tests/HuskyIntegrationTests/Utilities/DockerFixture.cs b/tests/HuskyIntegrationTests/Utilities/DockerFixture.cs index a7e1190..93d0a1a 100644 --- a/tests/HuskyIntegrationTests/Utilities/DockerFixture.cs +++ b/tests/HuskyIntegrationTests/Utilities/DockerFixture.cs @@ -2,6 +2,7 @@ using DotNet.Testcontainers.Builders; using DotNet.Testcontainers.Containers; using DotNet.Testcontainers.Images; +using HuskyIntegrationTests; public class DockerFixture : IAsyncDisposable { @@ -67,6 +68,19 @@ public async Task StartAsync([CallerMemberName] string name = null!) return container; } + + public async Task StartWithInstalledHusky([CallerMemberName] string name = null!) + { + var c = await CopyAndStartAsync(nameof(TestProjectBase), name); + await c.BashAsync("git init"); + await c.BashAsync("dotnet tool restore"); + await c.BashAsync("dotnet husky install"); + await c.BashAsync("git add ."); + await c.BashAsync("git commit -m 'initial commit'"); + return c; + } + + private static string GenerateContainerName(string name) { return $"{name}-{Guid.NewGuid().ToString("N")[..4]}"; diff --git a/tests/HuskyIntegrationTests/Utilities/Extensions.cs b/tests/HuskyIntegrationTests/Utilities/Extensions.cs index 63f7048..8204bb9 100644 --- a/tests/HuskyIntegrationTests/Utilities/Extensions.cs +++ b/tests/HuskyIntegrationTests/Utilities/Extensions.cs @@ -4,6 +4,8 @@ namespace HuskyIntegrationTests; public static class Extensions { + public const string SuccessfullyExecuted = "✔ Successfully executed"; + public static Task BashAsync(this IContainer container, params string[] command) { return container.ExecAsync(["/bin/bash", "-c", ..command]); @@ -12,12 +14,18 @@ public static Task BashAsync(this IContainer container, params strin public static async Task BashAsync(this IContainer container, ITestOutputHelper output, params string[] command) { var result = await container.ExecAsync(["/bin/bash", "-c", ..command]); - if (!string.IsNullOrEmpty(result.Stderr)) - output.WriteLine(result.Stderr); if (!string.IsNullOrEmpty(result.Stdout)) output.WriteLine(result.Stdout); + if (!string.IsNullOrEmpty(result.Stderr)) + output.WriteLine(result.Stderr); + return result; } + + public static Task UpdateTaskRunner(this IContainer container, string content) + { + return container.BashAsync($"echo -e '{content}' > /test/.husky/task-runner.json"); + } } From 4e936e728a9ec78c401db26fac7d9d8da5885ab3 Mon Sep 17 00:00:00 2001 From: AliReZa Sabouri Date: Sun, 17 Dec 2023 14:17:05 +0100 Subject: [PATCH 5/5] test: Update BashAsync method and enhance Docker setup The BashAsync method in Extensions.cs now handles exceptions for non-zero exit codes, enhancing error handling. A new method, AddCsharpClass, has also been added to help create C# classes. In DockerFixture.cs, global user details are now set up to aid Git operations. --- .../HuskyIntegrationTests/Utilities/DockerFixture.cs | 2 ++ tests/HuskyIntegrationTests/Utilities/Extensions.cs | 12 ++++++++++-- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/tests/HuskyIntegrationTests/Utilities/DockerFixture.cs b/tests/HuskyIntegrationTests/Utilities/DockerFixture.cs index 93d0a1a..28a9c3f 100644 --- a/tests/HuskyIntegrationTests/Utilities/DockerFixture.cs +++ b/tests/HuskyIntegrationTests/Utilities/DockerFixture.cs @@ -75,6 +75,8 @@ public async Task StartWithInstalledHusky([CallerMemberName] string await c.BashAsync("git init"); await c.BashAsync("dotnet tool restore"); await c.BashAsync("dotnet husky install"); + await c.BashAsync("git config --global user.email \"you@example.com\""); + await c.BashAsync("git config --global user.name \"Your Name\""); await c.BashAsync("git add ."); await c.BashAsync("git commit -m 'initial commit'"); return c; diff --git a/tests/HuskyIntegrationTests/Utilities/Extensions.cs b/tests/HuskyIntegrationTests/Utilities/Extensions.cs index 8204bb9..ba6622b 100644 --- a/tests/HuskyIntegrationTests/Utilities/Extensions.cs +++ b/tests/HuskyIntegrationTests/Utilities/Extensions.cs @@ -6,9 +6,12 @@ public static class Extensions { public const string SuccessfullyExecuted = "✔ Successfully executed"; - public static Task BashAsync(this IContainer container, params string[] command) + public static async Task BashAsync(this IContainer container, params string[] command) { - return container.ExecAsync(["/bin/bash", "-c", ..command]); + var result = await container.ExecAsync(["/bin/bash", "-c", ..command]); + if (result.ExitCode != 0) + throw new Exception(result.Stderr); + return result; } public static async Task BashAsync(this IContainer container, ITestOutputHelper output, params string[] command) @@ -28,4 +31,9 @@ public static Task UpdateTaskRunner(this IContainer container, strin { return container.BashAsync($"echo -e '{content}' > /test/.husky/task-runner.json"); } + + public static Task AddCsharpClass(this IContainer container, string content, string fileName = "Class2.cs") + { + return container.BashAsync($"echo -e '{content}' > /test/{fileName}"); + } }