• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

SpiNNakerManchester / JavaSpiNNaker / 6310285782

26 Sep 2023 08:47AM UTC coverage: 36.367% (-0.5%) from 36.866%
6310285782

Pull #658

github

dkfellows
Merge branch 'master' into java-17
Pull Request #658: Update Java version to 17 and JEE to 9

1675 of 1675 new or added lines in 266 files covered. (100.0%)

8368 of 23010 relevant lines covered (36.37%)

0.36 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

5.6
/SpiNNaker-allocserv/src/main/java/uk/ac/manchester/spinnaker/alloc/admin/AdminImpl.java
1
/*
2
 * Copyright (c) 2021 The University of Manchester
3
 *
4
 * Licensed under the Apache License, Version 2.0 (the "License");
5
 * you may not use this file except in compliance with the License.
6
 * You may obtain a copy of the License at
7
 *
8
 *     https://www.apache.org/licenses/LICENSE-2.0
9
 *
10
 * Unless required by applicable law or agreed to in writing, software
11
 * distributed under the License is distributed on an "AS IS" BASIS,
12
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
 * See the License for the specific language governing permissions and
14
 * limitations under the License.
15
 */
16
package uk.ac.manchester.spinnaker.alloc.admin;
17

18
import static jakarta.ws.rs.core.MediaType.APPLICATION_JSON;
19
import static jakarta.ws.rs.core.Response.created;
20
import static jakarta.ws.rs.core.Response.noContent;
21
import static jakarta.ws.rs.core.Response.Status.BAD_REQUEST;
22
import static jakarta.ws.rs.core.Response.Status.NOT_FOUND;
23
import static jakarta.ws.rs.core.Response.Status.NOT_MODIFIED;
24
import static java.util.stream.Collectors.toList;
25
import static org.slf4j.LoggerFactory.getLogger;
26
import static uk.ac.manchester.spinnaker.alloc.admin.AdminAPI.Paths.BASE_PATH;
27

28
import java.lang.reflect.Method;
29
import java.net.URI;
30
import java.util.Map;
31

32
import org.slf4j.Logger;
33
import org.springframework.beans.factory.annotation.Autowired;
34
import org.springframework.jmx.export.annotation.ManagedOperation;
35
import org.springframework.jmx.export.annotation.ManagedResource;
36
import org.springframework.stereotype.Service;
37

38
import io.swagger.v3.oas.annotations.Hidden;
39
import jakarta.ws.rs.Path;
40
import jakarta.ws.rs.WebApplicationException;
41
import jakarta.ws.rs.core.Response;
42
import jakarta.ws.rs.core.SecurityContext;
43
import jakarta.ws.rs.core.UriInfo;
44
import uk.ac.manchester.spinnaker.alloc.admin.MachineDefinitionLoader.Machine;
45
import uk.ac.manchester.spinnaker.alloc.model.GroupRecord;
46
import uk.ac.manchester.spinnaker.alloc.model.MemberRecord;
47
import uk.ac.manchester.spinnaker.alloc.model.UserRecord;
48
import uk.ac.manchester.spinnaker.alloc.web.RequestFailedException;
49
import uk.ac.manchester.spinnaker.machine.board.PhysicalCoords;
50
import uk.ac.manchester.spinnaker.machine.board.TriadCoords;
51

52
/**
53
 * Implements the service administration interface.
54
 *
55
 * @author Donal Fellows
56
 */
57
@Service("admin")
58
@Path(BASE_PATH)
59
@Hidden
60
@ManagedResource("Spalloc:type=Admin,name=admin")
61
public class AdminImpl implements AdminAPI {
1✔
62
        private static final Logger log = getLogger(AdminImpl.class);
1✔
63

64
        @Autowired
65
        private MachineDefinitionLoader loader;
66

67
        @Autowired
68
        private MachineStateControl machineController;
69

70
        @Autowired
71
        private UserControl userManager;
72

73
        @Override
74
        public void importMachinesByContent(
75
                        MachineDefinitionLoader.Configuration definitions) {
76
                log.warn("CALLED importMachinesByContent({})", definitions.machines()
×
77
                                .stream().map(Machine::getName).collect(toList()));
×
78
                loader.loadMachineDefinitions(definitions);
×
79
        }
×
80

81
        private static final Method DESCRIBE_GROUP;
82

83
        private static final Method DESCRIBE_USER;
84

85
        private static final Method DESCRIBE_MEMBER;
86

87
        static {
88
                try {
89
                        DESCRIBE_GROUP = AdminAPI.class.getMethod("describeGroup",
1✔
90
                                        int.class, UriInfo.class);
91
                        DESCRIBE_USER = AdminAPI.class.getMethod("describeUser", int.class,
1✔
92
                                        UriInfo.class);
93
                        DESCRIBE_MEMBER = AdminAPI.class.getMethod("describeMember",
1✔
94
                                        int.class, int.class, UriInfo.class);
95
                } catch (NoSuchMethodException | SecurityException e) {
×
96
                        throw new RuntimeException("failed to discover method signatures",
×
97
                                        e);
98
                }
1✔
99
        }
1✔
100

101
        private static WebApplicationException noBoard() {
102
                return new WebApplicationException("no such board", NOT_FOUND);
×
103
        }
104

105
        private static WebApplicationException noUser() {
106
                return new WebApplicationException("no such user", NOT_FOUND);
×
107
        }
108

109
        private static WebApplicationException noGroup() {
110
                return new WebApplicationException("no such group", NOT_FOUND);
×
111
        }
112

113
        private static WebApplicationException noMember() {
114
                return new WebApplicationException("no such membership", NOT_FOUND);
×
115
        }
116

117
        @Override
118
        public boolean getBoardStateXYZ(String name, int x, int y, int z) {
119
                log.info("CALLED boardState({}:XYZ=({},{},{}))", name, x, y, z);
×
120
                var board = machineController.findTriad(name, new TriadCoords(x, y, z))
×
121
                                .orElseThrow(AdminImpl::noBoard);
×
122
                return board.getState();
×
123
        }
124

125
        @Override
126
        @ManagedOperation
127
        public boolean setBoardStateXYZ(String name, int x, int y, int z,
128
                        boolean enabled) {
129
                log.warn("CALLED boardState({}:XYZ=({},{},{})) := {}", name, x, y, z,
×
130
                                enabled);
×
131
                var board = machineController.findTriad(name, new TriadCoords(x, y, z))
×
132
                                .orElseThrow(AdminImpl::noBoard);
×
133
                board.setState(enabled);
×
134
                return board.getState();
×
135
        }
136

137
        @Override
138
        public boolean getBoardStateCFB(String name, int c, int f, int b) {
139
                log.info("CALLED boardState({}:CFB=({},{},{}))", name, c, f, b);
×
140
                var board = machineController
×
141
                                .findPhysical(name, new PhysicalCoords(c, f, b))
×
142
                                .orElseThrow(AdminImpl::noBoard);
×
143
                return board.getState();
×
144
        }
145

146
        @Override
147
        @ManagedOperation
148
        public boolean setBoardStateCFB(String name, int c, int f, int b,
149
                        boolean enabled) {
150
                log.warn("CALLED boardState({}:CFB=({},{},{})) := {}", name, c, f, b,
×
151
                                enabled);
×
152
                var board = machineController
×
153
                                .findPhysical(name, new PhysicalCoords(c, f, b))
×
154
                                .orElseThrow(AdminImpl::noBoard);
×
155
                board.setState(enabled);
×
156
                return board.getState();
×
157
        }
158

159
        @Override
160
        public boolean getBoardStateAddress(String name, String address) {
161
                log.info("CALLED boardState({}:IP=({}))", name, address);
×
162
                var board = machineController.findIP(name, address)
×
163
                                .orElseThrow(AdminImpl::noBoard);
×
164
                return board.getState();
×
165
        }
166

167
        @Override
168
        @ManagedOperation
169
        public boolean setBoardStateAddress(String name, String address,
170
                        boolean enabled) {
171
                log.warn("CALLED boardState({}:IP=({})) := {}", name, address, enabled);
×
172
                var board = machineController.findIP(name, address)
×
173
                                .orElseThrow(AdminImpl::noBoard);
×
174
                board.setState(enabled);
×
175
                return board.getState();
×
176
        }
177

178
        @Override
179
        public Map<String, URI> listUsers(UriInfo ui) {
180
                log.info("CALLED listUsers()");
×
181
                var ub = ui.getBaseUriBuilder().path(DESCRIBE_USER);
×
182
                return userManager.listUsers(user -> ub.build(user.getUserId()));
×
183
        }
184

185
        @Override
186
        public Response createUser(UserRecord providedUser, UriInfo ui) {
187
                log.warn("CALLED createUser({})", providedUser.getUserName());
×
188
                providedUser.initCreationDefaults();
×
189
                var realUser = userManager.createUser(providedUser)
×
190
                                .orElseThrow(() -> new RequestFailedException(NOT_MODIFIED,
×
191
                                                "user already exists"));
192
                var ub = ui.getBaseUriBuilder().path(DESCRIBE_USER);
×
193
                int id = realUser.getUserId();
×
194
                return created(ub.build(id)).type(APPLICATION_JSON)
×
195
                                .entity(realUser.sanitise()).build();
×
196
        }
197

198
        @Override
199
        public UserRecord describeUser(int id, UriInfo ui) {
200
                log.info("CALLED describeUser({})", id);
×
201
                var ub = ui.getBaseUriBuilder().path(DESCRIBE_GROUP);
×
202
                return userManager.getUser(id, m -> ub.build(m.getGroupId()))
×
203
                                .orElseThrow(AdminImpl::noUser).sanitise();
×
204
        }
205

206
        @Override
207
        public UserRecord updateUser(int id, UserRecord providedUser, UriInfo ui,
208
                        SecurityContext security) {
209
                log.warn("CALLED updateUser({})", providedUser.getUserName());
×
210
                var adminUser = security.getUserPrincipal().getName();
×
211
                providedUser.setUserId(null);
×
212
                var ub = ui.getBaseUriBuilder().path(DESCRIBE_GROUP);
×
213
                return userManager
×
214
                                .updateUser(id, providedUser, adminUser,
×
215
                                                m -> ub.build(m.getGroupId()))
×
216
                                .orElseThrow(AdminImpl::noUser).sanitise();
×
217
        }
218

219
        @Override
220
        public String deleteUser(int id, SecurityContext security) {
221
                log.warn("CALLED deleteUser({})", id);
×
222
                var adminUser = security.getUserPrincipal().getName();
×
223
                return "deleted user " + userManager.deleteUser(id, adminUser)
×
224
                                .orElseThrow(AdminImpl::noUser);
×
225
        }
226

227
        @Override
228
        public Map<String, URI> listGroups(UriInfo ui) {
229
                log.warn("CALLED listGroups()");
×
230
                var ub = ui.getBaseUriBuilder().path(DESCRIBE_GROUP);
×
231
                return userManager.listGroups(g -> ub.build(g.getGroupId()));
×
232
        }
233

234
        @Override
235
        public Response createGroup(GroupRecord group, UriInfo ui) {
236
                log.warn("CALLED createGroup({})", group.getGroupName());
×
237
                var realGroup = userManager.createGroup(group, group.getType())
×
238
                                .orElseThrow(() -> new WebApplicationException(
×
239
                                                "group already exists", BAD_REQUEST));
240
                var ub = ui.getBaseUriBuilder().path(DESCRIBE_GROUP);
×
241
                return created(ub.build(realGroup.getGroupId())).type(APPLICATION_JSON)
×
242
                                .entity(realGroup).build();
×
243
        }
244

245
        @Override
246
        public GroupRecord describeGroup(int groupId, UriInfo ui) {
247
                log.warn("CALLED describeGroup({})", groupId);
×
248
                var ub = ui.getBaseUriBuilder().path(DESCRIBE_MEMBER);
×
249
                return userManager.getGroup(groupId, m -> ub.build(groupId, m.getId()))
×
250
                                .orElseThrow(AdminImpl::noGroup);
×
251
        }
252

253
        @Override
254
        public GroupRecord updateGroup(int groupId, GroupRecord group, UriInfo ui) {
255
                log.warn("CALLED updateGroup({})", groupId);
×
256
                var ub = ui.getBaseUriBuilder().path(DESCRIBE_MEMBER);
×
257
                return userManager
×
258
                                .updateGroup(groupId, group,
×
259
                                                m -> ub.build(group.getGroupId(), m.getId()))
×
260
                                .orElseThrow(AdminImpl::noGroup);
×
261
        }
262

263
        @Override
264
        public String deleteGroup(int groupId) {
265
                log.warn("CALLED deleteGroup({})", groupId);
×
266
                return "deleted group " + userManager.deleteGroup(groupId)
×
267
                                .orElseThrow(AdminImpl::noGroup);
×
268
        }
269

270
        @Override
271
        public Response addMember(int groupId, MemberRecord request, UriInfo ui) {
272
                var userName = request.getUserName();
×
273
                log.warn("CALLED addMember({},{})", groupId, userName);
×
274
                var ub = ui.getBaseUriBuilder().path(DESCRIBE_MEMBER);
×
275
                var group = userManager.getGroup(groupId, null)
×
276
                                .orElseThrow(AdminImpl::noGroup);
×
277
                var user = userManager.getUser(userName, null)
×
278
                                .orElseThrow(AdminImpl::noUser);
×
279
                return userManager.addUserToGroup(user, group)
×
280
                                .map(member -> created(ub.build(member.getId()))
×
281
                                                .type(APPLICATION_JSON).entity(member))
×
282
                                .orElseThrow(() -> new WebApplicationException(
×
283
                                                "user already a member of group", BAD_REQUEST))
284
                                .build();
×
285
        }
286

287
        @Override
288
        public MemberRecord describeMember(int groupId, int memberId, UriInfo ui) {
289
                log.warn("CALLED describeMember({},{})", groupId, memberId);
×
290
                var ubGroup = ui.getBaseUriBuilder().path(DESCRIBE_GROUP);
×
291
                var ubUser = ui.getBaseUriBuilder().path(DESCRIBE_USER);
×
292
                return userManager
×
293
                                .describeMembership(memberId,
×
294
                                                m -> ubGroup.build(m.getGroupId()),
×
295
                                                m -> ubUser.build(m.getUserId()))
×
296
                                .orElseThrow(AdminImpl::noMember);
×
297
        }
298

299
        @Override
300
        public Response removeMember(int groupId, int memberId) {
301
                log.warn("CALLED removeMember({groupId},{memberId})");
×
302
                var group = userManager.getGroup(groupId, null)
×
303
                                .orElseThrow(AdminImpl::noGroup);
×
304
                var member = userManager.describeMembership(memberId, null, null)
×
305
                                .orElseThrow(AdminImpl::noMember);
×
306
                if (!userManager.removeMembershipOfGroup(member, group)) {
×
307
                        throw new WebApplicationException("remove failed", BAD_REQUEST);
×
308
                }
309
                return noContent().build();
×
310
        }
311
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2025 Coveralls, Inc