jenkins-peace 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 83adb7855da16bf2491e373d1f1a63eb7246ace0
+  data.tar.gz: 68800057f45f6e45ffc3a3b66d6a85ff1ac008c1
+SHA512:
+  metadata.gz: b4259c305059ff23b05ef402e3db85c98cc2ac806a01052a41c5d021a968779d27c5cc38cfecf9a20eed5fdfb3f6d6bcf87e30df44959c6849c85e1e94b544aa
+  data.tar.gz: f8b7108210e1ddb0426f863eab337689b31598fe17cf036b995a8c483b1b4adc032205d47a9c0f9807345e14c06cefeec2e2e54295c3bb0803ca884125f65187

data/.gitignore

@@ -0,0 +1,3 @@
+/*.gem
+/*.lock
+/coverage

data/.pullreview.yml

@@ -0,0 +1,8 @@
+---
+rules:
+  ignore:
+  - extra_blank_line_detected
+  - missing_class_documentation
+  - missing_method_documentation
+  - use_a_logger
+  - reduce_number_of_params

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+sudo: false
+cache: bundler
+script: bundle exec rake spec
+rvm:
+  - 2.3.1
+  - 2.2.5
+  - jruby-1.7.20
+  - jruby-9.0.5.0
+env:
+  global:
+    - JRUBY_OPTS="--debug"

data/AUTHORS

@@ -0,0 +1,2 @@
+Charles Lowell <cowboyd@thefrontside.net>
+Nicolas Rodriguez <nrodriguez@jbox-web.com>

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## CHANGELOG
+
+### 1.0.0 - 2015-09-19
+
+First release!

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'codeclimate-test-reporter', require: false
+  gem 'pullreview-coverage',       require: false
+end

data/LICENSE

@@ -0,0 +1,19 @@
+The MIT License (MIT)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+## Jenkins ~~War~~ Peace
+
+[![GitHub license](https://img.shields.io/github/license/jbox-web/jenkins-peace.svg)](https://github.com/jbox-web/jenkins-peace/blob/master/LICENSE)
+[![GitHub release](https://img.shields.io/github/release/jbox-web/jenkins-peace.svg)](https://github.com/jbox-web/jenkins-peace/releases/latest)
+[![Gem](https://img.shields.io/gem/v/jenkins-peace.svg)](https://rubygems.org/gems/jenkins-peace/versions/1.0.0)
+[![Gem](https://img.shields.io/gem/dtv/jenkins-peace.svg)](https://rubygems.org/gems/jenkins-peace/versions/1.0.0)
+[![Build Status](https://travis-ci.org/jbox-web/jenkins-peace.svg?branch=master)](https://travis-ci.org/jbox-web/jenkins-peace)
+[![Code Climate](https://codeclimate.com/github/jbox-web/jenkins-peace/badges/gpa.svg)](https://codeclimate.com/github/jbox-web/jenkins-peace)
+[![Test Coverage](https://codeclimate.com/github/jbox-web/jenkins-peace/badges/coverage.svg)](https://codeclimate.com/github/jbox-web/jenkins-peace/coverage)
+[![Dependency Status](https://gemnasium.com/jbox-web/jenkins-peace.svg)](https://gemnasium.com/jbox-web/jenkins-peace)
+[![PullReview stats](https://www.pullreview.com/github/jbox-web/jenkins-peace/badges/master.svg?)](https://www.pullreview.com/github/jbox-web/jenkins-peace/reviews/master)
+
+### A small console application to manage Jenkins war files, easy, and in peace ;)
+
+This gem aims to replace [jenkins-war](https://rubygems.org/gems/jenkins-war/versions/1.514) to manage Jenkins war files.
+
+The previous version of this gem used to embed the war file directly in the GitHub repo which could lead to very long download time.
+
+This one uses a cache directory to store Jenkins war files (```/<home directory>/.jenkins/war-files```).
+
+
+## Installation
+
+```ruby
+gem install jenkins-peace
+```
+
+No need to add it to your Gemfile, it will be globally available.
+
+## Usage
+
+```sh
+Commands:
+  jenkins.peace clean               # Remove all war files
+  jenkins.peace download <version>  # Download war file corresponding to version passed in params
+  jenkins.peace help [COMMAND]      # Describe available commands or one specific command
+  jenkins.peace infos               # Display infos about this gem
+  jenkins.peace install <version>   # Install war file corresponding to version passed in params (will download then unpack war file)
+  jenkins.peace latest              # Display infos about the latest version of war file installed
+  jenkins.peace list                # List war files installed
+  jenkins.peace remove <version>    # Remove war file corresponding to version passed in params
+  jenkins.peace server <version>    # Start a server with the war file corresponding to version passed in params
+  jenkins.peace unpack <version>    # Unpack war file corresponding to version passed in params
+```
+
+## Example
+
+```sh
+nicolas@desktop:~$ jenkins.peace list
++------------------+-------------------------------------------------------+-------------------------------------------------------------------------+-------------+
+|  Version         |  Location                                             |  Classpath                                                              |  Installed  |
++------------------+-------------------------------------------------------+-------------------------------------------------------------------------+-------------+
+|  latest (1.629)  |  /home/nicolas/.jenkins/war-files/latest/jenkins.war  |  /home/nicolas/.jenkins/wars/latest/WEB-INF/lib/jenkins-core-1.629.jar  |  true       |
+|  1.628           |  /home/nicolas/.jenkins/war-files/1.628/jenkins.war   |  /home/nicolas/.jenkins/wars/1.628/WEB-INF/lib/jenkins-core-1.628.jar   |  true       |
++------------------+-------------------------------------------------------+-------------------------------------------------------------------------+-------------+
+```
+
+## Contributors
+
+A big thank to [them](https://github.com/jbox-web/jenkins-peace/blob/master/AUTHORS) for their contribution!
+
+## Contribute
+
+You can contribute to this plugin in many ways such as :
+
+* Helping with documentation
+* Contributing code (features or bugfixes)
+* Reporting a bug
+* Submitting translations

data/Rakefile

@@ -0,0 +1,28 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rspec/core/rake_task'
+
+desc 'Start unit tests'
+task test: :spec
+task :spec do
+  RSpec::Core::RakeTask.new(:spec) do |config|
+    config.rspec_opts = '--color'
+  end
+  Rake::Task['spec'].invoke
+end
+
+desc 'Install latest Jenkins war file'
+task default: :prepare
+task :prepare do
+  begin
+    require 'bundler/setup'
+    require 'jenkins_peace'
+    Jenkins::Peace::ConsoleLogger.new().info("Installing Jenkins war file version : 'latest'")
+    Jenkins::Peace.install('latest')
+    Jenkins::Peace::ConsoleLogger.new().info('Done !')
+  rescue
+    puts "Failed to install Jenkins war, you'll have to install it yourself with 'jenkins.peace install <version>'"
+  end
+end

data/bin/jenkins.peace

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'jenkins_peace'
+
+Jenkins::Peace::CLI.start(ARGV)

data/jenkins-peace.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'jenkins/peace/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'jenkins-peace'
+  s.version     = Jenkins::Peace::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Nicolas Rodriguez']
+  s.email       = ['nrodriguez@jbox-web.com']
+  s.homepage    = 'http://jbox-web.github.io/jenkins-peace/'
+  s.summary     = %q{Fetch and use a specific Jenkins version with Rubygems}
+  s.description = %q{Download and install a specific version of the Jenkins war file which can be used for either running a server, or for plugin development}
+  s.license     = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.extensions    = ['Rakefile']
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'rake'
+  s.add_runtime_dependency 'thor'
+  s.add_runtime_dependency 'tty-table'
+  s.add_runtime_dependency 'ruby-progressbar'
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'simplecov'
+end

data/lib/jenkins/peace.rb

@@ -0,0 +1,133 @@
+require 'pathname'
+
+module Jenkins
+  module Peace
+    extend self
+
+    def jenkins_war_url
+      'http://mirrors.jenkins-ci.org/war/'
+    end
+
+
+    def base_path
+      File.join(ENV['HOME'], '.jenkins')
+    end
+
+
+    def war_files_cache
+      File.join(base_path, 'war-files')
+    end
+
+
+    def war_unpacked_cache
+      File.join(base_path, 'wars')
+    end
+
+
+    def server_path
+      File.join(base_path, 'server')
+    end
+
+
+    def infos
+      {
+        jenkins_war_url: jenkins_war_url,
+        base_path: base_path,
+        war_files_cache: war_files_cache,
+        war_unpacked_cache: war_unpacked_cache,
+        server_path: server_path
+      }
+    end
+
+
+    def latest_war_file
+      return nil if all_war_files_as_object.empty?
+      all_war_files_as_object.select { |f| f.installed? }.first
+    end
+
+
+    def latest_version
+      latest_war_file ? latest_war_file.classpath : nil
+    end
+
+
+    def list
+      all_war_files_as_object
+    end
+
+
+    def download(version, overwrite = false, url = nil)
+      war_file = build_war_file(version, url)
+      war_file = check_for_presence_and_execute(war_file, :download!, overwrite)
+      war_file
+    end
+
+
+    def install(version, overwrite = false, url = nil)
+      war_file = build_war_file(version, url)
+      war_file = check_for_presence_and_execute(war_file, :install!, overwrite)
+      war_file
+    end
+
+
+    def unpack(version, overwrite = false)
+      war_file = build_war_file(version)
+      war_file = check_for_presence_and_execute(war_file, :unpack!, overwrite)
+      war_file
+    end
+
+
+    def remove(version)
+      war_file = build_war_file(version)
+      war_file.remove! if war_file.exists?
+      war_file
+    end
+
+
+    def clean!
+      all_war_files_as_object.map(&:remove!)
+    end
+
+
+    def build_war_file(version, url = nil)
+      options = build_war_file_options
+      options = options.merge(base_url: url) unless url.nil?
+      WarFile.new(version, options)
+    end
+
+
+    def all_war_files
+      FileUtils.mkdir_p war_files_cache unless File.exists?(war_files_cache)
+      Pathname.new(war_files_cache).children.select { |c| c.directory? }
+    end
+
+
+    def check_for_presence_and_execute(war_file, method, overwrite = false)
+      if !war_file.exists?
+        war_file.send(method)
+      elsif war_file.exists? && overwrite
+        war_file.send(method)
+      end
+      war_file
+    end
+
+
+    private
+
+
+      def build_war_file_options
+        { base_url: jenkins_war_url, base_path: war_files_cache, lib_path: war_unpacked_cache, server_path: server_path, logger: ConsoleLogger.new }
+      end
+
+
+      def all_war_files_sorted
+        all_war_files.sort.reverse
+      end
+
+
+      def all_war_files_as_object
+        all_war_files_sorted.map { |f| build_war_file(File.basename(f)) }
+      end
+
+  end
+end

data/lib/jenkins/peace/cli.rb

@@ -0,0 +1,91 @@
+require 'tty-table'
+require 'thor'
+
+module Jenkins
+  module Peace
+    class CLI < Thor
+
+      include Jenkins::Peace::ThorExtensions
+
+      desc 'infos', 'Display infos about this gem'
+
+      def infos
+        say
+        table = TTY::Table.new rows: Jenkins::Peace.infos.to_a
+        puts table.render(:basic, padding: [0, 2])
+        say
+      end
+
+
+      desc 'latest', 'Display infos about the latest version of war file installed'
+
+      def latest
+        return warn 'No Jenkins war files installed' unless Jenkins::Peace.latest_version
+        info Jenkins::Peace.latest_version
+      end
+
+
+      desc 'list', 'List war files installed'
+
+      def list
+        return warn 'No Jenkins war files installed' if Jenkins::Peace.list.empty?
+        table = TTY::Table.new header: formated_headers, rows: formated_war_files_list
+        puts table.render(:ascii, padding: [0, 2])
+      end
+
+
+      desc 'download <version>', 'Download war file corresponding to version passed in params'
+
+      def download(version)
+        check_conflicts_and_call_method(:download, version)
+      end
+
+
+      desc 'unpack <version>', 'Unpack war file corresponding to version passed in params'
+
+      def unpack(version)
+        check_conflicts_and_call_method(:unpack, version, :unpacked?) do |war_file|
+          return download_it_first! unless war_file.exists?
+        end
+      end
+
+
+      desc 'install <version>', 'Install war file corresponding to version passed in params (will download then unpack war file)'
+
+      def install(version)
+        check_conflicts_and_call_method(:install, version)
+      end
+
+
+      desc 'remove <version>', 'Remove war file corresponding to version passed in params'
+
+      def remove(version)
+        Jenkins::Peace.remove(version)
+        success_message
+      end
+
+
+      desc 'clean', 'Remove all war files'
+
+      def clean
+        yes_no_question('Are you sure?') { Jenkins::Peace.clean! }
+      end
+
+
+      desc 'server <version>', 'Start a server with the war file corresponding to version passed in params'
+
+      method_option :home,    aliases: '-h', default: File.join(ENV['HOME'], '.jenkins', 'server'), type: :string, desc: 'Use this directory to store server data'
+      method_option :port,    aliases: '-p', default: 3001,  type: :numeric, desc: 'Port for server (default 3001)'
+      method_option :control, aliases: '-c', default: 3002,  type: :numeric, desc: 'Shutdown/Control port (default 3002)'
+      method_option :daemon,  aliases: '-d', default: false, type: :boolean, desc: 'Daemonize'
+      method_option :kill,    aliases: '-k', default: false, type: :boolean, desc: 'Kill'
+      method_option :logfile, aliases: '-l', default: File.join(Dir.pwd, 'jenkins.log'), type: :string, desc: 'Redirect log messages to this file'
+
+      def server(version)
+        war_file = Jenkins::Peace.build_war_file(version)
+        war_file.exists? ? war_file.start!(options) : download_it_first!
+      end
+
+    end
+  end
+end

data/lib/jenkins/peace/console_logger.rb

@@ -0,0 +1,34 @@
+module Jenkins
+  module Peace
+    class ConsoleLogger
+
+      RED    = "\e[31m"
+      GREEN  = "\e[32m"
+      YELLOW = "\e[33m"
+      CLEAR  = "\e[0m"
+
+      attr_reader :logger
+
+
+      def initialize(logger = $stdout)
+        @logger = logger
+      end
+
+
+      def info(message)
+        logger << "#{GREEN}#{message}#{CLEAR}\n"
+      end
+
+
+      def warn(message)
+        logger << "#{YELLOW}#{message}#{CLEAR}\n"
+      end
+
+
+      def error(message)
+        logger << "#{RED}#{message}#{CLEAR}\n"
+      end
+
+    end
+  end
+end