diff --git a/Client.Wasm/Components/StudentCard.razor b/Client.Wasm/Components/StudentCard.razor index 661f1181..2c0c813c 100644 --- a/Client.Wasm/Components/StudentCard.razor +++ b/Client.Wasm/Components/StudentCard.razor @@ -4,10 +4,10 @@ - Номер №X "Название лабораторной" - Вариант №Х "Название варианта" - Выполнена Фамилией Именем 65ХХ - Ссылка на форк + Номер №1 "Кэширование" + Вариант №17 "Транспортное средство" + Выполнена Чукарев Михаил 6511 + Ссылка на форк diff --git a/Client.Wasm/Properties/launchSettings.json b/Client.Wasm/Properties/launchSettings.json index 0d824ea7..8141fbab 100644 --- a/Client.Wasm/Properties/launchSettings.json +++ b/Client.Wasm/Properties/launchSettings.json @@ -38,4 +38,4 @@ } } } -} +} \ No newline at end of file diff --git a/Client.Wasm/wwwroot/appsettings.json b/Client.Wasm/wwwroot/appsettings.json index d1fe7ab3..87e4c8ee 100644 --- a/Client.Wasm/wwwroot/appsettings.json +++ b/Client.Wasm/wwwroot/appsettings.json @@ -6,5 +6,6 @@ } }, "AllowedHosts": "*", - "BaseAddress": "" + "BaseAddress": "https://localhost:5001/api/vehicles" } + diff --git a/CloudDevelopment.sln b/CloudDevelopment.sln index cb48241d..f1238eee 100644 --- a/CloudDevelopment.sln +++ b/CloudDevelopment.sln @@ -5,20 +5,98 @@ VisualStudioVersion = 17.14.36811.4 MinimumVisualStudioVersion = 10.0.40219.1 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Client.Wasm", "Client.Wasm\Client.Wasm.csproj", "{AE7EEA74-2FE0-136F-D797-854FD87E022A}" EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{827E0CD3-B72D-47B6-A68D-7590B98EB39B}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ServiceDefaults", "src\ServiceDefaults\ServiceDefaults.csproj", "{207C1A03-203E-4804-854F-0B70D3B0226F}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "VehicleApi", "src\VehicleApi\VehicleApi.csproj", "{8C4738CB-0C2F-4664-9F35-62F27C0E5877}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "tests", "tests", "{0AB3BF05-4346-4AA6-1389-037BE0695223}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "VehicleApi.Tests", "tests\VehicleApi.Tests\VehicleApi.Tests.csproj", "{E6CB2EEC-E2A0-449F-89DE-11AE5579B37B}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AppHost", "src\AppHost\AppHost.csproj", "{BD8774D8-8997-4902-B545-B6EEB3304A63}" +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU + Debug|x64 = Debug|x64 + Debug|x86 = Debug|x86 Release|Any CPU = Release|Any CPU + Release|x64 = Release|x64 + Release|x86 = Release|x86 EndGlobalSection GlobalSection(ProjectConfigurationPlatforms) = postSolution {AE7EEA74-2FE0-136F-D797-854FD87E022A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {AE7EEA74-2FE0-136F-D797-854FD87E022A}.Debug|Any CPU.Build.0 = Debug|Any CPU + {AE7EEA74-2FE0-136F-D797-854FD87E022A}.Debug|x64.ActiveCfg = Debug|Any CPU + {AE7EEA74-2FE0-136F-D797-854FD87E022A}.Debug|x64.Build.0 = Debug|Any CPU + {AE7EEA74-2FE0-136F-D797-854FD87E022A}.Debug|x86.ActiveCfg = Debug|Any CPU + {AE7EEA74-2FE0-136F-D797-854FD87E022A}.Debug|x86.Build.0 = Debug|Any CPU {AE7EEA74-2FE0-136F-D797-854FD87E022A}.Release|Any CPU.ActiveCfg = Release|Any CPU {AE7EEA74-2FE0-136F-D797-854FD87E022A}.Release|Any CPU.Build.0 = Release|Any CPU + {AE7EEA74-2FE0-136F-D797-854FD87E022A}.Release|x64.ActiveCfg = Release|Any CPU + {AE7EEA74-2FE0-136F-D797-854FD87E022A}.Release|x64.Build.0 = Release|Any CPU + {AE7EEA74-2FE0-136F-D797-854FD87E022A}.Release|x86.ActiveCfg = Release|Any CPU + {AE7EEA74-2FE0-136F-D797-854FD87E022A}.Release|x86.Build.0 = Release|Any CPU + {207C1A03-203E-4804-854F-0B70D3B0226F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {207C1A03-203E-4804-854F-0B70D3B0226F}.Debug|Any CPU.Build.0 = Debug|Any CPU + {207C1A03-203E-4804-854F-0B70D3B0226F}.Debug|x64.ActiveCfg = Debug|Any CPU + {207C1A03-203E-4804-854F-0B70D3B0226F}.Debug|x64.Build.0 = Debug|Any CPU + {207C1A03-203E-4804-854F-0B70D3B0226F}.Debug|x86.ActiveCfg = Debug|Any CPU + {207C1A03-203E-4804-854F-0B70D3B0226F}.Debug|x86.Build.0 = Debug|Any CPU + {207C1A03-203E-4804-854F-0B70D3B0226F}.Release|Any CPU.ActiveCfg = Release|Any CPU + {207C1A03-203E-4804-854F-0B70D3B0226F}.Release|Any CPU.Build.0 = Release|Any CPU + {207C1A03-203E-4804-854F-0B70D3B0226F}.Release|x64.ActiveCfg = Release|Any CPU + {207C1A03-203E-4804-854F-0B70D3B0226F}.Release|x64.Build.0 = Release|Any CPU + {207C1A03-203E-4804-854F-0B70D3B0226F}.Release|x86.ActiveCfg = Release|Any CPU + {207C1A03-203E-4804-854F-0B70D3B0226F}.Release|x86.Build.0 = Release|Any CPU + {8C4738CB-0C2F-4664-9F35-62F27C0E5877}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {8C4738CB-0C2F-4664-9F35-62F27C0E5877}.Debug|Any CPU.Build.0 = Debug|Any CPU + {8C4738CB-0C2F-4664-9F35-62F27C0E5877}.Debug|x64.ActiveCfg = Debug|Any CPU + {8C4738CB-0C2F-4664-9F35-62F27C0E5877}.Debug|x64.Build.0 = Debug|Any CPU + {8C4738CB-0C2F-4664-9F35-62F27C0E5877}.Debug|x86.ActiveCfg = Debug|Any CPU + {8C4738CB-0C2F-4664-9F35-62F27C0E5877}.Debug|x86.Build.0 = Debug|Any CPU + {8C4738CB-0C2F-4664-9F35-62F27C0E5877}.Release|Any CPU.ActiveCfg = Release|Any CPU + {8C4738CB-0C2F-4664-9F35-62F27C0E5877}.Release|Any CPU.Build.0 = Release|Any CPU + {8C4738CB-0C2F-4664-9F35-62F27C0E5877}.Release|x64.ActiveCfg = Release|Any CPU + {8C4738CB-0C2F-4664-9F35-62F27C0E5877}.Release|x64.Build.0 = Release|Any CPU + {8C4738CB-0C2F-4664-9F35-62F27C0E5877}.Release|x86.ActiveCfg = Release|Any CPU + {8C4738CB-0C2F-4664-9F35-62F27C0E5877}.Release|x86.Build.0 = Release|Any CPU + {E6CB2EEC-E2A0-449F-89DE-11AE5579B37B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {E6CB2EEC-E2A0-449F-89DE-11AE5579B37B}.Debug|Any CPU.Build.0 = Debug|Any CPU + {E6CB2EEC-E2A0-449F-89DE-11AE5579B37B}.Debug|x64.ActiveCfg = Debug|Any CPU + {E6CB2EEC-E2A0-449F-89DE-11AE5579B37B}.Debug|x64.Build.0 = Debug|Any CPU + {E6CB2EEC-E2A0-449F-89DE-11AE5579B37B}.Debug|x86.ActiveCfg = Debug|Any CPU + {E6CB2EEC-E2A0-449F-89DE-11AE5579B37B}.Debug|x86.Build.0 = Debug|Any CPU + {E6CB2EEC-E2A0-449F-89DE-11AE5579B37B}.Release|Any CPU.ActiveCfg = Release|Any CPU + {E6CB2EEC-E2A0-449F-89DE-11AE5579B37B}.Release|Any CPU.Build.0 = Release|Any CPU + {E6CB2EEC-E2A0-449F-89DE-11AE5579B37B}.Release|x64.ActiveCfg = Release|Any CPU + {E6CB2EEC-E2A0-449F-89DE-11AE5579B37B}.Release|x64.Build.0 = Release|Any CPU + {E6CB2EEC-E2A0-449F-89DE-11AE5579B37B}.Release|x86.ActiveCfg = Release|Any CPU + {E6CB2EEC-E2A0-449F-89DE-11AE5579B37B}.Release|x86.Build.0 = Release|Any CPU + {BD8774D8-8997-4902-B545-B6EEB3304A63}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {BD8774D8-8997-4902-B545-B6EEB3304A63}.Debug|Any CPU.Build.0 = Debug|Any CPU + {BD8774D8-8997-4902-B545-B6EEB3304A63}.Debug|x64.ActiveCfg = Debug|Any CPU + {BD8774D8-8997-4902-B545-B6EEB3304A63}.Debug|x64.Build.0 = Debug|Any CPU + {BD8774D8-8997-4902-B545-B6EEB3304A63}.Debug|x86.ActiveCfg = Debug|Any CPU + {BD8774D8-8997-4902-B545-B6EEB3304A63}.Debug|x86.Build.0 = Debug|Any CPU + {BD8774D8-8997-4902-B545-B6EEB3304A63}.Release|Any CPU.ActiveCfg = Release|Any CPU + {BD8774D8-8997-4902-B545-B6EEB3304A63}.Release|Any CPU.Build.0 = Release|Any CPU + {BD8774D8-8997-4902-B545-B6EEB3304A63}.Release|x64.ActiveCfg = Release|Any CPU + {BD8774D8-8997-4902-B545-B6EEB3304A63}.Release|x64.Build.0 = Release|Any CPU + {BD8774D8-8997-4902-B545-B6EEB3304A63}.Release|x86.ActiveCfg = Release|Any CPU + {BD8774D8-8997-4902-B545-B6EEB3304A63}.Release|x86.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE EndGlobalSection + GlobalSection(NestedProjects) = preSolution + {207C1A03-203E-4804-854F-0B70D3B0226F} = {827E0CD3-B72D-47B6-A68D-7590B98EB39B} + {8C4738CB-0C2F-4664-9F35-62F27C0E5877} = {827E0CD3-B72D-47B6-A68D-7590B98EB39B} + {E6CB2EEC-E2A0-449F-89DE-11AE5579B37B} = {0AB3BF05-4346-4AA6-1389-037BE0695223} + {BD8774D8-8997-4902-B545-B6EEB3304A63} = {827E0CD3-B72D-47B6-A68D-7590B98EB39B} + EndGlobalSection GlobalSection(ExtensibilityGlobals) = postSolution SolutionGuid = {90FE6B04-8381-437E-893A-FEBA1DA10AEE} EndGlobalSection diff --git a/README.md b/README.md index dcaa5eb7..d4cd8209 100644 --- a/README.md +++ b/README.md @@ -1,128 +1,85 @@ # Современные технологии разработки программного обеспечения -[Таблица с успеваемостью](https://docs.google.com/spreadsheets/d/1an43o-iqlq4V_kDtkr_y7DC221hY9qdhGPrpII27sH8/edit?usp=sharing) -## Задание -### Цель -Реализация проекта микросервисного бекенда. -### Задачи -* Реализация межсервисной коммуникации, -* Изучение работы с брокерами сообщений, -* Изучение архитектурных паттернов, -* Изучение работы со средствами оркестрации на примере .NET Aspire, -* Повторение основ работы с системами контроля версий, -* Интеграционное тестирование. +## Лабораторная работа №1 — «Кэширование» + +**Вариант №17 — «Транспортное средство»** +**Выполнил:** Чукарев Михаил, группа 6511 + +### Описание + +Реализован сервис генерации данных о транспортных средствах с кэшированием ответов в Redis и оркестрацией через .NET Aspire. + +### Что реализовано -### Лабораторные работы -
-1. «Кэширование» - Реализация сервиса генерации контрактов, кэширование его ответов -
- -В рамках первой лабораторной работы необходимо: -* Реализовать сервис генерации контрактов на основе Bogus, -* Реализовать кеширование при помощи IDistributedCache и Redis, -* Реализовать структурное логирование сервиса генерации, -* Настроить оркестрацию Aspire. - -
-
-2. «Балансировка нагрузки» - Реализация апи гейтвея, настройка его работы -
- -В рамках второй лабораторной работы необходимо: -* Настроить оркестрацию на запуск нескольких реплик сервиса генерации, -* Реализовать апи гейтвей на основе Ocelot, -* Имплементировать алгоритм балансировки нагрузки согласно варианту. - -
-
-3. «Интеграционное тестирование» - Реализация файлового сервиса и объектного хранилища, интеграционное тестирование бекенда -
+Генерация данных (Bogus) +
-В рамках третьей лабораторной работы необходимо: -* Добавить в оркестрацию объектное хранилище, -* Реализовать файловый сервис, сериализующий сгенерированные данные в файлы и сохраняющий их в объектном хранилище, -* Реализовать отправку генерируемых данных в файловый сервис посредством брокера, -* Реализовать интеграционные тесты, проверяющие корректность работы всех сервисов бекенда вместе. +- Класс `VehicleGenerator` с `RuleFor` для каждого поля +- Поля: VIN, производитель, модель, год выпуска, тип кузова, тип топлива, цвет, пробег, дата последнего ТО -
+
+
-4. (Опционально) «Переход на облачную инфраструктуру» - Перенос бекенда в Yandex Cloud -
- -В рамках четвертой лабораторной работы необходимо перенестиервисы на облако все ранее разработанные сервисы: -* Клиент - в хостинг через отдельный бакет Object Storage, -* Сервис генерации - в Cloud Function, -* Апи гейтвей - в Serverless Integration как API Gateway, -* Брокер сообщений - в Message Queue, -* Файловый сервис - в Cloud Function, -* Объектное хранилище - в отдельный бакет Object Storage, - -
+Кэширование (Redis + IDistributedCache) +
+ +- Сервис `VehicleService` инкапсулирует логику работы с кэшем + +
-## Задание. Общая часть -**Обязательно**: -* Реализация серверной части на [.NET 8](https://learn.microsoft.com/ru-ru/dotnet/core/whats-new/dotnet-8/overview). -* Оркестрация проектов при помощи [.NET Aspire](https://learn.microsoft.com/ru-ru/dotnet/aspire/get-started/aspire-overview). -* Реализация сервиса генерации данных при помощи [Bogus](https://github.com/bchavez/Bogus). -* Реализация тестов с использованием [xUnit](https://xunit.net/?tabs=cs). -* Создание минимальной документации к проекту: страница на GitHub с информацией о задании, скриншоты приложения и прочая информация. +
+Структурное логирование +
-**Факультативно**: -* Перенос бекенда на облачную инфраструктуру Yandex Cloud +- Логирование через `ILogger` -Внимательно прочитайте [дискуссии](https://github.com/itsecd/cloud-development/discussions/1) о том, как работает автоматическое распределение на ревью. -Сразу корректно называйте свои pr, чтобы они попали на ревью нужному преподавателю. +
+
-По итогу работы в семестре должна получиться следующая информационная система:
-C4 диаграмма -Современные_технологии_разработки_ПО_drawio -
+CORS +
-## Варианты заданий -Номер варианта задания присваивается в начале семестра. Изменить его нельзя. Каждый вариант имеет уникальную комбинацию из предметной области, базы данных и технологии для общения сервиса генерации данных и сервера апи. +- Доверенные origins вынесены в `appsettings.json` (`Cors:AllowedOrigins`) +- `AllowAnyMethod`, `AllowAnyHeader` -[Список вариантов](https://docs.google.com/document/d/1WGmLYwffTTaAj4TgFCk5bUyW3XKbFMiBm-DHZrfFWr4/edit?usp=sharing) -[Список предметных областей и алгоритмов балансировки](https://docs.google.com/document/d/1PLn2lKe4swIdJDZhwBYzxqFSu0AbY2MFY1SUPkIKOM4/edit?usp=sharing) +
+ -## Схема сдачи +
+Оркестрация (.NET Aspire) +
-На каждую из лабораторных работ необходимо сделать отдельный [Pull Request (PR)](https://docs.github.com/en/pull-requests). +- Redis +- API сервис +- Клиент WASM -Общая схема: -1. Сделать форк данного репозитория -2. Выполнить задание -3. Сделать PR в данный репозиторий -4. Исправить замечания после code review -5. Получить approve +
+
-## Критерии оценивания +
+API +
-Конкурентный принцип. -Так как задания в первой лабораторной будут повторяться между студентами, то выделяются следующие показатели для оценки: -1. Скорость разработки -2. Качество разработки -3. Полнота выполнения задания +- Единственный эндпоинт: `GET /api/vehicles?id={id}` -Быстрее делаете PR - у вас преимущество. -Быстрее получаете Approve - у вас преимущество. -Выполните нечто немного выходящее за рамки проекта - у вас преимущество. -Не укладываетесь в дедлайн - получаете минимально возможный балл. +
+
-### Шкала оценивания +
+Тесты (xUnit) +
-- **3 балла** за качество кода, из них: - - 2 балла - базовая оценка - - 1 балл (но не более) можно получить за выполнение любого из следующих пунктов: - - Реализация факультативного функционала - - Выполнение работы раньше других: первые 5 человек из каждой группы, которые сделали PR и получили approve, получают дополнительный балл - -## Вопросы и обратная связь по курсу +- `Generate_SameId_ReturnsSameData` — детерминированность генерации +- `Generate_DifferentIds_ReturnsDifferentData` — уникальность по `id` +- `Generate_YearConstraint_IsValid` — год в диапазоне [1990, текущий] +- `Generate_MileageConstraint_IsValid` — пробег в диапазоне [0, 500 000] +- `Generate_LastServiceDateConstraint_IsValid` — дата ТО не раньше года выпуска и не в будущем -Чтобы задать вопрос по лабораторной, воспользуйтесь [соответствующим разделом дискуссий](https://github.com/itsecd/cloud-development/discussions/categories/questions) или заведите [ишью](https://github.com/itsecd/cloud-development/issues/new). -Если у вас появились идеи/пожелания/прочие полезные мысли по преподаваемой дисциплине, их можно оставить [здесь](https://github.com/itsecd/cloud-development/discussions/categories/ideas). +
+
diff --git a/src/AppHost/AppHost.csproj b/src/AppHost/AppHost.csproj new file mode 100644 index 00000000..32cb9e10 --- /dev/null +++ b/src/AppHost/AppHost.csproj @@ -0,0 +1,21 @@ + + + + Exe + net8.0 + enable + enable + true + + + + + + + + + + + + + \ No newline at end of file diff --git a/src/AppHost/Program.cs b/src/AppHost/Program.cs new file mode 100644 index 00000000..1bf22dcd --- /dev/null +++ b/src/AppHost/Program.cs @@ -0,0 +1,14 @@ +var builder = DistributedApplication.CreateBuilder(args); + +var cache = builder.AddRedis("cache") + .WithRedisInsight(); + +var api = builder.AddProject("vehicleapi") + .WithReference(cache) + .WaitFor(cache); + +var client = builder.AddProject("client") + .WithReference(api) + .WaitFor(api); + +builder.Build().Run(); diff --git a/src/AppHost/Properties/launchSettings.json b/src/AppHost/Properties/launchSettings.json new file mode 100644 index 00000000..a37f7f18 --- /dev/null +++ b/src/AppHost/Properties/launchSettings.json @@ -0,0 +1,17 @@ +{ + "$schema": "https://json.schemastore.org/launchsettings.json", + "profiles": { + "https": { + "commandName": "Project", + "dotnetRunMessages": true, + "launchBrowser": true, + "applicationUrl": "https://localhost:17057;http://localhost:15057", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development", + "DOTNET_ENVIRONMENT": "Development", + "DOTNET_DASHBOARD_OTLP_ENDPOINT_URL": "https://localhost:21057", + "DOTNET_RESOURCE_SERVICE_ENDPOINT_URL": "https://localhost:22057" + } + } + } +} diff --git a/src/ServiceDefaults/Extensions.cs b/src/ServiceDefaults/Extensions.cs new file mode 100644 index 00000000..62670bc2 --- /dev/null +++ b/src/ServiceDefaults/Extensions.cs @@ -0,0 +1,79 @@ +using Microsoft.AspNetCore.Builder; +using Microsoft.AspNetCore.Diagnostics.HealthChecks; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Diagnostics.HealthChecks; +using Microsoft.Extensions.Logging; +using OpenTelemetry; +using OpenTelemetry.Metrics; +using OpenTelemetry.Trace; + +namespace Microsoft.Extensions.Hosting; + +public static class Extensions +{ + private const string HealthEndpointPath = "/health"; + private const string AlivenessEndpointPath = "/alive"; + + public static TBuilder AddServiceDefaults(this TBuilder builder) where TBuilder : IHostApplicationBuilder + { + builder.ConfigureOpenTelemetry(); + builder.AddDefaultHealthChecks(); + builder.Services.AddServiceDiscovery(); + + return builder; + } + + 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() + .AddHttpClientInstrumentation()); + + builder.AddOpenTelemetryExporters(); + + return builder; + } + + private static TBuilder AddOpenTelemetryExporters(this TBuilder builder) where TBuilder : IHostApplicationBuilder + { + var useOtlpExporter = !string.IsNullOrWhiteSpace(builder.Configuration["OTEL_EXPORTER_OTLP_ENDPOINT"]); + + if (useOtlpExporter) + { + builder.Services.AddOpenTelemetry().UseOtlpExporter(); + } + + return builder; + } + + public static TBuilder AddDefaultHealthChecks(this TBuilder builder) where TBuilder : IHostApplicationBuilder + { + builder.Services.AddHealthChecks() + .AddCheck("self", () => HealthCheckResult.Healthy(), ["live"]); + + return builder; + } + + public static WebApplication MapDefaultEndpoints(this WebApplication app) + { + app.MapHealthChecks(HealthEndpointPath); + app.MapHealthChecks(AlivenessEndpointPath, new HealthCheckOptions + { + Predicate = r => r.Tags.Contains("live") + }); + + return app; + } +} diff --git a/src/ServiceDefaults/ServiceDefaults.csproj b/src/ServiceDefaults/ServiceDefaults.csproj new file mode 100644 index 00000000..66030857 --- /dev/null +++ b/src/ServiceDefaults/ServiceDefaults.csproj @@ -0,0 +1,20 @@ + + + + net8.0 + enable + enable + + + + + + + + + + + + + + \ No newline at end of file diff --git a/src/VehicleApi/Models/Vehicle.cs b/src/VehicleApi/Models/Vehicle.cs new file mode 100644 index 00000000..5b9602c7 --- /dev/null +++ b/src/VehicleApi/Models/Vehicle.cs @@ -0,0 +1,37 @@ +namespace VehicleApi.Models; + +/// +/// Представляет сущность транспортного средства. +/// +public record Vehicle +{ + /// Уникальный идентификатор транспортного средства. + public int Id { get; init; } + + /// Идентификационный номер транспортного средства (VIN). + public required string Vin { get; init; } + + /// Производитель транспортного средства. + public required string Manufacturer { get; init; } + + /// Модель транспортного средства. + public required string Model { get; init; } + + /// Год выпуска транспортного средства. + public int Year { get; init; } + + /// Тип кузова транспортного средства. + public required string BodyType { get; init; } + + /// Тип топлива транспортного средства. + public required string FuelType { get; init; } + + /// Цвет транспортного средства. + public required string Color { get; init; } + + /// Пробег транспортного средства. + public double Mileage { get; init; } + + /// Дата последнего технического обслуживания. + public DateOnly LastServiceDate { get; init; } +} \ No newline at end of file diff --git a/src/VehicleApi/Program.cs b/src/VehicleApi/Program.cs new file mode 100644 index 00000000..d372b002 --- /dev/null +++ b/src/VehicleApi/Program.cs @@ -0,0 +1,44 @@ +using VehicleApi.Services; +using Microsoft.AspNetCore.Mvc; + +var builder = WebApplication.CreateBuilder(args); + +builder.AddServiceDefaults(); + +builder.Services.AddScoped(); + +builder.AddRedisDistributedCache("cache"); + +builder.Services.AddCors(options => +{ + options.AddDefaultPolicy(policy => + { + var allowedOrigins = builder.Configuration + .GetSection("Cors:AllowedOrigins") + .Get() ?? []; + + policy.WithOrigins(allowedOrigins) + .AllowAnyMethod() + .AllowAnyHeader(); + }); +}); + +var app = builder.Build(); + +app.UseCors(); + +app.MapDefaultEndpoints(); + +app.MapGet("/api/vehicles", async (int id, [FromServices] VehicleService vehicleService, ILogger logger) => +{ + if (id <= 0) + { + logger.LogWarning("Invalid vehicle ID {Id} requested", id); + return Results.BadRequest("ID must be greater than 0"); + } + + var vehicle = await vehicleService.GetByIdAsync(id); + return Results.Ok(vehicle); +}); + +app.Run(); diff --git a/src/VehicleApi/Properties/launchSettings.json b/src/VehicleApi/Properties/launchSettings.json new file mode 100644 index 00000000..900ff92f --- /dev/null +++ b/src/VehicleApi/Properties/launchSettings.json @@ -0,0 +1,23 @@ +{ + "$schema": "https://json.schemastore.org/launchsettings.json", + "profiles": { + "http": { + "commandName": "Project", + "dotnetRunMessages": true, + "launchBrowser": true, + "applicationUrl": "http://localhost:5000", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development" + } + }, + "https": { + "commandName": "Project", + "dotnetRunMessages": true, + "launchBrowser": true, + "applicationUrl": "https://localhost:5001;http://localhost:5000", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development" + } + } + } +} diff --git a/src/VehicleApi/Services/VehicleGenerator.cs b/src/VehicleApi/Services/VehicleGenerator.cs new file mode 100644 index 00000000..2f7145fb --- /dev/null +++ b/src/VehicleApi/Services/VehicleGenerator.cs @@ -0,0 +1,26 @@ +using Bogus; +using VehicleApi.Models; + +namespace VehicleApi.Services; + +public static class VehicleGenerator +{ + private static readonly Faker _faker = new Faker() + .RuleFor(v => v.Id, f => f.IndexFaker) + .RuleFor(v => v.Vin, f => f.Vehicle.Vin()) + .RuleFor(v => v.Manufacturer, f => f.Vehicle.Manufacturer()) + .RuleFor(v => v.Model, f => f.Vehicle.Model()) + .RuleFor(v => v.Year, f => f.Random.Int(1990, DateTime.Now.Year)) + .RuleFor(v => v.BodyType, f => f.Vehicle.Type()) + .RuleFor(v => v.FuelType, f => f.Vehicle.Fuel()) + .RuleFor(v => v.Color, f => f.Commerce.Color()) + .RuleFor(v => v.Mileage, f => f.Random.Double(0, 500000)) + .RuleFor(v => v.LastServiceDate, (f, v) => + DateOnly.FromDateTime(f.Date.Between(new DateTime(v.Year, 1, 1), DateTime.Now))); + + public static Vehicle Generate(int id) + { + _faker.UseSeed(id); + return _faker.Generate(); + } +} \ No newline at end of file diff --git a/src/VehicleApi/Services/VehicleService.cs b/src/VehicleApi/Services/VehicleService.cs new file mode 100644 index 00000000..399d2c57 --- /dev/null +++ b/src/VehicleApi/Services/VehicleService.cs @@ -0,0 +1,40 @@ +using System.Text.Json; +using Microsoft.Extensions.Caching.Distributed; +using VehicleApi.Models; + +namespace VehicleApi.Services; + +public class VehicleService(IDistributedCache cache, ILogger logger, IConfiguration config) +{ + private DistributedCacheEntryOptions GetCacheOptions() + { + var minutes = config.GetValue("Cache:AbsoluteExpirationMinutes", 10); + return new DistributedCacheEntryOptions + { + AbsoluteExpirationRelativeToNow = TimeSpan.FromMinutes(minutes) + }; + } + + public async Task GetByIdAsync(int id) + { + var cacheKey = $"vehicle:{id}"; + var cachedData = await cache.GetAsync(cacheKey); + + if (cachedData != null) + { + logger.LogInformation("Cache hit for vehicle ID {Id}", id); + var cached = JsonSerializer.Deserialize(cachedData); + if (cached != null) + return cached; + } + + logger.LogInformation("Cache miss for vehicle ID {Id}", id); + var vehicle = VehicleGenerator.Generate(id); + + var serialized = JsonSerializer.SerializeToUtf8Bytes(vehicle); + await cache.SetAsync(cacheKey, serialized, GetCacheOptions()); + logger.LogInformation("Vehicle {Id} cached", id); + + return vehicle; + } +} \ No newline at end of file diff --git a/src/VehicleApi/VehicleApi.csproj b/src/VehicleApi/VehicleApi.csproj new file mode 100644 index 00000000..b1afe2f4 --- /dev/null +++ b/src/VehicleApi/VehicleApi.csproj @@ -0,0 +1,18 @@ + + + + net8.0 + enable + enable + + + + + + + + + + + + \ No newline at end of file diff --git a/src/VehicleApi/appsettings.json b/src/VehicleApi/appsettings.json new file mode 100644 index 00000000..0fa53018 --- /dev/null +++ b/src/VehicleApi/appsettings.json @@ -0,0 +1,12 @@ +{ + "Cors": { + "AllowedOrigins": [ + "https://localhost:7282", + "http://localhost:5127" + ] + }, + "Cache": { + "AbsoluteExpirationMinutes": 10 + }, + "AllowedHosts": "*" +} \ No newline at end of file diff --git a/tests/VehicleApi.Tests/VehicleApi.Tests.csproj b/tests/VehicleApi.Tests/VehicleApi.Tests.csproj new file mode 100644 index 00000000..43d11c14 --- /dev/null +++ b/tests/VehicleApi.Tests/VehicleApi.Tests.csproj @@ -0,0 +1,24 @@ + + + + net8.0 + enable + enable + false + true + + + + + + + runtime; build; native; contentfiles; analyzers; buildtransitive + all + + + + + + + + diff --git a/tests/VehicleApi.Tests/VehicleGeneratorTests.cs b/tests/VehicleApi.Tests/VehicleGeneratorTests.cs new file mode 100644 index 00000000..b7d0257f --- /dev/null +++ b/tests/VehicleApi.Tests/VehicleGeneratorTests.cs @@ -0,0 +1,73 @@ +using VehicleApi.Services; +using Xunit; + +namespace VehicleApi.Tests; + +public class VehicleGeneratorTests +{ + [Fact] + public void Generate_SameId_ReturnsSameData() + { + var vehicle1 = VehicleGenerator.Generate(42); + var vehicle2 = VehicleGenerator.Generate(42); + + Assert.Equal(vehicle1.Vin, vehicle2.Vin); + Assert.Equal(vehicle1.Manufacturer, vehicle2.Manufacturer); + Assert.Equal(vehicle1.Model, vehicle2.Model); + Assert.Equal(vehicle1.Year, vehicle2.Year); + Assert.Equal(vehicle1.BodyType, vehicle2.BodyType); + Assert.Equal(vehicle1.FuelType, vehicle2.FuelType); + Assert.Equal(vehicle1.Color, vehicle2.Color); + Assert.Equal(vehicle1.Mileage, vehicle2.Mileage); + } + + [Theory] + [InlineData(1, 2)] + [InlineData(10, 20)] + [InlineData(42, 100)] + public void Generate_DifferentIds_ReturnsDifferentData(int id1, int id2) + { + var vehicle1 = VehicleGenerator.Generate(id1); + var vehicle2 = VehicleGenerator.Generate(id2); + + Assert.NotEqual(vehicle1.Vin, vehicle2.Vin); + } + + [Fact] + public void Generate_YearConstraint_IsValid() + { + for (var i = 1; i <= 100; i++) + { + var vehicle = VehicleGenerator.Generate(i); + + Assert.True(vehicle.Year >= 1990, $"Vehicle {i} has Year {vehicle.Year} which is less than 1990"); + Assert.True(vehicle.Year <= DateTime.Now.Year, $"Vehicle {i} has Year {vehicle.Year} which exceeds current year {DateTime.Now.Year}"); + } + } + + [Fact] + public void Generate_MileageConstraint_IsValid() + { + for (var i = 1; i <= 100; i++) + { + var vehicle = VehicleGenerator.Generate(i); + + Assert.True(vehicle.Mileage >= 0, $"Vehicle {i} has Mileage {vehicle.Mileage} which is less than 0"); + Assert.True(vehicle.Mileage <= 500000, $"Vehicle {i} has Mileage {vehicle.Mileage} which exceeds 500,000"); + } + } + + [Fact] + public void Generate_LastServiceDateConstraint_IsValid() + { + for (var i = 1; i <= 100; i++) + { + var vehicle = VehicleGenerator.Generate(i); + + Assert.True(vehicle.LastServiceDate.Year >= vehicle.Year, + $"Vehicle {i} has LastServiceDate year {vehicle.LastServiceDate.Year} which is before the vehicle's manufacturing year {vehicle.Year}"); + Assert.True(vehicle.LastServiceDate <= DateOnly.FromDateTime(DateTime.Now), + $"Vehicle {i} has LastServiceDate {vehicle.LastServiceDate} which is in the future"); + } + } +}