V9.0.0/housekeeping and cuemon aid #11
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| // This file is used by Code Analysis to maintain SuppressMessage | ||
| // attributes that are applied to this project. | ||
| // Project-level suppressions either have no target or are given | ||
| // a specific target and scoped to a namespace, type, member, etc. | ||
|
|
||
| using System.Diagnostics.CodeAnalysis; | ||
|
|
||
| [assembly: SuppressMessage("Major Code Smell", "S3881:\"IDisposable\" should be implemented correctly", Justification = "This is a base class implementation of the IDisposable interface tailored to avoid wrong implementations.", Scope = "type", Target = "~T:Codebelt.Extensions.Xunit.Test")] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,9 +6,9 @@ | |
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <PackageReference Include="Cuemon.AspNetCore" Version="9.0.0-preview.9" /> | ||
| <PackageReference Include="Cuemon.Extensions.AspNetCore" Version="9.0.0-preview.9" /> | ||
| <PackageReference Include="Cuemon.Extensions.IO" Version="9.0.0-preview.9" /> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| using System.IO; | ||
|
|
||
| namespace Codebelt.Extensions.Xunit.Assets | ||
| { | ||
| public class ManagedDisposable : Test | ||
| { | ||
| public ManagedDisposable() | ||
| { | ||
| Stream = new MemoryStream(); | ||
| } | ||
|
|
||
| public MemoryStream Stream { get; private set; } | ||
|
|
||
| protected override void OnDisposeManagedResources() | ||
| { | ||
| try | ||
| { | ||
| Stream?.Dispose(); | ||
| } | ||
| finally | ||
| { | ||
| Stream = null; | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| using System; | ||
| using System.Runtime.InteropServices; | ||
| #if NET48_OR_GREATER | ||
| using NativeLibraryLoader; | ||
| #endif | ||
|
Comment on lines
+3
to
+5
There was a problem hiding this comment. Correct the conditional compilation symbols The symbol Update the conditional compilation directives to use the correct symbols: - #if NET48_OR_GREATER
+ #if NETFRAMEWORK
using NativeLibraryLoader;
#endifSimilarly, adjust other directives to match the appropriate target frameworks. Also applies to: 26-28 |
||
| namespace Codebelt.Extensions.Xunit.Assets | ||
| { | ||
| public class UnmanagedDisposable : Test | ||
| { | ||
| internal IntPtr _handle = IntPtr.Zero; | ||
| internal IntPtr _libHandle = IntPtr.Zero; | ||
|
|
||
| public delegate bool CloseHandle(IntPtr hObject); | ||
|
|
||
| public delegate IntPtr CreateFileDelegate(string lpFileName, | ||
| uint dwDesiredAccess, | ||
| uint dwShareMode, | ||
| IntPtr lpSecurityAttributes, | ||
| uint dwCreationDisposition, | ||
| uint dwFlagsAndAttributes, | ||
| IntPtr hTemplateFile); | ||
|
|
||
| public delegate IntPtr PtSname(int fd); | ||
|
|
||
| #if NET48_OR_GREATER | ||
| internal NativeLibrary _nativeLibrary; | ||
| #endif | ||
|
|
||
| public UnmanagedDisposable() | ||
| { | ||
| #if NET6_0_OR_GREATER | ||
| if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) | ||
| { | ||
| if (NativeLibrary.TryLoad("kernel32.dll", GetType().Assembly, DllImportSearchPath.System32, out _libHandle)) | ||
| { | ||
| if (NativeLibrary.TryGetExport(_libHandle, "CreateFileW", out var functionHandle)) | ||
| { | ||
| var createFileFunc = Marshal.GetDelegateForFunctionPointer<CreateFileDelegate>(functionHandle); | ||
| _handle = createFileFunc(@"C:\TestFile.txt", | ||
| 0x80000000, //access read-only | ||
| 1, //share-read | ||
| IntPtr.Zero, | ||
| 3, //open existing | ||
| 0, | ||
| IntPtr.Zero); | ||
| } | ||
| } | ||
| } | ||
| else if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux)) | ||
| { | ||
| if (NativeLibrary.TryLoad("libc.so.6", GetType().Assembly, DllImportSearchPath.SafeDirectories, out _libHandle)) | ||
| { | ||
| _handle = _libHandle; // i don't know of any native methods on unix | ||
|
There was a problem hiding this comment. Review the assignment Assigning Consider removing this assignment or properly initializing Also applies to: 76-76 |
||
| } | ||
| } | ||
| #else | ||
| if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) | ||
| { | ||
| _nativeLibrary = new NativeLibrary("kernel32.dll"); | ||
| _libHandle = _nativeLibrary.Handle; | ||
| var functionHandle = _nativeLibrary.LoadFunction("CreateFileW"); | ||
| var createFileFunc = Marshal.GetDelegateForFunctionPointer<CreateFileDelegate>(functionHandle); | ||
| _handle = createFileFunc(@"C:\TestFile.txt", | ||
| 0x80000000, //access read-only | ||
| 1, //share-read | ||
| IntPtr.Zero, | ||
| 3, //open existing | ||
| 0, | ||
| IntPtr.Zero); | ||
| } | ||
| else if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux)) | ||
| { | ||
| _nativeLibrary = new NativeLibrary("libc.so.6"); | ||
| _libHandle = _nativeLibrary.Handle; | ||
| _handle = _libHandle; // i don't know of any native methods on unix | ||
| } | ||
| #endif | ||
| } | ||
|
|
||
| ~UnmanagedDisposable() | ||
| { | ||
| Dispose(false); | ||
| } | ||
|
|
||
|
|
||
| protected override void OnDisposeManagedResources() | ||
| { | ||
|
|
||
| } | ||
|
|
||
| protected override void OnDisposeUnmanagedResources() | ||
| { | ||
| #if NET6_0_OR_GREATER | ||
| if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) | ||
| { | ||
| if (_handle != IntPtr.Zero) | ||
| { | ||
| if (NativeLibrary.TryGetExport(_libHandle, "CloseHandle", out var closeHandle)) | ||
| { | ||
| var closeHandleAction = Marshal.GetDelegateForFunctionPointer<CloseHandle>(closeHandle); | ||
| closeHandleAction(_handle); | ||
| } | ||
| } | ||
| NativeLibrary.Free(_libHandle); | ||
| } | ||
| else if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux)) | ||
| { | ||
| NativeLibrary.Free(_libHandle); | ||
| } | ||
| #else | ||
| if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) | ||
| { | ||
| if (_handle != IntPtr.Zero) | ||
| { | ||
| var closeHandle = _nativeLibrary.LoadFunction("CloseHandle"); | ||
| var closeHandleAction = Marshal.GetDelegateForFunctionPointer<CloseHandle>(closeHandle); | ||
| closeHandleAction(_handle); | ||
| } | ||
| _nativeLibrary.Dispose(); | ||
| } | ||
| else if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux)) | ||
| { | ||
| _nativeLibrary.Dispose(); | ||
| } | ||
| #endif | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,4 +4,8 @@ | |
| <RootNamespace>Codebelt.Extensions.Xunit</RootNamespace> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <PackageReference Include="NativeLibraryLoader" Version="1.0.13" /> | ||
| </ItemGroup> | ||
|
|
||
| </Project> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| using System; | ||
| using Codebelt.Extensions.Xunit.Assets; | ||
| using Xunit; | ||
| using Xunit.Abstractions; | ||
|
|
||
| namespace Codebelt.Extensions.Xunit | ||
| { | ||
| public class DisposableTest : Test | ||
| { | ||
| public DisposableTest(ITestOutputHelper output) : base(output) | ||
| { | ||
| } | ||
|
|
||
|
|
||
|
|
||
| [Fact] | ||
| public void ManagedDisposable_VerifyThatAssetIsBeingDisposed() | ||
| { | ||
| ManagedDisposable mdRef = null; | ||
| using (var md = new ManagedDisposable()) | ||
| { | ||
| mdRef = md; | ||
| Assert.NotNull(md.Stream); | ||
| Assert.Equal(0, md.Stream.Length); | ||
| Assert.False(mdRef.Disposed); | ||
| } | ||
| Assert.NotNull(mdRef); | ||
| Assert.Null(mdRef.Stream); | ||
| Assert.True(mdRef.Disposed); | ||
| } | ||
|
|
||
| private WeakReference<UnmanagedDisposable> unmanaged = null; | ||
|
|
||
| [Fact] | ||
| public void UnmanagedDisposable_VerifyThatAssetIsBeingDisposedOnFinalize() | ||
| { | ||
| Action body = () => | ||
| { | ||
| var o = new UnmanagedDisposable(); | ||
| Assert.NotEqual(IntPtr.Zero, o._libHandle); | ||
| Assert.NotEqual(IntPtr.Zero, o._handle); | ||
| unmanaged = new WeakReference<UnmanagedDisposable>(o, true); | ||
| }; | ||
|
|
||
| try | ||
| { | ||
| body(); | ||
| } | ||
| finally | ||
| { | ||
| GC.Collect(0, GCCollectionMode.Forced); | ||
| GC.WaitForPendingFinalizers(); | ||
| } | ||
|
|
||
| if (unmanaged.TryGetTarget(out var ud2)) | ||
| { | ||
| Assert.True(ud2.Disposed); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
Comment on lines
+1
to
+61
There was a problem hiding this comment. 🛠️ Refactor suggestion Consider adding more test cases for comprehensive coverage. The
Here's an example of an additional test case for explicit disposal of [Fact]
public void UnmanagedDisposable_ExplicitDispose_VerifyResourcesAreReleased()
{
var ud = new UnmanagedDisposable();
Assert.NotEqual(IntPtr.Zero, ud._libHandle);
Assert.NotEqual(IntPtr.Zero, ud._handle);
ud.Dispose();
Assert.True(ud.Disposed);
Assert.Equal(IntPtr.Zero, ud._libHandle);
Assert.Equal(IntPtr.Zero, ud._handle);
}Adding these test cases will provide more comprehensive coverage and help ensure the robustness of your disposable implementations. |
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 Codebase verification
Found version discrepancies across Microsoft.Extensions packages.
Different target frameworks are using varying versions of Microsoft.Extensions packages:
9.0.0-rc.1.24431.78.0.0and8.0.12.1.1These inconsistencies may lead to compatibility and runtime issues. Please align the package versions across all target frameworks to ensure consistency and stability.
🔗 Analysis chain
Approve xunit.extensibility.core update with a compatibility check.
The update of xunit.extensibility.core from version 2.9.1 to 2.9.2 is a good practice to keep dependencies up-to-date. This minor version update likely includes bug fixes and small improvements.
To ensure compatibility, please verify that this update doesn't introduce any breaking changes by running the project's test suite. You can use the following command to check for any potential issues:
If any issues are found, please address them before merging this change.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
Length of output: 6640