Files
openfoodnetwork/spec/models/product_importer_spec.rb
David Rodríguez 4c6d894bc0 Bump RuboCop to 1.86.6
There were a few changes needed:

* Plugins are now specified through `plugin:` config keyword.
* All plugin gems need to be specified explicitly in Gemfile since they
  are no longer dependencies of plugins already specified explicitly.
* All plugin gems need to be updated in other to use the new APIs.
* One cop was renamed.
* New offenses safe to correct were corrected directly with `bundle exec
  rubocop -a`.
* New offenses unsafe to correct were added to the TODO configuration
  with `bundle exec rubocop --auto-gen-config --auto-gen-only-exclude
  --exclude-limit 1400 --no-auto-gen-timestamp`.
2025-10-27 11:30:33 +01:00

1073 lines
43 KiB
Ruby

# frozen_string_literal: false
require 'spec_helper'
require 'open_food_network/permissions'
RSpec.describe ProductImport::ProductImporter do
let!(:admin) { create(:admin_user) }
let!(:user) { create(:user) }
let!(:user2) { create(:user) }
let!(:user3) { create(:user) }
let!(:enterprise) {
create(:enterprise, is_primary_producer: true, owner: user, name: "User Enterprise")
}
let!(:enterprise2) {
create(:distributor_enterprise, is_primary_producer: true, owner: user2,
name: "Another Enterprise")
}
let!(:enterprise3) {
create(:distributor_enterprise, is_primary_producer: true, owner: user3,
name: "And Another Enterprise")
}
let!(:enterprise4) {
create(:enterprise, is_primary_producer: false, owner: user, name: "Non-Producer")
}
let!(:relationship) {
create(:enterprise_relationship, parent: enterprise, child: enterprise2,
permissions_list: [:create_variant_overrides])
}
let!(:category) { create(:taxon, name: 'Vegetables') }
let!(:category2) { create(:taxon, name: 'Cake') }
let!(:category3) { create(:taxon, name: 'Meat') }
let!(:category4) { create(:taxon, name: 'Cereal') }
let!(:tax_category) { create(:tax_category) }
let!(:tax_category2) { create(:tax_category) }
let!(:shipping_category) { create(:shipping_category) }
let!(:product) {
create(:simple_product, name: 'Hypothetical Cake', description: nil,
primary_taxon_id: category2.id, supplier_id: enterprise2.id,
variants: [])
}
let!(:variant) {
create(:variant, product_id: product.id, price: '8.50', on_hand: '100', unit_value: '500',
display_name: 'Preexisting Banana', supplier: enterprise2)
}
let!(:variant_with_empty_display_name) {
create(:variant, product_id: product.id, price: '8.50', on_hand: '100', unit_value: '500',
display_name: '', supplier: enterprise2)
}
let!(:product2) {
create(:simple_product, on_hand: '100', name: 'Beans', unit_value: '500',
primary_taxon_id: category.id, description: nil, variants: [] )
}
let!(:product3) {
create(:simple_product, on_hand: '100', name: 'Sprouts', unit_value: '500',
primary_taxon_id: category.id, supplier_id: enterprise.id)
}
let!(:product4) {
create(:simple_product, on_hand: '100', name: 'Cabbage', unit_value: '1',
variant_unit_scale: nil, variant_unit: "items",
variant_unit_name: "Whole", primary_taxon_id: category.id,
supplier_id: enterprise.id)
}
let!(:product5) {
create(:simple_product, on_hand: '100', name: 'Lettuce', unit_value: '500',
primary_taxon_id: category.id, supplier_id: enterprise2.id)
}
let!(:product6) {
create(:simple_product, on_hand: '100', name: 'Beetroot',
unit_value: '500', on_demand: true, variant_unit_scale: 1,
variant_unit: 'weight', primary_taxon_id: category.id, description: nil,
supplier_id: enterprise3.id)
}
let!(:product7) {
create(:simple_product, on_hand: '100', name: 'Tomato', unit_value: '500',
variant_unit_scale: 1, variant_unit: 'weight',
primary_taxon_id: category.id, description: nil,
supplier_id: enterprise3.id)
}
let!(:product8) {
create(:simple_product, on_hand: '100', name: 'Oats', description: "",
unit_value: '500', variant_unit_scale: 1, variant_unit: 'weight',
primary_taxon_id: category4.id)
}
let!(:product9) {
create(:simple_product, on_hand: '100', name: 'Oats', description: "",
unit_value: '500', variant_unit_scale: 1, variant_unit: 'weight',
primary_taxon_id: category4.id)
}
let!(:variant2) {
create(:variant, product_id: product8.id, price: '4.50', on_hand: '100', unit_value: '500',
display_name: 'Porridge Oats', supplier: enterprise)
}
let!(:variant3) {
create(:variant, product_id: product8.id, price: '5.50', on_hand: '100', unit_value: '500',
display_name: 'Rolled Oats', supplier: enterprise)
}
let!(:variant4) {
create(:variant, product_id: product9.id, price: '6.50', on_hand: '100', unit_value: '500',
display_name: 'Flaked Oats', supplier: enterprise)
}
let!(:variant_override) {
create(:variant_override, variant_id: product4.variants.first.id, hub: enterprise2,
count_on_hand: 42)
}
let!(:variant_override2) {
create(:variant_override, variant_id: product5.variants.first.id, hub: enterprise,
count_on_hand: 96)
}
let(:permissions) { OpenFoodNetwork::Permissions.new(user) }
after(:each) do
File.delete('/tmp/test-m.csv')
end
describe "importing products from a spreadsheet" do
let(:csv_data) {
CSV.generate do |csv|
csv << ["name", "producer", "category", "on_hand", "price", "units", "unit_type",
"variant_unit_name", "on_demand", "shipping_category"]
csv << ["Carrots", enterprise.name, "Vegetables", "5", "3.20", "500", "g", "", "",
shipping_category.name]
csv << ["Potatoes", enterprise.name, "Vegetables", "6", "6.50", "2", "kg", "", "",
shipping_category.name]
csv << ["Pea Soup", enterprise.name, "Vegetables", "8", "5.50", "750", "ml", "", "0",
shipping_category.name]
csv << ["Salad", enterprise.name, "Vegetables", "7", "4.50", "1", "", "bags", "",
shipping_category.name]
csv << ["Hot Cross Buns", enterprise.name, "Cake", "7", "3.50", "1", "", "buns", "1",
shipping_category.name]
end
}
let(:importer) { import_data csv_data }
it "returns the number of entries" do
expect(importer.item_count).to eq(5)
end
it "validates entries and returns the results as json" do
importer.validate_entries
entries = JSON.parse(importer.entries_json)
expect(filter('valid', entries)).to eq 5
expect(filter('invalid', entries)).to eq 0
expect(filter('create_product', entries)).to eq 5
expect(filter('update_product', entries)).to eq 0
end
it "saves the results and returns info on updated products" do
importer.save_entries
expect(importer.products_created_count).to eq 5
expect(importer.updated_ids).to be_a(Array)
expect(importer.updated_ids.count).to eq 5
carrots_variant = find_variant("Carrots")
expect(carrots_variant.supplier).to eq enterprise
expect(carrots_variant.price).to eq 3.20
expect(carrots_variant.unit_value).to eq 500
expect(carrots_variant.variant_unit).to eq 'weight'
expect(carrots_variant.variant_unit_scale).to eq 1
expect(carrots_variant.on_demand).not_to eq true
expect(carrots_variant.on_hand).to eq 5
expect(carrots_variant.import_date).to be_within(1.minute).of Time.zone.now
potatoes_variant = find_variant("Potatoes")
expect(potatoes_variant.supplier).to eq enterprise
expect(potatoes_variant.price).to eq 6.50
expect(potatoes_variant.unit_value).to eq 2000
expect(potatoes_variant.variant_unit).to eq 'weight'
expect(potatoes_variant.variant_unit_scale).to eq 1000
expect(potatoes_variant.on_demand).not_to eq true
expect(potatoes_variant.on_hand).to eq 6
expect(potatoes_variant.import_date).to be_within(1.minute).of Time.zone.now
pea_soup_variant = find_variant("Pea Soup")
expect(pea_soup_variant.supplier).to eq enterprise
expect(pea_soup_variant.price).to eq 5.50
expect(pea_soup_variant.unit_value).to eq 0.75
expect(pea_soup_variant.variant_unit).to eq 'volume'
expect(pea_soup_variant.variant_unit_scale).to eq 0.001
expect(pea_soup_variant.on_demand).not_to eq true
expect(pea_soup_variant.on_hand).to eq 8
expect(pea_soup_variant.import_date).to be_within(1.minute).of Time.zone.now
salad_variant = find_variant("Salad")
expect(salad_variant.supplier).to eq enterprise
expect(salad_variant.price).to eq 4.50
expect(salad_variant.unit_value).to eq 1
expect(salad_variant.variant_unit).to eq 'items'
expect(salad_variant.variant_unit_scale).to eq nil
expect(salad_variant.on_demand).not_to eq true
expect(salad_variant.on_hand).to eq 7
expect(salad_variant.import_date).to be_within(1.minute).of Time.zone.now
buns_variant = find_variant("Hot Cross Buns")
expect(buns_variant.supplier).to eq enterprise
expect(buns_variant.price).to eq 3.50
expect(buns_variant.unit_value).to eq 1
expect(buns_variant.variant_unit).to eq 'items'
expect(buns_variant.variant_unit_scale).to eq nil
expect(buns_variant.on_demand).to eq true
expect(buns_variant.on_hand).to eq 7
expect(buns_variant.import_date).to be_within(1.minute).of Time.zone.now
end
end
describe "when uploading a spreadsheet with some invalid entries" do
let(:csv_data) {
CSV.generate do |csv|
csv << ["name", "producer", "category", "on_hand", "price", "units", "unit_type",
"shipping_category"]
csv << ["Good Carrots", enterprise.name, "Vegetables", "5", "3.20", "500", "g",
shipping_category.name]
csv << ["Bad Potatoes", "", "Vegetables", "6", "6.50", "1", "", shipping_category.name]
end
}
let(:importer) { import_data csv_data }
it "validates entries" do
importer.validate_entries
entries = JSON.parse(importer.entries_json)
expect(filter('valid', entries)).to eq 1
expect(filter('invalid', entries)).to eq 1
expect(filter('create_product', entries)).to eq 1
expect(filter('update_product', entries)).to eq 0
end
it "allows saving of the valid entries" do
importer.save_entries
expect(importer.products_created_count).to eq 1
expect(importer.updated_ids).to be_a(Array)
expect(importer.updated_ids.count).to eq 1
carrots_variant = find_variant("Good Carrots")
expect(carrots_variant.on_hand).to eq 5
expect(carrots_variant.supplier).to eq enterprise
expect(carrots_variant.price).to eq 3.20
expect(carrots_variant.import_date).to be_within(1.minute).of Time.zone.now
expect(Spree::Product.find_by(name: 'Bad Potatoes')).to eq nil
end
end
describe "when uploading a spreadsheet with some malformed data" do
# Use a simple string as CSV.generate will do some escaping
let(:csv_data) {
csv = "name,producer,category,on_hand,price,units,unit_type,shipping_category\n"
csv += "Good Carrots,#{enterprise.name},Vegetables,5,3.20,500,g,#{shipping_category.name}\n"
csv += "Malformed \rBrocolli,#{enterprise.name},
Vegetables,8,2.50,200,g,#{shipping_category.name}\n"
}
let(:importer) { import_data csv_data }
# an unquoted \n will create a non valid line which will fail entry validation
# hence why we are only testing with \r
it "should raise an unquoted field error if data include unquoted field with \r character" do
expect(importer.errors.messages.values).to include(
[format("Product Import encountered a malformed CSV: %s",
"Unquoted fields do not allow new line <\"\\r\"> in line 3.")]
)
end
end
describe "when uploading a spreadsheet with unnecessary leading and trailing whitespace" do
let(:csv_data) {
CSV.generate do |csv|
csv << [" name ", "\nproducer\n", "\rcategory\r", "\ton_hand\t",
" price ", " units ", " unit_type ", " shipping_category "]
csv << [" Good Carrots ", "\n#{enterprise.name}\n", "\rVegetables\r", "\t5\t",
" 3.20 ", " 500 ", " g ", " #{shipping_category.name} "]
end
}
let(:importer) { import_data csv_data }
it "ignores unnecessary leading and trailing whitespace in headers and rows" do
importer.save_entries
expect(importer.products_created_count).to eq 1
carrots_variant = find_variant("Good Carrots")
expect(carrots_variant.on_hand).to eq 5
expect(carrots_variant.primary_taxon.name).to eq "Vegetables"
expect(carrots_variant.supplier).to eq enterprise
expect(carrots_variant.price).to eq 3.20
expect(carrots_variant.shipping_category).to eq shipping_category
expect(carrots_variant.unit_presentation).to eq "500g"
end
end
describe "when shipping category is missing" do
let(:csv_data) {
CSV.generate do |csv|
csv << ["name", "producer", "category", "on_hand", "price", "units", "unit_type",
"variant_unit_name", "on_demand", "shipping_category"]
csv << ["Shipping Test", enterprise.name, "Vegetables", "5", "3.20", "500", "g", "", nil,
nil]
end
}
let(:importer) { import_data csv_data }
it "raises an error" do
importer.validate_entries
entries = JSON.parse(importer.entries_json)
expect(entries['2']['errors']['shipping_category']).to eq "Shipping_category can't be blank"
end
end
describe "when shipping category is not found" do
let(:csv_data) {
CSV.generate do |csv|
csv << ["name", "producer", "category", "on_hand", "price", "units", "unit_type",
"variant_unit_name", "on_demand", "shipping_category"]
csv << ["Shipping Test", enterprise.name, "Vegetables", "5", "3.20", "500", "g", "", nil,
"not_found"]
end
}
let(:importer) { import_data csv_data }
it "raises an error" do
importer.validate_entries
entries = JSON.parse(importer.entries_json)
error = entries['2']['errors']['shipping_category']
expect(error).to include "Shipping_category doesn't match allowed categories"
end
end
describe "when enterprises are not valid" do
let(:csv_data) {
CSV.generate do |csv|
csv << ["name", "producer", "category", "on_hand", "price", "units", "unit_type"]
csv << ["Product 1", "Non-existent Enterprise", "Vegetables", "5", "5.50", "500", "g"]
csv << ["Product 2", enterprise4.name, "Vegetables", "5", "5.50", "500", "g"]
end
}
let(:importer) { import_data csv_data }
it "adds enterprise errors" do
importer.validate_entries
entries = JSON.parse(importer.entries_json)
expect(entries['2']['errors']['producer']).to include "not found in database"
expect(entries['3']['errors']['producer']).to include "not enabled as a producer"
end
end
describe "adding new variants to existing products and updating exiting products" do
let(:csv_data) {
CSV.generate do |csv|
csv << ["name", "producer", "category", "on_hand", "price", "units", "unit_type",
"display_name", "shipping_category"]
csv << ["Hypothetical Cake", enterprise2.name, "Cake", "5", "5.50", "500", "g",
"Preexisting Banana", shipping_category.name]
csv << ["Hypothetical Cake", enterprise2.name, "Cake", "6", "3.50", "500", "g",
"Emergent Coffee", shipping_category.name]
end
}
let(:importer) { import_data csv_data }
it "validates entries" do
importer.validate_entries
entries = JSON.parse(importer.entries_json)
expect(filter('valid', entries)).to eq 2
expect(filter('invalid', entries)).to eq 0
expect(filter('create_product', entries)).to eq 1
expect(filter('update_product', entries)).to eq 1
end
it "saves and updates" do
importer.save_entries
expect(importer.products_created_count).to eq 1
expect(importer.products_updated_count).to eq 1
expect(importer.updated_ids).to be_a(Array)
expect(importer.updated_ids.count).to eq 2
added_coffee = Spree::Variant.find_by(display_name: 'Emergent Coffee')
expect(added_coffee.product.name).to eq 'Hypothetical Cake'
expect(added_coffee.price).to eq 3.50
expect(added_coffee.on_hand).to eq 6
expect(added_coffee.import_date).to be_within(1.minute).of Time.zone.now
updated_banana = Spree::Variant.find_by(display_name: 'Preexisting Banana')
expect(updated_banana.product.name).to eq 'Hypothetical Cake'
expect(updated_banana.price).to eq 5.50
expect(updated_banana.on_hand).to eq 5
expect(updated_banana.import_date).to be_within(1.minute).of Time.zone.now
end
end
describe "updating an exiting variant" do
let(:csv_data) {
CSV.generate do |csv|
csv << ["name", "producer", "description", "category", "on_hand", "price", "units",
"unit_type", "display_name", "shipping_category"]
csv << ["Hypothetical Cake", enterprise2.name, "New Description", "Cake", "5", "5.50",
"500", "g", "Preexisting Banana", shipping_category.name]
end
}
let(:importer) { import_data csv_data }
it "ignores (non-updatable) description field if it doesn't match the current description" do
importer.validate_entries
entries = JSON.parse(importer.entries_json)
expect(filter('valid', entries)).to eq 1
expect(filter('invalid', entries)).to eq 0
expect(filter('update_product', entries)).to eq 1
end
context "updating tax category" do
let(:csv_data) {
CSV.generate do |csv|
csv << ["name", "producer", "category", "on_hand", "price", "units",
"unit_type", "display_name", "shipping_category", "tax_category"]
csv << ["Hypothetical Cake", enterprise2.name, "Cake", "123", "123",
"500", "g", "Preexisting Banana", shipping_category.name, tax_category2.name]
end
}
it "allows updating tax category" do
importer.validate_entries
entries = JSON.parse(importer.entries_json)
expect(filter('valid', entries)).to eq 1
expect(filter('invalid', entries)).to eq 0
expect(filter('update_product', entries)).to eq 1
importer.save_entries
variant = Spree::Variant.find_by(display_name: "Preexisting Banana")
expect(variant.on_hand).to eq(123)
expect(variant.tax_category).to eq tax_category2
end
end
end
describe "updating variant having an nil display name with CSV with empty display name" do
let(:csv_data) {
CSV.generate do |csv|
csv << ["name", "producer", "category", "on_hand", "price", "units", "unit_type",
"display_name", "shipping_category"]
csv << ["Hypothetical Cake", enterprise2.name, "Cake", "5", "5.50", "500", "g",
"", shipping_category.name]
end
}
let(:importer) { import_data csv_data }
it "consider both existing and imported as the same and should be then updated" do
importer.validate_entries
entries = JSON.parse(importer.entries_json)
expect(filter('valid', entries)).to eq 1
expect(filter('invalid', entries)).to eq 0
expect(filter('create_product', entries)).to eq 0
expect(filter('update_product', entries)).to eq 1
end
end
describe "adding new product and sub-variant at the same time" do
let(:csv_data) {
CSV.generate do |csv|
csv << ["name", "producer", "category", "on_hand", "price", "units", "unit_type",
"display_name", "shipping_category"]
csv << ["Potatoes", enterprise.name, "Vegetables", "5", "3.50", "500", "g", "Small Bag",
shipping_category.name]
csv << ["Chives", enterprise.name, "Vegetables", "6", "4.50", "500", "g", "Bunch",
shipping_category.name]
csv << ["Potatoes", enterprise.name, "Vegetables", "6", "5.50", "2", "kg", "Big Bag",
shipping_category.name]
csv << ["Potatoes", enterprise.name, "Vegetables", "6", "22.00", "10000", "g",
"Small Sack", shipping_category.name]
csv << ["Potatoes", enterprise.name, "Vegetables", "6", "60.00", "30000", "", "Big Sack",
shipping_category.name]
end
}
let(:importer) { import_data csv_data }
it "validates entries" do
importer.validate_entries
entries = JSON.parse(importer.entries_json)
expect(filter('valid', entries)).to eq 3
expect(filter('invalid', entries)).to eq 2
expect(filter('create_product', entries)).to eq 3
end
it "saves and updates" do
importer.save_entries
expect(importer.products_created_count).to eq 3
expect(importer.updated_ids).to be_a(Array)
expect(importer.updated_ids.count).to eq 3
small_bag = Spree::Variant.find_by(display_name: 'Small Bag')
expect(small_bag.product.name).to eq 'Potatoes'
expect(small_bag.price).to eq 3.50
expect(small_bag.on_hand).to eq 5
big_bag = Spree::Variant.find_by(display_name: "Big Bag")
expect(big_bag).to be_blank
small_sack = Spree::Variant.find_by(display_name: "Small Sack")
expect(small_sack.product.name).to eq "Potatoes"
expect(small_sack.price).to eq 22.00
expect(small_sack.on_hand).to eq 6
expect(small_sack.product.id).to eq small_bag.product.id
big_sack = Spree::Variant.find_by(display_name: "Big Sack")
expect(big_sack).to be_blank
end
end
describe "updating various fields" do
let(:csv_data) {
CSV.generate do |csv|
csv << ["name", "producer", "category", "on_hand", "price", "units", "unit_type",
"on_demand", "sku", "shipping_category"]
csv << ["Beetroot", enterprise3.name, "Vegetables", "5", "3.50", "500", "g", "0", nil,
shipping_category.name]
csv << ["Tomato", enterprise3.name, "Vegetables", "6", "5.50", "500", "g", "1", "TOMS",
shipping_category.name]
end
}
let(:importer) { import_data csv_data }
it "validates entries" do
importer.validate_entries
entries = JSON.parse(importer.entries_json)
expect(filter('valid', entries)).to eq 2
expect(filter('invalid', entries)).to eq 0
expect(filter('create_product', entries)).to eq 0
expect(filter('update_product', entries)).to eq 2
end
it "saves and updates" do
importer.save_entries
expect(importer.products_created_count).to eq 0
expect(importer.products_updated_count).to eq 2
expect(importer.updated_ids).to be_a(Array)
expect(importer.updated_ids.count).to eq 2
beetroot = find_variant("Beetroot")
expect(beetroot.price).to eq 3.50
expect(beetroot.on_demand).not_to eq true
tomato = find_variant("Tomato")
expect(tomato.price).to eq 5.50
expect(tomato.on_demand).to eq true
end
end
describe "updating non-updatable fields on existing variants" do
let(:csv_data) {
CSV.generate do |csv|
csv << ["name", "producer", "category", "on_hand", "price", "units", "variant_unit_name",
"shipping_category"]
csv << ["Beetroot", enterprise3.name, "Vegetables", "5", "3.50", "500", "Half",
shipping_category.name]
csv << ["Tomato", enterprise3.name, "Vegetables", "6", "5.50", "500", "Half",
shipping_category.name]
end
}
let(:importer) { import_data csv_data }
it "does not allow updating" do
importer.validate_entries
entries = JSON.parse(importer.entries_json)
expect(filter('valid', entries)).to eq 0
expect(filter('invalid', entries)).to eq 2
importer.entries.each do |entry|
expect(entry.errors.messages.values)
.to include ['cannot be updated on existing products via product import']
end
end
end
describe "when more than one product of same name already exists with multiple variants each" do
let(:csv_data) {
<<~CSV
name,producer,category,description,on_hand,price,units,unit_type,display_name,shipping_category
Oats,#{enterprise.name},Cereal,,50,3.50,500,g,Rolled Oats,#{shipping_category.name}
Oats,#{enterprise.name},Cereal,,80,3.75,500,g,Flaked Oats,#{shipping_category.name}
Oats,#{enterprise.name},Cereal,,60,5.50,500,g,Magic Oats,#{shipping_category.name}
Oats,#{enterprise.name},Cereal,,70,8.50,500,g,French Oats,#{shipping_category.name}
Oats,#{enterprise.name},Cereal,,70,8.50,500,g,Scottish Oats,#{shipping_category.name}
CSV
}
let(:importer) { import_data csv_data }
it "validates entries" do
importer.validate_entries
entries = JSON.parse(importer.entries_json)
expect(filter('valid', entries)).to eq 5
expect(filter('invalid', entries)).to eq 0
expect(filter('create_product', entries)).to eq 3
expect(filter('update_product', entries)).to eq 2
expect(filter('create_inventory', entries)).to eq 0
expect(filter('update_inventory', entries)).to eq 0
end
it "saves and updates" do
importer.save_entries
expect(importer.products_created_count).to eq 3
expect(importer.products_updated_count).to eq 2
expect(importer.inventory_created_count).to eq 0
expect(importer.inventory_updated_count).to eq 0
expect(importer.updated_ids.count).to eq 5
end
end
describe "when importer processes create and update across multiple stages" do
let(:csv_data) {
CSV.generate do |csv|
csv << ["name", "producer", "category", "on_hand", "price", "units", "unit_type",
"display_name", "shipping_category"]
csv << [
"Bag of Oats", enterprise.name, "Cereal", "60", "5.50",
"500", "g", "Magic Oats", shipping_category.name
] # Add
csv << [
"Bag of Oats", enterprise.name, "Cereal", "70", "8.50",
"500", "g", "French Oats", shipping_category.name
] # Add
csv << [
"Bag of Oats", enterprise.name, "Cereal", "80", "9.50",
"500", "g", "Organic Oats", shipping_category.name
] # Add
csv << [
"Bag of Oats", enterprise.name, "Cereal", "90", "7.50",
"500", "g", "Scottish Oats", shipping_category.name
] # Add
csv << [
"Bag of Oats", enterprise.name, "Cereal", "30", "6.50",
"500", "g", "Breakfast Oats", shipping_category.name
] # Add
end
}
it "processes the validation in stages" do
# Using settings of start: 1, end: 3 to simulate import over multiple stages
importer = import_data csv_data, start: 1, end: 3
importer.validate_entries
entries = JSON.parse(importer.entries_json)
expect(filter('valid', entries)).to eq 3
expect(filter('invalid', entries)).to eq 0
expect(filter('create_product', entries)).to eq 3
expect(filter('update_product', entries)).to eq 0
expect(filter('create_inventory', entries)).to eq 0
expect(filter('update_inventory', entries)).to eq 0
importer = import_data csv_data, start: 4, end: 6
importer.validate_entries
entries = JSON.parse(importer.entries_json)
expect(filter('valid', entries)).to eq 2
expect(filter('invalid', entries)).to eq 0
expect(filter('create_product', entries)).to eq 2
expect(filter('update_product', entries)).to eq 0
expect(filter('create_inventory', entries)).to eq 0
expect(filter('update_inventory', entries)).to eq 0
end
it "processes saving in stages" do
importer = import_data csv_data, start: 1, end: 3
importer.save_entries
expect(importer.products_created_count).to eq 3
expect(importer.products_updated_count).to eq 0
expect(importer.inventory_created_count).to eq 0
expect(importer.inventory_updated_count).to eq 0
expect(importer.updated_ids.count).to eq 3
importer = import_data csv_data, start: 4, end: 6
importer.save_entries
expect(importer.products_created_count).to eq 2
expect(importer.products_updated_count).to eq 0
expect(importer.inventory_created_count).to eq 0
expect(importer.inventory_updated_count).to eq 0
expect(importer.updated_ids.count).to eq 2
products = Spree::Product.where(name: 'Bag of Oats')
expect(products.count).to eq 1
expect(products.first.variants.count).to eq 5
end
end
describe "importing items into inventory" do
describe "creating and updating inventory" do
let(:csv_data) {
CSV.generate do |csv|
csv << ["name", "distributor", "producer", "on_hand", "price", "units", "unit_type",
"variant_unit_name"]
csv << ["Beans", enterprise2.name, enterprise.name, "5", "3.20", "500", "g", ""]
csv << ["Sprouts", enterprise2.name, enterprise.name, "6", "6.50", "500", "g", ""]
csv << ["Cabbage", enterprise2.name, enterprise.name, "2001", "1.50", "1", "", "Whole"]
end
}
let(:importer) { import_data csv_data, import_into: 'inventories' }
it "validates entries" do
importer.validate_entries
entries = JSON.parse(importer.entries_json)
expect(filter('valid', entries)).to eq 3
expect(filter('invalid', entries)).to eq 0
expect(filter('create_inventory', entries)).to eq 2
expect(filter('update_inventory', entries)).to eq 1
end
it "saves and updates inventory" do
importer.save_entries
expect(importer.inventory_created_count).to eq 2
expect(importer.inventory_updated_count).to eq 1
expect(importer.updated_ids).to be_a(Array)
expect(importer.updated_ids.count).to eq 3
beans_override = VariantOverride.where(variant_id: product2.variants.first.id,
hub_id: enterprise2.id).first
sprouts_override = VariantOverride.where(variant_id: product3.variants.first.id,
hub_id: enterprise2.id).first
cabbage_override = VariantOverride.where(variant_id: product4.variants.first.id,
hub_id: enterprise2.id).first
expect(Float(beans_override.price)).to eq 3.20
expect(beans_override.count_on_hand).to eq 5
expect(Float(sprouts_override.price)).to eq 6.50
expect(sprouts_override.count_on_hand).to eq 6
expect(Float(cabbage_override.price)).to eq 1.50
expect(cabbage_override.count_on_hand).to eq 2001
end
end
describe "updating existing inventory referenced by display_name" do
let(:csv_data) {
CSV.generate do |csv|
csv << ["name", "display_name", "distributor", "producer", "on_hand", "price", "units"]
csv << ["Oats", "Porridge Oats", enterprise2.name, enterprise.name, "900", "1.0", "500"]
end
}
let(:importer) { import_data csv_data, import_into: 'inventories' }
it "updates inventory item correctly" do
importer.save_entries
expect(importer.inventory_created_count).to eq 1
override = VariantOverride.where(variant_id: variant2.id, hub_id: enterprise2.id).first
visible = InventoryItem.where(variant_id: variant2.id,
enterprise_id: enterprise2.id).first.visible
expect(override.count_on_hand).to eq 900
expect(visible).to be_truthy
end
end
describe "updating existing item that was set to hidden in inventory" do
let!(:inventory) {
InventoryItem.create(variant_id: product4.variants.first.id, enterprise_id: enterprise2.id,
visible: false)
}
let(:csv_data) {
CSV.generate do |csv|
csv << ["name", "distributor", "producer", "on_hand", "price", "units",
"variant_unit_name"]
csv << ["Cabbage", enterprise2.name, enterprise.name, "900", "1.0", "1", "Whole"]
end
}
let(:importer) { import_data csv_data, import_into: 'inventories' }
it "sets the item to visible in inventory when the item is updated" do
importer.save_entries
expect(importer.inventory_updated_count).to eq 1
override = VariantOverride.where(variant_id: product4.variants.first.id,
hub_id: enterprise2.id).first
visible = InventoryItem.where(variant_id: product4.variants.first.id,
enterprise_id: enterprise2.id).first.visible
expect(override.count_on_hand).to eq 900
expect(visible).to be_truthy
end
end
describe "when headers or rows contain unnecessary leading or trailing whitespace" do
let(:csv_data) {
CSV.generate do |csv|
csv << [" name ", "\ndisplay_name\n", "\rdistributor\r", "\tproducer\t",
" on_hand ", " price ", " units "]
csv << [" Oats ", "\nPorridge Oats\n", "\r#{enterprise2.name}\r",
"\t#{enterprise.name}\t", " 900 ", " 1.0 ", " 500 "]
end
}
let(:importer) { import_data csv_data, import_into: 'inventories' }
it "ignores unnecessary leading and trailing whitespace in headers and rows" do
importer.save_entries
expect(importer.inventory_created_count).to eq 1
override = VariantOverride.where(variant_id: variant2.id, hub_id: enterprise2.id).first
visible = InventoryItem.where(variant_id: variant2.id,
enterprise_id: enterprise2.id).first.visible
expect(override.count_on_hand).to eq 900
expect(visible).to be_truthy
end
end
end
describe "handling enterprise permissions" do
it "only allows product import into enterprises the user is permitted to manage" do
csv_data = CSV.generate do |csv|
csv << ["name", "producer", "category", "on_hand", "price", "units", "unit_type",
"shipping_category"]
csv << ["My Carrots", enterprise.name, "Vegetables", "5", "3.20", "500", "g",
shipping_category.name]
csv << ["Your Potatoes", enterprise2.name, "Vegetables", "6", "6.50", "1", "kg",
shipping_category.name]
end
importer = import_data csv_data, import_user: user
importer.validate_entries
entries = JSON.parse(importer.entries_json)
expect(filter('valid', entries)).to eq 1
expect(filter('invalid', entries)).to eq 1
expect(filter('create_product', entries)).to eq 1
importer.save_entries
expect(importer.products_created_count).to eq 1
expect(importer.updated_ids).to be_a(Array)
expect(importer.updated_ids.count).to eq 1
expect(Spree::Product.find_by(name: 'My Carrots')).to be_a Spree::Product
expect(Spree::Product.find_by(name: 'Your Potatoes')).to eq nil
end
it "allows creating inventories for producers that a user's hub has permission for" do
csv_data = CSV.generate do |csv|
csv << ["name", "producer", "distributor", "on_hand", "price", "units", "unit_type"]
csv << ["Beans", enterprise.name, enterprise2.name, "777", "3.20", "500", "g"]
end
importer = import_data csv_data, import_into: 'inventories'
importer.validate_entries
entries = JSON.parse(importer.entries_json)
expect(filter('valid', entries)).to eq 1
expect(filter('invalid', entries)).to eq 0
expect(filter('create_inventory', entries)).to eq 1
importer.save_entries
expect(importer.inventory_created_count).to eq 1
expect(importer.updated_ids).to be_a(Array)
expect(importer.updated_ids.count).to eq 1
beans = VariantOverride.where(variant_id: product2.variants.first.id,
hub_id: enterprise2.id).first
expect(beans.count_on_hand).to eq 777
end
it "does not allow creating inventories for producers " \
"that a user's hubs don't have permission for" do
csv_data = CSV.generate do |csv|
csv << ["name", "producer", "on_hand", "price", "units", "unit_type"]
csv << ["Beans", enterprise.name, "5", "3.20", "500", "g"]
csv << ["Sprouts", enterprise.name, "6", "6.50", "500", "g"]
end
importer = import_data csv_data, import_into: 'inventories'
importer.validate_entries
entries = JSON.parse(importer.entries_json)
expect(filter('valid', entries)).to eq 0
expect(filter('invalid', entries)).to eq 2
expect(filter('create_inventory', entries)).to eq 0
importer.save_entries
expect(importer.inventory_created_count).to eq 0
expect(importer.updated_ids).to be_a(Array)
expect(importer.updated_ids.count).to eq 0
end
end
describe "applying settings and defaults on import" do
it "can reset all products for an enterprise that are not present " \
"in the uploaded file to zero stock" do
csv_data = CSV.generate do |csv|
csv << ["name", "producer", "category", "on_hand", "price", "units", "unit_type",
"shipping_category"]
csv << ["Carrots", enterprise.name, "Vegetables", "5", "3.20", "500", "g",
shipping_category.name]
csv << ["Beans", enterprise.name, "Vegetables", "6", "6.50", "500", "g",
shipping_category.name]
end
importer = import_data csv_data, reset_all_absent: true
importer.validate_entries
entries = JSON.parse(importer.entries_json)
expect(filter('valid', entries)).to eq 2
expect(filter('invalid', entries)).to eq 0
expect(filter('create_product', entries)).to eq 1
expect(filter('update_product', entries)).to eq 1
importer.save_entries
expect(importer.products_created_count).to eq 1
expect(importer.products_updated_count).to eq 1
expect(importer.updated_ids).to be_a(Array)
expect(importer.updated_ids.count).to eq 2
updated_ids = importer.updated_ids
importer = import_data csv_data, reset_all_absent: true, updated_ids:,
enterprises_to_reset: [enterprise.id]
importer.reset_absent(updated_ids)
expect(importer.products_reset_count).to eq 7
expect(find_variant("Carrots").on_hand).to eq 5 # Present in file, added
expect(find_variant("Beans").on_hand).to eq 6 # Present in file, updated
expect(find_variant("Sprouts").on_hand).to eq 0 # In enterprise, not file
expect(find_variant("Cabbage").on_hand).to eq 0 # In enterprise, not file
expect(find_variant("Lettuce").on_hand).to eq 100 # In different enterprise; unchanged
end
it "can reset all inventory items for an enterprise that are not present " \
"in the uploaded file to zero stock" do
csv_data = CSV.generate do |csv|
csv << ["name", "distributor", "producer", "on_hand", "price", "units", "unit_type"]
csv << ["Beans", enterprise2.name, enterprise.name, "6", "3.20", "500", "g"]
csv << ["Sprouts", enterprise2.name, enterprise.name, "7", "6.50", "500", "g"]
end
importer = import_data csv_data, import_into: 'inventories', reset_all_absent: true
importer.validate_entries
entries = JSON.parse(importer.entries_json)
expect(filter('valid', entries)).to eq 2
expect(filter('invalid', entries)).to eq 0
expect(filter('create_inventory', entries)).to eq 2
importer.save_entries
expect(importer.inventory_created_count).to eq 2
expect(importer.updated_ids).to be_a(Array)
expect(importer.updated_ids.count).to eq 2
updated_ids = importer.updated_ids
importer = import_data csv_data, import_into: 'inventories', reset_all_absent: true,
updated_ids:,
enterprises_to_reset: [enterprise2.id]
importer.reset_absent(updated_ids)
beans = VariantOverride.where(variant_id: product2.variants.first.id,
hub_id: enterprise2.id).first
sprouts = VariantOverride.where(variant_id: product3.variants.first.id,
hub_id: enterprise2.id).first
cabbage = VariantOverride.where(variant_id: product4.variants.first.id,
hub_id: enterprise2.id).first
lettuce = VariantOverride.where(variant_id: product5.variants.first.id,
hub_id: enterprise.id).first
expect(beans.count_on_hand).to eq 6 # Present in file, created
expect(sprouts.count_on_hand).to eq 7 # Present in file, created
expect(cabbage.count_on_hand).to eq 0 # In enterprise, not in file (reset)
expect(lettuce.count_on_hand).to eq 96 # In different enterprise; unchanged
end
end
# Fix https://github.com/openfoodfoundation/openfoodnetwork/issues/12973
describe 'update existing product with units and on_hand/on_demand is empty' do
let(:csv_data) do
CSV.generate do |csv|
csv << ["name", "producer", "category", "on_hand", "price", "units", "unit_type",
"shipping_category", "on_demand"]
csv << ["Beetroot", enterprise3.name, "Vegetables", "", "6.50", "", "g",
shipping_category.name, "1"]
end
end
let(:importer) { import_data csv_data }
it "returns the units error due to invalid data" do
importer.validate_entries
entries = JSON.parse(importer.entries_json)
expect(entries.dig('2', 'errors')).to eq(
{
"units" => "Units can't be blank",
}
)
end
end
def find_variant(name)
Spree::Product.find_by(name:).variants.first
end
end
def import_data(csv_data, args = {})
import_user = args[:import_user] || admin
import_into = args[:import_into] || 'product_list'
start_row = args[:start] || 1
end_row = args[:end] || 100
reset_all_absent = args[:reset_all_absent] || false
updated_ids = args[:updated_ids] || nil
enterprises_to_reset = args[:enterprises_to_reset] || nil
settings = args[:settings] || { 'import_into' => import_into,
'reset_all_absent' => reset_all_absent }
File.write('/tmp/test-m.csv', csv_data)
@file ||= File.new('/tmp/test-m.csv')
ProductImport::ProductImporter.new(@file,
import_user,
start: start_row,
end: end_row,
updated_ids:,
enterprises_to_reset:,
settings:)
end
def filter(type, entries)
valid_count = 0
entries.each_value do |entry|
validates_as = entry['validates_as']
valid_count += 1 if type == 'valid' && (validates_as != '')
valid_count += 1 if type == 'invalid' && (validates_as == '')
valid_count += 1 if type == 'create_product' && ['new_product',
'new_variant'].include?(validates_as)
valid_count += 1 if type == 'update_product' && validates_as == 'existing_variant'
valid_count += 1 if type == 'create_inventory' && validates_as == 'new_inventory_item'
valid_count += 1 if type == 'update_inventory' && validates_as == 'existing_inventory_item'
end
valid_count
end