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.controller.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;
18 import java.util.List;
20 import java.util.Optional;
22 import java.util.TreeSet;
23 import javax.ws.rs.core.UriInfo;
24 import org.junit.Before;
25 import org.junit.Test;
26 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
27 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
28 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
29 import org.opendaylight.netconf.sal.rest.doc.impl.ApiDocServiceImpl.OAversion;
30 import org.opendaylight.netconf.sal.rest.doc.impl.ApiDocServiceImpl.URIType;
31 import org.opendaylight.netconf.sal.rest.doc.impl.MountPointSwaggerGeneratorDraft02;
32 import org.opendaylight.netconf.sal.rest.doc.mountpoints.MountPointSwagger;
33 import org.opendaylight.netconf.sal.rest.doc.swagger.SwaggerObject;
34 import org.opendaylight.yangtools.yang.common.QName;
35 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
37 public final class MountPointSwaggerTest extends AbstractApiDocTest {
38 private static final String HTTP_URL = "http://localhost/path";
39 private static final YangInstanceIdentifier INSTANCE_ID = YangInstanceIdentifier.builder()
40 .node(QName.create("", "nodes"))
41 .node(QName.create("", "node"))
42 .nodeWithKey(QName.create("", "node"), QName.create("", "id"), "123").build();
43 private static final String INSTANCE_URL = "/nodes/node/123/";
45 private MountPointSwagger swagger;
48 public void before() {
49 // We are sharing the global schema service and the mount schema service
51 // OK for testing - real thing would have separate instances.
52 final DOMMountPoint mountPoint = mock(DOMMountPoint.class);
53 when(mountPoint.getService(DOMSchemaService.class)).thenReturn(Optional.of(SCHEMA_SERVICE));
55 final DOMMountPointService service = mock(DOMMountPointService.class);
56 when(service.getMountPoint(INSTANCE_ID)).thenReturn(Optional.of(mountPoint));
58 swagger = new MountPointSwaggerGeneratorDraft02(SCHEMA_SERVICE, service).getMountPointSwagger();
62 public void getInstanceIdentifiers() {
63 assertEquals(0, swagger.getInstanceIdentifiers().size());
64 swagger.onMountPointCreated(INSTANCE_ID); // add this ID into the list of mount points
65 assertEquals(1, swagger.getInstanceIdentifiers().size());
66 assertEquals((Long) 1L, swagger.getInstanceIdentifiers().entrySet().iterator().next()
68 assertEquals(INSTANCE_URL, swagger.getInstanceIdentifiers().entrySet().iterator().next()
70 swagger.onMountPointRemoved(INSTANCE_ID); // remove ID from list of mount points
71 assertEquals(0, swagger.getInstanceIdentifiers().size());
75 public void testGetDataStoreApi() throws Exception {
76 final UriInfo mockInfo = DocGenTestHelper.createMockUriInfo(HTTP_URL);
77 swagger.onMountPointCreated(INSTANCE_ID); // add this ID into the list of mount points
79 final SwaggerObject mountPointApi = (SwaggerObject) swagger.getMountPointApi(mockInfo, 1L, "Datastores",
80 "-", URIType.DRAFT02, OAversion.V2_0);
81 assertNotNull("failed to find Datastore API", mountPointApi);
83 final ObjectNode pathsObject = mountPointApi.getPaths();
84 assertNotNull(pathsObject);
86 assertEquals("Unexpected api list size", 3, pathsObject.size());
88 final Set<String> actualUrls = new TreeSet<>();
90 final Iterator<Map.Entry<String, JsonNode>> fields = pathsObject.fields();
91 while (fields.hasNext()) {
92 final Map.Entry<String, JsonNode> field = fields.next();
93 final String path = field.getKey();
94 final JsonNode operations = field.getValue();
95 actualUrls.add(field.getKey());
96 assertEquals("unexpected operations size on " + path, 1, operations.size());
98 final JsonNode getOperation = operations.get("get");
100 assertNotNull("unexpected operation method on " + path, getOperation);
102 assertNotNull("expected non-null desc on " + path, getOperation.get("description"));
105 final Set<String> expectedUrls = new TreeSet<>(List.of(
106 "/restconf/config" + INSTANCE_URL + "yang-ext:mount",
107 "/restconf/operational" + INSTANCE_URL + "yang-ext:mount",
108 "/restconf/operations" + INSTANCE_URL + "yang-ext:mount"));
109 assertEquals(expectedUrls, actualUrls);