Merge pull request #1050 from gooddata/tz

Add workspace timezone setting

Reviewed-by: Peter Plocháň
             https://github.com/peter-plochan

Author: gdgate

gooddata-java-model/src/main/java/com/gooddata/sdk/model/md/Service.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright (C) 2004-2021, 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.sdk.model.md;
+
+import com.fasterxml.jackson.annotation.*;
+import com.gooddata.sdk.common.util.GoodDataToStringBuilder;
+
+import java.io.Serializable;
+
+/**
+ * Represents project/workspace metadata configuration.
+ */
+@JsonTypeName("service")
+@JsonTypeInfo(include = JsonTypeInfo.As.WRAPPER_OBJECT, use = JsonTypeInfo.Id.NAME)
+@JsonIgnoreProperties(ignoreUnknown = true)
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public class Service implements Serializable {
+
+    public static final String TIMEZONE_URI = "/gdc/md/{projectId}/service/timezone";
+
+    private static final long serialVersionUID = -3382672258337809805L;
+
+    private final String timezone;
+
+    @JsonCreator
+    public Service(@JsonProperty("timezone") String timezone) {
+        this.timezone = timezone;
+    }
+
+    /**
+     * @return string identifier of the timezone (see IANA/Olson tz database for possible values)
+     */
+    public String getTimezone() {
+        return timezone;
+    }
+
+    @Override
+    public String toString() {
+        return GoodDataToStringBuilder.defaultToString(this);
+    }
+}

gooddata-java-model/src/test/java/com/gooddata/sdk/model/md/ServiceTest.java

@@ -0,0 +1,32 @@
+/*
+ * Copyright (C) 2004-2021, 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.sdk.model.md;
+
+import org.testng.annotations.Test;
+
+import static com.gooddata.sdk.common.util.ResourceUtils.readObjectFromResource;
+import static org.hamcrest.CoreMatchers.is;
+import static org.hamcrest.CoreMatchers.notNullValue;
+import static org.hamcrest.MatcherAssert.assertThat;
+
+public class ServiceTest {
+
+    @Test
+    public void shouldDeserialize() throws Exception {
+        final Service service = readObjectFromResource("/md/service-timezone.json", Service.class);
+
+        assertThat(service, is(notNullValue()));
+        assertThat(service.getTimezone(), is("UTC"));
+    }
+
+    @Test
+    public void testToStringFormat() throws Exception {
+        final Service service = readObjectFromResource("/md/service-timezone.json", Service.class);
+
+        assertThat(service.toString(), is("Service[timezone=UTC]"));
+    }
+
+}

gooddata-java-model/src/test/resources/md/service-timezone.json

@@ -0,0 +1,5 @@
+{
+    "service": {
+        "timezone": "UTC"
+    }
+}

gooddata-java/src/main/java/com/gooddata/sdk/service/md/MetadataService.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2004-2019, GoodData(R) Corporation. All rights reserved.
+ * Copyright (C) 2004-2021, 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.
  */
@@ -21,9 +21,8 @@
 import java.util.*;
 import java.util.stream.Collectors;
 
-import static com.gooddata.sdk.common.util.Validate.noNullElements;
-import static com.gooddata.sdk.common.util.Validate.notNull;
-import static com.gooddata.sdk.common.util.Validate.notNullState;
+import static com.gooddata.sdk.common.util.Validate.*;
+import static com.gooddata.sdk.model.md.Service.TIMEZONE_URI;
 import static java.util.Arrays.asList;
 
 /**
@@ -440,6 +439,56 @@ public List<AttributeElement> getAttributeElements(DisplayForm displayForm) {
         }
     }
 
+    /**
+     * Get project/workspace timezone.
+     *
+     * @param project project from what to return the timezone
+     * @return string identifier of the timezone (see IANA/Olson tz database for possible values)
+     * @throws com.gooddata.sdk.common.GoodDataRestException if GoodData REST API returns unexpected status code
+     * @throws com.gooddata.sdk.common.GoodDataException     if no response from API or client-side HTTP error
+     */
+    public String getTimezone(final Project project) {
+        notNull(project, "project");
+        notNull(project.getId(), "project.id");
+
+        try {
+            final Service result = restTemplate.getForObject(TIMEZONE_URI, Service.class, project.getId());
+
+            if (result != null) {
+                return result.getTimezone();
+            } else {
+                throw new GoodDataException("Received empty response from API call.");
+            }
+        } catch (RestClientException e) {
+            throw new GoodDataException("Unable to get timezone of project/workspace " + project.getId(), e);
+        }
+    }
+
+    /**
+     * Set project/workspace timezone.
+     *
+     * @param project the project/workspace where to set the timezone
+     * @param timezone the timezone to be set (see IANA/Olson tz database for possible values)
+     */
+    public void setTimezone(final Project project, final String timezone) {
+        notNull(project, "project");
+        notNull(project.getId(), "project.id");
+        notNull(timezone, "timezone");
+        notEmpty(timezone, "timezone");
+
+        try {
+            final Service result = restTemplate.postForObject(TIMEZONE_URI, new Service(timezone), Service.class,
+                    project.getId());
+
+            if (result == null) {
+                throw new GoodDataException("Unexpected empty result from API call.");
+            }
+        } catch (RestClientException e) {
+            throw new GoodDataException("Unable to set timezone of project/workspace " + project.getId(), e);
+        }
+    }
+
+
     private Collection<Entry> filterEntries(Collection<Entry> entries, Restriction... restrictions) {
         if (restrictions == null || restrictions.length == 0) {
             return entries;

gooddata-java/src/test/java/com/gooddata/sdk/service/md/MetadataServiceAT.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2004-2019, GoodData(R) Corporation. All rights reserved.
+ * Copyright (C) 2004-2021, 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.
  */
@@ -38,6 +38,7 @@
 import static com.gooddata.sdk.model.md.Restriction.identifier;
 import static com.gooddata.sdk.model.md.report.MetricGroup.METRIC_GROUP;
 import static java.util.Arrays.asList;
+import static java.util.Collections.singletonList;
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.empty;
 import static org.hamcrest.Matchers.hasItems;
@@ -52,15 +53,15 @@
 public class MetadataServiceAT extends AbstractGoodDataAT {
 
     @Test(groups = "md", dependsOnGroups = "model")
-    public void getObjs() throws Exception {
+    public void getObjs() {
         final MetadataService md = gd.getMetadataService();
 
         fact = md.getObjUri(project, Fact.class, identifier("fact.person.shoesize"));
         attr = md.getObj(project, Attribute.class, identifier("attr.person.department"));
     }
 
     @Test(groups = "md", dependsOnMethods = "getObjs")
-    public void updateObj() throws Exception {
+    public void updateObj() {
         final MetadataService md = gd.getMetadataService();
 
         attr.setSummary("Changed person department");
@@ -70,7 +71,7 @@ public void updateObj() throws Exception {
     }
 
     @Test(groups = "md", dependsOnMethods = "getObjs")
-    public void createMetric() throws Exception {
+    public void createMetric() {
         final MetadataService md = gd.getMetadataService();
         final Metric create = new Metric("Avg shoe size", "SELECT AVG([" + fact + "])", "#,##0");
         create.setIdentifier("metric.avgshoesize");
@@ -79,12 +80,12 @@ public void createMetric() throws Exception {
     }
 
     @Test(groups = "md", dependsOnMethods = "createMetric")
-    public void createReport() throws Exception {
+    public void createReport() {
         final MetadataService md = gd.getMetadataService();
 
         reportDefinition = md.createObj(project, GridReportDefinitionContent.create(
                 "Department avg shoe size",
-                asList(METRIC_GROUP),
+                singletonList(METRIC_GROUP),
                 asList(new AttributeInGrid(attr.getDefaultDisplayForm())),
                 asList(new MetricElement(metric, "Avg shoe size")),
                 asList(new Filter("(SELECT [" + metric.getUri() + "]) >= 0"))
@@ -93,7 +94,7 @@ public void createReport() throws Exception {
     }
 
     @Test(groups = "md", dependsOnGroups = "model")
-    public void createDashboardEmpty() throws Exception {
+    public void createDashboardEmpty() {
         dashboard = gd.getMetadataService().createObj(project, new ProjectDashboard("My Dashboard", new Tab("My Tab")));
 
         assertThat(dashboard.getTitle(), is("My Dashboard"));
@@ -139,7 +140,7 @@ public void usedByBatch() {
     }
 
     @Test(groups = "md", dependsOnGroups = "model")
-    public void getObjsByUris() throws Exception {
+    public void getObjsByUris() {
         final MetadataService md = gd.getMetadataService();
 
         final Map<String, String> uris =
@@ -154,7 +155,7 @@ public void getObjsByUris() throws Exception {
     }
 
     @Test(groups = "md", dependsOnMethods = "createReport")
-    public void createScheduledMail() throws Exception {
+    public void createScheduledMail() {
         final MetadataService md = gd.getMetadataService();
 
         scheduledMail = md.createObj(project,
@@ -172,7 +173,7 @@ public void createScheduledMail() throws Exception {
     }
 
     @Test(groups = "md", dependsOnMethods = "createScheduledMail")
-    public void retrieveScheduledMail() throws Exception {
+    public void retrieveScheduledMail() {
         final MetadataService md = gd.getMetadataService();
         Collection<Entry> result = md.find(project, ScheduledMail.class);
         assertThat(result, hasSize(1));
@@ -183,7 +184,7 @@ public void retrieveScheduledMail() throws Exception {
     }
 
     @Test(groups = "md", dependsOnMethods = "retrieveScheduledMail")
-    public void removeScheduledMail() throws Exception {
+    public void removeScheduledMail() {
         final MetadataService metadataService = gd.getMetadataService();
         metadataService.removeObj(scheduledMail);
     }
@@ -192,30 +193,49 @@ public void removeScheduledMail() throws Exception {
     public void identifiersToUri() {
         final MetadataService metadataService = gd.getMetadataService();
         final Map<String, String> idsToUris =
-                metadataService.identifiersToUris(project, asList("attr.person.department"));
+                metadataService.identifiersToUris(project, singletonList("attr.person.department"));
         assertThat(idsToUris.entrySet(), hasSize(1));
         final Attribute attribute = metadataService.getObjByUri(idsToUris.get("attr.person.department"), Attribute.class);
         assertThat(attribute.getIdentifier(), is("attr.person.department"));
     }
 
     @Test(dependsOnGroups = "export", dependsOnMethods = {"usedBy", "usedByBatch"})
-    public void removeReport() throws Exception {
+    public void removeReport() {
         final MetadataService metadataService = gd.getMetadataService();
         metadataService.removeObj(report);
     }
 
     @Test(dependsOnMethods = {"removeReport", "removeScheduledMail"})
-    public void removeDefinition() throws Exception {
+    public void removeDefinition() {
         final MetadataService metadataService = gd.getMetadataService();
         metadataService.removeObj(reportDefinition);
     }
 
     @Test(groups = "mdAfterLoad", dependsOnGroups = {"model", "dataset"}, dependsOnMethods = "getObjs")
-    public void getAttributeElements() throws Exception {
+    public void getAttributeElements() {
         final List<AttributeElement> elements = gd.getMetadataService().getAttributeElements(attr);
         assertThat("there should be 2 elements", elements, hasSize(2));
         final Set<String> titles = new HashSet<>(elements.size());
         titles.addAll(elements.stream().map(AttributeElement::getTitle).collect(Collectors.toList()));
         assertThat(titles, hasItems("DevOps", "HR"));
     }
+
+    @Test(groups = "md", dependsOnGroups = "project")
+    public void getTimezone() {
+        final MetadataService md = gd.getMetadataService();
+
+        final String tz = md.getTimezone(project);
+        assertThat(tz, is("America/Los_Angeles"));
+    }
+
+    @Test(groups = "md", dependsOnMethods = "getTimezone")
+    public void setTimezone() {
+        final MetadataService md = gd.getMetadataService();
+
+        md.setTimezone(project, "UTC");
+
+        final String tz = md.getTimezone(project);
+        assertThat(tz, is("UTC"));
+    }
+
 }