gernotbelger@9031: package test;
gernotbelger@9031: 
gernotbelger@9031: /** Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
gernotbelger@9031:  * Software engineering by
gernotbelger@9031:  *  Björnsen Beratende Ingenieure GmbH
gernotbelger@9031:  *  Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
gernotbelger@9031:  *
gernotbelger@9031:  * This file is Free Software under the GNU AGPL (>=v3)
gernotbelger@9031:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
gernotbelger@9031:  * documentation coming with Dive4Elements River for details.
gernotbelger@9031:  */
gernotbelger@9031: 
gernotbelger@9031: import java.io.File;
gernotbelger@9031: import java.io.FileNotFoundException;
gernotbelger@9031: import java.io.FileOutputStream;
gernotbelger@9031: import java.io.IOException;
gernotbelger@9031: import java.io.InputStream;
gernotbelger@9031: import java.io.InputStreamReader;
gernotbelger@9031: import java.net.URL;
gernotbelger@9031: import java.util.ArrayList;
gernotbelger@9031: import java.util.HashMap;
gernotbelger@9031: import java.util.List;
gernotbelger@9031: 
gernotbelger@9031: import org.apache.commons.io.FileUtils;
gernotbelger@9031: import org.apache.commons.io.IOUtils;
gernotbelger@9031: import org.dive4elements.artifacts.common.ArtifactNamespaceContext;
gernotbelger@9031: import org.dive4elements.artifacts.common.utils.ClientProtocolUtils;
gernotbelger@9031: import org.dive4elements.artifacts.httpclient.exceptions.ConnectionException;
gernotbelger@9031: import org.dive4elements.artifacts.httpclient.http.HttpClient;
gernotbelger@9031: import org.dive4elements.artifacts.httpclient.http.HttpClientImpl;
gernotbelger@9031: import org.dive4elements.artifacts.httpclient.http.response.DocumentResponseHandler;
gernotbelger@9031: import org.dive4elements.artifacts.httpclient.utils.XMLUtils;
gernotbelger@9031: import org.dive4elements.river.client.client.ui.NilDatacageTwinPanelInfo;
gernotbelger@9031: import org.dive4elements.river.client.client.ui.RecommandationUtils;
gernotbelger@9031: import org.dive4elements.river.client.server.AdvanceServiceImpl;
gernotbelger@9031: import org.dive4elements.river.client.server.ArtifactHelper;
gernotbelger@9031: import org.dive4elements.river.client.server.CollectionHelper;
gernotbelger@9031: import org.dive4elements.river.client.server.CreateCollectionServiceImpl;
gernotbelger@9031: import org.dive4elements.river.client.server.FLYSArtifactCreator;
gernotbelger@9031: import org.dive4elements.river.client.server.FeedServiceImpl;
gernotbelger@9031: import org.dive4elements.river.client.server.LoadArtifactServiceImpl;
gernotbelger@9031: import org.dive4elements.river.client.server.auth.DefaultUser;
gernotbelger@9031: import org.dive4elements.river.client.server.auth.User;
gernotbelger@9031: import org.dive4elements.river.client.server.auth.UserClient;
gernotbelger@9031: import org.dive4elements.river.client.shared.exceptions.ServerException;
gernotbelger@9031: import org.dive4elements.river.client.shared.model.Artifact;
gernotbelger@9031: import org.dive4elements.river.client.shared.model.Collection;
gernotbelger@9031: import org.dive4elements.river.client.shared.model.Data;
gernotbelger@9031: import org.dive4elements.river.client.shared.model.DataItem;
gernotbelger@9031: import org.dive4elements.river.client.shared.model.DefaultCollection;
gernotbelger@9031: import org.dive4elements.river.client.shared.model.DefaultDataItem;
gernotbelger@9031: import org.dive4elements.river.client.shared.model.Recommendation;
gernotbelger@9031: import org.dive4elements.river.client.shared.model.StringOptionsData;
gernotbelger@9031: import org.junit.Assert;
gernotbelger@9031: import org.w3c.dom.Document;
gernotbelger@9031: import org.w3c.dom.Element;
gernotbelger@9031: 
gernotbelger@9031: /**
gernotbelger@9031:  * @author Domenico Nardi Tironi
gernotbelger@9031:  *
gernotbelger@9031:  */
gernotbelger@9031: public abstract class SuperTest {
gernotbelger@9031: 
gernotbelger@9031:     private final String serverUrl = "http://localhost:8181";
gernotbelger@9031:     private final String locale = "de";
gernotbelger@9031:     private final HttpClient client;
gernotbelger@9031: 
gernotbelger@9031:     private static final String exportFileDir = "D:" + File.separator;
gernotbelger@9031:     private static final String erstellDatumSearchString = "# Datum der Erstellung";
gernotbelger@9031: 
gernotbelger@9031:     private final String username;
gernotbelger@9031:     private final String password;
gernotbelger@9031:     private final String infotype;
gernotbelger@9031:     private final String userUuid;
gernotbelger@9031:     private Collection collection;
gernotbelger@9031:     private Artifact artifact;
gernotbelger@9031: 
gernotbelger@9031:     private final List<String> pairIds = new ArrayList<String>();
gernotbelger@9031: 
gernotbelger@9031:     public SuperTest(final String username, final String password, final String infotype) throws ConnectionException, ServerException {
gernotbelger@9031:         this.username = username;
gernotbelger@9031:         this.password = password;
gernotbelger@9031:         this.infotype = infotype;
gernotbelger@9031: 
gernotbelger@9031:         // init
gernotbelger@9031:         this.client = new HttpClientImpl(this.serverUrl, this.locale);
gernotbelger@9031:         this.userUuid = makeUserUuid();
gernotbelger@9031:         this.collection = getCollection();
gernotbelger@9031:         this.artifact = getArtifact();
gernotbelger@9031:     }
gernotbelger@9031: 
gernotbelger@9031:     private String makeUserUuid() throws ConnectionException {
gernotbelger@9031:         final User user = new DefaultUser(this.username, this.password, null, false, new ArrayList<String>(), new ArrayList<String>());
gernotbelger@9031:         final UserClient userClient = new UserClient(this.serverUrl);
gernotbelger@9031:         Element userElement;
gernotbelger@9031: 
gernotbelger@9031:         userElement = userClient.findUser(user);
gernotbelger@9031:         return userElement.getAttributeNS(ArtifactNamespaceContext.NAMESPACE_URI, "uuid");
gernotbelger@9031: 
gernotbelger@9031:     }
gernotbelger@9031: 
gernotbelger@9031:     protected final Artifact getArtifact() throws ServerException, ConnectionException {
gernotbelger@9031:         if (this.artifact == null) {
gernotbelger@9031:             this.artifact = ArtifactHelper.createArtifact(this.serverUrl, this.locale, this.infotype, null);
gernotbelger@9031:             setCollection(CollectionHelper.addArtifact(getCollection(), this.artifact, this.serverUrl, this.locale)); // wichtig; sorgt für Persistenz
gernotbelger@9031:         }
gernotbelger@9031:         return this.artifact;
gernotbelger@9031:     }
gernotbelger@9031: 
gernotbelger@9031:     private Collection getCollection() throws ConnectionException {
gernotbelger@9031: 
gernotbelger@9031:         if (this.collection == null) {
gernotbelger@9031:             // lazy-Loading
gernotbelger@9031:             final Document create = ClientProtocolUtils.newCreateCollectionDocument(null);
gernotbelger@9031:             final Document doc = (Document) this.client.createCollection(create, this.userUuid, new DocumentResponseHandler());
gernotbelger@9031:             final String uuid = XMLUtils.xpathString(doc, CreateCollectionServiceImpl.XPATH_COLLECTION_UUID, ArtifactNamespaceContext.INSTANCE);
gernotbelger@9031:             final String ttlStr = XMLUtils.xpathString(doc, CreateCollectionServiceImpl.XPATH_COLLECTION_TTL, ArtifactNamespaceContext.INSTANCE);
gernotbelger@9031:             this.collection = new DefaultCollection(uuid, Long.valueOf(ttlStr), uuid);
gernotbelger@9031:         }
gernotbelger@9031:         return this.collection;
gernotbelger@9031: 
gernotbelger@9031:     }
gernotbelger@9031: 
gernotbelger@9031:     private void setCollection(final Collection collection) {
gernotbelger@9031:         this.collection = collection;
gernotbelger@9031:     }
gernotbelger@9031: 
gernotbelger@9031:     private void setArtifact(final Artifact artifact) {
gernotbelger@9031:         this.artifact = artifact;
gernotbelger@9031:     }
gernotbelger@9031: 
gernotbelger@9031:     public abstract void runTest(final boolean exportToFile) throws ConnectionException, ServerException, IOException;
gernotbelger@9031: 
gernotbelger@9031:     protected final void describeCollection() throws ConnectionException {
gernotbelger@9031: 
gernotbelger@9031:         final String uuid = getCollection().identifier();
gernotbelger@9031:         final Document describe = ClientProtocolUtils.newDescribeCollectionDocument(uuid);
gernotbelger@9031:         final Document response = (Document) this.client.doCollectionAction(describe, uuid, new DocumentResponseHandler());
gernotbelger@9031:         final Collection c = CollectionHelper.parseCollection(response);
gernotbelger@9031:         setCollection(c);
gernotbelger@9031: 
gernotbelger@9031:     }
gernotbelger@9031: 
gernotbelger@9031:     protected final void feedAndGo(final Data[] data, final int reachableStateIndex) throws ConnectionException, ServerException {
gernotbelger@9031:         feed(data);
gernotbelger@9031:         advance(getReachableStateByIndex(getArtifact(), reachableStateIndex)); // reachablestate könnte auch String sein... TODO: feedAndgo(data,string)
gernotbelger@9031:                                                                                // bauen, falls irgendwann erforderlich
gernotbelger@9031:     }
gernotbelger@9031: 
gernotbelger@9031:     private String getReachableStateByIndex(final Artifact artifact, final int index) {
gernotbelger@9031: 
gernotbelger@9031:         final String[] states = artifact.getArtifactDescription().getReachableStates();
gernotbelger@9031:         if (states != null) {
gernotbelger@9031:             if (states.length > index) {
gernotbelger@9031:                 return states[index];
gernotbelger@9031:             } else {
gernotbelger@9031:                 return states[0];
gernotbelger@9031:             }
gernotbelger@9031:         } else {
gernotbelger@9031:             return "";
gernotbelger@9031:         }
gernotbelger@9031:     }
gernotbelger@9031: 
gernotbelger@9031:     private void feed(final Data[] data) throws ServerException, ConnectionException {
gernotbelger@9031:         final Document feed = ClientProtocolUtils.newFeedDocument(getArtifact().getUuid(), getArtifact().getHash(), createKVP(data));
gernotbelger@9031:         final Document description = (Document) this.client.feed(
gernotbelger@9031:                 new org.dive4elements.artifacts.httpclient.objects.Artifact(getArtifact().getUuid(), getArtifact().getHash()), feed,
gernotbelger@9031:                 new DocumentResponseHandler());
gernotbelger@9031: 
gernotbelger@9031:         final String result = XMLUtils.xpathString(description, FeedServiceImpl.XPATH_RESULT, ArtifactNamespaceContext.INSTANCE);
gernotbelger@9031: 
gernotbelger@9031:         if (result == null || !result.equals(FeedServiceImpl.OPERATION_FAILURE)) {
gernotbelger@9031:             setArtifact((Artifact) new FLYSArtifactCreator().create(description));
gernotbelger@9031:         } else if (result != null && result.equals(FeedServiceImpl.OPERATION_FAILURE)) {
gernotbelger@9031:             final String msg = XMLUtils.xpathString(description, FeedServiceImpl.XPATH_RESULT_MSG, ArtifactNamespaceContext.INSTANCE);
gernotbelger@9031:             throw new ServerException(msg);
gernotbelger@9031:         }
gernotbelger@9031:     }
gernotbelger@9031: 
gernotbelger@9031:     private String[][] createKVP(final Data[] data) {
gernotbelger@9031:         if (data != null) {
gernotbelger@9031:             final String[][] kvp = new String[data.length][];
gernotbelger@9031: 
gernotbelger@9031:             int i = 0;
gernotbelger@9031: 
gernotbelger@9031:             for (final Data d : data) {
gernotbelger@9031:                 // final DataItem[] items = d.getItems();
gernotbelger@9031:                 final String key = d.getLabel();
gernotbelger@9031:                 final String value = d.getStringValue();
gernotbelger@9031: 
gernotbelger@9031:                 kvp[i++] = new String[] { key, value };
gernotbelger@9031:             }
gernotbelger@9031: 
gernotbelger@9031:             return kvp;
gernotbelger@9031:         }
gernotbelger@9031:         return null;
gernotbelger@9031:     }
gernotbelger@9031: 
gernotbelger@9031:     private void advance(final String target) throws ConnectionException, ServerException {
gernotbelger@9031:         final Document advance = ClientProtocolUtils.newAdvanceDocument(getArtifact().getUuid(), getArtifact().getHash(), target);
gernotbelger@9031:         final Document description = (Document) this.client.advance(
gernotbelger@9031:                 new org.dive4elements.artifacts.httpclient.objects.Artifact(getArtifact().getUuid(), getArtifact().getHash()), advance,
gernotbelger@9031:                 new DocumentResponseHandler());
gernotbelger@9031: 
gernotbelger@9031:         if (description == null) {
gernotbelger@9031:             throw new ServerException(AdvanceServiceImpl.ERROR_ADVANCE_ARTIFACT);
gernotbelger@9031:         }
gernotbelger@9031: 
gernotbelger@9031:         final String result = XMLUtils.xpathString(description, AdvanceServiceImpl.XPATH_RESULT, ArtifactNamespaceContext.INSTANCE);
gernotbelger@9031: 
gernotbelger@9031:         if (result == null || !result.equals(AdvanceServiceImpl.OPERATION_FAILURE)) {
gernotbelger@9031:             setArtifact((Artifact) new FLYSArtifactCreator().create(description));
gernotbelger@9031:         }
gernotbelger@9031:     }
gernotbelger@9031: 
gernotbelger@9031:     protected final Artifact[] loadMany(final Recommendation[] recoms, final String factory) throws ServerException, ConnectionException {
gernotbelger@9031:         final ArrayList<Artifact> artifacts = new ArrayList<Artifact>();
gernotbelger@9031:         final HashMap<Recommendation, Artifact> cloneMap = new HashMap<Recommendation, Artifact>();
gernotbelger@9031: 
gernotbelger@9031:         for (final Recommendation recom : recoms) {
gernotbelger@9031: 
gernotbelger@9031:             final Artifact prevClone = cloneMap.get(recom);
gernotbelger@9031:             if (prevClone != null) {
gernotbelger@9031: 
gernotbelger@9031:                 artifacts.add(prevClone);
gernotbelger@9031:             } else {
gernotbelger@9031:                 // Not already cloned.
gernotbelger@9031:                 final String realFactory = factory != null ? factory : recom.getFactory();
gernotbelger@9031: 
gernotbelger@9031:                 final Artifact clone = ArtifactHelper.createArtifact(this.serverUrl, this.locale, realFactory, recom);
gernotbelger@9031: 
gernotbelger@9031:                 if (clone != null) {
gernotbelger@9031:                     final Collection c = CollectionHelper.addArtifact(getCollection(), clone, this.serverUrl, this.locale);
gernotbelger@9031: 
gernotbelger@9031:                     if (c != null) {
gernotbelger@9031:                         artifacts.add(clone);
gernotbelger@9031:                         // Remember we cloned a recommendation like this.
gernotbelger@9031:                         cloneMap.put(recom, clone);
gernotbelger@9031:                     } else {
gernotbelger@9031:                         throw new ServerException(LoadArtifactServiceImpl.ERROR_LOAD_ARTIFACT);
gernotbelger@9031:                     }
gernotbelger@9031:                 }
gernotbelger@9031:             }
gernotbelger@9031:         }
gernotbelger@9031:         return artifacts.toArray(new Artifact[artifacts.size()]);
gernotbelger@9031: 
gernotbelger@9031:     }
gernotbelger@9031: 
gernotbelger@9031:     /// ExportServiceImpl
gernotbelger@9031:     public void doGet(final String mode, final boolean exportToFile) throws IOException {
gernotbelger@9031: 
gernotbelger@9031:         final String name = mode;
gernotbelger@9031:         final String type = "csv";
gernotbelger@9031: 
gernotbelger@9031:         final String fn = name + "." + type; // TODO: make filename unique
gernotbelger@9031:         final String enc = "windows-1252";// req.getParameter("encoding");
gernotbelger@9031: 
gernotbelger@9031:         final URL expectedResource = getClass().getResource("/sinfo/flowdepthminmax/" + fn);
gernotbelger@9031:         final Document attr = null;
gernotbelger@9031:         final Document request = ClientProtocolUtils.newOutCollectionDocument(getCollection().identifier(), mode, type, attr);
gernotbelger@9031: 
gernotbelger@9031:         final InputStream response = this.client.collectionOut(request, getCollection().identifier(), mode);
gernotbelger@9031: 
gernotbelger@9031:         final String actual = deleteErstelldatum(IOUtils.toString(response, "UTF-8"));
gernotbelger@9031: 
gernotbelger@9031:         final String expected = deleteErstelldatum(FileUtils.readFileToString(new File(expectedResource.getFile()), enc));
gernotbelger@9031: 
gernotbelger@9031:         // if (!actual.equals(expected)) {
gernotbelger@9031:         if (exportToFile) {
gernotbelger@9031:             doGetWriteToDisk(mode); // TODO: WENN der Test negativ ausfällt, Datei abspeichern -> Diskussion
gernotbelger@9031:         }
gernotbelger@9031:         Assert.assertEquals(actual, expected);
gernotbelger@9031: 
gernotbelger@9031:     }
gernotbelger@9031: 
gernotbelger@9031:     private String deleteErstelldatum(final String input) {
gernotbelger@9031:         String result = "";
gernotbelger@9031:         final String[] lines = input.split(System.lineSeparator());
gernotbelger@9031:         for (final String line : lines) {
gernotbelger@9031:             if (!line.contains(SuperTest.erstellDatumSearchString)) {
gernotbelger@9031:                 result = result + line + System.lineSeparator();
gernotbelger@9031:             }
gernotbelger@9031:         }
gernotbelger@9031:         return result;
gernotbelger@9031:     }
gernotbelger@9031: 
gernotbelger@9031:     public void doGetWriteToDisk(final String mode) throws FileNotFoundException, IOException {
gernotbelger@9031: 
gernotbelger@9031:         final String name = mode;
gernotbelger@9031:         final String type = "csv";
gernotbelger@9031: 
gernotbelger@9031:         final String fn = name + "." + type; // TODO: make filename unique
gernotbelger@9031:         final String enc = "windows-1252";
gernotbelger@9031: 
gernotbelger@9031:         final String filepath = exportFileDir + fn;
gernotbelger@9031: 
gernotbelger@9031:         final Document attr = null;
gernotbelger@9031:         final Document request = ClientProtocolUtils.newOutCollectionDocument(getCollection().identifier(), mode, type, attr);
gernotbelger@9031: 
gernotbelger@9031:         final InputStream response = this.client.collectionOut(request, getCollection().identifier(), mode);
gernotbelger@9031:         final InputStreamReader in = new InputStreamReader(response, "UTF-8");
gernotbelger@9031: 
gernotbelger@9031:         IOUtils.copy(in, new FileOutputStream(filepath), enc);
gernotbelger@9031: 
gernotbelger@9031:     }
gernotbelger@9031: 
gernotbelger@9031:     public void addRecommendationPair(final String[] rec1, final String[] rec2) throws ConnectionException, ServerException {
gernotbelger@9031:         final Recommendation recom1 = new Recommendation(rec1[0], rec1[1], rec1[2]);
gernotbelger@9031:         final Recommendation recom2 = new Recommendation(rec2[0], rec2[1], rec2[2]);
gernotbelger@9031:         final Artifact[] artifacts = loadMany(new Recommendation[] { recom1, recom2 }, null);
gernotbelger@9031:         final String rec1String = RecommandationUtils.createDataString(artifacts[0].getUuid(), recom1, new NilDatacageTwinPanelInfo("xxxx"));
gernotbelger@9031:         final String rec2String = RecommandationUtils.createDataString(artifacts[1].getUuid(), recom2, new NilDatacageTwinPanelInfo("xxxx"));
gernotbelger@9031:         // TODO: check display name recom1.getDisplayName() TODO: makeDisplayName
gernotbelger@9031:         final String combinedIdNeu = rec1String + "#" + rec2String;
gernotbelger@9031:         this.pairIds.add(combinedIdNeu);
gernotbelger@9031:     }
gernotbelger@9031: 
gernotbelger@9031:     protected Data[] getPairData() {
gernotbelger@9031:         final Data[] data = new Data[this.pairIds.size()];
gernotbelger@9031:         int i = 0;
gernotbelger@9031:         for (final String pairId : this.pairIds) {
gernotbelger@9031:             final Data pair = new StringOptionsData("diffids", "diffids", new DataItem[] { new DefaultDataItem(pairId, pairId, pairId) });
gernotbelger@9031:             data[i] = pair;
gernotbelger@9031:             i++;
gernotbelger@9031:         }
gernotbelger@9031:         return data;
gernotbelger@9031:     }
gernotbelger@9031: }