fix: code review

Farfetch · Jan 31, 2024 · cfdd7b3 · cfdd7b3
1 parent c2faf41
commit cfdd7b3
Show file tree

Hide file tree

Showing 29 changed files with 128 additions and 72 deletions.
diff --git a/.github/workflows/build-test.yml b/.github/workflows/build-test.yml
@@ -0,0 +1,48 @@
+name: Build and Test
+
+on:
+  pull_request:
+
+  push:
+    branches: [ main ]
+
+jobs:
+  build-test:
+
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: GITHUB CONTEXT
+        env:
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+        run: echo "$GITHUB_CONTEXT"
+
+      - name: Commit Lint
+        uses: wagoid/commitlint-github-action@master
+        with:
+          failOnWarnings: true
+
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: '8.0.x'
+
+      - name: Build Framework
+        run:  |
+          dotnet build LoadShedding.sln -c Release
+
+      - name: UnitTests
+        run: |
+          dotnet test LoadShedding.sln --filter Category=Unit -c Release --logger "console;verbosity=detailed"
+
+      - name: IntegrationTests
+        run: |
+          dotnet test LoadShedding.sln --filter Category=Integration -c Release --logger "console;verbosity=detailed"
+
+
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
diff --git a/.github/workflows/metrics.yml b/.github/workflows/metrics.yml
@@ -41,7 +41,7 @@ jobs:
       uses: github/issue-metrics@v2
       env:
         GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        SEARCH_QUERY: 'repo:farfetch/kafkaflow created:${{ env.last_month }} -reason:"not planned"'
+        SEARCH_QUERY: 'repo:farfetch/loadshedding created:${{ env.last_month }} -reason:"not planned"'
 
     - name: Upload for opened items 
       uses: actions/upload-artifact@v3
@@ -54,7 +54,7 @@ jobs:
       uses: github/issue-metrics@v2
       env:
         GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        SEARCH_QUERY: 'repo:farfetch/kafkaflow closed:${{ env.last_month }} -reason:"not planned"'
+        SEARCH_QUERY: 'repo:farfetch/loadshedding closed:${{ env.last_month }} -reason:"not planned"'
 
     - name: Upload for closed items
       uses: actions/upload-artifact@v3
@@ -67,7 +67,7 @@ jobs:
       uses: github/issue-metrics@v2
       env:
         GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        SEARCH_QUERY: 'repo:farfetch/kafkaflow type:discussions created:${{ env.last_month }} -reason:"not planned"'
+        SEARCH_QUERY: 'repo:farfetch/loadshedding type:discussions created:${{ env.last_month }} -reason:"not planned"'
 
     - name: Upload for opened discussions
       uses: actions/upload-artifact@v3
@@ -80,10 +80,10 @@ jobs:
       uses: github/issue-metrics@v2
       env:
         GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        SEARCH_QUERY: 'repo:farfetch/kafkaflow type:discussions closed:${{ env.last_month }} -reason:"not planned"'
+        SEARCH_QUERY: 'repo:farfetch/loadshedding type:discussions closed:${{ env.last_month }} -reason:"not planned"'
 
     - name: Upload for closed discussions
       uses: actions/upload-artifact@v3
       with:
         name: discussions-closed
-        path: ./issue_metrics.md
+        path: ./issue_metrics.md
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -14,7 +14,7 @@ jobs:
       - name: Setup .NET
         uses: actions/setup-dotnet@v3
         with:
-          dotnet-version: '2.0.x'
+          dotnet-version: '8.0.x'
 
       - name: Pack
         run: dotnet pack ./LoadShedding.sln -c Release /p:Version=${{ github.event.release.tag_name }} -o ./drop
@@ -23,4 +23,4 @@ jobs:
         run: dotnet nuget push ./drop/**/*.nupkg -k ${{ secrets.NUGET_PUBLISH_KEY }} -s https://api.nuget.org/v3/index.json --skip-duplicate
 
       - name: Print Version
-        run: echo ${{ github.event.release.tag_name }}
+        run: echo ${{ github.event.release.tag_name }}
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -0,0 +1,33 @@
+<Project>
+  <PropertyGroup>
+    <LangVersion>10.0</LangVersion>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <IncludeSymbols>true</IncludeSymbols>
+    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
+    <PublishRepositoryUrl>true</PublishRepositoryUrl>
+    <Authors>Farfetch</Authors>
+    <Company>Farfetch</Company>
+    <Product>LoadShedding</Product>
+    <PackageProjectUrl>https://github.com/Farfetch/loadshedding</PackageProjectUrl>
+    <RepositoryUrl>https://github.com/Farfetch/loadshedding</RepositoryUrl>
+    <RepositoryType>git</RepositoryType>
+    <license>https://github.com/Farfetch/loadshedding/blob/master/LICENSE</license>
+    <PackageLicenseExpression>MIT</PackageLicenseExpression>
+    <PackageIconUrl>https://raw.githubusercontent.com/Farfetch/.github/master/images/fuse-logo-128.png</PackageIconUrl>
+    <PackageTags>loadshedding</PackageTags>
+    <CodeAnalysisRuleSet>$([MSBuild]::GetPathOfFileAbove('StyleCopAnalyzersDefault.ruleset'))</CodeAnalysisRuleSet>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="All"/>
+    <PackageReference Include="StyleCop.Analyzers" Version="1.1.118">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+  </ItemGroup>
+
+  <ItemGroup>
+    <AdditionalFiles Include="$([MSBuild]::GetPathOfFileAbove('stylecop.json'))" Link="stylecop.json" />
+  </ItemGroup>
+
+</Project>
diff --git a/src/StyleCopAnalyzersDefault.ruleset → StyleCopAnalyzersDefault.ruleset b/src/StyleCopAnalyzersDefault.ruleset → StyleCopAnalyzersDefault.ruleset
diff --git a/src/Farfetch.LoadShedding/Farfetch.LoadShedding.csproj b/src/Farfetch.LoadShedding/Farfetch.LoadShedding.csproj
@@ -2,6 +2,8 @@
 
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
+    <PackageId>LoadShedding</PackageId>
+    <Description>LoadShedding main package</Description>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/src/stylecop.json → stylecop.json b/src/stylecop.json → stylecop.json
diff --git a/tests/Directory.Build.props b/tests/Directory.Build.props
@@ -0,0 +1,8 @@
+<Project>
+    <Import Project="$([MSBuild]::GetPathOfFileAbove('Directory.Build.props', '$(MSBuildThisFileDirectory)../src'))" />
+
+    <ItemGroup>
+        <Compile Include="$(MSBuildProjectDirectory)/../Traits.cs" Link="Properties/Traits.cs"/>
+		<AdditionalFiles Include="..\..\..\stylecop.json" Link="stylecop.json" />
+    </ItemGroup>
+</Project>
diff --git a/...enchmark/Farfetch.LoadShedding.BenchmarkTests/Farfetch.LoadShedding.BenchmarkTests.csproj b/...enchmark/Farfetch.LoadShedding.BenchmarkTests/Farfetch.LoadShedding.BenchmarkTests.csproj
@@ -17,4 +17,8 @@
     <ProjectReference Include="..\..\..\src\Farfetch.LoadShedding\Farfetch.LoadShedding.csproj" />
   </ItemGroup>
 
+  <ItemGroup>
+    <Compile Remove="$(MSBuildProjectDirectory)/../Traits.cs" />
+  </ItemGroup>
+
 </Project>
diff --git a/...arfetch.LoadShedding.IntegrationTests/Tests/Limiters/AdaptativeConcurrencyLimiterTests.cs b/...arfetch.LoadShedding.IntegrationTests/Tests/Limiters/AdaptativeConcurrencyLimiterTests.cs
@@ -1,4 +1,4 @@
-using System.Collections.Concurrent;
+using System.Collections.Concurrent;
 using System.Net;
 using Farfetch.LoadShedding.AspNetCore.Options;
 using Farfetch.LoadShedding.Configurations;

diff --git a/tests/integration-tests/Traits.cs b/tests/integration-tests/Traits.cs
@@ -0,0 +1,3 @@
+using Xunit;
+
+[assembly: AssemblyTrait("Category", "Integration")]
diff --git a/...ests/Farfetch.LoadShedding.PerformanceTests/Farfetch.LoadShedding.PerformanceTests.csproj b/...ests/Farfetch.LoadShedding.PerformanceTests/Farfetch.LoadShedding.PerformanceTests.csproj
@@ -17,4 +17,8 @@
     </None>
   </ItemGroup>
 
+  <ItemGroup>
+    <Compile Remove="$(MSBuildProjectDirectory)/../Traits.cs" />
+  </ItemGroup>
+
 </Project>
diff --git a/...sts/Farfetch.LoadShedding.AspNetCore.Tests/Configurators/LoadSheddingConfiguratorTests.cs b/...sts/Farfetch.LoadShedding.AspNetCore.Tests/Configurators/LoadSheddingConfiguratorTests.cs
@@ -1,4 +1,4 @@
-using Farfetch.LoadShedding.AspNetCore.Configurators;
+using Farfetch.LoadShedding.AspNetCore.Configurators;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.Extensions.DependencyInjection;
 using Xunit;

diff --git a/....LoadShedding.AspNetCore.Tests/Middlewares/AdaptativeConcurrencyLimiterMiddlewareTests.cs b/....LoadShedding.AspNetCore.Tests/Middlewares/AdaptativeConcurrencyLimiterMiddlewareTests.cs
@@ -1,4 +1,4 @@
-using Farfetch.LoadShedding.AspNetCore.Middlewares;
+using Farfetch.LoadShedding.AspNetCore.Middlewares;
 using Farfetch.LoadShedding.AspNetCore.Options;
 using Farfetch.LoadShedding.Exceptions;
 using Farfetch.LoadShedding.Limiters;

diff --git a/...it-tests/Farfetch.LoadShedding.AspNetCore.Tests/Resolvers/DefaultPriorityResolverTests.cs b/...it-tests/Farfetch.LoadShedding.AspNetCore.Tests/Resolvers/DefaultPriorityResolverTests.cs
@@ -1,4 +1,4 @@
-using Farfetch.LoadShedding.AspNetCore.Resolvers;
+using Farfetch.LoadShedding.AspNetCore.Resolvers;
 using Farfetch.LoadShedding.Tasks;
 using Microsoft.AspNetCore.Http;
 using Moq;

diff --git a/...t-tests/Farfetch.LoadShedding.AspNetCore.Tests/Resolvers/EndpointPriorityResolverTests.cs b/...t-tests/Farfetch.LoadShedding.AspNetCore.Tests/Resolvers/EndpointPriorityResolverTests.cs
@@ -1,4 +1,4 @@
-using Farfetch.LoadShedding.AspNetCore.Attributes;
+using Farfetch.LoadShedding.AspNetCore.Attributes;
 using Farfetch.LoadShedding.AspNetCore.Resolvers;
 using Farfetch.LoadShedding.Tasks;
 using Microsoft.AspNetCore.Http;

diff --git a/...tests/Farfetch.LoadShedding.AspNetCore.Tests/Resolvers/HttpHeaderPriorityResolverTests.cs b/...tests/Farfetch.LoadShedding.AspNetCore.Tests/Resolvers/HttpHeaderPriorityResolverTests.cs
@@ -1,4 +1,4 @@
-using Farfetch.LoadShedding.AspNetCore.Resolvers;
+using Farfetch.LoadShedding.AspNetCore.Resolvers;
 using Farfetch.LoadShedding.Tasks;
 using Microsoft.AspNetCore.Http;
 using Moq;

diff --git a/tests/unit-tests/Farfetch.LoadShedding.Tests/Builders/AdaptativeLimiterBuilderTests.cs b/tests/unit-tests/Farfetch.LoadShedding.Tests/Builders/AdaptativeLimiterBuilderTests.cs
@@ -1,4 +1,4 @@
-using Farfetch.LoadShedding.Builders;
+using Farfetch.LoadShedding.Builders;
 using Xunit;
 
 namespace Farfetch.LoadShedding.Tests.Builders

diff --git a/tests/unit-tests/Farfetch.LoadShedding.Tests/Calculators/GradientLimitCalculatorTests.cs b/tests/unit-tests/Farfetch.LoadShedding.Tests/Calculators/GradientLimitCalculatorTests.cs
@@ -1,4 +1,4 @@
-using Farfetch.LoadShedding.Calculators;
+using Farfetch.LoadShedding.Calculators;
 using Farfetch.LoadShedding.Configurations;
 using Moq;
 using Xunit;

diff --git a/tests/unit-tests/Farfetch.LoadShedding.Tests/Calculators/SquareRootQueueCalculatorTests.cs b/tests/unit-tests/Farfetch.LoadShedding.Tests/Calculators/SquareRootQueueCalculatorTests.cs
@@ -1,4 +1,4 @@
-using Farfetch.LoadShedding.Calculators;
+using Farfetch.LoadShedding.Calculators;
 using Farfetch.LoadShedding.Configurations;
 using Moq;
 using Xunit;

diff --git a/tests/unit-tests/Farfetch.LoadShedding.Tests/Configurations/ConcurrencyContextTests.cs b/tests/unit-tests/Farfetch.LoadShedding.Tests/Configurations/ConcurrencyContextTests.cs
@@ -1,4 +1,4 @@
-using Farfetch.LoadShedding.Configurations;
+using Farfetch.LoadShedding.Configurations;
 using Farfetch.LoadShedding.Events;
 using Farfetch.LoadShedding.Measures;
 using Farfetch.LoadShedding.Tasks;

diff --git a/tests/unit-tests/Farfetch.LoadShedding.Tests/Configurations/ConcurrencyOptionsTests.cs b/tests/unit-tests/Farfetch.LoadShedding.Tests/Configurations/ConcurrencyOptionsTests.cs
@@ -1,4 +1,4 @@
-using Farfetch.LoadShedding.Configurations;
+using Farfetch.LoadShedding.Configurations;
 using Farfetch.LoadShedding.Exceptions;
 using Xunit;
 

diff --git a/tests/unit-tests/Farfetch.LoadShedding.Tests/Limiters/AdaptativeConcurrencyLimiterTests.cs b/tests/unit-tests/Farfetch.LoadShedding.Tests/Limiters/AdaptativeConcurrencyLimiterTests.cs
@@ -1,4 +1,4 @@
-using Farfetch.LoadShedding.Calculators;
+using Farfetch.LoadShedding.Calculators;
 using Farfetch.LoadShedding.Configurations;
 using Farfetch.LoadShedding.Limiters;
 using Farfetch.LoadShedding.Events;

diff --git a/tests/unit-tests/Farfetch.LoadShedding.Tests/Measures/RTTMeasuresTests.cs b/tests/unit-tests/Farfetch.LoadShedding.Tests/Measures/RTTMeasuresTests.cs
@@ -1,4 +1,4 @@
-using Farfetch.LoadShedding.Measures;
+using Farfetch.LoadShedding.Measures;
 using Xunit;
 
 namespace Farfetch.LoadShedding.Tests.Measures

diff --git a/tests/unit-tests/Farfetch.LoadShedding.Tests/Tasks/TaskItemTests.cs b/tests/unit-tests/Farfetch.LoadShedding.Tests/Tasks/TaskItemTests.cs
@@ -1,4 +1,4 @@
-using Farfetch.LoadShedding.Tasks;
+using Farfetch.LoadShedding.Tasks;
 using Xunit;
 
 namespace Farfetch.LoadShedding.Tests.Tasks

diff --git a/tests/unit-tests/Farfetch.LoadShedding.Tests/Tasks/TaskManagerTests.cs b/tests/unit-tests/Farfetch.LoadShedding.Tests/Tasks/TaskManagerTests.cs
@@ -1,4 +1,4 @@
-using Farfetch.LoadShedding.Events;
+using Farfetch.LoadShedding.Events;
 using Farfetch.LoadShedding.Events.Args;
 using Farfetch.LoadShedding.Exceptions;
 using Farfetch.LoadShedding.Tasks;

diff --git a/tests/unit-tests/Farfetch.LoadShedding.Tests/Tasks/TaskQueueTests.cs b/tests/unit-tests/Farfetch.LoadShedding.Tests/Tasks/TaskQueueTests.cs
@@ -1,4 +1,4 @@
-using Farfetch.LoadShedding.Tasks;
+using Farfetch.LoadShedding.Tasks;
 using Xunit;
 
 namespace Farfetch.LoadShedding.Tests.Tasks

diff --git a/tests/unit-tests/Traits.cs b/tests/unit-tests/Traits.cs
@@ -0,0 +1,3 @@
+using Xunit;
+
+[assembly: AssemblyTrait("Category", "Unit")]