API.java

/*
 * Fusion Studio API - API for Fusion Studio
 * Copyright © 2017 Evolved Binary (tech@evolvedbinary.com)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package com.fusiondb.studio.api;

import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.function.Function;

import com.evolvedbinary.j8fu.tuple.Tuple2;

import static com.evolvedbinary.j8fu.tuple.Tuple.Tuple;
import static io.restassured.RestAssured.given;
import static org.apache.http.HttpStatus.SC_OK;

public class API {

    /**
     * Default Host for FusionDB Server
     */
    public static String DEFAULT_HOST = "localhost";

    /**
     * Default Port for FusionDB Server
     */
    public static int DEFAULT_PORT = 4059;

    /**
     * Default admin username
     */
    public static String DEFAULT_ADMIN_USERNAME = "admin";

    /**
     * Default admin password
     */
    public static String DEFAULT_ADMIN_PASSWORD = "";

    /**
     * Default API Endpoint for Fusion Studio API
     */
    public static String DEFAULT_ENDPOINT = "fusiondb";

    /**
     * System Property for setting the API Host
     */
    public static String SYS_PROP_NAME_API_HOST = "api.host";

    /**
     * Environment variable name for setting the API Host
     */
    public static String ENV_VAR_API_HOST = "API_HOST";

    /**
     * System Property for setting the API Port
     */
    public static String SYS_PROP_NAME_API_PORT = "api.port";

    /**
     * Environment variable name for setting the API Port
     */
    public static String ENV_VAR_API_PORT = "API_PORT";

    /**
     * System Property for setting the Docker DB Image
     */
    public static String SYS_PROP_NAME_DOCKER_DB_IMAGE = "docker.db.image";

    /**
     * Environment Variable for setting the Docker DB Image
     */
    private static String ENV_VAR_DOCKER_DB_IMAGE = "DOCKER_DB_IMAGE";

    /**
     * Get the Base URI for the Fusion Studio API.
     *
     * The URI can be overridden by System Properties firstly,
     * or Environment Variables secondly.
     * See {@link #SYS_PROP_NAME_API_HOST} {@link #SYS_PROP_NAME_API_PORT}
     * {@link #ENV_VAR_API_HOST} and {@link #ENV_VAR_API_PORT}.
     *
     * @return the base URI
     */
    public static String getApiBaseUri() {
        final String host = sysPropOrEnvVarOrDefault(SYS_PROP_NAME_API_HOST, ENV_VAR_API_HOST, DEFAULT_HOST, envVarValue -> envVarValue);
        final int port = sysPropOrEnvVarOrDefault(SYS_PROP_NAME_API_PORT, ENV_VAR_API_PORT, DEFAULT_PORT, envVarValue -> {
            try {
                return Integer.parseInt(envVarValue);
            } catch (final NumberFormatException e) {
                // invalid number
                System.err.println("Port " + envVarValue + " is not a valid TCP port number. Using default: " + DEFAULT_PORT);
                e.printStackTrace();
                return DEFAULT_PORT;
            }
        });

        return "http://" + host + ":" + port + "/exist/restxq/" + DEFAULT_ENDPOINT;
    }

    /**
     * Get the Base URI for the eXist-db REST API.
     *
     * The URI can be overridden by System Properties firstly,
     * or Environment Variables secondly.
     * See {@link #SYS_PROP_NAME_API_HOST} {@link #SYS_PROP_NAME_API_PORT}
     * {@link #ENV_VAR_API_HOST} and {@link #ENV_VAR_API_PORT}.
     *
     * @return the REST base URI
     */
    public static String getRestApiBaseUri() {
        final String host = sysPropOrEnvVarOrDefault(SYS_PROP_NAME_API_HOST, ENV_VAR_API_HOST, DEFAULT_HOST, envVarValue -> envVarValue);
        final int port = sysPropOrEnvVarOrDefault(SYS_PROP_NAME_API_PORT, ENV_VAR_API_PORT, DEFAULT_PORT, envVarValue -> {
            try {
                return Integer.parseInt(envVarValue);
            } catch (final NumberFormatException e) {
                // invalid number
                System.err.println("Port " + envVarValue + " is not a valid TCP port number. Using default: " + DEFAULT_PORT);
                e.printStackTrace();
                return DEFAULT_PORT;
            }
        });

        return "http://" + host + ":" + port + "/exist/rest";
    }

    /**
     * Gets a value from an Environment variable or uses the default
     * if there is no such variable.
     *
     * @param envVarName the name of the environment variable.
     * @param defaultValue the default value to use if there is no environment variable
     * @param typeConverter a function for converting the value of the environment
     *     variable (if present) to the desired type
     *
     * @return the value from the environment variable, or the default value
     */
    private static <T> T envVarOrDefault(final String envVarName, final T defaultValue, final Function<String, T> typeConverter) {
        final String envVarValue = System.getenv(envVarName);
        if (envVarValue != null && !envVarValue.isEmpty()) {
            return typeConverter.apply(envVarValue);
        } else {
            return defaultValue;
        }
    }

    /**
     * Gets a value from a System Property or uses the default
     * if there is no such variable.
     *
     * @param sysPropName the name of the system property.
     * @param defaultValue the default value to use if there is no system property
     * @param typeConverter a function for converting the value of the system
     *     property (if present) to the desired type
     *
     * @return the value from the system property, or the default value
     */
    private static <T> T sysPropOrDefault(final String sysPropName, final T defaultValue, final Function<String, T> typeConverter) {
        final String sysPropValue = System.getProperty(sysPropName);
        if (sysPropValue != null && !sysPropValue.isEmpty()) {
            return typeConverter.apply(sysPropValue);
        } else {
            return defaultValue;
        }
    }

    /**
     * Gets a value from a System Property, or an Environment Variable if there
     * is not such system property. If there is no environment variable, then
     * the default value is returned.
     *
     * @param sysPropName the name of the system property.
     * @param envVarName the name of the environment variable if there is no system property.
     * @param defaultValue the default value to use if there is no system property or environment variable.
     * @param typeConverter a function for converting the value of the system
     *     property or environment variable (if present) to the desired type
     *
     * @return the value from the system property, environment variable, or the default value
     */
    private static <T> T sysPropOrEnvVarOrDefault(final String sysPropName, final String envVarName,
            final T defaultValue, final Function<String, T> typeConverter) {
        final T sysPropValue = sysPropOrDefault(sysPropName, null, typeConverter);
        if (sysPropValue != null) {
            return sysPropValue;
        }
        return envVarOrDefault(envVarName, defaultValue, typeConverter);
    }

    static <K, V> Map<K, V> mapOf(final Tuple2<K, V>... entries) {
        if (entries == null) {
            return Collections.emptyMap();
        }

        final Map<K, V> map = new HashMap<>(entries.length);
        for (final Tuple2<K, V> entry : entries) {
            map.put(entry._1, entry._2);
        }
        return map;
    }


    static <K, V>  Map<K, V>[] arrayOf(final Map<K, V>... entries) {
        if (entries == null) {
            return new Map[0];
        }

        final Map<K, V>[] arrayOfMaps = new Map[entries.length];
        for (int i = 0; i < entries.length; i++) {
            arrayOfMaps[i] = entries[i];
        }
        return arrayOfMaps;
    }

    static Tuple2<String, String> getServerVersion() {
        final String productName =
            given().
                    accept("text/text").
            when().
                        get(getRestApiBaseUri() + "/db?_query=system:get-product-name()&_wrap=no").
            then().
                    statusCode(SC_OK).
            extract().body().asString();

        final String version =
                given().
                        accept("text/text").
                when().
                        get(getRestApiBaseUri() + "/db?_query=system:get-version()&_wrap=no").
                then().
                        statusCode(SC_OK).
                extract().body().asString();

        return Tuple(productName, version);
    }

    static boolean testServerHasBadJsonSerialization() {
        final Tuple2<String, String> serverVersion = getServerVersion();
        return serverVersion.equals(Tuple("FusionDB", "1.0.0-ALPHA2"))
                || serverVersion.equals(Tuple("eXist-db", "5.0.0"))
                || serverVersion.equals(Tuple("eXist-db", "5.2.0"));
    }

    static boolean testServerHasBadXmldbSetMimeType() {
        final Tuple2<String, String> serverVersion = getServerVersion();
        return serverVersion.equals(Tuple("FusionDB", "1.0.0-ALPHA2"));
    }

    static boolean testServerHasBadCopyMoveCollectionOperations() {
        final Tuple2<String, String> serverVersion = getServerVersion();
        return serverVersion.equals(Tuple("FusionDB", "1.0.0-ALPHA3"));
    }
}