fastlane-plugin-update_jenkins_build 0.1.4 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 97103e6d6d332d6f40d11e45175040bad3be978c
-  data.tar.gz: f168d93cff6a8217f9411255047c85cfe774ff58
+SHA256:
+  metadata.gz: dd94a14381f6b4065878242ccd53858e717e854015c7a8b8ba74746ee8f5831b
+  data.tar.gz: f0fc857b6e62148a95b9be4f7a9733f8ac178f25081a88f520fe49d2ad703b19
 SHA512:
-  metadata.gz: 50fabbb72666689bf4ed48a44ccbc74f7ae257719532a9f4185cb72e58ff66911fc1ef14b86756c5998d5ae148549fe3a063011a8d768e671240749c4b36a3c7
-  data.tar.gz: 6331ce118460695e45fb2949b3a5c3693a6cae686b8bfb54bc89906d07a00a3c3185fc8f7aad598841687b1303fc7a2cc005f32c2a29ffa8edc0b50e6e15764b
+  metadata.gz: ed102c9db15db0ccbc9d42f117dccaf7dc108773ec21c316b721713e1afb6576a4a71a5b0a1a16650fb16ae87683ea6228eed55e7c6cadbf2aaacee5d6b41545
+  data.tar.gz: bf8a574839dc58af1aa288a23d1bf75bac42024d3dc50d390192a70f3b7547ebf91bbd47dfd3de069226a53b86fca0d0c68ef5d544b27733db8d9b84b7bf2f8b

data/README.md

@@ -10,6 +10,15 @@ This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To
 fastlane add_plugin update_jenkins_build
 ```
 
+![screenshot](screenshot.png)
+
+### Configure Jenkins
+
+⚠️ **READ ME FRIST**
+
+Jenkins version below 2.221, you need disable CSRF Protection in Global Security Settings page or
+else you must append '-Dhudson.security.csrf.GlobalCrumbIssuerConfiguration.DISABLE_CSRF_PROTECTION=true' into Jenkins startup argument, [Check more details](https://github.com/icyleaf/fastlane-plugin-update_jenkins_build/issues/2).
+
 ## About update_jenkins_build
 
 Update build's description of jenkins.
@@ -22,6 +31,7 @@ $ bundle exec fastlane action update_jenkins_build
 | Key          | Description                                 | Env Var                           | Default |
 +--------------+---------------------------------------------+-----------------------------------+---------+
 | description  | the description of current build            | UPDATE_JENKINS_BUILD_DESCRIPTION  |         |
+| url          | the url of jenkins                          | UPDATE_JENKINS_BUILD_URL          |         |
 | project      | the name of project(job)                    | UPDATE_JENKINS_BUILD_PROJECT      |         |
 | build_number | the build number of project(job)            | UPDATE_JENKINS_BUILD_BUILD_NUMBER |         |
 | user         | the user of jenkins if enabled security     | UPDATE_JENKINS_BUILD_USER         |         |
@@ -31,7 +41,7 @@ $ bundle exec fastlane action update_jenkins_build
 +-----------------------------------+
 | update_jenkins_build Return Value |
 +-----------------------------------+
-| ture/false                        |
+| [ture/false, response_body]       |
 +-----------------------------------+
 ```
 

data/lib/fastlane/plugin/update_jenkins_build/actions/update_jenkins_build_action.rb

@@ -1,5 +1,6 @@
 require 'fastlane/action'
 require_relative '../helper/update_jenkins_build_helper'
+require 'rubygems'
 require 'http'
 require 'uri'
 
@@ -9,49 +10,69 @@ module Fastlane
       def self.run(params)
         @user = params[:user]
         @password = params[:password]
+        @url = params[:url]
         @project = params[:project]
         @build_number = params[:build_number]
-        @description = params[:description]
+        @description = format_description(params[:description])
 
         url = "#{base_uri}/submitDescription"
-        res = if @user
+        res = if @user || @password
                 HTTP.basic_auth(user: @user, pass: @password)
                     .post(url, form: {description: @description})
               else
-                HTTP.post(url, form: {description: @description})
+                HTTP.post(url, form: {
+                  "description" => @description,
+                  "Jenkins-Crumb" => "234234234234234234" # random value
+                })
               end
 
-        result = res.status == 302 ? true : false
+        # Submit form succesed it will 302 to the build url.
+        result = res.code == 302 ? 'success' : "#{res.code} fail"
 
+        jenkins_version = Helper::UpdateJenkinsBuildHelper.jenkins_version(@url, @user, @password)
         params = {
           title: "Summary for update_jenkins_build #{UpdateJenkinsBuild::VERSION}".green,
           rows: {
-            result: (result ? 'success' : 'fail'),
+            jenkins_version: jenkins_version,
+            result: result,
             url: "#{base_uri}/editDescription",
             auth: @user ? true : false,
             description: @description,
           }
         }
 
-        puts ""
         puts Terminal::Table.new(params)
-        puts ""
 
-        result
+        if res.code != 302
+          UI.error "Detect `update_jenkins_build` ran fail."
+          if jenkins_version && Gem::Version.new(jenkins_version) > Gem::Version.new('2.221')
+            UI.error "Because Jenkins v#{jenkins_version} removed 'disable CSRF Protection' option since 2.222,"
+            UI.error "You need append '-Dhudson.security.csrf.GlobalCrumbIssuerConfiguration.DISABLE_CSRF_PROTECTION=true' into Jenkins startup argument."
+            UI.error "Please check https://github.com/icyleaf/fastlane-plugin-update_jenkins_build/issues/2"
+          else
+            UI.error "Please 'disable CSRF Protection' in 'Global Security Settings' page from Jenkins."
+          end
+        end
+
+        [result, res.body]
+      end
+
+      def self.format_description(descripion)
+        descripion.gsub('\n', "\n")
       end
 
       def self.base_uri
-        uri = URI(ENV['JENKINS_URL'])
+        uri = URI(@url)
         uri.path = "/job/#{@project}/#{@build_number}"
         uri.to_s
       end
 
       def self.return_value
-        "ture/false"
+        "[ture/false, response_body]"
       end
 
       def self.return_type
-        :boolean
+        :array
       end
 
       def self.example_code
@@ -60,6 +81,7 @@ module Fastlane
             description: "AdHoc v1.0 (1.0.1)"
           )',
           'update_jenkins_build(
+            url: "http://127.0.0.1:8080/", # specify specific jenkins url
             project: "foobar", # specify specific project name
             build_number: 75, # specify specific build number
             description: "AdHoc v1.0 (1.0.1)",
@@ -76,6 +98,10 @@ module Fastlane
         "Update build's description of jenkins"
       end
 
+      def self.details
+        "MUST disable CSRF in Security configure"
+      end
+
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :description,
@@ -83,6 +109,12 @@ module Fastlane
                                description: "the description of current build",
                                   optional: false,
                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :url,
+                                  env_name: "UPDATE_JENKINS_BUILD_URL",
+                               description: "the url of jenkins",
+                             default_value: ENV['JENKINS_URL'],
+                                  optional: true,
+                                      type: String),
           FastlaneCore::ConfigItem.new(key: :project,
                                   env_name: "UPDATE_JENKINS_BUILD_PROJECT",
                                description: "the name of project(job)",

data/lib/fastlane/plugin/update_jenkins_build/helper/update_jenkins_build_helper.rb

@@ -5,11 +5,17 @@ module Fastlane
 
   module Helper
     class UpdateJenkinsBuildHelper
-      # class methods that you define here become available in your action
-      # as `Helper::UpdateJenkinsBuildHelper.your_method`
-      #
-      def self.show_message
-        UI.message("Hello from the update_jenkins_build plugin helper!")
+
+      def self.jenkins_version(url, user, password)
+        url = "#{url}/api/json"
+        res = if user && password
+                HTTP.basic_auth(user: user, pass: password)
+                    .get(url)
+              else
+                HTTP.get(url)
+              end
+
+        res.headers['X-Jenkins']
       end
     end
   end

data/lib/fastlane/plugin/update_jenkins_build/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module UpdateJenkinsBuild
-    VERSION = "0.1.4"
+    VERSION = "0.3.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-update_jenkins_build
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.3.1
 platform: ruby
 authors:
 - icyleaf
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-01-26 00:00:00.000000000 Z
+date: 2022-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -164,7 +164,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email: icyleaf.cn@gmail.com
 executables: []
 extensions: []
@@ -180,7 +180,7 @@ homepage: https://github.com/icyleaf/fastlane-plugin-update_jenkins_build
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -195,9 +195,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Update Description of Build
 test_files: []