cucumber-openerpscenario 0.1.0

data/lib/cucumber/lib/Helpers/StockPicking.rb

@@ -0,0 +1,49 @@
+# -*- encoding: utf-8 -*-
+#################################################################################
+#                                                                               #
+#    OERPScenario, OpenERP Functional Tests                                     #
+#    Copyright (C) 2011 Akretion Benoît Guillot <benoit.guillot@akretion.com>   #
+#                                                                               #
+#    This program is free software: you can redistribute it and/or modify       #
+#    it under the terms of the GNU General Public License as published by       #
+#    the Free Software Foundation, either version 3 Afero of the License, or    #
+#    (at your option) any later version.                                        #
+#                                                                               #
+#    This program is distributed in the hope that it will be useful,            #
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of             #
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              #
+#    GNU General Public License for more details.                               #
+#                                                                               #
+#    You should have received a copy of the GNU General Public License          #
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.      #
+#                                                                               #
+#################################################################################
+require 'pp'
+require 'rubygems'
+require 'ooor'
+
+begin
+  if Object.const_defined? 'StockPicking'
+    StockPicking.class_eval do
+      $utils.log.debug("Extending  #{self.class} #{self.name}")
+      # Add useful methode on stock picking handling
+
+      def self.to_ary
+        return [name]
+      end
+
+      def validate_picking()
+        res = {'delivery_date' => (DateTime.now).strftime(fmt="%Y-%m-%d %H:%M:%S")}
+        stock_moves = move_lines
+        stock_moves.each do |move_line|
+          res["move#{move_line.id}"] = {'prodlot_id' => move_line.prodlot_id && move_line.prodlot_id.id || false, 'product_id' => move_line.product_id.id, 'product_uom' => move_line.product_uom.id, 'product_qty' => move_line.product_qty}
+        end
+        StockPicking.do_partial([id], res)
+      end
+    end
+  else
+    $utils.log.debug("StockPicking helper not initialized")
+  end
+rescue Exception => e
+  $utils.log.fatal("ERROR : #{e.to_s}")
+end

data/lib/cucumber/lib/core_ext/basic_object.rb

@@ -0,0 +1,19 @@
+# taken from Sequel gem, BasicObject implementation for ruby 1.8
+if RUBY_VERSION < '1.9.0'
+  # If on Ruby 1.8, create a <tt>Sequel::BasicObject</tt> class that is similar to the
+  # the Ruby 1.9 +BasicObject+ class. This is used in a few places where proxy
+  # objects are needed that respond to any method call.
+  class BasicObject
+    # The instance methods to not remove from the class when removing
+    # other methods.
+    KEEP_METHODS = %w"__id__ __send__ __metaclass__ instance_eval == equal? initialize method_missing"
+
+    # Remove all but the most basic instance methods from the class. A separate
+    # method so that it can be called again if necessary if you load libraries
+    # after Sequel that add instance methods to +Object+.
+    def self.remove_methods!
+      ((private_instance_methods + instance_methods) - KEEP_METHODS).each{|m| undef_method(m)}
+    end
+    remove_methods!
+  end
+end

data/lib/cucumber/lib/utils/memoizer_utils.rb

@@ -0,0 +1,45 @@
+###############################################################################
+#
+#    OERPScenario, OpenERP Functional Tests
+#    Author Nicolas Bessi 2009
+#    Copyright Camptocamp SA
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 Afero of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+##############################################################################
+
+module MemoizerUtils
+  # Define a memorizer to store object handled by the test
+  # Useful to store an invoice in a var which name = invoice name !
+  def set_var(name, value)
+    memoizer[name] = value
+  end
+
+  def get_var(name)
+    memoizer[name]
+  end
+
+  def clean_var(name)
+    memoizer.delete(name)
+  end
+
+  def clean_all_var
+    memoizer.clear
+  end
+
+  def memoizer
+    @memoizer ||= {}
+  end
+  private :memoizer
+end

data/lib/cucumber/lib/utils/ooor_utils.rb

@@ -0,0 +1,124 @@
+###############################################################################
+#
+#    OERPScenario, OpenERP Functional Tests
+#    Author Nicolas Bessi 2009
+#    Copyright Camptocamp SA
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 Afero of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+##############################################################################
+
+module OoorUtils
+
+  def ooor
+    @ooor ||= init_ooor
+  end
+
+  def init_ooor
+    OoorProxy.new(log)
+  end
+
+  def ready?
+    !ooor.nil? && ooor.all_loaded_models.size == 0
+  end
+
+  def login(params={})
+    ooor.login(config.merge(params))
+  end
+
+  def create_ooor_connection(params={})
+    ooor.open_connection(config.merge(params))
+    load_helpers
+  end
+
+  def create_database_with_ooor(params={})
+    ooor.create_database(config.merge(params))
+    load_helpers
+  end
+
+  def setConnexionfromConf(params={})
+    log.warn('Deprecated: ScenarioUtils#setConnexionfromConf. Use ScenarioUtils#create_ooor_connection')
+    create_ooor_connection(params)
+  end
+
+  def createdatabasefromConf(params={})
+    log.warn('Deprecated: ScenarioUtils#createdatabasefromConf. Use ScenarioUtils#create_database_with_ooor')
+    create_database_with_ooor(params)
+  end
+end
+
+
+class OoorProxy < BasicObject
+  # Delegate to OOOR except the OERPScenario methods to manage the connections
+
+    attr_reader :log
+
+    def initialize(log)
+      @log = log
+    end
+
+    def xmlrpc_url(params)
+      "http://#{params[:host]}:#{params[:port]}/xmlrpc"
+    end
+    private :xmlrpc_url
+
+    def login(params)
+      @ooor.global_login(params[:user], params[:pwd])
+    end
+
+    def init_ooor_connection(params)
+      ::Ooor.new({:url => xmlrpc_url(params),
+                  :database => params[:dbname],
+                  :username => params[:user],
+                  :password => params[:pwd],
+                  :log_level => params[:log_level]})
+    end
+    private :init_ooor_connection
+
+    #read the base.conf file to set all the parameter to begin an xml rpc session with openerp
+    #you can override any of the parameters
+    def open_connection(params)
+      if @ooor
+        login(params)
+      else
+        begin
+          @ooor = init_ooor_connection(params)
+        rescue RuntimeError #We catch RuntimeError because ooor doesn't give the error name.
+                            #we deduce in that case that the database doesn't exist and we have to create it.
+          log.warn("No database, try to create it")
+          create_database_with_ooor(params)
+        end
+      end
+      self
+    end
+
+    def create_database(params)
+      log.info("Creating a new database")
+      begin
+        @ooor = Ooor.new(:url => xmlrpc_url(params))
+        @ooor.create(ooor_config[:pwd], params[:dbname], false, 'en_US', params[:pwd])
+        @ooor.load_models(false)
+      rescue RuntimeError
+        log.fatal("ERROR : Cannot create database")
+        raise 'Cannot create database'
+      end
+      self
+    end
+
+    def method_missing(name, *args, &block)
+      @ooor.send(name, *args, &block)
+    end
+    protected :method_missing
+
+end

data/lib/cucumber/lib/utils/sequel_utils.rb

@@ -0,0 +1,65 @@
+###############################################################################
+#
+#    OERPScenario, OpenERP Functional Tests
+#    Author Guewen Baconnier
+#    Copyright Camptocamp SA 2012
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 Afero of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+##############################################################################
+
+module SequelUtils
+  attr_reader :sequel
+
+  def sequel(params={})
+    @sequel ||= init_sequel(params)
+  end
+
+  def init_sequel(params={})
+    if SEQUEL_ACTIVE
+      sequel_params = config.merge(params)
+      @sequel = SequelProxy.new(sequel_params, log)
+    else
+      msg = 'Please install the sequel and pg gems in order to use $utils.sequel.'
+      log.fatal(msg)
+      raise msg
+    end
+  end
+  private :init_sequel
+end
+
+if SEQUEL_ACTIVE
+  require 'sequel'
+
+  class SequelProxy < BasicObject
+    # Delegate to Sequel except the OERPScenario methods to manage the connections
+
+    attr_reader :log
+
+    def initialize(params, log)
+      @log = log
+      @db = ::Sequel.postgres(:host=>params[:db_host],
+                              :database=>params[:dbname],
+                              :user=>params[:db_user],
+                              :password=>params[:db_password],
+                              :port => params[:db_port] || 5432)
+    end
+    protected
+
+    def method_missing(name, *args, &block)
+      @db.send(name, *args, &block)
+    end
+
+  end
+end

data/lib/cucumber/openerp/dsl.rb

@@ -0,0 +1,81 @@
+def prepare_args(args)
+  mixed = args.strip.split('and')
+  attrs = []
+  arguments = []
+  mixed.each do |set|
+    tmp = set.split(':')
+    attrs.push(tmp[0].strip)
+    arguments.push(tmp[1].strip)
+  end
+  attrs_string = attrs.join('_and_')
+  return attrs_string, arguments
+end
+
+def get_items(action, qty, model, args)
+  @found_items = nil
+  @found_item = nil
+  oclass =  Object.const_get(model.split('.').collect {|s| s.capitalize}.join)
+  unique_mode = ['create', 'need', 'find or create']
+  if qty == 'all'
+    if unique_mode.include? action
+      raise "#{unique_mode.inspect} does not allows 'all' keyword"
+    end
+    qty = 'all_'
+  else
+    qty = ''
+  end
+  command_map = {'create' => 'new', 'need' => 'find_or_initialize_by_', 'shoud_have' => "find_#{qty}by_", 'find' => "find_#{qty}by_", 'find or create' => 'find_or_initialize_by_'}
+  comm_ext, arguments = prepare_args(args)
+  if command_map[action] == 'create'
+    if oclass.send(('find_by_'+comm_ext).to_sym, *arguments)
+      raise "Error object allerady exist if this is not the wished behavior please use need keyword"
+    end
+  end
+  res = oclass.send((command_map[action]+comm_ext).to_sym, *arguments) # I know in case or create we do 2 search but as there should be nul it cost almost nothing
+  if @found_items.is_a? Array
+    @found_items = res
+  else
+    @found_item = res
+  end
+end
+
+def _manage_col_search(field_def, value)
+  oclass = Object.const_get(field_def['relation'].split('.').collect {|s| s.capitalize}.join) # TODO use Scenario helper
+  oid = nil
+  if value.start_with? 'by '
+    comm_ext, arguments = prepare_args(value.gsub('by ', ''))
+    arguments.push({'fields'=>['id']})
+    oid = oclass.send(('find_by_'+comm_ext).to_sym, *arguments)
+  else
+    eval "oid = oclass.#{value}"
+  end
+  unless oid
+    raise "Can not find #{value}"
+  end
+  return oid
+end
+
+def manage_item_table(item, table)
+  fields = {}
+  fields.merge! item.class.many2one_associations
+  fields.merge! item.class.one2many_associations
+  fields.merge! item.class.many2many_associations
+  
+  table.hashes.each do |dict|
+    if fields[dict['name']]
+      rel_item = _manage_col_search(fields[dict['name']], dict['value'])
+      eval "item.#{dict['name']} = rel_item.id"
+    else
+      eval "item.#{dict['name']} = dict['value']"
+    end
+  end    
+end
+
+Given /^I (create|need|should have|find|find or create) (a|all|last) "([^"]*)" with (.*)$/ do |action, qty, model, args|
+ get_items(action, qty, model, args)
+end
+
+Given /^having$/ do |table|
+  manage_item_table(@found_item, table)
+  @found_item.save
+end

data/lib/cucumber/openerp/world.rb

@@ -0,0 +1,37 @@
+require "cucumber/lib/ERPConnector.rb"
+module CucumberOpenERP
+    attr_accessor :is_alive, :openerp
+    def am_i_alive?
+      puts 'did i live'
+      @@is_alive ||= false
+      return @@is_alive
+    end
+    def born
+      puts 'I m born'
+      @@is_alive = true
+    end
+  def openerp_ignition
+  unless am_i_alive?
+    openerp = ScenarioUtils.new() #$utils is deprecated please use openerp
+    begin
+        unless openerp.ready?
+            openerp.log.info("Attempt to connect")
+            openerp.create_ooor_connection
+        end
+    rescue Exception => e
+        openerp.log.warn("#{e.to_s}")
+        openerp.log.warn("Force reconnect")
+        openerp.create_ooor_connection
+    end
+    born
+    $util = openerp #for retro-compat
+  end
+  
+end
+end
+
+World(CucumberOpenERP)
+
+Before do 
+  openerp_ignition
+end

data/lib/cucumber/openerp.rb

@@ -0,0 +1,26 @@
+env_caller = File.dirname(caller.detect{|f| f =~ /\/env\.rb:/}) if caller.detect{|f| f =~ /\/env\.rb:/}
+if env_caller
+  require 'xmlrpc/client'
+  XMLRPC::Config::ENABLE_NIL_PARSER = true if not XMLRPC::Config::ENABLE_NIL_PARSER
+  XMLRPC::Config::ENABLE_NIL_CREATE = true if not XMLRPC::Config::ENABLE_NIL_CREATE
+  XMLRPC::Config::ENABLE_BIGINT = true if not XMLRPC::Config::ENABLE_BIGINT
+  begin
+    require 'sequel'
+    SEQUEL_ACTIVE = true
+  rescue LoadError => err
+    SEQUEL_ACTIVE = false
+  end
+  require 'ooor'
+  require 'pp'
+  require 'parseconfig'
+  require "ooor/finders"
+  require 'logger'
+  require 'cucumber/lib/core_ext/basic_object'
+  require 'cucumber/lib/utils/memoizer_utils'
+  require 'cucumber/lib/utils/ooor_utils'
+  require 'cucumber/lib/utils/sequel_utils'
+  require 'cucumber/openerp/dsl'
+  require 'cucumber/openerp/world'
+else
+  warn "WARNING: Cucumber-openerp required outside of env.rb.  The rest of loading is being defered until env.rb is called"
+end