#23533

Committed 23 Oct 2024 01:18PM CUT coverage: 20.865%. First build

Build # #23533

Build Type

Pull #10958

github

Committed by

GPortas

Commit Message

Changed: using new UpdateDataverseAttributeCommand from updateAttribute endpoint

Pull Request Pull Request #10958: Fixes updateAttributes endpoint

Run Details

0 of 42 new or added lines in 2 files covered. (0.0%)

17977 of 86159 relevant lines covered (20.86%)

0.21 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

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

package edu.harvard.iq.dataverse.engine.command.impl;

import edu.harvard.iq.dataverse.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.engine.command.exception.IllegalCommandException;
import edu.harvard.iq.dataverse.engine.command.exception.PermissionException;
import edu.harvard.iq.dataverse.settings.SettingsServiceBean;

import java.util.Collections;

/**
 * Command to update an existing Dataverse attribute.
 */
@RequiredPermissions(Permission.EditDataverse)
public class UpdateDataverseAttributeCommand extends AbstractCommand<Dataverse> {

    private static final String ATTRIBUTE_ALIAS = "alias";
    private static final String ATTRIBUTE_NAME = "name";
    private static final String ATTRIBUTE_DESCRIPTION = "description";
    private static final String ATTRIBUTE_AFFILIATION = "affiliation";
    private static final String ATTRIBUTE_FILE_PIDS_ENABLED = "filePIDsEnabled";

    private final Dataverse dataverse;
    private final String attributeName;
    private final Object attributeValue;

    public UpdateDataverseAttributeCommand(DataverseRequest request, Dataverse dataverse, String attributeName, Object attributeValue) {
        super(request, dataverse);
        this.dataverse = dataverse;
        this.attributeName = attributeName;
        this.attributeValue = attributeValue;
    }

    @Override
    public Dataverse execute(CommandContext ctxt) throws CommandException {
        switch (attributeName) {
            case ATTRIBUTE_ALIAS:
            case ATTRIBUTE_NAME:
            case ATTRIBUTE_DESCRIPTION:
            case ATTRIBUTE_AFFILIATION:
                setStringAttribute(attributeName, attributeValue);
                break;
            case ATTRIBUTE_FILE_PIDS_ENABLED:
                setBooleanAttributeForFilePIDs(ctxt);
                break;
            default:
                throw new IllegalCommandException("'" + attributeName + "' is not a supported attribute", this);
        }

        return ctxt.engine().submit(new UpdateDataverseCommand(dataverse, null, null, getRequest(), null));
    }

    /**
     * Helper method to set a string attribute.
     *
     * @param attributeName  The name of the attribute.
     * @param attributeValue The value of the attribute (must be a String).
     * @throws IllegalCommandException if the provided attribute value is not of String type.
     */
    private void setStringAttribute(String attributeName, Object attributeValue) throws IllegalCommandException {
        if (!(attributeValue instanceof String stringValue)) {
            throw new IllegalCommandException("'" + attributeName + "' requires a string value", this);
        }

        switch (attributeName) {
            case ATTRIBUTE_ALIAS:
                dataverse.setAlias(stringValue);
                break;
            case ATTRIBUTE_NAME:
                dataverse.setName(stringValue);
                break;
            case ATTRIBUTE_DESCRIPTION:
                dataverse.setDescription(stringValue);
                break;
            case ATTRIBUTE_AFFILIATION:
                dataverse.setAffiliation(stringValue);
                break;
            default:
                throw new IllegalCommandException("Unsupported string attribute: " + attributeName, this);
        }
    }

    /**
     * Helper method to handle the "filePIDsEnabled" boolean attribute.
     *
     * @param ctxt The command context.
     * @throws PermissionException if the user doesn't have permission to modify this attribute.
     */
    private void setBooleanAttributeForFilePIDs(CommandContext ctxt) throws CommandException {
        if (!getRequest().getUser().isSuperuser()) {
            throw new PermissionException("You must be a superuser to change this setting",
                    this, Collections.singleton(Permission.EditDataset), dataverse);
        }
        if (!ctxt.settings().isTrueForKey(SettingsServiceBean.Key.AllowEnablingFilePIDsPerCollection, false)) {
            throw new PermissionException("Changing File PID policy per collection is not enabled on this server",
                    this, Collections.singleton(Permission.EditDataset), dataverse);
        }

        if (!(attributeValue instanceof Boolean)) {
            throw new IllegalCommandException("'" + ATTRIBUTE_FILE_PIDS_ENABLED + "' requires a boolean value", this);
        }

        dataverse.setFilePIDsEnabled((Boolean) attributeValue);
    }
}

1	package edu.harvard.iq.dataverse.engine.command.impl;
2
3	import edu.harvard.iq.dataverse.Dataverse;
4	import edu.harvard.iq.dataverse.authorization.Permission;
5	import edu.harvard.iq.dataverse.engine.command.AbstractCommand;
6	import edu.harvard.iq.dataverse.engine.command.CommandContext;
7	import edu.harvard.iq.dataverse.engine.command.DataverseRequest;
8	import edu.harvard.iq.dataverse.engine.command.RequiredPermissions;
9	import edu.harvard.iq.dataverse.engine.command.exception.CommandException;
10	import edu.harvard.iq.dataverse.engine.command.exception.IllegalCommandException;
11	import edu.harvard.iq.dataverse.engine.command.exception.PermissionException;
12	import edu.harvard.iq.dataverse.settings.SettingsServiceBean;
13
14	import java.util.Collections;
15
16	/**
17	* Command to update an existing Dataverse attribute.
18	*/
19	@RequiredPermissions(Permission.EditDataverse)
20	public class UpdateDataverseAttributeCommand extends AbstractCommand<Dataverse> {
21
22	private static final String ATTRIBUTE_ALIAS = "alias";
23	private static final String ATTRIBUTE_NAME = "name";
24	private static final String ATTRIBUTE_DESCRIPTION = "description";
25	private static final String ATTRIBUTE_AFFILIATION = "affiliation";
26	private static final String ATTRIBUTE_FILE_PIDS_ENABLED = "filePIDsEnabled";
27
28	private final Dataverse dataverse;
29	private final String attributeName;
30	private final Object attributeValue;
31
32	public UpdateDataverseAttributeCommand(DataverseRequest request, Dataverse dataverse, String attributeName, Object attributeValue) {
NEW 33	super(request, dataverse);	×
NEW 34	this.dataverse = dataverse;	×
NEW 35	this.attributeName = attributeName;	×
NEW 36	this.attributeValue = attributeValue;	×
NEW 37	}	×
38
39	@Override
40	public Dataverse execute(CommandContext ctxt) throws CommandException {
NEW 41	switch (attributeName) {	×
42	case ATTRIBUTE_ALIAS:
43	case ATTRIBUTE_NAME:
44	case ATTRIBUTE_DESCRIPTION:
45	case ATTRIBUTE_AFFILIATION:
NEW 46	setStringAttribute(attributeName, attributeValue);	×
NEW 47	break;	×
48	case ATTRIBUTE_FILE_PIDS_ENABLED:
NEW 49	setBooleanAttributeForFilePIDs(ctxt);	×
NEW 50	break;	×
51	default:
NEW 52	throw new IllegalCommandException("'" + attributeName + "' is not a supported attribute", this);	×
53	}
54
NEW 55	return ctxt.engine().submit(new UpdateDataverseCommand(dataverse, null, null, getRequest(), null));	×
56	}
57
58	/**
59	* Helper method to set a string attribute.
60	*
61	* @param attributeName The name of the attribute.
62	* @param attributeValue The value of the attribute (must be a String).
63	* @throws IllegalCommandException if the provided attribute value is not of String type.
64	*/
65	private void setStringAttribute(String attributeName, Object attributeValue) throws IllegalCommandException {
NEW 66	if (!(attributeValue instanceof String stringValue)) {	×
NEW 67	throw new IllegalCommandException("'" + attributeName + "' requires a string value", this);	×
68	}
69
NEW 70	switch (attributeName) {	×
71	case ATTRIBUTE_ALIAS:
NEW 72	dataverse.setAlias(stringValue);	×
NEW 73	break;	×
74	case ATTRIBUTE_NAME:
NEW 75	dataverse.setName(stringValue);	×
NEW 76	break;	×
77	case ATTRIBUTE_DESCRIPTION:
NEW 78	dataverse.setDescription(stringValue);	×
NEW 79	break;	×
80	case ATTRIBUTE_AFFILIATION:
NEW 81	dataverse.setAffiliation(stringValue);	×
NEW 82	break;	×
83	default:
NEW 84	throw new IllegalCommandException("Unsupported string attribute: " + attributeName, this);	×
85	}
NEW 86	}	×
87
88	/**
89	* Helper method to handle the "filePIDsEnabled" boolean attribute.
90	*
91	* @param ctxt The command context.
92	* @throws PermissionException if the user doesn't have permission to modify this attribute.
93	*/
94	private void setBooleanAttributeForFilePIDs(CommandContext ctxt) throws CommandException {
NEW 95	if (!getRequest().getUser().isSuperuser()) {	×
NEW 96	throw new PermissionException("You must be a superuser to change this setting",	×
NEW 97	this, Collections.singleton(Permission.EditDataset), dataverse);	×
98	}
NEW 99	if (!ctxt.settings().isTrueForKey(SettingsServiceBean.Key.AllowEnablingFilePIDsPerCollection, false)) {	×
NEW 100	throw new PermissionException("Changing File PID policy per collection is not enabled on this server",	×
NEW 101	this, Collections.singleton(Permission.EditDataset), dataverse);	×
102	}
103
NEW 104	if (!(attributeValue instanceof Boolean)) {	×
NEW 105	throw new IllegalCommandException("'" + ATTRIBUTE_FILE_PIDS_ENABLED + "' requires a boolean value", this);	×
106	}
107
NEW 108	dataverse.setFilePIDsEnabled((Boolean) attributeValue);	×
NEW 109	}	×
110	}

IQSS / dataverse / #23533

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous