jackal 0.3.12 → 0.3.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02001e5b2ff6b59d1031f8121657bcb1e7ed5ee7
-  data.tar.gz: 0392d96103ada117ed0d36efb82aa8bb4c1033c2
+  metadata.gz: 7253602def38f284c8ad696165795a312490d5dd
+  data.tar.gz: 596d502a71246dc3c4534899841e1e63dc4f982d
 SHA512:
-  metadata.gz: 6eeb8f2de5be35b540209a3a366ffbf7c3668b5df73dd123509549ca7be26ee8b9a3577a80b65499cd23d81a25ea679b5ecd54cfd28e9e8b9757ff692be0afc7
-  data.tar.gz: 23cf4aa6b4966daa6b4329e5d88c03aeaa2ec16b25da321da68a579bb4fb59905784b10316c8f7f908dd5431fef7ba47599d21f82b3b6723c430e19d3faf2bf4
+  metadata.gz: bac6c34c10109837b87bb9debc3490cb301cee1c5fb0bbab4434fb0a039ff93c021d82e6dcf79961aac09f0e8d2d9d83c648a6edcc76f094b7e8440f35e0ed6e
+  data.tar.gz: 2ff2bb0ff8927e174f008dd36ecd141191a94f7f7f73958e3fe3d5e0567d9b505a8882c817d14c5395951fe7c9d726bbe872d7679dd8c7bd322636c306034700

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# v0.3.14
+* Add test scaffold generator
+* Update carnivore constraint
+
 # v0.3.12
 * Set default verbosity to :info
 * Support changing spec runner

data/bin/jackal-test

@@ -2,4 +2,26 @@
 # -*- mode: ruby -*-
 # -*- encoding: utf-8 -*-
 
-require 'jackal/utils/spec/loader'
+require 'bogo-cli'
+require 'jackal'
+
+# This conditional is necessary since the cli parsing has a no-arg
+#   default of printing the help menu (not able to override the default)
+if ARGV.empty?
+  require 'jackal/utils/spec/loader'
+else
+  Bogo::Cli::Setup.define do
+    global_opts = lambda do
+      on :s, 'service-name=', 'Service to test (Eg: Jackal::Mail::Smtp - mail)', :required => true
+      on :m, 'module-name=',  'Module to test  (Eg: Jackal::Mail::Smtp - smtp)', :required => true
+    end
+
+    command 'generate' do
+      description 'Generate test boilerplate for jackal-test'
+      self.instance_exec(&global_opts)
+      run do |opts, args|
+        Jackal::Utils::Spec::Generator.new(opts.to_h, args).execute!
+      end
+    end
+  end
+end

data/jackal.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.description = 'Message processing helper'
   s.require_path = 'lib'
   s.license = 'Apache 2.0'
-  s.add_dependency 'carnivore', '>= 0.3.12', '< 1.0.0'
+  s.add_dependency 'carnivore', '>= 0.3.14', '< 1.0.0'
   s.add_dependency 'bogo', '>= 0.1.24', '< 1.0.0'
   s.add_dependency 'bogo-cli', '~> 0.1'
   s.add_dependency 'bogo-config', '>= 0.1.12', '< 1.0.0'

data/lib/jackal/utils/spec.rb

@@ -5,6 +5,7 @@ module Jackal
     # Testing helpers
     module Spec
       autoload :CallbackLocal, 'jackal/utils/spec/callback_local'
+      autoload :Generator, 'jackal/utils/spec/generator'
 
       class << self
 

data/lib/jackal/utils/spec/generator.rb

@@ -0,0 +1,185 @@
+require 'bogo-cli'
+require 'fileutils'
+require 'jackal'
+
+module Jackal
+  module Utils
+    module Spec
+      # Test files generator
+      class Generator < Bogo::Cli::Command
+
+        # Test directory path
+        TEST_DIR = 'test/specs'
+        # Test configuration directory path
+        TEST_CONFIG_DIR = 'test/specs/config'
+        # Lines required within Gemfile
+        GEMFILE_LINES = [
+          "gem 'carnivore-actor'",
+          "gem 'minitest'",
+          "gem 'pry'"
+        ]
+
+        # Create new instance
+        #
+        # @return [self]
+        def initialize(*_)
+          super
+
+          @orig_service_name = options[:service_name].downcase
+          @service_name = Bogo::Utility.snake(@orig_service_name)
+          @service_class_name = Bogo::Utility.camel(@service_name)
+
+          @module_name = options[:module_name].downcase
+          @module_class_name = Bogo::Utility.camel(@module_name)
+
+          @callback_type   = 'jackal'
+          @supervisor_name = "jackal_#{@service_name}_input"
+        end
+
+        # Generate test files
+        #
+        # @return [TrueClass]
+        def execute!
+          ui.info 'Generating jackal test files'
+
+          # ensure dependencies are present in Gemfile
+          run_action 'Update Gemfile contents' do
+            update_gemfile
+            nil
+          end
+
+          run_action 'Create testing directory structure' do
+            # Create test directory structure
+            [TEST_DIR, TEST_CONFIG_DIR].each do |dir|
+              FileUtils.mkdir_p(dir)
+            end
+            nil
+          end
+
+          run_action 'Write test configuration file' do
+            conf_path = File.join(Dir.pwd, TEST_CONFIG_DIR, "#{@module_name}.rb")
+            write_file(conf_path, config_file_content)
+            nil
+          end
+
+          run_action 'Write default test spec file' do
+            spec_path = File.join(Dir.pwd, TEST_DIR, "#{@service_name}_spec.rb")
+            write_file(spec_path, spec_file_content)
+            nil
+          end
+
+          ui.info 'Jackal test file generation complete!'
+          true
+        end
+
+        # Configuration file content
+        #
+        # @return [String]
+        def config_file_content
+          <<-TEXT
+Configuration.new do
+  jackal do
+    require ["carnivore-actor", "jackal-#{@orig_service_name}"]
+
+    mail do
+      config do
+      end
+
+      sources do
+        input  { type 'actor' }
+        output { type 'spec' }
+      end
+
+      callbacks ['Jackal::#{@service_class_name}::#{@module_class_name}']
+    end
+  end
+end
+TEXT
+        end
+
+        # Spec file content
+        #
+        # @return [String]
+        def spec_file_content
+          <<TEXT
+require '#{@callback_type}-#{@orig_service_name}'
+require 'pry'
+
+# To stub out an api call for your callback
+class #{callback_class}::#{@service_class_name}::#{@module_class_name}
+  attr_accessor :test_payload
+
+  #def api_call(args)
+  #  test_payload.set(:args, args)
+  #end
+end
+
+describe #{callback_class}::#{@service_class_name}::#{@module_class_name} do
+
+  before do
+    @runner = run_setup(:#{@module_name})
+    track_execution(#{callback_class}::#{@service_class_name}::#{@module_class_name})
+  end
+
+  after do
+    @runner.terminate
+  end
+
+  let(:actor) { Carnivore::Supervisor.supervisor[:#{@supervisor_name}] }
+
+  it 'executes with empty payload' do
+    result = transmit_and_wait(actor, payload)
+    (!!result).must_equal true
+    callback_executed?(result).must_equal true
+  end
+
+  private
+
+  # payload to send for callback execution
+  def payload
+    Jackal::Utils.new_payload(:test, Smash.new)
+  end
+
+end
+TEXT
+        end
+
+        private
+
+        # @return [String] callback class name
+        def callback_class
+          @callback_class ||= Bogo::Utility.camel(@callback_type)
+        end
+
+        # Update the contents of the Gemfile with required items
+        #
+        # @return [TrueClass]
+        def update_gemfile
+          raise Errno::ENOENT.new('Gemfile (ensure file exists)') unless File.exists?('Gemfile')
+          gemfile = File.read('Gemfile')
+          lines = GEMFILE_LINES.select{ |l| !gemfile[l] } # only append items not already present
+
+          unless(lines.empty?)
+            File.open('Gemfile', 'a') do |f|
+              f << "\n"
+              lines.each { |l| f << (l + "\n") }
+            end
+          end
+          true
+        end
+
+        # Write file content to given path if file does not already
+        # exist
+        #
+        # @param path [String] path to write
+        # @param content [String] file content
+        # @return [Integer] number of bytes written
+        def write_file(path, content)
+          raise Errno::EEXIST.new(path) if File.exists?(path)
+          File.write(path, content)
+        end
+
+      end
+    end
+  end
+end

data/lib/jackal/version.rb

@@ -1,4 +1,4 @@
 module Jackal
   # Current library version
-  VERSION = Gem::Version.new('0.3.12')
+  VERSION = Gem::Version.new('0.3.14')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jackal
 version: !ruby/object:Gem::Version
-  version: 0.3.12
+  version: 0.3.14
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-10 00:00:00.000000000 Z
+date: 2015-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: carnivore
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.12
+        version: 0.3.14
     - - "<"
       - !ruby/object:Gem::Version
         version: 1.0.0
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.12
+        version: 0.3.14
     - - "<"
       - !ruby/object:Gem::Version
         version: 1.0.0
@@ -127,6 +127,7 @@ files:
 - lib/jackal/utils/process.rb
 - lib/jackal/utils/spec.rb
 - lib/jackal/utils/spec/callback_local.rb
+- lib/jackal/utils/spec/generator.rb
 - lib/jackal/utils/spec/helpers.rb
 - lib/jackal/utils/spec/loader.rb
 - lib/jackal/utils/spec/runner.rb
@@ -156,3 +157,4 @@ signing_key:
 specification_version: 4
 summary: Message processing helper
 test_files: []
+has_rdoc: