pigspec 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e976beef7562e44da2622c367d5aed0c9b8fd0b
+  data.tar.gz: fdd80f3420090ac64a1b9389c67992db7b745f26
+SHA512:
+  metadata.gz: 5b3bb24cb0bd3379653a4c90a8969777043d0a007cef7eee33e4ebe5bc6497432abe5c1ad981b6b7476dc57bb3ea3f28bb2be36a7b2126b79fab8dde83e2004d
+  data.tar.gz: d65677aa13302ea25c6d54acedbf43117188f939baf8062b3918dedbf652699b6d13a55428db30957191e4efdc7d331fe15c34d9022691e04823279a6f84f5fd

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,8 @@
+Style/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/LineLength:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 shiracha
+
+MIT License
+
+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,87 @@
+# PigSpec
+
+PigSpec is a extention for rspec testing framework for Apache Pig.
+This extention can execute pig script with customize input relation data, and can get output relation data in ruby easily.
+
+
+## Installation
+PigSpec uses Pig and PigUnit.
+Thus, install Pig and PigUnit first.
+
+Second. install gem of pigspec.
+
+If you using bundle, You write Gemfile to
+
+```ruby
+gem 'pigspec'
+```
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install pigspec
+```
+
+
+## Usage
+
+First: write a test case in your rspec code.
+Sample:
+```ruby
+require 'pigspec'
+include PigSpec
+
+describe 'SamplePigTest' do
+  it 'sample test' do
+    actual = pig do
+      script <<-EOS
+        in = LOAD 'inputfile' AS (query:chararray);
+        out = LIMIT in 1;
+        STORE out INTO 'outputfile';
+      EOS
+      with_args 'n=2'
+      override 'in', %w(hoge hoge hoge)
+      pickup 'out'
+    end
+    expect(actual).to eq([['hoge']])
+  end
+end
+```
+
+pig returns `pickup`ed alias datas.
+
+Readed datatype are following:
+
+| Pig DataType          | Ruby Class   |
+|-----------------------|--------------|
+| bag                   | Array        |
+| tuple                 | Array        |
+| map                   | String       |
+| chararray             | String       |
+| bytearray             | String       |
+| datetime              | String       |
+| long                  | Integer      |
+| integer               | Integer      |
+| double                | Float        |
+| float                 | Float        |
+| boolean               | True/False   |
+
+
+Second: Set environment variable `PIG_HOME` to Your pig installed directory, And Run.
+```bash
+export PIG_HOME=<your pig installed dir>
+spec
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/shiracha/pigspec/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/lib/pigspec/javabridge.rb

@@ -0,0 +1,145 @@
+require 'rjb'
+require 'tempfile'
+
+# A testing framework for pig
+module PigSpec
+  # bridge for java pig classies
+  class JavaBridge
+    def initialize(pig_home = ENV['PIG_HOME'])
+      fail ArgumentError, 'pig_home must not be nil.' unless pig_home
+
+      Rjb.add_classpath(File.join(pig_home, 'pig.jar'))
+      Rjb.add_classpath(File.join(pig_home, 'pigunit.jar'))
+
+      Rjb.load '.', ['-Dfile.encoding=UTF-8']
+
+      Rjb.add_jar(File.join(pig_home, 'pig.jar'))
+      Rjb.add_jar(File.join(pig_home, 'pigunit.jar'))
+
+      import_classies
+    end
+
+    def unload
+      @pig_test_class = nil
+      @cluster_class = nil
+      @file_localizer_class = nil
+      @pig_server_class = nil
+      @schema_class = nil
+      @string_builder_class = nil
+      @data_type_enum = nil
+      @string_util_class = nil
+      Rjb.unload
+      GC.start
+    end
+
+    def create_test(script, *args)
+      instance = @pig_test_class.new script, args
+      JavaPigTest.new self, instance
+    end
+
+    def context
+      @pig_test_class.getPigServer.getPigContext
+    end
+
+    def create_hdfs_temp
+      @file_localizer_class.getTemporaryPath(context).toString
+    end
+
+    def server
+      @pig_test_class.getPigServer
+    end
+
+    def cluster
+      @pig_test_class.getCluster
+    end
+
+    def upload_text(text, path)
+      cluster.copyFromLocalFile(text, path, true)
+    end
+
+    def schema(alias_name)
+      raw_schema = server.dumpSchema(alias_name)
+      builder = @string_builder_class.new
+      @schema_class.stringifySchema(builder, raw_schema, @data_type_enum.TUPLE)
+      builder.toString
+    end
+
+    def stringify(alias_values)
+      @string_util_class.join(alias_values, "\n")
+    end
+
+    attr_reader :data_type_enum
+
+  private
+
+    def import_classies
+      require 'rjb/list'
+      @pig_test_class = Rjb.import('org.apache.pig.pigunit.PigTest')
+      @cluster_class = Rjb.import('org.apache.pig.pigunit.Cluster')
+      @file_localizer_class = Rjb.import('org.apache.pig.impl.io.FileLocalizer')
+      @pig_server_class = Rjb.import('org.apache.pig.pigunit.pig.PigServer')
+      @schema_class = Rjb.import('org.apache.pig.impl.logicalLayer.schema.Schema')
+      @string_builder_class = Rjb.import('java.lang.StringBuilder')
+      @data_type_enum = Rjb.import('org.apache.pig.data.DataType')
+      @string_util_class = Rjb.import('org.apache.commons.lang.StringUtils')
+    end
+  end
+
+  # Wrapper for java Pigtest class.
+  class JavaPigTest
+    def initialize(bridge, instance)
+      @bridge = bridge
+      @instance = instance
+    end
+
+    def register_script
+      # runScript method only register pigscript.
+      # pig uses 'lazy run' to decide really output alias.
+      @instance.runScript
+    end
+
+    def run_script(goal_alias)
+      items = []
+      @instance.getAlias(goal_alias).each do |item|
+        items.push read_tuple(item)
+      end
+      items
+    end
+
+    def override(name, query)
+      @instance.override name, query
+    end
+
+  private
+
+    def read_as(type, value)  # rubocop:disable Metrics/AbcSize, Style/CyclomaticComplexity, Style/MethodLength
+      return value unless type
+      # AllTypes: http://pig.apache.org/docs/r0.11.1/api/org/apache/pig/data/DataType.html
+      types = @bridge.data_type_enum
+      case type
+      when types.CHARARRAY, types.BYTEARRAY, types.DATETIME then value.toString
+      # daringly no cast to test convinience
+      when types.DATETIME then value.toString
+      when types.LONG, types.INTEGER, types.BYTE then value.toString.to_i
+      when types.DOUBLE, types.FLOAT then value.toString.to_f
+      when types.BOOLEAN then value.toString.downcase.include? 't'
+      when types.TUPLE then read_tuple value
+      # TODO: types.MAP is schemaless...How to cast it...?
+      when types.MAP then value.toString # read_map value
+      when types.UNKNOWN then nil
+      else nil
+      end
+    end
+
+    def read_tuple(tuple)
+      casted = []
+      tuple.size.times do|index|
+        type = tuple.getType index
+        value = nil
+        value = tuple.get(index) unless tuple.isNull index
+        casted.push read_as(type, value)
+      end
+      casted
+    end
+  end
+end # module PigSpec

data/lib/pigspec/version.rb

@@ -0,0 +1,4 @@
+# PigSpec version constant
+module PigSpec
+  VERSION = '0.0.1'
+end

data/lib/pigspec.rb

@@ -0,0 +1,98 @@
+require 'pigspec/version'
+require 'pigspec/javabridge'
+
+require 'cleanroom'
+require 'tempfile'
+
+# A testing framework for pig
+module PigSpec
+  # TestCase of PigSpec
+  class Test
+    include Cleanroom
+
+    class << self
+      attr_reader :bridge
+      def construct
+        @bridge ||= JavaBridge.new
+      rescue ArgumentError
+        raise 'Environment variable PIG_HOME does not found or does not correct. It must point to your installation of Apache Pig.'
+      end
+    end
+
+    def setup
+      Test.construct
+      @script = []
+      @args = []
+      @override = []
+      @pickup = nil
+    end
+
+    def shutdown
+      # Rjb unload -> load is not work.(current restriction.)
+      # s.a https://github.com/arton/rjb/issues/34
+      # If the JNI bug fixed then we can uncomment follow line.
+      # @bridge.unload
+    end
+
+    def script(text)
+      @script = text.split("\n")
+    end
+    expose :script
+
+    def script_file(path)
+      @script = open(path, 'r') { |f| f.each_line.to_a }
+    end
+    expose :script_file
+
+    def with_args(*args)
+      @args = args
+    end
+    expose :with_args
+
+    def override(name, value)
+      @override.push name: name, value: value
+    end
+    expose :override
+
+    # to 'expose'
+    def pickup(name)  # rubocop:disable Style/TrivialAccessors
+      @pickup = name
+    end
+    expose :pickup
+
+    def run
+      # If no output alias, must result nil
+      return nil unless @pickup
+
+      test = Test.bridge.create_test @script, *@args
+      test.register_script
+      apply_override test
+      test.run_script @pickup
+    end
+
+  private
+
+    def apply_override(test)
+      @override.each do |item|
+        temp = Test.bridge.create_hdfs_temp
+        Test.bridge.upload_text item[:value], temp
+
+        schema = Test.bridge.schema item[:name]
+
+        query = "#{item[:name]} = LOAD '#{temp}' USING PigStorage('\\t') AS #{schema};"
+        test.override item[:name], query
+      end
+    end
+  end # class Test
+
+module_function
+
+  def pig(&block)
+    test = Test.new
+    test.setup
+    test.evaluate(&block)
+    result = test.run
+    test.shutdown
+    result
+  end
+end # module PigSpec

data/pigspec.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pigspec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pigspec'
+  spec.version       = PigSpec::VERSION
+  spec.authors       = ['shiracha']
+  spec.email         = ['shiracha.rikyu@gmail.com']
+  spec.summary       = 'A Testing Framework extension for Apache Pig.'
+  spec.description   = 'A Testing Framework extension for Apache Pig.To setup, executing and get the result.'
+  spec.homepage      = 'https://github.com/shiracha/pigspec'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rjb'
+  spec.add_dependency 'cleanroom'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+end

data/spec/pig/counting_macro.pig

@@ -0,0 +1,4 @@
+DEFINE counting_macro(rel, column) RETURNS RET {
+    rel_00 = GROUP $rel BY ($column);
+    $RET = FOREACH rel_00 GENERATE group as word, COUNT($rel) AS count;
+};

data/spec/pig/test.pig

@@ -0,0 +1,3 @@
+in = LOAD 'inputfile' AS (query:chararray);
+out = LIMIT in 1;
+STORE out INTO 'outputfile';

data/spec/pig/test2.pig

@@ -0,0 +1,5 @@
+IMPORT 'spec/pig/test_macro.pig';
+in = LOAD 'inputfile' AS (query:chararray);
+macro_in = LIMIT in 1;
+out = test_macro(macro_in, 'query');
+STORE out INTO 'outputfile';

data/spec/pig/test_macro.pig

@@ -0,0 +1,3 @@
+DEFINE test_macro(rel, column) RETURNS RET {
+    $RET = FOREACH $rel GENERATE CONCAT('testconcat_', $column);
+};

data/spec/pigspec_spec.rb

@@ -0,0 +1,114 @@
+require 'spec_helper'
+
+# ---------------------- test data constants
+input_alias = 'in'
+input = %w(
+  hoge
+  hoge
+  hoge
+  hoge
+  haga
+  haga
+  hage
+  hage
+  hage
+  huge
+)
+output_alias = 'out'
+output = [['hoge']]
+
+# ---------------------- test
+
+include PigSpec
+
+describe PigSpec do
+  it 'has a version number' do
+    expect(PigSpec::VERSION).not_to be nil
+  end
+
+  it 'can run' do
+    actual = pig do
+      script <<-EOS
+        in = LOAD 'inputfile' AS (query:chararray);
+        out = LIMIT in 1;
+        STORE out INTO 'outputfile';
+      EOS
+      with_args 'n=2'
+      override input_alias, input
+      pickup output_alias
+    end
+    expect(actual).to eq(output)
+  end
+
+  it 'can run from file' do
+    actual = pig do
+      script_file 'spec/pig/test.pig'
+      with_args 'n=2'
+      override input_alias, input
+      pickup output_alias
+    end
+    expect(actual).to eq(output)
+  end
+
+  it 'can import pig macro(script)' do
+    actual = pig do
+      script <<-EOS
+        IMPORT 'spec/pig/test_macro.pig';
+        in = LOAD 'inputfile' AS (query:chararray);
+        macro_in = LIMIT in 1;
+        out = test_macro(macro_in, 'query');
+        STORE out INTO 'outputfile';
+      EOS
+      with_args 'n=2'
+      override input_alias, input
+      pickup output_alias
+    end
+    expect(actual).to eq([['testconcat_hoge']])
+  end
+
+  it 'can import pig macro(script_file)' do
+    actual = pig do
+      script_file 'spec/pig/test2.pig'
+      with_args 'n=2'
+      override input_alias, input
+      pickup output_alias
+    end
+    expect(actual).to eq([['testconcat_hoge']])
+  end
+
+  # TODO: avoiding duplicated macro error...
+  it 'can define macro on script', skip: true  do
+    actual = pig do
+      script <<-EOS
+        DEFINE counting_macro(rel, column) RETURNS RET {
+            rel_00 = GROUP $rel BY ($column);
+            $RET = FOREACH rel_00 GENERATE group as word, COUNT($rel) AS count;
+        };
+        in_00 = LOAD 'inputfile' AS (query:chararray);
+        out_00 = counting_macro(in_00, 'query');
+        out = ORDER out_00 BY count DESC;
+        STORE out INTO 'outputfile';
+      EOS
+      with_args 'n=2'
+      override 'in_00', input
+      pickup output_alias
+    end
+    expect(actual).to eq([['hoge', 4], ['hage', 3], ['haga', 2], ['huge', 1]])
+  end
+
+  it 'can override macro relation' do
+    actual = pig do
+      script <<-EOS
+        IMPORT 'spec/pig/counting_macro.pig';
+        in_00 = LOAD 'inputfile' AS (query:chararray);
+        out_00 = counting_macro(in_00, 'query');
+        out = ORDER out_00 BY count DESC;
+        STORE out INTO 'outputfile';
+      EOS
+      with_args 'n=2'
+      override 'in_00', input
+      pickup output_alias
+    end
+    expect(actual).to eq([['hoge', 4], ['hage', 3], ['haga', 2], ['huge', 1]])
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+RSpec.configure do |c|
+  c.filter_run_excluding skip: true
+end
+require 'pigspec'

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: pigspec
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- shiracha
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rjb
+  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: cleanroom
+  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: rubocop
+  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: A Testing Framework extension for Apache Pig.To setup, executing and
+  get the result.
+email:
+- shiracha.rikyu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pigspec.rb
+- lib/pigspec/javabridge.rb
+- lib/pigspec/version.rb
+- pigspec.gemspec
+- spec/pig/counting_macro.pig
+- spec/pig/test.pig
+- spec/pig/test2.pig
+- spec/pig/test_macro.pig
+- spec/pigspec_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/shiracha/pigspec
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A Testing Framework extension for Apache Pig.
+test_files:
+- spec/pig/counting_macro.pig
+- spec/pig/test.pig
+- spec/pig/test2.pig
+- spec/pig/test_macro.pig
+- spec/pigspec_spec.rb
+- spec/spec_helper.rb