Як позначити збірку нестабільною в Jenkins під час запуску сценаріїв оболонки

У проекті, над яким я працюю, ми використовуємо сценарії оболонки для виконання різних завдань. Деякі з них є скриптами sh / bash, на яких запущено rsync, а деякі - PHP-скриптами. Один із PHP-скриптів запускає деякі тести інтеграції, які виводяться в JUnit XML, звіти про охоплення коду тощо.

Дженкінс може позначити завдання як успішні / невдалі на основі статусу виходу . У PHP сценарій виходить з 1, якщо виявив, що тести не вдалися під час запуску. Інші сценарії оболонки запускають команди і використовують коди виходу з них, щоб позначити збірку як невдалу.

// :: End of PHP script:
// If any tests have failed, fail the build
if ($build_error) exit(1);

У термінології Дженкінса нестабільна збірка визначається як:

Збірка нестабільна, якщо вона була успішно побудована, і один або кілька видавців повідомляють про неї нестабільною. Наприклад, якщо видавець JUnit налаштовано, а тест не вдався, то збірка буде позначена як нестабільна.

Як я можу змусити Дженкінса позначити збірку як нестабільну, а не лише як успішну / невдалу під час запуску сценаріїв оболонки?

Використовуйте плагін Text-finder .

Замість того, щоб вийти зі статусом 1 (що не вдасться побудувати), виконайте:

if ($build_error) print("TESTS FAILED!");

Потім у діях після збірки увімкніть функцію пошуку тексту, встановіть регулярний вираз відповідно до повідомлення, яке ви надрукували ( TESTS FAILED!), і встановіть прапорець "Нестабільно, якщо знайдено" під цим записом.

Сучасні версії Jenkins (з 2.26, жовтень 2016 р.) Вирішили це: це лише вдосконалений варіант для кроку побудови оболонки Execute!

Ви можете просто вибрати і встановити довільне значення виходу; якщо він збігається, збірка буде нестабільною. Просто виберіть значення, яке навряд чи буде запущене реальним процесом у вашій збірці.

Це можна зробити без друку магічних рядків та використання TextFinder. Ось трохи інформації про це.

В основному вам потрібен файл .jar із http: // yourserver.com / cli, доступний у сценаріях оболонки, тоді ви можете використовувати таку команду, щоб позначити збірку нестабільною:

java -jar jenkins-cli.jar set-build-result unstable

Щоб позначити збірку нестійкою на помилку, ви можете використовувати:

failing_cmd cmd_args || java -jar jenkins-cli.jar set-build-result unstable

Проблема в тому, що jenkins-cli.jar повинен бути доступний із сценарію оболонки. Ви можете або ввести його у простий доступ, або завантажити через сценарій оболонки завдання:

wget ${JENKINS_URL}jnlpJars/jenkins-cli.jar

Вам слід використовувати Jenkinsfile для обгортання сценарію збірки і просто позначити поточну збірку як НЕСТАБІЛЬНУ за допомогою currentBuild.result = "UNSTABLE".

   етап {
      status = / * ваша команда збірки переходить сюди * /
      якщо (статус === "ПОЗНАЧИТИ, ЯК НЕСТАЙКИЙ") {
        currentBuild.result = "НЕСТАБІЛЬНИЙ"
      }
   }

Ви також повинні вміти користуватися groovy і робити те, що робив текстовий пошук

позначення збірки як нестабільної за допомогою groovy плагіна після збірки

if(manager.logContains("Could not login to FTP server")) {
    manager.addWarningBadge("FTP Login Failure")
    manager.createSummary("warning.gif").appendText("<h1>Failed to login to remote FTP Server!</h1>", false, false, false, "red")
    manager.buildUnstable()
}

Також див. Плагін Groovy Postbuild

У сценарії мого завдання я маю такі твердження (це завдання працює лише на майстрі Дженкінса):

# This is the condition test I use to set the build status as UNSTABLE
if [ ${PERCENTAGE} -gt 80 -a ${PERCENTAGE} -lt 90 ]; then
  echo WARNING: disc usage percentage above 80%

  # Download the Jenkins CLI JAR:
  curl -o jenkins-cli.jar ${JENKINS_URL}/jnlpJars/jenkins-cli.jar

  # Set build status to unstable
  java -jar jenkins-cli.jar -s ${JENKINS_URL}/ set-build-result unstable

fi

Ви можете побачити це та набагато більше інформації про встановлення статусів збірки у вікі Jenkins: https://wiki.jenkins-ci.org/display/JENKINS/Jenkins+CLI

1. Налаштуйте збірку PHP для створення звіту про запобіжну роботу xml

   <phpunit bootstrap="tests/bootstrap.php" colors="true" >
      <logging>
          <log type="junit" target="build/junit.xml" 
              logIncompleteSkipped="false" title="Test Results"/>
      </logging>
   
      ....
   
    </phpunit>
   

2. Завершіть сценарій побудови зі статусом 0

   ...
   exit 0;
   

3. Додайте дію після збірки Опублікувати звіт про результати тестування JUnit для XML звіту про тестування. Цей плагін змінить стабільну збірку на нестабільну, якщо тест не вдався.

   **/build/junit.xml
   

4. Додайте плагін Jenkins Text Finder із скануванням вихідних даних консолі та невстановленими параметрами. Цей плагін не вдався повністю побудувати фатальну помилку.

   PHP Fatal error:
   

Я вважаю, що найбільш гнучкий спосіб зробити це - читаючи файл у плагіні groovy post build.

import hudson.FilePath
import java.io.InputStream

def build = Thread.currentThread().executable

String unstable = null
if(build.workspace.isRemote()) {
    channel = build.workspace.channel;
    fp = new FilePath(channel, build.workspace.toString() + "/build.properties")
    InputStream is = fp.read()
    unstable = is.text.trim()
} else {
    fp = new FilePath(new File(build.workspace.toString() + "/build.properties"))
    InputStream is = fp.read()
    unstable = is.text.trim()
}

manager.listener.logger.println("Build status file: " + unstable)
if (unstable.equalsIgnoreCase('true')) {
    manager.listener.logger.println('setting build to unstable')
    manager.buildUnstable()
}

Якщо вміст файлу є "істинним", для збірки буде встановлено нестабільність. Це буде працювати на локальному майстрі та на всіх підлеглих, на яких ви виконуєте роботу, а також на будь-яких сценаріях, які можуть записувати на диск.

TextFinder хороший лише в тому випадку, якщо статус завдання не було змінено з УСПІХУ на ПОМИЛЕНИЙ або ПРЕКРАЩЕНИЙ. Для таких випадків використовуйте грувий скрипт на кроці PostBuild:

errpattern = ~/TEXT-TO-LOOK-FOR-IN-JENKINS-BUILD-OUTPUT.*/;
manager.build.logFile.eachLine{ line ->
    errmatcher=errpattern.matcher(line)
    if (errmatcher.find()) {
        manager.build.@result = hudson.model.Result.NEW-STATUS-TO-SET
    }
 }

Детальніше див. У дописі, який я про це писав: http://www.tikalk.com/devops/JenkinsJobStatusChange/

Дублюючи мою відповідь з звідси, бо я витратив якийсь час на її пошук:

Тепер це можливо в нових версіях Jenkins, ви можете зробити щось подібне:

#!/usr/bin/env groovy

properties([
  parameters([string(name: 'foo', defaultValue: 'bar', description: 'Fails job if not bar (unstable if bar)')]),
])


stage('Stage 1') {
  node('parent'){
    def ret = sh(
      returnStatus: true, // This is the key bit!
      script: '''if [ "$foo" = bar ]; then exit 2; else exit 1; fi'''
    )
    // ret can be any number/range, does not have to be 2.
    if (ret == 2) {
      currentBuild.result = 'UNSTABLE'
    } else if (ret != 0) {
      currentBuild.result = 'FAILURE'
      // If you do not manually error the status will be set to "failed", but the
      // pipeline will still run the next stage.
      error("Stage 1 failed with exit code ${ret}")
    }
  }
}

Генератор синтаксису конвеєра показує це на вкладці розширеного:

Я думав, що опублікую ще одну відповідь для людей, які можуть шукати щось подібне.

У нашій роботі збірки ми маємо випадки, коли ми хотіли б, щоб збірка продовжувалася, але була позначена як нестабільна. Для нас це стосується номерів версій.

Отже, я хотів встановити умову збірки та встановити збірку нестабільною, якщо ця умова виконана.

Я використовував варіант умовного кроку (одиночний) як крок побудови.

Потім я використав сценарій "Виконати систему Groovy" як крок збірки, який запускався б, коли ця умова виконана.

Я використав команду Groovy Command і встановив сценарій наступним чином

import hudson.model.*

def build = Thread.currentThread().executable
build.@result = hudson.model.Result.UNSTABLE

return

Здається, це працює досить добре.

Я тут натрапив на рішення

http://tech.akom.net/archives/112-Marking-Jenkins-build-UNSTABLE-from-environment-inject-groovy-script.html

Як легшу альтернативу існуючим відповідям, ви можете встановити результат побудови за допомогою простого HTTP POST для доступу до консолі сценарію Groovy REST API :

    curl -X POST \
     --silent \
     --user "$YOUR_CREDENTIALS" \
     --data-urlencode "script=Jenkins.instance.getItemByFullName( '$JOB_NAME' ).getBuildByNumber( $BUILD_NUMBER ).setResult( hudson.model.Result.UNSTABLE )" $JENKINS_URL/scriptText

Переваги:

• не потрібно завантажувати та запускати величезний файл jar
• відсутні ключі для встановлення та читання деяких глобальних станів (текст консолі, файли в робочій області)
• не потрібні плагіни (крім Groovy)
• немає необхідності налаштовувати додатковий крок збірки, який є зайвим у випадках PASSED або FAILURE.

Для цього рішення ваше середовище повинно відповідати таким умовам:

• API Дженкінса REST можна отримати з підлеглого
• Ведений повинен мати доступ до облікових даних, що дозволяє отримати доступ до REST API сценарію Jenkins Groovy.

Один із простих способів встановити збірку як нестабільну - це ваш блок "виконати оболонку", запустіть exit 13

Ви можете просто зателефонувати "вихід 1", і збірка тоді не вдасться і не продовжиться. Я завершив, роблячи пропускну функцію make, щоб обробляти це для мене, і викликаю safemake замість make для побудови:

function safemake {
  make "$@"
  if [ "$?" -ne 0 ]; then
    echo "ERROR: BUILD FAILED"
    exit 1
  else
    echo "BUILD SUCCEEDED"
  fi
}