optionally enable check for /var nodes even outside container packages (#2)

Author: kwin

README.md

@@ -9,6 +9,14 @@ Validates content packages for invalid usage patterns described in [Debugging AE
 
 *This validator only includes checks which are not yet covered by the [aem-analyser-maven-plugin][aem-analyser-maven-plugin] so it is strongly recommended to also enable the [aem-analyser-maven-plugin][aem-analyser-maven-plugin] in your build.*
 
+# Settings
+
+The following options are supported apart from the default settings mentioned in [FileVault validation][2].
+
+Option | Mandatory | Description
+--- | --- | ---
+allowVarNodeOutsideContainer | no | `true` in case `/var` nodes should be allowed in content packages which do not contain other packages (i.e. are no containers). Otherwise `var` nodes are not even allowed in standalone packages. Default value `true`.
+
 # Included Checks
 
 ## Including `/var` in content package

src/main/java/biz/netcentric/filevault/validator/aem/cloud/AemCloudValidator.java

@@ -27,28 +27,33 @@
 
 public class AemCloudValidator implements NodePathValidator {
 
-    static final String VIOLATION_MESSAGE_STRING = "Using nodes below /var is only allowed in author-specific packages. Further details at https://experienceleague.adobe.com/docs/experience-manager-learn/cloud-service/debugging/debugging-aem-as-a-cloud-service/build-and-deployment.html?lang=en#including-%2Fvar-in-content-package";
+    static final String VIOLATION_MESSAGE_STRING_VAR_NODES_CONDITION_CONTAINER = "only allowed in author-specific packages";
+    static final String VIOLATION_MESSAGE_STRING_VAR_NODES_CONDITION_OVERALL = "not allowed";
+    static final String VIOLATION_MESSAGE_STRING_VAR_NODES = "Using nodes below /var is %s. Consider to use repoinit scripts instead or move that content to another location. Further details at https://experienceleague.adobe.com/docs/experience-manager-learn/cloud-service/debugging/debugging-aem-as-a-cloud-service/build-and-deployment.html?lang=en#including-%%2Fvar-in-content-package";
 
     private final @NotNull ValidationMessageSeverity defaultSeverity;
     private final ValidationContext containerValidationContext;
     private boolean foundViolation;
 
-    public AemCloudValidator(@Nullable ValidationContext containerValidationContext, @NotNull ValidationMessageSeverity defaultSeverity) {
+    private boolean allowVarNodesOutsideContainers;
+
+    public AemCloudValidator(boolean allowVarNodesOutsideContainers, @Nullable ValidationContext containerValidationContext, @NotNull ValidationMessageSeverity defaultSeverity) {
         super();
         this.containerValidationContext = containerValidationContext;
         this.defaultSeverity = defaultSeverity;
         this.foundViolation = false;
+        this.allowVarNodesOutsideContainers = allowVarNodesOutsideContainers;
     }
 
     @Override
     public Collection<ValidationMessage> validate(@NotNull String path) {
-        // only check if within a container
-        if (containerValidationContext != null && !foundViolation) {
+        if (!foundViolation && path.startsWith("/var/")) {
             // check if package itself is only used on author
-            if (path.startsWith("/var/") && !isContainedInAuthorOnlyPackage(containerValidationContext)) {
+            if (!allowVarNodesOutsideContainers || !isContainedInAuthorOnlyPackage(containerValidationContext)) {
                 // only emit once per package
                 foundViolation = true;
-                return Collections.singleton(new ValidationMessage(defaultSeverity, VIOLATION_MESSAGE_STRING));
+                return Collections.singleton(new ValidationMessage(defaultSeverity, String.format(
+                        VIOLATION_MESSAGE_STRING_VAR_NODES, allowVarNodesOutsideContainers ? VIOLATION_MESSAGE_STRING_VAR_NODES_CONDITION_CONTAINER : VIOLATION_MESSAGE_STRING_VAR_NODES_CONDITION_OVERALL)));
             }
         }
         return null;

src/main/java/biz/netcentric/filevault/validator/aem/cloud/AemCloudValidatorFactory.java

@@ -19,13 +19,25 @@
 import org.apache.jackrabbit.vault.validation.spi.ValidatorSettings;
 import org.jetbrains.annotations.NotNull;
 import org.kohsuke.MetaInfServices;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 
 @MetaInfServices
 public class AemCloudValidatorFactory implements ValidatorFactory {
 
+    private static final Logger LOGGER = LoggerFactory.getLogger(AemCloudValidatorFactory.class);
+
+    private static final String OPTION_ALLOW_VAR_NODE_OUTSIDE_CONTAINERS = "allowVarNodeOutsideContainer";
+    
     @Override
     public Validator createValidator(@NotNull ValidationContext context, @NotNull ValidatorSettings settings) {
-        return new AemCloudValidator(context.getContainerValidationContext(), settings.getDefaultSeverity());
+        boolean allowVarNodesOutsideContainers = true;
+        if (settings.getOptions().containsKey(OPTION_ALLOW_VAR_NODE_OUTSIDE_CONTAINERS)) {
+            allowVarNodesOutsideContainers = Boolean.parseBoolean(settings.getOptions().get(OPTION_ALLOW_VAR_NODE_OUTSIDE_CONTAINERS));
+        }
+        LOGGER.debug("netcentric-aem-cloud: Allow /var nodes outside containers: {}", allowVarNodesOutsideContainers);
+        return new AemCloudValidator(allowVarNodesOutsideContainers, context.getContainerValidationContext(), settings.getDefaultSeverity());
     }
 
     @Override