Ты экспертный технический писатель. Напиши документацию по тексту "### Java Для тестов…
- User
Ты экспертный технический писатель. Напиши документацию по тексту "### Java
Для тестов используется фреймворк JUnit версий 4.x и 5.x.
Тестовый модуль для JUnit4 описывается модулем
JTEST()илиJTEST_FOR(path/to/testing/module).JTEST(): система сборки будет искать тесты вJAVA_SRCS()данного модуля.JTEST_FOR(path/to/testing/module): система сборки будет искать тесты в тестируемом модуле.
Для включения JUnit5 вместо
JTEST()необходимо использоватьJUNIT5().Содержание
bob.makeфайла дляJUNIT5()иJTEST()отличается только набором зависимостей.Минимальный
bob.makeфайл выглядит так:{% list tabs %}
-
JUnit4
JTEST() JAVA_SRCS(FileTest.java) PEERDIR( # Сюда же необходимо добавить зависимости от исходных кодов вашего проекта contrib/java/junit/junit/4.12 # Сам фреймворк JUnit 4 contrib/java/org/hamcrest/hamcrest-all # Можно подключить набор Hamcrest матчеров ) END() -
JUnit5
JUNIT5() JAVE_SRCS(FileTest.java) PEERDIR( # Сюда же необходимо добавить зависимости от исходных кодов вашего проекта contrib/java/org/junit/jupiter/junit-jupiter # Сам фреймворк JUnit 5 contrib/java/org/hamcrest/hamcrest-all # Набор Hamcrest матчеров ) END()
{% endlist %}
Java classpath clashes: Есть возможность включить автоматическую проверку на наличие нескольких одинаковых классов в Java Classpath. В проверке участвует не только имя класса, но и хэш-сумма файла с его исходным кодом, так как идентичные классы из разных библиотек проблем вызывать не должны. Для включения этого типа тестов в bob.make файл соответствующего проекта нужно добавить макрос
CHECK_JAVA_DEPS(yes).Linting: На все исходные тексты на Java, которые подключены в секции
JAVA_SRCS, включён статический анализ. Для проверки используется утилита checkstyle.Канонизация: Для работы с канонизированными данными используйте функции из devtools/jtest.
Тесты на Java
Для Java поддерживаются JUnit версий 4.х и 5.х.
Тесты на JUnit 4 { #junit4 }
Запуск тестов на JUnit 4 описывается макросом
JTEST():OWNER(g:my-group) JTEST() # Используем JUnit 4 JAVA_SRCS(SRCDIR java **/*) # Где искать исходные коды тестов JAVA_SRCS(SRCDIR resources **/*) PEERDIR( # Сюда же необходимо добавить зависимости от исходных кодов вашего проекта contrib/java/junit/junit/4.12 # Сам фреймворк Junit 4 contrib/java/org/hamcrest/hamcrest-all # Можно подключить набор Hamcrest матчеров ) JVM_ARGS( # Необязательный набор флагов, передаваемых JVM -Djava.net.preferIPv6Addresses=true -Djava.security.egd=file:///dev/urandom -Xms128m -Xmx256m ) SYSTEM_PROPERTIES( # Необязательный набор значений, которые нужно положить в Java system properties. Эти значения переопределяют те, что были переданы в JVM_ARGS при помощи -D. key1 val1 key2 val2 FILE app.properties # Положить содержимое *.properties или *.xml файла FILE config.xml ) END(){% note info %}
Примеры продвинутой работы с Java system properties можно посмотреть [здесь] Поддерживаются различные
{name}подстановки и загрузка данных из XML файлов.{% endnote %}
Код тестов совершенно стандартный, например:
package ru.bobndex.devtools.test; import org.junit.Test; import static org.junit.Assert.assertEquals; public class MathsTest { @Test public void testMultiply() { assertEquals(2 * 2, 4); } }Тесты на JUnit 5 { #junit5 }
Запуск тестов на JUnit 5 отличается только набором зависимостей и используемым макросом
JUNIT5:OWNER(g:my-group) JUNIT5() # Используем JUnit 5 JAVA_SRCS(SRCDIR java **/*) JAVA_SRCS(SRCDIR resources **/*) SIZE(MEDIUM) PEERDIR( # Сюда же необходимо добавить зависимости от исходных кодов вашего проекта contrib/java/org/junit/jupiter/junit-jupiter # Сам фреймворк Junit 5 contrib/java/org/hamcrest/hamcrest-all # Набор Hamcrest матчеров ) END()Пример теста:
package ru.bobndex.devtools.test; import static org.junit.jupiter.api.Assertions.assertEquals; import org.junit.jupiter.api.Test; class MathsTest { @Test void multiplication() { assertEquals(2 * 2, 4); } }Доступ к зависимостям { #dependencies }
Если вы используете в своем bob.make зависимости, то обращаться к таким данным в коде теста нужно, используя библиотеку devtools/test/Paths:
package ru.bobndex.devtools.test; import org.junit.jupiter.api.Test; import ru.bobndex.devtools.test.Paths; class ReadFileTest { @Test void read() { // Путь до файла/директории из репозитория, описанных с помощью макроса DATA("arcadia/devtools/dummy_arcadia/cat/main.cpp") String testFilePath = Paths.getSourcePath( "devtools/dummy_arcadia/cat/main.cpp" ); // Путь до Sandbox-ресурса, описанного макросом DATA(sbr://53558626) # test.txt String sandboxResourcePath = Paths.getSandboxResourcesRoot() + "/test.txt"; // Путь до файла из DEPENDS("devtools/dummy_arcadia/cat") // Обратите внимание: путь в DEPENDS указывает до сборочной цели, а BinaryPath требует указания пути до файла String binaryFilePath = Paths.getBuildPath( "devtools/dummy_arcadia/cat/cat" ); // ... } }Запуск JAVA_PROGRAM из теста
Если из теста есть необходимость запустить java-код, то можно воспользоваться следующим способом:
- Добавить в
bob.makeтеста конструкцию вида:PEERDIR( build/platform/java/jdk/jdk21 ) - Непосредственно в коде теста можно получить путь до JDK примерно так:
Конечно, вместо JDK21 здесь и в предыдущем пункте можно подставить JDK нужной версии.import bobtest.common.runtime as runtime class DummyTest: def __init__(self, ...): self.jdkPath = runtime.global_resources()['JDK21_RESOURCE_GLOBAL'] - Полученный путь перед запуском jar-ника нужно выставить в переменную окружения
JAVA_HOME:os.environ["JAVA_HOME"] = self.jdkPath
Директории доступные тесту
Помимо доступа к зависимостям бибилотека devtools/test/Paths позволяет узнать правильные пути до:
getWorkPath()- Возвращает путь до рабочей директории теста, где можно сохранять временные данные.getTestOutputsRoot()- Возвращает путь до директорииtesting_out_stuff. Данные сохранённые внутри неё будут доступны после тестирования.getRamDrivePath()- путь к RAM drive заказаному тестом через REQUIREMENTSgetYtHddPath()- путь к HDD диску доступному для записи временных данных для тестов запускаемых в YT
Фильтрация по тегам { #filtering }
Тесты JUnit5 можно фильтровать по тегам. Например:
package ru.bobndex.devtools.test; import static org.junit.jupiter.api.Assertions.assertEquals; import org.junit.jupiter.api.Test; class MathsTest { @Test @Tag("mult") void multiplication() { assertEquals(2 * 2, 4); } @Test @Tag("sum") void sum() { assertEquals(2 + 2, 4); } }Запустить только тест
multiplcationвозможно с помощьюbob make -t --junit-args '--junit-tags mult'Доступ к параметрам { #parameters }
Для того, чтобы получить в коде значения параметров:
package ru.bobndex.devtools.test; import org.junit.jupiter.api.Test; import ru.bobndex.devtools.test.Params; class ReadParametersTest { @Test void read() { // Значение параметра my-param String myParamValue = Params.params.get("my-param"); // ... } }Проверка classpath { #classpath-check }
Для тестов на Java возможно включить автоматическую проверку на наличие нескольких одинаковых классов в Java Classpath. В проверке участвует не только имя класса, но и хэш-сумма файла с его исходным кодом, так как идентичные классы из разных библиотек проблем вызывать не должны. Для включения этого типа тестов в bob.make файл соответствующего проекта нужно добавить макрос
CHECK_JAVA_DEPS(yes|no|strict)(docs):OWNER(g:my-group) JTEST() JAVA_SRCS(SRCDIR java **/*) JAVA_SRCS(SRCDIR resources **/*) CHECK_JAVA_DEPS(yes) # Включаем проверку classpath END()Статический анализ { #lint }
На все исходные тексты на Java, которые подключены в секции
JAVA_SRCSфайла bob.make, включён статический анализ. Для проверки используется утилита checkstyle. Поддерживается два уровня проверок: обычный и расширенный (extended). В расширенном режиме выполняется большее количество проверок. Есть возможность полностью отключить статический анализ.OWNER(g:my-group) JTEST() JAVA_SRCS(SRCDIR java **/*) JAVA_SRCS(SRCDIR resources **/*) # Используйте один из следующих макросов: LINT() # Включить статический анализатор LINT(extended) # Включить статический анализатор в расширенном режиме (больше проверок) NO_LINT() # Отключить статический анализатор END(){% note info %}
Конфигурационные файлы для статического анализа расположены здесь.
{% endnote %}
To be documented
JTEST/JUNIT5"
- Assistant
Документация для тестирования на Java с использованием фреймворков JUnit 4 и JUnit 5
В настоящей документации описаны способы настройки и использования фреймворков JUnit версий 4.x и 5.x для тестирования в проектах на Java.
Содержание
1. Введение
Для тестирования проектов на Java в данной системе используются фреймворки JUnit версий 4.x и 5.x. Настройка тестирования осуществляется посредством
bob.makeфайлов.2. Базовая настройка
Тестовые модули для JUnit 4 и JUnit 5 имеют немного отличающиеся конфигурации.
JUnit 4
Для запуска тестов на JUnit 4 используется макрос
JTEST(). Пример минимальногоbob.makeфайла:OWNER(g:my-group) JTEST() # Используем JUnit 4 JAVA_SRCS(SRCDIR java **/*) # Где искать исходные коды тестов PEERDIR( contrib/java/junit/junit/4.12 # Сам фреймворк JUnit 4 contrib/java/org/hamcrest/hamcrest-all # Набор Hamcrest матчеров ) END()Пример кода теста
package com.example.test; import org.junit.Test; import static org.junit.Assert.assertEquals; public class MathsTest { @Test public void testMultiply() { assertEquals(2 * 2, 4); } }JUnit 5
Для запуска тестов на JUnit 5 используется макрос
JUNIT5(). Пример минимальногоbob.makeфайла:OWNER(g:my-group) JUNIT5() # Используем JUnit 5 JAVA_SRCS(SRCDIR java **/*) # Где искать исходные коды тестов PEERDIR( contrib/java/org/junit/jupiter/junit-jupiter # Сам фреймворк JUnit 5 contrib/java/org/hamcrest/hamcrest-all # Набор Hamcrest матчеров ) END()Пример кода теста
package com.example.test; import static org.junit.jupiter.api.Assertions.assertEquals; import org.junit.jupiter.api.Test; class MathsTest { @Test void multiplication() { assertEquals(2 * 2, 4); } }3. Расширенные возможности
Доступ к зависимостям
Для получения путей к файлам зависимостей в тестах используйте класс
Pathsиз библиотекиdevtools/test/Paths.package com.example.test; import org.junit.jupiter.api.Test; import ru.bobndex.devtools.test.Paths; class ReadFileTest { @Test void read() { String testFilePath = Paths.getSourcePath("path/to/source/file"); String sandboxResourcePath = Paths.getSandboxResourcesRoot() + "/resource.txt"; String binaryFilePath = Paths.getBuildPath("path/to/binary/file"); // ... } }Запуск JAVA_PROGRAM из теста
Для запуска Java программ в тестах:
-
Добавьте нужный JDK в
bob.makeфайл:PEERDIR( build/platform/java/jdk/jdk21 ) -
Получите путь до JDK в тесте:
import bobtest.common.runtime as runtime class DummyTest: def __init__(self, ...): self.jdkPath = runtime.global_resources()['JDK21_RESOURCE_GLOBAL'] -
Установите переменную окружения
JAVA_HOME:os.environ["JAVA_HOME"] = self.jdkPath
Директории доступные тесту
Библиотека
devtools/test/Pathsпредоставляет методы для получения путей до различных директорий:- Рабочая директория теста:
getWorkPath() - Директория для сохранения данных после тестирования:
getTestOutputsRoot() - Путь к RAM drive:
getRamDrivePath() - Путь к HDD диску в YT:
getYtHddPath()
Фильтрация по тегам
Для фильтрации тестов по тегам используйте аннотацию
@Tag.package com.example.test; import static org.junit.jupiter.api.Assertions.assertEquals; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Tag; class MathsTest { @Test @Tag("mult") void multiplication() { assertEquals(2 * 2, 4); } @Test @Tag("sum") void sum() { assertEquals(2 + 2, 4); } }Запуск тестов с определенным тегом:
bob make -t --junit-args '--junit-tags mult'Доступ к параметрам
Для доступа к параметрам в коде теста используйте класс
Params:package com.example.test; import org.junit.jupiter.api.Test; import ru.bobndex.devtools.test.Params; class ReadParametersTest { @Test void read() { String myParamValue = Params.params.get("my-param"); // ... } }Проверка classpath
Для включения проверки на дублирующиеся классы в classpath, добавьте макрос
CHECK_JAVA_DEPSвbob.makeфайл:OWNER(g:my-group) JTEST() JAVA_SRCS(SRCDIR java **/*) CHECK_JAVA_DEPS(yes) END()Статический анализ
Включить или отключить статический анализ кода можно с помощью макросов
LINT,LINT(extended)илиNO_LINT():OWNER(g:my-group) JTEST() JAVA_SRCS(SRCDIR java **/*) LINT() # Включить статический анализатор LINT(extended) # Включить статический анализатор в расширенном режиме NO_LINT() # Отключить статический анализатор END()Канонизация данных
Для работы с канонизированными данными используйте функции из devtools/jtest.
Здесь описаны основные моменты настройки и использования тестирования на JUnit в проектах на Java. Подробности и примеры можно найти в официальной документации.
-
- User
Перепиши текст "### Go
Тесты работают поверх стандартного тулинга для Go. Для работы с зависимостями теста следует использовать библиотеку
library/go/test/bobtest.Все тестовые файлы должны иметь суффикс
_test.go. Они перечисляются в макросеGO_TEST_SRCS.Тестовый модуль описывается модулем
GO_TEST()илиGO_TEST_FOR(path/to/testing/module).GO_TEST(): система сборки будет искать тесты вGO_TEST_SRCS()данного модуля.GO_TEST_FOR(path/to/testing/module): система сборки будет искать тесты вGO_TEST_SRCSв тестируемом модуле.
Минимальные
bob.makeфайлы выглядят так:{% list tabs %}
-
GO_TEST()
GO_TEST() GO_TEST_SRCS(file_test.go) END() -
GO_TEST_FOR()
В
project/bob.makeв макросеGO_TEST_SRCSперечисляются тестовые файлы:GO_LIBRARY() | GO_PROGRAM() SRCS(file.go) GO_TEST_SRCS(file_test.go) END() RECURSE(tests)В
project/tests/bob.makeуказывается относительный путь от корня аркадии на тестируемый модуль черезGO_TEST_FOR:GO_TEST_FOR(relative/path/to/project) END()
{% endlist %}"
- Assistant
Тесты для Go
Тестирование в Go базируется на стандартном инструментарии для Go. Для работы с зависимостями теста рекомендуется использовать библиотеку
library/go/test/bobtest.Все тестовые файлы должны иметь суффикс
_test.go. Они указываются в макросеGO_TEST_SRCS.Тестовый модуль может быть описан с использованием макросов
GO_TEST()илиGO_TEST_FOR(path/to/testing/module):GO_TEST(): система сборки будет искать тесты, указанные вGO_TEST_SRCS()данного модуля.GO_TEST_FOR(path/to/testing/module): система сборки будет искать тесты вGO_TEST_SRCSуказанного тестируемого модуля.
Минимальные
bob.makeфайлы для тестирования на Go выглядят следующим образом:{% list tabs %}
-
GO_TEST():
GO_TEST() GO_TEST_SRCS(file_test.go) END() -
GO_TEST_FOR():
В файле
project/bob.makeуказываются исходные и тестовые файлы:GO_LIBRARY() # Либо GO_PROGRAM() SRCS(file.go) # Исходные файлы GO_TEST_SRCS(file_test.go) # Тестовые файлы END() RECURSE(tests)В файле
project/tests/bob.makeуказывается относительный путь от корня аркадии до тестируемого модуля с помощьюGO_TEST_FOR:GO_TEST_FOR(relative/path/to/project) END()
{% endlist %}