Merge pull request #4 from YarinOmesi/dev

merge dev into master

Author: YarinOmesi

.github/workflows/CI.yml

@@ -0,0 +1,30 @@
+name: Build
+
+on:
+  workflow_call: 
+  push:
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set Up .NET
+        uses: actions/setup-dotnet@v2
+        with:
+          dotnet-version: 6.0.x
+      - name: Restore
+        run: dotnet restore
+      - name: Build
+        run: dotnet build -c Release --no-restore
+      - name: Test
+        run: dotnet test -c Release --no-build --verbosity normal
+      - name: Pack
+        run: dotnet pack -c Release --no-build -o nupkgs
+      - uses: actions/cache@v2
+        id: restore-build
+        with:
+          path: ./*
+          key: ${{ github.sha }}
+

.github/workflows/Release.yml

@@ -0,0 +1,25 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "*"
+
+jobs:
+  build:
+    uses: ./.github/workflows/CI.yml
+  release:
+    needs: [build]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/cache@v3
+        id: restore-build
+        with:
+          path: ./*
+          key: ${{ github.sha }}
+      - name: Create GitHub release
+        uses: softprops/action-gh-release@v1
+        with:
+          files:  |
+            ${{ github.workspace }}/nupkgs/*.nupkg
+          tag_name: ${{ steps.tagName.outputs.tag }}

.gitignore

@@ -1,6 +1,6 @@
 # Common IntelliJ Platform excludes
 
-
+**/nupkg
 **/.idea
 
 # User specific

README.md

@@ -0,0 +1,73 @@
+# Mock Filler
+
+Creating tested class instance with mocks!
+
+refer to [Test File Example](./Sample.Tests/Test.cs) to see an example
+
+## How To Use
+
+All you need to do is to mark you test fixture class as `partial`.
+
+Create field of the desired tested class and mark it with attribute `[FillMocks]`.
+
+The Source Generator will fill mocks field and create a `Build()` method to create the instance.
+
+### Features
+
+#### FillMocks
+
+To Fill Mocks for given tested class, create a field for that class and mark it with `[FillMocks]`
+
+#### Default Value
+
+To declare a default value instead of creating a mock, create a field with name as following:
+
+defaultValue[Constructor Parameter Name]
+
+> you can add underscore and change the casing
+
+##### Demonstration
+
+```csharp
+private ILoggerFactory _defaultValueFactory = NullLoggerFactory.Instance;
+```
+
+### Example
+
+For This Code
+
+```csharp
+// Class Being Tested
+public class TestedClass
+{
+    private ILogger _logger;
+    
+    public TestedClass(ILoggerFactory factory)
+    {
+        /* Some Code */
+    }
+}
+
+// Test Fixture class
+public partial class MyTestFixture
+{
+    [FillMocks]
+    private TestedClass _testedClasss;
+    
+   /* Rest Of The Class */
+}
+```
+
+The Generated Code Will Be
+
+```csharp
+public partial class MyTestFixture
+{
+    private Mock<ILoggerFactory> _loggerFactoryMock;
+    
+   private TestedClass Build()
+   {
+        return new TestedClass(_loggerFactoryMock.Object);
+   }
+}
+```

Sample.Tests/IDependency.cs

@@ -0,0 +1,6 @@
+namespace Sample.Tests;
+
+public interface IDependency
+{
+    
+}

Sample.Tests/Sample.Tests.csproj

@@ -0,0 +1,24 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <TargetFramework>net6.0</TargetFramework>
+        <ImplicitUsings>enable</ImplicitUsings>
+        <Nullable>enable</Nullable>
+        <IsPackable>false</IsPackable>
+    </PropertyGroup>
+
+    <ItemGroup>
+        <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="7.0.0" />
+        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.1" />
+        <PackageReference Include="Moq" Version="4.18.4" />
+        <PackageReference Include="NUnit" Version="3.13.3" />
+        <PackageReference Include="NUnit3TestAdapter" Version="4.3.1" />
+    </ItemGroup>
+
+    <ItemGroup>
+        <ProjectReference Include="..\TestsHelper.SourceGenerator.Attributes\TestsHelper.SourceGenerator.Attributes.csproj" />
+        <ProjectReference Include="..\TestsHelper.SourceGenerator\TestsHelper.SourceGenerator.csproj" PrivateAssets="all" ReferenceOutputAssembly="true" OutputItemType="Analyzer" />
+    </ItemGroup>
+    
+
+</Project>

Sample.Tests/Test.cs

@@ -0,0 +1,34 @@
+using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Logging.Abstractions;
+using NUnit.Framework;
+using TestsHelper.SourceGenerator.Attributes;
+
+namespace Sample.Tests;
+
+[TestFixture]
+public partial class Test
+{
+    [FillMocks]
+    private TestedClass _testedClass;
+
+    
+    private readonly ILoggerFactory _defaultValueFactory = NullLoggerFactory.Instance;
+
+    [SetUp]
+    public void Setup()
+    {
+        _testedClass = Build();
+    }
+
+    [Test]
+    public void METHOD_On_Effect()
+    {
+        // Arrange
+        
+        // Act
+        _testedClass.VeryComplicatedLogic();
+        // Assert
+
+    }
+}
+

Sample.Tests/TestedClass.cs

@@ -0,0 +1,20 @@
+using Microsoft.Extensions.Logging;
+
+namespace Sample.Tests;
+
+public class TestedClass
+{
+    private IDependency _dependency;
+    private ILogger _logger;
+
+    public TestedClass(IDependency dependency, ILoggerFactory factory)
+    {
+        _dependency = dependency;
+        _logger = factory.CreateLogger<TestedClass>();
+    }
+
+    public int VeryComplicatedLogic()
+    {
+        return 0;
+    }
+}

TestsHelper.SourceGenerator.Attributes/FillMocksAttribute.cs

@@ -0,0 +1,9 @@
+using System;
+
+namespace TestsHelper.SourceGenerator.Attributes
+{
+    [AttributeUsage(AttributeTargets.Field | AttributeTargets.Property)]
+    public class FillMocksAttribute : Attribute
+    {
+    }
+}

TestsHelper.SourceGenerator.Attributes/TestsHelper.SourceGenerator.Attributes.csproj

@@ -0,0 +1,11 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <TargetFramework>netstandard2.0</TargetFramework>
+        <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
+    </PropertyGroup>
+    
+    <PropertyGroup>
+        <Version>1.0.0</Version>
+    </PropertyGroup>
+</Project>