NIFI-824: When calling TestRunner.removeProperty with a required property, the property's value should be set to the default, or null if no default exists

nifi-mock/pom.xml

@@ -38,6 +38,11 @@
             <groupId>org.apache.nifi</groupId>
             <artifactId>nifi-data-provenance-utils</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.apache.nifi</groupId>
+            <artifactId>nifi-processor-utils</artifactId>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <!-- Dependency marked as provided, not test, because we have assertion 
             methods in our MockSession & MockFlowFile -->

nifi-mock/src/main/java/org/apache/nifi/util/MockProcessContext.java

@@ -132,8 +132,12 @@ public class MockProcessContext extends MockControllerServiceLookup implements S
         Objects.requireNonNull(descriptor);
         final PropertyDescriptor fullyPopulatedDescriptor = component.getPropertyDescriptor(descriptor.getName());
         String value = null;
-        if (!fullyPopulatedDescriptor.isRequired() && (value = properties.remove(fullyPopulatedDescriptor)) != null) {
+
-            component.onPropertyModified(fullyPopulatedDescriptor, value, null);
+        if ((value = properties.remove(fullyPopulatedDescriptor)) != null) {
+            if (!value.equals(fullyPopulatedDescriptor.getDefaultValue())) {
+                component.onPropertyModified(fullyPopulatedDescriptor, value, null);
+            }
+
             return true;
         }
         return false;
@@ -266,6 +270,7 @@ public class MockProcessContext extends MockControllerServiceLookup implements S
     public void leaseControllerService(final String identifier) {
     }
 
+    @Override
     public Set<Relationship> getAvailableRelationships() {
         if (!(component instanceof Processor)) {
             return Collections.emptySet();

nifi-mock/src/main/java/org/apache/nifi/util/TestRunner.java

@@ -742,10 +742,10 @@ public interface TestRunner {
 
     /**
      * Removes the {@link PropertyDescriptor} from the {@link ProcessContext},
-     * effectively setting its value to null.
+     * effectively setting its value to null, or the property's default value, if it has one.
      *
      * @param descriptor of property to remove
-     * @return true if removed
+     * @return <code>true</code> if removed, <code>false</code> if the property was not set
      */
     boolean removeProperty(PropertyDescriptor descriptor);
 

nifi-mock/src/test/java/org/apache/nifi/util/TestMockProcessContext.java

@@ -0,0 +1,126 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.nifi.util;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertNull;
+import static org.junit.Assert.assertTrue;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import org.apache.nifi.components.PropertyDescriptor;
+import org.apache.nifi.processor.AbstractProcessor;
+import org.apache.nifi.processor.ProcessContext;
+import org.apache.nifi.processor.ProcessSession;
+import org.apache.nifi.processor.exception.ProcessException;
+import org.apache.nifi.processor.util.StandardValidators;
+import org.junit.Test;
+
+public class TestMockProcessContext {
+
+    @Test
+    public void testRemoveProperty() {
+        final DummyProcessor proc = new DummyProcessor();
+        final MockProcessContext context = new MockProcessContext(proc);
+        context.setProperty(DummyProcessor.REQUIRED_PROP, "req-value");
+        context.setProperty(DummyProcessor.OPTIONAL_PROP, "opt-value");
+        context.setProperty(DummyProcessor.DEFAULTED_PROP, "custom-value");
+
+        assertEquals(1, proc.getUpdateCount(DummyProcessor.REQUIRED_PROP));
+        assertEquals(1, proc.getUpdateCount(DummyProcessor.OPTIONAL_PROP));
+        assertEquals(1, proc.getUpdateCount(DummyProcessor.DEFAULTED_PROP));
+
+        assertTrue(context.removeProperty(DummyProcessor.OPTIONAL_PROP));
+        assertNull(context.getProperty(DummyProcessor.OPTIONAL_PROP).getValue());
+        assertFalse(context.removeProperty(DummyProcessor.OPTIONAL_PROP));
+        assertEquals(2, proc.getUpdateCount(DummyProcessor.OPTIONAL_PROP));
+
+        assertTrue(context.removeProperty(DummyProcessor.REQUIRED_PROP));
+        assertNull(context.getProperty(DummyProcessor.REQUIRED_PROP).getValue());
+        assertFalse(context.removeProperty(DummyProcessor.REQUIRED_PROP));
+        assertEquals(2, proc.getUpdateCount(DummyProcessor.REQUIRED_PROP));
+
+        assertTrue(context.removeProperty(DummyProcessor.DEFAULTED_PROP));
+        assertEquals("default-value", context.getProperty(DummyProcessor.DEFAULTED_PROP).getValue());
+        assertFalse(context.removeProperty(DummyProcessor.DEFAULTED_PROP));
+        assertEquals(2, proc.getUpdateCount(DummyProcessor.DEFAULTED_PROP));
+
+        // Since value is already the default, this shouldn't trigger onPropertyModified to be called.
+        context.setProperty(DummyProcessor.DEFAULTED_PROP, DummyProcessor.DEFAULTED_PROP.getDefaultValue());
+        assertEquals(2, proc.getUpdateCount(DummyProcessor.DEFAULTED_PROP));
+
+        assertEquals("default-value", context.getProperty(DummyProcessor.DEFAULTED_PROP).getValue());
+        assertTrue(context.removeProperty(DummyProcessor.DEFAULTED_PROP));
+
+        // since we are calling remove on a property that has a default value, this shouldn't
+        // trigger the onPropertyModified method to be called.
+        assertEquals(2, proc.getUpdateCount(DummyProcessor.DEFAULTED_PROP));
+    }
+
+    private static class DummyProcessor extends AbstractProcessor {
+        static final PropertyDescriptor REQUIRED_PROP = new PropertyDescriptor.Builder()
+            .name("required")
+            .required(true)
+            .addValidator(StandardValidators.NON_EMPTY_VALIDATOR)
+            .build();
+        static final PropertyDescriptor DEFAULTED_PROP = new PropertyDescriptor.Builder()
+            .name("defaulted")
+            .required(true)
+            .addValidator(StandardValidators.NON_EMPTY_VALIDATOR)
+            .defaultValue("default-value")
+            .build();
+        static final PropertyDescriptor OPTIONAL_PROP = new PropertyDescriptor.Builder()
+            .name("optional")
+            .required(false)
+            .addValidator(StandardValidators.NON_EMPTY_VALIDATOR)
+            .build();
+
+        private final Map<PropertyDescriptor, Integer> propertyModifiedCount = new HashMap<>();
+
+        @Override
+        protected List<PropertyDescriptor> getSupportedPropertyDescriptors() {
+            final List<PropertyDescriptor> properties = new ArrayList<>();
+            properties.add(REQUIRED_PROP);
+            properties.add(DEFAULTED_PROP);
+            properties.add(OPTIONAL_PROP);
+            return properties;
+        }
+
+        @Override
+        public void onPropertyModified(final PropertyDescriptor descriptor, final String oldValue, final String newValue) {
+            Integer updateCount = propertyModifiedCount.get(descriptor);
+            if (updateCount == null) {
+                updateCount = 0;
+            }
+
+            propertyModifiedCount.put(descriptor, updateCount + 1);
+        }
+
+        public int getUpdateCount(final PropertyDescriptor descriptor) {
+            Integer updateCount = propertyModifiedCount.get(descriptor);
+            return (updateCount == null) ? 0 : updateCount;
+        }
+
+        @Override
+        public void onTrigger(final ProcessContext context, final ProcessSession session) throws ProcessException {
+        }
+    }
+}