jenkins2 0.1.0 → 1.0.0

data/lib/jenkins2/client/node_commands.rb

@@ -1,105 +0,0 @@
-require 'cgi'
-
-module Jenkins2
-	class Client
-		module NodeCommands
-			# Connects a node.
-			# +node+:: Node name, <tt>(master)</tt> for master.
-			def connect_node( node: '(master)' )
-				api_request( :post, "/computer/#{node}/launchSlaveAgent" )
-			end
-
-			# Creates a new node, by providing node definition XML.
-			# Keyword parameters:
-			# +node+:: Node name.
-			# +xml_config+:: New configuration in xml format.
-			def create_node( node: nil, xml_config: nil )
-				xml_config = STDIN.read if xml_config.nil?
-				api_request( :post, "/computer/doCreateItem", :raw ) do |req|
-					req.form_data = { 'name' => node, type: "hudson.slaves.DumbSlave$DescriptorImpl",
-						json: {}.to_json }
-				end
-				update_node( node: node, xml_config: xml_config )
-			end
-			
-			# Deletes a node
-			# +node+:: Node name. Master cannot be deleted.
-			def delete_node( node: nil )
-				raise ArgumentError, 'node must be provided' if node.nil?
-				api_request( :post, "/computer/#{node}/doDelete" )
-			end
-
-			# Disconnects a node.
-			# +node+:: Node name, <tt>(master)</tt> for master.
-			# +message+:: Reason why the node is being disconnected.
-			def disconnect_node( node: '(master)', message: nil )
-				api_request( :post, "/computer/#{node}/doDisconnect" ) do |req|
-					req.body = "offlineMessage=#{CGI::escape message}" unless message.nil?
-				end
-			end
-
-			# Returns the node definition XML.
-			# +node+:: Node name, <tt>(master)</tt> for master.
-			def get_node_xml( node: '(master)' )
-				api_request( :get, "/computer/#{node}/config.xml", :body )
-			end
-			
-			# Returns the node state
-			# +node+:: Node name, <tt>(master)</tt> for master.
-			def get_node( node: '(master)' )
-				api_request( :get, "/computer/#{node}/api/json" )
-			end
-
-			# Sets node temporarily offline. Does nothing, if node is already offline.
-			# +node+:: Node name, or <tt>(master)</tt> for master.
-			# +message+:: Record the note about this node is being disconnected.
-			def offline_node( node: '(master)', message: nil )
-				if node_online?( node: node )
-					api_request( :post, "/computer/#{node}/toggleOffline" ) do |req|
-						req.body = "offlineMessage=#{CGI::escape message}" unless message.nil?
-					end
-				end
-			end
-
-			# Sets node back online, if node is temporarily offline.
-			# +node+:: Node name, <tt>(master)</tt> for master.
-			def online_node( node: '(master)' )
-				api_request( :post, "/computer/#{node}/toggleOffline" ) unless node_online?( node: node )
-			end
-
-			# Updates the node definition XML
-			# Keyword parameters:
-			# +node+:: Node name, <tt>(master)</tt> for master.
-			# +xml_config+:: New configuration in xml format.
-			def update_node( node: '(master)', xml_config: nil )
-				xml_config = STDIN.read if xml_config.nil?
-				api_request( :post, "/computer/#{node}/config.xml", :body ) do |req|
-					req.body = xml_config
-				end
-			end
-
-			# Waits for node to become idle or until +max_wait_minutes+ pass.
-			# +node+:: Node name, <tt>(master)</tt> for master.
-			# +max_wait_minutes+:: Maximum wait time in minutes. Default 60.
-			def wait_node_idle( node: '(master)', max_wait_minutes: 60 )
-				Jenkins2::Wait.wait( max_wait_minutes: max_wait_minutes ){ node_idle? node: node }
-			end
-
-			def node_idle?( node: '(master)' )
-				get_node( node: node )['idle']
-			end
-
-			# Checks if node is online (= not temporarily offline )
-			# +node+:: Node name. Use <tt>(master)</tt> for master.
-			def node_online?( node: '(master)' )
-				!get_node( node: node )['temporarilyOffline']
-			end
-
-			# Checks if node is connected, i.e. Master connected and launched client on it.
-			# +node+:: Node name. Use <tt>(master)</tt> for master.
-			def node_connected?( node: '(master)' )
-				!get_node( node: node )['offline']
-			end
-		end
-	end
-end

data/lib/jenkins2/client/plugin_commands.rb

@@ -1,53 +0,0 @@
-module Jenkins2
-	class Client
-		module PluginCommands
-			# Installs plugins by short name (like +thinBackup+).
-			# +names+:: List of short names.
-			def install_plugins( *names )
-				api_request( :post, '/pluginManager/install' ) do |req|
-					req.form_data = names.flatten.inject({}) do |memo,obj|
-						memo.merge "plugin.#{obj}.default" => 'on'
-					end.merge( 'dynamicLoad' => 'Install without restart' )
-				end
-			end
-
-			# Installs a plugin by uploading *.hpi or *.jpi file.
-			# +plugin_file+:: A *.hpi or *.jpi file itself ( not some path )
-			def upload_plugin( plugin_file )
-				api_request( :post, '/pluginManager/uploadPlugin' ) do |req|
-					req.body = plugin_file
-					req.content_type = 'multipart/form-data'
-				end
-			end
-
-			# Lists installed plugins
-			def list_plugins
-				api_request( :get, '/pluginManager/api/json?depth=1' )['plugins']
-			end
-
-			# Checks, if all of the plugins from the passed list are installed
-			# +names+:: List of short names of plugins (like +thinBackup+).
-			def plugins_installed?( *names )
-				plugins = list_plugins
-				return false if plugins.nil?
-				names.flatten.all? do |name|
-					plugins.detect{|p| p['shortName'] == name and !p['deleted'] }
-				end
-			end
-
-			# Uninstalls a plugin
-			# +name+:: Plugin short name
-			def uninstall_plugin( name )
-				api_request( :post, "/pluginManager/plugin/#{name}/doUninstall" ) do |req|
-					req.form_data = { 'Submit' => 'Yes', 'json' => '{}' }
-				end
-			end
-
-			def wait_plugins_installed( *names, max_wait_minutes: 2 )
-				Wait.wait( max_wait_minutes: max_wait_minutes ) do
-					plugins_installed? names
-				end
-			end
-		end
-	end
-end

data/lib/jenkins2/cmdparse.rb

@@ -1,51 +0,0 @@
-require 'optparse'
-
-module Jenkins2
-	class CommandParser < OptionParser
-		attr_reader :command_name
-
-		def command( key, desc, &block )
-			sw = OptionParser::Switch::NoArgument.new( key, nil, [key], nil, nil, [desc],
-				Proc.new{ OptionParser.new( &block ) } ), [], [key]
-			commands[key.to_s] = sw[0]
-		end
-
-		def parse!( argv=default_argv )
-			@command_name = argv.detect{|c| commands.has_key? c }
-			if command_name
-				#create temporary parser with option definitions from both: globalparse and subparse
-				OptionParser.new do |parser|
-					parser.instance_variable_set(:@stack,
-						commands[command_name.to_s].block.call.instance_variable_get(:@stack) + @stack)
-				end.parse! argv
-			else
-				super( argv )
-			end
-		end
-
-		def commands
-			@commands ||= {}
-		end
-
-		private
-		def summarize(to = [], width = @summary_width, max = width - 1, indent = @summary_indent, &blk)
-			super(to, width, max, indent, &blk)
-			if command_name and commands.has_key?( command_name )
-				to << "Command:\n"
-				commands[command_name].summarize( {}, {}, width, max, indent ) do |l|
-					to << (l.index($/, -1) ? l : l + $/)
-				end
-				to << "Command options:\n"
-				commands[command_name].block.call.summarize( to, width, max, indent, &blk )
-			else
-				to << "Commands:\n"
-				commands.each do |name, command|
-					command.summarize( {}, {}, width, max, indent ) do |l|
-						to << (l.index($/, -1) ? l : l + $/)
-					end
-				end
-			end
-			to
-		end
-	end
-end

data/lib/jenkins2/command_line.rb

@@ -1,221 +0,0 @@
-require 'optparse/uri'
-require_relative 'cmdparse'
-require_relative 'client'
-require_relative 'log'
-
-module Jenkins2
-	class CommandLine
-		attr_accessor :global_options
-		attr_accessor :command_options
-		
-		def initialize( args )
-			@global_options = OptionParser::OptionMap.new
-			@log_options = { verbose: 0, log: STDOUT }
-			@command_options = OptionParser::OptionMap.new
-			global = CommandParser.new 'Usage: jenkins [global-options] <command> [options]' do |opts|
-				opts.separator ''
-				opts.separator "Global options (accepted by all commands):"
-				opts.on '-s', '--server URL', ::URI, 'Jenkins Server Url' do |opt|
-					@global_options[:server] = opt
-				end
-				opts.on '-u', '--user USER', 'Jenkins API user' do |opt|
-					@global_options[:user] = opt
-				end
-				opts.on '-k', '--key KEY', 'Jenkins API key' do |opt|
-					@global_options[:key] = opt
-				end
-				opts.on '-c', '--config [PATH]', 'Use configuration file. Instead of providing '\
-					'server, user and key through command line, you can do that with configuration file. '\
-					'File format is json: { "server": "http://jenkins.example.com", "user": "admin", '\
-					'"key": "123456" }. Options provided in command line will overwrite ones from '\
-					'configuration file. Program looks for ~/.jenkins2.json if no PATH is provided.' do |opt|
-					@global_options[:config] = opt || ::File.join( ENV['HOME'], '.jenkins2.json' )
-				end
-				opts.on '-l', '--log FILE', 'Log file. Prints to standard out, if not provided' do |opt|
-					@log_options[:log] = opt
-				end
-				opts.on '-v', '--verbose', 'Print more info. Up to -vvv. Prints only errors by default.' do
-					@log_options[:verbose] += 1
-				end
-				opts.on '-h', '--help', 'Show help' do
-					@global_options[:help] = true
-				end
-				opts.on '-V', '--version', 'Show version' do
-					puts VERSION
-					exit
-				end
-
-				opts.separator ''
-				opts.separator 'For command specific options run: jenkins2 --help <command>'
-				opts.separator ''
-				opts.command 'version', 'Outputs the current version of Jenkins'
-				opts.command 'prepare-for-shutdown', 'Stop executing new builds, so that the system can '\
-					'be eventually shut down safely.'
-				opts.command 'cancel-shutdown', 'Cancel the effect of "prepare-for-shutshow" command.'
-				opts.command 'wait-nodes-idle', 'Wait for all nodes to become idle. Is expected to be '\
-					'called after "prepare_for_shutdown", otherwise new builds will still be run.' do |cmd|
-					cmd.on '-m', '--max-wait-minutes INT', Integer, 'Wait for INT minutes at most. '\
-						'Default 60' do |opt|
-						@command_options[:max_wait_minutes] = opt
-					end
-				end
-				opts.command 'offline-node', 'Stop using a node for performing builds temporarily, until '\
-					'the next "online-node" command.' do |cmd|
-					cmd.on '-n', '--node NAME', 'Name of the node or empty for master' do |opt|
-						@command_options[:node] = opt
-					end
-					cmd.on '-m', '--message MESSAGE', 'Record the note about why you are '\
-						'disconnecting this node' do |opt|
-						@command_options[:message] = opt
-					end
-				end
-				opts.command 'online-node', 'Resume using a node for performing builds, to cancel out '\
-					'the earlier "offline-node" command.' do |cmd|
-					cmd.on '-n', '--node [NAME]', 'Name of the node or empty for master' do |opt|
-						@command_options[:node] = opt
-					end
-				end
-				opts.command 'connect-node', 'Connects a node, i.e. starts Jenkins slave on a node.' do |cmd|
-					cmd.on '-n', '--node [NAME]', 'Name of the node or empty for master' do |opt|
-						@command_options[:node] = opt
-					end
-				end
-				opts.command 'create-node', 'Creates a new node from XML' do |cmd|
-					cmd.on '-n', '--node NAME', 'Name of the new node' do |opt|
-						@command_options[:node] = opt
-					end
-					cmd.on '-x', '--xml FILE', 'Path to XML configuration file' do |opt|
-						@command_options[:xml] = IO.read opt
-					end
-				end
-				opts.command 'delete-node', 'Deletes a node' do |cmd|
-					cmd.on '-n', '--node NAME', 'Node name' do |opt|
-						@command_options[:node] = opt
-					end
-				end
-				opts.command 'create-credential', 'Creates credential.' do |cmd|
-					cmd.on '-S', '--scope SCOPE', 'GLOBAL or SYSTEM scope' do |opt|
-						@command_options[:scope] = opt
-					end
-					cmd.on '-i', '--id ID', 'Unique Id of credential. Will be generated automactically, if '\
-						'not provided' do |opt|
-						@command_options[:id] = opt
-					end
-					cmd.on '-d', '--description DESC', 'Human readable text, what this credential is used for.' do |opt|
-						@command_options[:description] = opt
-					end
-					cmd.on '-n', '--username NAME', 'Username for Username-Password or SSH credential' do |opt|
-						@command_options[:username] = opt
-					end
-					cmd.on '-p', '--password PASS', 'Password in plain text for Username-Password credential' do |opt|
-						@command_options[:password] = opt
-					end
-					cmd.on '-f', '--private-key FILE', 'Path to private key file for SSH credential' do |opt|
-						@command_options[:private_key] = IO.read( opt ).gsub( "\n", "\\n" )
-					end
-					cmd.on '-P', '--passphrase PHRASE', 'Passphrase for the private key for SSH credential' do |opt|
-						@command_options[:passphrase] = opt
-					end
-					cmd.on '-e', '--secret SECRET', 'Some secret text for Secret credential' do |opt|
-						@command_options[:secret] = opt
-					end
-					cmd.on '-F', '--secret-file FILE', 'Path to secret file for Secret File credential' do |opt|
-						@command_options[:filename] = File.basename opt
-						@command_options[:content] = IO.read opt
-					end
-				end
-				opts.command 'delete-credential', 'Deletes credential.' do |cmd|
-					cmd.on '-i', '--id ID', 'Credential id' do |opt|
-						@command_options[:id] = opt
-					end
-				end
-				opts.command 'get-credential', 'Returns credential as json.' do |cmd|
-					cmd.on '-i', '--id ID', 'Credential id' do |opt|
-						@command_options[:id] = opt
-					end
-				end
-				opts.command 'list-credentials', 'Lists all credentials.'
-				opts.command 'disconnect-node', 'Disconnects a node.' do |cmd|
-					cmd.on '-n', '--node [NAME]', 'Name of the node or empty for master' do |opt|
-						@command_options[:node] = opt
-					end
-					cmd.on '-m', '--message MESSAGE', 'Reason, why the node is being disconnected.' do |opt|
-						@command_options[:message] = opt
-					end
-				end
-				opts.command 'wait-node-idle', 'Wait for the node to become idle. Make sure you run '\
-					'"offline-node" first.' do |cmd|
-					cmd.on '-n', '--node [NAME]', 'Name of the node or empty for master' do |opt|
-						@command_options[:node] = opt
-					end
-					cmd.on '-m', '--max-wait-minutes INT', Integer, 'Wait for INT minutes at most. '\
-						'Default 60' do |opt|
-						@command_options[:max_wait_minutes] = opt
-					end
-				end
-				opts.command 'get-node-xml', 'Returns the node definition XML.' do |cmd|
-					cmd.on '-n', '--node [NAME]', 'Name of the node or empty for master' do |opt|
-						@command_options[:node] = opt
-					end
-				end
-				opts.command 'get-node', 'Returns the node state.' do |cmd|
-					cmd.on '-n', '--node [NAME]', 'Name of the node or empty for master' do |opt|
-						@command_options[:node] = opt
-					end
-				end
-				opts.command 'update-node', 'Updates the node definition XML from stdin or file.' do |cmd|
-					cmd.on '-n', '--node [NAME]', 'Name of the node or empty for master' do |opt|
-						@command_options[:node] = opt
-					end
-					cmd.on '-x', '--xml-config FILE', 'File to read definition from. Omit this to read from stdin' do |opt|
-						@command_options[:xml_config] = IO.read( opt )
-					end
-				end
-				opts.command 'build', 'Starts a build.' do |cmd|
-					cmd.on '-j', '--job NAME', 'Name of the job' do |opt|
-						@command_options[:job] = opt
-					end
-					cmd.on '-p', '--params KEY=VALUE[,KEY=VALUE...]', Array, 'Build parameters, where keys are'\
-						' names of variables' do |opt|
-						@command_options[:params] = opt.collect{|i| i.split( '=', 2 ) }.to_h
-					end
-				end
-				opts.command 'install-plugin', 'Installs a plugin from url or by short name. '\
-					'Provide either --url or --name.' do |cmd|
-					cmd.on '-u', '--uri URI', ::URI, 'Uri to install plugin from.' do |opt|
-						@command_options[:uri] = opt
-					end
-					cmd.on '-n', '--name SHORTNAME', 'Plugin short name (like thinBackup).' do |opt|
-						@command_options[:name] = opt
-					end
-				end
-				opts.command 'list-plugins', 'Lists installed plugins'
-			end
-			begin
-				global.parse!( args )
-				@global_options[:command] = global.command_name
-				if @global_options[:config]
-					from_file = JSON.parse( IO.read( @global_options[:config] ), symbolize_names: true )
-					@global_options = from_file.merge( @global_options )
-				end
-				Log.init @log_options
-				if @global_options[:help]
-					Log.unknown { global.help }
-					exit
-				end
-				raise OptionParser::MissingArgument, :command unless @global_options[:command]
-			rescue OptionParser::InvalidOption, OptionParser::MissingArgument => e
-				Log.fatal { e.message }
-				Log.fatal { global.help }
-				exit 1
-			end
-			Log.debug { "Options: #{@global_options}\nUnparsed args: #{ARGV}" }
-		end
-
-		def run
-			jc = Client.new( @global_options )
-			jc.send( @global_options[:command].gsub( '-', '_' ), @command_options )
-		end
-	end
-end
-

data/lib/jenkins2/try.rb

@@ -1,36 +0,0 @@
-require 'net/http'
-
-require_relative 'log'
-
-module Jenkins2
-	module Try
-		# Tries a block several times, if raised exception is <tt>Net::HTTPFatalError</tt>,
-		# <tt>Errno::ECONNREFUSED</tt> or <tt>Net::ReadTimeout</tt>.
-		# +retries+:: Number of retries.
-		# +retry_delay+:: Seconds to sleep, before attempting next retry.
-		# +&block+:: Code to run inside <tt>retry</tt> loop.
-		#
-		# Returns the result of a block, if it eventually succeeded or throws the exception, thown by
-		# the block on last try.
-		#
-		# Note that this is both a method of module Try, so you can <tt>include Jenkins::Try</tt>
-		# into your classes so they have a #try method, as well as a module method, so you can call it
-		# directly as ::try().
-		def try( retries: 3, retry_delay: 5, &block )
-			yield
-		rescue Errno::ECONNREFUSED, Net::HTTPFatalError, Net::ReadTimeout => e
-			i ||= 0
-			unless ( i += 1 ) == retries
-				Log.warn { "Received error: #{e}." }
-				Log.warn { "Retry request in #{retry_delay} seconds." }
-				sleep retry_delay
-				retry
-			end
-			Log.error { "Received error: #{e}." }
-			Log.error { "Reached maximum number of retries (#{retries}). Give up." }
-			raise e
-		end
-
-		module_function :try
-	end
-end