Skip to content

Commit

Permalink
Backport resource delta applyDefinition fix
Browse files Browse the repository at this point in the history 
This is an attempt to backport the fix for MID-7918
(992d273). The problem is that
the fix itself refers to the code that was heavily refactored
during the development of 4.5-4.6.

Hence, here we practically replace parts of the legacy code with their
modern equivalents: ConnectorSpec class and the code for applyDefinition
method related to resource definition deltas.
  • Loading branch information
@mederly
mederly committed Dec 15, 2022
1 parent 8a56c04 commit 28936e5
Show file tree
Hide file tree
Showing 6 changed files with 716 additions and 132 deletions.
1 change: 1 addition & 0 deletions infra/schema/src/main/resources/xml/ns/public/common/common-core-3.xsd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3748,6 +3748,7 @@
</xsd:sequence>
<xsd:attribute name="id" type="xsd:long"/>
</xsd:complexType>
<xsd:element name="connectorInstanceSpecification" type="c:ConnectorInstanceSpecificationType" />

<xsd:complexType name="XmlSchemaType">
<xsd:annotation>
Expand Down
288 changes: 281 additions & 7 deletions ...t/src/test/java/com/evolveum/midpoint/model/intest/multi/TestMultiConnectorResources.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,42 @@
*/
package com.evolveum.midpoint.model.intest.multi;

import static org.assertj.core.api.Assertions.assertThat;
import static org.testng.AssertJUnit.assertEquals;

import java.io.File;
import java.util.List;

import com.evolveum.midpoint.model.api.ModelExecuteOptions;
import com.evolveum.midpoint.prism.*;
import com.evolveum.midpoint.prism.delta.ContainerDelta;
import com.evolveum.midpoint.prism.delta.ItemDelta;
import com.evolveum.midpoint.prism.delta.ObjectDelta;
import com.evolveum.midpoint.prism.delta.PropertyDelta;
import com.evolveum.midpoint.prism.path.ItemName;
import com.evolveum.midpoint.prism.path.ItemPath;
import com.evolveum.midpoint.schema.constants.SchemaConstants;
import com.evolveum.midpoint.util.exception.*;

import com.evolveum.midpoint.xml.ns._public.common.common_3.ConnectorConfigurationType;
import com.evolveum.midpoint.xml.ns._public.common.common_3.ConnectorInstanceSpecificationType;
import com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectReferenceType;
import com.evolveum.midpoint.xml.ns._public.common.common_3.ResourceType;

import org.springframework.test.annotation.DirtiesContext;
import org.springframework.test.annotation.DirtiesContext.ClassMode;
import org.springframework.test.context.ContextConfiguration;
import org.testng.annotations.Test;

import com.evolveum.midpoint.model.intest.AbstractConfiguredModelIntegrationTest;
import com.evolveum.midpoint.schema.constants.MidPointConstants;
import com.evolveum.midpoint.schema.result.OperationResult;
import com.evolveum.midpoint.task.api.Task;
import com.evolveum.midpoint.test.DummyResourceContoller;
import com.evolveum.midpoint.test.util.TestUtil;

/**
* Test resources that have several connectors.
* <p>
*
* MID-5921
*
* @author semancik
Expand All @@ -36,14 +53,16 @@ public class TestMultiConnectorResources extends AbstractConfiguredModelIntegrat
public static final File TEST_DIR = new File("src/test/resources/multi-connector");

// Black dummy resource for testing tolerant attributes
protected static final File RESOURCE_DUMMY_OPALINE_FILE = new File(TEST_DIR, "resource-dummy-opaline.xml");
protected static final String RESOURCE_DUMMY_OPALINE_OID = "d4a2a030-0a1c-11ea-b61c-67d35cfea30f";
protected static final String RESOURCE_DUMMY_OPALINE_NAME = "opaline";
protected static final String RESOURCE_DUMMY_OPALINE_SCRIPT_NAME = "opaline-script";
protected static final String RESOURCE_DUMMY_OPALINE_NAMESPACE = MidPointConstants.NS_RI;
private static final File RESOURCE_DUMMY_OPALINE_FILE = new File(TEST_DIR, "resource-dummy-opaline.xml");
private static final String RESOURCE_DUMMY_OPALINE_OID = "d4a2a030-0a1c-11ea-b61c-67d35cfea30f";
private static final String RESOURCE_DUMMY_OPALINE_NAME = "opaline";
private static final String RESOURCE_DUMMY_OPALINE_SCRIPT_NAME = "opaline-script";
private static final String CONF_USELESS_OPALINE = "USEless-opaline";
private static final String CONF_USELESS_SCRIPT = "USEless-script";

private static final String SCRIPT_RUNNER_NS = "http://midpoint.evolveum.com/xml/ns/public/connector/icf-1/bundle/com.evolveum.icf.dummy/com.evolveum.icf.dummy.connector.DummyConnectorScriptRunner";
private static final ItemName SCRIPT_RUNNER_INSTANCE_ID = new ItemName(SCRIPT_RUNNER_NS, "instanceId");

@Override
public void initSystem(Task initTask, OperationResult initResult) throws Exception {
super.initSystem(initTask, initResult);
Expand Down Expand Up @@ -99,4 +118,259 @@ public void test100JackAssignDummyOpaline() throws Exception {
.assertFullName(USER_JACK_FULL_NAME);
}

/**
* Tests `applyDefinition` method w.r.t. additional connectors.
*
* MID-7918
*/
@Test
public void test200CheckConfigurationPropertyDeltaDefinition() throws CommonException {
Task task = getTestTask();
OperationResult result = task.getResult();

given("a delta for configuration property of additional connector");
PropertyDelta<Object> propertyDelta = createConfigurationPropertyDelta();
ObjectDelta<ResourceType> objectDelta = createObjectDelta(propertyDelta);

when("applying definition to the delta");
provisioningService.applyDefinition(objectDelta, task, result);

then("the definition is there");
ItemDelta<?, ?> propertyDeltaAfter = objectDelta.getModifications().iterator().next();
assertThat(propertyDeltaAfter.getDefinition()).as("definition").isNotNull();
}

private PropertyDelta<Object> createConfigurationPropertyDelta() {
PrismContainer<Containerable> additionalConnectorsContainer =
getDummyResourceObject(RESOURCE_DUMMY_OPALINE_NAME).findContainer(ResourceType.F_ADDITIONAL_CONNECTOR);
// Using legacy API because we intentionally provide no definition here
PropertyDelta<Object> propertyDelta = prismContext.deltaFactory().property().create(
ItemPath.create(
ResourceType.F_ADDITIONAL_CONNECTOR,
additionalConnectorsContainer.getValue().getId(),
ConnectorInstanceSpecificationType.F_CONNECTOR_CONFIGURATION,
SchemaConstants.ICF_CONFIGURATION_PROPERTIES,
SCRIPT_RUNNER_INSTANCE_ID),
null);
propertyDelta.setValueToReplace(
prismContext.itemFactory().createPropertyValue("opaline-script-2"));
return propertyDelta;
}

private ObjectDelta<ResourceType> createObjectDelta(ItemDelta<?, ?> itemDelta) {
return prismContext.deltaFactory().object()
.createModifyDelta(RESOURCE_DUMMY_OPALINE_OID, itemDelta, ResourceType.class);
}

/**
* The same as previous test, but this time really executing the delta.
*
* MID-7918
*/
@Test
public void test210ModifyConfigurationProperty() throws CommonException {
Task task = getTestTask();
OperationResult result = task.getResult();

given("a delta for configuration property of additional connector");
PropertyDelta<Object> propertyDelta = createConfigurationPropertyDelta();
ObjectDelta<ResourceType> objectDelta = createObjectDelta(propertyDelta);

when("executing the delta");
modelService.executeChanges(
List.of(objectDelta), ModelExecuteOptions.create().raw(), task, result);

then("the property is updated");
assertPropertyAfter("opaline-script-2", task, result);
}

/**
* This time we replace the whole `configurationProperties` container.
*
* MID-7918
*/
@Test
public void test220ReplaceConfigurationPropertiesContainer() throws CommonException {
Task task = getTestTask();
OperationResult result = task.getResult();

given("a delta for configuration properties container of additional connector");
PrismContainer<Containerable> additionalConnectorsContainer =
getDummyResourceObject(RESOURCE_DUMMY_OPALINE_NAME).findContainer(ResourceType.F_ADDITIONAL_CONNECTOR);
// Using legacy API because we intentionally provide no definition here
ContainerDelta<Containerable> containerDelta = prismContext.deltaFactory().container().create(
ItemPath.create(
ResourceType.F_ADDITIONAL_CONNECTOR,
additionalConnectorsContainer.getValue().getId(),
ConnectorInstanceSpecificationType.F_CONNECTOR_CONFIGURATION,
SchemaConstants.ICF_CONFIGURATION_PROPERTIES),
null);
PrismContainerValue<Containerable> containerValue = prismContext.itemFactory().createContainerValue();
PrismProperty<String> property = prismContext.itemFactory().createProperty(SCRIPT_RUNNER_INSTANCE_ID);
property.setRealValue("opaline-script-220");
containerValue.add(property);
containerDelta.setValueToReplace(containerValue);

ObjectDelta<ResourceType> objectDelta = createObjectDelta(containerDelta);

when("applying definition to the delta");
provisioningService.applyDefinition(objectDelta, task, result);

then("the definition is there");
ItemDelta<?, ?> containerDeltaAfter = objectDelta.getModifications().iterator().next();

PrismContainerValue<?> configurationPropertiesPcv =
(PrismContainerValue<?>) containerDeltaAfter.getValuesToReplace().iterator().next();
PrismProperty<?> propertyAfter = configurationPropertiesPcv.findProperty(SCRIPT_RUNNER_INSTANCE_ID);
assertThat(propertyAfter.getDefinition()).as("definition").isNotNull();

when("executing the delta");
modelService.executeChanges(
List.of(objectDelta), ModelExecuteOptions.create().raw(), task, result);

then("the property is updated");
assertPropertyAfter("opaline-script-220", task, result);
}

/**
* As the previous test, but this time we replace the whole `connectorConfiguration` container.
*
* MID-7918
*/
@Test
public void test230ReplaceConnectorConfigurationContainer() throws CommonException {
Task task = getTestTask();
OperationResult result = task.getResult();

given("a delta for connector configuration container of additional connector");
PrismContainer<Containerable> additionalConnectorsContainer =
getDummyResourceObject(RESOURCE_DUMMY_OPALINE_NAME).findContainer(ResourceType.F_ADDITIONAL_CONNECTOR);
// Using legacy API because we intentionally provide no definition here
ContainerDelta<Containerable> containerDelta = prismContext.deltaFactory().container().create(
ItemPath.create(
ResourceType.F_ADDITIONAL_CONNECTOR,
additionalConnectorsContainer.getValue().getId(),
ConnectorInstanceSpecificationType.F_CONNECTOR_CONFIGURATION),
null);

PrismContainerValue<Containerable> configurationPropertiesContainerValue =
prismContext.itemFactory().createContainerValue();
PrismProperty<String> property = prismContext.itemFactory().createProperty(SCRIPT_RUNNER_INSTANCE_ID);
property.setRealValue("opaline-script-230");
configurationPropertiesContainerValue.add(property);

//noinspection unchecked
PrismContainer<Containerable> configurationPropertiesContainer =
prismContext.itemFactory().createContainer(SchemaConstants.ICF_CONFIGURATION_PROPERTIES);
configurationPropertiesContainer.add(configurationPropertiesContainerValue);

PrismContainerValue<Containerable> connectorConfigurationContainerValue =
prismContext.itemFactory().createContainerValue();
connectorConfigurationContainerValue.add(configurationPropertiesContainer);
containerDelta.setValueToReplace(connectorConfigurationContainerValue);

ObjectDelta<ResourceType> objectDelta = createObjectDelta(containerDelta);

when("applying definition to the delta");
provisioningService.applyDefinition(objectDelta, task, result);

then("the definition is there");
ItemDelta<?, ?> containerDeltaAfter = objectDelta.getModifications().iterator().next();

PrismContainerValue<?> connectorConfigurationPcv =
(PrismContainerValue<?>) containerDeltaAfter.getValuesToReplace().iterator().next();
PrismProperty<?> propertyAfter = connectorConfigurationPcv.findProperty(
ItemPath.create(
SchemaConstants.ICF_CONFIGURATION_PROPERTIES,
SCRIPT_RUNNER_INSTANCE_ID));
assertThat(propertyAfter.getDefinition()).as("definition").isNotNull();

when("executing the delta");
modelService.executeChanges(
List.of(objectDelta), ModelExecuteOptions.create().raw(), task, result);

then("the property is updated");
assertPropertyAfter("opaline-script-230", task, result);
}

/**
* Finally, here we create a delta to replace the whole `additionalConnector` container.
*
* MID-7918
*/
@Test
public void test240ReplaceAdditionalConnectorContainer() throws CommonException {
Task task = getTestTask();
OperationResult result = task.getResult();

given("a delta for additional connector (replace)");
ObjectReferenceType connectorRef =
getDummyResourceObject(RESOURCE_DUMMY_OPALINE_NAME).asObjectable()
.getAdditionalConnector().get(0).getConnectorRef();
ConnectorInstanceSpecificationType additionalConnector = new ConnectorInstanceSpecificationType();
additionalConnector.connectorRef(connectorRef.clone());
additionalConnector.setName("scripting");
ConnectorConfigurationType connectorConfiguration = new ConnectorConfigurationType();
additionalConnector.setConnectorConfiguration(connectorConfiguration);

PrismContainerValue<Containerable> configurationPropertiesContainerValue =
prismContext.itemFactory().createContainerValue();
PrismProperty<String> property = prismContext.itemFactory().createProperty(SCRIPT_RUNNER_INSTANCE_ID);
property.setRealValue("opaline-script-240");
configurationPropertiesContainerValue.add(property);

//noinspection unchecked
PrismContainer<Containerable> configurationPropertiesContainer =
prismContext.itemFactory().createContainer(SchemaConstants.ICF_CONFIGURATION_PROPERTIES);
configurationPropertiesContainer.add(configurationPropertiesContainerValue);

//noinspection unchecked
connectorConfiguration.asPrismContainerValue().add(configurationPropertiesContainer);

// This time we provide (generic) definition for the delta. The "applyDefinition" code is not expected
// to deal with this situation.
ContainerDelta<ConnectorInstanceSpecificationType> containerDelta =
prismContext.deltaFactory().container().create(
ResourceType.F_ADDITIONAL_CONNECTOR,
prismContext.getSchemaRegistry()
.findContainerDefinitionByCompileTimeClass(ConnectorInstanceSpecificationType.class));
//noinspection unchecked
containerDelta.setValueToReplace(additionalConnector.asPrismContainerValue());

ObjectDelta<ResourceType> objectDelta = createObjectDelta(containerDelta);

when("applying definition to the delta");
provisioningService.applyDefinition(objectDelta, task, result);

then("the definition is there");
ItemDelta<?, ?> containerDeltaAfter = objectDelta.getModifications().iterator().next();

PrismContainerValue<?> additionalContainerPcv =
(PrismContainerValue<?>) containerDeltaAfter.getValuesToReplace().iterator().next();
PrismProperty<?> propertyAfter = additionalContainerPcv.findProperty(
ItemPath.create(
ConnectorInstanceSpecificationType.F_CONNECTOR_CONFIGURATION,
SchemaConstants.ICF_CONFIGURATION_PROPERTIES,
SCRIPT_RUNNER_INSTANCE_ID));

assertThat(propertyAfter.getDefinition()).as("definition").isNotNull();

when("executing the delta");
modelService.executeChanges(
List.of(objectDelta), ModelExecuteOptions.create().raw(), task, result);

then("the property is updated");
assertPropertyAfter("opaline-script-240", task, result);
}

private void assertPropertyAfter(String expected, Task task, OperationResult result) throws CommonException {
PrismObject<ResourceType> resourceAfter =
repositoryService.getObject(ResourceType.class, RESOURCE_DUMMY_OPALINE_OID, null, result);
provisioningService.applyDefinition(resourceAfter, task, result);
Object valueAfter = resourceAfter.asObjectable().getAdditionalConnector().get(0)
.getConnectorConfiguration().asPrismContainerValue()
.findContainer(SchemaConstants.ICF_CONFIGURATION_PROPERTIES).getValue()
.findProperty(SCRIPT_RUNNER_INSTANCE_ID).getRealValue();
assertThat(valueAfter).as("property value after").isEqualTo(expected);
}
}
6 changes: 4 additions & 2 deletions ...sioning-api/src/main/java/com/evolveum/midpoint/provisioning/api/ProvisioningService.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -437,10 +437,12 @@ <T extends ObjectType> void applyDefinition(ObjectDelta<T> delta, Task task, Ope
throws SchemaException, ObjectNotFoundException, CommunicationException, ConfigurationException, ExpressionEvaluationException;

/**
* Applies appropriate definition to the shadow/resource delta (uses provided object to get necessary information)
* Applies appropriate definition to the shadow/resource delta. The provided object is used to get necessary information,
* and it's (sometimes) updated as well. TODO this should be specified better
*/
<T extends ObjectType> void applyDefinition(ObjectDelta<T> delta, Objectable object, Task task, OperationResult parentResult)
throws SchemaException, ObjectNotFoundException, CommunicationException, ConfigurationException, ExpressionEvaluationException;
throws SchemaException, ObjectNotFoundException, CommunicationException, ConfigurationException,
ExpressionEvaluationException;

/**
* Applies appropriate definition to the shadow.
Expand Down
4 changes: 2 additions & 2 deletions ...isioning-impl/src/main/java/com/evolveum/midpoint/provisioning/impl/ConnectorManager.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -305,9 +305,9 @@ private void configureConnector(ConnectorInstance connector, ConnectorSpec conne
connector.configure(connectorConfigurationVal, ResourceTypeUtil.getSchemaGenerationConstraints(connectorSpec.getResource()), result);

ResourceSchema resourceSchema = RefinedResourceSchemaImpl.getResourceSchema(connectorSpec.getResource(), prismContext);
Collection<Object> capabilities = ResourceTypeUtil.getNativeCapabilitiesCollection(connectorSpec.getResource().asObjectable());
Collection<Object> capabilities = ResourceTypeUtil.getNativeCapabilitiesCollection(connectorSpec.getResource());

connector.initialize(resourceSchema, capabilities, ResourceTypeUtil.isCaseIgnoreAttributeNames(connectorSpec.getResource().asObjectable()), result);
connector.initialize(resourceSchema, capabilities, ResourceTypeUtil.isCaseIgnoreAttributeNames(connectorSpec.getResource()), result);
} catch (GenericFrameworkException e) {
// Not expected. Transform to system exception
result.recordFatalError("Generic provisioning framework error", e);
Expand Down

0 comments on commit 28936e5

Please sign in to comment.