Skip to content

Latest commit

 

History

History
140 lines (98 loc) · 4.99 KB

CLAUDE.md

File metadata and controls

140 lines (98 loc) · 4.99 KB

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

SMock is a .NET library for mocking static and instance methods and properties. It's built on top of the MonoMod library and provides two distinct API styles:

  • Hierarchical Setup: Mock setup with validation actions - Mock.Setup(expression, action).Returns(value)
  • Sequential Setup: Disposable mock setup - using var _ = Mock.Setup(expression).Returns(value)

The library targets multiple frameworks: .NET Standard 2.0 and .NET Framework (4.62, 4.7, 4.71, 4.72, 4.8, 4.81), published as the "SMock" NuGet package.

Prerequisites

The development environment requires:

  • .NET 8.0, 9.0, and 10.0 SDKs installed for cross-platform testing
  • All tests run on Windows by default; Unix/macOS testing requires framework-specific commands

Development Commands

Build and Test

# Navigate to src directory first
cd src

# Restore dependencies
dotnet restore

# Build (Release configuration recommended)
dotnet build --configuration Release --no-restore

# Run all tests (Windows)
dotnet test --no-build --configuration Release --verbosity minimal

# Run tests for specific framework (Unix/macOS)
dotnet test --framework net8.0 --no-build --configuration Release --verbosity minimal
dotnet test --framework net9.0 --no-build --configuration Release --verbosity minimal
dotnet test --framework net10.0 --no-build --configuration Release --verbosity minimal

# Run a single test class
dotnet test --filter "ClassName=SetupMockReturnsTests"

# Run tests with specific category
dotnet test --filter "TestCategory=Hierarchical"

Working with Individual Projects

# Build only the main library
dotnet build src/StaticMock/StaticMock.csproj

# Run only unit tests
dotnet test src/StaticMock.Tests/StaticMock.Tests.csproj

# Run benchmarks
dotnet run --project src/StaticMock.Tests.Benchmark/StaticMock.Tests.Benchmark.csproj

Package Building and Publishing

# Pack the library for NuGet publication
dotnet pack --configuration Release --output packages src/StaticMock/StaticMock.csproj

# Publish to NuGet (requires API key)
dotnet nuget push packages/*.nupkg -k <NUGET_API_KEY> -s https://api.nuget.org/v3/index.json

Architecture Overview

Core Components

Mock Entry Points (Mock.Hierarchical.cs, Mock.Sequential.cs):

  • Partial class split into two files for the two API styles
  • All setup methods route through SetupMockHelper for consistency

Hook Management System:

  • HookBuilderFactory: Determines whether to create static or instance hook builders
  • StaticHookBuilder/InstanceHookBuilder: Create method hooks using MonoMod
  • MonoModHookManager: Manages hook lifecycle and method interception

Mock Implementations (Mocks/):

  • Hierarchical mocks: Support inline validation during setup
  • Sequential mocks: Return disposable objects for automatic cleanup
  • Type-specific mocks: IFuncMock<T>, IAsyncFuncMock<T>, IActionMock

Context System (Entities/Context/):

  • SetupContext: Provides access to It parameter matching
  • It: Argument matchers like IsAny<T>(), Is<T>(predicate)

Key Design Patterns

Factory Pattern: HookBuilderFactory creates appropriate builders based on static vs instance methods

Expression Tree Processing: Converts Lambda expressions into MethodInfo for runtime hook installation

Disposable Pattern: Sequential mocks implement IDisposable for automatic cleanup

Testing Structure

Test Organization

  • Tests/Hierarchical/: Tests for hierarchical API style
  • Tests/Sequential/: Tests for sequential API style
  • Tests/*/ReturnsTests/: Mock return value functionality
  • Tests/*/ThrowsTests/: Exception throwing functionality
  • Tests/*/CallbackTests/: Callback execution tests

Test Entities (StaticMock.Tests.Common/TestEntities/):

  • TestStaticClass: Static methods for testing
  • TestStaticAsyncClass: Async static methods
  • TestInstance: Instance methods
  • TestGenericInstance: Generic type testing

Running Specific Test Scenarios

# Test hierarchical returns functionality
dotnet test --filter "FullyQualifiedName~Hierarchical.ReturnsTests"

# Test sequential callback functionality
dotnet test --filter "FullyQualifiedName~Sequential.CallbackTests"

# Test async functionality across both styles
dotnet test --filter "TestMethod~Async"

Multi-Framework Support

The project targets multiple .NET versions to ensure broad compatibility:

  • netstandard2.0: Uses MonoMod.Core and System.Reflection.Emit
  • .NET Framework 4.62-4.81: Uses MonoMod.RuntimeDetour

When adding new features, ensure compatibility across all target frameworks by checking conditional compilation in the .csproj files.

Documentation

API documentation is generated using DocFX:

To work with documentation locally, use the DocFX toolchain in the docfx_project/ directory.