2 * Copyright (c) 2014 Brocade Communications Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.netconf.sal.rest.doc.impl;
10 import static org.junit.Assert.assertEquals;
11 import static org.junit.Assert.assertNotNull;
12 import static org.mockito.Mockito.mock;
13 import static org.mockito.Mockito.when;
15 import com.fasterxml.jackson.databind.JsonNode;
16 import com.fasterxml.jackson.databind.node.ObjectNode;
17 import java.util.Iterator;
19 import java.util.Optional;
21 import java.util.TreeSet;
22 import javax.ws.rs.core.UriInfo;
23 import org.junit.Before;
24 import org.junit.Test;
25 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
26 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
27 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
28 import org.opendaylight.netconf.sal.rest.doc.impl.ApiDocServiceImpl.OAversion;
29 import org.opendaylight.netconf.sal.rest.doc.mountpoints.MountPointSwagger;
30 import org.opendaylight.netconf.sal.rest.doc.swagger.SwaggerObject;
31 import org.opendaylight.yangtools.yang.common.QName;
32 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
34 public final class MountPointSwaggerTest extends AbstractApiDocTest {
35 private static final String HTTP_URL = "http://localhost/path";
36 private static final YangInstanceIdentifier INSTANCE_ID = YangInstanceIdentifier.builder()
37 .node(QName.create("", "nodes"))
38 .node(QName.create("", "node"))
39 .nodeWithKey(QName.create("", "node"), QName.create("", "id"), "123").build();
40 private static final String INSTANCE_URL = "/nodes/node=123/";
42 private MountPointSwagger swagger;
45 public void before() {
46 // We are sharing the global schema service and the mount schema service
48 // OK for testing - real thing would have separate instances.
49 final DOMMountPoint mountPoint = mock(DOMMountPoint.class);
50 when(mountPoint.getService(DOMSchemaService.class)).thenReturn(Optional.of(SCHEMA_SERVICE));
52 final DOMMountPointService service = mock(DOMMountPointService.class);
53 when(service.getMountPoint(INSTANCE_ID)).thenReturn(Optional.of(mountPoint));
55 swagger = new MountPointSwaggerGeneratorRFC8040(SCHEMA_SERVICE, service).getMountPointSwagger();
59 public void getInstanceIdentifiers() {
60 assertEquals(0, swagger.getInstanceIdentifiers().size());
61 swagger.onMountPointCreated(INSTANCE_ID); // add this ID into the list of mount points
62 assertEquals(1, swagger.getInstanceIdentifiers().size());
63 assertEquals((Long) 1L, swagger.getInstanceIdentifiers().entrySet().iterator().next()
65 assertEquals(INSTANCE_URL, swagger.getInstanceIdentifiers().entrySet().iterator().next()
67 swagger.onMountPointRemoved(INSTANCE_ID); // remove ID from list of mount points
68 assertEquals(0, swagger.getInstanceIdentifiers().size());
72 public void testGetDataStoreApi() throws Exception {
73 final UriInfo mockInfo = DocGenTestHelper.createMockUriInfo(HTTP_URL);
74 swagger.onMountPointCreated(INSTANCE_ID); // add this ID into the list of mount points
76 final SwaggerObject mountPointApi = (SwaggerObject) swagger.getMountPointApi(mockInfo, 1L, "Datastores", "-",
78 assertNotNull("failed to find Datastore API", mountPointApi);
80 final ObjectNode pathsObject = mountPointApi.getPaths();
81 assertNotNull(pathsObject);
83 assertEquals("Unexpected api list size", 2, pathsObject.size());
85 final Set<String> actualUrls = new TreeSet<>();
87 final Iterator<Map.Entry<String, JsonNode>> fields = pathsObject.fields();
88 while (fields.hasNext()) {
89 final Map.Entry<String, JsonNode> field = fields.next();
90 final String path = field.getKey();
91 final JsonNode operations = field.getValue();
92 actualUrls.add(field.getKey());
93 assertEquals("unexpected operations size on " + path, 1, operations.size());
95 final JsonNode getOperation = operations.get("get");
97 assertNotNull("unexpected operation method on " + path, getOperation);
99 assertNotNull("expected non-null desc on " + path, getOperation.get("description"));
102 assertEquals(Set.of("/rests/data" + INSTANCE_URL + "yang-ext:mount",
103 "/rests/operations" + INSTANCE_URL + "yang-ext:mount"), actualUrls);