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
|
/*****************************************************************************
* Copyright (c) 2019, 2021 CEA LIST, Christian W. Damus, and others.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* Nicolas FAUVERGUE (CEA LIST) nicolas.fauvergue@cea.fr - Initial API and implementation
* Christian W. Damus - bugs 569357, 570097
*
*****************************************************************************/
package org.eclipse.papyrus.toolsmiths.validation.elementtypes.internal.checkers;
import static org.eclipse.papyrus.toolsmiths.validation.elementtypes.constants.ElementTypesPluginValidationConstants.ELEMENTTYPES_EXTENSION_POINT_IDENTIFIER;
import static org.eclipse.papyrus.toolsmiths.validation.elementtypes.constants.ElementTypesPluginValidationConstants.ELEMENTTYPES_PLUGIN_VALIDATION_MARKER_TYPE;
import java.util.Collection;
import java.util.Set;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.emf.common.util.Diagnostic;
import org.eclipse.emf.common.util.URI;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.emf.ecore.resource.impl.ResourceSetImpl;
import org.eclipse.emf.ecore.util.EcoreUtil;
import org.eclipse.papyrus.infra.types.ElementTypeSetConfiguration;
import org.eclipse.papyrus.infra.types.ElementTypesConfigurationsPackage;
import org.eclipse.papyrus.toolsmiths.validation.common.checkers.BuildPropertiesChecker;
import org.eclipse.papyrus.toolsmiths.validation.common.checkers.CustomModelChecker;
import org.eclipse.papyrus.toolsmiths.validation.common.checkers.ExtensionsChecker;
import org.eclipse.papyrus.toolsmiths.validation.common.checkers.IPluginChecker2;
import org.eclipse.papyrus.toolsmiths.validation.common.checkers.ModelDependenciesChecker;
import org.eclipse.papyrus.toolsmiths.validation.common.checkers.ModelValidationChecker;
import org.eclipse.papyrus.toolsmiths.validation.common.internal.utils.PluginErrorReporter;
import org.eclipse.papyrus.toolsmiths.validation.common.utils.MarkersService;
import org.eclipse.papyrus.toolsmiths.validation.common.utils.PluginValidationService;
import org.eclipse.papyrus.toolsmiths.validation.common.utils.ProjectManagementService;
import org.eclipse.papyrus.toolsmiths.validation.elementtypes.constants.ElementTypesPluginValidationConstants;
import org.eclipse.papyrus.toolsmiths.validation.elementtypes.internal.messages.Messages;
import org.eclipse.papyrus.uml.types.core.advices.applystereotype.ApplyStereotypeAdvicePackage;
import org.eclipse.papyrus.uml.types.core.advices.stereotypepropertyreferenceedgeadvice.StereotypePropertyReferenceEdgeAdvicePackage;
import org.eclipse.papyrus.uml.types.core.matchers.stereotype.StereotypeApplicationMatcherPackage;
/**
* This allows to check an element types plug-in (extensions, builds, dependencies, ...).
*/
public class ElementTypesPluginChecker {
public static final String ELEMENT_TYPES_CONFIGURATION_EXTENSION = "elementtypesconfigurations";//$NON-NLS-1$
// TODO: Why were some of these in the original definition of base requirements?
// private static final Set<String> ADDITIONAL_REQUIREMENTS = Set.of(
// "org.eclipse.papyrus.infra.types.core", //$NON-NLS-1$
// "org.eclipse.gmf.runtime.emf.type.core", //$NON-NLS-1$
// "org.eclipse.papyrus.uml.service.types", //$NON-NLS-1$
// "org.eclipse.papyrus.infra.services.edit", //$NON-NLS-1$
// "org.eclipse.papyrus.infra.types", //$NON-NLS-1$
// "org.eclipse.papyrus.uml.tools.utils" //$NON-NLS-1$
// );
private static final Set<String> ADDITIONAL_REQUIREMENTS = Set.of(
"org.eclipse.papyrus.infra.types.core", //$NON-NLS-1$
"org.eclipse.papyrus.infra.types" //$NON-NLS-1$
);
/**
* This allows to check the element types plug-in.
*
* @param project
* The current project to check.
* @param A
* monitor to report progress
*/
public static void checkElementTypesPlugin(final IProject project, IProgressMonitor monitor) {
// Open the progress monitor dialog
final Collection<IFile> elementTypesFiles = ProjectManagementService.getFilesFromProject(project, ELEMENT_TYPES_CONFIGURATION_EXTENSION, true);
monitor.beginTask(Messages.ElementTypesPluginChecker_0, 1 + (elementTypesFiles.size() * 3));
monitor.subTask(Messages.ElementTypesPluginChecker_1);
// First of all, delete the existing markers for project
MarkersService.deleteMarkers(project, ElementTypesPluginValidationConstants.ELEMENTTYPES_PLUGIN_VALIDATION_MARKER_TYPE);
// Create the plug-in validation service
final PluginValidationService pluginValidationService = new PluginValidationService();
// First, check the static dependencies needed
pluginValidationService.addPluginChecker(createModelDependenciesChecker(project));
// For all element types files in the plug-in
for (final IFile elementTypesFile : elementTypesFiles) {
if (monitor.isCanceled()) {
return;
}
// Get the resource
final URI elementTypesFileURI = URI.createPlatformResourceURI(elementTypesFile.getFullPath().toOSString(), true);
final Resource resource = new ResourceSetImpl().getResource(elementTypesFileURI, true);
// Check the validation of the element types file
pluginValidationService.addPluginChecker(createModelValidationChecker(project, elementTypesFile, resource));
// Check the extension point
pluginValidationService.addPluginChecker(createExtensionsChecker(project, elementTypesFile, resource));
// Check the external dependencies needed
pluginValidationService.addPluginChecker(createModelDependenciesChecker(project, elementTypesFile, resource));
}
monitor.worked(1);
// Call the validate
pluginValidationService.validate(monitor);
}
/**
* Obtain a dependencies checker factory for the specified bundle dependencies validation.
*
* @return the dependencies checker factory
*/
public static IPluginChecker2.Factory modelDependenciesCheckerFactory() {
// When checking the project, we have some additional requirements that aren't model-specific
return IPluginChecker2.Factory.forProject(ElementTypesPluginChecker::createModelDependenciesChecker)
.or(IPluginChecker2.Factory.forEMFResource(ElementTypesPluginChecker::createModelDependenciesChecker));
}
private static ModelDependenciesChecker createModelDependenciesChecker(IProject project) {
// When checking the project, we have some additional requirements that aren't model-specific
return new ModelDependenciesChecker(project, null, null, ELEMENTTYPES_PLUGIN_VALIDATION_MARKER_TYPE)
.addRequirements(ADDITIONAL_REQUIREMENTS)
.withSeverityFunction(bundle -> ADDITIONAL_REQUIREMENTS.contains(bundle) ? Diagnostic.WARNING : Diagnostic.ERROR);
}
private static ModelDependenciesChecker createModelDependenciesChecker(IProject project, IFile modelFile, Resource resource) {
return new ModelDependenciesChecker(project, modelFile, resource, ELEMENTTYPES_PLUGIN_VALIDATION_MARKER_TYPE)
.withAdditionalRequirements(new ElementTypesDependencies(project)::computeDependencies);
}
/**
* Obtain a model validation checker factory.
*
* @return the model validation checker factory
*/
public static IPluginChecker2.Factory modelValidationCheckerFactory() {
return IPluginChecker2.Factory.forEMFResource(ElementTypesPluginChecker::createModelValidationChecker);
}
private static ModelValidationChecker createModelValidationChecker(IProject project, IFile modelFile, Resource resource) {
return new ModelValidationChecker(modelFile, resource, ELEMENTTYPES_PLUGIN_VALIDATION_MARKER_TYPE);
}
/**
* Obtain a build properties checker factory.
*
* @return the build properties checker factory
*/
public static IPluginChecker2.Factory buildPropertiesCheckerFactory() {
return IPluginChecker2.Factory.forEMFResource(ElementTypesPluginChecker::createBuildPropertiesChecker);
}
private static BuildPropertiesChecker createBuildPropertiesChecker(IProject project, IFile modelFile, Resource resource) {
return new BuildPropertiesChecker(project, modelFile, ELEMENTTYPES_PLUGIN_VALIDATION_MARKER_TYPE)
.withDependencies(file -> new ElementTypesBuildPropertiesDependencies(resource).getDependencies());
}
/**
* Obtain a <tt>plugin.xml</tt> extensions checker factory.
*
* @return the extensions checker factory
*/
public static IPluginChecker2.Factory extensionsCheckerFactory() {
return IPluginChecker2.Factory.forEMFResource(ElementTypesPluginChecker::createExtensionsChecker);
}
private static ExtensionsChecker<ElementTypeSetConfiguration, PluginErrorReporter<ElementTypeSetConfiguration>> createExtensionsChecker(
IProject project, IFile modelFile, Resource resource) {
Collection<ElementTypeSetConfiguration> sets = EcoreUtil.getObjectsByType(resource.getContents(), ElementTypesConfigurationsPackage.Literals.ELEMENT_TYPE_SET_CONFIGURATION);
return new ExtensionsChecker<>(project, modelFile, sets, ELEMENTTYPES_PLUGIN_VALIDATION_MARKER_TYPE, ElementTypesPluginChecker::createPluginErrorReporter);
}
private static PluginErrorReporter<ElementTypeSetConfiguration> createPluginErrorReporter(IFile pluginXML, IFile modelFile, ElementTypeSetConfiguration model) {
ElementTypesPluginXMLValidator validator = new ElementTypesPluginXMLValidator(modelFile);
return new PluginErrorReporter<>(pluginXML, modelFile, model, ELEMENTTYPES_PLUGIN_VALIDATION_MARKER_TYPE, set -> set.getIdentifier())
.requireExtensionPoint(ELEMENTTYPES_EXTENSION_POINT_IDENTIFIER, validator::matchExtension, validator::checkExtension, null)
.impliedByArchitectureContexts(ELEMENTTYPES_EXTENSION_POINT_IDENTIFIER);
}
/**
* Obtain a checker factory for custom model validation rules.
*
* @return the custom model checker factory
*/
public static IPluginChecker2.Factory customModelCheckerFactory() {
return IPluginChecker2.Factory.forEMFResource(ElementTypesPluginChecker::createCustomModelChecker);
}
private static CustomModelChecker createCustomModelChecker(IProject project, IFile modelFile, Resource resource) {
return new CustomModelChecker(modelFile, resource, ELEMENTTYPES_PLUGIN_VALIDATION_MARKER_TYPE)
.withValidator(ElementTypesConfigurationsPackage.eNS_URI, ElementTypesCustomValidator::new)
.withValidator(ApplyStereotypeAdvicePackage.eNS_URI, ApplyStereotypeAdviceCustomValidator::new)
.withValidator(StereotypeApplicationMatcherPackage.eNS_URI, StereotypeApplicationMatcherCustomValidator::new)
.withValidator(StereotypePropertyReferenceEdgeAdvicePackage.eNS_URI, StereotypePropertyReferenceEdgeAdviceCustomValidator::new);
}
}
|
