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 edit dataverse 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 edit dataverse permission in the collection in order to use this endpoint.

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

@@ -370,6 +370,25 @@ protected Dataverse findDataverseOrDie( String dvIdtf ) throws WrappedResponse {
         }
         return dv;
     }
+
+    protected Template findTemplateOrDie(Long templateId, Dataverse dataverse) throws WrappedResponse {
+
+        List<Template> templates = new ArrayList<>();
+
+        templates.addAll(dataverse.getTemplates());
+        templates.addAll(dataverse.getParentTemplates());
+
+        Template template = templates.stream()
+                .filter(t -> Objects.equals(t.getId(), templateId))
+                .findFirst()
+                .orElse(null);
+
+        if (template == null) {
+            throw new WrappedResponse(
+                    error(Response.Status.NOT_FOUND, "Can't find template with identifier='" + templateId + "'"));
+        }
+        return template;
+    }
 
     protected DataverseLinkingDataverse findDataverseLinkingDataverseOrDie(String dataverseId, String linkedDataverseId) throws WrappedResponse {
         DataverseLinkingDataverse dvld;

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

@@ -2031,6 +2031,45 @@ public Response createTemplate(@Context ContainerRequestContext crc, String body
         }
     }
 
+    @POST
+    @AuthRequired
+    @Path("{identifier}/templates/default/{templateId}")
+    public Response setDefaultTemplate(@Context ContainerRequestContext crc,
+            @PathParam("identifier") String dvId,
+            @PathParam("templateId") Long templateId) {
+
+        try {
+
+            Dataverse dataverse = findDataverseOrDie(dvId);
+            Template template = findTemplateOrDie(templateId, dataverse);
+            DataverseRequest dvReq = createDataverseRequest(getRequestUser(crc));
+            SetDefaultTemplateCommand command = new SetDefaultTemplateCommand(template, dvReq, dataverse);
+
+            execCommand(command);
+
+            return ok(BundleUtil.getStringFromBundle("dataverse.setDefaultTemplate.success"));
+
+        } catch (WrappedResponse e) {
+            return e.getResponse();
+        }
+    }
+
+    @DELETE
+    @AuthRequired
+    @Path("{identifier}/templates/default")
+    public Response removeDefaultTemplate(@Context ContainerRequestContext crc,
+            @PathParam("identifier") String dvId) {
+        try {
+            Dataverse dataverse = findDataverseOrDie(dvId);
+            RemoveDefaultTemplateCommand command = new RemoveDefaultTemplateCommand(createDataverseRequest(getRequestUser(crc)), dataverse);
+            execCommand(command);
+            return ok(BundleUtil.getStringFromBundle("dataverse.removeDefaultTemplate.success"));
+        } catch (WrappedResponse e) {
+            return e.getResponse();
+        }
+    }
+
+
     @GET
     @AuthRequired
     @Path("{identifier}/allowedMetadataLanguages")

src/main/java/edu/harvard/iq/dataverse/engine/command/impl/CreateTemplateCommand.java

@@ -53,6 +53,7 @@ public Template execute(CommandContext ctxt) throws CommandException {
         if (initialize && createdTemplate.isIsDefaultForDataverse()) {
             dataverse.setDefaultTemplate(createdTemplate);
             ctxt.em().merge(dataverse);
+            ctxt.em().flush();
         }
 
         //Flush so that api response can include the id

src/main/java/edu/harvard/iq/dataverse/engine/command/impl/RemoveDefaultTemplateCommand.java

@@ -0,0 +1,32 @@
+package edu.harvard.iq.dataverse.engine.command.impl;
+
+import edu.harvard.iq.dataverse.*;
+import edu.harvard.iq.dataverse.authorization.Permission;
+
+import edu.harvard.iq.dataverse.engine.command.AbstractCommand;
+import edu.harvard.iq.dataverse.engine.command.CommandContext;
+import edu.harvard.iq.dataverse.engine.command.DataverseRequest;
+import edu.harvard.iq.dataverse.engine.command.RequiredPermissions;
+import edu.harvard.iq.dataverse.engine.command.exception.CommandException;
+
+/** 
+ * @author J.P. Tosca
+ * Removes the default template {@link Template} for a {@link Dataverse}.
+ */
+@RequiredPermissions(Permission.EditDataverse)
+public class RemoveDefaultTemplateCommand extends AbstractCommand<Dataverse>{
+
+    private final Dataverse dataverse;
+
+    public RemoveDefaultTemplateCommand(DataverseRequest request, Dataverse dataverse) {
+        super(request, dataverse);
+        this.dataverse = dataverse;
+    }
+
+    @Override
+    public Dataverse execute(CommandContext ctxt) throws CommandException {
+        dataverse.setDefaultTemplate(null);
+        return dataverse;
+    }
+
+}

src/main/java/edu/harvard/iq/dataverse/engine/command/impl/SetDefaultTemplateCommand.java

@@ -0,0 +1,35 @@
+package edu.harvard.iq.dataverse.engine.command.impl;
+
+import edu.harvard.iq.dataverse.*;
+import edu.harvard.iq.dataverse.authorization.Permission;
+
+import edu.harvard.iq.dataverse.engine.command.AbstractCommand;
+import edu.harvard.iq.dataverse.engine.command.CommandContext;
+import edu.harvard.iq.dataverse.engine.command.DataverseRequest;
+import edu.harvard.iq.dataverse.engine.command.RequiredPermissions;
+import edu.harvard.iq.dataverse.engine.command.exception.CommandException;
+import edu.harvard.iq.dataverse.Template;
+
+/** 
+ * @author J.P. Tosca
+ * Sets a default template {@link Template} for a {@link Dataverse}.
+ */
+@RequiredPermissions(Permission.EditDataverse)
+public class SetDefaultTemplateCommand extends AbstractCommand<Template> {
+
+    private final Template template;
+    private final Dataverse dataverse;
+
+    public SetDefaultTemplateCommand(Template template, DataverseRequest request, Dataverse dataverse) {
+        super(request, dataverse);
+        this.template = template;
+        this.dataverse = dataverse;
+    }
+
+    @Override
+    public Template execute(CommandContext ctxt) throws CommandException {
+        dataverse.setDefaultTemplate(template);
+        return template;
+    }
+
+}

src/main/java/propertyFiles/Bundle.properties

@@ -1042,6 +1042,8 @@ dataverse.update.featuredItems.error.invalidType=Unknown 'type' must be one of {
 dataverse.update.featuredItems.error.typeAndDvObjectMismatch=The 'type' passed does not match the dvObject type.
 dataverse.delete.featuredItems.success=All featured items of this Dataverse have been successfully deleted.
 dataverse.createTemplate.error.jsonParseMetadataFields=Error parsing the POSTed template dataset fields: {0}
+dataverse.setDefaultTemplate.success=The default dataset template has been successfully set for this dataverse.
+dataverse.removeDefaultTemplate.success=The default dataset template has been successfully removed from this dataverse.
 # rolesAndPermissionsFragment.xhtml
 
 # advanced.xhtml

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

@@ -2617,9 +2617,9 @@ public void testCreateAndGetTemplates() throws JsonParseException  {
         String apiToken = UtilIT.getApiTokenFromResponse(createUserResponse);
         String username = UtilIT.getUsernameFromResponse(createUserResponse);
 
-        Response createSecondUserResponse = UtilIT.createRandomUser();
-        String secondApiToken = UtilIT.getApiTokenFromResponse(createSecondUserResponse);
-        String secondUsername = UtilIT.getUsernameFromResponse(createSecondUserResponse);
+            Response createSecondUserResponse = UtilIT.createRandomUser();
+            String secondApiToken = UtilIT.getApiTokenFromResponse(createSecondUserResponse);
+            String secondUsername = UtilIT.getUsernameFromResponse(createSecondUserResponse);
 
 
         /*
@@ -2642,61 +2642,52 @@ public void testCreateAndGetTemplates() throws JsonParseException  {
         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,
+        // 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
-        );
-
+                Boolean.FALSE, Boolean.FALSE, null);
+
         updateDataverseResponse.then().assertThat()
                 .statusCode(OK.getStatusCode());
 
-        Response publishDataverse = UtilIT.publishDataverseViaNativeApi(dataverseAlias, apiToken);
-        assertEquals(200, publishDataverse.getStatusCode());
-        assertTrue(publishDataverse.prettyPrint().contains("isReleased\": true"));
-
-        // 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"
-                    }
-                  ]
-                }
-                """;
+                            {
+                              "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
-        );
+                apiToken);
 
-        createTemplateResponse.prettyPrint();
-        Long templateId = UtilIT.getTemplateIdFromResponse(createTemplateResponse);
-
         createTemplateResponse.then().assertThat().statusCode(CREATED.getStatusCode())
                 .body("data.name", equalTo("Dataverse template"))
                 .body("data.isDefault", equalTo(true))
@@ -2708,17 +2699,24 @@ public void testCreateAndGetTemplates() throws JsonParseException  {
                 .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
+        Long templateId = createTemplateResponse.body().jsonPath().getLong("data.id");
+
+        //Check for failure due unauthorized user.
+        Response setDefaultResp = UtilIT.setDefaultTemplate(dataverseAlias, templateId, secondApiToken);
+        setDefaultResp.then().assertThat().statusCode(UNAUTHORIZED.getStatusCode());
+
+        // Set default template
+        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
-        );
+                secondApiToken);
         createTemplateResponse.then().assertThat().statusCode(UNAUTHORIZED.getStatusCode());
 
-        // Get templates
-
+        // Get templates and check this one is default now
         Response getTemplateResponse = UtilIT.getTemplates(dataverseAlias, apiToken);
         getTemplateResponse.then().assertThat().statusCode(OK.getStatusCode())
                 .body("data.size()", equalTo(1))
@@ -2731,13 +2729,28 @@ public void testCreateAndGetTemplates() throws JsonParseException  {
                 .body("data[0].instructions[0].instructionField", equalTo("author"))
                 .body("data[0].instructions[0].instructionText", equalTo("The author data"))
                 .body("data[0].dataverseAlias", equalTo(dataverseAlias));
+
+
+            // Remove default template
+            System.out.print("***************: " + dataverseAlias );
+
+            Response removeDefaultResp = UtilIT.removeDefaultTemplate(dataverseAlias, apiToken);
+            removeDefaultResp.prettyPrint();
+            removeDefaultResp.then().assertThat().statusCode(OK.getStatusCode());       
 
-        // Templates retrieval should fail if a secondary user lacks dataset creation permissions
+            //check that template is no longer default.
+            getTemplateResponse = UtilIT.getTemplates(dataverseAlias, apiToken);
+            getTemplateResponse.then().assertThat().statusCode(OK.getStatusCode())
+                            .body("data.size()", equalTo(1))
+                            .body("data[0].isDefault", equalTo(false));
 
-        getTemplateResponse = UtilIT.getTemplates(dataverseAlias, secondApiToken);
-        getTemplateResponse.then().assertThat().statusCode(UNAUTHORIZED.getStatusCode());
 
-        // Templates retrieval should succeed if the secondary user has dataset creation permissions
+            // Templates retrieval should fail if a secondary user lacks dataset creation
+            // permissions
+
+            getTemplateResponse = UtilIT.getTemplates(dataverseAlias, secondApiToken);
+            getTemplateResponse.then().assertThat().statusCode(UNAUTHORIZED.getStatusCode());
+
 
 
         //set to super to update role 
@@ -2791,7 +2804,7 @@ public void testCreateAndGetTemplates() throws JsonParseException  {
         deleteUserResponse.prettyPrint();
         assertEquals(200, deleteUserResponse.getStatusCode());
 
-        
+
     }
 
     @Test

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

@@ -5157,6 +5157,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");
+    }
+
+
 
     public static Response getTemplate(String templateId) {
         return given()