import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
-import com.google.common.base.Optional;
-import java.net.URISyntaxException;
-import java.util.Arrays;
-import java.util.List;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import java.util.Iterator;
+import java.util.Map;
+import java.util.Optional;
import java.util.Set;
import java.util.TreeSet;
import javax.ws.rs.core.UriInfo;
import org.junit.Before;
import org.junit.Test;
-import org.opendaylight.controller.md.sal.dom.api.DOMMountPoint;
-import org.opendaylight.controller.md.sal.dom.api.DOMMountPointService;
-import org.opendaylight.controller.sal.core.api.model.SchemaService;
+import org.opendaylight.mdsal.dom.api.DOMMountPoint;
+import org.opendaylight.mdsal.dom.api.DOMMountPointService;
+import org.opendaylight.mdsal.dom.api.DOMSchemaService;
+import org.opendaylight.netconf.sal.rest.doc.impl.ApiDocServiceImpl.OAversion;
+import org.opendaylight.netconf.sal.rest.doc.impl.MountPointSwaggerGeneratorRFC8040;
import org.opendaylight.netconf.sal.rest.doc.mountpoints.MountPointSwagger;
-import org.opendaylight.netconf.sal.rest.doc.swagger.Api;
-import org.opendaylight.netconf.sal.rest.doc.swagger.ApiDeclaration;
-import org.opendaylight.netconf.sal.rest.doc.swagger.Operation;
-import org.opendaylight.netconf.sal.rest.doc.swagger.Resource;
-import org.opendaylight.netconf.sal.rest.doc.swagger.ResourceList;
+import org.opendaylight.netconf.sal.rest.doc.swagger.SwaggerObject;
import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
-import org.opendaylight.yangtools.yang.model.api.SchemaContext;
-
-public class MountPointSwaggerTest {
+public final class MountPointSwaggerTest extends AbstractApiDocTest {
private static final String HTTP_URL = "http://localhost/path";
private static final YangInstanceIdentifier INSTANCE_ID = YangInstanceIdentifier.builder()
- .node(QName.create("nodes"))
- .node(QName.create("node"))
- .nodeWithKey(QName.create("node"), QName.create("id"), "123").build();
- private static final String INSTANCE_URL = "/nodes/node/123/";
+ .node(QName.create("", "nodes"))
+ .node(QName.create("", "node"))
+ .nodeWithKey(QName.create("", "node"), QName.create("", "id"), "123").build();
+ private static final String INSTANCE_URL = "/nodes/node=123/";
+
private MountPointSwagger swagger;
- private DocGenTestHelper helper;
- private SchemaContext schemaContext;
@Before
- public void setUp() throws Exception {
- this.swagger = new MountPointSwagger();
- this.helper = new DocGenTestHelper();
- this.helper.setUp();
- this.schemaContext = this.helper.getSchemaContext();
- }
+ public void before() {
+ // We are sharing the global schema service and the mount schema service
+ // in our test.
+ // OK for testing - real thing would have separate instances.
+ final DOMMountPoint mountPoint = mock(DOMMountPoint.class);
+ when(mountPoint.getService(DOMSchemaService.class)).thenReturn(Optional.of(SCHEMA_SERVICE));
- @Test()
- public void testGetResourceListBadIid() throws Exception {
- final UriInfo mockInfo = this.helper.createMockUriInfo(HTTP_URL);
+ final DOMMountPointService service = mock(DOMMountPointService.class);
+ when(service.getMountPoint(INSTANCE_ID)).thenReturn(Optional.of(mountPoint));
- assertEquals(null, this.swagger.getResourceList(mockInfo, 1L));
+ swagger = new MountPointSwaggerGeneratorRFC8040(SCHEMA_SERVICE, service).getMountPointSwagger();
}
@Test()
- public void getInstanceIdentifiers() throws Exception {
- final UriInfo mockInfo = setUpSwaggerForDocGeneration();
-
- assertEquals(0, this.swagger.getInstanceIdentifiers().size());
- this.swagger.onMountPointCreated(INSTANCE_ID); // add this ID into the list of
- // mount points
- assertEquals(1, this.swagger.getInstanceIdentifiers().size());
- assertEquals((Long) 1L, this.swagger.getInstanceIdentifiers().entrySet().iterator().next()
+ public void getInstanceIdentifiers() {
+ assertEquals(0, swagger.getInstanceIdentifiers().size());
+ swagger.onMountPointCreated(INSTANCE_ID); // add this ID into the list of mount points
+ assertEquals(1, swagger.getInstanceIdentifiers().size());
+ assertEquals((Long) 1L, swagger.getInstanceIdentifiers().entrySet().iterator().next()
.getValue());
- assertEquals(INSTANCE_URL, this.swagger.getInstanceIdentifiers().entrySet().iterator().next()
+ assertEquals(INSTANCE_URL, swagger.getInstanceIdentifiers().entrySet().iterator().next()
.getKey());
- this.swagger.onMountPointRemoved(INSTANCE_ID); // remove ID from list of mount
- // points
- assertEquals(0, this.swagger.getInstanceIdentifiers().size());
- }
-
- @Test
- public void testGetResourceListGoodId() throws Exception {
- final UriInfo mockInfo = setUpSwaggerForDocGeneration();
- this.swagger.onMountPointCreated(INSTANCE_ID); // add this ID into the list of
- // mount points
- final ResourceList resourceList = this.swagger.getResourceList(mockInfo, 1L);
-
- Resource dataStoreResource = null;
- for (final Resource r : resourceList.getApis()) {
- if (r.getPath().endsWith("/Datastores(-)")) {
- dataStoreResource = r;
- }
- }
- assertNotNull("Failed to find data store resource", dataStoreResource);
+ swagger.onMountPointRemoved(INSTANCE_ID); // remove ID from list of mount points
+ assertEquals(0, swagger.getInstanceIdentifiers().size());
}
@Test
public void testGetDataStoreApi() throws Exception {
- final UriInfo mockInfo = setUpSwaggerForDocGeneration();
- this.swagger.onMountPointCreated(INSTANCE_ID); // add this ID into the list of
- // mount points
+ final UriInfo mockInfo = DocGenTestHelper.createMockUriInfo(HTTP_URL);
+ swagger.onMountPointCreated(INSTANCE_ID); // add this ID into the list of mount points
- final ApiDeclaration mountPointApi = this.swagger.getMountPointApi(mockInfo, 1L, "Datastores", "-");
+ final SwaggerObject mountPointApi = (SwaggerObject) swagger.getMountPointApi(mockInfo, 1L, "Datastores", "-",
+ OAversion.V2_0);
assertNotNull("failed to find Datastore API", mountPointApi);
- final List<Api> apis = mountPointApi.getApis();
- assertEquals("Unexpected api list size", 3, apis.size());
-
- final Set<String> actualApis = new TreeSet<>();
- for (final Api api : apis) {
- actualApis.add(api.getPath());
- final List<Operation> operations = api.getOperations();
- assertEquals("unexpected operation size on " + api.getPath(), 1, operations.size());
- assertEquals("unexpected operation method " + api.getPath(), "GET", operations.get(0)
- .getMethod());
- assertNotNull("expected non-null desc on " + api.getPath(), operations.get(0)
- .getNotes());
- }
- final Set<String> expectedApis = new TreeSet<>(Arrays.asList(new String[] {
- "/config" + INSTANCE_URL + "yang-ext:mount",
- "/operational" + INSTANCE_URL + "yang-ext:mount",
- "/operations" + INSTANCE_URL + "yang-ext:mount",}));
- assertEquals(expectedApis, actualApis);
- }
- protected UriInfo setUpSwaggerForDocGeneration() throws URISyntaxException {
- final UriInfo mockInfo = this.helper.createMockUriInfo(HTTP_URL);
- // We are sharing the global schema service and the mount schema service
- // in our test.
- // OK for testing - real thing would have seperate instances.
- final SchemaContext context = this.helper.createMockSchemaContext();
- final SchemaService schemaService = this.helper.createMockSchemaService(context);
+ final ObjectNode pathsObject = mountPointApi.getPaths();
+ assertNotNull(pathsObject);
- final DOMMountPoint mountPoint = mock(DOMMountPoint.class);
- when(mountPoint.getSchemaContext()).thenReturn(context);
+ assertEquals("Unexpected api list size", 2, pathsObject.size());
- final DOMMountPointService service = mock(DOMMountPointService.class);
- when(service.getMountPoint(INSTANCE_ID)).thenReturn(Optional.of(mountPoint));
- this.swagger.setMountService(service);
- this.swagger.setGlobalSchema(schemaService);
+ final Set<String> actualUrls = new TreeSet<>();
- return mockInfo;
- }
+ final Iterator<Map.Entry<String, JsonNode>> fields = pathsObject.fields();
+ while (fields.hasNext()) {
+ final Map.Entry<String, JsonNode> field = fields.next();
+ final String path = field.getKey();
+ final JsonNode operations = field.getValue();
+ actualUrls.add(field.getKey());
+ assertEquals("unexpected operations size on " + path, 1, operations.size());
+
+ final JsonNode getOperation = operations.get("get");
+
+ assertNotNull("unexpected operation method on " + path, getOperation);
+ assertNotNull("expected non-null desc on " + path, getOperation.get("description"));
+ }
+
+ assertEquals(Set.of("/rests/data" + INSTANCE_URL + "yang-ext:mount",
+ "/rests/operations" + INSTANCE_URL + "yang-ext:mount"), actualUrls);
+ }
}
Code Review / netconf.git / blobdiff