From 4bf07b0972440d65d0504161be41d6941ece4bee Mon Sep 17 00:00:00 2001 From: ThompsonNye Date: Sun, 15 Jun 2025 09:36:52 +0200 Subject: [PATCH] Add editor config and apply code cleanup --- .editorconfig | 271 ++++++++++++++++++ src/Vegasco.Server.Api/Cars/GetCars.cs | 2 +- .../Common/DependencyInjectionExtensions.cs | 6 +- .../Common/StartupExtensions.cs | 4 +- .../Consumptions/GetConsumptions.cs | 76 ++--- .../Endpoints/EndpointExtensions.cs | 2 +- src/Vegasco.Server.Api/Info/GetServerInfo.cs | 40 +-- .../Migrations/20240818105918_Initial.cs | 150 +++++----- src/Vegasco.Server.AppHost/Program.cs | 4 +- .../Extensions.cs | 164 +++++------ .../Info/GetServerInfoTests.cs | 46 +-- 11 files changed, 516 insertions(+), 249 deletions(-) create mode 100644 .editorconfig diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..5055012 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,271 @@ +# Remove the line below if you want to inherit .editorconfig settings from higher directories +root = true + +# C# files +[*.cs] + +#### Core EditorConfig Options #### + +# Indentation and spacing +indent_size = 4 +indent_style = tab +tab_width = 4 + +# New line preferences +end_of_line = crlf +insert_final_newline = false + +#### .NET Coding Conventions #### + +# Organize usings +dotnet_separate_import_directive_groups = false +dotnet_sort_system_directives_first = false +file_header_template = unset + +# this. and Me. preferences +dotnet_style_qualification_for_event = false +dotnet_style_qualification_for_field = false +dotnet_style_qualification_for_method = false +dotnet_style_qualification_for_property = false + +# Language keywords vs BCL types preferences +dotnet_style_predefined_type_for_locals_parameters_members = true +dotnet_style_predefined_type_for_member_access = true + +# Parentheses preferences +dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity +dotnet_style_parentheses_in_other_binary_operators = always_for_clarity +dotnet_style_parentheses_in_other_operators = never_if_unnecessary +dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity + +# Modifier preferences +dotnet_style_require_accessibility_modifiers = for_non_interface_members + +# Expression-level preferences +dotnet_style_coalesce_expression = true +dotnet_style_collection_initializer = true +dotnet_style_explicit_tuple_names = true +dotnet_style_namespace_match_folder = true +dotnet_style_null_propagation = true +dotnet_style_object_initializer = true +dotnet_style_operator_placement_when_wrapping = beginning_of_line +dotnet_style_prefer_auto_properties = true:suggestion +dotnet_style_prefer_collection_expression = when_types_loosely_match +dotnet_style_prefer_compound_assignment = true +dotnet_style_prefer_conditional_expression_over_assignment = true +dotnet_style_prefer_conditional_expression_over_return = true +dotnet_style_prefer_foreach_explicit_cast_in_source = when_strongly_typed +dotnet_style_prefer_inferred_anonymous_type_member_names = true +dotnet_style_prefer_inferred_tuple_names = true +dotnet_style_prefer_is_null_check_over_reference_equality_method = true +dotnet_style_prefer_simplified_boolean_expressions = true +dotnet_style_prefer_simplified_interpolation = true + +# Field preferences +dotnet_style_readonly_field = true + +# Parameter preferences +dotnet_code_quality_unused_parameters = all + +# Suppression preferences +dotnet_remove_unnecessary_suppression_exclusions = none + +# New line preferences +dotnet_style_allow_multiple_blank_lines_experimental = false:suggestion +dotnet_style_allow_statement_immediately_after_block_experimental = false:suggestion + +#### C# Coding Conventions #### + +# var preferences +csharp_style_var_elsewhere = false +csharp_style_var_for_built_in_types = false +csharp_style_var_when_type_is_apparent = false + +# Expression-bodied members +csharp_style_expression_bodied_accessors = true:silent +csharp_style_expression_bodied_constructors = false:silent +csharp_style_expression_bodied_indexers = true:silent +csharp_style_expression_bodied_lambdas = true:silent +csharp_style_expression_bodied_local_functions = true:silent +csharp_style_expression_bodied_methods = false:silent +csharp_style_expression_bodied_operators = false:silent +csharp_style_expression_bodied_properties = true:silent + +# Pattern matching preferences +csharp_style_pattern_matching_over_as_with_null_check = true +csharp_style_pattern_matching_over_is_with_cast_check = true +csharp_style_prefer_extended_property_pattern = true +csharp_style_prefer_not_pattern = true +csharp_style_prefer_pattern_matching = true +csharp_style_prefer_switch_expression = true + +# Null-checking preferences +csharp_style_conditional_delegate_call = true + +# Modifier preferences +csharp_prefer_static_local_function = true +csharp_preferred_modifier_order = public,private,protected,internal,file,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,required,volatile,async +csharp_style_prefer_readonly_struct = true +csharp_style_prefer_readonly_struct_member = true + +# Code-block preferences +csharp_prefer_braces = true:silent +csharp_prefer_simple_using_statement = true:suggestion +csharp_style_namespace_declarations = file_scoped:silent +csharp_style_prefer_method_group_conversion = true:silent +csharp_style_prefer_primary_constructors = true:suggestion +csharp_style_prefer_top_level_statements = true:silent + +# Expression-level preferences +csharp_prefer_simple_default_expression = true +csharp_style_deconstructed_variable_declaration = true +csharp_style_implicit_object_creation_when_type_is_apparent = true +csharp_style_inlined_variable_declaration = true +csharp_style_prefer_index_operator = true +csharp_style_prefer_local_over_anonymous_function = true +csharp_style_prefer_null_check_over_type_check = true +csharp_style_prefer_range_operator = true +csharp_style_prefer_tuple_swap = true +csharp_style_prefer_utf8_string_literals = true +csharp_style_throw_expression = true +csharp_style_unused_value_assignment_preference = discard_variable +csharp_style_unused_value_expression_statement_preference = discard_variable + +# 'using' directive preferences +csharp_using_directive_placement = outside_namespace:silent + +# New line preferences +csharp_style_allow_blank_line_after_colon_in_constructor_initializer_experimental = true +csharp_style_allow_blank_line_after_token_in_arrow_expression_clause_experimental = true +csharp_style_allow_blank_line_after_token_in_conditional_expression_experimental = true +csharp_style_allow_blank_lines_between_consecutive_braces_experimental = false:suggestion +csharp_style_allow_embedded_statements_on_same_line_experimental = true + +#### C# Formatting Rules #### + +# New line preferences +csharp_new_line_before_catch = true +csharp_new_line_before_else = true +csharp_new_line_before_finally = true +csharp_new_line_before_members_in_anonymous_types = true +csharp_new_line_before_members_in_object_initializers = true +csharp_new_line_before_open_brace = all +csharp_new_line_between_query_expression_clauses = true + +# Indentation preferences +csharp_indent_block_contents = true +csharp_indent_braces = false +csharp_indent_case_contents = true +csharp_indent_case_contents_when_block = true +csharp_indent_labels = one_less_than_current +csharp_indent_switch_labels = true + +# Space preferences +csharp_space_after_cast = false +csharp_space_after_colon_in_inheritance_clause = true +csharp_space_after_comma = true +csharp_space_after_dot = false +csharp_space_after_keywords_in_control_flow_statements = true +csharp_space_after_semicolon_in_for_statement = true +csharp_space_around_binary_operators = before_and_after +csharp_space_around_declaration_statements = false +csharp_space_before_colon_in_inheritance_clause = true +csharp_space_before_comma = false +csharp_space_before_dot = false +csharp_space_before_open_square_brackets = false +csharp_space_before_semicolon_in_for_statement = false +csharp_space_between_empty_square_brackets = false +csharp_space_between_method_call_empty_parameter_list_parentheses = false +csharp_space_between_method_call_name_and_opening_parenthesis = false +csharp_space_between_method_call_parameter_list_parentheses = false +csharp_space_between_method_declaration_empty_parameter_list_parentheses = false +csharp_space_between_method_declaration_name_and_open_parenthesis = false +csharp_space_between_method_declaration_parameter_list_parentheses = false +csharp_space_between_parentheses = false +csharp_space_between_square_brackets = false + +# Wrapping preferences +csharp_preserve_single_line_blocks = true +csharp_preserve_single_line_statements = true + +#### Naming styles #### + +# Naming rules + +dotnet_naming_rule.interface_should_be_begins_with_i.severity = warning +dotnet_naming_rule.interface_should_be_begins_with_i.symbols = interface +dotnet_naming_rule.interface_should_be_begins_with_i.style = begins_with_i + +dotnet_naming_rule.types_should_be_pascal_case.severity = warning +dotnet_naming_rule.types_should_be_pascal_case.symbols = types +dotnet_naming_rule.types_should_be_pascal_case.style = pascal_case + +dotnet_naming_rule.non_field_members_should_be_pascal_case.severity = warning +dotnet_naming_rule.non_field_members_should_be_pascal_case.symbols = non_field_members +dotnet_naming_rule.non_field_members_should_be_pascal_case.style = pascal_case + +dotnet_naming_rule.private_or_internal_field_should_be_underscore.severity = warning +dotnet_naming_rule.private_or_internal_field_should_be_underscore.symbols = private_or_internal_field +dotnet_naming_rule.private_or_internal_field_should_be_underscore.style = underscore + +dotnet_naming_rule.private_or_internal_static_field_should_be_sunderscore.severity = warning +dotnet_naming_rule.private_or_internal_static_field_should_be_sunderscore.symbols = private_or_internal_static_field +dotnet_naming_rule.private_or_internal_static_field_should_be_sunderscore.style = sunderscore + +# Symbol specifications + +dotnet_naming_symbols.interface.applicable_kinds = interface +dotnet_naming_symbols.interface.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected +dotnet_naming_symbols.interface.required_modifiers = + +dotnet_naming_symbols.private_or_internal_field.applicable_kinds = field +dotnet_naming_symbols.private_or_internal_field.applicable_accessibilities = internal, private, private_protected +dotnet_naming_symbols.private_or_internal_field.required_modifiers = + +dotnet_naming_symbols.private_or_internal_static_field.applicable_kinds = field +dotnet_naming_symbols.private_or_internal_static_field.applicable_accessibilities = internal, private, private_protected +dotnet_naming_symbols.private_or_internal_static_field.required_modifiers = static + +dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum +dotnet_naming_symbols.types.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected +dotnet_naming_symbols.types.required_modifiers = + +dotnet_naming_symbols.non_field_members.applicable_kinds = property, event, method +dotnet_naming_symbols.non_field_members.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected +dotnet_naming_symbols.non_field_members.required_modifiers = + +# Naming styles + +dotnet_naming_style.pascal_case.required_prefix = +dotnet_naming_style.pascal_case.required_suffix = +dotnet_naming_style.pascal_case.word_separator = +dotnet_naming_style.pascal_case.capitalization = pascal_case + +dotnet_naming_style.begins_with_i.required_prefix = I +dotnet_naming_style.begins_with_i.required_suffix = +dotnet_naming_style.begins_with_i.word_separator = +dotnet_naming_style.begins_with_i.capitalization = pascal_case + +dotnet_naming_style.underscore.required_prefix = _ +dotnet_naming_style.underscore.required_suffix = +dotnet_naming_style.underscore.word_separator = +dotnet_naming_style.underscore.capitalization = camel_case + +dotnet_naming_style.sunderscore.required_prefix = s_ +dotnet_naming_style.sunderscore.required_suffix = +dotnet_naming_style.sunderscore.word_separator = +dotnet_naming_style.sunderscore.capitalization = camel_case + +[*.{cs,vb}] +dotnet_style_coalesce_expression = true:suggestion +dotnet_style_null_propagation = true:suggestion +dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion +dotnet_style_prefer_auto_properties = true:suggestion +dotnet_style_object_initializer = true:suggestion +dotnet_style_collection_initializer = true:suggestion +dotnet_style_prefer_simplified_boolean_expressions = true:suggestion +dotnet_style_prefer_conditional_expression_over_assignment = true:silent +dotnet_style_operator_placement_when_wrapping = beginning_of_line +tab_width = 4 +indent_size = 4 +end_of_line = crlf \ No newline at end of file diff --git a/src/Vegasco.Server.Api/Cars/GetCars.cs b/src/Vegasco.Server.Api/Cars/GetCars.cs index cb4ce6e..0e009db 100644 --- a/src/Vegasco.Server.Api/Cars/GetCars.cs +++ b/src/Vegasco.Server.Api/Cars/GetCars.cs @@ -11,7 +11,7 @@ public static class GetCars { public IEnumerable Cars { get; set; } = []; } - + public record ResponseDto(Guid Id, string Name); public class Request diff --git a/src/Vegasco.Server.Api/Common/DependencyInjectionExtensions.cs b/src/Vegasco.Server.Api/Common/DependencyInjectionExtensions.cs index 7cccca9..44faa51 100644 --- a/src/Vegasco.Server.Api/Common/DependencyInjectionExtensions.cs +++ b/src/Vegasco.Server.Api/Common/DependencyInjectionExtensions.cs @@ -3,9 +3,7 @@ using FluentValidation; using Microsoft.AspNetCore.Authentication.JwtBearer; using Microsoft.Extensions.Options; using System.Diagnostics; -using System.Globalization; using System.Reflection; -using Microsoft.AspNetCore.Localization; using Vegasco.Server.Api.Authentication; using Vegasco.Server.Api.Common; using Vegasco.Server.Api.Persistence; @@ -51,7 +49,7 @@ public static class DependencyInjectionExtensions services.AddHttpContextAccessor(); services.AddHostedService(); - + services.AddRequestLocalization(o => { string[] cultures = @@ -61,7 +59,7 @@ public static class DependencyInjectionExtensions "de-DE", "de" ]; - + o.SetDefaultCulture(cultures[0]) .AddSupportedCultures(cultures) .AddSupportedUICultures(cultures); diff --git a/src/Vegasco.Server.Api/Common/StartupExtensions.cs b/src/Vegasco.Server.Api/Common/StartupExtensions.cs index 4c1d06d..679a213 100644 --- a/src/Vegasco.Server.Api/Common/StartupExtensions.cs +++ b/src/Vegasco.Server.Api/Common/StartupExtensions.cs @@ -1,6 +1,4 @@ -using Microsoft.AspNetCore.Localization; -using System.Globalization; -using Vegasco.Server.Api.Endpoints; +using Vegasco.Server.Api.Endpoints; using Vegasco.Server.ServiceDefaults; namespace Vegasco.Server.Api.Common; diff --git a/src/Vegasco.Server.Api/Consumptions/GetConsumptions.cs b/src/Vegasco.Server.Api/Consumptions/GetConsumptions.cs index 84fcebd..ad5fb76 100644 --- a/src/Vegasco.Server.Api/Consumptions/GetConsumptions.cs +++ b/src/Vegasco.Server.Api/Consumptions/GetConsumptions.cs @@ -7,47 +7,47 @@ namespace Vegasco.Server.Api.Consumptions; public static class GetConsumptions { - public class ApiResponse - { - public IEnumerable Consumptions { get; set; } = []; - } + public class ApiResponse + { + public IEnumerable Consumptions { get; set; } = []; + } - public record ResponseDto( - Guid Id, - DateTimeOffset DateTime, - double Distance, - double Amount, - bool IgnoreInCalculation, - Guid CarId); + public record ResponseDto( + Guid Id, + DateTimeOffset DateTime, + double Distance, + double Amount, + bool IgnoreInCalculation, + Guid CarId); - public class Request - { - [FromQuery(Name = "page")] public int? Page { get; set; } - [FromQuery(Name = "pageSize")] public int? PageSize { get; set; } - } + public class Request + { + [FromQuery(Name = "page")] public int? Page { get; set; } + [FromQuery(Name = "pageSize")] public int? PageSize { get; set; } + } - public static RouteHandlerBuilder MapEndpoint(IEndpointRouteBuilder builder) - { - return builder - .MapGet("consumptions", Endpoint) - .WithDescription("Returns all consumption entries") - .WithTags("Consumptions"); - } + public static RouteHandlerBuilder MapEndpoint(IEndpointRouteBuilder builder) + { + return builder + .MapGet("consumptions", Endpoint) + .WithDescription("Returns all consumption entries") + .WithTags("Consumptions"); + } - private static async Task> Endpoint( - [AsParameters] Request request, - ApplicationDbContext dbContext, - CancellationToken cancellationToken) - { - List consumptions = await dbContext.Consumptions - .Select(x => - new ResponseDto(x.Id.Value, x.DateTime, x.Distance, x.Amount, x.IgnoreInCalculation, x.CarId.Value)) - .ToListAsync(cancellationToken); + private static async Task> Endpoint( + [AsParameters] Request request, + ApplicationDbContext dbContext, + CancellationToken cancellationToken) + { + List consumptions = await dbContext.Consumptions + .Select(x => + new ResponseDto(x.Id.Value, x.DateTime, x.Distance, x.Amount, x.IgnoreInCalculation, x.CarId.Value)) + .ToListAsync(cancellationToken); - var apiResponse = new ApiResponse - { - Consumptions = consumptions - }; - return TypedResults.Ok(apiResponse); - } + var apiResponse = new ApiResponse + { + Consumptions = consumptions + }; + return TypedResults.Ok(apiResponse); + } } \ No newline at end of file diff --git a/src/Vegasco.Server.Api/Endpoints/EndpointExtensions.cs b/src/Vegasco.Server.Api/Endpoints/EndpointExtensions.cs index 1febd76..0b5901d 100644 --- a/src/Vegasco.Server.Api/Endpoints/EndpointExtensions.cs +++ b/src/Vegasco.Server.Api/Endpoints/EndpointExtensions.cs @@ -17,7 +17,7 @@ public static class EndpointExtensions RouteGroupBuilder versionedApis = builder.MapGroup("/v{apiVersion:apiVersion}") .WithApiVersionSet(apiVersionSet); - + GetCar.MapEndpoint(versionedApis) .RequireAuthorization(Constants.Authorization.RequireAuthenticatedUserPolicy); GetCars.MapEndpoint(versionedApis) diff --git a/src/Vegasco.Server.Api/Info/GetServerInfo.cs b/src/Vegasco.Server.Api/Info/GetServerInfo.cs index 2e82096..e188769 100644 --- a/src/Vegasco.Server.Api/Info/GetServerInfo.cs +++ b/src/Vegasco.Server.Api/Info/GetServerInfo.cs @@ -4,26 +4,26 @@ namespace Vegasco.Server.Api.Info; public class GetServerInfo { - public record Response( - string FullVersion, - string CommitId, - DateTimeOffset CommitDate, - string Environment); + public record Response( + string FullVersion, + string CommitId, + DateTimeOffset CommitDate, + string Environment); - public static RouteHandlerBuilder MapEndpoint(IEndpointRouteBuilder builder) - { - return builder - .MapGet("info/server", Endpoint) - .WithTags("Info"); - } + public static RouteHandlerBuilder MapEndpoint(IEndpointRouteBuilder builder) + { + return builder + .MapGet("info/server", Endpoint) + .WithTags("Info"); + } - private static Ok Endpoint( - IHostEnvironment environment) - { - return TypedResults.Ok(new Response( - ThisAssembly.AssemblyInformationalVersion, - ThisAssembly.GitCommitId, - new DateTimeOffset(ThisAssembly.GitCommitDate, TimeSpan.Zero), - environment.EnvironmentName)); - } + private static Ok Endpoint( + IHostEnvironment environment) + { + return TypedResults.Ok(new Response( + ThisAssembly.AssemblyInformationalVersion, + ThisAssembly.GitCommitId, + new DateTimeOffset(ThisAssembly.GitCommitDate, TimeSpan.Zero), + environment.EnvironmentName)); + } } \ No newline at end of file diff --git a/src/Vegasco.Server.Api/Persistence/Migrations/20240818105918_Initial.cs b/src/Vegasco.Server.Api/Persistence/Migrations/20240818105918_Initial.cs index 90e5b37..039e09b 100644 --- a/src/Vegasco.Server.Api/Persistence/Migrations/20240818105918_Initial.cs +++ b/src/Vegasco.Server.Api/Persistence/Migrations/20240818105918_Initial.cs @@ -4,86 +4,86 @@ namespace Vegasco.Server.Api.Persistence.Migrations { - /// - public partial class Initial : Migration - { - /// - protected override void Up(MigrationBuilder migrationBuilder) - { - migrationBuilder.CreateTable( - name: "Users", - columns: table => new - { - Id = table.Column(type: "text", nullable: false) - }, - constraints: table => - { - table.PrimaryKey("PK_Users", x => x.Id); - }); + /// + public partial class Initial : Migration + { + /// + protected override void Up(MigrationBuilder migrationBuilder) + { + migrationBuilder.CreateTable( + name: "Users", + columns: table => new + { + Id = table.Column(type: "text", nullable: false) + }, + constraints: table => + { + table.PrimaryKey("PK_Users", x => x.Id); + }); - migrationBuilder.CreateTable( - name: "Cars", - columns: table => new - { - Id = table.Column(type: "uuid", nullable: false), - Name = table.Column(type: "character varying(50)", maxLength: 50, nullable: false), - UserId = table.Column(type: "text", nullable: false) - }, - constraints: table => - { - table.PrimaryKey("PK_Cars", x => x.Id); - table.ForeignKey( - name: "FK_Cars_Users_UserId", - column: x => x.UserId, - principalTable: "Users", - principalColumn: "Id", - onDelete: ReferentialAction.Cascade); - }); + migrationBuilder.CreateTable( + name: "Cars", + columns: table => new + { + Id = table.Column(type: "uuid", nullable: false), + Name = table.Column(type: "character varying(50)", maxLength: 50, nullable: false), + UserId = table.Column(type: "text", nullable: false) + }, + constraints: table => + { + table.PrimaryKey("PK_Cars", x => x.Id); + table.ForeignKey( + name: "FK_Cars_Users_UserId", + column: x => x.UserId, + principalTable: "Users", + principalColumn: "Id", + onDelete: ReferentialAction.Cascade); + }); - migrationBuilder.CreateTable( - name: "Consumptions", - columns: table => new - { - Id = table.Column(type: "uuid", nullable: false), - DateTime = table.Column(type: "timestamp with time zone", nullable: false), - Distance = table.Column(type: "double precision", nullable: false), - Amount = table.Column(type: "double precision", nullable: false), - IgnoreInCalculation = table.Column(type: "boolean", nullable: false), - CarId = table.Column(type: "uuid", nullable: false) - }, - constraints: table => - { - table.PrimaryKey("PK_Consumptions", x => x.Id); - table.ForeignKey( - name: "FK_Consumptions_Cars_CarId", - column: x => x.CarId, - principalTable: "Cars", - principalColumn: "Id", - onDelete: ReferentialAction.Cascade); - }); + migrationBuilder.CreateTable( + name: "Consumptions", + columns: table => new + { + Id = table.Column(type: "uuid", nullable: false), + DateTime = table.Column(type: "timestamp with time zone", nullable: false), + Distance = table.Column(type: "double precision", nullable: false), + Amount = table.Column(type: "double precision", nullable: false), + IgnoreInCalculation = table.Column(type: "boolean", nullable: false), + CarId = table.Column(type: "uuid", nullable: false) + }, + constraints: table => + { + table.PrimaryKey("PK_Consumptions", x => x.Id); + table.ForeignKey( + name: "FK_Consumptions_Cars_CarId", + column: x => x.CarId, + principalTable: "Cars", + principalColumn: "Id", + onDelete: ReferentialAction.Cascade); + }); - migrationBuilder.CreateIndex( - name: "IX_Cars_UserId", - table: "Cars", - column: "UserId"); + migrationBuilder.CreateIndex( + name: "IX_Cars_UserId", + table: "Cars", + column: "UserId"); - migrationBuilder.CreateIndex( - name: "IX_Consumptions_CarId", - table: "Consumptions", - column: "CarId"); - } + migrationBuilder.CreateIndex( + name: "IX_Consumptions_CarId", + table: "Consumptions", + column: "CarId"); + } - /// - protected override void Down(MigrationBuilder migrationBuilder) - { - migrationBuilder.DropTable( - name: "Consumptions"); + /// + protected override void Down(MigrationBuilder migrationBuilder) + { + migrationBuilder.DropTable( + name: "Consumptions"); - migrationBuilder.DropTable( - name: "Cars"); + migrationBuilder.DropTable( + name: "Cars"); - migrationBuilder.DropTable( - name: "Users"); - } - } + migrationBuilder.DropTable( + name: "Users"); + } + } } diff --git a/src/Vegasco.Server.AppHost/Program.cs b/src/Vegasco.Server.AppHost/Program.cs index 2cdb72d..a4365d9 100644 --- a/src/Vegasco.Server.AppHost/Program.cs +++ b/src/Vegasco.Server.AppHost/Program.cs @@ -16,7 +16,7 @@ builder .AddNpmApp("Vegasco-Web", "../Vegasco-Web") .WithReference(api) .WaitFor(api) - .WithHttpEndpoint(port: 44200, env: "PORT") - .WithExternalHttpEndpoints(); + .WithHttpEndpoint(port: 44200, env: "PORT") + .WithExternalHttpEndpoints(); builder.Build().Run(); diff --git a/src/Vegasco.Server.ServiceDefaults/Extensions.cs b/src/Vegasco.Server.ServiceDefaults/Extensions.cs index 82fd99b..f602d29 100644 --- a/src/Vegasco.Server.ServiceDefaults/Extensions.cs +++ b/src/Vegasco.Server.ServiceDefaults/Extensions.cs @@ -15,105 +15,105 @@ namespace Vegasco.Server.ServiceDefaults; // To learn more about using this project, see https://aka.ms/dotnet/aspire/service-defaults public static class Extensions { - public static TBuilder AddServiceDefaults(this TBuilder builder) where TBuilder : IHostApplicationBuilder - { - builder.ConfigureOpenTelemetry(); + public static TBuilder AddServiceDefaults(this TBuilder builder) where TBuilder : IHostApplicationBuilder + { + builder.ConfigureOpenTelemetry(); - builder.AddDefaultHealthChecks(); + builder.AddDefaultHealthChecks(); - builder.Services.AddServiceDiscovery(); + builder.Services.AddServiceDiscovery(); - builder.Services.ConfigureHttpClientDefaults(http => - { - // Turn on resilience by default - http.AddStandardResilienceHandler(); + builder.Services.ConfigureHttpClientDefaults(http => + { + // Turn on resilience by default + http.AddStandardResilienceHandler(); - // Turn on service discovery by default - http.AddServiceDiscovery(); - }); + // Turn on service discovery by default + http.AddServiceDiscovery(); + }); - // Uncomment the following to restrict the allowed schemes for service discovery. - // builder.Services.Configure(options => - // { - // options.AllowedSchemes = ["https"]; - // }); + // Uncomment the following to restrict the allowed schemes for service discovery. + // builder.Services.Configure(options => + // { + // options.AllowedSchemes = ["https"]; + // }); - return builder; - } + return builder; + } - public static TBuilder ConfigureOpenTelemetry(this TBuilder builder) where TBuilder : IHostApplicationBuilder - { - builder.Logging.AddOpenTelemetry(logging => - { - logging.IncludeFormattedMessage = true; - logging.IncludeScopes = true; - }); + public static TBuilder ConfigureOpenTelemetry(this TBuilder builder) where TBuilder : IHostApplicationBuilder + { + builder.Logging.AddOpenTelemetry(logging => + { + logging.IncludeFormattedMessage = true; + logging.IncludeScopes = true; + }); - builder.Services.AddOpenTelemetry() - .WithMetrics(metrics => - { - metrics.AddAspNetCoreInstrumentation() - .AddHttpClientInstrumentation() - .AddRuntimeInstrumentation(); - }) - .WithTracing(tracing => - { - tracing.AddSource(builder.Environment.ApplicationName) - .AddAspNetCoreInstrumentation() - // Uncomment the following line to enable gRPC instrumentation (requires the OpenTelemetry.Instrumentation.GrpcNetClient package) - //.AddGrpcClientInstrumentation() - .AddHttpClientInstrumentation(); - }); + builder.Services.AddOpenTelemetry() + .WithMetrics(metrics => + { + metrics.AddAspNetCoreInstrumentation() + .AddHttpClientInstrumentation() + .AddRuntimeInstrumentation(); + }) + .WithTracing(tracing => + { + tracing.AddSource(builder.Environment.ApplicationName) + .AddAspNetCoreInstrumentation() + // Uncomment the following line to enable gRPC instrumentation (requires the OpenTelemetry.Instrumentation.GrpcNetClient package) + //.AddGrpcClientInstrumentation() + .AddHttpClientInstrumentation(); + }); - builder.AddOpenTelemetryExporters(); + builder.AddOpenTelemetryExporters(); - return builder; - } + return builder; + } - private static TBuilder AddOpenTelemetryExporters(this TBuilder builder) where TBuilder : IHostApplicationBuilder - { - bool useOtlpExporter = !string.IsNullOrWhiteSpace(builder.Configuration["OTEL_EXPORTER_OTLP_ENDPOINT"]); + private static TBuilder AddOpenTelemetryExporters(this TBuilder builder) where TBuilder : IHostApplicationBuilder + { + bool useOtlpExporter = !string.IsNullOrWhiteSpace(builder.Configuration["OTEL_EXPORTER_OTLP_ENDPOINT"]); - if (useOtlpExporter) - { - builder.Services.AddOpenTelemetry().UseOtlpExporter(); - } + if (useOtlpExporter) + { + builder.Services.AddOpenTelemetry().UseOtlpExporter(); + } - // Uncomment the following lines to enable the Azure Monitor exporter (requires the Azure.Monitor.OpenTelemetry.AspNetCore package) - //if (!string.IsNullOrEmpty(builder.Configuration["APPLICATIONINSIGHTS_CONNECTION_STRING"])) - //{ - // builder.Services.AddOpenTelemetry() - // .UseAzureMonitor(); - //} + // Uncomment the following lines to enable the Azure Monitor exporter (requires the Azure.Monitor.OpenTelemetry.AspNetCore package) + //if (!string.IsNullOrEmpty(builder.Configuration["APPLICATIONINSIGHTS_CONNECTION_STRING"])) + //{ + // builder.Services.AddOpenTelemetry() + // .UseAzureMonitor(); + //} - return builder; - } + return builder; + } - public static TBuilder AddDefaultHealthChecks(this TBuilder builder) where TBuilder : IHostApplicationBuilder - { - builder.Services.AddHealthChecks() - // Add a default liveness check to ensure app is responsive - .AddCheck("self", () => HealthCheckResult.Healthy(), ["live"]); + public static TBuilder AddDefaultHealthChecks(this TBuilder builder) where TBuilder : IHostApplicationBuilder + { + builder.Services.AddHealthChecks() + // Add a default liveness check to ensure app is responsive + .AddCheck("self", () => HealthCheckResult.Healthy(), ["live"]); - return builder; - } + return builder; + } - public static WebApplication MapDefaultEndpoints(this WebApplication app) - { - // Adding health checks endpoints to applications in non-development environments has security implications. - // See https://aka.ms/dotnet/aspire/healthchecks for details before enabling these endpoints in non-development environments. - if (app.Environment.IsDevelopment()) - { - // All health checks must pass for app to be considered ready to accept traffic after starting - app.MapHealthChecks("/health"); + public static WebApplication MapDefaultEndpoints(this WebApplication app) + { + // Adding health checks endpoints to applications in non-development environments has security implications. + // See https://aka.ms/dotnet/aspire/healthchecks for details before enabling these endpoints in non-development environments. + if (app.Environment.IsDevelopment()) + { + // All health checks must pass for app to be considered ready to accept traffic after starting + app.MapHealthChecks("/health"); - // Only health checks tagged with the "live" tag must pass for app to be considered alive - app.MapHealthChecks("/alive", new HealthCheckOptions - { - Predicate = r => r.Tags.Contains("live") - }); - } + // Only health checks tagged with the "live" tag must pass for app to be considered alive + app.MapHealthChecks("/alive", new HealthCheckOptions + { + Predicate = r => r.Tags.Contains("live") + }); + } - return app; - } + return app; + } } diff --git a/tests/Vegasco.Server.Api.Tests.Integration/Info/GetServerInfoTests.cs b/tests/Vegasco.Server.Api.Tests.Integration/Info/GetServerInfoTests.cs index 2732bec..6c2f393 100644 --- a/tests/Vegasco.Server.Api.Tests.Integration/Info/GetServerInfoTests.cs +++ b/tests/Vegasco.Server.Api.Tests.Integration/Info/GetServerInfoTests.cs @@ -1,6 +1,6 @@ -using System.Net.Http.Json; -using FluentAssertions; +using FluentAssertions; using FluentAssertions.Extensions; +using System.Net.Http.Json; using Vegasco.Server.Api.Info; namespace Vegasco.Server.Api.Tests.Integration.Info; @@ -8,28 +8,28 @@ namespace Vegasco.Server.Api.Tests.Integration.Info; [Collection(SharedTestCollection.Name)] public class GetServerInfoTests { - private readonly WebAppFactory _factory; + private readonly WebAppFactory _factory; - public GetServerInfoTests(WebAppFactory factory) - { - _factory = factory; - } + public GetServerInfoTests(WebAppFactory factory) + { + _factory = factory; + } - [Fact] - public async Task GetServerInfo_ShouldReturnServerInfo_WhenCalled() - { - // Arrange - - // Act - using HttpResponseMessage response = await _factory.HttpClient.GetAsync("/v1/info/server"); + [Fact] + public async Task GetServerInfo_ShouldReturnServerInfo_WhenCalled() + { + // Arrange - // Assert - response.IsSuccessStatusCode.Should().BeTrue(); - var serverInfo = await response.Content.ReadFromJsonAsync(); - serverInfo!.Environment.Should().NotBeEmpty(); - serverInfo.CommitDate.Should().BeAfter(23.August(2024)) - .And.NotBeAfter(DateTime.Now); - serverInfo.CommitId.Should().MatchRegex(@"[0-9a-f]{40}"); - serverInfo.FullVersion.Should().MatchRegex(@"\d\.\d\.\d(-[0-9a-zA-Z]+)?(\+g?[0-9a-f]{10})?"); - } + // Act + using HttpResponseMessage response = await _factory.HttpClient.GetAsync("/v1/info/server"); + + // Assert + response.IsSuccessStatusCode.Should().BeTrue(); + var serverInfo = await response.Content.ReadFromJsonAsync(); + serverInfo!.Environment.Should().NotBeEmpty(); + serverInfo.CommitDate.Should().BeAfter(23.August(2024)) + .And.NotBeAfter(DateTime.Now); + serverInfo.CommitId.Should().MatchRegex(@"[0-9a-f]{40}"); + serverInfo.FullVersion.Should().MatchRegex(@"\d\.\d\.\d(-[0-9a-zA-Z]+)?(\+g?[0-9a-f]{10})?"); + } } \ No newline at end of file