/*******************************************************************************
* Gisgraphy Project
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA
*
* Copyright 2008 Gisgraphy project
* David Masclet <davidmasclet@gisgraphy.com>
*
*
*******************************************************************************/
package com.gisgraphy.importer;
import static org.junit.Assert.fail;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import org.easymock.EasyMock;
import org.junit.Assert;
import org.junit.Test;
import com.gisgraphy.domain.valueobject.ImporterStatus;
import com.gisgraphy.domain.valueobject.ImporterStatusDto;
import com.gisgraphy.helper.FileHelper;
import com.gisgraphy.service.IInternationalisationService;
import com.gisgraphy.test.GisgraphyTestHelper;
public class OpenStreetMapCitiesFileRetrieverTest {
@Test
public void processShouldExtractFilesEvenIfRetrieveFileIsFalse(){
final List<String> methodCalled = new ArrayList<String>();
final String downloadFlag = "download";
final String decompressFlag = "decompress";
OpenStreetMapCitiesFileRetriever openStreetMapCitiesFileRetriever = new OpenStreetMapCitiesFileRetriever(){
@Override
protected void downloadFiles() {
methodCalled.add(downloadFlag);
}
@Override
public void decompressFiles() throws IOException {
methodCalled.add(decompressFlag);
}
};
ImporterConfig importerConfig = new ImporterConfig();
importerConfig.setOpenstreetmapImporterEnabled(true);
importerConfig.setRetrieveFiles(false);
openStreetMapCitiesFileRetriever.setInternationalisationService(createMockInternationalisationService());
openStreetMapCitiesFileRetriever.setImporterConfig(importerConfig);
openStreetMapCitiesFileRetriever.process();
Assert.assertEquals(decompressFlag, methodCalled.get(0));
}
@Test
public void processShouldExtractAndDownloadFilesIfRetrieveFileIsTrue(){
final List<String> methodCalled = new ArrayList<String>();
final String downloadFlag = "download";
final String decompressFlag = "decompress";
OpenStreetMapCitiesFileRetriever openStreetMapCitiesFileRetriever = new OpenStreetMapCitiesFileRetriever(){
@Override
protected void downloadFiles() {
methodCalled.add(downloadFlag);
}
@Override
public void decompressFiles() throws IOException {
methodCalled.add(decompressFlag);
}
};
ImporterConfig importerConfig = new ImporterConfig();
importerConfig.setOpenstreetmapImporterEnabled(true);
importerConfig.setRetrieveFiles(true);
openStreetMapCitiesFileRetriever.setInternationalisationService(createMockInternationalisationService());
openStreetMapCitiesFileRetriever.setImporterConfig(importerConfig);
openStreetMapCitiesFileRetriever.process();
Assert.assertEquals(downloadFlag, methodCalled.get(0));
Assert.assertEquals(decompressFlag, methodCalled.get(1));
}
@Test
public void processShouldDoNothingIfopenstreetmapIsDisabled(){
final List<String> methodCalled = new ArrayList<String>();
final String downloadFlag = "download";
final String decompressFlag = "decompress";
OpenStreetMapCitiesFileRetriever openStreetMapCitiesFileRetriever = new OpenStreetMapCitiesFileRetriever(){
@Override
protected void downloadFiles() {
methodCalled.add(downloadFlag);
}
@Override
public void decompressFiles() throws IOException {
methodCalled.add(decompressFlag);
}
};
ImporterConfig importerConfig = new ImporterConfig();
importerConfig.setOpenstreetmapImporterEnabled(false);
importerConfig.setRetrieveFiles(true);
openStreetMapCitiesFileRetriever.setInternationalisationService(createMockInternationalisationService());
openStreetMapCitiesFileRetriever.setImporterConfig(importerConfig);
openStreetMapCitiesFileRetriever.process();
Assert.assertEquals(0, methodCalled.size());
}
@Test
public void process() {
OpenStreetMapCitiesFileRetriever openStreetMapCitiesFileRetriever = new OpenStreetMapCitiesFileRetriever();
openStreetMapCitiesFileRetriever.setInternationalisationService(createMockInternationalisationService());
ImporterConfig importerConfig = new ImporterConfig();
importerConfig.setOpenstreetMapCitiesDownloadURL(ImporterConfigTest.GISGRAPHY_DOWNLOAD_SERVER+"/openstreetmap/version_3_0/");
// create a temporary directory to download files
File tempDir = FileHelper.createTempDir(this.getClass()
.getSimpleName());
// get files to download
List<String> filesToDownload =new ArrayList<String>();
String fileTobeDownload = "NU.gis";
filesToDownload.add(fileTobeDownload);
importerConfig.setOpenStreetMapCitiesFilesToDownload(fileTobeDownload);
importerConfig.setRetrieveFiles(true);
importerConfig.setOpenStreetMapCitiesDir(tempDir.getAbsolutePath());
// check that the directory is ending with the / or \ according to the
// System
Assert.assertTrue("openstreetmap cities dir must ends with" + File.separator,
importerConfig.getOpenStreetMapCitiesDir().endsWith(File.separator));
openStreetMapCitiesFileRetriever.setImporterConfig(importerConfig);
openStreetMapCitiesFileRetriever.process();
// check that openStreetmapURL ends with '/' : normally "/" is added
// if not
Assert.assertTrue("openstreetmapCitiesDownloadURL must ends with '/' but was "
+ importerConfig.getOpenstreetMapCitiesDownloadURL(), importerConfig
.getOpenstreetMapCitiesDownloadURL().endsWith("/"));
// check that files have been Downloaded
File file = null;
for (String fileToDownload : filesToDownload) {
file = new File(importerConfig.getOpenStreetMapCitiesDir() + fileToDownload);
if (importerConfig.isRetrieveFiles()) {
Assert.assertTrue("Le fichier " + fileToDownload
+ " have not been downloaded in "
+ importerConfig.getOpenStreetMapCitiesDir(), file.exists());
} else {
Assert.assertFalse("Le fichier " + fileToDownload
+ " have been downloaded in "
+ importerConfig.getOpenStreetMapCitiesDir()
+ " even if the option retrievefile is"
+ importerConfig.isRetrieveFiles(), file.exists());
}
}
// check that files have been untar
for (String fileToDownload : filesToDownload) {
String fileNameWithCSVExtension = fileToDownload.substring(0,
(fileToDownload.length()) - importerConfig.OPENSTREETAMP_COMPRESSED_FILE_EXTENSION.length())
+ ".txt";
file = new File(importerConfig.getOpenStreetMapCitiesDir()
+ fileNameWithCSVExtension);
if (importerConfig.isRetrieveFiles()) {
Assert.assertTrue("Le fichier " + fileNameWithCSVExtension
+ " have not been untar in "
+ importerConfig.getOpenStreetMapCitiesDir(), file.exists());
} else {
Assert.assertFalse("Le fichier " + fileToDownload
+ " have been unzip in "
+ importerConfig.getOpenStreetMapCitiesDir()
+ " even if the option retrievefile is"
+ importerConfig.isRetrieveFiles(), file.exists());
}
}
// delete temp dir
Assert.assertTrue("the tempDir has not been deleted", GisgraphyTestHelper
.DeleteNonEmptyDirectory(tempDir));
}
@Test
public void processWhenNotExistingFile() {
OpenStreetMapCitiesFileRetriever openStreetMapCitiesFileRetriever = new OpenStreetMapCitiesFileRetriever();
openStreetMapCitiesFileRetriever.setInternationalisationService(createMockInternationalisationService());
ImporterConfig importerConfig = new ImporterConfig();
importerConfig.setOpenstreetMapCitiesDownloadURL(ImporterConfigTest.GISGRAPHY_DOWNLOAD_SERVER+"/openstreetmap/version_3_0/");
// create a temporary directory to download files
File tempDir = FileHelper.createTempDir(this.getClass()
.getSimpleName());
// get files to download
List<String> filesToDownload =new ArrayList<String>();
String fileTobeDownload = "notExisting.gis";
filesToDownload.add(fileTobeDownload);
importerConfig.setOpenStreetMapCitiesFilesToDownload(fileTobeDownload);
importerConfig.setRetrieveFiles(true);
importerConfig.setOpenStreetMapCitiesDir(tempDir.getAbsolutePath());
openStreetMapCitiesFileRetriever.setImporterConfig(importerConfig);
try {
openStreetMapCitiesFileRetriever.process();
fail("all the files specify should exists");
} catch (ImporterException e) {
Assert.assertEquals(FileNotFoundException.class, e.getCause().getCause().getClass());
}
// delete temp dir
Assert.assertTrue("the tempDir has not been deleted", GisgraphyTestHelper
.DeleteNonEmptyDirectory(tempDir));
}
private IInternationalisationService createMockInternationalisationService() {
IInternationalisationService internationalisationService = EasyMock.createMock(IInternationalisationService.class);
EasyMock.expect(internationalisationService.getString((String)EasyMock.anyObject())).andStubReturn("localizedValue");
EasyMock.replay(internationalisationService);
return internationalisationService;
}
@Test
public void StatusShouldBeEqualsToSkipedIfRetrieveFileIsFalse(){
OpenStreetMapCitiesFileRetriever openStreetMapCitiesFileRetriever = new OpenStreetMapCitiesFileRetriever(){
@Override
public void decompressFiles() throws IOException {
return;
}
};
openStreetMapCitiesFileRetriever.setInternationalisationService(createMockInternationalisationService());
ImporterConfig importerConfig = new ImporterConfig();
importerConfig.setOpenstreetmapImporterEnabled(false);
openStreetMapCitiesFileRetriever.setImporterConfig(importerConfig);
openStreetMapCitiesFileRetriever.process();
Assert.assertEquals(ImporterStatus.SKIPPED, openStreetMapCitiesFileRetriever.getStatus());
ImporterStatusDto statusDto = new ImporterStatusDto(openStreetMapCitiesFileRetriever);
Assert.assertEquals(0, statusDto.getPercent());
}
@Test
public void StatusShouldBeEqualsToPROCESSEDIfNoError(){
OpenStreetMapCitiesFileRetriever openStreetMapCitiesFileRetriever = new OpenStreetMapCitiesFileRetriever();
openStreetMapCitiesFileRetriever.setInternationalisationService(createMockInternationalisationService());
ImporterConfig importerConfig = EasyMock.createMock(ImporterConfig.class);
EasyMock.expect(importerConfig.isRetrieveFiles()).andReturn(true).times(2);
EasyMock.expect(importerConfig.isOpenstreetmapImporterEnabled()).andReturn(true);
EasyMock.expect(importerConfig.getGeonamesDownloadFilesListFromOption()).andStubReturn(new ArrayList<String>());
EasyMock.expect(importerConfig.getOpenStreetMapCitiesDir()).andStubReturn("");
EasyMock.expect(importerConfig.getOpenstreetMapCitiesDownloadURL()).andStubReturn("");
EasyMock.expect(importerConfig.getOpenStreetMapCitiesDownloadFilesListFromOption()).andStubReturn(new ArrayList<String>());
EasyMock.replay(importerConfig);
openStreetMapCitiesFileRetriever.setImporterConfig(importerConfig);
openStreetMapCitiesFileRetriever.process();
Assert.assertEquals(ImporterStatus.PROCESSED, openStreetMapCitiesFileRetriever.getStatus());
ImporterStatusDto statusDto = new ImporterStatusDto(openStreetMapCitiesFileRetriever);
Assert.assertEquals(100, statusDto.getPercent());
}
@Test
public void shouldBeSkipShouldReturnCorrectValue(){
ImporterConfig importerConfig = new ImporterConfig();
OpenStreetMapCitiesFileRetriever openStreetMapCitiesFileRetriever = new OpenStreetMapCitiesFileRetriever();
openStreetMapCitiesFileRetriever.setImporterConfig(importerConfig);
importerConfig.setOpenstreetmapImporterEnabled(false);
Assert.assertTrue(openStreetMapCitiesFileRetriever.shouldBeSkipped());
importerConfig.setOpenstreetmapImporterEnabled(true);
Assert.assertFalse(openStreetMapCitiesFileRetriever.shouldBeSkipped());
}
@Test
public void getFilesToDownloadShouldReturnTheImporterConfigOption(){
ImporterConfig importerConfig = new ImporterConfig();
String fileTobeDownload = "AD.gis";
List<String> filesToDownload =new ArrayList<String>();
filesToDownload.add(fileTobeDownload);
importerConfig.setOpenStreetMapCitiesFilesToDownload(fileTobeDownload);
OpenStreetMapCitiesFileRetriever openStreetMapCitiesFileRetriever = new OpenStreetMapCitiesFileRetriever();
openStreetMapCitiesFileRetriever.setImporterConfig(importerConfig);
Assert.assertEquals("getFilesToDownload should return the importerConfig Option",filesToDownload, openStreetMapCitiesFileRetriever.getFilesToDownload());
}
}