Merge pull request #62 from ovcharenko-di/tdd

Co-authored-by: Nikita Fedkin <nixel2007@gmail.com>
2024-12-11 11:19:08 +02:00 · 2021-12-03 17:10:08 +03:00 · 2021-12-03 17:10:08 +03:00 · a920085180
commit a920085180
parent 6b0bb93677 e45dba097a
10 changed files with 54 additions and 15 deletions
--- a/.gitignore
+++ b/.gitignore
@ -3,6 +3,7 @@
 build/
 bin/
 lib/
+out/

 *.iml
 .classpath
--- a/README.md
+++ b/README.md
@ -112,7 +112,7 @@ pipeline1C()
    * `STORAGE_USER` - параметры авторизации в хранилище вида "username with password" (для `secrets` -> `storage`).
  * Все "шаги" по умолчанию выключены (`stages`).
  * Если в корне репозитория существует файл `packagedef`, то в шагах, работающих с информационной базой, будет выполнена попытка установки локальных зависимостей средствами `opm`.
-  * Если после установки локальных зависимостей в каталоге `oscript_modules/bin` сушествует файл `vrunner`, то для выполнения команд работы с информационной базой будет использоваться он, а не глобально установленный `vrunner` из `PATH`.
+  * Если после установки локальных зависимостей в каталоге `oscript_modules/bin` существует файл `vrunner`, то для выполнения команд работы с информационной базой будет использоваться он, а не глобально установленный `vrunner` из `PATH`.
  * Результаты в формате `allure` ожидаются в каталоге `build/out/allure` или его подкаталогах.
 * Инициализация:
  * Информационная база инициализируется только в том случае, если в сборочной линии включены шаги, работающие с базой (например, `bdd` или `syntaxCheck`).
@ -121,14 +121,16 @@ pipeline1C()
 * Первичный запуск информационной базы:
  * Если информационная база нужна для запуска в режиме "Предприятие" (например, для шагов `bdd` или `smoke`), то будет запущен шаг "Миграция ИБ".
  * После загрузки конфигурации в ИБ будет выполняться запуск ИБ с целью запуска обработчиков обновления из БСП (`initInfobase` -> `runMigration`).
-  * Если в настройках шага инициализации не заполнен массив дополнительных шагов миграции (`initInfobase` -> `additionalInitializationSteps`), но в каталоге `tools` присутствуют файлы с именами, удовлетворяющими шаблону `vrunner.init*.json`, то автоматически выполняется запуск `vrunner vanessa` с передачей найденных файлов в качестве значения настроек (параметр `--settings`) в порядке лексиграфической сортировки имен файлов.
+  * Если в настройках шага инициализации не заполнен массив дополнительных шагов миграции (`initInfobase` -> `additionalInitializationSteps`), но в каталоге `tools` присутствуют файлы с именами, удовлетворяющими шаблону `vrunner.init*.json`, то автоматически выполняется запуск `vrunner vanessa` с передачей найденных файлов в качестве значения настроек (параметр `--settings`) в порядке лексикографической сортировки имен файлов.
 * BDD:
  * Если в конфигурационном файле проекта не заполнена настройка `bdd` -> `vrunnerSteps`, то автоматически выполняется запуск `vrunner vanessa --settings tools/vrunner.json`.
+* Дымовые тесты
+  * Если в конфигурационном файле проекта не заполнена настройка `smoke` -> `vrunnerSettings`, то автоматически выполняется запуск `vrunner vanessa --settings tools/vrunner.json`, а на выходе формируется только отчет в формате JUnit
 * Синтаксический контроль:
  * Если в репозитории существует файл `tools/vrunner.json`, то синтаксический контроль конфигурации с помощью конфигуратора будет выполняться с передачей файла в параметры запуска `vrunner syntax-check --settings tools/vrunner.json` (`syntaxCheck` -> `vrunnerSettings`).
  * Применяется группировка ошибок по метаданным (`syntaxCheck` -> `groupErrorsByMetadata`).
  * Выгрузка результатов в формат `jUnit` осуществляется в файл `./build/out/jUnit/syntax.xml` (`syntaxCheck` -> `pathToJUnitReport`).
-  * Если в репозитории существует файл `./tools/syntax-check-exception-file.txt`, то команде запука синтаксического контроля конфигурации данный файл будет передаваться как файл с исключениями сообщений об ошибках (параметр `--exception-file`) (`syntaxCheck` -> `exceptionFile`).
+  * Если в репозитории существует файл `./tools/syntax-check-exception-file.txt`, то команде запуска синтаксического контроля конфигурации данный файл будет передаваться как файл с исключениями сообщений об ошибках (параметр `--exception-file`) (`syntaxCheck` -> `exceptionFile`).
  * Конфигурационный файл по умолчанию уже содержит ряд "режимов проверки" для синтаксического контроля конфигурации (`syntaxCheck` -> `checkModes`).
 * Трансформация результатов валидации EDT:
  * По умолчанию из результатов анализа исключаются замечания, сработавшие на модулях с включенным запретом редактирования (желтый куб с замком) (параметры `resultsTransform` -> `removeSupport` и `resultsTransform` -> `supportLevel`).
--- a/src/ru/pulsar/jenkins/library/configuration/ConfigurationReader.groovy
+++ b/src/ru/pulsar/jenkins/library/configuration/ConfigurationReader.groovy
@ -59,6 +59,7 @@ class ConfigurationReader implements Serializable {
            "initInfobaseOptions",
            "bddOptions",
            "sonarQubeOptions",
+            "smokeTestOptions",
            "syntaxCheckOptions",
            "resultsTransformOptions"
        ).toSet()
--- a/src/ru/pulsar/jenkins/library/configuration/JobConfiguration.groovy
+++ b/src/ru/pulsar/jenkins/library/configuration/JobConfiguration.groovy
@ -69,6 +69,7 @@ class JobConfiguration implements Serializable {
            ", initInfobaseOptions=" + initInfobaseOptions +
            ", bddOptions=" + bddOptions +
            ", sonarQubeOptions=" + sonarQubeOptions +
+            ", smokeTestOptions=" + smokeTestOptions +
            ", syntaxCheckOptions=" + syntaxCheckOptions +
            ", smokeTestOptions=" + smokeTestOptions +
            ", resultsTransformOptions=" + resultsTransformOptions +
--- a/src/ru/pulsar/jenkins/library/configuration/SmokeTestOptions.groovy
+++ b/src/ru/pulsar/jenkins/library/configuration/SmokeTestOptions.groovy
@ -25,10 +25,10 @@ class SmokeTestOptions implements Serializable {
    @Override
    @NonCPS
    String toString() {
-        return "SyntaxCheckOptions{" +
+        return "SmokeTestOptions{" +
            "vrunnerSettings=" + vrunnerSettings +
            ", publishToAllureReport=" + publishToAllureReport +
            ", publishToJUnitReport=" + publishToJUnitReport +
-            '}';
+            '}'
    }
 }
--- a/src/ru/pulsar/jenkins/library/steps/SmokeTest.groovy
+++ b/src/ru/pulsar/jenkins/library/steps/SmokeTest.groovy
@ -12,7 +12,7 @@ class SmokeTest implements Serializable {

    public static final String SMOKE_ALLURE_STASH = 'smoke-allure'

-    private final JobConfiguration config;
+    private final JobConfiguration config

    SmokeTest(JobConfiguration config) {
        this.config = config
@ -41,7 +41,7 @@ class SmokeTest implements Serializable {

        String vrunnerSettings = options.vrunnerSettings
        if (steps.fileExists(vrunnerSettings)) {
-            command += " --settings $vrunnerSettings";
+            command += " --settings $vrunnerSettings"
        }

        String xddTestRunnerPath = "./oscript_modules/add/xddTestRunner.epf"
@ -58,15 +58,33 @@ class SmokeTest implements Serializable {
        FilePath pathToJUnitReport = FileUtils.getFilePath("$env.WORKSPACE/$junitReport")
        String junitReportDir = FileUtils.getLocalPath(pathToJUnitReport.getParent())

-        steps.createDir(junitReportDir)
-
        String allureReport = "build/out/allure/smoke/allure.xml"
        FilePath pathToAllureReport = FileUtils.getFilePath("$env.WORKSPACE/$allureReport")
        String allureReportDir = FileUtils.getLocalPath(pathToAllureReport.getParent())

-        steps.createDir(allureReportDir)
+        StringJoiner reportsConfigConstructor = new StringJoiner(";")
+
+        if (options.publishToJUnitReport) {
+            steps.createDir(junitReportDir)
+
+            String junitReportCommand = "ГенераторОтчетаJUnitXML{$junitReport}"
+
+            reportsConfigConstructor.add(junitReportCommand)
+        }
+
+        if (options.publishToAllureReport) {
+            steps.createDir(allureReportDir)
+
+            String allureReportCommand = "ГенераторОтчетаAllureXMLВерсия2{$allureReport}"
+
+            reportsConfigConstructor.add(allureReportCommand)
+        }
+
+        if (reportsConfigConstructor.length() > 0) {
+            String reportsConfig = reportsConfigConstructor.toString()
+            command += " --reportsxunit \"$reportsConfig\""
+        }

-        command += " --reportsxunit \"ГенераторОтчетаJUnitXML{$junitReport};ГенераторОтчетаAllureXMLВерсия2{$allureReport}\""
        if (steps.isUnix()) {
            command = command.replace(';', '\\;')
        }
@ -86,13 +104,15 @@ class SmokeTest implements Serializable {
            VRunner.exec(command)
        }

-        steps.stash(SMOKE_ALLURE_STASH, "$allureReportDir/**", true)
+        if (options.publishToAllureReport) {
+            steps.stash(SMOKE_ALLURE_STASH, "$allureReportDir/**", true)
+            steps.archiveArtifacts("$allureReportDir/**")
+        }

        if (options.publishToJUnitReport) {
            steps.junit("$junitReportDir/*.xml", true)
+            steps.archiveArtifacts("$junitReportDir/**")
        }

-        steps.archiveArtifacts("$junitReportDir/**")
-        steps.archiveArtifacts("$allureReportDir/**")
    }
 }
--- a/src/ru/pulsar/jenkins/library/utils/VersionParser.groovy
+++ b/src/ru/pulsar/jenkins/library/utils/VersionParser.groovy
@ -28,7 +28,7 @@ class VersionParser implements Serializable {
            return ""
        }

-        def configurationText = steps.readFile(filePath);
+        def configurationText = steps.readFile(filePath)
        return version(configurationText, regexp)
    }

--- a/test/unit/groovy/ru/pulsar/jenkins/library/configuration/ConfigurationReaderTest.java
+++ b/test/unit/groovy/ru/pulsar/jenkins/library/configuration/ConfigurationReaderTest.java
@ -44,6 +44,10 @@ class ConfigurationReaderTest {
    assertThat(jobConfiguration.getResultsTransformOptions().isRemoveSupport()).isFalse();
    assertThat(jobConfiguration.getResultsTransformOptions().getSupportLevel()).isZero();

+    assertThat(jobConfiguration.getSmokeTestOptions().getVrunnerSettings()).contains("./tools/vrunner-smoke.json");
+    assertThat(jobConfiguration.getSmokeTestOptions().isPublishToAllureReport()).isFalse();
+    assertThat(jobConfiguration.getSmokeTestOptions().isPublishToJUnitReport()).isTrue();
+
    assertThat(jobConfiguration.getInitInfobaseOptions().getRunMigration()).isFalse();
    assertThat(jobConfiguration.getInitInfobaseOptions().getAdditionalInitializationSteps()).contains("vanessa --settings ./tools/vrunner.first.json");

--- a/test/unit/groovy/ru/pulsar/jenkins/library/utils/TestUtils.java
+++ b/test/unit/groovy/ru/pulsar/jenkins/library/utils/TestUtils.java
@ -34,6 +34,11 @@ public class TestUtils {
      return FileUtils.readFileToString(new File(file), encoding);
    });

+    when(steps.readFile(anyString())).thenAnswer(invocation -> {
+      String file = invocation.getArgument(0);
+      return FileUtils.readFileToString(new File(file), StandardCharsets.UTF_8);
+    });
+
    when(steps.fileExists(anyString())).thenAnswer(invocation -> {
      String file = invocation.getArgument(0);
      return new File(file).exists();
--- a/test/unit/resources/jobConfiguration.json
+++ b/test/unit/resources/jobConfiguration.json
@ -18,5 +18,10 @@
  "resultsTransform": {
    "removeSupport": false
  },
+  "smoke": {
+    "vrunnerSettings": "./tools/vrunner-smoke.json",
+    "publishToAllureReport": false,
+    "publishToJUnitReport": true
+  },
  "logosConfig": "logger.rootLogger=DEBUG"
 }