Merge pull request #966 from gooddata/export

Add export/import of the whole project

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

Author: gdgate

gooddata-java-model/src/main/java/com/gooddata/sdk/model/md/maintenance/ExportProject.java

@@ -0,0 +1,91 @@
+/*
+ * Copyright (C) 2004-2020, 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.maintenance;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonTypeInfo;
+import com.fasterxml.jackson.annotation.JsonTypeName;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import com.gooddata.sdk.common.util.BooleanStringSerializer;
+import com.gooddata.sdk.common.util.GoodDataToStringBuilder;
+
+import java.util.Collection;
+import java.util.HashSet;
+
+import static com.gooddata.sdk.common.util.Validate.notEmpty;
+import static java.util.Arrays.asList;
+
+/**
+ * Complete project export configuration structure.
+ * Serialization only.
+ */
+@JsonTypeName("exportProject")
+@JsonTypeInfo(include = JsonTypeInfo.As.WRAPPER_OBJECT, use = JsonTypeInfo.Id.NAME)
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public class ExportProject {
+
+    public static final String URI = "/gdc/md/{projectId}/maintenance/export";
+
+    private final boolean exportUsers;
+    private final boolean exportData;
+    private final boolean excludeSchedules;
+    private final boolean crossDataCenterExport;
+    private final String authorizedUsers;
+
+    /**
+     * Creates new ExportProject with default settings.
+     * Sets exportUsers=true exportData=true, excludeSchedules=false, crossDataCenterExport=false and empty authorizedUsers.
+     */
+    public ExportProject() {
+        this(true, true, false, false, null);
+    }
+
+    /**
+     * Creates new ExportProject.
+     *
+     * @param exportUsers whether to add necessary data to be able to clone attribute properties
+     * @param exportData whether to add necessary data to be able to clone attribute properties
+     * @param excludeSchedules whether to add necessary data to be able to clone attribute properties
+     * @param crossDataCenterExport whether export should be usable in any Data Center
+     * @param authorizedUsers comma-separated list of email addresses of users authorized to import the project, surround email addresses with double quotes
+     */
+    public ExportProject(final boolean exportUsers, final boolean exportData, final boolean excludeSchedules, final boolean crossDataCenterExport, final String authorizedUsers) {
+        this.exportUsers = exportUsers;
+        this.exportData = exportData;
+        this.excludeSchedules = excludeSchedules;
+        this.crossDataCenterExport = crossDataCenterExport;
+        this.authorizedUsers = authorizedUsers;
+    }
+
+    @JsonSerialize(using = BooleanStringSerializer.class)
+    public boolean isExportUsers() {
+        return exportUsers;
+    }
+
+    @JsonSerialize(using = BooleanStringSerializer.class)
+    public boolean isExportData() {
+        return exportData;
+    }
+
+    @JsonSerialize(using = BooleanStringSerializer.class)
+    public boolean isExcludeSchedules() {
+        return excludeSchedules;
+    }
+
+    @JsonSerialize(using = BooleanStringSerializer.class)
+    public boolean isCrossDataCenterExport() {
+        return crossDataCenterExport;
+    }
+
+    public String getAuthorizedUsers() {
+        return authorizedUsers;
+    }
+
+    @Override
+    public String toString() {
+        return GoodDataToStringBuilder.defaultToString(this);
+    }
+}

gooddata-java-model/src/main/java/com/gooddata/sdk/model/md/maintenance/ExportProjectArtifact.java

@@ -0,0 +1,25 @@
+/*
+ * Copyright (C) 2004-2020, 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.maintenance;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.annotation.JsonTypeName;
+import com.gooddata.sdk.model.gdc.UriResponse;
+
+/**
+ * Complete project export result structure.
+ * For internal use only.
+ * Deserialization only.
+ */
+@JsonTypeName("exportArtifact")
+public class ExportProjectArtifact extends PartialMdArtifact {
+
+    @JsonCreator
+    public ExportProjectArtifact(@JsonProperty("status") UriResponse status, @JsonProperty("token") String token) {
+        super(status, token);
+    }
+}

gooddata-java-model/src/main/java/com/gooddata/sdk/model/md/maintenance/ExportProjectToken.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright (C) 2004-2020, 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.maintenance;
+
+import com.fasterxml.jackson.annotation.JsonTypeInfo;
+import com.fasterxml.jackson.annotation.JsonTypeName;
+import com.gooddata.sdk.common.util.GoodDataToStringBuilder;
+
+import static com.gooddata.sdk.common.util.Validate.notEmpty;
+
+/**
+ * Complete project export token. Serves as configuration structure for import.
+ * Serialization only.
+ */
+@JsonTypeName("importProject")
+@JsonTypeInfo(include = JsonTypeInfo.As.WRAPPER_OBJECT, use = JsonTypeInfo.Id.NAME)
+public class ExportProjectToken {
+
+    public static final String URI = "/gdc/md/{projectId}/maintenance/import";
+
+    private final String token;
+
+    /**
+     * Creates new ExportProjectToken.
+     *
+     * @param token token identifying export of another project
+     */
+    public ExportProjectToken(String token) {
+        this.token = notEmpty(token, "token");
+    }
+
+    public String getToken() {
+        return token;
+    }
+
+    @Override
+    public String toString() {
+        return GoodDataToStringBuilder.defaultToString(this);
+    }
+}

gooddata-java-model/src/test/java/com/gooddata/sdk/model/md/maintenance/ExportProjectArtifactTest.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright (C) 2004-2020, 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.maintenance;
+
+import com.gooddata.sdk.model.gdc.UriResponse;
+import org.testng.annotations.Test;
+
+import static com.gooddata.sdk.common.util.ResourceUtils.readObjectFromResource;
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.is;
+import static org.hamcrest.text.MatchesPattern.matchesPattern;
+
+public class ExportProjectArtifactTest {
+
+    @Test
+    public void shouldDeserialize() throws Exception {
+        final ExportProjectArtifact exportProjectArtifact = readObjectFromResource("/md/maintenance/exportArtifact.json",
+                ExportProjectArtifact.class);
+
+        assertThat(exportProjectArtifact.getStatusUri(), is("/gdc/md/projectId/tasks/taskId/status"));
+        assertThat(exportProjectArtifact.getToken(), is("TOKEN123"));
+    }
+
+    @Test
+    public void testToStringFormat() {
+        final ExportProjectArtifact exportProjectArtifact = new ExportProjectArtifact(
+                new UriResponse("/gdc/md/projectId/tasks/taskId/status"), "TOKEN123");
+
+        assertThat(exportProjectArtifact.toString(), matchesPattern(ExportProjectArtifact.class.getSimpleName() + "\\[.*\\]"));
+    }
+}

gooddata-java-model/src/test/java/com/gooddata/sdk/model/md/maintenance/ExportProjectTest.java

@@ -0,0 +1,37 @@
+/*
+ * Copyright (C) 2004-2020, 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.maintenance;
+
+import org.testng.annotations.Test;
+
+import static net.javacrumbs.jsonunit.JsonMatchers.jsonEquals;
+import static net.javacrumbs.jsonunit.core.util.ResourceUtils.resource;
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.text.MatchesPattern.matchesPattern;
+
+public class ExportProjectTest {
+
+    @Test
+    public void shouldSerialize() {
+        final ExportProject exportProject = new ExportProject(false, false, true, true, "test");
+
+        assertThat(exportProject, jsonEquals(resource("md/maintenance/exportProject.json")));
+    }
+
+    @Test
+    public void shouldSerializeDefaultValues() {
+        final ExportProject exportProject = new ExportProject();
+
+        assertThat(exportProject, jsonEquals(resource("md/maintenance/exportProject-defaultVals.json")));
+    }
+
+    @Test
+    public void testToStringFormat() {
+        final ExportProject exportProject = new ExportProject();
+
+        assertThat(exportProject.toString(), matchesPattern(ExportProject.class.getSimpleName() + "\\[.*\\]"));
+    }
+}

gooddata-java-model/src/test/java/com/gooddata/sdk/model/md/maintenance/ExportProjectTokenTest.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright (C) 2004-2020, 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.maintenance;
+
+import org.testng.annotations.Test;
+
+import static net.javacrumbs.jsonunit.JsonMatchers.jsonEquals;
+import static net.javacrumbs.jsonunit.core.util.ResourceUtils.resource;
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.text.MatchesPattern.matchesPattern;
+
+public class ExportProjectTokenTest {
+
+    @Test
+    public void shouldSerialize() {
+        final ExportProjectToken exportProjectToken = new ExportProjectToken("TOKEN123");
+
+        assertThat(exportProjectToken, jsonEquals(resource("md/maintenance/importProject.json")));
+    }
+
+    @Test
+    public void testToStringFormat() {
+        final ExportProjectToken exportProjectToken = new ExportProjectToken("TOKEN123");
+
+        assertThat(exportProjectToken.toString(), matchesPattern(ExportProjectToken.class.getSimpleName() + "\\[.*\\]"));
+    }
+}

gooddata-java-model/src/test/resources/md/maintenance/exportArtifact.json

@@ -0,0 +1,8 @@
+{
+  "exportArtifact": {
+    "status": {
+      "uri": "/gdc/md/projectId/tasks/taskId/status"
+    },
+    "token": "TOKEN123"
+  }
+}

gooddata-java-model/src/test/resources/md/maintenance/exportProject-defaultVals.json

@@ -0,0 +1,8 @@
+{
+  "exportProject": {
+    "exportUsers": "1",
+    "exportData": "1",
+    "excludeSchedules": "0",
+    "crossDataCenterExport": "0"
+  }
+}

gooddata-java-model/src/test/resources/md/maintenance/exportProject.json

@@ -0,0 +1,9 @@
+{
+  "exportProject": {
+    "exportUsers": "0",
+    "exportData": "0",
+    "excludeSchedules": "1",
+    "crossDataCenterExport": "1",
+    "authorizedUsers": "test"
+  }
+}

gooddata-java-model/src/test/resources/md/maintenance/importProject.json

@@ -0,0 +1,5 @@
+{
+  "importProject": {
+    "token": "TOKEN123"
+  }
+}