11914 set template default

doc/release-notes/11914-set-template-default-api.md

@@ -0,0 +1,15 @@
+## New Endpoint: POST `/dataverses/{id}/template/default/{templateId}`
+
+A new endpoint has been implemented to set the default template to a given dataverse collection.
+
+### Functionality
+- Sets the default template of the given dataverse collection.
+- You must have add dataset permission in the collection in order to use this endpoint.
+
+## New Endpoint: DELETE `/dataverses/{id}/template/default`
+
+A new endpoint has been implemented to remove the default template to a given dataverse collection.
+
+### Functionality
+- Removes the default template of the given dataverse collection.
+- You must have add dataset permission in the collection in order to use this endpoint.

src/main/java/edu/harvard/iq/dataverse/api/Dataverses.java

@@ -2001,6 +2001,50 @@ public Response createTemplate(@Context ContainerRequestContext crc, String body
             return e.getResponse();
         }
     }
+
+    @POST
+    @AuthRequired
+    @Path("{identifier}/templates/default/{templateId}")
+    public Response setDefaultTemplate(@Context ContainerRequestContext crc, String body,
+            @PathParam("identifier") String dvId,
+            @PathParam("templateId") Long templateId) {
+
+        try {
+            System.out.println(
+                    "Dataverse API: setting default template for dataverse " + dvId + " to template " + templateId);
+            Dataverse dataverse = findDataverseOrDie(dvId);
+
+            Template templateToSet = dataverse.getTemplates().stream()
+                    .filter(t -> Objects.equals(t.getId(), templateId))
+                    .findFirst()
+                    .orElse(null);
+            if (templateToSet == null) {
+                return error(Status.NOT_FOUND, "Template with id " + templateId + " not found for dataverse " + dvId);
+            }
+            dataverse.setDefaultTemplate(templateToSet);
+            return ok(jsonTemplates(execCommand(
+                    new ListDataverseTemplatesCommand(createDataverseRequest(getRequestUser(crc)), dataverse))));
+        } catch (WrappedResponse e) {
+            return e.getResponse();
+        }
+    }
+
+    @DELETE
+    @AuthRequired
+    @Path("{identifier}/templates/default")
+    public Response removeDefaultTemplate(@Context ContainerRequestContext crc, String body,
+            @PathParam("identifier") String dvId) {
+        try {
+            Dataverse dataverse = findDataverseOrDie(dvId);
+            dataverse.setDefaultTemplate(null);
+            return ok(jsonTemplates(execCommand(
+                    new ListDataverseTemplatesCommand(createDataverseRequest(getRequestUser(crc)), dataverse))));
+        } catch (WrappedResponse e) {
+            return e.getResponse();
+        }
+    }
+
+
 
     @GET
     @AuthRequired

src/test/java/edu/harvard/iq/dataverse/api/DataversesIT.java

@@ -2594,128 +2594,140 @@ public void testUpdateInputLevelDisplayOnCreateOverride() {
     }
 
     @Test
-    public void testCreateAndGetTemplates() throws JsonParseException  {
-        Response createUserResponse = UtilIT.createRandomUser();
-        String apiToken = UtilIT.getApiTokenFromResponse(createUserResponse);
-        String username = UtilIT.getUsernameFromResponse(createUserResponse);
-
-        Response createSecondUserResponse = UtilIT.createRandomUser();
-        String secondApiToken = UtilIT.getApiTokenFromResponse(createSecondUserResponse);
-        String secondUsername = UtilIT.getUsernameFromResponse(createSecondUserResponse);
-
-
-        /*
-        We need to make this a non-inherited metadatablocks so the get template will only get templates from current dv
-         */
-
-        Response createDataverseResponse = UtilIT.createRandomDataverse(apiToken);
-        createDataverseResponse.then().assertThat().statusCode(CREATED.getStatusCode());
-        String dataverseAlias = UtilIT.getAliasFromResponse(createDataverseResponse);
-
-        String newName = "New Test Dataverse Name";
-        String newAffiliation = "New Test Dataverse Affiliation";
-        String newDataverseType = Dataverse.DataverseType.TEACHING_COURSES.toString();
-        String[] newContactEmails = new String[]{"new_email@dataverse.com"};
-        String[] newInputLevelNames = new String[]{"geographicCoverage"};
-        String[] newFacetIds = new String[]{"contributorName"};
-        String[] newMetadataBlockNames = new String[]{"citation", "geospatial", "biomedical"};
-
-       //Giving the new Dataverse updated metadatablocks so that it will not inherit templates 
-       Response updateDataverseResponse = UtilIT.updateDataverse(
-                dataverseAlias, dataverseAlias, newName, newAffiliation, newDataverseType, newContactEmails, newInputLevelNames,
-                null, newMetadataBlockNames, apiToken,
-                Boolean.FALSE, Boolean.FALSE, null
-        );
-
-        updateDataverseResponse.then().assertThat()
-                .statusCode(OK.getStatusCode());
-
-        // Create a template
-
-        String jsonString = """
-                {
-                  "name": "Dataverse template",
-                  "isDefault": true,
-                  "fields": [
-                    {
-                      "typeName": "author",
-                      "value": [
-                        {
-                          "authorName": {
-                            "typeName": "authorName",
-                            "value": "Belicheck, Bill"
-                          },
-                          "authorAffiliation": {
-                            "typeName": "authorIdentifierScheme",
-                            "value": "ORCID"
-                          }
-                        }
-                      ]
-                    }
-                  ],
-                  "instructions": [
-                    {
-                        "instructionField": "author",
-                        "instructionText": "The author data"
-                    }
-                  ]
-                }
-                """;
-
-        Response createTemplateResponse = UtilIT.createTemplate(
-                dataverseAlias,
-                jsonString,
-                apiToken
-        );
-
-        createTemplateResponse.then().assertThat().statusCode(OK.getStatusCode())
-                .body("data.name", equalTo("Dataverse template"))
-                .body("data.isDefault", equalTo(true))
-                .body("data.usageCount", equalTo(0))
-                .body("data.termsOfUseAndAccess.license.name", equalTo("CC0 1.0"))
-                .body("data.datasetFields.citation.fields.size()", equalTo(1))
-                .body("data.instructions.size()", equalTo(1))
-                .body("data.instructions[0].instructionField", equalTo("author"))
-                .body("data.instructions[0].instructionText", equalTo("The author data"))
-                .body("data.dataverseAlias", equalTo(dataverseAlias));
-
-        // Template creation should fail if the user lacks dataverse edit permissions
-
-        createTemplateResponse = UtilIT.createTemplate(
-                dataverseAlias,
-                jsonString,
-                secondApiToken
-        );
-        createTemplateResponse.then().assertThat().statusCode(UNAUTHORIZED.getStatusCode());
-
-        // Get templates
-
-        Response getTemplateResponse = UtilIT.getTemplates(dataverseAlias, apiToken);
-        getTemplateResponse.then().assertThat().statusCode(OK.getStatusCode())
-                .body("data.size()", equalTo(1))
-                .body("data[0].name", equalTo("Dataverse template"))
-                .body("data[0].isDefault", equalTo(true))
-                .body("data[0].usageCount", equalTo(0))
-                .body("data[0].termsOfUseAndAccess.license.name", equalTo("CC0 1.0"))
-                .body("data[0].datasetFields.citation.fields.size()", equalTo(1))
-                .body("data[0].instructions.size()", equalTo(1))
-                .body("data[0].instructions[0].instructionField", equalTo("author"))
-                .body("data[0].instructions[0].instructionText", equalTo("The author data"))
-                .body("data[0].dataverseAlias", equalTo(dataverseAlias));
-
-        // Templates retrieval should fail if a secondary user lacks dataset creation permissions
-
-        getTemplateResponse = UtilIT.getTemplates(dataverseAlias, secondApiToken);
-        getTemplateResponse.then().assertThat().statusCode(UNAUTHORIZED.getStatusCode());
-
-        // Templates retrieval should succeed if the secondary user has dataset creation permissions
-
-        UtilIT.setSuperuserStatus(username, true);
-        Response grantRoleResponse = UtilIT.grantRoleOnDataverse(dataverseAlias, DataverseRole.DS_CONTRIBUTOR, "@" + secondUsername, apiToken);
-        grantRoleResponse.then().assertThat().statusCode(OK.getStatusCode());
-
-        getTemplateResponse = UtilIT.getTemplates(dataverseAlias, secondApiToken);
-        getTemplateResponse.then().assertThat().statusCode(OK.getStatusCode());
+    public void testCreateAndGetTemplates() throws JsonParseException {
+            Response createUserResponse = UtilIT.createRandomUser();
+            String apiToken = UtilIT.getApiTokenFromResponse(createUserResponse);
+            String username = UtilIT.getUsernameFromResponse(createUserResponse);
+
+            Response createSecondUserResponse = UtilIT.createRandomUser();
+            String secondApiToken = UtilIT.getApiTokenFromResponse(createSecondUserResponse);
+            String secondUsername = UtilIT.getUsernameFromResponse(createSecondUserResponse);
+
+            /*
+             * We need to make this a non-inherited metadatablocks so the get template will
+             * only get templates from current dv
+             */
+
+            Response createDataverseResponse = UtilIT.createRandomDataverse(apiToken);
+            createDataverseResponse.then().assertThat().statusCode(CREATED.getStatusCode());
+            String dataverseAlias = UtilIT.getAliasFromResponse(createDataverseResponse);
+
+            String newName = "New Test Dataverse Name";
+            String newAffiliation = "New Test Dataverse Affiliation";
+            String newDataverseType = Dataverse.DataverseType.TEACHING_COURSES.toString();
+            String[] newContactEmails = new String[] { "new_email@dataverse.com" };
+            String[] newInputLevelNames = new String[] { "geographicCoverage" };
+            String[] newFacetIds = new String[] { "contributorName" };
+            String[] newMetadataBlockNames = new String[] { "citation", "geospatial", "biomedical" };
+
+            // Giving the new Dataverse updated metadatablocks so that it will not inherit
+            // templates
+            Response updateDataverseResponse = UtilIT.updateDataverse(
+                            dataverseAlias, dataverseAlias, newName, newAffiliation, newDataverseType, newContactEmails,
+                            newInputLevelNames,
+                            null, newMetadataBlockNames, apiToken,
+                            Boolean.FALSE, Boolean.FALSE, null);
+
+            updateDataverseResponse.then().assertThat()
+                            .statusCode(OK.getStatusCode());
+
+            // Create a template
+
+            String jsonString = """
+                            {
+                              "name": "Dataverse template",
+                              "isDefault": false,
+                              "fields": [
+                                {
+                                  "typeName": "author",
+                                  "value": [
+                                    {
+                                      "authorName": {
+                                        "typeName": "authorName",
+                                        "value": "Belicheck, Bill"
+                                      },
+                                      "authorAffiliation": {
+                                        "typeName": "authorIdentifierScheme",
+                                        "value": "ORCID"
+                                      }
+                                    }
+                                  ]
+                                }
+                              ],
+                              "instructions": [
+                                {
+                                    "instructionField": "author",
+                                    "instructionText": "The author data"
+                                }
+                              ]
+                            }
+                            """;
+
+            Response createTemplateResponse = UtilIT.createTemplate(
+                            dataverseAlias,
+                            jsonString,
+                            apiToken);
+
+            createTemplateResponse.then().assertThat().statusCode(OK.getStatusCode())
+                            .body("data.name", equalTo("Dataverse template"))
+                            .body("data.isDefault", equalTo(false))
+                            .body("data.usageCount", equalTo(0))
+                            .body("data.termsOfUseAndAccess.license.name", equalTo("CC0 1.0"))
+                            .body("data.datasetFields.citation.fields.size()", equalTo(1))
+                            .body("data.instructions.size()", equalTo(1))
+                            .body("data.instructions[0].instructionField", equalTo("author"))
+                            .body("data.instructions[0].instructionText", equalTo("The author data"))
+                            .body("data.dataverseAlias", equalTo(dataverseAlias));
+
+            Long templateId = createTemplateResponse.then().extract().path("data.id");
+
+
+
+            Response setDefaultResp = UtilIT.setDefaultTemplate(dataverseAlias, templateId, secondApiToken);
+            setDefaultResp.then().assertThat().statusCode(UNAUTHORIZED.getStatusCode());
+
+            setDefaultResp = UtilIT.setDefaultTemplate(dataverseAlias, templateId, apiToken);
+            setDefaultResp.then().assertThat().statusCode(OK.getStatusCode());
+
+            // Template creation should fail if the user lacks dataverse edit permissions
+
+            createTemplateResponse = UtilIT.createTemplate(
+                            dataverseAlias,
+                            jsonString,
+                            secondApiToken);
+            createTemplateResponse.then().assertThat().statusCode(UNAUTHORIZED.getStatusCode());
+
+            // Get templates
+
+            Response getTemplateResponse = UtilIT.getTemplates(dataverseAlias, apiToken);
+            getTemplateResponse.then().assertThat().statusCode(OK.getStatusCode())
+                            .body("data.size()", equalTo(1))
+                            .body("data[0].name", equalTo("Dataverse template"))
+                            .body("data[0].isDefault", equalTo(true))
+                            .body("data[0].usageCount", equalTo(0))
+                            .body("data[0].termsOfUseAndAccess.license.name", equalTo("CC0 1.0"))
+                            .body("data[0].datasetFields.citation.fields.size()", equalTo(1))
+                            .body("data[0].instructions.size()", equalTo(1))
+                            .body("data[0].instructions[0].instructionField", equalTo("author"))
+                            .body("data[0].instructions[0].instructionText", equalTo("The author data"))
+                            .body("data[0].dataverseAlias", equalTo(dataverseAlias));
+
+            // Templates retrieval should fail if a secondary user lacks dataset creation
+            // permissions
+
+            getTemplateResponse = UtilIT.getTemplates(dataverseAlias, secondApiToken);
+            getTemplateResponse.then().assertThat().statusCode(UNAUTHORIZED.getStatusCode());
+
+            // Templates retrieval should succeed if the secondary user has dataset creation
+            // permissions
+
+            UtilIT.setSuperuserStatus(username, true);
+            Response grantRoleResponse = UtilIT.grantRoleOnDataverse(dataverseAlias, DataverseRole.DS_CONTRIBUTOR,
+                            "@" + secondUsername, apiToken);
+            grantRoleResponse.then().assertThat().statusCode(OK.getStatusCode());
+
+            getTemplateResponse = UtilIT.getTemplates(dataverseAlias, secondApiToken);
+            getTemplateResponse.then().assertThat().statusCode(OK.getStatusCode());
     }
 
     @Test

src/test/java/edu/harvard/iq/dataverse/api/UtilIT.java

@@ -5054,6 +5054,22 @@ public static Response getTemplates(String dataverseAlias, String apiToken) {
                 .header(API_TOKEN_HTTP_HEADER, apiToken)
                 .get("/api/dataverses/" + dataverseAlias + "/templates");
     }
+
+    public static Response setDefaultTemplate(String dataverseAlias, Long templateId, String apiToken) {
+    return given()
+            .contentType(ContentType.JSON)
+            .header(API_TOKEN_HTTP_HEADER, apiToken)
+            .post("/api/dataverses/" + dataverseAlias + "/templates/default/" + templateId);
+    }
+
+    public static Response removeDefaultTemplate(String dataverseAlias, String apiToken) {
+    return given()
+            .contentType(ContentType.JSON)
+            .header(API_TOKEN_HTTP_HEADER, apiToken)
+            .delete("/api/dataverses/" + dataverseAlias + "/templates/default");
+    }
+
+
 
     /**
      * Gets the tool URL for a dataset with optional parameters