Do not report failure on empty action output

When an action invocation results in an empty container
we should be emitting a normal 204 response, not go through
the error path -- as per RFC8040 section 6.3.

JIRA: NETCONF-799
Change-Id: Ie8f3d098fc65828998b088bfed5ca89e2f438828
Signed-off-by: PeterSuna <Peter.Suna@pantheon.tech>
Signed-off-by: Ivan Hrasko <ivan.hrasko@pantheon.tech>
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
(cherry picked from commit 916a6a5cb7e3ac5148f9cf6bb1a24bf7298ea9f6)

diff --git a/restconf/restconf-nb-rfc8040/src/main/java/org/opendaylight/restconf/nb/rfc8040/rests/services/impl/RestconfDataServiceImpl.java b/restconf/restconf-nb-rfc8040/src/main/java/org/opendaylight/restconf/nb/rfc8040/rests/services/impl/RestconfDataServiceImpl.java
index 1dd7ac400bbfd866b6408cc3b20e2bfab3fccbd3..8b020cff5896daa0aab14a511cd1ee0448b06554 100644 (file)
--- a/restconf/restconf-nb-rfc8040/src/main/java/org/opendaylight/restconf/nb/rfc8040/rests/services/impl/RestconfDataServiceImpl.java
+++ b/restconf/restconf-nb-rfc8040/src/main/java/org/opendaylight/restconf/nb/rfc8040/rests/services/impl/RestconfDataServiceImpl.java
@@ -27,7 +27,6 @@ import java.util.Map.Entry;
 import java.util.Optional;
 import java.util.concurrent.ExecutionException;
 import javax.ws.rs.Path;
-import javax.ws.rs.WebApplicationException;
 import javax.ws.rs.core.Response;
 import javax.ws.rs.core.UriInfo;
 import org.eclipse.jdt.annotation.Nullable;
@@ -442,7 +441,7 @@ public class RestconfDataServiceImpl implements RestconfDataService {
         }
 
         if (resultData != null && resultData.getValue().isEmpty()) {
-            throw new WebApplicationException(Response.Status.NO_CONTENT);
+            return Response.status(Response.Status.NO_CONTENT).build();
         }
 
         return Response.status(200).entity(new NormalizedNodeContext(new InstanceIdentifierContext<>(yangIIdContext,

diff --git a/restconf/restconf-nb-rfc8040/src/test/java/org/opendaylight/restconf/nb/rfc8040/rests/services/impl/Netconf799Test.java b/restconf/restconf-nb-rfc8040/src/test/java/org/opendaylight/restconf/nb/rfc8040/rests/services/impl/Netconf799Test.java
new file mode 100644 (file)
index 0000000..d489dbf
--- /dev/null
+++ b/restconf/restconf-nb-rfc8040/src/test/java/org/opendaylight/restconf/nb/rfc8040/rests/services/impl/Netconf799Test.java
@@ -0,0 +1,103 @@
+/*
+ * Copyright (c) 2021 PANTHEON.tech s.r.o. All Rights Reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.restconf.nb.rfc8040.rests.services.impl;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNull;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.Mockito.doReturn;
+import static org.mockito.Mockito.mock;
+
+import com.google.common.util.concurrent.Futures;
+import java.io.FileNotFoundException;
+import java.util.Optional;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.junit.MockitoJUnitRunner;
+import org.opendaylight.mdsal.dom.api.DOMActionService;
+import org.opendaylight.mdsal.dom.api.DOMDataBroker;
+import org.opendaylight.mdsal.dom.api.DOMMountPointService;
+import org.opendaylight.mdsal.dom.api.DOMSchemaService;
+import org.opendaylight.mdsal.dom.spi.SimpleDOMActionResult;
+import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
+import org.opendaylight.restconf.common.context.NormalizedNodeContext;
+import org.opendaylight.restconf.nb.rfc8040.TestRestconfUtils;
+import org.opendaylight.restconf.nb.rfc8040.handlers.ActionServiceHandler;
+import org.opendaylight.restconf.nb.rfc8040.handlers.DOMMountPointServiceHandler;
+import org.opendaylight.restconf.nb.rfc8040.handlers.SchemaContextHandler;
+import org.opendaylight.restconf.nb.rfc8040.handlers.TransactionChainHandler;
+import org.opendaylight.restconf.nb.rfc8040.rests.services.api.RestconfStreamsSubscriptionService;
+import org.opendaylight.restconf.nb.rfc8040.streams.Configuration;
+import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.common.Uint32;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
+import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
+import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
+import org.opendaylight.yangtools.yang.data.util.DataSchemaContextNode;
+import org.opendaylight.yangtools.yang.data.util.DataSchemaContextTree;
+import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
+import org.opendaylight.yangtools.yang.model.api.ActionNodeContainer;
+import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
+import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
+import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
+
+@RunWith(MockitoJUnitRunner.StrictStubs.class)
+public class Netconf799Test {
+    private static final QName CONT_QNAME = QName.create("instance:identifier:module", "2014-01-17", "cont");
+    private static final QName CONT1_QNAME = QName.create(CONT_QNAME, "cont1");
+    private static final QName RESET_QNAME = QName.create(CONT_QNAME, "reset");
+
+    private static final QName DELAY_QNAME = QName.create(CONT_QNAME, "delay");
+    private static final QName INPUT_QNAME = QName.create(CONT_QNAME, "input");
+    private static final QName OUTPUT_QNAME = QName.create(CONT_QNAME, "output");
+    private static final YangInstanceIdentifier ACTION_YII = YangInstanceIdentifier.of(CONT_QNAME).node(CONT1_QNAME);
+
+    @Test
+    public void testInvokeAction() throws FileNotFoundException {
+        final EffectiveModelContext contextRef = YangParserTestUtils.parseYangFiles(
+            TestRestconfUtils.loadFiles("/instanceidentifier/yang"));
+
+        final DOMDataBroker mockDataBroker = mock(DOMDataBroker.class);
+        final SchemaContextHandler schemaContextHandler = new SchemaContextHandler(
+            new TransactionChainHandler(mockDataBroker), mock(DOMSchemaService.class));
+        schemaContextHandler.onModelContextUpdated(contextRef);
+
+        final DOMActionService actionService = mock(DOMActionService.class);
+        doReturn(Futures.immediateFuture(new SimpleDOMActionResult(
+            Builders.containerBuilder().withNodeIdentifier(NodeIdentifier.create(OUTPUT_QNAME)).build())))
+            .when(actionService).invokeAction(eq(Absolute.of(CONT_QNAME, CONT1_QNAME, RESET_QNAME)), any(), any());
+
+        final RestconfDataServiceImpl dataService = new RestconfDataServiceImpl(schemaContextHandler,
+            new TransactionChainHandler(mockDataBroker),
+            new DOMMountPointServiceHandler(mock(DOMMountPointService.class)),
+            mock(RestconfStreamsSubscriptionService.class), new ActionServiceHandler(actionService),
+            mock(Configuration.class));
+
+        final var schemaNode = loadAction(contextRef, RESET_QNAME, ACTION_YII).orElseThrow();
+        final var response = dataService.invokeAction(new NormalizedNodeContext(
+            new InstanceIdentifierContext<>(ACTION_YII, schemaNode, null, contextRef),
+            Builders.containerBuilder()
+                .withNodeIdentifier(NodeIdentifier.create(INPUT_QNAME))
+                .withChild(ImmutableNodes.leafNode(DELAY_QNAME, Uint32.TEN))
+                .build()));
+
+        assertEquals(204, response.getStatus());
+        assertNull(response.getEntity());
+    }
+
+    private static Optional<ActionDefinition> loadAction(final EffectiveModelContext modelContext,
+            final QName actionQName, final YangInstanceIdentifier actionYII) {
+        return DataSchemaContextTree.from(modelContext)
+            .findChild(actionYII)
+            .map(DataSchemaContextNode::getDataSchemaNode)
+            .flatMap(node -> node instanceof ActionNodeContainer ? ((ActionNodeContainer) node).findAction(actionQName)
+                : Optional.empty());
+    }
+}