pdi 2.0.0.pre.alpha

data/lib/pdi/spoon/parser.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2020-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module Pdi
+  class Spoon
+    # This class knows how to parse feedback from Pentaho and make sense of it.
+    class Parser
+      NEW_LINE = "\n"
+
+      def version(string)
+        string.to_s
+              .chomp
+              .split(NEW_LINE)
+              .last
+              .to_s
+      end
+    end
+  end
+end

data/lib/pdi/spoon/result.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2020-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module Pdi
+  class Spoon
+    # General return object for wrapping up a execution call result (execution) and
+    # a usable result (value)
+    class Result
+      attr_reader :execution, :value
+
+      def initialize(execution, value)
+        @execution = execution
+        @value     = value
+
+        freeze
+      end
+    end
+  end
+end

data/lib/pdi/version.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2020-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module Pdi
+  VERSION = '2.0.0-alpha'
+end

data/pdi.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require './lib/pdi/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'pdi'
+  s.version     = Pdi::VERSION
+  s.summary     = 'Ruby wrapper for invoking Pentaho Data Integration'
+
+  s.description = <<-DESCRIPTION
+    Pentaho Data Integration allows for the creation of ETL transformation and jobs.  This library allows those ETL tasks to be executed from Ruby.
+  DESCRIPTION
+
+  s.authors     = ['Matthew Ruggio']
+  s.email       = ['mruggio@bluemarblepayroll.com']
+  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.homepage    = 'https://github.com/bluemarblepayroll/pdi'
+  s.license     = 'MIT'
+
+  s.required_ruby_version = '>= 2.3.8'
+
+  s.add_dependency('acts_as_hashable', '~>1')
+
+  s.add_development_dependency('guard-rspec', '~>4.7')
+  s.add_development_dependency('pry', '~>0')
+  s.add_development_dependency('rake', '~> 13')
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('rubocop', '~>0.79.0')
+  s.add_development_dependency('simplecov', '~>0.17.0')
+  s.add_development_dependency('simplecov-console', '~>0.6.0')
+end

data/spec/mocks/spoon/return_code.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+error(){
+  echo "$1" >&2
+}
+
+output(){
+  echo "$1"
+}
+
+output "output to stdout"
+error "output to sterr"
+
+exit $1

data/spec/mocks/spoon/sleep.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+echo 'std_out'
+echo 'err_out' >&2
+
+sleep $1
+
+echo 'after_sleep'
+
+exit $2

data/spec/mocks/spoon/version.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+echo 'random info'
+echo 'random info'
+echo 'random info'
+echo 'random info'
+echo 'random info'
+echo '2020/01/30 13:31:04 - Pan - Kettle version 6.1.0.1-196, build 1, build date : 2016-04-07 12.08.49'
+
+exit 0

data/spec/pdi/executor_spec.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2018-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'spec_helper'
+
+describe Pdi::Executor do
+  let(:script)      { File.join('spec', 'mocks', 'spoon', 'sleep.sh') }
+  let(:one_second)  { 1 }
+  let(:return_code) { 33 }
+
+  describe '#run' do
+    context 'with a timeout' do
+      # do not make these too high, bugs could cause the entire script to still be executed without
+      # killing it so these high values could draw out results.
+      let(:thirty_seconds) { 30 }
+
+      subject { described_class.new(timeout_in_seconds: one_second) }
+
+      # This will run a script that will take 30 seconds to process, but by limiting the
+      # timeout using the #run argument, it should raise an error after one second.
+      it 'times out and kills process after 5 seconds' do
+        args = [script, thirty_seconds]
+
+        expect { subject.run(args) }.to raise_error(Timeout::Error)
+      end
+    end
+
+    context 'without a timeout' do
+      it 'returns right exit status as code' do
+        args = [script, one_second, return_code]
+
+        result = subject.run(args)
+
+        expect(result.code).to eq(return_code)
+      end
+
+      it 'returns right standard output and error as out' do
+        args = [script, one_second, return_code]
+
+        result = subject.run(args)
+
+        expect(result.out).to eq("std_out\nerr_out\nafter_sleep\n")
+      end
+    end
+  end
+end

data/spec/pdi/spoon/kitchen_error_spec.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2018-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'spec_helper'
+
+describe Pdi::Spoon::KitchenError do
+  describe 'initialization' do
+    [1, 2, 7, 8, 9].each do |code|
+      specify "code #{code} should have message" do
+        result = Pdi::Executor::Result.new(
+          args: [],
+          status: {
+            code: code,
+            pid: 123
+          }
+        )
+
+        expect(described_class.new(result).message).not_to eq('Unknown')
+      end
+    end
+
+    [-1, 0, 3, 4, 5, 6, 10, 11].each do |code|
+      specify "code #{code} should not have message" do
+        result = Pdi::Executor::Result.new(
+          args: [],
+          status: {
+            code: code,
+            pid: 123
+          }
+        )
+
+        expect(described_class.new(result).message).to eq('Unknown')
+      end
+    end
+  end
+end

data/spec/pdi/spoon/options/arg_spec.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2018-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'spec_helper'
+
+describe Pdi::Spoon::Options::Arg do
+  let(:key)   { :param }
+  let(:value) { 'v1' }
+  let(:value_with_space) { 'v 1' }
+
+  describe '#initialize' do
+    subject { described_class.new(key, value) }
+
+    it 'requires a key' do
+      expect { described_class.new('') }.to raise_error(ArgumentError)
+    end
+
+    it 'sets key' do
+      expect(subject.key).to eq(key)
+    end
+
+    it 'sets value' do
+      expect(subject.value).to eq(value)
+    end
+  end
+
+  describe '#to_s' do
+    it 'works without a value' do
+      subject  = described_class.new(key)
+      expected = "-#{key}"
+
+      expect(subject.to_s).to eq(expected)
+    end
+
+    it 'works with a value (with no space)' do
+      subject  = described_class.new(key, value)
+      expected = "-#{key}:#{value}"
+
+      expect(subject.to_s).to eq(expected)
+    end
+
+    it 'works with a value (with a space)' do
+      subject  = described_class.new(key, value_with_space)
+      expected = "\"-#{key}:#{value_with_space}\""
+
+      expect(subject.to_s).to eq(expected)
+    end
+  end
+
+  describe 'equality' do
+    let(:subject2) { described_class.new(key, value) }
+
+    subject { described_class.new(key, value) }
+
+    specify '#hash compares key and value' do
+      expect(subject.hash).to eq(subject2.hash)
+    end
+
+    specify '#== compares #to_s values' do
+      expect(subject).to eq(subject2)
+    end
+
+    specify '#eql? compares #to_s values' do
+      expect(subject).to eql(subject2)
+    end
+  end
+end

data/spec/pdi/spoon/options/param_spec.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2018-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'spec_helper'
+
+describe Pdi::Spoon::Options::Param do
+  let(:key)   { 'k1' }
+  let(:value) { 'v1' }
+  let(:value_with_space) { 'v 1' }
+
+  describe '#to_s' do
+    it 'works without a value' do
+      subject  = described_class.new(key)
+      expected = "-param:#{key}="
+
+      expect(subject.to_s).to eq(expected)
+    end
+
+    it 'works with a value (with no space)' do
+      subject  = described_class.new(key, value)
+      expected = "-param:#{key}=#{value}"
+
+      expect(subject.to_s).to eq(expected)
+    end
+
+    it 'works with a value (with a space)' do
+      subject  = described_class.new(key, value_with_space)
+      expected = "\"-param:#{key}=#{value_with_space}\""
+
+      expect(subject.to_s).to eq(expected)
+    end
+  end
+end

data/spec/pdi/spoon/options_spec.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2018-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'spec_helper'
+
+describe Pdi::Spoon::Options do
+  describe '#to_args' do
+    let(:params) do
+      {
+        key1: 'value1',
+        key2: 'value2',
+        key3: 'value with spaces'
+      }
+    end
+
+    let(:repository) { 'some repo' }
+    let(:name)       { 'some_transformation' }
+
+    subject do
+      described_class.new(
+        params: params,
+        repository: repository,
+        name: name,
+        type: type
+      )
+    end
+
+    context 'when type is transformation' do
+      let(:type) { 'transformation' }
+
+      it 'wraps any args with spaces inside double quotes' do
+        args             = subject.to_args
+        args_with_spaces = args.select { |a| a.to_s.include?(' ') }
+
+        raise ArgumentError, 'no examples to assert!' if args_with_spaces.empty?
+
+        args_with_spaces.each do |arg|
+          actual = arg.to_s
+
+          expect(actual).to start_with('"')
+          expect(actual).to end_with('"')
+        end
+      end
+
+      it 'includes each option' do
+        expected = [
+          '"-rep:some repo"',
+          '-trans:some_transformation',
+          '-level:Basic',
+          '-param:key1=value1',
+          '-param:key2=value2',
+          '"-param:key3=value with spaces"'
+        ]
+
+        expected_set = Set[*expected]
+        actual_set   = Set[*subject.to_args.map(&:to_s)]
+
+        expect(actual_set).to eq(expected_set)
+      end
+    end
+
+    context 'when type is job' do
+      let(:type) { 'job' }
+
+      it 'wraps any args with spaces inside double quotes' do
+        args             = subject.to_args
+        args_with_spaces = args.select { |a| a.to_s.include?(' ') }
+
+        raise ArgumentError, 'no examples to assert!' if args_with_spaces.empty?
+
+        args_with_spaces.each do |arg|
+          actual = arg.to_s
+
+          expect(actual).to start_with('"')
+          expect(actual).to end_with('"')
+        end
+      end
+
+      it 'includes each option' do
+        expected = [
+          '"-rep:some repo"',
+          '-job:some_transformation',
+          '-level:Basic',
+          '-param:key1=value1',
+          '-param:key2=value2',
+          '"-param:key3=value with spaces"'
+        ]
+
+        expected_set = Set[*expected]
+        actual_set   = Set[*subject.to_args.map(&:to_s)]
+
+        expect(actual_set).to eq(expected_set)
+      end
+    end
+  end
+end