feat: add performance tests for format method

Author: wmundev

.github/workflows/run_performance_tests_windows.yml

@@ -0,0 +1,22 @@
+name: build_and_run_unit_tests_windows
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+  workflow_dispatch:
+
+jobs:
+  build_and_run_unit_tests_windows:
+    runs-on: windows-latest
+    timeout-minutes: 20
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: 8.x
+      - name: Run performance tests
+        run: dotnet run -c Release --framework net8.0
+        working-directory: ./csharp/PhoneNumbers.PerformanceTest

.gitignore

@@ -129,7 +129,7 @@ publish/
 # Publish Web Output
 *.[Pp]ublish.xml
 *.azurePubxml
-# TODO: Comment the next line if you want to checkin your web deploy settings 
+# TODO: 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
@@ -201,4 +201,7 @@ FakesAssemblies/
 
 # Zipped Geocoding Data
 geocoding.zip
-testgeocoding.zip
+testgeocoding.zip
+
+# Performance tests artifacts
+csharp/PhoneNumbers.PerformanceTest/BenchmarkDotNet.Artifacts/

csharp/PhoneNumbers.PerformanceTest/PhoneNumberFormatBenchmark.cs

@@ -0,0 +1,31 @@
+using BenchmarkDotNet.Attributes;
+using BenchmarkDotNet.Jobs;
+
+namespace PhoneNumbers.PerformanceTest
+{
+    [MemoryDiagnoser]
+    [SimpleJob(RuntimeMoniker.Net48)]
+    [SimpleJob(RuntimeMoniker.Net60)]
+    [SimpleJob(RuntimeMoniker.Net70)]
+    [SimpleJob(RuntimeMoniker.Net80)]
+    public class PhoneNumberFormatBenchmark
+    {
+        private PhoneNumberUtil phoneNumberUtil;
+        private PhoneNumber phoneNumber;
+
+        [GlobalSetup]
+        public void Setup()
+        {
+            phoneNumberUtil = PhoneNumberUtil.GetInstance();
+            phoneNumber = phoneNumberUtil.Parse("+14156667777", "US");
+        }
+
+        [Benchmark]
+        public void FormatPhoneNumber()
+        {
+            phoneNumberUtil.Format(phoneNumber, PhoneNumberFormat.INTERNATIONAL);
+        }
+    }
+}
+
+

csharp/PhoneNumbers.PerformanceTest/PhoneNumbers.PerformanceTest.csproj

@@ -0,0 +1,25 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFrameworks>netframework4.8;net6.0;net7.0;net8.0</TargetFrameworks>
+    <ImplicitUsings>disable</ImplicitUsings>
+  </PropertyGroup>
+
+  <PropertyGroup Condition="'$(TargetFramework)' == 'net6.0' Or '$(TargetFramework)' == 'net7.0' Or '$(TargetFramework)' == 'net8.0'">
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="BenchmarkDotNet" Version="0.13.12" />
+  </ItemGroup>
+
+  <ItemGroup Condition=" '$(TargetFramework)' == 'net48' ">
+    <PackageReference Include="System.Memory" Version="4.5.4" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\PhoneNumbers\PhoneNumbers.csproj" />
+  </ItemGroup>
+
+</Project>

csharp/PhoneNumbers.PerformanceTest/Program.cs

@@ -0,0 +1,12 @@
+using BenchmarkDotNet.Running;
+
+namespace PhoneNumbers.PerformanceTest
+{
+    public class Program
+    {
+        public static void Main(string[] args)
+        {
+            var summary = BenchmarkRunner.Run<PhoneNumberFormatBenchmark>();
+        }
+    }
+}