1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
/*
* Copyright © 2016-2018 European Support Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.openecomp.sdcrests.item.rest.services;
import com.google.common.annotations.VisibleForTesting;
import org.openecomp.sdc.activitylog.ActivityLogManager;
import org.openecomp.sdc.activitylog.ActivityLogManagerFactory;
import org.openecomp.sdc.activitylog.dao.type.ActivityLogEntity;
import org.openecomp.sdc.activitylog.dao.type.ActivityType;
import org.openecomp.sdc.common.errors.CoreException;
import org.openecomp.sdc.common.errors.Messages;
import org.openecomp.sdc.conflicts.ConflictsManager;
import org.openecomp.sdc.conflicts.ConflictsManagerFactory;
import org.openecomp.sdc.itempermissions.PermissionsManager;
import org.openecomp.sdc.itempermissions.PermissionsManagerFactory;
import org.openecomp.sdc.logging.api.Logger;
import org.openecomp.sdc.logging.api.LoggerFactory;
import org.openecomp.sdc.notification.dtos.Event;
import org.openecomp.sdc.notification.factories.NotificationPropagationManagerFactory;
import org.openecomp.sdc.notification.services.NotificationPropagationManager;
import org.openecomp.sdc.versioning.AsdcItemManager;
import org.openecomp.sdc.versioning.AsdcItemManagerFactory;
import org.openecomp.sdc.versioning.VersioningManager;
import org.openecomp.sdc.versioning.VersioningManagerFactory;
import org.openecomp.sdc.versioning.dao.types.Revision;
import org.openecomp.sdc.versioning.dao.types.SynchronizationState;
import org.openecomp.sdc.versioning.dao.types.Version;
import org.openecomp.sdc.versioning.errors.RevisionIdNotFoundErrorBuilder;
import org.openecomp.sdc.versioning.types.NotificationEventTypes;
import org.openecomp.sdc.versioning.types.VersionCreationMethod;
import org.openecomp.sdcrests.item.rest.Versions;
import org.openecomp.sdcrests.item.rest.mapping.MapActivityLogEntityToDto;
import org.openecomp.sdcrests.item.rest.mapping.MapRevisionToDto;
import org.openecomp.sdcrests.item.rest.mapping.MapVersionToDto;
import org.openecomp.sdcrests.item.rest.models.SyncEvent;
import org.openecomp.sdcrests.item.types.*;
import org.openecomp.sdcrests.wrappers.GenericCollectionWrapper;
import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Service;
import javax.inject.Named;
import javax.ws.rs.core.Response;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import static org.openecomp.sdc.itempermissions.notifications.NotificationConstants.PERMISSION_USER;
import static org.openecomp.sdc.versioning.VersioningNotificationConstansts.*;
@Named
@Service("versions")
@Scope(value = "prototype")
public class VersionsImpl implements Versions {
private static final String COMMIT_ITEM_ACTION = "Commit_Item";
private static final Logger LOGGER = LoggerFactory.getLogger(VersionsImpl.class);
private ManagersProvider managersProvider;
@Override
public Response list(String itemId, String user) {
GenericCollectionWrapper<VersionDto> results = new GenericCollectionWrapper<>();
MapVersionToDto mapper = new MapVersionToDto();
getManagersProvider().getVersioningManager().list(itemId)
.forEach(version -> results.add(mapper.applyMapping(version, VersionDto.class)));
return Response.ok(results).build();
}
@Override
public Response create(VersionRequestDto request, String itemId, String baseVersionId, String user) {
Version version = new Version();
version.setBaseId(baseVersionId);
version.setDescription(request.getDescription());
version = getManagersProvider().getVersioningManager()
.create(itemId, version, VersionCreationMethod.valueOf(request.getCreationMethod().name()));
VersionDto versionDto = new MapVersionToDto().applyMapping(version, VersionDto.class);
getManagersProvider().getActivityLogManager().logActivity(
new ActivityLogEntity(itemId, version, ActivityType.Create_Version, user, true, "", ""));
return Response.ok(versionDto).build();
}
@Override
public Response get(String itemId, String versionId, String user) {
Version version = getVersion(itemId, new Version(versionId));
VersionDto versionDto = new MapVersionToDto().applyMapping(version, VersionDto.class);
return Response.ok(versionDto).build();
}
@Override
public Response getActivityLog(String itemId, String versionId, String user) {
GenericCollectionWrapper<ActivityLogDto> results = new GenericCollectionWrapper<>();
MapActivityLogEntityToDto mapper = new MapActivityLogEntityToDto();
getManagersProvider().getActivityLogManager().listLoggedActivities(itemId, new Version(versionId))
.forEach(loggedActivity -> results.add(mapper.applyMapping(loggedActivity, ActivityLogDto.class)));
return Response.ok(results).build();
}
@Override
public Response listRevisions(String itemId, String versionId, String user) {
List<Revision> revisions = getManagersProvider().getVersioningManager().listRevisions(itemId, new Version(versionId));
filterRevisions(revisions);
GenericCollectionWrapper<RevisionDto> results = new GenericCollectionWrapper<>();
MapRevisionToDto mapper = new MapRevisionToDto();
revisions.forEach(revision -> results.add(mapper.applyMapping(revision, RevisionDto.class)));
return Response.ok(results).build();
}
@Override
public Response actOn(VersionActionRequestDto request, String itemId, String versionId, String user) {
Version version = new Version(versionId);
switch (request.getAction()) {
case Sync:
sync(itemId, version);
break;
case Commit:
if (!getManagersProvider().getPermissionsManager().isAllowed(itemId, user, COMMIT_ITEM_ACTION)) {
return Response.status(Response.Status.FORBIDDEN)
.entity(new Exception(Messages.PERMISSIONS_ERROR.getErrorMessage())).build();
}
commit(request.getCommitRequest(), itemId, version, user);
break;
case Revert:
revert(request.getRevisionRequest(), itemId, versionId);
break;
case Clean:
getManagersProvider().getVersioningManager().clean(itemId, version);
break;
default:
throw new UnsupportedOperationException(String.format("Action %s not supported.", request.getAction()));
}
return Response.ok().build();
}
private Version getVersion(String itemId, Version version) {
Version retrievedVersion = getManagersProvider().getVersioningManager().get(itemId, version);
if (retrievedVersion.getState().getSynchronizationState() != SynchronizationState.Merging &&
// looks for sdc applicative conflicts
getManagersProvider().getConflictsManager().isConflicted(itemId, retrievedVersion)) {
retrievedVersion.getState().setSynchronizationState(SynchronizationState.Merging);
}
return retrievedVersion;
}
private void sync(String itemId, Version version) {
getManagersProvider().getVersioningManager().sync(itemId, version);
getManagersProvider().getConflictsManager().finalizeMerge(itemId, version);
}
private void commit(CommitRequestDto request, String itemId, Version version, String user) {
String message = request == null ? "" : request.getMessage();
getManagersProvider().getVersioningManager().publish(itemId, version, message);
notifyUsers(itemId, version, message, user, NotificationEventTypes.COMMIT);
getManagersProvider().getActivityLogManager().logActivity(
new ActivityLogEntity(itemId, version, ActivityType.Commit, user, true, "", message));
}
private void revert(RevisionRequestDto request, String itemId, String versionId) {
if (request.getRevisionId() == null) {
throw new CoreException(new RevisionIdNotFoundErrorBuilder().build());
}
getManagersProvider().getVersioningManager().revert(itemId, new Version(versionId), request.getRevisionId());
}
private void filterRevisions(List<Revision> revisions) {
/* When creating a new item an initial version is created with invalid data.
This revision is not an applicable revision. The logic of identifying this revision is:
1- only the first version of item has this issue
2- only in the first item version there are 2 revisions created
3- the second revision is in format "Initial <vlm/vsp>: <name of the vlm/vsp>"
4- only if a revision in this format exists we remove the first revision. */
int numOfRevisions = revisions.size();
if (numOfRevisions > 1 &&
revisions.get(numOfRevisions - 2).getMessage().matches("Initial .*:.*")) {
revisions.remove(numOfRevisions - 1);
}
}
private void notifyUsers(String itemId, Version version, String message, String userName,
NotificationEventTypes eventType) {
Map<String, Object> eventProperties = new HashMap<>();
eventProperties.put(ITEM_NAME, getManagersProvider().getAsdcItemManager().get(itemId).getName());
eventProperties.put(ITEM_ID, itemId);
Version ver = getManagersProvider().getVersioningManager().get(itemId, version);
eventProperties.put(VERSION_NAME, ver.getName());
eventProperties.put(VERSION_ID, ver.getId());
eventProperties.put(SUBMIT_DESCRIPTION, message);
eventProperties.put(PERMISSION_USER, userName);
Event syncEvent = new SyncEvent(eventType.getEventName(), itemId, eventProperties, itemId);
try {
getManagersProvider().getNotificationPropagationManager().notifySubscribers(syncEvent, userName);
} catch (Exception e) {
LOGGER.error("Failed to send sync notification to users subscribed o item '" + itemId);
}
}
@VisibleForTesting
void setManagersProvider(ManagersProvider managersProvider) {
this.managersProvider = managersProvider;
}
private ManagersProvider getManagersProvider() {
if (managersProvider == null){
managersProvider = new ManagersProvider();
}
return managersProvider;
}
}
|
