web-dev-qa-db-ja.com

Jenkinsパイプライン内のMavenライフサイクル-責任を最適に分離する方法

Jenkins 2（宣言型）パイプラインとMavenを使用する場合、パイプライン内で物を整理して再利用可能で柔軟にする方法に常に問題があります。

一方では、パイプラインを次のような論理ステージに分離したいと思います。

pipeline
 {
  stages
   {
    stage('Clean') {}
    stage('Build') {}
    stage('Test') {}
    stage('Sanity check') {}
    stage('Documentation') {}
    stage('Deploy - Test') {}
    stage('Selenium tests') {}
    stage('Deploy - Production') {}
    stage('Deliver') {}
   }
 }

一方、私は一緒に走るメイブンを持っています

mvn clean deploy site

単に私はmavenを分割して

mvn clean
mvn deploy
mvn site

ただし、「デプロイ」には、

  • 検証
  • コンパイル
  • テスト
  • パッケージ
  • 確認
  • インストール
  • 展開する

だから私は次のようなことをする多くのパイプラインの例を見ました

sh 'mvn clean compile'

そして

sh 'mvn test'

その結果、検証とコンパイルのステップがもう一度繰り返され、このように「時間/リソース」が無駄になります。これは、

sh 'mvn surefire:test'

ライフサイクル全体を再度実行する代わりに。

だから私の質問は-ジェンキンスのパイプラインのステージとメイブンのライフサイクルのバランスをとるのに最適な方法はどれですか？私には2つの方法があります。

  1. Mavenライフサイクルをできるだけ多くのパイプラインステージに分割します。これにより、Jenkinsユーザーフィードバックが向上します（どのステージが失敗するかなどを確認します）。
  2. Mavenにすべてを実行させ、Jenkinsパイプラインを使用して、Mavenの結果（つまり、単体テスト結果の分析など）のみを処理します。

それとも、CI/CDプラクティスで何かを誤解しましたか？

mavenjenkinsjenkins-pipelinemaven-3maven-lifecycle
8
PowerStat

2か月後、バランスの取れたJenkinsパイプラインスクリプトは完成していませんが、WindowsとLinuxでは安定して動作しています。それは私が見た他の例の落とし穴を避けます。

ジェンキンスファイル

pipeline
 {
  agent any

  tools
   {
    maven 'Maven3'
    jdk 'JDK8'
   }

  options
   {
    buildDiscarder(logRotator(numToKeepStr: '4'))
    skipStagesAfterUnstable()
    disableConcurrentBuilds()
   }


  triggers
   {
    // MINUTE HOUR DOM MONTH DOW
    pollSCM('H 6-18/4 * * 1-5')
   }


  stages
   {
    stage('Clean')
     {
      steps
       {
        script
         {
          if (isUnix()) 
           {
            sh 'mvn --batch-mode clean'
           }
          else
           {
            bat 'mvn --batch-mode clean'
           }
         }
       }
     }

    stage('Build')
     {
      steps
       {
        script
         {
          if (isUnix()) 
           {
            sh 'mvn --batch-mode compile'
           }
          else
           {
            bat 'mvn --batch-mode compile'
           }
         }
       }
     }

    stage('UnitTests')
     {
      steps
       {
        script
         {
          if (isUnix()) 
           {
            sh 'mvn --batch-mode resources:testResources compiler:testCompile surefire:test'
           }
          else
           {
            bat 'mvn --batch-mode resources:testResources compiler:testCompile surefire:test'
           }
         }
       }
      post
       {
        always
         {
          junit testResults: 'target/surefire-reports/*.xml'
         }
       }
     }

    stage('Sanity check')
     {
      steps
       {
        script
         {
          if (isUnix()) 
           {
            sh 'mvn --batch-mode checkstyle:checkstyle pmd:pmd pmd:cpd com.github.spotbugs:spotbugs-maven-plugin:spotbugs'
           }
          else
           {
            bat 'mvn --batch-mode checkstyle:checkstyle pmd:pmd pmd:cpd com.github.spotbugs:spotbugs-maven-plugin:spotbugs'
           }
         }
       }
     }

    stage('Packaging')
     {
      steps
       {
        script
         {
          if (isUnix()) 
           {
            sh 'mvn --batch-mode jar:jar'
           }
          else
           {
            bat 'mvn --batch-mode jar:jar'
           }
         }
       }
     }

    stage('install local')
     {
      steps
       {
        script
         {
          if (isUnix()) 
           {
            sh 'mvn --batch-mode jar:jar source:jar install:install'
           }
          else
           {
            bat 'mvn --batch-mode jar:jar source:jar install:install' // maven-jar-plugin falseCreation default is false, so no doubled jar construction here, but required for maven-install-plugin internal data
           }
         }
       }
     }

    stage('Documentation')
     {
      steps
       {
        script
         {
          if (isUnix()) 
           {
            sh 'mvn --batch-mode site'
           }
          else
           {
            bat 'mvn --batch-mode site'
           }
         }
       }
      post
       {
        always
         {
          publishHTML(target: [reportName: 'Site', reportDir: 'target/site', reportFiles: 'index.html', keepAll: false])
         }
       }
     }

    stage('Deploy test')
     {
      steps
       {      
        script
         {
          if (isUnix()) 
           {
            // todo
           }
          else
           {
            bat returnStatus: true, script: 'sc stop Tomcat8'
            sleep(time:30, unit:"SECONDS")
            bat returnStatus: true, script: 'C:\\scripts\\clean.bat'
            bat returnStatus: true, script: 'robocopy "target" "C:\\Program Files\\Apache Software Foundation\\Tomcat 9.0\\webapps" Test.war'
            bat 'sc start Tomcat8'
            sleep(time:30, unit:"SECONDS")
           }
         }
       }
     }

    stage('Integration tests')
     {
      steps
       {
        script
         {
          if (isUnix()) 
           {
            sh 'mvn --batch-mode failsafe:integration-test failsafe:verify'
           }
          else
           {
            bat 'mvn --batch-mode failsafe:integration-test failsafe:verify'
           }
         }
       }
     }

   }

 }

うまくいけば、これは他の開発者にとって興味深いことです。

時間の経過とともに大幅に改善した場合は、ここで更新します。

Jenkinsfileとともにmaven pomも見たい人のために、githubで私の小さなサンプルプロジェクトを見てください： TemplateEngine

2
PowerStat

正解はないと思いますが、次の例はうまくいきました。

stage('Build and Unit Test') {
    mvn clean deploy -> with unit tests, without integration tests, deploy local

    deploy local:
    You can define in a maven profile the distributionManagement like:
    <distributionManagement>
        <repository>
            <id>localFile</id>
            <url>file:target/repository/</url>
        </repository>
        <snapshotRepository>
            <id>localFile</id>
            <url>file:target/repository/</url>
        </snapshotRepository>
    </distributionManagement>
}   

stage('Pre Integration Tests') {
    The binaries are now in target/repository.
    From there you can use the binaries as you like.
    Copy them to a server, deploy them on an application server, etc.
}

stage('Integration Tests') {
    maven failsafe:integration-test failsafe:verify
    Already all tests are compiled, just execute them and verify the result.
}

stage('Deploy to Binary Repository (Nexus, Artifactory, etc)') {
    Now if everything is ok, finally upload the Binaries.
    For that we use wagon-maven-plugin
    So from target/repository the files are uploaded to the Binary Repository.
}

これをまとめると、

  • 速く失敗する。単体テストにエラーがある場合->ビルドに失敗します。
  • 一度だけビルドします。テスト、展開/統合テスト、リポジトリへのアップロードなどに同じバイナリを使用します。
  • これにより、ステージは論理ユニットになり、エラーを探す場所を十分にフィードバックできます。
1
wirnse