Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions GenerationService/Models/Course.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
namespace GenerationService.Models;

/// <summary>
/// Модель, описывающая учебный курс и его основные метаданные
/// </summary>
public class Course
{
/// <summary>
/// Уникальный идентификатор курса
/// </summary>
public int Id { get; init; }

/// <summary>
/// Название курса
/// </summary>
public string Name { get; init; } = string.Empty;

/// <summary>
/// Полное имя преподавателя курса
/// </summary>
public string TeacherFullName { get; init; } = string.Empty;

/// <summary>
/// Дата начала курса
/// </summary>
public DateOnly StartDate { get; init; }

/// <summary>
/// Дата окончания курса
/// </summary>
public DateOnly EndDate { get; init; }

/// <summary>
/// Максимально допустимое количество студентов, которые могут быть зачислены на курс
/// </summary>
public int MaxStudents { get; init; }

/// <summary>
/// Текущее количество записанных студентов
/// </summary>
public int CurrentStudents { get; init; }

/// <summary>
/// Выдаётся ли по окончании курса сертификат
/// </summary>
public bool HasCertificate { get; init; }

/// <summary>
/// Стоимость курса
/// </summary>
public decimal Cost { get; init; }

/// <summary>
/// Рейтинг курса
/// </summary>
public int Rating { get; init; }
}
58 changes: 58 additions & 0 deletions GenerationService/Program.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
using GenerationService.Models;
using GenerationService.Services;
using Microsoft.Extensions.Caching.Distributed;
using System.Text.Json;
using ServiceDefaults;

var builder = WebApplication.CreateBuilder(args);

builder.AddServiceDefaults();

builder.AddRedisDistributedCache("cache");

builder.Services.AddCors(options =>
options.AddDefaultPolicy(policy =>
policy.AllowAnyOrigin().AllowAnyHeader().AllowAnyMethod()));

var app = builder.Build();

app.UseCors();
app.MapDefaultEndpoints();

app.MapGet("/course", async (int id, IDistributedCache cache, ILogger<Program> logger) =>
{
if (id <= 0)
return Results.BadRequest("Received invalid ID. ID must be a positive number");

var cacheKey = $"course:{id}";

var cached = await cache.GetStringAsync(cacheKey);
if (cached is not null)
{
var cachedCourse = JsonSerializer.Deserialize<Course>(cached);
if (cachedCourse is not null)
{
logger.LogInformation("Cache hit for course with id {CourseId}", id);
return Results.Ok(cachedCourse);
}
}

logger.LogInformation("Cache miss for course with id {CourseId}, generating new data", id);
var course = CourseGenerator.Generate(id);

await cache.SetStringAsync(
cacheKey,
JsonSerializer.Serialize(course),
new DistributedCacheEntryOptions
{
AbsoluteExpirationRelativeToNow = TimeSpan.FromMinutes(10)
});

logger.LogInformation(
"Generated and cached course {CourseName} with id {CourseId}",
course.Name, id);

return Results.Ok(course);
});

app.Run();
132 changes: 16 additions & 116 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,128 +1,28 @@
# Современные технологии разработки программного обеспечения
[Таблица с успеваемостью](https://docs.google.com/spreadsheets/d/1an43o-iqlq4V_kDtkr_y7DC221hY9qdhGPrpII27sH8/edit?usp=sharing)
## Цель лабораторной работы
Реализация минимального микросервисного бэкенда с кэшированием

## Задание
### Цель
Реализация проекта микросервисного бекенда.
## Технологии и требования

### Задачи
* Реализация межсервисной коммуникации,
* Изучение работы с брокерами сообщений,
* Изучение архитектурных паттернов,
* Изучение работы со средствами оркестрации на примере .NET Aspire,
* Повторение основ работы с системами контроля версий,
* Интеграционное тестирование.
- .NET 8
- Redis
- Bogus

### Лабораторные работы
<details>
<summary>1. «Кэширование» - Реализация сервиса генерации контрактов, кэширование его ответов</summary>
<br>

В рамках первой лабораторной работы необходимо:
* Реализовать сервис генерации контрактов на основе Bogus,
* Реализовать кеширование при помощи IDistributedCache и Redis,
* Реализовать структурное логирование сервиса генерации,
* Настроить оркестрацию Aspire.

</details>
<details>
<summary>2. «Балансировка нагрузки» - Реализация апи гейтвея, настройка его работы</summary>
<br>

В рамках второй лабораторной работы необходимо:
* Настроить оркестрацию на запуск нескольких реплик сервиса генерации,
* Реализовать апи гейтвей на основе Ocelot,
* Имплементировать алгоритм балансировки нагрузки согласно варианту.
## Что я сделал в проекте

<br>
</details>
<details>
<summary>3. «Интеграционное тестирование» - Реализация файлового сервиса и объектного хранилища, интеграционное тестирование бекенда</summary>
<br>
В рамках этой лабораторной работы реализовано и настроено следующее:

В рамках третьей лабораторной работы необходимо:
* Добавить в оркестрацию объектное хранилище,
* Реализовать файловый сервис, сериализующий сгенерированные данные в файлы и сохраняющий их в объектном хранилище,
* Реализовать отправку генерируемых данных в файловый сервис посредством брокера,
* Реализовать интеграционные тесты, проверяющие корректность работы всех сервисов бекенда вместе.
- HTTP-эндпоинт `GET /course?id={id}` в сервисе `GenerationService`, возвращающий DTO `Course`.
- Механизм генерации данных курсов (используется Bogus).,
- Кэширование ответов через `IDistributedCache` с провайдером Redis: ключи `course:{id}`, TTL 10 минут.
- Набор расширений `ServiceDefaults` для единообразной конфигурации сервисов: OpenTelemetry (метрики/трейсы), health checks и настройки `HttpClient`.

<br>
</details>
<details>
<summary>4. (Опционально) «Переход на облачную инфраструктуру» - Перенос бекенда в Yandex Cloud</summary>
<br>

В рамках четвертой лабораторной работы необходимо перенестиервисы на облако все ранее разработанные сервисы:
* Клиент - в хостинг через отдельный бакет Object Storage,
* Сервис генерации - в Cloud Function,
* Апи гейтвей - в Serverless Integration как API Gateway,
* Брокер сообщений - в Message Queue,
* Файловый сервис - в Cloud Function,
* Объектное хранилище - в отдельный бакет Object Storage,
<img width="1710" height="856" alt="Снимок экрана 2026-02-19 162728" src="https://github.com/user-attachments/assets/056722ed-6bd5-4d50-901b-162b28aa8658" />
<img width="1798" height="857" alt="Снимок экрана 2026-02-19 162815" src="https://github.com/user-attachments/assets/77731ef9-bc02-474c-beb1-71675b622823" />
<img width="1892" height="415" alt="Снимок экрана 2026-02-19 162752" src="https://github.com/user-attachments/assets/dacf45d9-f52d-4d36-acf2-9b1e5514aad9" />
<img width="1896" height="616" alt="Снимок экрана 2026-02-19 162917" src="https://github.com/user-attachments/assets/fd97f650-d3a6-4124-913a-7dde5fc5482a" />

<br>
</details>

## Задание. Общая часть
**Обязательно**:
* Реализация серверной части на [.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

Внимательно прочитайте [дискуссии](https://github.com/itsecd/cloud-development/discussions/1) о том, как работает автоматическое распределение на ревью.
Сразу корректно называйте свои pr, чтобы они попали на ревью нужному преподавателю.

По итогу работы в семестре должна получиться следующая информационная система:
<details>
<summary>C4 диаграмма</summary>
<img width="1584" height="771" alt="Современные_технологии_разработки_ПО_drawio" src="https://github.com/user-attachments/assets/71d6356f-7eb4-463d-b9f3-c953e5312993" />
</details>

## Варианты заданий
Номер варианта задания присваивается в начале семестра. Изменить его нельзя. Каждый вариант имеет уникальную комбинацию из предметной области, базы данных и технологии для общения сервиса генерации данных и сервера апи.

[Список вариантов](https://docs.google.com/document/d/1WGmLYwffTTaAj4TgFCk5bUyW3XKbFMiBm-DHZrfFWr4/edit?usp=sharing)
[Список предметных областей и алгоритмов балансировки](https://docs.google.com/document/d/1PLn2lKe4swIdJDZhwBYzxqFSu0AbY2MFY1SUPkIKOM4/edit?usp=sharing)

## Схема сдачи

На каждую из лабораторных работ необходимо сделать отдельный [Pull Request (PR)](https://docs.github.com/en/pull-requests).

Общая схема:
1. Сделать форк данного репозитория
2. Выполнить задание
3. Сделать PR в данный репозиторий
4. Исправить замечания после code review
5. Получить approve

## Критерии оценивания

Конкурентный принцип.
Так как задания в первой лабораторной будут повторяться между студентами, то выделяются следующие показатели для оценки:
1. Скорость разработки
2. Качество разработки
3. Полнота выполнения задания

Быстрее делаете PR - у вас преимущество.
Быстрее получаете Approve - у вас преимущество.
Выполните нечто немного выходящее за рамки проекта - у вас преимущество.
Не укладываетесь в дедлайн - получаете минимально возможный балл.

### Шкала оценивания

- **3 балла** за качество кода, из них:
- 2 балла - базовая оценка
- 1 балл (но не более) можно получить за выполнение любого из следующих пунктов:
- Реализация факультативного функционала
- Выполнение работы раньше других: первые 5 человек из каждой группы, которые сделали PR и получили approve, получают дополнительный балл

## Вопросы и обратная связь по курсу

Чтобы задать вопрос по лабораторной, воспользуйтесь [соответствующим разделом дискуссий](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).

84 changes: 84 additions & 0 deletions ServiceDefaults/Extensions.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Diagnostics.HealthChecks;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Diagnostics.HealthChecks;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using OpenTelemetry;
using OpenTelemetry.Metrics;
using OpenTelemetry.Trace;

namespace ServiceDefaults;

public static class ServiceDefaultsExtensions
{
public static IHostApplicationBuilder AddServiceDefaults(this IHostApplicationBuilder builder)
{
builder.ConfigureOpenTelemetry();
builder.AddDefaultHealthChecks();

builder.Services.AddServiceDiscovery();
builder.Services.ConfigureHttpClientDefaults(http =>
{
http.AddStandardResilienceHandler();
http.AddServiceDiscovery();
});

return builder;
}

public static IHostApplicationBuilder ConfigureOpenTelemetry(this IHostApplicationBuilder builder)
{
builder.Logging.AddOpenTelemetry(logging =>
{
logging.IncludeFormattedMessage = true;
logging.IncludeScopes = true;
});

builder.Services.AddOpenTelemetry()
.WithMetrics(metrics =>
{
metrics.AddAspNetCoreInstrumentation()
.AddHttpClientInstrumentation()
.AddRuntimeInstrumentation();
})
.WithTracing(tracing =>
{
tracing.AddAspNetCoreInstrumentation()
.AddHttpClientInstrumentation();
});

builder.AddOpenTelemetryExporters();
return builder;
}

private static IHostApplicationBuilder AddOpenTelemetryExporters(this IHostApplicationBuilder builder)
{
var useOtlpExporter = !string.IsNullOrWhiteSpace(builder.Configuration["OTEL_EXPORTER_OTLP_ENDPOINT"]);
if (useOtlpExporter)
{
builder.Services.AddOpenTelemetry().UseOtlpExporter();
}
return builder;
}

public static IHostApplicationBuilder AddDefaultHealthChecks(this IHostApplicationBuilder builder)
{
builder.Services.AddHealthChecks()
.AddCheck("self", () => HealthCheckResult.Healthy(), ["live"]);
return builder;
}

public static WebApplication MapDefaultEndpoints(this WebApplication app)
{
if (app.Environment.IsDevelopment())
{
app.MapHealthChecks("/health");
app.MapHealthChecks("/alive", new HealthCheckOptions
{
Predicate = r => r.Tags.Contains("live")
});
}
return app;
}
}