prestashop-automation-tool 0.3.1 → 0.4

data/bin/pat

@@ -0,0 +1,108 @@
+#!/usr/bin/ruby
+require 'prestashop-automation-tool'
+
+require 'optparse'
+require 'json'
+
+def withConfig &block
+	if File.exists? 'pat.conf.json'
+		yield JSON.parse(File.read('pat.conf.json'), :symbolize_names => true)
+	else
+		abort "Could not find the config file #{pat.conf.json}, did you run 'pat.rb init'?"
+	end
+end
+
+options = {}
+OptionParser.new do |opts|
+	opts.on('-ad', '--accept-defaults', 'Accept default values automatically.') do
+		options[:accept_defaults] = true
+	end
+	opts.on('--no-restore', 'Do not save/restore intial state when running tests.') do
+		options[:no_restore] = true
+	end
+end.parse!
+if ARGV.count == 0
+	puts "Missing action argument!"
+	exit 1
+elsif ARGV[0] == 'init'
+	conf = PrestaShopAutomationTool::ConfigurationParser.new '.'
+	conf.parse
+	conf.ask_user_for_missing_info options
+	conf.autocomplete_config
+	File.write 'pat.conf.json', JSON.pretty_generate({
+		shop: conf.config
+	})
+	unless File.exists? 'tests-enabled'
+		Dir.mkdir 'tests-enabled'
+	end
+	unless File.exists? 'tests-available'
+		`git clone #{conf.config[:tests_repository]} tests-available`
+	end
+elsif ARGV[0] == 'purge'
+	`rm -Rf pat.conf.json tests-enabled tests-available`
+elsif ARGV[0] == 'install'
+	withConfig do |conf|
+		ps = PrestaShopAutomation::PrestaShop.new(conf[:shop])
+		ps.drop_database
+		ps.install options
+	end
+elsif ARGV[0] == 'create'
+	if ARGV[1]
+		template = File.join PrestaShopAutomationTool.gem_root, 'lib', 'templates', 'sample_test.rb'
+		`cp #{template} tests-enabled/#{ARGV[1]}.rb`
+	else
+		puts 'Please provide the name of the test to create!'
+	end
+elsif ARGV[0] == 'dump'
+	withConfig do |conf|
+		ps = PrestaShopAutomation::PrestaShop.new(conf[:shop])
+		ps.dump_database 'dump.sql'
+	end
+elsif ARGV[0] == 'restore'
+	withConfig do |conf|
+		ps = PrestaShopAutomation::PrestaShop.new(conf[:shop])
+		ps.load_database 'dump.sql'
+	end
+elsif ARGV[0] == 'test'
+
+	list = ARGV[1..-1]
+
+	if list.nil? or list.empty?
+		list = Dir.glob('tests-enabled/**/*')
+	end
+
+	list.sort!
+
+	list.each do |file|
+		ok = if file =~ /\.rb$/
+			puts "Running #{file}..."
+			system({'NO_RESTORE' => options[:no_restore]}, 'rspec', file)
+		elsif file =~ /\.json$/
+			puts "Running #{file}..."
+			data = JSON.parse File.read(file)
+			runner = "pat-runner-#{data['spec']['runner']}.rb"
+			system({'PAT_SOURCE' => file, 'NO_RESTORE' => (options[:no_restore] ? '1' : '0')}, runner)
+		else
+			:not_runnable
+		end
+
+		if ok != :not_runnable
+			puts "Ran #{file}: #{ok ? "success!" : "FAILED"}"
+		end
+
+	end
+elsif ARGV[0] == 'enable'
+	if ARGV[1]
+		`cp tests-available/#{ARGV[1]}.* tests-enabled/`
+	else
+		puts "Please also provide prefix!"
+	end
+elsif ARGV[0] == 'disable'
+	if ARGV[1]
+		`mv tests-enabled/#{ARGV[1]}.* tests-available/`
+	else
+		puts "Please also provide prefix!"
+	end
+else
+	puts "Unknown command '#{ARGV[0]}'!"
+end

data/bin/pat-runner-invoice.rb

@@ -0,0 +1,110 @@
+#!/usr/bin/ruby
+
+require 'rspec'
+require 'rspec/autorun'
+require 'prestashop-automation-tool/helper'
+
+def test_invoice ps, scenario, options={}
+
+	taxes = {}
+	groups = {}
+
+	ps.login_to_back_office
+	ps.set_friendly_urls false
+	ps.set_order_process_type scenario['meta']['order_process'].to_sym
+
+	if scenario["discounts"]
+		scenario["discounts"].each_pair do |name, amount|
+			ps.create_cart_rule :name=> name, :amount => amount
+		end
+	end
+
+	if scenario["gift_wrapping"]
+		ps.set_gift_wrapping_option true,
+			:price => scenario["gift_wrapping"]["price"],
+			:tax_group_id => scenario["gift_wrapping"]["vat"] ? ps.create_tax_group_from_rate(scenario["gift_wrapping"]["vat"], taxes, groups) : nil,
+			:recycling_option => false
+	else
+		ps.set_gift_wrapping_option false
+	end
+
+	ps.set_rounding_rule scenario['meta']['rounding_rule']
+	ps.set_rounding_method scenario['meta']['rounding_method']
+
+	if scenario['meta']['ecotax']
+		ps.set_ecotax_option true, ps.create_tax_group_from_rate(scenario['meta']['ecotax'], taxes, groups)
+	else
+		ps.set_ecotax_option false
+	end
+
+	carrier_name = ps.create_carrier({
+		:name => scenario['carrier']['name'],
+		:with_handling_fees => scenario['carrier']['with_handling_fees'],
+		:free_shipping => scenario['carrier']['shipping_fees'] == 0,
+		:ranges => [{:from_included => 0, :to_excluded => 1000, :prices => {0 => scenario['carrier']['shipping_fees']}}],
+		:tax_group_id => scenario['carrier']['vat'] ? ps.create_tax_group_from_rate(scenario['carrier']['vat'], taxes, groups) : nil
+	})
+
+	products = []
+	scenario['products'].each_pair do |name, data|
+		id = ps.create_product({
+			:name => name,
+			:price => data['price'],
+			:tax_group_id => ps.create_tax_group_from_rate(data['vat'], taxes, groups),
+			:ecotax => data['ecotax'],
+			:specific_price => data['specific_price']
+		})
+		products << {id: id, quantity: data['quantity']}
+
+		if data["discount"]
+			ps.create_cart_rule({
+				:product_id => id,
+				:amount => data["discount"],
+				:free_shipping => false,
+				:name => "#{name} with (#{data['discount']}) discount"
+			})
+		end
+	end
+
+	ps.login_to_front_office
+	ps.add_products_to_cart products
+
+	order_id = if scenario['meta']['order_process'] == 'five_steps'
+		ps.order_current_cart_5_steps :carrier => carrier_name, :gift_wrapping => scenario["gift_wrapping"]
+	else
+		ps.order_current_cart_opc :carrier => carrier_name, :gift_wrapping => scenario["gift_wrapping"]
+	end
+
+	ps.goto_back_office
+	invoice = ps.validate_order :id => order_id, :dump_pdf_to => options[:dump_pdf_to], :get_invoice_json => true
+
+	if scenario['expect']['invoice']
+		if expected_total = scenario['expect']['invoice']['total']
+			actual_total = invoice['order']
+			mapping = {
+				'to_pay_tax_included' => 'total_paid_tax_incl',
+				'to_pay_tax_excluded' => 'total_paid_tax_excl',
+				'products_tax_included' => 'total_products_wt',
+				'products_tax_excluded' => 'total_products',
+				'shipping_tax_included' => 'total_shipping_tax_incl',
+				'shipping_tax_excluded' => 'total_shipping_tax_excl',
+				'discounts_tax_included' => 'total_discounts_tax_incl',
+				'discounts_tax_excluded' => 'total_discounts_tax_excl',
+				'wrapping_tax_included' => 'total_wrapping_tax_incl',
+				'wrapping_tax_excluded' => 'total_wrapping_tax_excl'
+			}
+			#puts invoice
+			expected_total.each_pair do |key, value_expected|
+				expect(actual_total[mapping[key]].to_f).to eq value_expected.to_f
+			end
+		end
+	end
+end
+
+scenario = JSON.parse File.read(ENV['PAT_SOURCE'])
+
+describe 'Invoice test' do
+	it 'should work' do
+		test_invoice @shop, scenario, :dump_pdf_to => ENV['PAT_SOURCE'].sub(/\.json$/, '.pdf')
+	end
+end

data/lib/prestashop-automation-tool.rb

@@ -3,6 +3,11 @@ require 'apache-vhosts-parser'
 require 'prestashop-automation'
 
 module PrestaShopAutomationTool
+
+	def self.gem_root
+		File.expand_path '../..', __FILE__
+	end
+
 	class ConfigurationParser
 
 		attr_reader :config
@@ -31,7 +36,8 @@ module PrestaShopAutomationTool
 				admin_email: 'pub@prestashop.com',
 				admin_password: '123456789',
 				default_customer_email: 'pub@prestashop.com',
-				default_customer_password: '123456789'
+				default_customer_password: '123456789',
+				tests_repository: 'https://github.com/djfm/prestashop-automation-tool-tests'
 			}
 
 			@config = {}
@@ -91,12 +97,11 @@ module PrestaShopAutomationTool
 				@config[:database_host] = m[1]
 				@config[:database_port] = m[2]
 			end
-
 			if @admin_folder
-				@config[:back_office_url] = URI.join(@config[:front_office_url], @admin_folder).to_s
+				@config[:back_office_url] = URI.join(@config[:front_office_url], @admin_folder + '/').to_s
 			end
 			if @installer_folder
-				@config[:installer_url] = URI.join(@config[:front_office_url], @installer_folder).to_s
+				@config[:installer_url] = URI.join(@config[:front_office_url], @installer_folder + '/').to_s
 			end
 		end
 	end

data/lib/prestashop-automation-tool/helper.rb

@@ -0,0 +1,20 @@
+require 'prestashop-automation'
+require 'json'
+
+dump = nil
+
+RSpec.configure do |config|
+	config.before :all do
+		conf = JSON.parse(File.read('pat.conf.json'), :symbolize_names => true)
+		@shop = PrestaShopAutomation::PrestaShop.new conf[:shop]
+		unless ENV['NO_RESTORE'] == '1'
+			dump = @shop.save
+		end
+	end
+
+	config.after :all do
+		unless ENV['NO_RESTORE'] == '1'
+			@shop.restore dump
+		end
+	end
+end

data/lib/templates/sample_test.rb

@@ -0,0 +1,7 @@
+require 'prestashop-automation-tool/helper'
+
+describe 'My first test' do
+	it 'should login as a customer' do
+		@shop.login_to_front_office
+	end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prestashop-automation-tool
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: '0.4'
   prerelease: 
 platform: ruby
 authors:
@@ -46,12 +46,16 @@ dependencies:
 description: Automate prestashop.
 email: fm.de.jouvencel@gmail.com
 executables:
-- pat.rb
+- pat
+- pat-runner-invoice.rb
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/prestashop-automation-tool/helper.rb
 - lib/prestashop-automation-tool.rb
-- bin/pat.rb
+- lib/templates/sample_test.rb
+- bin/pat
+- bin/pat-runner-invoice.rb
 homepage: https://github.com/djfm/prestashop-automation-tool
 licenses:
 - OSL

data/bin/pat.rb

@@ -1,38 +0,0 @@
-#!/usr/bin/ruby
-require 'prestashop-automation-tool'
-
-require 'optparse'
-require 'json'
-
-def withConfig &block
-	if File.exists? 'pat.conf.json'
-		yield JSON.parse(File.read('pat.conf.json'), :symbolize_names => true)
-	else
-		abort "Could not find the config file #{pat.conf.json}, did you run 'pat.rb init'?"
-	end
-end
-
-options = {}
-OptionParser.new do |opts|
-	opts.on('-ad', '--accept-defaults', 'Accept default values automatically') do
-		options[:accept_defaults] = true
-	end
-end.parse!
-if ARGV.count != 1
-	puts "Missing action argument!"
-	exit 1
-elsif ARGV[0] == 'init'
-	conf = PrestaShopAutomationTool::ConfigurationParser.new '.'
-	conf.parse
-	conf.ask_user_for_missing_info options
-	conf.autocomplete_config
-	File.write 'pat.conf.json', JSON.pretty_generate({
-		shop: conf.config
-	})
-elsif ARGV[0] == 'install'
-	withConfig do |conf|
-		ps = PrestaShopAutomation::PrestaShop.new(conf[:shop])
-		ps.drop_database
-		ps.install options
-	end
-end