jenkins2 0.1.0 → 1.0.0

data/lib/jenkins2/cli/plugins.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require 'open-uri'
+
+module Jenkins2
+	class CLI
+		class InstallPlugin < CLI
+			def self.description
+				'Installs a plugin either from a file, an URL, standard input or from update center.'
+			end
+
+			private
+
+			def add_options
+				parser.on '-n', '--name SHORTNAME', 'Plugin short name (like thinBackup).' do |n|
+					options[:name] = n
+				end
+				parser.on '--source URI', 'If this points to a local file, it will be '\
+				'installed. If this is an URL, the file will be downloaded and installed. If it '\
+				'the "-" sting, the file will be read from standard input and "--name" must be '\
+				'specified.' do |s|
+					options[:source] = s
+				end
+			end
+
+			def run
+				case options[:source]
+				when nil, ''
+					jc.plugins.install options[:name]
+				when '-'
+					jc.plugins.upload(ARGF.read, options[:name])
+				else
+					open(options[:source], 'rb') do |f|
+						jc.plugins.upload(f.read, options[:name] || File.basename(options[:source]))
+					end
+				end
+			end
+		end
+
+		class ListPlugins < CLI
+			def self.description
+				'Lists all installed plugins.'
+			end
+
+			private
+
+			def run
+				jc.plugins(depth: 1).plugins.collect do |pl|
+					"#{pl.shortName} (#{pl.version})"
+				end.join("\n")
+			end
+		end
+
+		class UninstallPlugin < CLI
+			def self.description
+				'Uninstalls a plugin.'
+			end
+
+			private
+
+			def add_options
+				parser.separator 'Mandatory arguments:'
+				parser.on '-n', '--name SHORTNAME', 'Plugin short name (like thinBackup).' do |n|
+					options[:name] = n
+				end
+			end
+
+			def mandatory_arguments
+				super + [:name]
+			end
+
+			def run
+				jc.plugins.plugin(options[:name]).uninstall
+			end
+		end
+
+		class ShowPlugin < CLI
+			def self.description
+				'Show plugin info.'
+			end
+
+			private
+
+			def add_options
+				parser.separator 'Mandatory arguments:'
+				parser.on '-n', '--name SHORTNAME', 'Plugin short name (like thinBackup).' do |n|
+					options[:name] = n
+				end
+			end
+
+			def mandatory_arguments
+				super + [:name]
+			end
+
+			def run
+				pl = jc.plugins.plugin(options[:name]).subject
+				"#{pl.shortName} (#{pl.version}) - #{pl.longName}"
+			end
+		end
+	end
+end

data/lib/jenkins2/cli/root.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Jenkins2
+	class CLI
+		class SafeRestart < CLI
+			def self.description
+				'Safely restart Jenkins.'
+			end
+
+			private
+
+			def run
+				jc.restart
+			end
+		end
+
+		class Restart < CLI
+			def self.description
+				'Restart Jenkins.'
+			end
+
+			private
+
+			def run
+				jc.restart!
+			end
+		end
+
+		class QuietDown < CLI
+			def self.description
+				'Put Jenkins into the quiet mode, wait for existing builds to be completed.'
+			end
+
+			private
+
+			def run
+				jc.quiet_down
+			end
+		end
+
+		class CancelQuietDown < CLI
+			def self.description
+				'Cancel previously issued quiet-down command.'
+			end
+
+			private
+
+			def run
+				jc.cancel_quiet_down
+			end
+		end
+
+		class Version < CLI
+			def self.description
+				'Jenkins version.'
+			end
+
+			private
+
+			def run
+				jc.version
+			end
+		end
+	end
+end

data/lib/jenkins2/cli/user.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Jenkins2
+	class CLI
+		class WhoAmI < CLI
+			def self.description
+				'Reports your credentials.'
+			end
+
+			def run
+				r = jc.me.subject
+				%w[id fullName description].collect{|p| "#{p}: #{r[p]}" }.join "\n"
+			end
+		end
+	end
+end

data/lib/jenkins2/cli/view.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+module Jenkins2
+	class CLI
+		class CreateView < CLI
+			def self.description
+				'Creates a new view by reading stdin as a XML configuration.'
+			end
+
+			private
+
+			def add_options
+				parser.separator 'Mandatory arguments:'
+				parser.on '-n', '--name NAME', 'Name of the view.' do |n|
+					options[:name] = n
+				end
+			end
+
+			def mandatory_arguments
+				super + [:name]
+			end
+
+			def run
+				jc.view(options[:name]).create($stdin.read)
+			end
+		end
+
+		class DeleteView < CLI
+			def self.description
+				'Delete view(s).'
+			end
+
+			private
+
+			def add_options
+				parser.separator 'Mandatory arguments:'
+				parser.on '-n', '--name X,Y,..', Array, 'View names to delete.' do |n|
+					options[:name] = n
+				end
+			end
+
+			def mandatory_arguments
+				super + [:name]
+			end
+
+			def run
+				options[:name].all? do |name|
+					jc.view(name).delete
+				end
+			end
+		end
+
+		class GetView < CLI
+			def self.description
+				'Dumps the view definition XML to stdout.'
+			end
+
+			private
+
+			def add_options
+				parser.separator 'Mandatory arguments:'
+				parser.on '-n', '--name NAME', 'Name of the view.' do |n|
+					options[:name] = n
+				end
+			end
+
+			def mandatory_arguments
+				super + [:name]
+			end
+
+			def run
+				jc.view(options[:name]).config_xml
+			end
+		end
+
+		class UpdateView < CLI
+			def self.description
+				'Updates the view definition XML from stdin. The opposite of the get-view command.'
+			end
+
+			private
+
+			def add_options
+				parser.separator 'Mandatory arguments:'
+				parser.on '-n', '--name NAME', 'Name of the view.' do |n|
+					options[:name] = n
+				end
+			end
+
+			def mandatory_arguments
+				super + [:name]
+			end
+
+			def run
+				jc.view(options[:name]).update($stdin.read)
+			end
+		end
+
+		class AddJobToView < CLI
+			def self.description
+				'Adds jobs to view.'
+			end
+
+			private
+
+			def add_options
+				parser.separator 'Mandatory arguments:'
+				parser.on '-n', '--name NAME', 'Name of the view.' do |n|
+					options[:name] = n
+				end
+				parser.on '-j', '--job X,Y,..', Array, 'Job name(s) to add.' do |j|
+					options[:job] = j
+				end
+			end
+
+			def mandatory_arguments
+				super + %i[name job]
+			end
+
+			def run
+				options[:job].all? do |job|
+					jc.view(options[:name]).add_job(job)
+				end
+			end
+		end
+
+		class RemoveJobFromView < CLI
+			def self.description
+				'Removes jobs from view.'
+			end
+
+			private
+
+			def add_options
+				parser.separator 'Mandatory arguments:'
+				parser.on '-n', '--name NAME', 'Name of the view.' do |n|
+					options[:name] = n
+				end
+				parser.on '-j', '--job X,Y,..', Array, 'Job name(s) to remove.' do |j|
+					options[:job] = j
+				end
+			end
+
+			def mandatory_arguments
+				super + %i[name job]
+			end
+
+			def run
+				options[:job].all? do |job|
+					jc.view(options[:name]).remove_job(job)
+				end
+			end
+		end
+	end
+end

data/lib/jenkins2/connection.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'openssl'
+require 'json'
+
+module Jenkins2
+	class Connection
+		# Creates a "connection" to Jenkins.
+		# Parameter:
+		# +server+:: Jenkins Server URL.
+		def initialize(url)
+			@server = url
+			@crumb = nil
+		end
+
+		# Add basic auth to existing connection. Returns self.
+		# Parameters:
+		# +user+:: Jenkins API user.
+		# +key+:: Jenkins API key.
+		def basic_auth(user, key)
+			@user, @key = user, key
+			self
+		end
+
+		def get_json(path, params={}, &block)
+			get(::File.join(path, 'api/json'), params, &block)
+		end
+
+		def get(path, params={}, &block)
+			api_request(Net::HTTP::Get, build_uri(path, params), &block)
+		end
+
+		def head(path, params={}, &block)
+			api_request(Net::HTTP::Head, build_uri(path, params), &block)
+		end
+
+		def post(path, body=nil, params={}, &block)
+			headers = { 'Content-Type' => 'application/x-www-form-urlencoded' }
+			api_request(Net::HTTP::Post, build_uri(path, params), body, headers, &block)
+		end
+
+		def build_uri(relative_or_absolute, params={})
+			result = ::URI.parse relative_or_absolute
+			result = ::URI.parse ::File.join(@server.to_s, relative_or_absolute) unless result.absolute?
+			result.query = ::URI.encode_www_form params
+			result
+		end
+
+		def api_request(method, uri, body=nil, headers=nil)
+			req = method.new(URI(uri), headers)
+			req.basic_auth @user, @key if @user and @key
+			req.body = body
+			yield req if block_given?
+			Net::HTTP.start(req.uri.hostname, req.uri.port,
+				use_ssl: req.uri.scheme == 'https', verify_mode: OpenSSL::SSL::VERIFY_NONE) do |http|
+				begin
+					req[@crumb['crumbRequestField']] = @crumb['crumb'] if @crumb
+					Log.debug{ "Request uri: #{req.uri}" }
+					Log.debug{ "Request content_type: #{req.content_type}, body: #{req.body}" }
+					response = http.request req
+					handle_response response
+				rescue Jenkins2::NoValidCrumbMatcher
+					update_crumbs
+					retry
+				end
+			end
+		end
+
+		def update_crumbs
+			@crumb = JSON.parse(get_json('/crumbIssuer').body)
+		end
+
+		def handle_response(response)
+			Log.debug{ "Response: #{response.code}, #{response.body}" }
+			case response
+			when Net::HTTPNotFound
+				raise Jenkins2::NotFoundError, response
+			when Net::HTTPBadRequest
+				raise Jenkins2::BadRequestError, response
+			when Net::HTTPServiceUnavailable
+				raise Jenkins2::ServiceUnavailableError, response
+			when Net::HTTPClientError, Net::HTTPServerError # 4XX, 5XX
+				response.value
+			else
+				response
+			end
+		end
+	end
+end

data/lib/jenkins2/errors.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Jenkins2
+	class BadRequestError < Net::HTTPError
+		def initialize(res)
+			if res.body.nil? or res.body.empty?
+				super('', res)
+			elsif (match = res.body.match('<h1>Error</h1><p>(.*)</p>'))
+				super(match[1], res)
+			elsif (match = res.body.match('<h2>HTTP ERROR 404</h2>\n<p>(.*) Reason:'))
+				super(match[1], res)
+			end
+		end
+	end
+
+	class NotFoundError < Net::HTTPError
+		def initialize(res)
+			super(res.body.match('<h2>HTTP ERROR 404</h2>\n<p>(.*) Reason:')[1], res)
+		end
+	end
+
+	class ServiceUnavailableError < Net::HTTPError
+		def initialize(res)
+			if res.body.nil? or res.body.empty?
+				super('', res)
+			else
+				super(res.body.match('<h1[^>]*>\n\s+([^<]+)')[1], res)
+			end
+		end
+	end
+
+	class NoValidCrumbMatcher
+		def self.===(exception)
+			exception.message == '403 "No valid crumb was included in the request"'
+		end
+	end
+end