chore: Add dotnet format validation (#33)

Author: dylanlerch

.editorconfig

@@ -0,0 +1,26 @@
+name: Validate formatting
+
+on:
+  # Run on all PRs targeting main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  validate-formatting:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v5
+        with:
+          global-json-file: global.json
+
+      - name: 🧑‍🏫 Validate Formatting
+        working-directory: ./src
+        run: |
+          dotnet format --verify-no-changes

.github/workflows/dotnet-format.yml

@@ -12,7 +12,7 @@ public class OctopusFeatureContextProviderTests
     {
         CacheDuration = TimeSpan.FromSeconds(1)
     };
-    
+
     class MockOctopusFeatureClient(FeatureToggles? featureToggles) : IOctopusFeatureClient
     {
         FeatureToggles? featureToggles = featureToggles;
@@ -37,7 +37,7 @@ public void ChangeToggles(FeatureToggles? featureToggles = null)
     public void WhenInstantiated_ProvidesAnEmptyEvaluationContext()
     {
         var provider = new OctopusFeatureContextProvider(configuration, new MockOctopusFeatureClient(null), NullLogger.Instance);
-        
+
         var context = provider.GetEvaluationContext();
 
         using var scope = new AssertionScope();
@@ -49,11 +49,11 @@ public void WhenInstantiated_ProvidesAnEmptyEvaluationContext()
     public async Task WhenInitialized_ProvidesRetrievedEvaluationContext()
     {
         byte[] contentHash = [0x01, 0x02, 0x03, 0x04];
-        
+
         var client = new MockOctopusFeatureClient(new FeatureToggles(
             [new FeatureToggleEvaluation("Test Feature", "test-feature", true, [])],
             contentHash));
-        
+
         var provider = new OctopusFeatureContextProvider(configuration, client, NullLogger.Instance);
         await provider.Initialize();
         var context = provider.GetEvaluationContext();
@@ -68,35 +68,35 @@ [new FeatureToggleEvaluation("Test Feature", "test-feature", true, [])],
     public async Task WhenInitialized_RefreshesCacheAfterCacheDurationExpires()
     {
         byte[] contentHash = [0x01, 0x02, 0x03, 0x04];
-        
+
         var client = new MockOctopusFeatureClient(new FeatureToggles(
-            [new FeatureToggleEvaluation("Test Feature", "test-feature", true, [])], 
+            [new FeatureToggleEvaluation("Test Feature", "test-feature", true, [])],
             contentHash));
-        
+
         // Initialize the provider
         var provider = new OctopusFeatureContextProvider(configuration, client, NullLogger.Instance);
         await provider.Initialize();
-        
+
         // Validate the initial state
         using var scope = new AssertionScope();
         var context = provider.GetEvaluationContext();
         context.ContentHash.Should().BeEquivalentTo(contentHash);
         context.Evaluate("test-feature", false, context: null).Value.Should().BeTrue();
-        
+
         // Simulate a change in the available feature toggles
         client.ChangeToggles(new FeatureToggles(
             [new FeatureToggleEvaluation("Test Feature", "test-feature", false, [])],
             [0x01, 0x02, 0x03, 0x05]));
 
         // Wait for the cache to expire
         await Task.Delay(TimeSpan.FromSeconds(5));
-        
+
         // Validate the updated toggles are available
         context = provider.GetEvaluationContext();
         context.ContentHash.Should().BeEquivalentTo(new byte[] { 0x01, 0x02, 0x03, 0x05 });
         context.Evaluate("test-feature", false, context: null).Value.Should().BeFalse();
     }
-    
+
     class AlwaysFailsFeatureClient : IOctopusFeatureClient
     {
         public Task<bool> HaveFeaturesChanged(byte[] contentHash, CancellationToken cancellationToken)
@@ -109,14 +109,14 @@ public Task<bool> HaveFeaturesChanged(byte[] contentHash, CancellationToken canc
             throw new Exception("Oops!");
         }
     }
-    
+
     [Fact]
     public async Task WhenFeatureEvaluationRetrievalFails_LogsError()
     {
         var client = new AlwaysFailsFeatureClient();
         var logger = new FakeLogger();
         var provider = new OctopusFeatureContextProvider(configuration, client, logger);
-        
+
         await provider.Initialize();
 
         using var scope = new AssertionScope();
@@ -126,4 +126,4 @@ public async Task WhenFeatureEvaluationRetrievalFails_LogsError()
 
         await provider.Shutdown();
     }
-}
+}

src/Octopus.OpenFeature.Provider.Tests/OctopusFeatureContextProviderTests.cs

@@ -21,7 +21,7 @@ public void EvaluatesToTrue_IfFeatureIsContainedWithinTheSet_AndFeatureIsEnabled
 
         result.Value.Should().BeTrue();
     }
-    
+
     [Fact]
     public void WhenEvaluatedWithCasingDifferences_EvaluationIsInsensitiveToCase()
     {
@@ -35,7 +35,7 @@ public void WhenEvaluatedWithCasingDifferences_EvaluationIsInsensitiveToCase()
 
         result.Value.Should().BeTrue();
     }
-    
+
     [Fact]
     public void EvaluatesToFalse_IfFeatureIsContainedWithinTheSet_AndFeatureIsNotEnabled()
     {
@@ -49,7 +49,7 @@ public void EvaluatesToFalse_IfFeatureIsContainedWithinTheSet_AndFeatureIsNotEna
 
         result.Value.Should().BeFalse();
     }
-    
+
     [Fact]
     public void GivenAFlagKeyThatIsNotASlug_ReturnsFlagNotFound_AndEvaluatesToDefaultValue()
     {
@@ -64,7 +64,7 @@ public void GivenAFlagKeyThatIsNotASlug_ReturnsFlagNotFound_AndEvaluatesToDefaul
         result.ErrorType.Should().Be(ErrorType.FlagNotFound);
         result.Value.Should().BeTrue();
     }
-    
+
     [Fact]
     public void EvaluatesToDefaultValue_IfFeatureIsNotContainedWithinSet()
     {
@@ -140,7 +140,7 @@ public void WhenAFeatureIsToggledOnForMultipleSegments_EvaluatesCorrectly()
         // A matching context value is present for each toggled segment
         context.Evaluate("testfeature", false, context: BuildContext([("license", "trial"), ("region", "us")])).Value
             .Should().BeTrue("when there is a matching context value for each toggled segment, the toggle should be enabled");
-        
+
         // A context value is present for each toggled segment, but it is not toggled on for one of the supplied values
         context.Evaluate("testfeature", false, context: BuildContext([("license", "trial"), ("region", "eu")])).Value
             .Should().BeFalse("when there is a matching context value for each toggled segment, but the context value does not match the toggled segment, the toggle should be disabled");
@@ -149,7 +149,7 @@ public void WhenAFeatureIsToggledOnForMultipleSegments_EvaluatesCorrectly()
         context.Evaluate("testfeature", false,
                 context: BuildContext([("license", "trial"), ("region", "us"), ("language", "english")])).Value.Should()
             .BeTrue("when extra context values are present, the toggle should still be enabled");
-        
+
         // A context value is present for only one of the two toggled segments
         context.Evaluate("testfeature", false, context: BuildContext([("license", "trial")])).Value.Should()
             .BeFalse("when the context does not contain a value for all toggled segments, the toggle should be disabled");
@@ -163,7 +163,7 @@ public void WhenAFeatureIsToggledOnForMultipleSegments_EvaluatesCorrectly()
         // None specified
         context.Evaluate("testfeature", true, context: null).Value.Should().BeFalse("when no context values are present, and the feature is toggled on for a segment, the toggle should be disabled");
     }
-    
+
     [Fact]
     public void
         WhenAFeatureIsToggledOnForASpecificSegment_ToleratesNullValuesInContext()
@@ -179,4 +179,4 @@ public void
         context.Evaluate("testfeature", false, context: BuildContext([("other", "segment")])).Value.Should().BeFalse();
         context.Evaluate("testfeature", false, context: null).Value.Should().BeFalse();
     }
-}
+}

src/Octopus.OpenFeature.Provider.Tests/OctopusFeatureContextTests.cs

@@ -1,24 +1,24 @@
 using System.Net;
-using Microsoft.Extensions.Logging;
 using System.Text.Json;
+using Microsoft.Extensions.Logging;
 
 namespace Octopus.OpenFeature.Provider;
 
 public class FeatureToggles(FeatureToggleEvaluation[] evaluations, byte[] contentHash)
 {
     public FeatureToggleEvaluation[] Evaluations { get; } = evaluations;
-    
+
     public byte[] ContentHash { get; } = contentHash;
 }
 
 public class FeatureToggleEvaluation(string name, string slug, bool isEnabled, KeyValuePair<string, string>[] segments)
 {
     public string Name { get; } = name;
-    
+
     public string Slug { get; } = slug;
-    
+
     public bool IsEnabled { get; } = isEnabled;
-    
+
     public KeyValuePair<string, string>[] Segments { get; } = segments;
 }
 
@@ -58,22 +58,22 @@ public async Task<bool> HaveFeaturesChanged(byte[] contentHash, CancellationToke
             if (result is not null && result.IsSuccessStatusCode)
             {
                 var rawResult = await result.Content.ReadAsStringAsync();
-                
+
                 hash = JsonSerializer.Deserialize<FeatureCheck>(rawResult, JsonSerializerOptions.Web);
             }
         }
         else
         {
             var result = await ExecuteWithRetry(async ct => await client.GetAsync($"api/featuretoggles/{configuration.ClientIdentifier}/check", ct), cancellationToken);
-            
+
             if (result is not null && result.IsSuccessStatusCode)
             {
                 var rawResult = await result.Content.ReadAsStringAsync();
-            
+
                 hash = JsonSerializer.Deserialize<FeatureCheck>(rawResult, JsonSerializerOptions.Web);
             }
         }
-            
+
         if (hash is null)
         {
             logger.LogWarning("Failed to retrieve feature toggles after 3 retries. Previously retrieved feature toggle values will continue to be used.");
@@ -106,21 +106,21 @@ class FeatureCheck(byte[] contentHash)
 
         if (configuration.ReleaseVersionOverride is not null)
         {
-            client.DefaultRequestHeaders.Add(OctopusHttpHeaderNames.ReleaseVersion, configuration.ReleaseVersionOverride);       
+            client.DefaultRequestHeaders.Add(OctopusHttpHeaderNames.ReleaseVersion, configuration.ReleaseVersionOverride);
         }
 
         HttpResponseMessage? response;
         if (configuration.IsV3ClientIdentifierSupplied())
         {
             client.DefaultRequestHeaders.Add("Authorization", $"Bearer {configuration.ClientIdentifier}");
-            
+
             response = await ExecuteWithRetry(async ct => await client.GetAsync("api/featuretoggles/v3/", ct), cancellationToken);
         }
         else
         {
             response = await ExecuteWithRetry(async ct => await client.GetAsync($"api/featuretoggles/v2/{configuration.ClientIdentifier}", ct), cancellationToken);
         }
-           
+
         if (response is null or { StatusCode: HttpStatusCode.NotFound })
         {
             logger.LogWarning("Failed to retrieve feature toggles for client identifier {ClientIdentifier} from {OctoToggleUrl}", configuration.ClientIdentifier, configuration.ServerUri);
@@ -144,9 +144,9 @@ class FeatureCheck(byte[] contentHash)
         // If for any reason the v3 endpoint response contract starts to diverge from the v2 contract,
         // This code will need to update accordingly
         var result = await response.Content.ReadAsStringAsync();
-        
+
         var evaluations = JsonSerializer.Deserialize<FeatureToggleEvaluation[]>(result, JsonSerializerOptions.Web);
-        
+
         if (evaluations is null)
         {
             logger.LogWarning("Feature toggle response content from {OctoToggleUrl} was empty", configuration.ServerUri);
@@ -157,7 +157,7 @@ class FeatureCheck(byte[] contentHash)
 
         return toggles;
     }
-        
+
     async Task<T?> ExecuteWithRetry<T>(Func<CancellationToken, Task<T>> callback, CancellationToken cancellationToken)
     {
         var attempts = 0;

src/Octopus.OpenFeature.Provider/OctopusFeatureClient.cs

@@ -6,16 +6,16 @@ namespace Octopus.OpenFeature.Provider;
 public class OctopusFeatureConfiguration
 {
     const string DefaultServerUri = "https://features.octopus.com";
-        
+
     public OctopusFeatureConfiguration(string clientIdentifier)
     {
         ClientIdentifier = clientIdentifier;
         var serverUri = Environment.GetEnvironmentVariable("OctoToggle__Url");
         ServerUri = serverUri is not null ? new Uri(serverUri) : new Uri(DefaultServerUri);
     }
-        
+
     public Uri ServerUri { get; private set; }
-    
+
     /// <summary>
     /// Overrides the application release version embedded in the ClientIdentifier
     /// </summary>
@@ -24,16 +24,16 @@ public OctopusFeatureConfiguration(string clientIdentifier)
     /// <summary>
     /// The ClientIdentifier provided by the Octopus variable Octopus.FeatureToggles.ClientIdentifier
     /// </summary>
-    public string ClientIdentifier { get; set; } 
-        
+    public string ClientIdentifier { get; set; }
+
     /// <summary>
     /// The amount of time between checks to see if new feature toggles are available
     /// The cache will be refreshed if new feature toggles are available
     /// </summary>
     public TimeSpan CacheDuration { get; set; } = TimeSpan.FromMinutes(1);
-        
+
     public CancellationToken CancellationToken { get; set; } = CancellationToken.None;
-        
+
     public ILoggerFactory LoggerFactory { get; set; } = NullLoggerFactory.Instance;
 
     public bool IsV3ClientIdentifierSupplied()
@@ -42,4 +42,4 @@ public bool IsV3ClientIdentifierSupplied()
         var tokenSegments = ClientIdentifier.Split('.');
         return tokenSegments.Length == 3;
     }
-}
+}

src/Octopus.OpenFeature.Provider/OctopusFeatureConfiguration.cs

@@ -46,11 +46,14 @@ public ResolutionDetails<bool> Evaluate(string slug, bool defaultValue, Evaluati
 
     bool MatchesSegment(EvaluationContext? context, IEnumerable<KeyValuePair<string, string>> segments)
     {
-        if (context == null) return false;
+        if (context == null)
+        {
+            return false;
+        }
 
         var contextEntries = context.AsDictionary();
 
-        return segments.GroupBy(x => x.Key).All(group => 
+        return segments.GroupBy(x => x.Key).All(group =>
             group.Any(segment =>
                 contextEntries.Any(contextEntry =>
                     contextEntry.Key.Equals(segment.Key, StringComparison.OrdinalIgnoreCase)
@@ -63,4 +66,4 @@ bool Evaluate(FeatureToggleEvaluation evaluation, EvaluationContext? context = n
         return evaluation.IsEnabled &&
                (evaluation.Segments.Length == 0 || MatchesSegment(context, evaluation.Segments));
     }
-}
+}