fix_spec 0.1.0

data/features/support/env.rb

@@ -0,0 +1,20 @@
+$: << File.expand_path("../../../lib", __FILE__)
+
+require "fix_spec/cucumber"
+require "fix_spec/builder"
+
+def last_fix
+  @last_fix
+end
+
+Around('@with_data_dictionary') do |scenario, block|
+  FIXSpec::data_dictionary= quickfix.DataDictionary.new "features/support/FIX42.xml"
+  block.call
+  FIXSpec::data_dictionary= nil
+end
+
+Around('@ignore_length_and_checksum') do |scenario, block|
+  JsonSpec.excluded_keys=%w(CheckSum BodyLength)
+  block.call
+  JsonSpec.excluded_keys=JsonSpec::Configuration::DEFAULT_EXCLUDED_KEYS
+end

data/fix_spec.gemspec

@@ -0,0 +1,89 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "fix_spec"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chris Busbey"]
+  s.date = "2013-08-30"
+  s.description = "Build and Inspect FIX Messages with RSpec and Cucumber steps"
+  s.email = "info@connamara.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".travis.yml",
+    "CONTRIBUTION_GUIDELINES.md",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "QUICKFIX_LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "features/builder.feature",
+    "features/equivalence.feature",
+    "features/equivalence_data_dictionary.feature",
+    "features/memory.feature",
+    "features/message_type.feature",
+    "features/nested_builder.feature",
+    "features/paths.feature",
+    "features/step_definitions/steps.rb",
+    "features/support/FIX42.xml",
+    "features/support/env.rb",
+    "fix_spec.gemspec",
+    "lib/fix_spec.rb",
+    "lib/fix_spec/builder.rb",
+    "lib/fix_spec/configuration.rb",
+    "lib/fix_spec/cucumber.rb",
+    "lib/fix_spec/helpers.rb",
+    "lib/fix_spec/matchers.rb",
+    "lib/fix_spec/matchers/be_fix_eql.rb",
+    "lib/fix_spec/matchers/have_fix_path.rb",
+    "spec/fix_spec/helpers_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/connamara/fix_spec"
+  s.licenses = ["GPL"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Build and Inspect FIX Messages"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<json_spec>, ["~> 1.1.1"])
+      s.add_runtime_dependency(%q<quickfix-jruby>, ["~> 1.5.3"])
+      s.add_runtime_dependency(%q<cuke_mem>, ["~> 0.1.1"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.14"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8"])
+      s.add_development_dependency(%q<cucumber>, ["~> 1.3"])
+      s.add_development_dependency(%q<rake>, ["~> 10.1"])
+    else
+      s.add_dependency(%q<json_spec>, ["~> 1.1.1"])
+      s.add_dependency(%q<quickfix-jruby>, ["~> 1.5.3"])
+      s.add_dependency(%q<cuke_mem>, ["~> 0.1.1"])
+      s.add_dependency(%q<rspec>, ["~> 2.14"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8"])
+      s.add_dependency(%q<cucumber>, ["~> 1.3"])
+      s.add_dependency(%q<rake>, ["~> 10.1"])
+    end
+  else
+    s.add_dependency(%q<json_spec>, ["~> 1.1.1"])
+    s.add_dependency(%q<quickfix-jruby>, ["~> 1.5.3"])
+    s.add_dependency(%q<cuke_mem>, ["~> 0.1.1"])
+    s.add_dependency(%q<rspec>, ["~> 2.14"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8"])
+    s.add_dependency(%q<cucumber>, ["~> 1.3"])
+    s.add_dependency(%q<rake>, ["~> 10.1"])
+  end
+end
+

data/lib/fix_spec/builder.rb

@@ -0,0 +1,99 @@
+#encoding ascii
+
+module FIXSpec
+module Builder
+  def self.message
+    @message
+  end
+
+  def self.message= msg
+    @message=msg
+  end
+end
+end
+ 
+Given /^the following( unvalidated)? fix message:$/ do |unvalidated,fix_str|
+  factory = quickfix.DefaultMessageFactory.new
+  unless unvalidated
+    FIXSpec::Builder.message = quickfix.MessageUtils.parse(factory, FIXSpec::data_dictionary, FIXSpec::Helpers.fixify_string(fix_str) )
+  else
+    FIXSpec::Builder.message = quickfix.MessageUtils.parse(factory, nil, FIXSpec::Helpers.fixify_string(fix_str) )
+  end
+
+  FIXSpec::Builder.message.should_not be_nil
+end
+
+Given /^I create a (?:fix|FIX|(.*)) message(?: of type "(.*)")?$/ do |begin_string, msg_type|
+  FIXSpec::Builder.message = quickfix.Message.new
+
+  unless begin_string.nil?
+    steps %{And I set the FIX message at "BeginString" to "#{begin_string}"}
+  end
+
+  unless msg_type.nil?
+    steps %{And I set the FIX message at "MsgType" to "#{msg_type}"}
+  end
+end
+
+Given /^I create the following (?:fix|FIX|(.*)) message(?: of type "(.*)")?:$/ do |begin_string, msg_type, table|
+  FIXSpec::Builder.message = quickfix.Message.new
+
+  unless begin_string.nil?
+    steps %{And I set the FIX message at "BeginString" to "#{begin_string}"}
+  end
+
+  unless msg_type.nil?
+    steps %{And I set the FIX message at "MsgType" to "#{msg_type}"}
+  end
+
+  table.raw.each do |tag, value|
+    steps %{And I set the FIX message at "#{tag}" to #{value}}
+  end
+end
+
+
+
+Given /^I set the (?:FIX|fix) message at(?: tag)? "(.*?)" to (".*"|\-?\d+(?:\.\d+)?(?:[eE][\+\-]?\d+)?|\[.*\]|%?\{.*\}|true|false|null)$/ do |fieldName, fieldValue|
+  FIXSpec::Builder.message.should_not be_nil
+
+  #kill quotes
+  if fieldValue.match(/\"(.*)\"/)
+    fieldValue=$1
+  end
+
+  tag = -1
+  if !FIXSpec::data_dictionary.nil? 
+    tag = FIXSpec::data_dictionary.getFieldTag(fieldName)
+    
+    msg = FIXSpec::Builder.message
+
+    if FIXSpec::data_dictionary.is_header_field(tag)
+      msg = msg.get_header
+    elsif FIXSpec::data_dictionary.is_trailer_field(tag)
+      msg = msg.get_trailer
+    end
+
+    if tag == -1 then
+      msg.setString(fieldName, fieldValue)
+      return
+    end
+
+    case FIXSpec::data_dictionary.get_field_type_enum(tag).get_name
+      when "INT","DAYOFMONTH" then 
+        msg.setInt(tag, fieldValue.to_i)
+      when "PRICE","FLOAT","QTY" then 
+        msg.setDouble(tag, fieldValue.to_f)
+      when "BOOLEAN" then 
+        msg.setBoolean(tag, fieldValue == "true")
+      else
+        msg.setString(tag, fieldValue)
+    end
+
+  else
+    tag = fieldName.to_i
+    FIXSpec::Builder.message.setString(tag, fieldValue)
+  end
+end
+
+
+

data/lib/fix_spec/configuration.rb

@@ -0,0 +1,16 @@
+module FIXSpec
+  module Configuration
+
+    def data_dictionary=(dd)
+      @data_dictionary=dd
+    end
+
+    def data_dictionary
+      return @data_dictionary
+    end
+
+    def reset
+      instance_variables.each{|ivar| remove_instance_variable(ivar)}
+    end
+  end
+end

data/lib/fix_spec/cucumber.rb

@@ -0,0 +1,76 @@
+require File.expand_path("../../fix_spec", __FILE__)
+require 'cuke_mem'
+
+World(JsonSpec::Helpers, JsonSpec::Matchers)
+World(FIXSpec::Matchers)
+
+Then /^the FIX message type should( not)? be "(.*?)"$/ do |negative, msg_type|
+
+  unless FIXSpec::data_dictionary.nil?
+    msg_type = FIXSpec::data_dictionary.get_msg_type(msg_type)
+  end
+
+  if negative
+    last_fix.header.get_string(35).should_not == msg_type
+  else
+    last_fix.header.get_string(35).should == msg_type
+  end
+end
+
+Then /^the (?:fix|FIX)(?: message)? at(?: tag)? "(.*?)" should( not)? be (".*"|\-?\d+(?:\.\d+)?(?:[eE][\+\-]?\d+)?|\[.*\]|%?\{.*\}|true|false|null)$/ do |tag, negative, exp_value|
+  if negative
+    last_fix.should_not be_fix_eql(CukeMem.remember(exp_value)).at_path(tag)
+  else
+    last_fix.should be_fix_eql(CukeMem.remember(exp_value)).at_path(tag)
+  end
+end
+
+Then /^the (?:fix|FIX)(?: message)?(?: at(?: tag)? "(.*?)")? should( not)? be:$/ do |tag, negative, exp_value|
+
+  # raw fix
+  if tag.nil? and not exp_value.match(/{*}/)
+    require 'fix_spec/builder'
+    factory = quickfix.DefaultMessageFactory.new
+    exp_message = FIXSpec::Builder.message = quickfix.MessageUtils.parse(factory, nil, FIXSpec::Helpers.fixify_string(exp_value) )
+    exp_value = FIXSpec::Helpers.message_to_unordered_json(exp_message)
+  end
+  
+  if negative
+    last_fix.should_not be_fix_eql(CukeMem.remember(exp_value)).at_path(tag)
+  else
+    last_fix.should be_fix_eql(CukeMem.remember(exp_value)).at_path(tag)
+  end
+  
+end
+
+Then /^the (?:fix|FIX)(?: message)? should( not)? be (".*"|\-?\d+(?:\.\d+)?(?:[eE][\+\-]?\d+)?|\[.*\]|%?\{.*\}|true|false|null)$/ do |negative, exp_value|
+  if negative
+    last_fix.should_not be_fix_eql(CukeMem.remember(exp_value))
+  else
+    last_fix.should be_fix_eql(CukeMem.remember(exp_value))
+  end
+end
+
+Then /^the (?:FIX|fix)(?: message)?(?: at "(.*)")? should have the following:$/ do |base, table|
+  table.raw.each do |path, value|
+    path = [base, path].compact.join("/")
+
+    if value
+      step %(the fix at "#{path}" should be:), value
+    else
+      step %(the fix should have "#{path}")
+    end
+  end
+end
+
+Then /^the (?:fix|FIX)(?: message)? should( not)? have(?: tag)? "(.*)"$/ do |negative, path|
+  if negative
+    last_fix.should_not have_fix_path(path)
+  else
+    last_fix.should have_fix_path(path)
+  end
+end
+
+When /^(?:I )?keep the (?:fix|FIX)(?: message)?(?: at(?: tag)? "(.*)")? as "(.*)"$/ do |path, key|
+  CukeMem.memorize(key, normalize_json(FIXSpec::Helpers.message_to_unordered_json(last_fix), path))
+end

data/lib/fix_spec/helpers.rb

@@ -0,0 +1,98 @@
+require 'multi_json'
+module FIXSpec
+  module Helpers
+    extend self
+
+    def fixify_string msg_str
+      message = msg_str.strip
+      begin_string = message.slice!(/^8=.*?[\001]/)
+
+      raise "Message '#{msg_str}' has no begin string" if begin_string.nil?
+
+      #nobody's perfect, allow for missing trailing soh 
+      message+="\001" unless message.end_with?("\001")
+
+      #auto-calc length and checksum, ignore any existing
+      message.slice!(/^9=\d+\001/)
+      message.gsub!(/10=\d\d\d\001$/,"")
+
+      length = "9=#{message.length}\001"
+      checksum = "10=%03d\001" % (begin_string + length + message).sum(8)
+      return (begin_string + length + message + checksum)
+    end
+
+    def message_to_unordered_json msg
+      MultiJson.encode message_to_hash(msg)
+    end
+
+    def message_to_hash msg
+      header = msg.get_header
+      msg_type = extract_message_type header
+      msg_hash = field_map_to_hash header
+      msg_hash.merge! field_map_to_hash msg, FIXSpec::data_dictionary, msg_type
+      msg_hash.merge field_map_to_hash msg.get_trailer
+    end
+
+    def extract_message_type msg
+      if msg.is_set_field( quickfix::field::MsgType::FIELD)
+        msg.get_field(quickfix::field::MsgType::FIELD).get_value
+      else
+        nil
+      end
+    end
+
+    def find_field_type tag, data_dictionaries = []
+      data_dictionaries.each do |dd|
+        enum = dd.get_field_type_enum(tag)
+        value = enum.get_name unless enum.nil?
+        return value unless value.nil? or value.eql?("")
+      end
+    end
+
+    def find_field_name tag, data_dictionaries = []
+      data_dictionaries.each do |dd|
+        value = dd.get_field_name(tag)
+        return value unless value.nil? or value.eql?("")
+      end
+    end
+
+    def field_map_to_hash field_map, data_dictionary = FIXSpec::data_dictionary, msg_type = nil, all_dictionaries = [ data_dictionary ]
+      hash = {}
+      iter = field_map.iterator
+      while iter.has_next 
+        field = iter.next()
+        tag = field.get_tag
+        value = field.get_value
+
+        if !data_dictionary.nil?
+          if !msg_type.nil? and data_dictionary.is_group(msg_type, tag)
+            group_dd = data_dictionary.get_group(msg_type,tag).get_data_dictionary 
+            groups = []
+            for i in 1..value.to_i
+              groups << field_map_to_hash( field_map.get_group(i,tag), group_dd,  msg_type,Array.new(all_dictionaries) << group_dd  )
+            end
+            value = groups
+          elsif data_dictionary.is_field(tag)
+            value = case find_field_type(tag,all_dictionaries)
+              when "INT","DAYOFMONTH" then value.to_i
+              when "PRICE","FLOAT","QTY" then value.to_f
+              when "BOOLEAN" then value == "Y"
+              when "NUMINGROUP" then value = field_map.to_hash(value)
+              else 
+                value_name = data_dictionary.get_value_name(tag, value)
+                unless value_name.nil?
+                  value_name
+                else
+                  value
+                end
+            end
+          end
+          tag = find_field_name(tag,all_dictionaries) 
+        end
+        hash[tag] = value
+      end
+
+      return hash
+    end
+  end
+end

data/lib/fix_spec/matchers/be_fix_eql.rb

@@ -0,0 +1,45 @@
+module FIXSpec
+  module Matchers
+    class BeFIXEql
+      include FIXSpec::Helpers
+
+      def initialize(expected_fix_as_json = nil)
+        @json_matcher= JsonSpec::Matchers::BeJsonEql.new expected_fix_as_json
+      end
+
+      def diffable?
+        @json_matcher.diffable?
+      end
+
+      def actual
+        @json_matcher.actual
+      end
+
+      def expected
+        @json_matcher.expected
+      end
+
+      def at_path(path)
+        @json_matcher.at_path path
+        self
+      end
+
+      def matches?(fix_message)
+        fix_json =  message_to_unordered_json(fix_message)
+        @json_matcher.matches? fix_json
+      end
+
+      def failure_message_for_should
+        @json_matcher.message_with_path("Expected equivalent FIX")
+      end
+
+      def negative_failure_message
+        @json_matcher.message_with_path("Expected inequivalent FIX")
+      end
+
+      def description
+        @json_matcher.message_with_path("equal FIX")
+      end
+    end
+  end
+end

data/lib/fix_spec/matchers/have_fix_path.rb

@@ -0,0 +1,29 @@
+module FIXSpec
+  module Matchers
+    class HaveFIXPath
+      attr_reader :path
+      def initialize path
+        @path = path
+        @json_matcher = JsonSpec::Matchers::HaveJsonPath.new path
+      end
+
+      def matches? fix_message
+        fix_json =  FIXSpec::Helpers.message_to_unordered_json(fix_message)
+
+        @json_matcher.matches? fix_json
+      end
+
+      def failure_message_for_should
+        %(Expected FIX path "#{@path}")
+      end
+
+      def failure_message_for_should_not
+        %(Expected no FIX path "#{@path}")
+      end
+
+      def description
+        %(have Protobuf path "#{@path}")
+      end
+    end
+  end
+end

data/lib/fix_spec/matchers.rb

@@ -0,0 +1,18 @@
+require 'fix_spec/matchers/be_fix_eql'
+require 'fix_spec/matchers/have_fix_path'
+
+module FIXSpec
+  module Matchers
+    def be_fix_eql(expected=nil)
+      FIXSpec::Matchers::BeFIXEql.new(expected)
+    end
+
+    def have_fix_path(path)
+      FIXSpec::Matchers::HaveFIXPath.new(path)
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include(FIXSpec::Matchers)
+end

data/lib/fix_spec.rb

@@ -0,0 +1,10 @@
+require 'quickfix'
+require 'json_spec'
+
+require 'fix_spec/configuration'
+require 'fix_spec/helpers'
+require 'fix_spec/matchers'
+
+module FIXSpec
+  extend Configuration
+end

data/spec/fix_spec/helpers_spec.rb

@@ -0,0 +1,114 @@
+require 'spec_helper'
+
+describe FIXSpec::Helpers do
+  include described_class
+
+  describe "fixify_string" do
+    it "can calculate checksum" do
+      msg="8=FIX.4.2
35=8
49=ITG
56=SILO
205=4
"
+      fix_msg = fixify_string msg
+      fix_msg.end_with?("10=084
").should be_true
+    end
+
+    it "can ignore existing checksum" do
+      msg="8=FIX.4.2
35=8
49=ITG
56=SILO
205=4
10=045
"
+      fix_msg = fixify_string msg
+      fix_msg.end_with?("10=084
").should be_true
+    end
+
+    it "can calculate length" do
+      msg="8=FIX.4.2
35=8
49=ITG
56=SILO
205=4
10=045
"
+      fix_msg = fixify_string msg
+      fix_msg.start_with?("8=FIX.4.2\0019=26\001").should be_true
+    end
+
+    it "can ignore existing length" do
+      msg="8=FIX.4.2
9=45
35=8
49=ITG
56=SILO
205=4
10=045
"
+      fix_msg = fixify_string msg
+      fix_msg.start_with?("8=FIX.4.2\0019=26\001").should be_true
+    end
+
+
+    it "will strip out spaces" do
+      msg="    8=FIX.4.2
35=8
49=ITG
56=SILO
205=4
    "
+      fixify_string(msg).should ==("8=FIX.4.2\0019=26\00135=8\00149=ITG\00156=SILO\001205=4\00110=084\001")
+    end
+
+    it "should be generous with missing last soh" do
+      msg="8=FIX.4.2
35=8
49=ITG
56=SILO
205=4"
+      fixify_string(msg).should ==("8=FIX.4.2\0019=26\00135=8\00149=ITG\00156=SILO\001205=4\00110=084\001")
+
+      msg="8=FIX.4.2
35=8
49=ITG
56=SILO
205=4
10=045"
+      fixify_string(msg).should ==("8=FIX.4.2\0019=26\00135=8\00149=ITG\00156=SILO\001205=4\00110=084\001")
+    end
+
+
+  end
+
+  describe "message-to-hash functions"  do
+    let(:order) {
+      ord = quickfix.fix42.NewOrderSingle.new
+      ord.header.set(quickfix.field.TargetCompID.new "target")
+      ord.header.set(quickfix.field.SenderCompID.new "sender")
+
+      ord.set(quickfix.field.Account.new "account")
+      ord.set(quickfix.field.OrderQty.new(100.0))
+      ord.set(quickfix.field.Price.new(75.0))
+      ord
+    }
+
+    context "field_map_to_hash" do
+      let(:hash) { field_map_to_hash order.get_header }
+
+      it "should have unordered tags" do
+        hash[8].should=="FIX.4.2" 
+        hash[35].should=="D" 
+      end
+    end
+
+    context "message_to_hash" do
+      let(:hash) { message_to_hash order }
+
+      it "should have unordered tags from all message parts" do
+        hash[8].should=="FIX.4.2" 
+        hash[35].should=="D" 
+        hash[1].should=="account"
+        hash[44].should == "75"
+        hash[38].should == "100"
+      end
+    end
+  end
+
+  describe "get-message-type function" do
+    let(:order) {
+      ord = quickfix.fix42.NewOrderSingle.new
+      ord
+    }
+    let(:generic_message) {
+      msg = quickfix.Message.new
+      msg.setString( 8, "FIX.4.2" )
+      msg.setInt( 9, 26 )
+      msg.setString( 49, "ITG" )
+      msg.setString( 56, "SILO" )
+      msg.setInt( 205, 4 )
+      msg.setInt( 10, 84 )
+      msg
+    }
+
+    context "fix message with msgType field set" do
+      let(:msg_type) { extract_message_type( order.get_header ) }
+
+      it "should return the value of the msgType tag" do
+        msg_type.should == "D"
+      end
+    end
+
+    context "fix message from raw string with no message type" do
+      let(:msg_type) { extract_message_type( generic_message.get_header ) }
+
+      it "should not error out and return nil" do
+        msg_type.should == nil
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'fix_spec'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end
+