implab/gradle-common Commit - r28:1a0b4caf9976

Variants validation + fail-fast

cin -

r28:1a0b4caf9976 default

parent child

Context file:

r28:1a0b4caf9976

Collapse all files

common/src/main/java/org/implab/gradle/common/sources/BuildVariant.java +11 -1

                 public LayerLink link(String from, String to, String kind) {
                     ensureMutable("add links");
-                    var link = new LayerLink(from, to, kind);
+                    var link = new LayerLink(
+                            requireLinkValue("from", from),
+                            requireLinkValue("to", to),
+                            requireLinkValue("kind", kind));
                     links.add(link);
                     return link;
                 }
                         throw new InvalidUserDataException("Variant '" + name + "' is finalized and cannot " + operation);
                 }
+                private static String requireLinkValue(String field, String value) {
+                    if (value == null || value.trim().isEmpty())
+                        throw new InvalidUserDataException("Link '" + field + "' must not be null or blank");
+                    return value.trim();
+                }
                 public final class RolesSpec {
                     public BuildRole role(String name, Action<? super BuildRole> configure) {
                         return BuildVariant.this.role(name, configure);

common/src/main/java/org/implab/gradle/common/sources/BuildVariantsExtension.java +57 -6

@@ -158,8 +158,18 public abstract class BuildVariantsExten
158	var errors = new ArrayList<String>();	158	var errors = new ArrayList<String>();
159		159
160	var layersByName = new LinkedHashMap<String, BuildLayer>();	160	var layersByName = new LinkedHashMap<String, BuildLayer>();
161	for (var layer : layers)	161	for (var layer : layers) {
162	~~layersByName~~.~~put~~(layer.getName(), ~~layer~~);	162	var layerName = normalize(layer.getName());
		163	if (layerName == null) {
		164	errors.add("Layer name must not be blank");
		165	continue;
		166	}
		167
		168	var previous = layersByName.putIfAbsent(layerName, layer);
		169	if (previous != null) {
		170	errors.add("Layer '" + layerName + "' is declared more than once");
		171	}
		172	}
163		173
164	for (var variant : variants)	174	for (var variant : variants)
165	validateVariant(variant, layersByName, errors);	175	validateVariant(variant, layersByName, errors);
@@ -174,28 +184,69 public abstract class BuildVariantsExten
174	}	184	}
175		185
176	private static void validateVariant(BuildVariant variant, Map<String, BuildLayer> layersByName, List<String> errors) {	186	private static void validateVariant(BuildVariant variant, Map<String, BuildLayer> layersByName, List<String> errors) {
		187	var variantName = normalize(variant.getName());
		188	if (variantName == null) {
		189	errors.add("Variant name must not be blank");
		190	return;
		191	}
		192
		193	validateRoleAndArtifactNames(variant, errors);
177	var variantLayers = validateRoleMappings(variant, layersByName, errors);	194	var variantLayers = validateRoleMappings(variant, layersByName, errors);
178	validateLinks(variant, variantLayers, errors);	195	validateLinks(variant, variantLayers, errors);
179	}	196	}
180		197
		198	private static void validateRoleAndArtifactNames(BuildVariant variant, List<String> errors) {
		199	var roleNames = new LinkedHashSet<String>();
		200	for (var role : variant.getRoles()) {
		201	var roleName = normalize(role.getName());
		202	if (roleName == null) {
		203	errors.add("Variant '" + variant.getName() + "' contains blank role name");
		204	continue;
		205	}
		206	if (!roleNames.add(roleName)) {
		207	errors.add("Variant '" + variant.getName() + "' contains duplicated role name '" + roleName + "'");
		208	}
		209	}
		210
		211	var slotNames = new LinkedHashSet<String>();
		212	for (var slot : variant.getArtifactSlots()) {
		213	var slotName = normalize(slot.getName());
		214	if (slotName == null) {
		215	errors.add("Variant '" + variant.getName() + "' contains blank artifact slot name");
		216	continue;
		217	}
		218	if (!slotNames.add(slotName)) {
		219	errors.add("Variant '" + variant.getName() + "' contains duplicated artifact slot name '" + slotName + "'");
		220	}
		221	}
		222	}
		223
181	private static Set<String> validateRoleMappings(BuildVariant variant, Map<String, BuildLayer> layersByName,	224	private static Set<String> validateRoleMappings(BuildVariant variant, Map<String, BuildLayer> layersByName,
182	List<String> errors) {	225	List<String> errors) {
183	var variantLayers = new LinkedHashSet<String>();	226	var variantLayers = new LinkedHashSet<String>();
184		227
185	for (var role : variant.getRoles()) {	228	for (var role : variant.getRoles()) {
		229	var seenLayers = new LinkedHashSet<String>();
186	for (var layerName : role.getLayers().getOrElse(List.of())) {	230	for (var layerName : role.getLayers().getOrElse(List.of())) {
187	if (isBlank(layerName)) {	231	var normalizedLayerName = normalize(layerName);
		232	if (normalizedLayerName == null) {
188	errors.add("Variant '" + variant.getName() + "', role '" + role.getName() + "' contains blank layer name");	233	errors.add("Variant '" + variant.getName() + "', role '" + role.getName() + "' contains blank layer name");
189	continue;	234	continue;
190	}	235	}
191		236
192	var layer = layersByName.get(layerName);	237	var layer = layersByName.get(normalizedLayerName);
193	if (layer == null) {	238	if (layer == null) {
194	errors.add("Variant '" + variant.getName() + "' references unknown layer '" + layerName + "'");	239	errors.add("Variant '" + variant.getName() + "' references unknown layer '" + normalizedLayerName + "'");
195	continue;	240	continue;
196	}	241	}
197		242
198	~~variant~~Layers.add(layerName);	243	if (!seenLayers.add(normalizedLayerName)) {
		244	errors.add("Variant '" + variant.getName() + "', role '" + role.getName()
		245	+ "' contains duplicated layer reference '" + normalizedLayerName + "'");
		246	continue;
		247	}
		248
		249	variantLayers.add(normalizedLayerName);
199	}	250	}
200	}	251	}
201		252

common/src/main/java/org/implab/gradle/common/sources/VariantSourcesExtension.java +7 0

                 private final List<SourceSetContext> boundContexts = new ArrayList<>();
                 private final LinkedHashMap<String, NamedDomainObjectProvider<GenericSourceSet>> sourceSetsByName = new LinkedHashMap<>();
                 private final LinkedHashMap<String, String> sourceSetLayersByName = new LinkedHashMap<>();
+                private boolean sourceSetsRegistered;
                 @Inject
                 public VariantSourcesExtension(ObjectFactory objects) {
                 }
                 void registerSourceSets(BuildVariantsExtension variants, NamedDomainObjectContainer<GenericSourceSet> sources) {
+                    if (sourceSetsRegistered) {
+                        throw new InvalidUserDataException("variantSources source sets are already registered");
+                    }
                     validateBindings(variants);
                     var usages = layerUsages(variants).toList();
                             registeredContexts.size() - registeredBefore,
                             boundContexts.size() - boundBefore,
                             sourceSetsByName.size());
+                    sourceSetsRegistered = true;
                 }
                 private Stream<LayerUsage> layerUsages(BuildVariantsExtension variants) {

common/src/test/java/org/implab/gradle/common/sources/VariantsPluginFunctionalTest.java +20 -1

@@ -156,7 +156,7 class VariantsPluginFunctionalTest {
156	link('a', 'b', null)	156	link('a', 'b', null)
157	}	157	}
158	}	158	}
159	""", "has incomplete link (from/to/kind are required)");	159	""", "Link 'kind' must not be null or blank");
160	}	160	}
161		161
162	@Test	162	@Test
@@ -224,6 +224,25 class VariantsPluginFunctionalTest {
224	}	224	}
225		225
226	@Test	226	@Test
		227	void failsOnDuplicatedLayerReferenceInRole() throws Exception {
		228	assertBuildFails("""
		229	plugins {
		230	id 'org.implab.gradle-variants'
		231	}
		232
		233	variants {
		234	layer('a')
		235
		236	variant('browser') {
		237	role('main') {
		238	layers('a', 'a')
		239	}
		240	}
		241	}
		242	""", "contains duplicated layer reference 'a'");
		243	}
		244
		245	@Test
227	void failsOnLateLayerMutationAfterFinalize() throws Exception {	246	void failsOnLateLayerMutationAfterFinalize() throws Exception {
228	assertBuildFails("""	247	assertBuildFails("""
229	plugins {	248	plugins {

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages