cartodb-4.42/services/importer/spec/unit/unp_spec.rb

361 lines
11 KiB
Ruby
Raw Normal View History

2024-04-06 13:25:13 +08:00
require 'fileutils'
require_relative '../../lib/importer/unp'
require_relative '../../../../spec/rspec_configuration.rb'
include CartoDB::Importer2
describe Unp do
describe '#run' do
it 'extracts the contents of the file' do
zipfile = file_factory
unp = Unp.new
unp.run(zipfile)
Dir.entries(unp.temporary_directory).should include('bogus1.csv', 'bogus2.csv')
FileUtils.rm_rf(unp.temporary_directory)
end
it 'extracts the contents of a carto file (see #11954)' do
zipfile = file_factory(filename: 'this_is_a_zip_file.carto')
unp = Unp.new
unp.run(zipfile)
Dir.entries(unp.temporary_directory).should include('bogus1.csv', 'bogus2.csv')
FileUtils.rm_rf(unp.temporary_directory)
end
it 'lets an uncompressed file pass through and store it in a tmp dir with uppercase chars' do
uncompressed_file = file_factory(filename: 'duplicated_column_name.csv')
unp = Unp.new('unp_temporal_folder' => '/tmp/IMPORTS')
unp.run(uncompressed_file)
Dir.entries(unp.temporary_directory).should include('duplicated_column_name.csv')
FileUtils.rm_rf(unp.temporary_directory)
end
it 'can deal with filenames with capital letters (compressed file)' do
zip_file = file_factory(filename: 'TestShape.zip')
unp = Unp.new
unp.run(zip_file)
# NOTE: the input zip file contains file names capitalized, e.g:
# Bryansk_stores_for_test_point.shp This test is added to make
# sure of backwards compatibility with other pieces of the
# importer. Observe the uncompressed file is "normalized" and
# thus downcased.
Dir.entries(unp.temporary_directory).should include('bryansk_stores_for_test_point.shp')
FileUtils.rm_rf(unp.temporary_directory)
end
it 'can deal with filenames with capital letters (uncompressed file)' do
uncompressed_file = file_factory(filename: 'Name_With_Capitals.csv')
unp = Unp.new
unp.run(uncompressed_file)
# NOTE: the input is a file name capitalized. This test is added
# to make sure of backwards compatibility with other pieces of
# the importer. Observe the output file name is "normalized" and
# thus downcased.
Dir.entries(unp.temporary_directory).should include('name_with_capitals.csv')
FileUtils.rm_rf(unp.temporary_directory)
end
it 'extracts the contents of a GPKG file' do
zipfile = file_factory(filename: 'geopackage.zip')
unp = Unp.new
unp.run(zipfile)
Dir.entries(unp.temporary_directory).should include('geopackage.gpkg')
unp.source_files.length.should eq 2
unp.source_files.map(&:layer).should eq ["pts", "lns"]
FileUtils.rm_rf(unp.temporary_directory)
end
it 'extracts the contents of a FGDB file' do
zipfile = file_factory(filename: 'filegeodatabase.zip')
unp = Unp.new
unp.run(zipfile)
Dir.entries(unp.temporary_directory).should include('filegeodatabase.gdb')
unp.source_files.length.should eq 2
unp.source_files.map(&:layer).should eq ["pts", "lns"]
FileUtils.rm_rf(unp.temporary_directory)
end
it 'extracts the contents of a FGDB file' do
zipfile = file_factory(filename: 'filegeodatabase.gdb.zip')
unp = Unp.new
unp.run(zipfile)
Dir.entries(unp.temporary_directory).should include('filegeodatabase.gdb')
unp.source_files.length.should eq 2
unp.source_files.map(&:layer).should eq ["pts", "lns"]
FileUtils.rm_rf(unp.temporary_directory)
end
it 'extracts the contents of a carto file with rar in the name (see #11954)' do
zipfile = file_factory(filename: 'this_is_not_a_rar_file.carto')
unp = Unp.new
unp.run(zipfile)
Dir.entries(unp.temporary_directory).should include('bogus1.csv', 'bogus2.csv')
FileUtils.rm_rf(unp.temporary_directory)
end
it 'populates a list of source files' do
zipfile = file_factory
unp = Unp.new
unp.source_files.should be_empty
unp.run(zipfile)
unp.source_files.should_not be_empty
end
it 'populates a single source file for the passed path if not compressed' do
unp = Unp.new
unp.source_files.should be_empty
unp.run(file_factory)
unp.source_files.length.should eq 2
end
end
describe '#without_unpacking' do
it 'pushes a source file for the passed file path to the source files' do
unp = Unp.new
unp.source_files.should be_empty
unp.without_unpacking(file_factory)
unp.source_files.size.should eq 1
end
it 'raises if the path does not belong to a file' do
expect { Unp.new.without_unpacking('/var/tmp') }.to raise_error NotAFileError
end
end
describe '#compressed?' do
it 'returns true if extension denotes a compressed file' do
unp = Unp.new
unp.compressed?('bogus.gz').should eq true
unp.compressed?('bogus.csv').should eq false
unp.compressed?('bogus.zip').should eq true
end
end
describe '#process' do
it 'adds a source_file for the path if extension supported' do
unp = Unp.new
unp.source_files.should be_empty
unp.process('/var/tmp/foo.csv')
unp.source_files.should_not be_empty
unp.source_files.first.should be_an_instance_of SourceFile
end
end
describe '#crawl' do
it 'returns a list of full paths for files in the directory' do
Dir.mktmpdir do |path|
fixture1 = "#{path}/bogus1.csv"
fixture2 = "#{path}/bogus2.csv"
FileUtils.touch(fixture1)
FileUtils.touch(fixture2)
unp = Unp.new
files = unp.crawl(path)
files.should include(fixture1)
files.should include(fixture2)
end
end
end
describe '#extract' do
it 'generates a temporary directory' do
dir = '/var/tmp/bogus'
zipfile = file_factory(dir)
unp = Unp.new.extract(zipfile)
File.directory?(unp.temporary_directory).should eq true
FileUtils.rm_r(dir)
end
it 'extracts the contents of the file into the temporary directory' do
dir = '/var/tmp/bogus'
zipfile = file_factory(dir)
unp = Unp.new.extract(zipfile)
(Dir.entries(unp.temporary_directory).size > 2).should eq true
FileUtils.rm_r(dir)
end
it 'raises if unp could not extract the file' do
expect { Unp.new.extract('/var/tmp/non_existent.zip') }.to raise_error ExtractionError
end
end
describe '#source_file_for' do
it 'returns a source_file for the passed path' do
Unp.new.source_file_for('/var/tmp/foo.txt')
.should be_an_instance_of SourceFile
end
end
describe '#command_for' do
it 'returns the unp command line to be executed' do
unp = Unp.new
command = unp.command_for('bogus')
command.any? { |c| c.match /unp/ }.should be_true
command.should include 'bogus'
end
it 'raises if unp is not found' do
Open3.expects('capture3').with('which unp').returns [0, 0, 1]
unp = Unp.new
expect { unp.command_for('wadus') }.to raise_error InstallError
end
end
describe '#supported?' do
it 'returns true if file extension is supported' do
unp = Unp.new
unp.supported?('foo.doc').should eq false
unp.supported?('foo.xls').should eq true
unp.supported?('foo.gpkg').should eq true
unp.supported?('foo.gdb').should eq true
unp.supported?('foo.fgdb').should eq true
end
end
describe '#normalize' do
it 'underscores the file name' do
fixture = "/var/tmp/#{Time.now.to_i} with spaces.txt"
File.open(fixture, 'w').close
new_name = Unp.new.normalize(fixture)
new_name.should match(/with_spaces/)
end
it 'renames the file to the underscored file name' do
fixture = "/var/tmp/#{Time.now.to_i} with spaces.txt"
File.open(fixture, 'w').close
unp = Unp.new
unp.normalize(fixture)
File.exists?(fixture).should eq false
end
end
describe '#underscore' do
it 'substitutes spaces for underscores in the file name' do
fixture = "/var/tmp/#{Time.now.to_i} with spaces.txt"
new_name = Unp.new.underscore(fixture)
new_name.should match(/with_spaces/)
end
it 'converts the file name to downcase' do
fixture = "/var/tmp/#{Time.now.to_i}.txt"
new_name = '/var/tmp/foo.txt'
File.open(fixture, 'w').close
end
end
describe '#rename' do
it 'renames a file' do
fixture = "/var/tmp/#{Time.now.to_i}.txt"
new_name = '/var/tmp/unp_spec_renamed.txt'
File.open(fixture, 'w').close
unp = Unp.new
unp.rename(fixture, new_name)
File.exists?(fixture).should eq false
File.exists?(new_name).should eq true
FileUtils.rm(new_name)
end
it 'does nothing if destination file name is the same as the original' do
fixture = "/var/tmp/#{Time.now.to_i}.txt"
File.open(fixture, 'w').close
unp = Unp.new
unp.rename(fixture, fixture)
File.exists?(fixture).should eq true
end
end
describe '#generate_temporary_directory' do
it 'creates a temporary directory' do
unp = Unp.new
unp.generate_temporary_directory
File.directory?(unp.temporary_directory).should eq true
end
it 'sets the temporary_directory instance variable' do
unp = Unp.new
unp.instance_variable_get(:@temporary_directory).should eq nil
unp.generate_temporary_directory
unp.temporary_directory.should_not eq nil
end
end
describe '#hidden?' do
it 'returns true if filename starts with a dot' do
unp = Unp.new
unp.hidden?('.bogus').should eq true
unp.hidden?('bogus').should eq false
end
it 'returns true if filename starts with two underscores' do
unp = Unp.new
unp.hidden?('__bogus').should eq true
unp.hidden?('_bogus').should eq false
end
end
describe '#unp_failure?' do
it 'returns true if unp cannot read the file' do
Unp.new.unp_failure?('Cannot read', -1).should eq true
end
it 'returns true if returned an error exit code' do
Unp.new.unp_failure?('', 999).should eq true
end
end
describe "configuration" do
it "Uses a different configuration path if specified" do
new_config_path = "/fake/uploads"
Unp.new("unp_temporal_folder" => new_config_path).get_temporal_subfolder_path.should eq new_config_path
Unp.new.get_temporal_subfolder_path.should eq Unp::DEFAULT_IMPORTER_TMP_SUBFOLDER
end
end
def file_factory(dir = '/var/tmp/bogus', filename: 'bogus.zip')
zipfile = "#{dir}/#{filename}"
FileUtils.rm(zipfile) if File.exists?(zipfile)
FileUtils.rm_r(dir) if File.exists?(dir)
FileUtils.mkdir_p(dir)
FileUtils.cp(File.join(File.dirname(__FILE__), "../fixtures/#{filename}"), zipfile)
zipfile
end
end