@ -3,186 +3,110 @@ require "rails_helper"
RSpec . describe BulkUpload :: Lettings :: Validator do RSpec . describe BulkUpload :: Lettings :: Validator do
subject ( :validator ) { described_class . new ( bulk_upload : , path : ) } subject ( :validator ) { described_class . new ( bulk_upload : , path : ) }
let ( :organisation ) { create ( :organisation , old_visible_id : " 3 " ) } let ( :organisation ) { create ( :organisation , old_visible_id : " 3 " , rent_periods : [ 2 ] ) }
let ( :user ) { create ( :user , organisation : ) } let ( :user ) { create ( :user , organisation : ) }
let ( :log ) { build ( :lettings_log , :completed , startdate : Time . zone . local ( 2024 , 3 , 3 ) ) } let ( :log ) { build ( :lettings_log , :completed , period : 2 , assigned_to : user ) }
let ( :bulk_upload ) { create ( :bulk_upload , user : ) } let ( :log_to_csv ) { BulkUpload :: LettingsLogToCsv . new ( log : ) }
let ( :bulk_upload ) { create ( :bulk_upload , user : , year : log . collection_start_year ) }
let ( :path ) { file . path } let ( :path ) { file . path }
let ( :file ) { Tempfile . new } let ( :file ) { Tempfile . new }
describe " validations " do describe " validations " do
context " when 2023 " do context " when file has headers " do
let ( :bulk_upload ) { create ( :bulk_upload , user : , year : 2023 ) } context " and is empty " do
it " is not valid " do
context " when file has no headers " do expect ( validator ) . not_to be_valid
context " and too many columns " do expect ( validator . errors [ " base " ] ) . to eql ( [ " Template is blank - The template must be filled in for us to create the logs and check if data is correct. " ] )
before do
file . write ( ( " a " * 143 ) . chars . join ( " , " ) )
file . write ( " \n " )
file . rewind
end
it " is not valid " do
expect ( validator ) . not_to be_valid
expect ( validator . errors [ " base " ] ) . to eql ( [ " Too many columns, please ensure you have used the correct template " ] )
end
end
context " and is empty " do
it " is not valid " do
expect ( validator ) . not_to be_valid
expect ( validator . errors [ " base " ] ) . to eql ( [ " Template is blank - The template must be filled in for us to create the logs and check if data is correct. " ] )
end
end
context " and doesn't have too many columns " do
before do
file . write ( ( " a " * 142 ) . chars . join ( " , " ) )
file . write ( " \n " )
file . rewind
end
it " is valid " do
expect ( validator ) . to be_valid
end
end end
end end
context " when file has headers " do context " and file has extra invalid headers " do
context " and is empty " do let ( :seed ) { rand }
it " is not valid " do let ( :field_numbers ) { log_to_csv . default_field_numbers + %w[ invalid_field_number ] }
expect ( validator ) . not_to be_valid let ( :field_values ) { log_to_csv . to_row + %w[ value_for_invalid_field_number ] }
expect ( validator . errors [ " base " ] ) . to eql ( [ " Template is blank - The template must be filled in for us to create the logs and check if data is correct. " ] )
end
end
context " and file has extra invalid headers " do before do
let ( :seed ) { rand } file . write ( log_to_csv . custom_field_numbers_row ( seed : , field_numbers : ) )
let ( :log_to_csv ) { BulkUpload :: LettingsLogToCsv . new ( log : ) } file . write ( log_to_csv . to_custom_csv_row ( seed : , field_values : ) )
let ( :field_numbers ) { log_to_csv . default_2023_field_numbers + %w[ invalid_field_number ] } file . rewind
let ( :field_values ) { log_to_csv . to_2023_row + %w[ value_for_invalid_field_number ] }
before do
file . write ( log_to_csv . custom_field_numbers_row ( seed : , field_numbers : ) )
file . write ( log_to_csv . to_custom_csv_row ( seed : , field_values : ) )
file . rewind
end
it " is valid " do
expect ( validator ) . to be_valid
end
end end
context " and file has too few valid headers " do it " is valid " do
let ( :seed ) { rand } expect ( validator ) . to be_valid
let ( :log_to_csv ) { BulkUpload :: LettingsLogToCsv . new ( log : ) }
let ( :field_numbers ) { log_to_csv . default_2023_field_numbers }
let ( :field_values ) { log_to_csv . to_2023_row }
before do
field_numbers . delete_at ( 20 )
field_values . delete_at ( 20 )
file . write ( log_to_csv . custom_field_numbers_row ( seed : , field_numbers : ) )
file . write ( log_to_csv . to_custom_csv_row ( seed : , field_values : ) )
file . rewind
end
it " is not valid " do
expect ( validator ) . not_to be_valid
expect ( validator . errors [ " base " ] ) . to eql ( [ " Incorrect number of fields, please ensure you have used the correct template " ] )
end
end end
end
context " and file has too many valid headers " do context " and file has too few valid headers " do
let ( :seed ) { rand } let ( :seed ) { rand }
let ( :log_to_csv ) { BulkUpload :: LettingsLogToCsv . new ( log : ) } let ( :field_numbers ) { log_to_csv . default_field_numbers }
let ( :field_numbers ) { log_to_csv . default_2023_field_numbers + %w[ 23 ] } let ( :field_values ) { log_to_csv . to_row }
let ( :field_values ) { log_to_csv . to_2023_row + %w[ value ] }
before do
before do field_numbers . delete_at ( 20 )
file . write ( log_to_csv . custom_field_numbers_row ( seed : , field_numbers : ) ) field_values . delete_at ( 20 )
file . write ( log_to_csv . to_custom_csv_row ( seed : , field_values : ) ) file . write ( log_to_csv . custom_field_numbers_row ( seed : , field_numbers : ) )
file . rewind file . write ( log_to_csv . to_custom_csv_row ( seed : , field_values : ) )
end file . rewind
end
it " is not valid " do it " is not valid " do
expect ( validator ) . not_to be_valid expect ( validator ) . not_to be_valid
expect ( validator . errors [ " base " ] ) . to eql ( [ " Incorrect number of fields, please ensure you have used the correct template " ] ) expect ( validator . errors [ " base " ] ) . to eql ( [ " Incorrect number of fields, please ensure you have used the correct template " ] )
end
end end
end end
context " when uploading a 2022 logs for 2023 bulk upload " do context " and file has too many valid headers " do
let ( :bulk_upload ) { create ( :bulk_upload , user : , year : 2023 ) } let ( :seed ) { rand }
let ( :log ) { build ( :lettings_log , :completed , startdate : Time . zone . local ( 2022 , 5 , 6 ) , tenancycode : " 5 " ) } let ( :field_numbers ) { log_to_csv . default_field_numbers + %w[ 23 ] }
let ( :field_values ) { log_to_csv . to_row + %w[ value ] }
context " with no headers " do
before do
file . write ( BulkUpload :: LettingsLogToCsv . new ( log : , line_ending : " \r \n " , col_offset : 0 ) . to_2023_csv_row )
file . close
end
it " is not valid " do before do
expect ( validator ) . not_to be_valid file . write ( log_to_csv . custom_field_numbers_row ( seed : , field_numbers : ) )
end file . write ( log_to_csv . to_custom_csv_row ( seed : , field_values : ) )
file . rewind
end end
context " with headers " do it " is not valid " do
let ( :seed ) { rand } expect ( validator ) . not_to be_valid
let ( :log_to_csv ) { BulkUpload :: LettingsLogToCsv . new ( log : ) } expect ( validator . errors [ " base " ] ) . to eql ( [ " Incorrect number of fields, please ensure you have used the correct template " ] )
let ( :field_numbers ) { log_to_csv . default_2023_field_numbers }
let ( :field_values ) { log_to_csv . to_2023_row }
before do
file . write ( log_to_csv . custom_field_numbers_row ( seed : , field_numbers : ) )
file . write ( log_to_csv . to_custom_csv_row ( seed : , field_values : ) )
file . rewind
end
it " is not valid " do
expect ( validator ) . not_to be_valid
end
end end
end end
end
context " when uploading a 2023 logs for 2024 bulk upload " do context " when uploading a 2023 logs for 2024 bulk upload " do
let ( :bulk_upload ) { create ( :bulk_upload , user : , year : 2024 ) } let ( :log ) { build ( :lettings_log , :completed , startdate : Time . zone . local ( 2023 , 5 , 6 ) , tenancycode : " 5234234234234 " ) }
let ( :log ) { build ( :lettings_log , :completed , startdate : Time . zone . local ( 2023 , 5 , 6 ) , tenancycode : " 5234234234234 " ) } let ( :bulk_upload ) { build ( :bulk_upload , user : , year : 2024 ) }
context " with no headers " do context " with headers " do
before do let ( :seed ) { rand }
file . write ( BulkUpload :: LettingsLogToCsv . new ( log : , line_ending : " \r \n " , col_offset : 0 ) . to_2024_csv_row ) let ( :field_numbers ) { log_to_csv . default_2024_field_numbers }
file . close let ( :field_values ) { log_to_csv . to_2024_row }
end
it " is not valid " do before do
expect ( validator ) . not_to be_valid file . write ( log_to_csv . custom_field_numbers_row ( seed : , field_numbers : ) )
end file . write ( log_to_csv . to_custom_csv_row ( seed : , field_values : ) )
file . rewind
end end
context " with headers " do it " is not valid " do
let ( :seed ) { rand } expect ( validator ) . not_to be_valid
let ( :log_to_csv ) { BulkUpload :: LettingsLogToCsv . new ( log : ) } expect ( validator . errors [ " base " ] ) . to eql ( [ " Incorrect start dates, please ensure you have used the correct template " ] )
let ( :field_numbers ) { log_to_csv . default_2024_field_numbers }
let ( :field_values ) { log_to_csv . to_2024_row }
before do
file . write ( log_to_csv . custom_field_numbers_row ( seed : , field_numbers : ) )
file . write ( log_to_csv . to_custom_csv_row ( seed : , field_values : ) )
file . rewind
end
it " is not valid " do
expect ( validator ) . not_to be_valid
end
end end
end end
end end
end end
describe " # call " do describe " # call " do
context " when a valid csv " do context " with an invalid 2024 csv " do
let ( :path ) { file_fixture ( " 2023_24_lettings_bulk_upload_invalid.csv " ) } let ( :log ) { build ( :lettings_log , :completed , startdate : Time . zone . local ( 2024 , 7 , 1 ) , period : 2 , assigned_to : user ) }
before do
values = log_to_csv . to_2024_row
values [ 7 ] = nil
file . write ( log_to_csv . default_2024_field_numbers_row )
file . write ( log_to_csv . to_custom_csv_row ( seed : nil , field_values : values ) )
file . rewind
end
it " creates validation errors " do it " creates validation errors " do
expect { validator . call } . to change ( BulkUploadError , :count ) expect { validator . call } . to change ( BulkUploadError , :count )
@ -191,36 +115,39 @@ RSpec.describe BulkUpload::Lettings::Validator do
it " create validation error with correct values " do it " create validation error with correct values " do
validator . call validator . call
error = BulkUploadError . find_by ( row : " 9 " , field : " field_7 " , category : " setup " ) error = BulkUploadError . find_by ( row : " 2 " , field : " field_8 " , category : " setup " )
expect ( error . field ) . to eql ( " field_7 " ) expect ( error . field ) . to eql ( " field_8 " )
expect ( error . error ) . to eql ( " You must answer tenancy start date (day) " ) expect ( error . error ) . to eql ( " You must answer tenancy start date (day) " )
expect ( error . tenant_code ) . to eql ( " 123 " ) expect ( error . tenant_code ) . to eql ( log . tenancycode )
expect ( error . property_ref ) . to be_nil expect ( error . property_ref ) . to eql ( log . propcode )
expect ( error . row ) . to eql ( " 9 " ) expect ( error . row ) . to eql ( " 2 " )
expect ( error . cell ) . to eql ( " H9 " ) expect ( error . cell ) . to eql ( " I2 " )
expect ( error . col ) . to eql ( " H " ) expect ( error . col ) . to eql ( " I " )
end end
end end
context " with arbitrary ordered 23/24 csv " do context " with a valid csv " do
let ( :bulk_upload ) { create ( :bulk_upload , user : , year : 2023 ) } before do
let ( :log ) { build ( :lettings_log , :completed ) } file . write ( log_to_csv . default_field_numbers_row )
let ( :file ) { Tempfile . new } file . write ( log_to_csv . to_csv_row )
let ( :path ) { file . path } file . rewind
let ( :seed ) { 321 } end
around do | example |
FormHandler . instance . use_real_forms!
example . run
FormHandler . instance . use_fake_forms! it " does not create validation errors " do
expect { validator . call } . not_to change ( BulkUploadError , :count )
end end
end
context " with arbitrary ordered invalid csv " do
let ( :seed ) { 321 }
let ( :log ) { build ( :lettings_log , :completed , startdate : Time . zone . local ( 2024 , 7 , 1 ) , period : 2 , assigned_to : user ) }
before do before do
file . write ( BulkUpload :: LettingsLogToCsv . new ( log : , line_ending : " \r \n " ) . default_2023_field_numbers_row ( seed : ) ) log . needstype = nil
file . write ( BulkUpload :: LettingsLogToCsv . new ( log : , line_ending : " \r \n " ) . to_2023_csv_row ( seed : ) ) values = log_to_csv . to_2024_row
file . write ( log_to_csv . default_2024_field_numbers_row ( seed : ) )
file . write ( log_to_csv . to_custom_csv_row ( seed : , field_values : values ) )
file . close file . close
end end
@ -231,59 +158,71 @@ RSpec.describe BulkUpload::Lettings::Validator do
it " create validation error with correct values " do it " create validation error with correct values " do
validator . call validator . call
error = BulkUploadError . find_by ( field : " field_5 " ) error = BulkUploadError . find_by ( field : " field_4 " )
expect ( error . field ) . to eql ( " field_5 " ) expect ( error . field ) . to eql ( " field_4 " )
expect ( error . error ) . to eql ( " You must answer letting type " ) expect ( error . error ) . to eql ( " You must answer needs type " )
expect ( error . tenant_code ) . to eql ( log . tenancycode ) expect ( error . tenant_code ) . to eql ( log . tenancycode )
expect ( error . property_ref ) . to eql ( log . propcode ) expect ( error . property_ref ) . to eql ( log . propcode )
expect ( error . row ) . to eql ( " 2 " ) expect ( error . row ) . to eql ( " 2 " )
expect ( error . cell ) . to eql ( " DD 2" ) expect ( error . cell ) . to eql ( " CY 2" )
expect ( error . col ) . to eql ( " DD " ) expect ( error . col ) . to eql ( " CY " )
end end
end end
context " when duplicate rows present " do context " when duplicate rows present " do
let ( :file ) { Tempfile . new }
let ( :path ) { file . path }
let ( :log ) { build ( :lettings_log , :completed ) }
before do before do
file . write ( BulkUpload :: LettingsLogToCsv . new ( log : , line_ending : " \r \n " ) . default_2023 _field_numbers_row ) file . write ( log_to_csv . default_field_numbers_row )
file . write ( BulkUpload :: LettingsLogToCsv . new ( log : , line_ending : " \r \n " ) . to_2023 _csv_row) file . write ( log_to_csv . to_csv_row )
file . write ( BulkUpload :: LettingsLogToCsv . new ( log : , line_ending : " \r \n " ) . to_2023 _csv_row) file . write ( log_to_csv . to_csv_row )
file . close file . close
end end
it " creates errors " do it " creates errors " do
expect { validator . call } . to change ( BulkUploadError . where ( category : :setup , error : " This is a duplicate of a log in your file " ) , :count ) . by ( 22 ) expect { validator . call } . to change ( BulkUploadError . where ( category : :setup , error : " This is a duplicate of a log in your file " ) , :count )
end end
end end
context " with unix line endings " do [
let ( :fixture_path ) { file_fixture ( " 2023_24_lettings_bulk_upload.csv " ) } { line_ending : " \n " , name : " unix " } ,
let ( :file ) { Tempfile . new } { line_ending : " \r \n " , name : " windows " } ,
let ( :path ) { file . path } ] . each do | test_case |
context " with #{ test_case [ :name ] } line endings " do
let ( :log_to_csv ) { BulkUpload :: LettingsLogToCsv . new ( log : , line_ending : test_case [ :line_ending ] ) }
before do context " with a valid file " do
string = File . read ( fixture_path ) before do
string . gsub! ( " \r \n " , " \n " ) file . write ( log_to_csv . default_field_numbers_row )
file . write ( string ) file . write ( log_to_csv . to_csv_row )
file . rewind file . rewind
end end
it " creates validation errors " do it " does not create validation errors " do
expect { validator . call } . to change ( BulkUploadError , :count ) expect { validator . call } . not_to change ( BulkUploadError , :count )
end
end
context " with an invalid file " do
let ( :log ) { build ( :lettings_log , :completed , assigned_to : user , owning_organisation : organisation , managing_organisation : organisation , declaration : nil ) }
before do
file . write ( log_to_csv . default_field_numbers_row )
file . write ( log_to_csv . to_csv_row )
file . rewind
end
it " creates validation errors " do
expect { validator . call } . to change ( BulkUploadError , :count )
end
end
end end
end end
context " without headers " do context " with a 2024 csv without headers " do
let ( :log ) { build ( :lettings_log , :completed ) } let ( :log ) { build ( :lettings_log , :completed , startdate : Time . zone . local ( 2024 , 7 , 1 ) , period : 2 , assigned_to : user ) }
let ( :file ) { Tempfile . new }
let ( :path ) { file . path }
before do before do
file . write ( BulkUpload :: LettingsLogToCsv . new ( log : , line_ending : " \r \n " , col_offset : 0 ) . to_2023_csv_row ) file . write ( log_to_csv . to _csv_row)
file . close file . close
end end
@ -294,47 +233,29 @@ RSpec.describe BulkUpload::Lettings::Validator do
end end
describe " # create_logs? " do describe " # create_logs? " do
context " when all logs are valid " do context " when a log has a clearable, non-setup error " do
let ( :target_path ) { file_fixture ( " 2023_24_lettings_bulk_upload.csv " ) } let ( :log_1 ) { build ( :lettings_log , :completed , period : 2 , assigned_to : user ) }
let ( :log_2 ) { build ( :lettings_log , :completed , period : 2 , assigned_to : user , age1 : 5 ) }
it " returns truthy " do
validator . call
expect ( validator ) . to be_create_logs
end
end
context " when there is an invalid log " do
let ( :path ) { file_fixture ( " 2023_24_lettings_bulk_upload_invalid.csv " ) }
it " returns falsey " do
validator . call
expect ( validator ) . not_to be_create_logs
end
end
context " when a log is not valid? " do
let ( :log_1 ) { build ( :lettings_log , :completed , assigned_to : user ) }
let ( :log_2 ) { build ( :lettings_log , :completed , assigned_to : user ) }
before do before do
file . write ( BulkUpload :: LettingsLogToCsv . new ( log : log_1 , line_ending : " \r \n " , col_offset : 0 ) . to_2023 _csv_row ) file . write ( BulkUpload :: LettingsLogToCsv . new ( log : log_1 , col_offset : 0 ) . to_csv_row )
file . write ( BulkUpload :: LettingsLogToCsv . new ( log : log_2 , line_ending : " \r \n " , col_offset : 0 , overrides : { illness : 100 } ) . to_2023 _csv_row ) file . write ( BulkUpload :: LettingsLogToCsv . new ( log : log_2 , col_offset : 0 ) . to_csv_row )
file . close file . close
end end
it " returns false " do it " returns false " do
validator . call validator . call
expect ( validator ) . not_ tobe_create_logs expect ( validator ) . to be_create_logs
end end
end end
context " when all logs valid? " do context " when all logs valid? " do
let ( :log_1 ) { build ( :lettings_log , :completed , renttype : 1 , assigned_to : user ) } let ( :log_1 ) { build ( :lettings_log , :completed , period : 2 , assigned_to : user ) }
let ( :log_2 ) { build ( :lettings_log , :completed , renttype : 1 , assigned_to : user ) } let ( :log_2 ) { build ( :lettings_log , :completed , period : 2 , assigned_to : user ) }
before do before do
file . write ( BulkUpload :: LettingsLogToCsv . new ( log : log_1 , line_ending : " \r \n " , col_offset : 0 ) . to_2023 _csv_row ) file . write ( BulkUpload :: LettingsLogToCsv . new ( log : log_1 , col_offset : 0 ) . to_csv_row )
file . write ( BulkUpload :: LettingsLogToCsv . new ( log : log_2 , line_ending : " \r \n " , col_offset : 0 ) . to_2023 _csv_row ) file . write ( BulkUpload :: LettingsLogToCsv . new ( log : log_2 , col_offset : 0 ) . to_csv_row )
file . close file . close
end end
@ -344,13 +265,13 @@ RSpec.describe BulkUpload::Lettings::Validator do
end end
end end
context " when a single log wants to block log creation " do context " when a log wants to block log creation " do
let ( :unaffiliated_org ) { create ( :organisation ) } let ( :unaffiliated_org ) { create ( :organisation ) }
let ( :log_1 ) { build ( :lettings_log , :completed , renttype : 1 , assigned_to : user , owning_organisation : unaffiliated_org ) } let ( :log ) { build ( :lettings_log , :completed , assigned_to : user , owning_organisation : unaffiliated_org ) }
before do before do
file . write ( BulkUpload :: LettingsLogToCsv . new ( log : log_1 , line_ending : " \r \n " , col_offset : 0 ) . to_2023 _csv_row) file . write ( log_to_csv . to _csv_row)
file . close file . close
end end
@ -361,10 +282,10 @@ RSpec.describe BulkUpload::Lettings::Validator do
end end
context " when a log has incomplete setup section " do context " when a log has incomplete setup section " do
let ( :log ) { build ( :lettings_log , :in_progress , assigned_to : user , startdate : Time . zone . local ( 2022 , 5 , 1 ) ) } let ( :log ) { build ( :lettings_log , :completed , declaration : nil , assigned_to : user ) }
before do before do
file . write ( BulkUpload :: LettingsLogToCsv . new ( log : , line_ending : " \r \n " , col_offset : 0 ) . to_2023 _csv_row) file . write ( log_to_csv . to _csv_row)
file . close file . close
end end
Rachael Booth
8 months ago
committed by
GitHub