add support for warehouse schemas

close: #394

Author: Ondřej Benkovský

src/main/java/com/gooddata/warehouse/WarehouseSchema.java

@@ -0,0 +1,69 @@
+/**
+ * Copyright (C) 2004-2016, GoodData(R) Corporation. All rights reserved.
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE.txt file in the root directory of this source tree.
+ */
+package com.gooddata.warehouse;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.annotation.JsonTypeInfo;
+import com.fasterxml.jackson.annotation.JsonTypeName;
+import org.springframework.web.util.UriTemplate;
+
+import java.util.Map;
+
+/**
+ * Warehouse schema.
+ * Deserialization Only.
+ */
+@JsonTypeInfo(include = JsonTypeInfo.As.WRAPPER_OBJECT, use = JsonTypeInfo.Id.NAME)
+@JsonTypeName("schema")
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class WarehouseSchema {
+
+    private static final String SELF_LINK = "self";
+    private static final String INSTANCE_LINK = "instance";
+
+    public static final String URI = WarehouseSchemas.URI + "/{name}";
+    public static final UriTemplate TEMPLATE = new UriTemplate(URI);
+
+    private final String name;
+
+    private final String description;
+
+    private final Map<String, String> links;
+
+    @JsonCreator
+    private WarehouseSchema(@JsonProperty("name") final String name,
+                            @JsonProperty("description") final String description,
+                            @JsonProperty("links") final Map<String, String> links) {
+        this.name = name;
+        this.description = description;
+        this.links = links;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public String getDescription() {
+        return description;
+    }
+
+    public Map<String, String> getLinks() {
+        return links;
+    }
+
+    @JsonIgnore
+    public String getUri() {
+        return links != null ? links.get(SELF_LINK): null;
+    }
+
+    @JsonIgnore
+    public String getInstanceUri() {
+        return links != null ? links.get(INSTANCE_LINK): null;
+    }
+}

src/main/java/com/gooddata/warehouse/WarehouseSchemaNotFoundException.java

@@ -0,0 +1,26 @@
+/**
+ * Copyright (C) 2004-2016, GoodData(R) Corporation. All rights reserved.
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE.txt file in the root directory of this source tree.
+ */
+package com.gooddata.warehouse;
+
+import com.gooddata.GoodDataException;
+import com.gooddata.GoodDataRestException;
+
+/**
+ * Warehouse schema doesn't exist.
+ */
+public class WarehouseSchemaNotFoundException extends GoodDataException {
+
+    private final String warehouseSchemaUri;
+
+    public WarehouseSchemaNotFoundException(String uri, GoodDataRestException cause) {
+        super("Warehouse schema " + uri + " was not found", cause);
+        this.warehouseSchemaUri = uri;
+    }
+
+    public String getWarehouseSchemaUri() {
+        return warehouseSchemaUri;
+    }
+}

src/main/java/com/gooddata/warehouse/WarehouseSchemas.java

@@ -0,0 +1,42 @@
+/**
+ * Copyright (C) 2004-2016, GoodData(R) Corporation. All rights reserved.
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE.txt file in the root directory of this source tree.
+ */
+package com.gooddata.warehouse;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonTypeInfo;
+import com.fasterxml.jackson.annotation.JsonTypeName;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import com.gooddata.collections.PageableList;
+import com.gooddata.collections.Paging;
+import org.springframework.web.util.UriTemplate;
+
+import java.util.List;
+import java.util.Map;
+
+/**
+ * List of warehouse schemas.
+ * Deserialization Only.
+ */
+@JsonDeserialize(using = WarehouseSchemasDeserializer.class)
+@JsonTypeInfo(include = JsonTypeInfo.As.WRAPPER_OBJECT, use = JsonTypeInfo.Id.NAME)
+@JsonTypeName(WarehouseSchemas.ROOT_NODE)
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class WarehouseSchemas extends PageableList<WarehouseSchema> {
+
+    public static final String URI = Warehouse.URI + "/schemas";
+    public static final UriTemplate TEMPLATE = new UriTemplate(URI);
+
+    static final String ROOT_NODE = "schemas";
+
+    public WarehouseSchemas(final List<WarehouseSchema> items, final Paging paging) {
+        super(items, paging);
+    }
+
+    public WarehouseSchemas(final List<WarehouseSchema> items, final Paging paging, final Map<String, String> links) {
+        super(items, paging, links);
+    }
+}

src/main/java/com/gooddata/warehouse/WarehouseSchemasDeserializer.java

@@ -0,0 +1,27 @@
+/**
+ * Copyright (C) 2004-2016, GoodData(R) Corporation. All rights reserved.
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE.txt file in the root directory of this source tree.
+ */
+package com.gooddata.warehouse;
+
+import com.gooddata.collections.PageableListDeserializer;
+import com.gooddata.collections.Paging;
+
+import java.util.List;
+import java.util.Map;
+
+/**
+ * Deserializer of WarehouseSchemas.
+ */
+class WarehouseSchemasDeserializer extends PageableListDeserializer<WarehouseSchemas, WarehouseSchema> {
+
+    protected WarehouseSchemasDeserializer() {
+        super(WarehouseSchema.class);
+    }
+
+    @Override
+    protected WarehouseSchemas createList(final List<WarehouseSchema> items, final Paging paging, final Map<String, String> links) {
+        return new WarehouseSchemas(items, paging, links);
+    }
+}

src/main/java/com/gooddata/warehouse/WarehouseService.java

@@ -31,6 +31,8 @@
  */
 public class WarehouseService extends AbstractService {
 
+    private static final String DEFAULT_SCHEMA_NAME = "default";
+
     /**
      * Sets RESTful HTTP Spring template. Should be called from constructor of concrete service extending
      * this abstract one.
@@ -303,4 +305,67 @@ public Warehouse updateWarehouse(Warehouse toUpdate) {
 
         return getWarehouseByUri(toUpdate.getUri());
     }
+
+    /**
+     * list schemas for Warehouse
+     *
+     * @param warehouse to list schemas for
+     * @return pageable list of warehouse schemas
+     */
+    public PageableList<WarehouseSchema> listWarehouseSchemas(final Warehouse warehouse) {
+        try {
+            final WarehouseSchemas result = restTemplate.getForObject(WarehouseSchemas.TEMPLATE.expand(warehouse.getId()), WarehouseSchemas.class);
+            if (result == null) {
+                return new PageableList<>();
+            }
+            return result;
+        } catch (GoodDataException | RestClientException e) {
+            throw new GoodDataException("Unable to list Warehouse schemas", e);
+        }
+    }
+
+    /**
+     * get warehouse schema by name
+     *
+     * @param warehouse to get schema for
+     * @param name of schema
+     * @return warehouse schema
+     */
+    public WarehouseSchema getWarehouseSchemaByName(final Warehouse warehouse, final String name) {
+        notNull(warehouse, "warehouse");
+        notEmpty(name, "name");
+        final String uri = WarehouseSchema.TEMPLATE.expand(warehouse.getId(), name).toString();
+        return getWarehouseSchemaByUri(uri);
+    }
+
+    /**
+     * get warehouse schema by uri
+     *
+     * @param uri of schema
+     * @return warehouse schema
+     */
+    public WarehouseSchema getWarehouseSchemaByUri(final String uri) {
+        notEmpty(uri, "uri");
+        try {
+            return restTemplate.getForObject(uri, WarehouseSchema.class);
+        } catch (GoodDataRestException e) {
+            if (HttpStatus.NOT_FOUND.value() == e.getStatusCode()) {
+                throw new WarehouseSchemaNotFoundException(uri.toString(), e);
+            } else {
+                throw e;
+            }
+        } catch (RestClientException e) {
+            throw new GoodDataException("Unable to get Warehouse instance " + uri, e);
+        }
+    }
+
+    /**
+     * get default warehouse schema
+     *
+     * @param warehouse to get default schema for
+     * @return default warehouse schema
+     */
+    public WarehouseSchema getDefaultWarehouseSchema(final Warehouse warehouse) {
+        return getWarehouseSchemaByName(warehouse, DEFAULT_SCHEMA_NAME);
+    }
 }

src/test/java/com/gooddata/warehouse/WarehouseSchemaTest.java

@@ -0,0 +1,41 @@
+/**
+ * Copyright (C) 2004-2016, GoodData(R) Corporation. All rights reserved.
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE.txt file in the root directory of this source tree.
+ */
+package com.gooddata.warehouse;
+
+import static org.hamcrest.CoreMatchers.equalTo;
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.core.Is.is;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.testng.annotations.Test;
+
+import java.io.InputStream;
+import java.util.LinkedHashMap;
+import java.util.Map;
+
+public class WarehouseSchemaTest {
+
+    private static final String NAME = "default";
+    private static final String DESCRIPTION = "Default schema for new ADS instance";
+    private static final String SELF_LINK = "/gdc/datawarehouse/instances/instanceId/schemas/default";
+    private static final String INSTANCE = "/gdc/datawarehouse/instances/instanceId";
+    private static final String PARENT = "/gdc/datawarehouse/instances/warehouseId/schemas";
+    private static final Map<String, String> LINKS = new LinkedHashMap<String, String>() {{
+        put("self", SELF_LINK);
+        put("instance", INSTANCE);
+        put("parent", PARENT);
+    }};
+
+    @Test
+    public void testDeserialization() throws Exception {
+        final InputStream stream = getClass().getResourceAsStream("/warehouse/schema.json");
+        final WarehouseSchema warehouseSchema = new ObjectMapper().readValue(stream, WarehouseSchema.class);
+
+        assertThat(warehouseSchema.getName(), is(NAME));
+        assertThat(warehouseSchema.getDescription(), is(DESCRIPTION));
+        assertThat(warehouseSchema.getLinks(), is(equalTo(LINKS)));
+    }
+}

src/test/java/com/gooddata/warehouse/WarehouseSchemasTest.java

@@ -0,0 +1,25 @@
+/**
+ * Copyright (C) 2004-2016, GoodData(R) Corporation. All rights reserved.
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE.txt file in the root directory of this source tree.
+ */
+package com.gooddata.warehouse;
+
+import static com.gooddata.util.ResourceUtils.readObjectFromResource;
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.notNullValue;
+import static org.hamcrest.collection.IsCollectionWithSize.hasSize;
+import static org.hamcrest.core.Is.is;
+
+import org.testng.annotations.Test;
+
+public class WarehouseSchemasTest {
+    private final WarehouseSchemas warehouseSchemas = readObjectFromResource("/warehouse/schemas.json", WarehouseSchemas.class);
+
+    @Test
+    public void testDeserialization() throws Exception {
+        assertThat(warehouseSchemas, notNullValue());
+        assertThat(warehouseSchemas, hasSize(1));
+        assertThat(warehouseSchemas.get(0).getName(), is("default"));
+    }
+}

src/test/java/com/gooddata/warehouse/WarehouseServiceAT.java

@@ -21,6 +21,9 @@
 
 import static com.gooddata.warehouse.WarehouseIdMatcher.hasSameIdAs;
 import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.contains;
+import static org.hamcrest.Matchers.equalTo;
+import static org.hamcrest.Matchers.hasProperty;
 import static org.hamcrest.Matchers.hasSize;
 import static org.hamcrest.Matchers.is;
 import static org.hamcrest.Matchers.notNullValue;
@@ -34,6 +37,7 @@
 public class WarehouseServiceAT extends AbstractGoodDataAT {
 
     private static final String LOGIN = "john.smith." + UUID.randomUUID() + "@gooddata.com";
+    private static final String SCHEMA_NAME = "default";
 
     private final String warehouseToken;
     private final WarehouseService service;
@@ -118,6 +122,24 @@ public void shouldRemoveUserFromWarehouse() {
         warehouseUser = null;
     }
 
+    @Test(groups = "warehouse", dependsOnMethods = "createWarehouse")
+    public void listWarehouseSchemas() {
+        PageableList<WarehouseSchema> warehouseSchemas = service.listWarehouseSchemas(warehouse);
+        assertThat(warehouseSchemas, contains(hasProperty("name", equalTo(SCHEMA_NAME))));
+    }
+
+    @Test(groups = "warehouse", dependsOnMethods = "createWarehouse")
+    public void getWarehouseSchema() {
+        WarehouseSchema warehouseSchema = service.getWarehouseSchemaByName(warehouse, SCHEMA_NAME);
+        assertThat(warehouseSchema, is(notNullValue()));
+    }
+
+    @Test(groups = "warehouse", dependsOnMethods = "createWarehouse")
+    public void getDefaultWarehouseSchema() {
+        WarehouseSchema warehouseSchema = service.getDefaultWarehouseSchema(warehouse);
+        assertThat(warehouseSchema, is(notNullValue()));
+    }
+
     @Test(dependsOnGroups = "warehouse")
     public void removeWarehouse() throws Exception {
         service.removeWarehouse(warehouse);