cucumber-openerpscenario 0.1.0

data/cucumber-openerp.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+  s.name = %q{cucumber-openerpscenario}
+  s.version = "0.1.0"
+  s.date = %q{2013-03-06}
+  s.authors = ["Nicolas Bessi - Camptocamp"]
+  s.summary = %q{cucumber on OpenERP}
+  s.description = %q{cucumber on OpenERP}
+  s.add_dependency(%q<ooor>, [">= 1.6.5"])
+  s.add_dependency(%q<ooor-finders>)
+  s.add_dependency(%q<cucumber>)
+  s.add_dependency(%q<parseconfig>)
+  s.files = `bzr ls -R`.split("\n")
+  s.require_path = 'lib'
+end

data/lib/cucumber/lib/ERPConnector.rb

@@ -0,0 +1,75 @@
+###############################################################################
+#
+#    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/>.
+#
+##############################################################################
+# This class map OpenERP XMLRPC logins and common stuff
+class ScenarioUtils
+  include MemoizerUtils
+  include OoorUtils
+  include SequelUtils
+
+  attr_accessor :log
+
+  def initialize
+    @uid = false
+    @log = Logger.new(STDOUT)
+    @log.level = Logger::WARN
+  end
+
+  def config
+    @config ||= get_config
+  end
+
+  def config_path
+    ENV['CONF'] || 'base.conf'
+  end
+  private :config_path
+
+  def get_config
+    my_config = ParseConfig.new(config_path)
+
+    {# ooor options
+     :port => my_config.get_value('port'),
+     :user => my_config.get_value('user'),
+     :dbname => my_config.get_value('database'),
+     :pwd => my_config.get_value('password'),
+     :host => my_config.get_value('host'),
+     :log_level => Logger::ERROR,
+
+     # sequel options
+     :db_host => my_config.get_value('db_host'),
+     :db_port => my_config.get_value('db_port'),
+     :db_user => my_config.get_value('db_user'),
+     :db_password => my_config.get_value('db_password')}
+  end
+  private :get_config
+
+  def helpers_absolute_path
+    #File.expand_path("Helpers/*", File.dirname(__FILE__))
+  end
+  private :helpers_absolute_path
+
+  def load_helpers
+    # TODO generic method to load each helper
+    # actually each ruby file contains the same
+    # code : test if class exists, run a class_eval
+    # Dir[helpers_absolute_path].each { |file| load file }
+  end
+  private :load_helpers
+end

data/lib/cucumber/lib/Helpers/AccountBankStatement.rb

@@ -0,0 +1,156 @@
+###############################################################################
+#
+#    OERPScenario, OpenERP Functional Tests
+#    Author Nicolas Bessi & Joel Grand-Guillaume 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/>.
+#
+##############################################################################
+require 'rubygems'
+require 'ooor'
+require 'pp'
+
+
+begin
+  if Object.const_defined? 'AccountBankStatement'
+
+    # Add useful methode on bank statement handling
+    ##############################################################################
+    AccountBankStatement.class_eval do
+      $utils.log.debug("Extending  #{self.class} #{self.name}")
+      ############################################################################
+      # Import invoices into the given bank statements
+      # Input :
+      #  - invoices :  A valid dict of AccountInvoice instance
+      #  - statement : A valid AccountBankStatement instance
+      #  - options {
+      #      date (Default today) : date used into the first screen of the wizard (date
+      #                             imported in lines)
+      #    }
+      # Return
+      #  - The AccountBankStatement as a instance of the class¨
+      # Usage Example:
+      # statement = AccountBankStatement.import_invoice(invoices,statement)
+      #
+      # TODO implement journals
+      # TODO filter acc_move_line_ids to take the right one
+      # TODO Remove self to use it from an instance of the class
+      def import_invoice(invoices, options={}, *args)
+        o = {:date => false, :journals => []}.merge(options)
+        if o[:date]
+          o[:date] = Date.parse(str=o[:date]).to_s
+        else
+          o[:date] = Date.today.to_s
+        end
+
+        # Parse the given journal ids if provided
+        journal_ids=[]
+        o[:journals].each do |journal|
+          journal_ids.push journal.id
+        end
+        invoice_move_line_ids=[]
+        inv_total=0.0
+        self.balance_start=inv_total
+
+        # # For each invoices, add the right account.move.line and compute total
+        invoices.each do |inv|
+          unless inv.class == AccountInvoice
+            raise "!!! --- HELPER ERROR :import_invoice received a #{inv.class.to_s} instead of AccountInvoice"
+          end
+          # Take the move ids from concerned invoice
+          # TODO add journal support and (journal_ids.include? move_line.journal_id or journal_ids == []
+          # TODO : Debug the problem of undefined method `[]' for nil:NilClass (NoMethodError)
+          # pp inv.move_id.line_id
+          #       inv.move_id.line_id.each do |move_line|
+          #
+          #         # if move_line.reconcile_id == false
+          #         if move_line.account_id.reconcile == true
+          #           invoice_move_line_ids.push move_line.id
+          #         end
+          #       end
+
+          inv.move_id.line_id.each do |move_line|
+            if (not move_line.reconcile_id) && move_line.account_id.reconcile
+              invoice_move_line_ids.push move_line.id
+              inv_total = inv_total + move_line.amount_currency
+            end
+          end
+        end
+        # Save the start and end values
+        self.balance_end_real=inv_total
+        self.save
+        unless self.class == AccountBankStatement
+          raise "!!! --- HELPER ERROR :import_invoice received a #{self.class.to_s} instead of AccountBankStatement"
+        end
+
+        # Call the wizard
+        wizard = self.old_wizard_step('populate_statement_from_inv')
+        # Set the wizard with given values
+        step_dict = wizard.datas.merge({:date => o[:date]})
+        step_dict=step_dict.merge({:journal_id => [[[], [], journal_ids]]})
+        # Search the invoices and update values
+        res=wizard.go(step_dict)
+        step_dict=res.datas.merge(step_dict)
+        # Update the step_dict with invoice we want
+        step_dict=step_dict.merge({:lines => [[[], [], invoice_move_line_ids]]})
+        # Ask to populate the statement with given invoice linked account move
+        res=wizard.finish(step_dict)
+        # step_dict = step_dict.merge({:writeoff_acc_id => @journal.default_debit_account_id.id, :writeoff_journal_id=>@journal.id})
+        # return res
+      end
+
+      ############################################################################
+      # Create an statement with given informations
+      # Input :
+      #  - options {
+      #    journal : A valid AccountJournal instance
+      #    currency_code (Default : EUR) : An ISO code for currency
+      #    name (Default : computed by OpenERP sequence) : A valid name if you wanna set it
+      #  }
+      # Return
+      #  - The created AccountBankStatement as a instance of the class¨
+      # Usage Example:
+      # statement = AccountBankStatement.create_statement_with_currency({currency_code =>'CHF'})
+      def self.create_statement_with_currency(options={}, *args)
+        o = {:currency_code => 'EUR', :journal => false, :name => false}.merge(options)
+        if not o[:journal]
+          # Take the currency
+          currency_id = ResCurrency.find(:first, :domain => [['name', '=', o[:currency_code]]]).id
+          if currency_id
+            # Look for the asked cash journal currency
+            journal = AccountJournal.find(:first, :domain => [['type', '=', 'cash'], ['currency', '=', currency_id]])
+          else
+            raise "!!! --- HELPER ERROR : create_statement_with_currency #{o[:currency_code]} currency not found"
+          end
+        else
+          journal = o[:journal]
+        end
+        toreturn = AccountBankStatement.new()
+        toreturn.journal_id = journal.id
+        toreturn.create
+        if o[:name]
+          toreturn.name=o[:name]
+          toreturn.save
+        end
+        return toreturn
+      end
+
+    end
+  else
+    $utils.log.debug("AccountBankStatement helper not initialized !")
+  end
+rescue Exception => e
+  $utils.log.fatal("ERROR : #{e.to_s}")
+end

data/lib/cucumber/lib/Helpers/AccountInvoice.rb

@@ -0,0 +1,122 @@
+###############################################################################
+#
+#    OERPScenario, OpenERP Functional Tests
+#    Author Nicolas Bessi & Joel Grand-Guillaume 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/>.
+#
+##############################################################################
+require 'rubygems'
+require 'ooor'
+require 'pp'
+
+
+begin
+  if Object.const_defined? 'AccountInvoice'
+    # Add useful methode on invoice handling
+    ##############################################################################
+    AccountInvoice.class_eval do
+      $utils.log.debug("Extending  #{self.class} #{self.name}")
+      ##########################################################################
+      # Create an invoice with given informations
+      # Add a line if amount <> false, the account could be provided or not
+      # Input :
+      #  - name : Name of the invoice
+      #  - partner : A valid ResPartner instance
+      #  - option {
+      #    currency_code (Default : EUR) : An ISO code for currency
+      #    date (Default : false) : A date in this text format : 1 jan 2009
+      #    amount (Default : false) : An amount for the invoice => this will create a line 
+      #    account (Default : false) : An valide AccountAccount
+      #    type (Default : out_invoice) : the invoice type
+      #  }
+      # Return
+      #  - The created AccountInvoice as a instance of the class¨
+      # Usage Example:
+      # part = ResPartner.find(:first)
+      # puts part.id
+      # inv = AccountInvoice.create_cust_invoice_with_currency('my name',part,{currency_code =>'CHF'})
+      def self.create_invoice_with_currency(name, partner, options={}, *args)
+        o = {:type => 'out_invoice', :currency_code => 'EUR', :date => false, :amount => false, :account => false}.merge(options)
+        if o[:date]
+          date_invoice = Date.parse(str=o[:date]).to_s
+        else
+          date_invoice = Date.today.to_s
+        end
+        toreturn = AccountInvoice.new()
+
+        unless partner.class == ResPartner
+          raise "!!! --- HELPER ERROR :create_cust_invoice_with_currency received a #{partner.class.to_s} instead of ResPartner"
+        end
+        # Set partner
+        #We use this syntax for optimisation reason, helper have to be fast
+        if  ResPartnerAddress.find(:first, :domain => [['partner_id', '=', partner.id]], :fields => ['id'])
+          toreturn.partner_id = partner.id
+        else
+          raise "!!! --- HELPER ERROR :create_cust_invoice_with_currency received a partner : #{partner.name} without adresses"
+        end
+        toreturn.on_change('onchange_partner_id', :partner_id, partner.id, o[:type], partner.id, date_invoice, false, false)
+        toreturn.save
+        # Set name & date
+        toreturn.name = name
+        toreturn.date_invoice=date_invoice
+
+        # Set type of invoice
+        toreturn.type = o[:type]
+        curr = ResCurrency.find(:first, :domain => [['name', '=', o[:currency_code]]], :fields => ['id'])
+        # Set currency
+        if curr
+          toreturn.currency_id = curr.id
+        else
+          raise "!!! --- HELPER ERROR :#{o[:currency_code]} currency not found"
+        end
+
+        # Set amount and line if asked for
+        toreturn.save
+
+        if o[:amount]
+
+          if ['in_invoice', 'in_refund'].include? o[:type]
+            toreturn.check_total = o[:amount]
+          end
+          if o[:account]
+            unless account.class == AccountAccount
+              raise "!!! --- HELPER ERROR :create_cust_invoice_with_currency received a #{o[:account].class.to_s} instead of AccountAccount"
+            end
+            account_id = o[:account].id
+          else
+            # If no account, take on of type 'other' and a non-reconciliable account
+            account_id = AccountAccount.find(:first, :domain => [['type', '=', 'other'], ['reconcile', '=', false]], :fields => ['id']).id
+            # Create a line = amount for the created invoice
+            line=AccountInvoiceLine.new(
+                :account_id => account_id,
+                :quantity => 1,
+                :name => name+' line',
+                :price_unit => o[:amount],
+                :invoice_id => toreturn.id
+            )
+            line.create
+          end
+        end
+        toreturn.save
+        return toreturn
+      end
+    end
+  else
+    $utils.log.debug("AccountInvoice helper not initialized")
+  end
+rescue Exception => e
+  $utils.log.fatal("ERROR : #{e.to_s}")
+end

data/lib/cucumber/lib/Helpers/AccountTax.rb

@@ -0,0 +1,85 @@
+###############################################################################
+#
+#    OERPScenario, OpenERP Functional Tests
+#    Author Nicolas Bessi & Joel Grand-Guillaume 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/>.
+#
+##############################################################################
+require 'rubygems'
+require 'ooor'
+require 'pp'
+
+
+begin
+  if Object.const_defined? 'AccountTax'
+    # Add useful methode on taxes handling
+    ##############################################################################
+    AccountTax.class_eval do
+      $utils.log.debug("Extending  #{self.class} #{self.name}")
+      ##########################################################################
+      # Create a tax and tax code with given informations
+      # Input :
+      #  - name : Name of the tax
+      #  - option {
+      # :type=>'percent',
+      # :amount=>0.196,
+      # :type_tax_use=>'sale',
+      # # For refund
+      # :ref_base_sign=>-1.0,
+      # :ref_tax_sign=>-1.0,
+      # # For VAT declaration
+      # :base_sign=>1.0,
+      # :tax_sign=>1.0,
+      #  }
+      # Return
+      #  - The created AccountTax as a instance of the class¨
+      # Usage Example:
+      # tax = AccountTax.create_tax_and_code('my name',{:type=>'percent',:amount=>rate,:type_tax_use=>'purchase',})
+      def self.create_tax_and_code(name, options={}, *args)
+        #           debugger
+        # Set default values
+        o = {
+            :type => 'percent',
+            :amount => 0.196,
+            :type_tax_use => 'sale',
+            # For refund
+            :ref_base_sign => -1.0,
+            :ref_tax_sign => -1.0,
+            # For VAT declaration
+            :base_sign => 1.0,
+            :tax_sign => 1.0,
+        }.merge(options)
+
+        toreturn = AccountTax.new(o)
+        toreturn.name = name
+        toreturn.type = o[:type]
+        toreturn.amount = o[:amount]
+        toreturn.type_tax_use = o[:type_tax_use]
+        toreturn.ref_base_sign = o[:ref_base_sign]
+        toreturn.ref_tax_sign = o[:ref_tax_sign]
+        toreturn.base_sign = o[:base_sign]
+        toreturn.tax_sign = o[:tax_sign]
+
+        toreturn.create
+        return toreturn
+      end
+    end
+  else
+    $utils.log.debug("AccountTax helper not initialized")
+  end
+rescue Exception => e
+  $utils.log.fatal("ERROR : #{e.to_s}")
+end