Add missing identifier for list node in fields RESTCONF query
[netconf.git] / restconf / restconf-nb / src / test / java / org / opendaylight / restconf / nb / rfc8040 / utils / parser / NetconfFieldsTranslatorTest.java
1 /*
2  * Copyright © 2020 FRINX s.r.o. and others.  All rights reserved.
3  * Copyright © 2021 PANTHEON.tech, s.r.o.
4  *
5  * This program and the accompanying materials are made available under the
6  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
7  * and is available at http://www.eclipse.org/legal/epl-v10.html
8  */
9 package org.opendaylight.restconf.nb.rfc8040.utils.parser;
10
11 import static org.hamcrest.CoreMatchers.instanceOf;
12 import static org.hamcrest.MatcherAssert.assertThat;
13 import static org.junit.Assert.assertEquals;
14
15 import java.util.List;
16 import org.junit.runner.RunWith;
17 import org.mockito.junit.MockitoJUnitRunner;
18 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
19 import org.opendaylight.restconf.nb.rfc8040.FieldsParam;
20 import org.opendaylight.yangtools.yang.common.QName;
21 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
22 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
25
26 /**
27  * Unit test for {@link NetconfFieldsTranslator}.
28  */
29 @RunWith(MockitoJUnitRunner.class)
30 public class NetconfFieldsTranslatorTest extends AbstractFieldsTranslatorTest<YangInstanceIdentifier> {
31     @Override
32     protected List<YangInstanceIdentifier> translateFields(final InstanceIdentifierContext context,
33             final FieldsParam fields) {
34         return NetconfFieldsTranslator.translate(context, fields);
35     }
36
37     @Override
38     protected void assertSimplePath(final List<YangInstanceIdentifier> result) {
39         assertEquals(1, result.size());
40         final var pathArguments = result.get(0).getPathArguments();
41         assertEquals(1, pathArguments.size());
42         assertEquals(LIBRARY_Q_NAME, pathArguments.get(0).getNodeType());
43     }
44
45     @Override
46     protected void assertKeyedList(List<YangInstanceIdentifier> result) {
47         assertEquals(1, result.size());
48     }
49
50     @Override
51     protected void assertDoublePath(final List<YangInstanceIdentifier> result) {
52         assertEquals(2, result.size());
53
54         final var libraryPath = assertPath(result, LIBRARY_Q_NAME);
55         assertEquals(1, libraryPath.getPathArguments().size());
56
57         final var playerPath = assertPath(result, PLAYER_Q_NAME);
58         assertEquals(1, playerPath.getPathArguments().size());
59     }
60
61     @Override
62     protected void assertSubPath(final List<YangInstanceIdentifier> result) {
63         assertEquals(1, result.size());
64         final var pathArguments = result.get(0).getPathArguments();
65         assertEquals(6, pathArguments.size());
66         assertEquals(LIBRARY_Q_NAME, pathArguments.get(0).getNodeType());
67         assertEquals(ARTIST_Q_NAME, pathArguments.get(1).getNodeType());
68         assertEquals(ARTIST_Q_NAME, pathArguments.get(2).getNodeType());
69         assertEquals(ALBUM_Q_NAME, pathArguments.get(3).getNodeType());
70         assertEquals(ALBUM_Q_NAME, pathArguments.get(4).getNodeType());
71         assertEquals(NAME_Q_NAME, pathArguments.get(5).getNodeType());
72     }
73
74     @Override
75     protected void assertChildrenPath(final List<YangInstanceIdentifier> result) {
76         assertEquals(1, result.size());
77         final var pathArguments = result.get(0).getPathArguments();
78         assertEquals(6, pathArguments.size());
79         assertEquals(LIBRARY_Q_NAME, pathArguments.get(0).getNodeType());
80         assertEquals(ARTIST_Q_NAME, pathArguments.get(1).getNodeType());
81         assertEquals(ARTIST_Q_NAME, pathArguments.get(2).getNodeType());
82         assertEquals(ALBUM_Q_NAME, pathArguments.get(3).getNodeType());
83         assertEquals(ALBUM_Q_NAME, pathArguments.get(4).getNodeType());
84         assertEquals(NAME_Q_NAME, pathArguments.get(5).getNodeType());
85     }
86
87     @Override
88     protected void assertNamespace(final List<YangInstanceIdentifier> result) {
89         assertEquals(1, result.size());
90         final var augmentedLibraryPath = assertPath(result, AUGMENTED_LIBRARY_Q_NAME);
91         assertEquals(2, augmentedLibraryPath.getPathArguments().size());
92     }
93
94     @Override
95     protected void assertMultipleChildren1(final List<YangInstanceIdentifier> result) {
96         assertEquals(3, result.size());
97
98         final var tosPath = assertPath(result, TYPE_OF_SERVICE_Q_NAME);
99         assertEquals(3, tosPath.getPathArguments().size());
100
101         final var instanceNamePath = assertPath(result, INSTANCE_NAME_Q_NAME);
102         assertEquals(5, instanceNamePath.getPathArguments().size());
103
104         final var providerPath = assertPath(result, PROVIDER_Q_NAME);
105         assertEquals(5, providerPath.getPathArguments().size());
106     }
107
108     @Override
109     protected void assertMultipleChildren2(final List<YangInstanceIdentifier> result) {
110         assertEquals(3, result.size());
111
112         final var tosPath = assertPath(result, TYPE_OF_SERVICE_Q_NAME);
113         assertEquals(3, tosPath.getPathArguments().size());
114
115         final var instanceNamePath = assertPath(result, INSTANCE_NAME_Q_NAME);
116         assertEquals(5, instanceNamePath.getPathArguments().size());
117
118         final var providerPath = assertPath(result, PROVIDER_Q_NAME);
119         assertEquals(5, providerPath.getPathArguments().size());
120     }
121
122     @Override
123     protected void assertMultipleChildren3(final List<YangInstanceIdentifier> result) {
124         assertEquals(3, result.size());
125
126         final var instanceNamePath = assertPath(result, INSTANCE_NAME_Q_NAME);
127         assertEquals(5, instanceNamePath.getPathArguments().size());
128
129         final var tosPath = assertPath(result, TYPE_OF_SERVICE_Q_NAME);
130         assertEquals(3, tosPath.getPathArguments().size());
131
132         final var nextServicePath = assertPath(result, NEXT_SERVICE_Q_NAME);
133         assertEquals(4, nextServicePath.getPathArguments().size());
134     }
135
136     @Override
137     protected void assertMultipleChildren4(final List<YangInstanceIdentifier> result) {
138         assertEquals(4, result.size());
139
140         final var instanceNamePath = assertPath(result, INSTANCE_NAME_Q_NAME);
141         assertEquals(5, instanceNamePath.getPathArguments().size());
142
143         final var tosPath = assertPath(result, TYPE_OF_SERVICE_Q_NAME);
144         assertEquals(3, tosPath.getPathArguments().size());
145
146         final var nextServicePath = assertPath(result, NEXT_SERVICE_Q_NAME);
147         assertEquals(4, nextServicePath.getPathArguments().size());
148
149         final var providerPath = assertPath(result, PROVIDER_Q_NAME);
150         assertEquals(5, providerPath.getPathArguments().size());
151     }
152
153     @Override
154     protected void assertMultipleChildren5(final List<YangInstanceIdentifier> result) {
155         assertEquals(4, result.size());
156
157         final var instanceNamePath = assertPath(result, INSTANCE_NAME_Q_NAME);
158         assertEquals(5, instanceNamePath.getPathArguments().size());
159
160         final var tosPath = assertPath(result, TYPE_OF_SERVICE_Q_NAME);
161         assertEquals(3, tosPath.getPathArguments().size());
162
163         final var nextServicePath = assertPath(result, NEXT_SERVICE_Q_NAME);
164         assertEquals(4, nextServicePath.getPathArguments().size());
165
166         final var providerPath = assertPath(result, PROVIDER_Q_NAME);
167         assertEquals(5, providerPath.getPathArguments().size());
168     }
169
170     @Override
171     protected void assertAugmentedChild(final List<YangInstanceIdentifier> result) {
172         assertEquals(1, result.size());
173         final var pathArguments = result.get(0).getPathArguments();
174
175         assertEquals(3, pathArguments.size());
176         assertEquals(PLAYER_Q_NAME, pathArguments.get(0).getNodeType());
177         assertThat(pathArguments.get(1), instanceOf(AugmentationIdentifier.class));
178         assertEquals(SPEED_Q_NAME, pathArguments.get(2).getNodeType());
179     }
180
181     @Override
182     protected void assertListFieldUnderList(final List<YangInstanceIdentifier> result) {
183         assertEquals(1, result.size());
184         assertEquals(List.of(
185             NodeIdentifier.create(SERVICES_Q_NAME),
186             NodeIdentifierWithPredicates.of(SERVICES_Q_NAME),
187             NodeIdentifier.create(INSTANCE_Q_NAME),
188             NodeIdentifierWithPredicates.of(INSTANCE_Q_NAME)),
189             result.get(0).getPathArguments());
190     }
191
192     @Override
193     protected void assertLeafList(final List<YangInstanceIdentifier> parsedFields) {
194         assertEquals(1, parsedFields.size());
195         assertEquals(List.of(new NodeIdentifier(PROTOCOLS_Q_NAME)), parsedFields.get(0).getPathArguments());
196     }
197
198     private static YangInstanceIdentifier assertPath(final List<YangInstanceIdentifier> paths, final QName lastArg) {
199         return paths.stream()
200             .filter(path -> lastArg.equals(path.getLastPathArgument().getNodeType()))
201             .findAny()
202             .orElseThrow(() -> new AssertionError("Path ending with " + lastArg + " not found"));
203     }
204 }