fcrepo_wrapper 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba5066043ea86ae0ae0525b52afd49847d7fd100
-  data.tar.gz: 95b4fc274a0176cd36bfc1b05174221d7025f787
+  metadata.gz: a144f4c282130ef794aacb6218cf8134b563c8ef
+  data.tar.gz: 49d5805fc67970698545245d9707a832e5f5c57b
 SHA512:
-  metadata.gz: 41d86775c25d46c3c64c17150d6143b496a349a3656278397a5abc7fc04630eafa6694119f118172f0b8285cdf0c5555337241d54fc64742f4ec155861f849c4
-  data.tar.gz: 89257e5862f5c93a0f5cecfe75f3e79371e367675ddfc3bdba02d6a4d12f88820903a4fdacadc16fc89e3a9ab6a987d26492ce758a52f636e010e80fa850cf65
+  metadata.gz: 1514aa19a011b30e50864ca5d00cd3d493b5a4297fd066ce1eccec5c6843061ac62fe76046f6e7c4ce365f909d3818671efb2dccd0df9610eef1c828384de2af
+  data.tar.gz: e13cda2c8ca4211ab18bb3e1c4515c66fd533140c03a2d6cf9494e3f09ffaec4640abe07add3ef69e54377b90db7e57922e0ebecd4632bc14b919e471c87cb06

data/data/spring-noop.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<beans xmlns="http://www.springframework.org/schema/beans"
+  xmlns:context="http://www.springframework.org/schema/context"
+  xmlns:p="http://www.springframework.org/schema/p"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
+  http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.0.xsd">
+
+  <context:annotation-config/>
+
+</beans>

data/exe/fcrepo_wrapper

@@ -4,7 +4,7 @@ require 'fcrepo_wrapper'
 require 'optparse'
 
 options = {}
-collection_options = {}
+
 OptionParser.new do |opts|
   opts.banner = "Usage: fcrepo_wrapper [options]"
 
@@ -12,20 +12,43 @@ OptionParser.new do |opts|
     options[:verbose] = v
   end
 
+  opts.on("--[no-]jms", "Run without JMS") do |v|
+    options[:enable_jms] = v
+  end
+
   opts.on("--version VERSION", "Specify a fcrepo version to download (default: #{FcrepoWrapper.default_fcrepo_version})") do |v|
     options[:version] = v
   end
 
-  opts.on("-pPORT", "--port PORT", "Specify the port fcrepo should run at (default: 8080)") do |p|
-    options[:port] = p
+  opts.on("-pPORT", "--port PORT", "Specify the port fcrepo should run at (default: 8983)") do |p|
+    if p == 'random'
+      options[:port] = nil
+    else
+      options[:port] = p
+    end
+  end
+
+  opts.on("-iDIR", "--instance_directory DIR", "Install/use fcrepo jar at the given directory") do |d|
+    options[:instance_dir] = d
+  end
+
+  opts.on("-dDIR", "--fcrepo_home DIR", "Store fcrepo at the given directory") do |d|
+    options[:fcrepo_home_dir] = d
   end
 end.parse!
 
 # default to verbose
 options[:verbose] = true if options[:verbose].nil?
 
-FcrepoWrapper.wrap(options) do |conn|
-  while conn.status
-    sleep 1
+instance = FcrepoWrapper.default_instance(options)
+$stderr.print "Starting Fedora #{instance.version} on port #{instance.port} ... "
+instance.wrap do |conn|
+  $stderr.puts "http://#{instance.host}:#{instance.port}/"
+  begin
+    while conn.status
+      sleep 1
+    end
+  rescue Interrupt
+    $stderr.puts "Fedora is shutting down."
   end
 end

data/lib/fcrepo_wrapper/instance.rb

@@ -1,31 +1,30 @@
 require 'digest'
 require 'fileutils'
+require 'json'
 require 'open-uri'
 require 'ruby-progressbar'
 require 'securerandom'
+require 'socket'
 require 'stringio'
 require 'tmpdir'
-require 'service_instance'
 
 module FcrepoWrapper
   class Instance
-    include ServiceInstance
     attr_reader :options, :pid
 
     ##
     # @param [Hash] options
     # @option options [String] :url
-    # @option options [String] :version
-    # @option options [String] :port
-    # @option options [String] :version_file
-    # @option options [String] :instance_dir
-    # @option options [String] :download_path
-    # @option options [String] :md5sum
-    # @option options [String] :xml
-    # @option options [Boolean] :verbose
-    # @option options [Boolean] :managed
+    # @option options [String] :instance_dir Directory to store the fcrepo index files
+    # @option options [String] :version Fcrepo version to download and install
+    # @option options [String] :port port to run fcrepo on
+    # @option options [String] :version_file Local path to store the currently installed version
+    # @option options [String] :download_dir Local directory to store the downloaded fcrepo jar and its md5 file in (overridden by :download_path)
+    # @option options [String] :download_path Local path for storing the downloaded fcrepo jar file
+    # @option options [Boolean] :validate Should fcrepo_wrapper download a new md5 and (re-)validate the zip file? (default: trueF)
+    # @option options [String] :md5sum Path/URL to MD5 checksum
+    # @option options [Boolean] :verbose return verbose info when running fcrepo commands
     # @option options [Boolean] :ignore_md5sum
-    # @option options [Array<String>] :java_options a list of options to pass to the JVM
     # @option options [Hash] :fcrepo_options
     # @option options [Hash] :env
     def initialize(options = {})
@@ -33,6 +32,7 @@ module FcrepoWrapper
     end
 
     def wrap(&_block)
+      extract_and_configure
       start
       yield self
     ensure
@@ -50,7 +50,14 @@ module FcrepoWrapper
       # info:fedora/fedora-system:def/relations-external#isPartOf
       # was possibly misinterpreted as:
       # info:fedora/fedora-system:def/relations-external#."
-      '-Dfcrepo.log.kernel=ERROR']
+      '-Dfcrepo.log.kernel=ERROR',
+      ("-Dfcrepo.home=#{fcrepo_home_dir}" if fcrepo_home_dir),
+      ("-Dfcrepo.spring.jms.configuration=#{spring_noop_file}" unless jms_enabled?),
+      '-Xmx512m'].compact
+    end
+
+    def fcrepo_home_dir
+      options[:fcrepo_home_dir]
     end
 
     def process_arguments
@@ -60,15 +67,14 @@ module FcrepoWrapper
     end
 
     ##
-    # Start Solr and wait for it to become available
+    # Start fcrepo and wait for it to become available
     def start
-      extract
+      extract_and_configure
       if managed?
-
         @pid = spawn(env, *process_arguments)
 
         # Wait for fcrepo to start
-        until status
+        while !status
           sleep 1
         end
       end
@@ -91,6 +97,15 @@ module FcrepoWrapper
       @pid = nil
     end
 
+    ##
+    # Stop fcrepo and wait for it to finish exiting
+    def restart
+      if managed? && started?
+        stop
+        start
+      end
+    end
+
     ##
     # Check the status of a managed fcrepo service
     def status
@@ -100,27 +115,126 @@ module FcrepoWrapper
       begin
         Process.getpgid(pid)
 
-        TCPSocket.new('127.0.0.1', port).close
+        TCPSocket.new(host, port).close
+
+        Net::HTTP.start(host, port) do |http|
+          http.request(Net::HTTP::Get.new('/'))
+        end
+
         true
       rescue Errno::ESRCH, Errno::ECONNREFUSED
         false
       end
     end
 
+    ##
+    # Is fcrepo running?
+    def started?
+      !!status
+    end
+
+    ##
+    # Get the host this fcrepo instance is bound to
+    def host
+      '127.0.0.1'
+    end
+
     ##
     # Get the port this fcrepo instance is running at
     def port
-      options.fetch(:port, "8080").to_s
+      @port ||= options[:port]
+      @port ||= random_open_port.to_s
+    end
+
+    ##
+    # Clean up any files fcrepo_wrapper may have downloaded
+    def clean!
+      stop
+      remove_instance_dir!
+      FileUtils.remove_entry(download_path) if File.exists?(download_path)
+      FileUtils.remove_entry(tmp_save_dir, true) if File.exists? tmp_save_dir
+      FileUtils.remove_entry(md5sum_path) if File.exists? md5sum_path
+      FileUtils.remove_entry(version_file) if File.exists? version_file
+    end
+
+    ##
+    # Clean up any files in the fcrepo instance dir
+    def remove_instance_dir!
+      FileUtils.remove_entry(instance_dir, true) if File.exists? instance_dir
     end
 
     ##
     # Get a (likely) URL to the fcrepo instance
     def url
-      "http://127.0.0.1:#{port}/rest/"
+      "http://#{host}:#{port}/"
+    end
+
+    def configure
+      raise_error_unless_extracted
+    end
+
+    def instance_dir
+      @instance_dir ||= options.fetch(:instance_dir, File.join(Dir.tmpdir, File.basename(download_url, ".jar")))
+    end
+
+    def extract_and_configure
+      instance_dir = extract
+      configure
+      instance_dir
+    end
+
+    # extract a copy of fcrepo to instance_dir
+    # Does noting if fcrepo already exists at instance_dir
+    # @return [String] instance_dir Directory where fcrepo has been installed
+    def extract
+      return instance_dir if extracted?
+
+      jar_file = download
+
+      FileUtils.mkdir_p instance_dir
+      FileUtils.cp jar_file, binary_path
+      self.extracted_version = version
+
+      instance_dir
+    end
+    # rubocop:enable Lint/RescueException
+
+    def version
+      @version ||= options.fetch(:version, FcrepoWrapper.default_fcrepo_version)
+    end
+
+    protected
+
+    def extracted?
+      File.exists?(binary_path) && extracted_version == version
+    end
+
+    def download
+      unless File.exists?(download_path) && validate?(download_path)
+        fetch_with_progressbar download_url, download_path
+        validate! download_path
+      end
+      download_path
+    end
+
+    def validate?(file)
+      return true if options[:validate] == false
+
+      Digest::MD5.file(file).hexdigest == expected_md5sum
+    end
+
+    def validate!(file)
+      unless validate? file
+        raise "MD5 mismatch" unless options[:ignore_md5sum]
+      end
     end
 
     private
 
+    def download_url
+      @download_url ||= options.fetch(:url, default_download_url)
+    end
+
     def default_download_url
       @default_url ||= "https://github.com/fcrepo4/fcrepo4/releases/download/fcrepo-#{version}/fcrepo-webapp-#{version}-jetty-console.jar"
     end
@@ -129,43 +243,108 @@ module FcrepoWrapper
       "https://github.com/fcrepo4/fcrepo4/releases/download/fcrepo-#{version}/fcrepo-webapp-#{version}-jetty-console.jar.md5"
     end
 
-    def version
-      @version ||= options.fetch(:version, default_fcrepo_version)
-    end
-
     def fcrepo_options
       options.fetch(:fcrepo_options, headless: nil)
     end
 
-    def default_fcrepo_version
-      FcrepoWrapper.default_fcrepo_version
+    def env
+      options.fetch(:env, {})
+    end
+
+    def download_path
+      @download_path ||= options.fetch(:download_path, default_download_path)
     end
 
-    def default_instance_dir
-      File.join(Dir.tmpdir, File.basename(download_url, ".jar"))
+    def default_download_path
+      File.join(download_dir, File.basename(download_url))
+    end
+
+    def download_dir
+      @download_dir ||= options.fetch(:download_dir, Dir.tmpdir)
+      FileUtils.mkdir_p @download_dir
+      @download_dir
+    end
+
+    def verbose?
+      !!options.fetch(:verbose, false)
     end
 
     def managed?
-      !!options.fetch(:managed, true)
+      File.exists?(instance_dir)
+    end
+
+    def version_file
+      options.fetch(:version_file, File.join(instance_dir, "VERSION"))
+    end
+
+    def expected_md5sum
+      @md5sum ||= options.fetch(:md5sum, open(md5file).read.split(" ").first)
     end
 
     def binary_path
       File.join(instance_dir, "fcrepo-webapp-#{version}-jetty-console.jar")
     end
 
-    # extract a copy of fcrepo to instance_dir
-    # Does noting if fcrepo already exists at instance_dir
-    # @return [String] instance_dir Directory where solr has been installed
-    def extract
-      return instance_dir if extracted?
+    def md5sum_path
+      File.join(download_dir, File.basename(md5url))
+    end
 
-      jar_file = download
+    def tmp_save_dir
+      @tmp_save_dir ||= Dir.mktmpdir
+    end
 
-      FileUtils.mkdir_p instance_dir
-      FileUtils.cp jar_file, binary_path
-      self.extracted_version = version
+    def fetch_with_progressbar(url, output)
+      pbar = ProgressBar.create(title: File.basename(url), total: nil, format: "%t: |%B| %p%% (%e )")
+      open(url, content_length_proc: lambda do|t|
+        if t && 0 < t
+          pbar.total = t
+        end
+      end,
+                progress_proc: lambda do|s|
+                  pbar.progress = s
+                end) do |io|
+        IO.copy_stream(io, output)
+      end
+    end
 
-      instance_dir
+    def md5file
+      unless File.exists? md5sum_path
+        fetch_with_progressbar md5url, md5sum_path
+      end
+
+      md5sum_path
+    end
+
+    def extracted_version
+      File.read(version_file).strip if File.exists? version_file
+    end
+
+    def extracted_version=(version)
+      File.open(version_file, "w") do |f|
+        f.puts version
+      end
+    end
+
+    def random_open_port
+      socket = Socket.new(:INET, :STREAM, 0)
+      begin
+        socket.bind(Addrinfo.tcp('127.0.0.1', 0))
+        socket.local_address.ip_port
+      ensure
+        socket.close
+      end
+    end
+
+    def raise_error_unless_extracted
+      raise RuntimeError, "there is no fcrepo instance at #{instance_dir}.  Run FcrepoWrapper.extract first." unless extracted?
+    end
+
+    def spring_noop_file
+      'file://' + File.expand_path('../../../data/spring-noop.xml', __FILE__)
+    end
+
+    def jms_enabled?
+      options.fetch(:enable_jms, true)
     end
   end
 end

data/lib/fcrepo_wrapper/rake_task.rb

@@ -0,0 +1,5 @@
+module FcrepoWrapper
+  module RakeTask
+    Dir[File.expand_path(File.join(File.dirname(__FILE__),"tasks/*.rake"))].each { |ext| load ext } if defined?(Rake)
+  end
+end

data/lib/fcrepo_wrapper/tasks/fcrepo_wrapper.rake

@@ -0,0 +1,45 @@
+require 'fcrepo_wrapper'
+
+## These tasks get loaded into the host context when fcrepo_wrapper is required
+namespace :fcrepo do
+  desc "Load the fcrepo options and fcrepo instance"
+  task :environment do
+    FcrepoWrapper.default_instance_options[:download_dir] ||= Rails.root.to_s + '/tmp' if defined? Rails
+    @fcrepo_instance = FcrepoWrapper.default_instance
+  end
+
+  desc 'Install a clean version of fcrepo. Replaces the existing copy if there is one.'
+  task clean: :environment do
+    puts "Installing clean version of fcrepo at #{File.expand_path(@fcrepo_instance.instance_dir)}"
+    @fcrepo_instance.remove_instance_dir!
+    @fcrepo_instance.extract_and_configure
+  end
+
+  desc 'start fcrepo'
+  task start: :environment do
+    begin
+      puts "Starting fcrepo at #{File.expand_path(@fcrepo_instance.instance_dir)} with options #{@fcrepo_instance.options}"
+      @fcrepo_instance.start
+    rescue => e
+      if e.message.include?("Port #{@fcrepo_instance.port} is already being used by another process")
+        puts "FAILED. Port #{@fcrepo_instance.port} is already being used."
+        puts " Did you already have fcrepo running?"
+        puts "  a) YES: Continue as you were. fcrepo is running."
+        puts "  b) NO: Either set FCREPO_OPTIONS[:port] to a different value or stop the process that's using port #{@fcrepo_instance.port}."
+      else
+        raise "Failed to start fcrepo. #{e.class}: #{e.message}"
+      end
+    end
+  end
+
+  desc 'restart fcrepo'
+  task restart: :environment do
+    puts "Restarting fcrepo"
+    @fcrepo_instance.restart
+  end
+
+  desc 'stop fcrepo'
+  task stop: :environment do
+    @fcrepo_instance.stop
+  end
+end

data/lib/fcrepo_wrapper/version.rb

@@ -1,3 +1,3 @@
 module FcrepoWrapper
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'.freeze
 end

data/lib/fcrepo_wrapper.rb

@@ -6,12 +6,23 @@ module FcrepoWrapper
     '4.5.0'
   end
 
+  def self.default_instance_options
+    @default_instance_options ||= {
+      port: '8080',
+      version: FcrepoWrapper.default_fcrepo_version
+    }
+  end
+
+  def self.default_instance_options=(options)
+    @default_instance_options = options
+  end
+
   def self.default_instance(options = {})
-    @default_instance ||= FcrepoWrapper::Instance.new options
+    @default_instance ||= FcrepoWrapper::Instance.new default_instance_options.merge(options)
   end
 
   ##
-  # Ensures a Solr service is running before executing the block
+  # Ensures a fcrepo service is running before executing the block
   def self.wrap(options = {}, &block)
     default_instance(options).wrap &block
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fcrepo_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Chris Beer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-03 00:00:00.000000000 Z
+date: 2016-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-progressbar
@@ -112,12 +112,14 @@ files:
 - README.md
 - Rakefile
 - coveralls.yml
+- data/spring-noop.xml
 - exe/fcrepo_wrapper
 - fcrepo_wrapper.gemspec
 - lib/fcrepo_wrapper.rb
 - lib/fcrepo_wrapper/instance.rb
+- lib/fcrepo_wrapper/rake_task.rb
+- lib/fcrepo_wrapper/tasks/fcrepo_wrapper.rake
 - lib/fcrepo_wrapper/version.rb
-- lib/service_instance.rb
 - spec/lib/fcrepo_wrapper_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/cbeer/fcrepo_wrapper

data/lib/service_instance.rb

@@ -1,134 +0,0 @@
-# This module is intended to be mixed into SolrWrapper::Instance and FcrepoWrapper::Instance
-module ServiceInstance
-  def env
-    options.fetch(:env, {})
-  end
-
-  def binary_path
-    raise NotImplementedError, "Implement binary_path in a subclass"
-  end
-
-  def default_download_url
-    raise NotImplementedError, "Implement default_download_url in a subclass"
-  end
-
-  def default_instance_dir
-    raise NotImplementedError, "Implement default_instance_dir in a subclass"
-  end
-
-  def md5url
-    raise NotImplementedError, "Implement md5url in a subclass"
-  end
-
-  def download_path
-    @download_path ||= options.fetch(:download_path, default_download_path)
-  end
-
-  def default_download_path
-    File.join(Dir.tmpdir, File.basename(download_url))
-  end
-
-  def download_url
-    @download_url ||= options.fetch(:url, default_download_url)
-  end
-
-
-  def verbose?
-    !!options.fetch(:verbose, false)
-  end
-
-  def instance_dir
-    @instance_dir ||= options.fetch(:instance_dir, default_instance_dir)
-  end
-
-  def extracted?
-    File.exists?(binary_path) && extracted_version == version
-  end
-
-  def extracted_version
-    File.read(version_file).strip if File.exists? version_file
-  end
-
-  def extracted_version=(version)
-    File.open(version_file, "w") do |f|
-      f.puts version
-    end
-  end
-
-  def version_file
-    options.fetch(:version_file, File.join(instance_dir, "VERSION"))
-  end
-
-  def expected_md5sum
-    @md5sum ||= options.fetch(:md5sum, open(md5file).read.split(" ").first)
-  end
-
-  ##
-  # Is the service running?
-  def started?
-    !!status
-  end
-
-  def download
-    unless File.exists?(download_path) && validate?(download_path)
-      fetch_with_progressbar download_url, download_path
-      validate! download_path
-    end
-
-    download_path
-  end
-
-  def validate?(file)
-     return true if options[:validate] == false
-    Digest::MD5.file(file).hexdigest == expected_md5sum
-  end
-
-  def validate!(file)
-    unless validate? file
-      raise "MD5 mismatch" unless options[:ignore_md5sum]
-    end
-  end
-
-  ##
-  # Clean up any files fcrepo_wrapper may have downloaded
-  # TODO: if this is used for solr_wrapper, we also need to remove tmp_save_dir
-  def clean!
-    stop
-    remove_instance_dir!
-    FileUtils.remove_entry(download_path) if File.exists? download_path
-    FileUtils.remove_entry(md5sum_path) if File.exists? md5sum_path
-    FileUtils.remove_entry(version_file) if File.exists? version_file
-  end
-
-  ##
-  # Clean up any files in the Solr instance dir
-  def remove_instance_dir!
-    FileUtils.remove_entry(instance_dir, true) if File.exists? instance_dir
-  end
-
-  def fetch_with_progressbar(url, output)
-    pbar = ProgressBar.create(title: File.basename(url), total: nil, format: "%t: |%B| %p%% (%e )")
-    open(url, content_length_proc: lambda do|t|
-      if t && 0 < t
-        pbar.total = t
-      end
-    end,
-              progress_proc: lambda do|s|
-                pbar.progress = s
-              end) do |io|
-      IO.copy_stream(io, output)
-    end
-  end
-
-  def md5file
-    unless File.exists? md5sum_path
-      fetch_with_progressbar md5url, md5sum_path
-    end
-
-    md5sum_path
-  end
-
-  def md5sum_path
-    File.join(Dir.tmpdir, File.basename(md5url))
-  end
-end