ldp_testsuite_wrapper 0.0.1

data/.rubocop_todo.yml

@@ -0,0 +1,45 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-02-08 11:12:25 -0800 using RuboCop version 0.37.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AlignWith, SupportedStyles, AutoCorrect.
+# SupportedStyles: keyword, variable, start_of_line
+Lint/EndAlignment:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 158
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 49
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 13
+
+# Offense count: 2
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/ldp_testsuite_wrapper.rb'
+    - 'lib/ldp_testsuite_wrapper/instance.rb'
+
+# Offense count: 1
+Style/DoubleNegation:
+  Exclude:
+    - 'lib/ldp_testsuite_wrapper/instance.rb'

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+sudo: false
+rvm:
+  - 2.2.0
+  - jruby-9.0.1.0
+cache:
+  directories:
+  - /tmp/solr-5.1.0

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in solr_wrapper.gemspec
+gemspec
+
+gem 'byebug'

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Chris Beer
+
+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,2 @@
+# ldp_testsuite_wrapper
+

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: ['spec']

data/coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/exe/ldp_testsuite_wrapper

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'ldp_testsuite_wrapper'
+require 'byebug'
+
+LdpTestsuiteWrapper.default_instance.exec(ARGV)

data/ldp_testsuite_wrapper.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ldp_testsuite_wrapper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ldp_testsuite_wrapper"
+  spec.version       = LdpTestsuiteWrapper::VERSION
+  spec.authors       = ["Chris Beer"]
+  spec.email         = ["chris@cbeer.info"]
+  spec.summary       = %q{LDP Test Suite service wrapper}
+  spec.homepage      = "https://github.com/cbeer/ldp_testsuite_wrapper"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rubyzip"
+  spec.add_dependency "ruby-progressbar"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "coveralls"
+end

data/lib/ldp_testsuite_wrapper/instance.rb

@@ -0,0 +1,234 @@
+require 'digest'
+require 'fileutils'
+require 'json'
+require 'open-uri'
+require 'ruby-progressbar'
+require 'securerandom'
+require 'socket'
+require 'stringio'
+require 'tmpdir'
+require 'zip'
+
+module LdpTestsuiteWrapper
+  class Instance
+    attr_reader :options, :pid
+
+    ##
+    # @param [Hash] options
+    # @option options [String] :url
+    # @option options [String] :download_dir Local directory to store the downloaded Solr zip and its md5 file in (overridden by :download_path)
+    # @option options [String] :download_path Local path for storing the downloaded Solr zip file
+    # @option options [Boolean] :verbose return verbose info when running commands
+    # @option options [Hash] :env
+    def initialize(options = {})
+      @options = options
+    end
+
+    ##
+    # Run a bin/solr command
+    # @param [Hash] options key-value pairs to transform into command line arguments
+    # @return [StringIO] an IO object for the executed shell command
+    # @see https://github.com/apache/lucene-solr/blob/trunk/solr/bin/solr
+    # If you want to pass a boolean flag, include it in the +options+ hash with its value set to +true+
+    # the key will be converted into a boolean flag for you.
+    def exec(options = {})
+      extract_and_configure
+
+      silence_output = !options.delete(:output)
+
+      args = if options.is_a? Array
+               options
+             else
+               ldp_testsuite_options.merge(options).map do |k, v|
+                 case v
+                 when true
+                   "-#{k}"
+                 when false, nil
+                   # don't return anything
+                 else
+                   ["-#{k}", v.to_s]
+                 end
+               end.flatten.compact
+      end
+
+      args = ['java', '-jar', ldp_testsuite_binary] + args
+
+      if IO.respond_to? :popen4
+        # JRuby
+        env_str = env.map { |k, v| "#{Shellwords.escape(k)}=#{Shellwords.escape(v)}" }.join(' ')
+        pid, input, output, error = IO.popen4(env_str + ' ' + args.join(' '))
+        @pid = pid
+        stringio = StringIO.new
+        if verbose? && !silence_output
+          IO.copy_stream(output, $stderr)
+          IO.copy_stream(error, $stderr)
+        else
+          IO.copy_stream(output, stringio)
+          IO.copy_stream(error, stringio)
+        end
+
+        input.close
+        output.close
+        error.close
+        exit_status = Process.waitpid2(@pid).last
+      else
+        IO.popen(env, args + [err: [:child, :out]]) do |io|
+          stringio = StringIO.new
+
+          if verbose? && !silence_output
+            IO.copy_stream(io, $stderr)
+          else
+            IO.copy_stream(io, stringio)
+          end
+
+          @pid = io.pid
+
+          _, exit_status = Process.wait2(io.pid)
+        end
+      end
+
+      stringio.rewind
+
+      [exit_status, stringio]
+    end
+
+    ##
+    # Clean up any files ldp_testsuite_wrapper may have downloaded
+    def clean!
+      stop
+      remove_instance_dir!
+      FileUtils.remove_entry(download_path) if File.exist?(download_path)
+      FileUtils.remove_entry(tmp_save_dir, true) if File.exist? tmp_save_dir
+      FileUtils.remove_entry(md5sum_path) if File.exist? md5sum_path
+      FileUtils.remove_entry(version_file) if File.exist? version_file
+    end
+
+    def configure
+      return if File.exist? ldp_testsuite_binary
+
+      Dir.chdir(instance_dir) do
+        `mvn package`
+      end
+    end
+
+    def instance_dir
+      @instance_dir ||= options.fetch(:instance_dir, File.join(Dir.tmpdir, File.basename(download_url, '.zip')))
+    end
+
+    def extract_and_configure
+      instance_dir = extract
+      configure
+      instance_dir
+    end
+
+    # rubocop:disable Lint/RescueException
+
+    # extract a copy of solr to instance_dir
+    # Does noting if solr already exists at instance_dir
+    # @return [String] instance_dir Directory where solr has been installed
+    def extract
+      return instance_dir if extracted?
+
+      zip_path = download
+
+      begin
+        Zip::File.open(zip_path) do |zip_file|
+          # Handle entries one by one
+          zip_file.each do |entry|
+            dest_file = File.join(tmp_save_dir, entry.name)
+            FileUtils.remove_entry(dest_file, true)
+            entry.extract(dest_file)
+          end
+        end
+
+      rescue Exception => e
+        abort "Unable to unzip #{zip_path} into #{tmp_save_dir}: #{e.message}"
+      end
+
+      begin
+        FileUtils.remove_dir(instance_dir, true)
+        FileUtils.cp_r File.join(tmp_save_dir, "ldp-testsuite-#{version}"), instance_dir
+      rescue Exception => e
+        abort "Unable to copy #{tmp_save_dir} to #{instance_dir}: #{e.message}"
+      end
+
+      instance_dir
+    ensure
+      FileUtils.remove_entry tmp_save_dir if File.exist? tmp_save_dir
+    end
+    # rubocop:enable Lint/RescueException
+
+    def version
+      options.fetch(:version)
+    end
+
+    protected
+
+    def extracted?
+      File.exist?(ldp_testsuite_binary)
+    end
+
+    def download
+      unless File.exist?(download_path)
+        fetch_with_progressbar download_url, download_path
+      end
+      download_path
+    end
+
+    def ldp_testsuite_options
+      {}
+    end
+
+    private
+
+    def download_url
+      @download_url ||= options.fetch(:url, default_download_url)
+    end
+
+    def default_download_url
+      "https://github.com/w3c/ldp-testsuite/archive/#{version}.zip"
+    end
+
+    def env
+      options.fetch(:env, {})
+    end
+
+    def download_path
+      @download_path ||= options.fetch(:download_path, default_download_path)
+    end
+
+    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 ldp_testsuite_binary
+      File.join(instance_dir, 'target', "ldp-testsuite-#{version}-shaded.jar")
+    end
+
+    def tmp_save_dir
+      @tmp_save_dir ||= Dir.mktmpdir
+    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|
+        pbar.total = t if t && 0 < t
+      end,
+                progress_proc: lambda do |s|
+                  pbar.progress = s
+                end) do |io|
+        IO.copy_stream(io, output)
+      end
+    end
+  end
+end

data/lib/ldp_testsuite_wrapper/version.rb

@@ -0,0 +1,3 @@
+module LdpTestsuiteWrapper
+  VERSION = '0.0.1'.freeze
+end

data/lib/ldp_testsuite_wrapper.rb

@@ -0,0 +1,23 @@
+require 'ldp_testsuite_wrapper/version'
+require 'ldp_testsuite_wrapper/instance'
+
+module LdpTestsuiteWrapper
+  def self.default_test_suite_version
+    '0.1.1'
+  end
+
+  def self.default_instance_options
+    @default_instance_options ||= {
+      port: '8983',
+      version: LdpTestsuiteWrapper.default_test_suite_version
+    }
+  end
+
+  def self.default_instance_options=(options)
+    @default_instance_options = options
+  end
+
+  def self.default_instance(options = {})
+    @default_instance ||= LdpTestsuiteWrapper::Instance.new default_instance_options.merge(options)
+  end
+end

data/spec/lib/ldp_testsuite_wrapper_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe LdpTestsuiteWrapper do
+  describe '.default_instance_options=' do
+    it 'sets default options' do
+      LdpTestsuiteWrapper.default_instance_options = { port: '1234' }
+      expect(LdpTestsuiteWrapper.default_instance_options[:port]). to eq '1234'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'ldp_testsuite_wrapper'
+
+require 'rspec'
+FIXTURES_DIR = File.expand_path('fixtures', File.dirname(__FILE__))
+
+RSpec.configure do |_config|
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: ldp_testsuite_wrapper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Beer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: coveralls
+  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'
+description: 
+email:
+- chris@cbeer.info
+executables:
+- ldp_testsuite_wrapper
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_hound.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- coveralls.yml
+- exe/ldp_testsuite_wrapper
+- ldp_testsuite_wrapper.gemspec
+- lib/ldp_testsuite_wrapper.rb
+- lib/ldp_testsuite_wrapper/instance.rb
+- lib/ldp_testsuite_wrapper/version.rb
+- spec/lib/ldp_testsuite_wrapper_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/cbeer/ldp_testsuite_wrapper
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: LDP Test Suite service wrapper
+test_files:
+- spec/lib/ldp_testsuite_wrapper_spec.rb
+- spec/spec_helper.rb