jettywrapper 2.0.3 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41090c9b128c286ef7693a2cea00c70de5896f1d
-  data.tar.gz: 869ac3689c8c830a01a3f3a6582f75010c3a3848
+  metadata.gz: ad61d470f98b939656823a010312781aee10afd6
+  data.tar.gz: 9bf4d4e60718147234e08acb682c03fb5d8040bd
 SHA512:
-  metadata.gz: 88128ee21fe30aadce3a2b8ec72bda31879c98aca9e298a9ae520e42edfd8daf9256f4faf52e5bb3e771c8f214592acfb5410c1ce79b0dc5cc4b7a5fb0d2273c
-  data.tar.gz: 3123a2564cbd8e24f2650b74bf47517b048fe2a259159732c1fc210482ac52fdd1151975d10e52d9a65ec5ecb93752f18787ffd1f8686b7266789aacb2b34dce
+  metadata.gz: 82b203a172948e4b526caa378dcb9228eab6cc7a85c46a45570503ef62f5115185848134998d3ddf0eef399f7b7e132e43becf840de8431329f2b4fa4979c823
+  data.tar.gz: 3f51c8de273590e6ff1ea07df495d8ad6a030e306102bb4b389cfc016d86f775a0186b3e9bf7036c13d1280f2dcd10a87806dc3d73f3f5ded7b4ba05fbb18952

data/.travis.yml

@@ -1,3 +1,4 @@
+sudo: false
 language: ruby
 
 matrix:

data/Gemfile

@@ -2,4 +2,3 @@ source "http://rubygems.org"
 
 gemspec path: File.expand_path('..', __FILE__)
 
-gem 'simplecov'

data/README.md

@@ -1,70 +1,83 @@
 # Jettywrapper [![Version](https://badge.fury.io/gh/projecthydra%2Fjettywrapper.png)](http://badge.fury.io/gh/projecthydra%2Fjettywrapper) [![Build Status](https://travis-ci.org/projecthydra/jettywrapper.png?branch=master)](https://travis-ci.org/projecthydra/jettywrapper)
 
-This gem is designed to make it easier to integrate a jetty servlet container into a rails project.  
-Jettywrapper provides rake tasks for starting and stopping jetty, as well as the method `Jettywrapper.wrap` that will start
-the server before the block and stop the server after the block, which is useful for automated testing.
+NOTICE:  Because of changes introduced in Solr 5, we can no longer update jettywrapper to use modern versions of Solr. Therefore we discourage you from using jettywrapper in new projects.  No further development is anticipated for jettywrapper. Consider using [solr_wrapper](https://github.com/cbeer/solr_wrapper) and [fcrepo_wrapper](https://github.com/cbeer/fcrepo_wrapper) instead.
 
-By default, Jettywrapper is designed to work with Rails projects that use the Hydra gem, and downloads an instance of a 
-[hydra-jetty](https://github.com/projecthydra/hydra-jetty) project zipfile. However, it can be configured to 
-download any Jetty-based project on Github.
+This gem is designed to make it easier to integrate a jetty servlet container into a project with web service dependencies.  This can be especially useful for developing and testing projects requiring, for example, a Solr and/or a Fedora server.
 
-Jettywrapper supports
+Jettywrapper provides rake tasks for starting and stopping jetty, as well as the method `Jettywrapper.wrap` that will start the server before the block and stop the server after the block, which is useful for automated testing.
 
-* ruby 2.0.0
-* ruby 1.9.3 
-* ruby 1.8.7 
-* ree  1.8.7
-* jruby 1.6.6+
+Jettywrapper can be configured to work with any Jetty-based zip file, such as [blacklight-jetty](https://github.com/projectblacklight/blacklight-jetty) (Solr only) or [hydra-jetty](https://github.com/projecthydra/hydra-jetty) (Solr + Fedora). Jettywrapper uses hydra-jetty by default.
 
-## Configuring Jettywrapper
+## Requirements
 
-Jettywrapper starts the process with a list of options that you can specify in `config/jetty.yml`, otherwise a default is used.
-You can provide a per-environment configuration, or you can have a default configuration which will be used when a per-environment
-configuration is not specified. Such a configuration might look like:
+1.  ruby -- Jettywrapper supports the ruby versions in its [.travis.yml](.travis.yml) file.
+2.  bundler -- this ruby gem must be installed.
+3.  java -- Jetty is a java based servlet container; the version of java required depends on the version of jetty you are using (in the jetty-based zip file).
 
-    default:
-      jetty_port: 8983
-      java_opts:
-        - "-XX:MaxPermSize=128m"
-        - "-Xmx256m"
+## Installation
 
-You can also configure a specific version of hydra-jetty. This is placed in your codebase, usually in a rake task 
+Generally, you will only use a jetty instance for your project's web service dependencies during development and testing, not for production. So you would add this to your Gemfile:
+
+```
+group :development, :test do
+  gem 'jettywrapper'
+end
+```
+
+Or, if your project is a gem, you would add this to your .gemspec file:
+
+```
+Gem::Specification.new do |s|
+  s.add_development_dependency 'jettywrapper'
+end
+```
+
+Then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jettywrapper
 
-    Jettywrapper.hydra_jetty_version = "v1.2.3"
 
-Alternatively, you can use a completely different Jetty-based repository, Hydra-related or not
+## Usage
 
-    Jettywrapper.url = "https://github.com/myorg/my-jetty/archive/master.zip"
+### Configuration
 
-The name of the zip file can either be a branch name, such as master or develop, or the tag name of a released version.
-Basically, any url that Github provides as a *.zip file will work.
+See [Configuring jettywrapper](https://github.com/projecthydra/jettywrapper/wiki/Configuring-jettywrapper).
 
-## Example rake task
+If you don't need both Solr and Fedora, we recommend you avoid the default [hydra-jetty](https://github.com/projecthydra/hydra-jetty). If you only need Solr, use [blacklight-jetty](https://github.com/projectblacklight/blacklight-jetty).
+
+### Gotchas
+
+* Jetty may take a while to spin up
+* Jetty may not shut down cleanly
+
+See [Using jettywrapper](https://github.com/projecthydra/jettywrapper/wiki/Using-jettywrapper) for more information and what to do.
+
+### Example Rake Task
+
+See [Using jettywrapper](https://github.com/projecthydra/jettywrapper/wiki/Using-jettywrapper) for more information.
 
 ```ruby
 require 'jettywrapper'
-Jettywrapper.url = "https://github.com/myorg/my-jetty/archive/testing-feature-branch.zip"
-desc "Hudson build"
-task :hudson do
-  jetty_params = Jettywrapper.load_config.merge({:jetty_home => File.expand_path(File.dirname(__FILE__) + '/../jetty')})
-  error = Jettywrapper.wrap(jetty_params) do  
-    Rake::Task["spec"].invoke
+
+desc 'run the tests for continuous integration'
+task ci: ['jetty:clean', 'myproj:configure_jetty'] do
+  ENV['environment'] = 'test'
+  jetty_params = Jettywrapper.load_config
+  jetty_params[:startup_wait] = 60
+
+  error = nil
+  error = Jettywrapper.wrap(jetty_params) do
+    # run the tests
+    Rake::Task['spec'].invoke
   end
   raise "test failures: #{error}" if error
 end
 ```
 
-## Testing the gem 
-
-If you haven't already, clone the git repository
-
-    git clone git@github.com:projecthydra/jettywrapper.git
-    cd jettywrapper
-
-Install the gems
-
-    bundle install
-
-Run the tests
+## Contributing
 
-    rake 
+See [CONTRIBUTING.md](https://github.com/projecthydra/jettywrapper/blob/master/CONTRIBUTING.md) to help us make this project better.

data/Rakefile

@@ -20,21 +20,6 @@ RSpec::Core::RakeTask.new(:spec => 'jetty:clean') do |spec|
 #  spec.spec_files = FileList['spec/**/*_spec.rb']
 end
 
-RSpec::Core::RakeTask.new(:coverage) do |spec|
-  ruby_engine = defined?(RUBY_ENGINE) ? RUBY_ENGINE : "ruby"
-  ENV['COVERAGE'] = 'true' unless ruby_engine == 'jruby'
-
-  if ENV['COVERAGE'] and RUBY_VERSION =~ /^1.8/
-    spec.rcov = true
-    spec.rcov_opts = %w{--exclude spec\/*,gems\/*,ruby\/* --aggregate coverage.data}
-  end
-end
-
-task :clean do
-  puts 'Cleaning old coverage.data'
-  FileUtils.rm('coverage.data') if(File.exists? 'coverage.data')
-end
-
 # Use yard to build docs
 begin
   require 'yard'
@@ -54,5 +39,4 @@ rescue LoadError
   end
 end
 
-#task :default => [:coverage, :doc]
 task :default => [:spec]

data/jettywrapper.gemspec

@@ -23,11 +23,12 @@ Gem::Specification.new do |s|
   s.add_dependency "childprocess"
   s.add_dependency "i18n"
   s.add_dependency "activesupport", ">=3.0.0"
-  s.add_dependency 'rubyzip'
+  s.add_dependency 'rubyzip', "~> 1.0"
 
   s.add_development_dependency "rspec", '~> 3.2'
   s.add_development_dependency "rspec-its"
   s.add_development_dependency 'rake'
+  s.add_development_dependency 'simplecov'
 
   s.add_development_dependency 'yard'
 end

data/lib/jettywrapper.rb

@@ -1,4 +1,3 @@
-require 'singleton'
 require 'fileutils'
 require 'shellwords'
 require 'socket'
@@ -10,14 +9,13 @@ require 'erb'
 require 'yaml'
 require 'logger'
 require 'open-uri'
+require 'tempfile'
 require 'zip'
 
-Dir[File.expand_path(File.join(File.dirname(__FILE__),"tasks/*.rake"))].each { |ext| load ext } if defined?(Rake)
+Dir[File.expand_path(File.join(File.dirname(__FILE__),"tasks/*.rake"))].each { |ext| load ext } if (defined?(Rake::VERSION))
 
-# Jettywrapper is a Singleton class, so you can only create one jetty instance at a time.
 class Jettywrapper
 
-  include Singleton
   include ActiveSupport::Benchmarkable
 
   attr_accessor :jetty_home   # Jetty's home directory
@@ -27,16 +25,29 @@ class Jettywrapper
   attr_accessor :solr_home    # Solr's home directory. Default is jetty_home/solr
   attr_accessor :base_path    # The root of the application. Used for determining where log files and PID files should go.
   attr_accessor :java_opts    # Options to pass to java (ex. ["-Xmx512mb", "-Xms128mb"])
+  attr_accessor :java_command # Path to the Java executable
+  attr_accessor :java_version # Minimum java version
   attr_accessor :jetty_opts   # Options to pass to jetty (ex. ["etc/my_jetty.xml", "etc/other.xml"] as in http://wiki.eclipse.org/Jetty/Reference/jetty.xml_usage
 
-  # configure the singleton with some defaults
   def initialize(params = {})
     self.base_path = self.class.app_root
+    configure(params)
   end
 
+  def configure params
+    self.quiet        = params[:quiet].nil? ? true : params[:quiet]
+    self.jetty_home   = params[:jetty_home  ] || File.expand_path(File.join(self.base_path, 'jetty'))
+    self.solr_home    = params[:solr_home   ] || File.join( self.jetty_home, "solr")
+    self.port         = params[:jetty_port  ] || 8888
+    self.startup_wait = params[:startup_wait] || 5
+    self.java_opts    = params[:java_opts   ] || []
+    self.java_command = params[:java_command] || default_java_command
+    self.java_version = params[:java_version]
+    self.jetty_opts   = params[:jetty_opts  ] || []
+  end
 
   # Methods inside of the class << self block can be called directly on Jettywrapper, as class methods.
-  # Methods outside the class << self block must be called on Jettywrapper.instance, as instance methods.
+  # Methods outside the class << self block must be called on Jettywrapper.instance or a Jettywrapper object, as instance methods.
   class << self
 
     attr_writer :hydra_jetty_version, :url, :tmp_dir, :jetty_dir, :env
@@ -193,17 +204,14 @@ class Jettywrapper
     def configure(params = {})
       jetty_server = self.instance
       jetty_server.reset_process!
-      jetty_server.quiet = params[:quiet].nil? ? true : params[:quiet]
-
-      jetty_server.jetty_home = params[:jetty_home] || File.expand_path(File.join(app_root, 'jetty'))
-      jetty_server.solr_home = params[:solr_home]  || File.join( jetty_server.jetty_home, "solr")
-      jetty_server.port = params[:jetty_port] || 8888
-      jetty_server.startup_wait = params[:startup_wait] || 5
-      jetty_server.java_opts = params[:java_opts] || []
-      jetty_server.jetty_opts = params[:jetty_opts] || []
+      jetty_server.configure params
       return jetty_server
     end
 
+    def instance
+      @instance ||= Jettywrapper.new
+    end
+
     # Wrap the tests. Startup jetty, yield to the test task, capture any errors, shutdown
     # jetty, and return the error.
     # @example Using this method in a rake task
@@ -324,6 +332,35 @@ class Jettywrapper
       end
     end
 
+    def check_java_version! java_path, required_java_version
+      Tempfile.open("java-version-output") do |f|
+        process = ChildProcess.build(java_path, "-version")
+        process.io.stderr = f
+        process.start
+
+        begin
+          process.poll_for_exit(10)
+        rescue ChildProcess::TimeoutError
+          process.stop # tries increasingly harsher methods to kill the process.
+        end
+
+        f.rewind
+        err = f.read
+
+        java_version = if version = err.match(/java version "([^"]+)"/)
+          version[1]
+        else
+          raise "Java not found, or an error was encountered when running `#{java_path} -version`: #{err}"
+        end
+
+        unless Gem::Dependency.new('', required_java_version.gsub("_", ".")).match?('', java_version.gsub("_", "."))
+          raise "Java #{required_java_version} is required to run Jetty. Found Java #{java_version} when running `#{java_path} -version`."
+        end
+      end
+
+      true
+    end
+
     def logger=(logger)
       @@logger = logger
     end
@@ -342,7 +379,7 @@ class Jettywrapper
 
   # What command is being run to invoke jetty?
   def jetty_command
-    ["java", java_variables, java_opts, "-jar", "start.jar", jetty_opts].flatten
+    [java_command, java_variables, java_opts, "-jar", "start.jar", jetty_opts].flatten
   end
 
   def java_variables
@@ -350,6 +387,12 @@ class Jettywrapper
      "-Dsolr.solr.home=#{Shellwords.escape(@solr_home)}"]
   end
 
+  def check_java_version!
+    if java_version
+      @checked_java_version ||= Jettywrapper.check_java_version!(java_command, java_version)
+    end
+  end
+
   # Start the jetty server. Check the pid file to see if it is running already,
   # and stop it if so. After you start jetty, write the PID to a file.
   # This is the instance start method. It must be called on Jettywrapper.instance
@@ -363,6 +406,8 @@ class Jettywrapper
     logger.debug "jetty_home: #{@jetty_home}"
     logger.debug "jetty_command: #{jetty_command.join(' ')}"
 
+    check_java_version!
+
     # Check to see if we can start.
     # 1. If there is a pid, check to see if it is really running
     # 2. Check to see if anything is blocking the port we want to use
@@ -485,4 +530,22 @@ class Jettywrapper
   def pid
     File.open( pid_path ) { |f| return f.gets.to_i } if File.exist?(pid_path)
   end
+
+  private
+
+  def default_java_command
+    # Use the same JAVA_HOME lookup as Solr
+    @default_java_command ||= if ENV["JAVA_HOME"]
+      if File.exists? File.join(ENV["JAVA_HOME"], "bin", "java")
+        File.join(ENV["JAVA_HOME"], "bin", "java")
+      end
+
+      if File.exists? File.join(ENV["JAVA_HOME"], "amd64", "bin", "java")
+        File.join(ENV["JAVA_HOME"], "amd64", "bin", "java")
+      end
+    end
+
+    @default_java_command ||= "java"
+  end
+
 end

data/lib/jettywrapper/version.rb

@@ -1,3 +1,3 @@
 class Jettywrapper
-  VERSION = "2.0.3"
+  VERSION = "2.0.4"
 end

data/spec/lib/jettywrapper_integration_spec.rb

@@ -104,6 +104,19 @@ module Hydra
         end
       end
 
+      describe "#check_java_version!" do
+        it "should check for a required minimum version of java" do
+          expect(Jettywrapper.check_java_version!("java", ">= 1.2")).to eq true
+        end
+
+        it "should raise an exception if java can't be found" do
+          expect { Jettywrapper.check_java_version!("/bin/cat", ">= 1.2") }.to raise_error /Java not found/
+        end
+
+        it "should raise an exception if the version of java is not new enough" do
+          expect { Jettywrapper.check_java_version!("java", ">= 999.999") }.to raise_error /999.999 is required to run Jetty/
+        end
+      end
     end
   end
 end

data/spec/lib/jettywrapper_spec.rb

@@ -364,6 +364,12 @@ require 'fileutils'
         expect(File.file? swp.pid_path).to eql(false)
       end
 
+      it "can pass the java executable in the configuration" do
+        subject = Jettywrapper.new(java_command: "/dev/null/java")
+        allow_any_instance_of(Jettywrapper).to receive(:process).and_return(double('proc', :start => nil, :pid=>2323))
+        expect(subject.jetty_command.first).to eq "/dev/null/java" 
+      end
+
       describe "creates a pid file" do
         let(:ts) { Jettywrapper.configure(@jetty_params) }
         describe "when the environment isn't set" do

data/spec/spec_helper.rb

@@ -1,12 +1,5 @@
-$: << File.join(File.dirname(__FILE__), "/../../lib")
-
-if ENV['COVERAGE'] and RUBY_VERSION =~ /^1.9/
-  require 'simplecov'
-  require 'simplecov-rcov'
-
-  SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
-  SimpleCov.start
-end
+require 'simplecov'
+SimpleCov.start
 
 require 'rspec/its'
 require 'jettywrapper'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jettywrapper
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.4
 platform: ruby
 authors:
 - Chris Beer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-24 00:00:00.000000000 Z
+date: 2016-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger
@@ -72,16 +72,16 @@ dependencies:
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -124,6 +124,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -156,7 +170,6 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- TODO.txt
 - config/jetty.yml
 - gemfiles/rails4.1.gemfile
 - gemfiles/rails4.2.gemfile
@@ -188,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Convenience tasks for working with jetty from within a ruby project.

data/TODO.txt

@@ -1,3 +0,0 @@
-Next up:
-
-Check whether a port is open before you attempt to start jetty. I've put a method in place, but I need to work on something else for awhile and I haven't fully implemented this yet.