ref #10222: merge DescriptionUtility and DistributionServiceUtilities
[cdmlib.git] / cdmlib-services / src / test / java / eu / etaxonomy / cdm / api / service / geo / DistributionServiceImplTest.java
1 /**
2 * Copyright (C) 2007 EDIT
3 * European Distributed Institute of Taxonomy
4 * http://www.e-taxonomy.eu
5 *
6 * The contents of this file are subject to the Mozilla Public License Version 1.1
7 * See LICENSE.TXT at the top of this package for the full license terms.
8 */
9 package eu.etaxonomy.cdm.api.service.geo;
10
11 import static org.junit.Assert.assertTrue;
12
13 import java.awt.Color;
14 import java.io.FileNotFoundException;
15 import java.io.IOException;
16 import java.io.InputStream;
17 import java.io.InputStreamReader;
18 import java.net.HttpURLConnection;
19 import java.net.MalformedURLException;
20 import java.net.URL;
21 import java.util.ArrayList;
22 import java.util.Collection;
23 import java.util.HashMap;
24 import java.util.HashSet;
25 import java.util.List;
26 import java.util.Map;
27 import java.util.Set;
28 import java.util.UUID;
29
30 import org.apache.commons.lang3.StringUtils;
31 import org.apache.http.client.ClientProtocolException;
32 import org.apache.logging.log4j.LogManager;
33 import org.apache.logging.log4j.Logger;
34 import org.junit.Assert;
35 import org.junit.Before;
36 import org.junit.Test;
37 import org.unitils.dbunit.annotation.DataSet;
38 import org.unitils.spring.annotation.SpringBeanByType;
39
40 import eu.etaxonomy.cdm.api.service.ITaxonService;
41 import eu.etaxonomy.cdm.api.service.ITermService;
42 import eu.etaxonomy.cdm.api.service.IVocabularyService;
43 import eu.etaxonomy.cdm.common.StreamUtils;
44 import eu.etaxonomy.cdm.common.URI;
45 import eu.etaxonomy.cdm.common.UriUtils;
46 import eu.etaxonomy.cdm.model.common.CdmBase;
47 import eu.etaxonomy.cdm.model.common.Language;
48 import eu.etaxonomy.cdm.model.common.MarkerType;
49 import eu.etaxonomy.cdm.model.description.DescriptionElementBase;
50 import eu.etaxonomy.cdm.model.description.Distribution;
51 import eu.etaxonomy.cdm.model.description.Feature;
52 import eu.etaxonomy.cdm.model.description.PresenceAbsenceTerm;
53 import eu.etaxonomy.cdm.model.description.TaxonDescription;
54 import eu.etaxonomy.cdm.model.location.Country;
55 import eu.etaxonomy.cdm.model.location.NamedArea;
56 import eu.etaxonomy.cdm.model.location.NamedAreaLevel;
57 import eu.etaxonomy.cdm.model.location.NamedAreaType;
58 import eu.etaxonomy.cdm.model.taxon.Taxon;
59 import eu.etaxonomy.cdm.model.term.DefinedTermBase;
60 import eu.etaxonomy.cdm.model.term.TermType;
61 import eu.etaxonomy.cdm.model.term.TermVocabulary;
62 import eu.etaxonomy.cdm.test.integration.CdmTransactionalIntegrationTest;
63
64 /**
65 * @author a.mueller
66 * @since 08.10.2008
67 */
68 public class DistributionServiceImplTest extends CdmTransactionalIntegrationTest {
69
70 private static final Logger logger = LogManager.getLogger();
71
72 private static final String EDIT_MAPSERVICE_URI_STRING = "https://edit.africamuseum.be/edit_wp5/v1.2/rest_gen.php";
73 private static URI editMapServiceUri;
74
75 @SpringBeanByType
76 private ITermService termService;
77
78 @SpringBeanByType
79 private IVocabularyService vocabService;
80
81 @SpringBeanByType
82 private GeoServiceAreaAnnotatedMapping mapping;
83
84 @SpringBeanByType
85 private IDistributionService distributionService;
86
87 @SpringBeanByType
88 private ITaxonService taxonService ;
89
90 @Before
91 public void setUp() throws Exception {
92 System.setProperty("ONLY-A-TEST", "TRUE"); // allows EditGeoServiceUtilities to skip some line of code
93 editMapServiceUri = new URI(EDIT_MAPSERVICE_URI_STRING);
94 }
95
96 //******************************************** TESTS**************
97
98 @Test
99 public void testGetWebServiceUrlCountry() {
100 Set<Distribution> distributions = new HashSet<>();
101 Country germany = termService.findByIdInVocabulary("DEU", Country.uuidCountryVocabulary, Country.class);
102
103 distributions.add(Distribution.NewInstance(germany, PresenceAbsenceTerm.PRESENT()));
104 distributions.add(Distribution.NewInstance(termService.findByIdInVocabulary("DE", Country.uuidCountryVocabulary, Country.class), PresenceAbsenceTerm.INTRODUCED()));
105 Map<PresenceAbsenceTerm, Color> presenceAbsenceColorMap = new HashMap<>();
106 presenceAbsenceColorMap.put(PresenceAbsenceTerm.PRESENT(), Color.BLUE);
107 presenceAbsenceColorMap.put(PresenceAbsenceTerm.INTRODUCED(), Color.BLACK);
108 List<Language> languages = new ArrayList<>();
109
110 boolean subAreaPreference = false;
111 boolean statusOrderPreference = false;
112
113 Collection<Distribution> filteredDistributions = DistributionServiceUtilities.filterDistributions(
114 distributions, null, false, statusOrderPreference, subAreaPreference, true, false);
115
116 String result = DistributionServiceUtilities.getDistributionServiceRequestParameterString(filteredDistributions,
117 mapping, null, null, languages );
118 logger.warn(result);
119 Assert.assertTrue("WebServiceUrl must contain country part for Germany", result.matches(".*ad=country_earth(%3A|:)gmi_cntry:.:DEU.*"));
120 }
121
122 @Test
123 public void testGetWebServiceUrlTdwg() throws MalformedURLException, IOException {
124 //String webServiceUrl = "http://www.test.de/webservice";
125 Set<Distribution> distributions = new HashSet<>();
126 distributions.add(Distribution.NewInstance(termService.getAreaByTdwgAbbreviation("SPA"), PresenceAbsenceTerm.PRESENT()));
127 distributions.add(Distribution.NewInstance(termService.getAreaByTdwgAbbreviation("GER"), PresenceAbsenceTerm.INTRODUCED()));
128 distributions.add(Distribution.NewInstance(termService.getAreaByTdwgAbbreviation("14"), PresenceAbsenceTerm.CULTIVATED()));
129 distributions.add(Distribution.NewInstance(termService.getAreaByTdwgAbbreviation("BGM"), PresenceAbsenceTerm.ABSENT()));
130 distributions.add(Distribution.NewInstance(termService.getAreaByTdwgAbbreviation("FRA"), PresenceAbsenceTerm.ABSENT()));
131 distributions.add(Distribution.NewInstance(termService.getAreaByTdwgAbbreviation("IND-AP"), PresenceAbsenceTerm.PRESENT()));
132
133 Map<PresenceAbsenceTerm, Color> presenceAbsenceColorMap = new HashMap<>();
134 presenceAbsenceColorMap.put(PresenceAbsenceTerm.PRESENT(), Color.BLUE);
135 presenceAbsenceColorMap.put(PresenceAbsenceTerm.INTRODUCED(), Color.BLACK);
136 presenceAbsenceColorMap.put(PresenceAbsenceTerm.CULTIVATED(), Color.YELLOW);
137 presenceAbsenceColorMap.put(PresenceAbsenceTerm.ABSENT(), Color.DARK_GRAY);
138 // String backLayer ="";
139 presenceAbsenceColorMap = null;
140 // String bbox="-20,0,120,70";
141 List<Language> languages = new ArrayList<>();
142
143 // boolean subAreaPreference = false;
144 // boolean statusOrderPreference = false;
145 String result = DistributionServiceUtilities.getDistributionServiceRequestParameterString(
146 distributions,
147 mapping,
148 null, // presenceAbsenceTermColors
149 null, // projectToLayer
150 languages );
151 //TODO Set semantics is not determined
152 //String expected = "http://www.test.de/webservice?l=tdwg3&ad=tdwg3:a:GER|b:OKL|c:BGM|b:SPA|d:FRA&as=a:005500|b:00FF00|c:FFFFFF|d:001100&bbox=-20,40,40,40&ms=400x300";
153 logger.debug(result);
154 assertTrue(result.matches(".*ad=tdwg[1-4].*"));
155 assertTrue(result.matches(".*tdwg2:[a-d]:14[\\|&].*") );
156 assertTrue(result.matches(".*[a-d]:FRA,BGM[\\|&].*") || result.matches(".*[a-d]:BGM,FRA[\\|&].*") );
157 assertTrue(result.matches(".*[a-d]:GER[\\|&].*") );
158 assertTrue(result.matches(".*[a-d]:SPA[\\|&].*") );
159 assertTrue(result.matches(".*tdwg4:[a-d]:INDAP[\\|&].*") );
160 //assertTrue(result.matches("0000ff"));
161 //TODO continue
162
163 // request map image from webservice
164 subTestWithEditMapService(result);
165 }
166
167 @Test
168 public void testGetWebServiceUrlCyprus() throws ClientProtocolException, IOException {
169 makeCyprusAreas();
170 Set<Distribution> distributions = new HashSet<>();
171 distributions.add(Distribution.NewInstance(divisions.get("1"), PresenceAbsenceTerm.PRESENT()));
172 distributions.add(Distribution.NewInstance(divisions.get("2"), PresenceAbsenceTerm.INTRODUCED()));
173 distributions.add(Distribution.NewInstance(divisions.get("3"), PresenceAbsenceTerm.CULTIVATED()));
174 distributions.add(Distribution.NewInstance(divisions.get("4"), PresenceAbsenceTerm.ABSENT()));
175 distributions.add(Distribution.NewInstance(divisions.get("5"), PresenceAbsenceTerm.ABSENT()));
176 distributions.add(Distribution.NewInstance(divisions.get("6"), PresenceAbsenceTerm.PRESENT()));
177
178 Map<PresenceAbsenceTerm, Color> presenceAbsenceColorMap = new HashMap<>();
179 presenceAbsenceColorMap.put(PresenceAbsenceTerm.PRESENT(), Color.BLUE);
180 presenceAbsenceColorMap.put(PresenceAbsenceTerm.INTRODUCED(), Color.BLACK);
181 presenceAbsenceColorMap.put(PresenceAbsenceTerm.CULTIVATED(), Color.YELLOW);
182 presenceAbsenceColorMap.put(PresenceAbsenceTerm.ABSENT(), Color.DARK_GRAY);
183 presenceAbsenceColorMap = null;
184 List<Language> languages = new ArrayList<>();
185
186 String result = DistributionServiceUtilities.getDistributionServiceRequestParameterString(
187 distributions,
188 mapping,
189 null, null, languages );
190 //TODO Set semantics is not determined
191 //String expected = "http://www.test.de/webservice?l=tdwg3&ad=tdwg3:a:GER|b:OKL|c:BGM|b:SPA|d:FRA&as=a:005500|b:00FF00|c:FFFFFF|d:001100&bbox=-20,40,40,40&ms=400x300";
192 assertTrue(result.matches(".*ad=cyprusdivs%3Abdcode:.*"));
193 assertTrue(result.matches(".*[a-d]:5,4[\\|&].*") || result.matches(".*[a-d]:4,5[\\|&].*") );
194 assertTrue(result.matches(".*[a-d]:1,6[\\|&].*") || result.matches(".*[a-d]:6,1[\\|&].*") );
195 assertTrue(result.matches(".*[a-d]:2[\\|&].*") );
196 assertTrue(result.matches(".*[a-d]:3[\\|&].*") );
197
198 // request map image from webservice
199 subTestWithEditMapService(result);
200 }
201
202 private void subTestWithEditMapService(String queryString)throws MalformedURLException, IOException {
203 if(UriUtils.isServiceAvailable(editMapServiceUri)){
204 URL requestUrl = new URL(editMapServiceUri.toString() + "?img=false&bbox=-180,-90,180,90&ms=1000&" + queryString);
205 logger.debug("editMapServiceUri: " + requestUrl);
206 HttpURLConnection connection = (HttpURLConnection) requestUrl.openConnection();
207 connection.connect();
208 // connection.setReadTimeout(10000); //timeout after 10 sec, does not seem to work
209 assertTrue(connection.getResponseCode() == 200);
210 InputStream contentStream = connection.getInputStream();
211 String content = StreamUtils.readToString(contentStream);
212 logger.debug("EditMapService response body:\n" + content);
213 assertTrue(content.startsWith("[{"));
214 assertTrue(content.endsWith("}]"));
215 assertTrue(content.matches(".*\"bbox\":.*"));
216 assertTrue(content.matches(".*\"legend\":.*"));
217 assertTrue(content.matches(".*\"layers\":.*"));
218 assertTrue(content.matches(".*\"sld\":.*"));
219 assertTrue(content.matches(".*\"geoserver\":.*"));
220 }
221 }
222
223 public static final UUID uuidCyprusDivisionsVocabulary = UUID.fromString("2119f610-1f93-4d87-af28-40aeefaca100");
224 private final Map<String, NamedArea> divisions = new HashMap<>();
225
226 private boolean makeCyprusAreas() throws IOException {
227 //divisions
228
229 NamedAreaType areaType = NamedAreaType.NATURAL_AREA();
230 NamedAreaLevel areaLevel = NamedAreaLevel.NewInstance("Cyprus Division", "Cyprus Division", null);
231
232 termService.saveOrUpdate(areaLevel);
233
234 TermVocabulary<NamedArea> areaVocabulary = TermVocabulary.NewInstance(TermType.NamedArea,
235 NamedArea.class, "Cyprus devisions", "Cyprus divisions", null, null);
236 areaVocabulary.setUuid(uuidCyprusDivisionsVocabulary);
237
238 for(int i = 1; i <= 8; i++){
239 UUID divisionUuid = getNamedAreaUuid(String.valueOf(i));
240 NamedArea division = this.newNamedArea(
241 divisionUuid,
242 "Division " + i,
243 "Cyprus: Division " + i,
244 String.valueOf(i), // id in vocab
245 areaType,
246 areaLevel,
247 areaVocabulary);
248 divisions.put(String.valueOf(i), division);
249 }
250
251 vocabService.saveOrUpdate(areaVocabulary);
252 commitAndStartNewTransaction(null);
253
254 // import and map shapefile attributes from csv
255 InputStream is = getClass().getClassLoader().getResourceAsStream("eu/etaxonomy/cdm/api/service/geo/cyprusdivs.csv");
256 List<String> idSearchFields = new ArrayList<String>();
257 idSearchFields.add("bdcode");
258 String wmsLayerName = "cyprusdivs";
259 distributionService.mapShapeFileToNamedAreas(new InputStreamReader(is), idSearchFields, wmsLayerName, uuidCyprusDivisionsVocabulary, null);
260
261 divisions.clear();
262 Set<DefinedTermBase> terms = vocabService.load(uuidCyprusDivisionsVocabulary).getTerms();
263 for(DefinedTermBase<?> dtb : terms){
264 divisions.put(dtb.getIdInVocabulary(), (NamedArea) dtb);
265 }
266
267 // indigenousStatus = (PresenceTerm)getTermService().find(CyprusTransformer.indigenousUuid);
268 // casualStatus = (PresenceTerm)getTermService().find(CyprusTransformer.casualUuid);
269 // nonInvasiveStatus = (PresenceTerm)getTermService().find(CyprusTransformer.nonInvasiveUuid);
270 // invasiveStatus = (PresenceTerm)getTermService().find(CyprusTransformer.invasiveUuid);
271 // questionableStatus = (PresenceTerm)getTermService().find(CyprusTransformer.questionableUuid);
272
273 return true;
274 }
275
276 public static final UUID uuidDivision1 = UUID.fromString("ab17eee9-1abb-4ce9-a9a2-563f840cdbfc");
277 public static final UUID uuidDivision2 = UUID.fromString("c3606165-efb7-4224-a168-63e009eb4aa5");
278 public static final UUID uuidDivision3 = UUID.fromString("750d4e07-e34b-491f-a7b7-09723afdc960");
279 public static final UUID uuidDivision4 = UUID.fromString("8a858922-e8e5-4791-ad53-906e50633ec7");
280 public static final UUID uuidDivision5 = UUID.fromString("16057133-d541-4ebd-81d4-cb92265ec54c");
281 public static final UUID uuidDivision6 = UUID.fromString("fbf21230-4a42-4f4c-9af8-5da52123c264");
282 public static final UUID uuidDivision7 = UUID.fromString("d31dd96a-36ea-4428-871c-d8552a9565ca");
283 public static final UUID uuidDivision8 = UUID.fromString("236ea447-c3ab-486d-9e06-cc5907861acc");
284
285 public UUID getNamedAreaUuid(String key) {
286 if (StringUtils.isBlank(key)){return null;
287 }else if (key.equalsIgnoreCase("1")){return uuidDivision1;
288 }else if (key.equalsIgnoreCase("2")){return uuidDivision2;
289 }else if (key.equalsIgnoreCase("3")){return uuidDivision3;
290 }else if (key.equalsIgnoreCase("4")){return uuidDivision4;
291 }else if (key.equalsIgnoreCase("5")){return uuidDivision5;
292 }else if (key.equalsIgnoreCase("6")){return uuidDivision6;
293 }else if (key.equalsIgnoreCase("7")){return uuidDivision7;
294 }else if (key.equalsIgnoreCase("8")){return uuidDivision8;
295 }else{
296 return null;
297 }
298 }
299
300 protected NamedArea newNamedArea(UUID uuid, String label, String text, String IdInVocabulary, NamedAreaType areaType, NamedAreaLevel level, TermVocabulary<NamedArea> voc){
301 NamedArea namedArea = NamedArea.NewInstance(text, label, null);
302 voc.addTerm(namedArea);
303 namedArea.setType(areaType);
304 namedArea.setLevel(level);
305 namedArea.setUuid(uuid);
306 namedArea.setIdInVocabulary(IdInVocabulary);
307 return namedArea;
308 }
309
310 @Test
311 public void testGetWebServiceUrlBangka() throws ClientProtocolException, IOException {
312 NamedArea areaBangka = NamedArea.NewInstance("Bangka", "Bangka", null);
313 TermVocabulary<NamedArea> voc = TermVocabulary.NewInstance(TermType.NamedArea,
314 NamedArea.class, "test Voc", "test voc", null, null);
315 voc.addTerm(areaBangka);
316
317 GeoServiceArea geoServiceArea = new GeoServiceArea();
318 String geoServiceLayer="vmap0_as_bnd_political_boundary_a";
319 String layerFieldName ="nam";
320 String areaValue = "PULAU BANGKA#SUMATERA SELATAN";
321 geoServiceArea.add(geoServiceLayer, layerFieldName, areaValue);
322 geoServiceArea.add(geoServiceLayer, layerFieldName, "BALI");
323
324 mapping.set(areaBangka, geoServiceArea);
325 Set<Distribution> distributions = new HashSet<>();
326 distributions.add(Distribution.NewInstance(areaBangka, PresenceAbsenceTerm.PRESENT()));
327
328 Map<PresenceAbsenceTerm, Color> presenceAbsenceColorMap = new HashMap<>();
329 presenceAbsenceColorMap.put(PresenceAbsenceTerm.PRESENT(), Color.BLUE);
330
331 presenceAbsenceColorMap = null;
332 List<Language> languages = new ArrayList<>();
333
334 String result = DistributionServiceUtilities.getDistributionServiceRequestParameterString(distributions,
335 mapping,
336 null, null, languages );
337 //TODO Set semantics is not determined
338 //String expected = "http://www.test.de/webservice?l=tdwg3&ad=tdwg3:a:GER|b:OKL|c:BGM|b:SPA|d:FRA&as=a:005500|b:00FF00|c:FFFFFF|d:001100&bbox=-20,40,40,40&ms=400x300";
339
340 logger.debug(result);
341 assertTrue(result.matches(".*ad=vmap0_as_bnd_political_boundary_a%3Anam:.*"));
342 assertTrue(result.matches(".*(PULAU\\+BANGKA%23SUMATERA\\+SELATAN).*") );
343 assertTrue(result.matches(".*(BALI).*") );
344
345 // request map image from webservice
346 subTestWithEditMapService(result);
347 }
348
349 @SuppressWarnings("deprecation")
350 // @Test
351 @DataSet( value="EditGeoServiceTest.getDistributionServiceRequestParameterString.xml")
352 // @DataSets({
353 // @DataSet(loadStrategy=CleanSweepInsertLoadStrategy.class, value="/eu/etaxonomy/cdm/database/ClearDB_with_Terms_DataSet.xml"),
354 // @DataSet("/eu/etaxonomy/cdm/database/TermsDataSet-with_auditing_info.xml"),
355 // @DataSet( value="EditGeoServiceTest.getDistributionServiceRequestParameterString.xml")
356 // })
357 public void getDistributionServiceRequestParameterString(){
358 boolean subAreaPreference = false;
359 boolean statusOrderPreference = false;
360 Set<MarkerType> hideMarkedAreas = null;
361 Map<PresenceAbsenceTerm, Color> presenceAbsenceTermColors = null;
362 List<Language> langs = null;
363
364 List<TaxonDescription> taxonDescriptions = new ArrayList<>();
365 TaxonDescription description1 = TaxonDescription.NewInstance();
366 taxonDescriptions.add(description1);
367 Distribution distribution1 = Distribution.NewInstance(Country.GERMANY(), null);
368 description1.addElement(distribution1);
369 Distribution distribution2 = Distribution.NewInstance(Country.FRANCE(), null);
370 distribution2.setFeature(Feature.COMMON_NAME());
371 description1.addElement(distribution2);
372
373 Taxon taxon = (Taxon)taxonService.find(UUID.fromString("7598f5d4-1cf2-4269-ae99-2adb79ae167c"));
374 TaxonDescription taxDesc = taxon.getDescriptions().iterator().next();
375 for (DescriptionElementBase deb : taxDesc.getElements()){
376 Distribution distribution = CdmBase.deproxy(deb, Distribution.class);
377 NamedArea area = distribution.getArea();
378 System.out.println(area.getTitleCache());
379 }
380 taxonDescriptions.addAll(taxon.getDescriptions());
381
382 String distributions = distributionService.getDistributionServiceRequestParameterString(taxonDescriptions,
383 subAreaPreference, statusOrderPreference, hideMarkedAreas, presenceAbsenceTermColors, langs);
384 System.out.println(distributions);
385 Assert.assertTrue("Distribution string should contain the non-persited distribution Germany", distributions.contains("DEU"));
386 Assert.assertFalse("Distribution string should contain France as it has a non-distribution feature", distributions.contains("FRA"));
387 // CHE,POL
388 }
389
390 @Override
391 // @Test
392 public void createTestDataSet() throws FileNotFoundException {
393
394 List<TaxonDescription> taxonDescriptions = new ArrayList<>();
395 TaxonDescription description1 = TaxonDescription.NewInstance();
396 taxonDescriptions.add(description1);
397 Distribution distribution1 = Distribution.NewInstance(Country.POLANDPOLISHPEOPLESREPUBLIC(), null);
398 description1.addElement(distribution1);
399 Distribution distribution2 = Distribution.NewInstance(Country.SWITZERLANDSWISSCONFEDERATION(), null);
400 // distribution2.setFeature(Feature.COMMON_NAME());
401 description1.addElement(distribution2);
402 Taxon taxon = Taxon.NewInstance(null, null);
403 taxon.setTitleCache("Dummy taxon", true);
404 taxon.addDescription(description1);
405 taxon.setUuid(UUID.fromString("7598f5d4-1cf2-4269-ae99-2adb79ae167c"));
406
407 taxonService.save(taxon);
408
409 setComplete();
410 endTransaction();
411
412 writeDbUnitDataSetFile(new String[] {
413 "TAXONBASE",
414 "DESCRIPTIONBASE", "DESCRIPTIONELEMENTBASE",
415 "HIBERNATE_SEQUENCES" // IMPORTANT!!!
416 },
417 "getDistributionServiceRequestParameterString", true );
418 }
419 }