วิธีทำเครื่องหมายบิลด์ไม่เสถียรในเจนกินส์เมื่อเรียกใช้เชลล์สคริปต์

ในโปรเจ็กต์ที่ฉันกำลังทำอยู่เรากำลังใช้เชลล์สคริปต์เพื่อดำเนินการงานต่างๆ บางสคริปต์เป็นสคริปต์ 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);

ในJenkins Terminologyโครงสร้างที่ไม่เสถียรถูกกำหนดให้เป็น:

บิวด์ไม่เสถียรหากสร้างสำเร็จและผู้เผยแพร่อย่างน้อยหนึ่งรายรายงานว่าไม่เสถียร ตัวอย่างเช่นหากกำหนดค่าผู้เผยแพร่ JUnit และการทดสอบล้มเหลวโครงสร้างจะถูกทำเครื่องหมายว่าไม่เสถียร

ฉันจะทำให้เจนกินส์ทำเครื่องหมายบิลด์ว่าไม่เสถียรแทนที่จะเป็นเพียงความสำเร็จ / ล้มเหลวเมื่อเรียกใช้เชลล์สคริปต์ได้อย่างไร

ใช้ปลั๊กอินค้นหาข้อความ

แทนที่จะออกด้วยสถานะ 1 (ซึ่งจะล้มเหลวในการสร้าง) ให้ทำ:

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

กว่าในการดำเนินการหลังการสร้างจะเปิดใช้งาน Text Finder ให้ตั้งค่านิพจน์ทั่วไปให้ตรงกับข้อความที่คุณพิมพ์ ( TESTS FAILED!) และเลือกช่องทำเครื่องหมาย "ไม่เสถียรหากพบ" ใต้รายการนั้น

Modern Jenkins เวอร์ชัน (ตั้งแต่ 2.26 ตุลาคม 2559) แก้ไขสิ่งนี้ได้: เป็นเพียงตัวเลือกขั้นสูงสำหรับขั้นตอนการสร้างเชลล์ 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 เพื่อรวมสคริปต์บิลด์ของคุณและทำเครื่องหมายบิลด์ปัจจุบันเป็น UNSTABLE โดยใช้currentBuild.result = "UNSTABLE".

   เวที {
      สถานะ = / * คำสั่ง build ของคุณอยู่ที่นี่ * /
      ถ้า (สถานะ === "MARK-AS-UNSTABLE") {
        currentBuild.result = "UNSTABLE"
      }
   }

คุณควรจะสามารถใช้ groovy และทำสิ่งที่ textfinder ทำได้

ทำเครื่องหมายบิลด์ว่าไม่เสถียรด้วยปลั๊กอินโพสต์บิวด์ที่มีร่อง

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 Plugin

ในสคริปต์งานของฉันฉันมีข้อความต่อไปนี้ (งานนี้ทำงานบนอาจารย์เจนกินส์เท่านั้น):

# 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 build เพื่อสร้างรายงาน xml junit

   <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 ของรายงานการทดสอบ ปลั๊กอินนี้จะเปลี่ยน Stable build เป็น Unstable เมื่อการทดสอบล้มเหลว

   **/build/junit.xml
   

4. เพิ่มปลั๊กอินJenkins Text Finderด้วยการสแกนเอาต์พุตคอนโซลและตัวเลือกที่ไม่ได้เลือก ปลั๊กอินนี้ล้มเหลวทั้งโครงสร้างเนื่องจากข้อผิดพลาดร้ายแรง

   PHP Fatal error:
   

ฉันพบวิธีที่ยืดหยุ่นที่สุดในการทำเช่นนี้คือการอ่านไฟล์ในปลั๊กอินการสร้างโพสต์ที่น่าสนใจ

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 ใช้ได้ดีก็ต่อเมื่อสถานะงานไม่ได้เปลี่ยนจาก SUCCESS เป็น FAILED หรือ ABORTED ในกรณีเช่นนี้ให้ใช้สคริปต์ที่น่าสนใจในขั้นตอน 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}")
    }
  }
}

ตัวสร้างไวยากรณ์ไปป์ไลน์จะแสดงสิ่งนี้ให้คุณเห็นในแท็บขั้นสูง:

ฉันคิดว่าฉันจะโพสต์คำตอบอื่นสำหรับผู้ที่อาจกำลังมองหาสิ่งที่คล้ายกัน

ในงานสร้างของเราเรามีกรณีที่เราต้องการให้งานสร้างต่อไป แต่ถูกทำเครื่องหมายว่าไม่เสถียร สำหรับของเรามันเกี่ยวข้องกับหมายเลขเวอร์ชัน

ดังนั้นฉันจึงต้องการตั้งเงื่อนไขบนบิลด์และตั้งค่าการสร้างให้ไม่เสถียรหากตรงตามเงื่อนไขนั้น

ฉันใช้อ็อพชันConditional step (single)เป็นขั้นตอนการสร้าง

จากนั้นฉันใช้Execute system Groovy scriptเป็นขั้นตอนการสร้างที่จะทำงานเมื่อตรงตามเงื่อนไขนั้น

ฉันใช้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 ขนาดใหญ่
• ไม่มี kludges สำหรับการตั้งค่าและอ่านสถานะส่วนกลาง (ข้อความคอนโซลไฟล์ในพื้นที่ทำงาน)
• ไม่ต้องใช้ปลั๊กอิน (นอกจาก Groovy)
• ไม่จำเป็นต้องกำหนดค่าขั้นตอนการสร้างเพิ่มเติมที่ไม่จำเป็นในกรณี PASSED หรือ FAILURE

สำหรับโซลูชันนี้สภาพแวดล้อมของคุณต้องเป็นไปตามเงื่อนไขเหล่านี้:

• Jenkins REST API สามารถเข้าถึงได้จากทาส
• Slave ต้องมีสิทธิ์เข้าถึงข้อมูลประจำตัวที่อนุญาตให้เข้าถึง Jenkins Groovy script REST API

วิธีง่ายๆวิธีหนึ่งในการตั้งค่าบิลด์ให้ไม่เสถียรคือในบล็อก "execute shell" ของคุณเรียกใช้ exit 13

คุณสามารถเรียก "exit 1" ได้และการสร้างจะล้มเหลว ณ จุดนั้นและไม่ดำเนินการต่อ ฉันทำ passthrough make function เพื่อจัดการมันให้ฉันและโทรหา safemake แทน make for building:

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