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
|
/*******************************************************************************
* Copyright (c) 2014 Boeing.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Boeing - initial API and implementation
*******************************************************************************/
package org.eclipse.osee.ats.core.client.branch;
import java.util.Date;
import java.util.logging.Level;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.core.runtime.jobs.Job;
import org.eclipse.osee.ats.api.user.IAtsUser;
import org.eclipse.osee.ats.api.util.IAtsChangeSet;
import org.eclipse.osee.ats.api.workdef.IAtsDecisionReviewDefinition;
import org.eclipse.osee.ats.api.workdef.IAtsPeerReviewDefinition;
import org.eclipse.osee.ats.api.workdef.StateEventType;
import org.eclipse.osee.ats.core.client.internal.Activator;
import org.eclipse.osee.ats.core.client.internal.AtsClientService;
import org.eclipse.osee.ats.core.client.review.DecisionReviewArtifact;
import org.eclipse.osee.ats.core.client.review.DecisionReviewDefinitionManager;
import org.eclipse.osee.ats.core.client.review.PeerReviewDefinitionManager;
import org.eclipse.osee.ats.core.client.review.PeerToPeerReviewArtifact;
import org.eclipse.osee.ats.core.client.team.TeamWorkFlowArtifact;
import org.eclipse.osee.ats.core.client.util.AtsChangeSet;
import org.eclipse.osee.ats.core.client.workflow.stateitem.AtsStateItemCoreManager;
import org.eclipse.osee.ats.core.client.workflow.stateitem.IAtsStateItemCore;
import org.eclipse.osee.ats.core.users.AtsCoreUsers;
import org.eclipse.osee.framework.core.data.IOseeBranch;
import org.eclipse.osee.framework.core.exception.OseeWrappedException;
import org.eclipse.osee.framework.core.model.TransactionRecord;
import org.eclipse.osee.framework.core.util.Result;
import org.eclipse.osee.framework.jdk.core.type.OseeCoreException;
import org.eclipse.osee.framework.jdk.core.type.OseeStateException;
import org.eclipse.osee.framework.jdk.core.util.Conditions;
import org.eclipse.osee.framework.jdk.core.util.Strings;
import org.eclipse.osee.framework.logging.OseeLog;
import org.eclipse.osee.framework.plugin.core.util.CatchAndReleaseJob;
import org.eclipse.osee.framework.plugin.core.util.IExceptionableRunnable;
import org.eclipse.osee.framework.plugin.core.util.Jobs;
import org.eclipse.osee.framework.skynet.core.artifact.BranchManager;
import org.eclipse.osee.framework.skynet.core.transaction.TransactionManager;
/**
* @author Donald G. Dunne
*/
public class AtsBranchUtil {
/**
* @return true if one or more reviews were created
*/
public static boolean createNecessaryBranchEventReviews(StateEventType stateEventType, TeamWorkFlowArtifact teamArt, Date createdDate, IAtsUser createdBy, IAtsChangeSet changes) throws OseeCoreException {
Conditions.checkNotNull(teamArt, "Team Workflow");
boolean created = false;
if (stateEventType != StateEventType.CommitBranch && stateEventType != StateEventType.CreateBranch) {
throw new OseeStateException("Invalid stateEventType [%s]", stateEventType);
}
// Create any decision and peerToPeer reviews for createBranch and commitBranch
for (IAtsDecisionReviewDefinition decRevDef : teamArt.getStateDefinition().getDecisionReviews()) {
if (decRevDef.getStateEventType() != null && decRevDef.getStateEventType().equals(stateEventType)) {
DecisionReviewArtifact decArt = DecisionReviewDefinitionManager.createNewDecisionReview(decRevDef, changes,
teamArt, createdDate, createdBy);
if (decArt != null) {
created = true;
changes.add(decArt);
}
}
}
for (IAtsPeerReviewDefinition peerRevDef : teamArt.getStateDefinition().getPeerReviews()) {
if (peerRevDef.getStateEventType() != null && peerRevDef.getStateEventType().equals(stateEventType)) {
PeerToPeerReviewArtifact peerArt = PeerReviewDefinitionManager.createNewPeerToPeerReview(peerRevDef,
changes, teamArt, createdDate, createdBy);
if (peerArt != null) {
created = true;
changes.add(peerArt);
}
}
}
return created;
}
/**
* Perform error checks and popup confirmation dialogs associated with creating a working branch.
*
* @param popup if true, errors are popped up to user; otherwise sent silently in Results
* @return Result return of status
*/
public static Result createWorkingBranch_Validate(TeamWorkFlowArtifact teamArt) {
try {
if (AtsClientService.get().getBranchService().isCommittedBranchExists(teamArt)) {
return new Result(
"Committed branch already exists. Can not create another working branch once changes have been committed.");
}
IOseeBranch parentBranch = AtsClientService.get().getBranchService().getConfiguredBranchForWorkflow(teamArt);
if (parentBranch == null) {
return new Result(
"Parent Branch can not be determined.\n\nPlease specify " + "parent branch through Version Artifact or Team Definition Artifact.\n\n" + "Contact your team lead to configure this.");
}
Result result = AtsClientService.get().getBranchService().isCreateBranchAllowed(teamArt);
if (result.isFalse()) {
return result;
}
} catch (Exception ex) {
OseeLog.log(Activator.class, Level.SEVERE, ex);
return new Result("Exception occurred: " + ex.getLocalizedMessage());
}
return Result.TrueResult;
}
/**
* Create a working branch associated with this Team Workflow. Call createWorkingBranch_Validate first to validate
* that branch can be created.
*/
public static Job createWorkingBranch_Create(final TeamWorkFlowArtifact teamArt) throws OseeCoreException {
return createWorkingBranch_Create(teamArt, false);
}
/**
* Create a working branch associated with this state machine artifact. This should NOT be called by applications
* except in test cases or automated tools. Use createWorkingBranchWithPopups
*/
public static Job createWorkingBranch_Create(final TeamWorkFlowArtifact teamArt, boolean pend) throws OseeCoreException {
final IOseeBranch parentBranch =
AtsClientService.get().getBranchService().getConfiguredBranchForWorkflow(teamArt);
return createWorkingBranch_Create(teamArt, parentBranch, pend);
}
public static Job createWorkingBranch_Create(final TeamWorkFlowArtifact teamArt, final IOseeBranch parentBranch) throws OseeCoreException {
return createWorkingBranch_Create(teamArt, parentBranch, false);
}
public static Job createWorkingBranch_Create(final TeamWorkFlowArtifact teamArt, final IOseeBranch parentBranch, boolean pend) throws OseeCoreException {
Conditions.checkNotNull(teamArt, "Parent Team Workflow");
Conditions.checkNotNull(parentBranch, "Parent Branch");
TransactionRecord parentTransactionId = TransactionManager.getHeadTransaction(parentBranch);
return createWorkingBranch(teamArt, parentTransactionId, pend);
}
public static Job createWorkingBranch(final TeamWorkFlowArtifact teamArt, final TransactionRecord parentTransactionId, boolean pend) throws OseeCoreException {
final String branchName =
Strings.truncate(AtsClientService.get().getBranchService().getBranchName(teamArt), 195, true);
Conditions.checkNotNull(teamArt, "Parent Team Workflow");
Conditions.checkNotNull(parentTransactionId, "Parent Branch");
IExceptionableRunnable runnable = new IExceptionableRunnable() {
@Override
public IStatus run(IProgressMonitor monitor) throws OseeCoreException {
teamArt.setWorkingBranchCreationInProgress(true);
BranchManager.createWorkingBranch(parentTransactionId, branchName, teamArt);
teamArt.setWorkingBranchCreationInProgress(false);
performPostBranchCreationTasks(teamArt);
return Status.OK_STATUS;
}
};
// Jobs.runInJob("Create Branch", runnable, Activator.class, Activator.PLUGIN_ID);
Job job =
Jobs.startJob(new CatchAndReleaseJob("Create Branch", runnable, Activator.class, Activator.PLUGIN_ID), true);
if (pend) {
try {
job.join();
} catch (InterruptedException ex) {
throw new OseeWrappedException(ex);
}
}
return job;
}
private static void performPostBranchCreationTasks(final TeamWorkFlowArtifact teamArt) throws OseeCoreException {
// Create reviews as necessary
AtsChangeSet changes = new AtsChangeSet("Create Reviews upon Transition");
boolean created = createNecessaryBranchEventReviews(StateEventType.CreateBranch, teamArt, new Date(),
AtsCoreUsers.SYSTEM_USER, changes);
if (created) {
changes.execute();
}
// Notify extensions of branch creation
for (IAtsStateItemCore item : AtsStateItemCoreManager.getStateItems()) {
item.workingBranchCreated(teamArt);
}
}
public static Result deleteWorkingBranch(TeamWorkFlowArtifact teamArt, boolean pend) throws OseeCoreException {
IOseeBranch branch = AtsClientService.get().getBranchService().getWorkingBranch(teamArt);
if (branch != null) {
IStatus status = null;
if (pend) {
status = BranchManager.deleteBranchAndPend(branch);
} else {
Job job = BranchManager.deleteBranch(branch);
job.schedule();
try {
job.join();
} catch (InterruptedException ex) {
throw new OseeWrappedException(ex);
}
status = job.getResult();
}
if (status.isOK()) {
return Result.TrueResult;
}
return new Result(status.getMessage());
}
return Result.TrueResult;
}
}
|
