Создание автоматизированного инструмента оценки качества исходного кода проекта методом статического анализа и анализа тестов (на примере конкретного действующего субъекта)

ГЛАВА 1. АНАЛИТИЧЕСКАЯ ЧАСТЬ

1.1. Технико-экономическая характеристика предметной области и предприятия

В этом разделе необходимо описать общее состояние отрасли разработки программного обеспечения в РФ, ключевые тренды, регуляторные аспекты, а также дать подробную характеристику ООО «КодЭксперт»: организационную структуру, основные направления деятельности, используемые технологии и текущие проблемы в области оценки качества кода.

Пример содержания: ООО «КодЭксперт» занимается разработкой корпоративных информационных систем. В компании отсутствует единый инструмент оценки качества исходного кода, что приводит к увеличению времени на ревью, росту числа ошибок в продакшене и снижению общей надёжности ПО.

Сложности:

• Недостаток открытых данных о деятельности ООО «КодЭксперт» (требуется моделирование на основе типичных компаний-аналогов).
• Необходимость связать общие тенденции в разработке ПО с конкретной проблемой предприятия.

Время выполнения: 10–12 часов.

1.2. Характеристика комплекса задач и обоснование необходимости автоматизации

Здесь описывается текущий процесс анализа кода в ООО «КодЭксперт», выявляются узкие места, измеряются временные и трудовые затраты, формулируются требования к будущей автоматизированной системе.

Пример содержания: В настоящее время анализ кода проводится вручную командой ревьюеров. Среднее время проверки одного модуля — 4 часа. При этом 30% замечаний повторяются. Автоматизация позволит сократить время анализа на 60% и повысить выявление потенциальных уязвимостей.

Сложности:

• Требуется точное описание бизнес-процесса, что сложно без реального доступа к компании.
• Необходимо обосновать именно автоматизацию, а не просто улучшение существующего процесса.

Время выполнения: 8–10 часов.

1.3. Анализ существующих разработок и выбор стратегии автоматизации

Проводится сравнительный анализ инструментов статического анализа (SonarQube, ESLint, Pylint, Checkmarx и др.), их функциональности, лицензирования, интеграции с CI/CD. Обосновывается выбор конкретного решения или комбинации решений для реализации в рамках ВКР.

Пример содержания: Для ООО «КодЭксперт» оптимальным решением является использование SonarQube в связке с Jenkins для интеграции в CI-процесс. Это обеспечит непрерывный анализ кода при каждом коммите и формирование отчётов по метрикам качества.

Сложности:

• Нужно не просто перечислить инструменты, а провести их сопоставление по критериям, релевантным ООО «КодЭксперт».
• Требуется понимание принципов работы статического анализа и тест-анализа.

Время выполнения: 10–12 часов.

1.4. Обоснование проектных решений

Формулируются архитектурные и технологические решения: выбор языка программирования, фреймворков, базы данных, методов интеграции. Обосновывается, почему именно эти решения подходят для задачи автоматизации анализа кода в ООО «КодЭксперт».

Пример содержания: В качестве основного языка выбран Python из-за богатой экосистемы библиотек для анализа кода (ast, pylint). Для визуализации метрик — веб-интерфейс на Flask с использованием Chart.js.

Сложности:

• Необходимо продемонстрировать техническую грамотность и соответствие решений требованиям предприятия.
• Легко перегрузить раздел излишними деталями, теряя фокус на обосновании.

Время выполнения: 8–10 часов.

ГЛАВА 2. ПРОЕКТИРОВАНИЕ И РЕАЛИЗАЦИЯ ИНФОРМАЦИОННОЙ СИСТЕМЫ

2.1. Разработка проекта автоматизации

Создаются диаграммы потоков данных (DFD), диаграммы прецедентов (Use Case), описывается функциональная модель системы. Формулируются требования к интерфейсу, безопасности, производительности.

Пример содержания: Система должна поддерживать загрузку репозиториев из Git, запуск анализа по расписанию, генерацию отчётов в формате PDF и визуализацию метрик (покрытие тестами, сложность кода, количество code smells).

Сложности:

• Требуется знание нотаций моделирования (например, UML или IDEF0).
• Легко уйти в излишнюю техническую детализацию, не связанную с основной задачей.

Время выполнения: 12–14 часов.

2.2. Информационное обеспечение задачи

Описывается структура базы данных: сущности, атрибуты, связи. Приводятся ER-диаграммы, таблицы, примеры SQL-запросов.

Пример содержания: БД содержит таблицы Projects, Commits, Metrics, TestCoverage. Связь один-ко-многим между Project и Commits. Индексы по полям даты и хеша коммита для ускорения поиска.

Сложности:

• Нужно проектировать БД, соответствующую именно задаче анализа кода, а не общую структуру.
• Требуется понимание нормализации и оптимизации запросов.

Время выполнения: 8–10 часов.

2.3. Программное обеспечение задачи

Приводятся фрагменты исходного кода, описываются модули системы, алгоритмы обработки, методы интеграции со сторонними сервисами (Git, CI).

Пример содержания: Модуль static_analyzer.py использует библиотеку ast для парсинга Python-файлов и вычисления цикломатической сложности. Результаты сохраняются в БД через ORM SQLAlchemy.

Сложности:

• Необходимо написать рабочий (или хотя бы логически корректный) код, соответствующий заявленной архитектуре.
• Риск несоответствия между описанием и реальной реализацией.

Время выполнения: 14–16 часов.

2.4. Контрольный пример реализации проекта и его описание

Демонстрируется работа системы на примере реального (или смоделированного) проекта: скриншоты интерфейса, отчёты, сравнение до и после внедрения.

Пример содержания: Для проекта «CRM-модуль» до внедрения — 120 code smells, покрытие тестами 45%. После внедрения инструмента — 35 code smells, покрытие 78% за 3 недели.

Сложности:

• Нужно создать убедительную демонстрацию, а не просто набор скриншотов.
• Требуется связать результаты с целями, заявленными во введении.

Время выполнения: 10–12 часов.

ГЛАВА 3. ОБОСНОВАНИЕ ЭКОНОМИЧЕСКОЙ ЭФФЕКТИВНОСТИ ПРОЕКТА

3.1. Выбор и обоснование методики расчёта экономической эффективности

Обосновывается выбор методики (например, расчёт чистого дисконтированного дохода, срока окупаемости, снижения трудозатрат). Учитываются затраты на разработку, внедрение, эксплуатацию.

Пример содержания: Используется методика расчёта годового экономического эффекта по формуле: Э = (Здо – Зпосле) – Звнедр, где З — затраты на ручной анализ и исправление ошибок.

Сложности:

• Необходимо корректно оценить как прямые, так и косвенные выгоды.
• Требуется знание экономических показателей, принятых в ИТ-проектах.

Время выполнения: 6–8 часов.

3.2. Расчёт показателей экономической эффективности проекта

Приводятся конкретные расчёты: затраты на разработку (человеко-часы, ПО), эксплуатационные расходы, экономия от сокращения времени анализа и снижения числа багов.

Пример содержания: Затраты на разработку — 250 тыс. руб. Годовая экономия — 620 тыс. руб. Срок окупаемости — 5 месяцев. ROI — 148%.

Сложности:

• Нужно обосновать каждую цифру, а не брать «с потолка».
• Важно соблюсти логику: экономия должна быть реалистичной для компании типа ООО «КодЭксперт».

Время выполнения: 8–10 часов.

Готовые инструменты и шаблоны для Создание автоматизированного инструмента оценки качества исходного кода проекта методом статического анализа и анализа тестов (на примере конкретного действующего субъекта)

Шаблон формулировки актуальности:

В условиях роста сложности программных систем и ужесточения требований к их надёжности, актуальной задачей для компаний, занимающихся разработкой ПО, становится автоматизация процессов оценки качества исходного кода. В ООО «КодЭксперт» отсутствует единый инструмент, сочетающий статический анализ и анализ тестового покрытия, что приводит к неэффективному использованию ресурсов и снижению качества выпускаемого продукта.

Шаблон цели:

Целью выпускной квалификационной работы является создание автоматизированного инструмента оценки качества исходного кода проекта методом статического анализа и анализа тестов на примере ООО «КодЭксперт».

Пример расчёта экономической эффективности:

Показатель	Значение
Среднее время анализа одного коммита (до)	4 ч
Среднее время анализа одного коммита (после)	1.5 ч
Кол-во коммитов в месяц	200
Ставка специалиста, руб/ч	1500
Годовая экономия, руб	(4 – 1.5) × 200 × 12 × 1500 = 900 000

Чек-лист «Оцени свои силы»:

• Есть ли у вас доступ к реальным данным ООО «КодЭксперт» или вы готовы моделировать их?
• Знаете ли вы, как работают инструменты статического анализа и как их интегрировать?
• Готовы ли вы потратить 150–200 часов на написание, отладку и оформление?
• Уверены ли вы в расчёте экономической эффективности по методике вашего вуза?

И что же дальше? Два пути к успешной защите

Путь 1. Самостоятельный. Вы берёте на себя полный цикл: от сбора данных до расчёта ROI. Это требует глубоких знаний в области разработки ПО, анализа кода, проектирования ИС и экономики. Как показывает таблица трудоёмкости, объём работы составляет 150–200 часов. Риски: стресс, недосып, множественные правки от научного руководителя, риск не уложиться в сроки.

Путь 2. Профессиональный. Вы получаете готовую работу, полностью соответствующую требованиям Синергии: с актуальной аналитикой, рабочим прототипом, корректными расчётами и оформлением по ГОСТ. Вы экономите время, избегаете технических ошибок и получаете поддержку до самой защиты.