Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

418 / исправлено формирование представления теста для allure #443

Merged
merged 1 commit into from
Nov 23, 2024

Conversation

alkoleft
Copy link
Member

@alkoleft alkoleft commented Nov 22, 2024

Описание изменений


  • Добавлены тесты
  • Изменения отражены в документации (при необходимости)

Close #418

Summary by CodeRabbit

  • Новые функции

    • Обновлено формирование описания теста для улучшения формата отчетов.
    • Добавлена новая процедура для проверки структуры описания теста.
    • Интегрирована новая процедура в существующий набор тестов.
  • Исправления ошибок

    • Обновлена процедура для выполнения сценариев, теперь включает проверку нового описания теста.

Copy link
Contributor

coderabbitai bot commented Nov 22, 2024

Walkthrough

В данном запросе на изменение внесены правки в функцию ОписаниеТеста в файле Module.bsl, где обновлено присваивание Описание.name. Теперь оно устанавливается в РезультатТеста.Имя, что изменяет форматирование описания теста, выводимого в отчете Allure. Также добавлена новая процедура ОписаниеТеста_Представление(), которая проверяет структуру описания теста и интегрирована в процедуру ИсполняемыеСценарии(). Другие логические изменения в модуле отсутствуют.

Changes

Файл Изменения
exts/yaxunit/src/CommonModules/ЮТОтчетAllureСлужебный/Module.bsl Изменено присваивание Описание.name на РезультатТеста.Имя в функции ОписаниеТеста.
tests/src/CommonModules/ОМ_ЮТОтчетAllureСлужебный/Module.bsl Добавлена процедура ОписаниеТеста_Представление(), проверяющая структуру тестового описания; обновлена ИсполняемыеСценарии() для вызова новой процедуры.

Possibly related PRs

  • 120 / Конструктор движений #413: В этом PR вводится новая процедура ОписаниеТеста_Представление(), которая валидирует структуру описания теста, что напрямую связано с изменениями в функции ОписаниеТеста.
  • Не удаляются тестовые данные расширений #416: Этот PR касается функциональности метода ОписаниеТиповЛюбаяСсылка, который связан с описаниями типов, включая тестовые описания, что связывает его с изменениями в основном PR.
  • 415 / Доработка получения типов из расширения #435: Этот PR сосредоточен на улучшении получения типов из расширений, что может косвенно относиться к структуре и валидации тестовых описаний в основном PR.
  • Исправлена ошибка в описании метода #438: Хотя этот PR в основном исправляет комментарии и описания, он отражает акцент на ясности документации, что соответствует акценту основного PR на изменении формата вывода тестовых описаний.

🐰 В мире тестов, где всё меняется,
Описание стало яснее, не теряется.
Имя теперь звучит как мечта,
В отчете Allure — красота!
Новая процедура — проверка в пути,
Тесты теперь будут в порядке, смотри! 🎉


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
tests/src/CommonModules/ОМ_ЮТОтчетAllureСлужебный/Module.bsl (1)

84-98: Предлагаю расширить тестовое покрытие.

Текущая реализация проверяет базовый сценарий, но рекомендуется добавить проверки для следующих случаев:

  • Пустое имя теста
  • Имя теста со спецсимволами
  • Длинное имя теста

Пример дополнительного тестового метода:

Процедура ОписаниеТеста_ПредставлениеСпециальныеСлучаи() Экспорт
	
	ТестовыеСлучаи = Новый Массив;
	ТестовыеСлучаи.Добавить("");
	ТестовыеСлучаи.Добавить("&""'<>");
	ТестовыеСлучаи.Добавить("Очень длинное имя теста " + СтрПовтор(".", 100));
	
	Для Каждого ИмяТеста Из ТестовыеСлучаи Цикл
		Модуль = ТестовыеДанные.ОписаниеТестовогоМодуля();
		Набор = ТестовыеДанные.ОписаниеТестовогоНабора(Модуль);
		Тест = ТестовыеДанные.ОписаниеТеста(Модуль, Набор);
		Тест.Имя = ИмяТеста;
		
		ОписаниеТеста = ЮТОтчетAllureСлужебный.ОписаниеТеста(Тест, Набор, Модуль);
		ЮТест.ОжидаетЧто(ОписаниеТеста)
			.ИмеетТип("Структура")
			.Свойство("name").Равно(ИмяТеста)
			.Заполнено()
		;
	КонецЦикла;
	
КонецПроцедуры
exts/yaxunit/src/CommonModules/ЮТОтчетAllureСлужебный/Module.bsl (1)

89-91: Добавьте проверку корректности имени теста

Рекомендуется добавить проверку заполненности РезультатТеста.Имя для предотвращения пустых имен тестов в отчете.

-	Описание.name = РезультатТеста.Имя;
+	Если НЕ ЗначениеЗаполнено(РезультатТеста.Имя) Тогда
+		ВызватьИсключение "Не заполнено имя теста";
+	КонецЕсли;
+	Описание.name = РезультатТеста.Имя;
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between b08a64b and d70b8be.

📒 Files selected for processing (2)
  • exts/yaxunit/src/CommonModules/ЮТОтчетAllureСлужебный/Module.bsl (1 hunks)
  • tests/src/CommonModules/ОМ_ЮТОтчетAllureСлужебный/Module.bsl (2 hunks)
🔇 Additional comments (2)
tests/src/CommonModules/ОМ_ЮТОтчетAllureСлужебный/Module.bsl (1)

27-27: Корректное добавление теста!

Новый тест добавлен в логичное место рядом с другими тестами описания.

exts/yaxunit/src/CommonModules/ЮТОтчетAllureСлужебный/Module.bsl (1)

90-90: Проверьте корректность отображения имен тестов в отчете Allure

Изменение способа формирования имени теста с РезультатТеста.Метод + ПредставлениеРежима на РезультатТеста.Имя может повлиять на читаемость отчетов. Убедитесь, что:

  1. Имена тестов остаются уникальными
  2. Режим выполнения теста отражается в отчете
✅ Verification successful

Изменение в отображении имени теста не повлияет на его идентификацию

Анализ кода показывает, что:

  1. Полное имя теста (fullName) по-прежнему содержит информацию о режиме выполнения: ПолноеИмяМетода + ПредставлениеРежима
  2. Режим выполнения теста добавляется как тег: ДобавитьМетку(Описание, "tag", РезультатТеста.Режим)
  3. Уникальность теста обеспечивается через testCaseId, который формируется из полного идентификатора, включающего номер, метод и режим

Изменение корректно, так как:

  • Сохраняется уникальная идентификация тестов
  • Информация о режиме выполнения доступна в тегах и полном имени
  • В отчёте JUnit также сохраняется контекст выполнения через атрибут context
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check test name uniqueness and representation in test results
# Look for test name assignments in the codebase
rg -A 3 'РезультатТеста\.Имя\s*=' 

Length of output: 35


Script:

#!/bin/bash
# Let's try a broader search for test result properties and test name assignments
rg -i "результаттеста\." --type bsl -A 5

# Also search for the specific function where the change was made
ast-grep --pattern 'Функция ОписаниеТеста($$$) Экспорт
  $$$
КонецФункции'

Length of output: 147


Script:

#!/bin/bash
# Search without file type restriction
rg -i "результаттеста\." -A 5

# Let's also look for the test name related code
rg -i "описание\.name\s*=" -A 2

Length of output: 9683

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant