jenkins-plugin 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+.idea
+Gemfile.lock
+pkg/*
+target/

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in jenkins-plugins.gemspec
+gemspec

data/README.md

@@ -0,0 +1,16 @@
+# Jenkins plugins
+
+Provide the facility to create, develop and release extensions for [Jenkins](http://jenkins-ci.org) with nothing but knowledge of the language, tools and best practices of the Ruby community.
+
+[read more](http://blog.thefrontside.net/2011/05/12/what-it-take-to-bring-ruby-to-jenkins)...
+
+# Get started
+
+> This is all very theoretical. Don't try this at home.
+
+    $ gem install jenkins-plugins
+    $ jpi create my-awesome-jenkins-plugin
+    $ cd my-awesome-jenkins-plugin
+    $ jpi gen build_wrapper MyBuildWrapper
+    $ rake server
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+

data/bin/jpi

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'jpi/cli'
+
+JPI::CLI.start

data/features/create-new-plugin.feature

@@ -0,0 +1,90 @@
+
+Feature: Generating a new Jenkins Ruby Plugin
+
+Creating a new Ruby plugin for Jenkins needs to be as simple as running a single command
+that will generate a project skeleton. This skeleton will come complete with git repository and all
+the goodies that you need to do your plugin develompent.
+
+Background: Creating a brand new Jenkins Ruby Plugin
+  Given I've run "jenkins-plugin create newplugin"
+
+Scenario: The directory skeleton is generated
+  Then I should see this structure
+  """
+  [-] newplugin
+   | [+] .git
+   | .gitignore
+   | Gemfile
+   | Rakefile
+   | [-] lib
+   | [-] newplugin
+   |  |  | version.rb
+   |  | newplugin.rb
+   | [-] spec
+   |  | spec_helper.rb
+   | [-] plugin
+   |  | [+] models
+   |  | [+] views
+  """
+
+Scenario: The .gitignore contents
+  When I open ".gitignore"
+  Then I should see
+  """
+.bundle
+.rvmrc
+.rspec
+  """
+
+Scenario: The Gemfile contents
+  When I open "Gemfile"
+  Then I should see
+  """
+source :rubygems
+
+gem "jenkins-war"
+gem "jenkins-plugins"
+  """
+
+Scenario: The Rakefile contents
+  When I open "Rakefile"
+  Then I should see
+  """
+require 'jenkins/rake'
+Jenkins::Rake.install_tasks
+  """
+
+Scenario: The plugin module contents
+  When I open "lib/newplugin.rb"
+  Then I should see
+  """
+module Newplugin
+
+  def self.start
+    #do any startup when this plugin initializes
+  end
+
+  def self.stop
+    #perform any necessary cleanup when this plugin is shut down.
+  end
+end
+  """
+
+Scenario: The version file is generated
+  When I open "lib/newplugin/version.rb"
+  Then I should see
+  """
+
+module Newplugin
+  VERSION = 0.0.1
+end
+  """
+
+Scenario: The spec_helper is created
+  When I open "spec/spec_helper.rb"
+  Then I should see
+  """
+  $:.unshift(Pathname(__FILE__).dirname.join('../lib'))
+  require 'newplugin'
+  """
+

data/jenkins-plugin.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "jenkins/plugin/version"
+
+Gem::Specification.new do |s|
+  s.name        = "jenkins-plugin"
+  s.version     = Jenkins::Plugin::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Charles Lowell"]
+  s.email       = ["cowboyd@thefrontside.net"]
+  s.homepage    = "http://github.com/cowboyd/jenkins-plugin"
+  s.summary     = %q{Tools for creating and building Jenkins Ruby plugins}
+  s.description = %q{I'll think of a better description later, but if you're reading this, then I haven't}
+
+  s.rubyforge_project = "jenkins-plugin"
+
+  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.require_paths = ["lib"]
+
+  s.add_dependency "rubyzip"
+  s.add_dependency "thor"
+  s.add_dependency "jenkins-war", ">= 1.427"
+  s.add_dependency "bundler", ">= 1.1.pre.8"
+
+  s.add_development_dependency "rspec", "~> 2.0"
+  s.add_development_dependency "cucumber", "~> 1.0"
+end

data/lib/jenkins/plugin/tools/hpi.rb

@@ -0,0 +1,106 @@
+require 'zip/zip'
+require 'net/http'
+require 'uri'
+require 'fileutils'
+
+module Jenkins
+  class Plugin
+    module Tools
+      # class for parsing hpi file and its manifests
+      class Hpi
+        attr_reader :file, :manifest
+
+        # take the path name to the plugin file
+        def initialize(file)
+          @file = file
+
+          # load and parse manifests
+          Zip::ZipFile.open(@file) do |zip|
+            zip.get_input_stream("META-INF/MANIFEST.MF") do |m|
+              # main section of the manifest
+              @manifest = parse_manifest(m.read)[0]
+            end
+          end
+
+          # parse dependencies into hash
+          @dependencies = {}
+          deps = @manifest["Plugin-Dependencies"]
+          if deps
+            deps.split(",").each do |token|
+              token = token.gsub(/;.+/,"")  # trim off the optional portions
+              name,ver = token.split(":")
+              @dependencies[name] = ver
+            end
+          end
+        end
+
+        # given the plugin short name and the version number,
+        # return the path name of the .hpi file by either locating the plugin locally or downloading it.
+        def self.resolve(short_name,version)
+          # this is where we expect the retrieved file to be
+          cache = File.expand_path "~/.jenkins/cache/plugins/#{short_name}/#{version}/#{short_name}.hpi"
+
+          return cache if File.exists?(cache)
+
+          # now we start looking for places to find them
+
+          # is it in the local maven2 repository?
+          maven = File.expand_path "~/.m2/repository/org/jenkins-ci/plugins/#{short_name}/#{version}/#{short_name}-#{version}.hpi"
+          return maven if File.exists?(maven)
+
+          # download from the community update center
+          FileUtils.mkdir_p(File.dirname(cache))
+          open(cache+".tmp","wb") do |f|
+            puts "Downloading #{short_name} #{version}"
+            url = "https://updates.jenkins-ci.org/download/plugins/#{short_name}/#{version}/#{short_name}.hpi?for=ruby-plugin"
+             f.write fetch(url).body
+          end
+          FileUtils.mv cache+".tmp", cache
+
+          return cache
+        end
+
+        # download with redirect support
+        def fetch(uri, limit = 10)
+          # You should choose better exception.
+          raise ArgumentError, 'HTTP redirect too deep' if limit == 0
+
+          response = Net::HTTP.get_response(URI.parse(uri))
+          case response
+          when Net::HTTPSuccess     then response
+          when Net::HTTPRedirection then fetch(response['location'], limit - 1)
+          else
+            response.error!
+          end
+        end
+
+        # parse manifest file text into a hash
+        def parse_manifest(txt)
+          # separators
+          nl = /\r\n|\n|\r[^\n]/
+          secsep = /(#{nl}){2}/
+
+          txt.split(secsep).reject { |s| s.chomp.length==0 }.map do |section|
+            lines = []
+            section.split(nl).each do |line|
+              if line[0]==0x20
+                lines.last << line[1..-1] # continuation of the previous line
+              else
+                lines << line
+              end
+            end
+
+            # convert to hash
+            hash = {}
+            lines.each do |l|
+              (k,v) = l.split(/: /,2)
+              hash[k] = v
+            end
+
+            hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jenkins/plugin/tools/loadpath.rb

@@ -0,0 +1,29 @@
+module Jenkins
+  class Plugin
+    module Tools
+      class Loadpath
+        def initialize(*groups)
+          require 'bundler'
+          @groups = groups.empty? ? [:default] : groups
+        end
+
+        def to_path
+          to_a.join(File::PATH_SEPARATOR)
+        end
+
+        def to_a
+          [].tap do |paths|
+            specs = Bundler.definition.specs_for @groups.map {|g| g.to_sym}
+            for spec in specs
+              next if spec.name == "bundler"
+              for path in spec.require_paths
+                paths << File.join(spec.full_gem_path, path)
+              end
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/jenkins/plugin/version.rb

@@ -0,0 +1,5 @@
+module Jenkins
+  class Plugin
+    VERSION = "0.1.0"
+  end
+end

data/lib/jenkins/rake.rb

@@ -0,0 +1,140 @@
+require 'jenkins/plugin/version'
+require 'jenkins/plugin/tools/hpi'
+require 'jenkins/plugin/tools/loadpath'
+require 'zip/zip'
+
+module Jenkins
+  # given the IO handle, produce the basic manifest entries that are common between hpi and hpl formats
+  def self.generate_manifest(f)
+    f.puts "Manifest-Version: 1.0"
+    f.puts "Created-By: #{Jenkins::Plugin::VERSION}"
+    f.puts "Build-Ruby-Platform: #{RUBY_PLATFORM}"
+    f.puts "Build-Ruby-Version: #{RUBY_VERSION}"
+
+    f.puts "Group-Id: org.jenkins-ci.plugins"
+    f.puts "Short-Name: #{::PluginName}"
+    f.puts "Long-Name: #{::PluginName}" # TODO: better name
+    f.puts "Url: http://jenkins-ci.org/" # TODO: better value
+    # f.puts "Compatible-Since-Version:"
+    f.puts "Plugin-Class: ruby.RubyPlugin"
+    f.puts "Plugin-Version: #{::PluginVersion}"
+    f.puts "Jenkins-Version: 1.426"
+
+    f.puts "Plugin-Dependencies: " + ::PluginDeps.map{|k,v| "#{k}:#{v}"}.join(",")
+    # f.puts "Plugin-Developers:"
+  end
+
+
+  class Rake
+    def self.install_tasks
+      self.new.install
+    end
+
+    include ::Rake::DSL if defined? ::Rake::DSL
+
+    def install
+      desc "Directory used as JENKINS_HOME during 'rake server'"
+      directory work = "work"
+
+      desc "remove built artifacts"
+      task :clean do
+        sh "rm -rf pkg"
+        sh "rm -rf vendor"
+      end
+
+      # verify that necessary metadata constants are defined
+      task :verify_constants do
+        ["PluginName","PluginVersion"].each do |n|
+          fail("Constant #{n} is not defined") unless Object.const_defined?(n)
+        end
+      end
+
+      desc "output the development servers loadpath"
+      task :loadpath do
+        loadpath = Jenkins::Plugin::Tools::Loadpath.new(:default)
+        puts loadpath.to_path
+      end
+
+      directory target = "pkg"
+      desc "bundle gems"
+      task :bundle => [target] do
+        require 'java'
+        require 'bundler'
+        require 'bundler/cli'
+
+        puts "bundling..."
+        ENV['BUNDLE_APP_CONFIG'] = "#{target}/vendor/bundle"
+        Bundler::CLI.start ["--standalone", "--path", "#{target}/vendor/gems", "--without", "development"]
+      end
+
+      desc "package up stuff into HPI file"
+      task :package => [:verify_constants, target, :bundle] do
+
+        file_name = "#{target}/#{::PluginName}.hpi"
+        File.delete file_name if File.exists?(file_name)
+
+        Zip::ZipFile.open(file_name, Zip::ZipFile::CREATE) do |zipfile|
+          zipfile.get_output_stream("META-INF/MANIFEST.MF") do |f|
+            Jenkins.generate_manifest(f)
+            f.puts "Bundle-Path: vendor/gems"
+          end
+          zipfile.mkdir("WEB-INF/classes")
+
+          ["lib","models","views", "#{target}/vendor"].each do |d|
+            Dir.glob("#{d}/**/*") do |f|
+              if !File.directory? f
+                zipfile.add("WEB-INF/classes/#{f.gsub("#{target}/",'')}",f)
+              end
+            end
+          end
+        end
+        puts "#{::PluginName} plugin #{::PluginVersion} built to #{file_name}"
+      end
+
+      desc "resolve dependency plugins into #{work}/plugins"
+      task :'resolve-dependency-plugins' => [work] do
+        FileUtils.mkdir_p("#{work}/plugins")
+
+        puts "Copying plugin dependencies into #{work}/plugins"
+        ::PluginDeps.each do |short_name,version|
+          FileUtils.cp Jenkins::Plugin::Tools::Hpi::resolve(short_name,version), "#{work}/plugins/#{short_name}.hpi", :verbose=>true
+        end
+      end
+
+      desc "run a Jenkins server with this plugin"
+      task :server => :'resolve-dependency-plugins' do
+        require 'jenkins/war'
+        require 'zip/zip'
+        require 'fileutils'
+
+        loadpath = Jenkins::Plugin::Tools::Loadpath.new
+
+        # generate the plugin manifest
+        FileUtils.mkdir_p("#{work}/plugins")
+        File.open("#{work}/plugins/#{::PluginName}.hpl",mode="w+") do |f|
+          Jenkins.generate_manifest f
+
+          # f.puts "Libraries: "+["lib","models","pkg/vendor"].collect{|r| Dir.pwd+'/'+r}.join(",")
+          # TODO: where do we put views?
+          # TODO: where do we put static resources?
+          f.puts "Load-Path: #{loadpath.to_a.join(':')}"
+          f.puts "Resource-Path: #{Dir.pwd}/views"
+          f.puts "Lib-Path: #{Dir.pwd}/lib/"
+          f.puts "Models-Path: #{Dir.pwd}/models"
+        end
+
+        # TODO: assemble dependency plugins
+
+        # execute Jenkins
+        args = []
+        args << "java"
+        args << "-Xrunjdwp:transport=dt_socket,server=y,address=8000,suspend=n"
+        args << "-DJENKINS_HOME=#{work}"
+        args << "-jar"
+        args << Jenkins::War::LOCATION
+        exec *args
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification 
+name: jenkins-plugin
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Charles Lowell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-02 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rubyzip
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jenkins-war
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 857
+        segments: 
+        - 1
+        - 427
+        version: "1.427"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1923831889
+        segments: 
+        - 1
+        - 1
+        - pre
+        - 8
+        version: 1.1.pre.8
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :development
+  version_requirements: *id006
+description: I'll think of a better description later, but if you're reading this, then I haven't
+email: 
+- cowboyd@thefrontside.net
+executables: 
+- jpi
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- bin/jpi
+- features/create-new-plugin.feature
+- jenkins-plugin.gemspec
+- lib/jenkins/plugin/tools/hpi.rb
+- lib/jenkins/plugin/tools/loadpath.rb
+- lib/jenkins/plugin/version.rb
+- lib/jenkins/rake.rb
+has_rdoc: true
+homepage: http://github.com/cowboyd/jenkins-plugin
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: jenkins-plugin
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Tools for creating and building Jenkins Ruby plugins
+test_files: 
+- features/create-new-plugin.feature