feat: add workflow variable PA:GLOBAL_FOLDER and PA:USER_FOLDER. (#3781)

scheduler/scheduler-api/src/main/java/org/ow2/proactive/scheduler/common/job/factories/spi/model/factory/GlobalFolderParserValidator.java

+/*
+ * ProActive Parallel Suite(TM):
+ * The Open Source library for parallel and distributed
+ * Workflows & Scheduling, Orchestration, Cloud Automation
+ * and Big Data Analysis on Enterprise Grids & Clouds.
+ *
+ * Copyright (c) 2007 - 2017 ActiveEon
+ * Contact: contact@activeeon.com
+ *
+ * This library is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU Affero General Public License
+ * as published by the Free Software Foundation: version 3 of
+ * the License.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * If needed, contact us to obtain a release under GPL Version 2 or 3
+ * or a different license than the AGPL.
+ */
+package org.ow2.proactive.scheduler.common.job.factories.spi.model.factory;
+
+import org.ow2.proactive.scheduler.common.job.factories.spi.model.converter.Converter;
+import org.ow2.proactive.scheduler.common.job.factories.spi.model.converter.IdentityConverter;
+import org.ow2.proactive.scheduler.common.job.factories.spi.model.exceptions.ModelSyntaxException;
+import org.ow2.proactive.scheduler.common.job.factories.spi.model.validator.GlobalFileValidator;
+import org.ow2.proactive.scheduler.common.job.factories.spi.model.validator.GlobalFolderValidator;
+import org.ow2.proactive.scheduler.common.job.factories.spi.model.validator.Validator;
+
+
+public class GlobalFolderParserValidator extends BaseParserValidator<String> {
+
+    public GlobalFolderParserValidator(String model) throws ModelSyntaxException {
+        super(model, ModelType.GLOBAL_FOLDER);
+    }
+
+    public GlobalFolderParserValidator(String model, ModelType type) throws ModelSyntaxException {
+        super(model, type);
+    }
+
+    @Override
+    protected Converter<String> createConverter(String model) throws ModelSyntaxException {
+        return new IdentityConverter();
+    }
+
+    @Override
+    protected Validator<String> createValidator(String model, Converter<String> converter) {
+        return new GlobalFolderValidator();
+    }
+}

scheduler/scheduler-api/src/main/java/org/ow2/proactive/scheduler/common/job/factories/spi/model/factory/ModelType.java

@@ -53,7 +53,9 @@ public enum ModelType {
     HIDDEN(HiddenParserValidator.class, String.class),
     CREDENTIAL(CredentialParserValidator.class, String.class),
     USER_FILE(UserFileParserValidator.class, String.class),
-    GLOBAL_FILE(GlobalFileParserValidator.class, String.class);
+    GLOBAL_FILE(GlobalFileParserValidator.class, String.class),
+    USER_FOLDER(UserFolderParserValidator.class, String.class),
+    GLOBAL_FOLDER(GlobalFolderParserValidator.class, String.class);
 
     // The parser validator of the model type
     private Class<?> typeParserValidator;

scheduler/scheduler-api/src/main/java/org/ow2/proactive/scheduler/common/job/factories/spi/model/factory/UserFolderParserValidator.java

+/*
+ * ProActive Parallel Suite(TM):
+ * The Open Source library for parallel and distributed
+ * Workflows & Scheduling, Orchestration, Cloud Automation
+ * and Big Data Analysis on Enterprise Grids & Clouds.
+ *
+ * Copyright (c) 2007 - 2017 ActiveEon
+ * Contact: contact@activeeon.com
+ *
+ * This library is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU Affero General Public License
+ * as published by the Free Software Foundation: version 3 of
+ * the License.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * If needed, contact us to obtain a release under GPL Version 2 or 3
+ * or a different license than the AGPL.
+ */
+package org.ow2.proactive.scheduler.common.job.factories.spi.model.factory;
+
+import org.ow2.proactive.scheduler.common.job.factories.spi.model.converter.Converter;
+import org.ow2.proactive.scheduler.common.job.factories.spi.model.converter.IdentityConverter;
+import org.ow2.proactive.scheduler.common.job.factories.spi.model.exceptions.ModelSyntaxException;
+import org.ow2.proactive.scheduler.common.job.factories.spi.model.validator.UserFileValidator;
+import org.ow2.proactive.scheduler.common.job.factories.spi.model.validator.UserFolderValidator;
+import org.ow2.proactive.scheduler.common.job.factories.spi.model.validator.Validator;
+
+
+public class UserFolderParserValidator extends BaseParserValidator<String> {
+
+    public UserFolderParserValidator(String model) throws ModelSyntaxException {
+        super(model, ModelType.USER_FOLDER);
+    }
+
+    public UserFolderParserValidator(String model, ModelType type) throws ModelSyntaxException {
+        super(model, type);
+    }
+
+    @Override
+    protected Converter<String> createConverter(String model) throws ModelSyntaxException {
+        return new IdentityConverter();
+    }
+
+    @Override
+    protected Validator<String> createValidator(String model, Converter<String> converter) {
+        return new UserFolderValidator();
+    }
+}

scheduler/scheduler-api/src/main/java/org/ow2/proactive/scheduler/common/job/factories/spi/model/validator/GlobalFolderValidator.java

+/*
+ * ProActive Parallel Suite(TM):
+ * The Open Source library for parallel and distributed
+ * Workflows & Scheduling, Orchestration, Cloud Automation
+ * and Big Data Analysis on Enterprise Grids & Clouds.
+ *
+ * Copyright (c) 2007 - 2017 ActiveEon
+ * Contact: contact@activeeon.com
+ *
+ * This library is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU Affero General Public License
+ * as published by the Free Software Foundation: version 3 of
+ * the License.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * If needed, contact us to obtain a release under GPL Version 2 or 3
+ * or a different license than the AGPL.
+ */
+package org.ow2.proactive.scheduler.common.job.factories.spi.model.validator;
+
+import static org.ow2.proactive.scheduler.common.SchedulerConstants.GLOBALSPACE_NAME;
+
+import org.apache.commons.lang3.StringUtils;
+import org.apache.log4j.Logger;
+import org.ow2.proactive.scheduler.common.exception.NotConnectedException;
+import org.ow2.proactive.scheduler.common.exception.PermissionException;
+import org.ow2.proactive.scheduler.common.job.factories.spi.model.ModelValidatorContext;
+import org.ow2.proactive.scheduler.common.job.factories.spi.model.exceptions.ValidationException;
+
+
+public class GlobalFolderValidator implements Validator<String> {
+    private static final Logger logger = Logger.getLogger(GlobalFolderValidator.class);
+
+    @Override
+    public String validate(String parameterValue, ModelValidatorContext context) throws ValidationException {
+        if (context == null || context.getSpace() == null) {
+            // Sometimes the workflow is parsed and checked without scheduler instance (e.g., submitted from catalog).
+            // In this case, we don't have the access of the scheduler global dataspace, so the validity check is passed.
+            logger.debug(String.format("Can't check the validity of the variable value [%s], because missing the access to the scheduler global data space",
+                                       parameterValue));
+            return parameterValue;
+        }
+
+        // if parameterValue is not a folder existing in data space, we throw ValidationException
+        if (StringUtils.isBlank(parameterValue)) {
+            throw new ValidationException("Please provide a valid folder path in the global space as the variable value.");
+        }
+        try {
+            if (!context.getSpace().checkFileExists(GLOBALSPACE_NAME, parameterValue)) {
+                throw new ValidationException(String.format("Could not find the folder path [%s] in the global data space. Please add the folder into the global data space or change the variable value to a valid path.",
+                                                            parameterValue));
+            }
+            if (!context.getSpace().isFolder(GLOBALSPACE_NAME, parameterValue)) {
+                throw new ValidationException(String.format("The file path [%s] in the global data space is not a folder. Please change the variable value to a valid path of a folder in the global data space.",
+                                                            parameterValue));
+            }
+        } catch (NotConnectedException | PermissionException e) {
+            throw new ValidationException("Could not read global data space files from the scheduler, make sure you are connected and you have permission rights to read global data space files.",
+                                          e);
+        }
+        // the parameterValue should not end with a slash to avoid the problem which may cause in defining data management because of duplicate slash
+        if (parameterValue.endsWith("/")) {
+            throw new ValidationException(String.format("Please remove the slash \"/\" at the end of the folder path [%s].",
+                                                        parameterValue));
+        }
+        return parameterValue;
+    }
+}

scheduler/scheduler-api/src/main/java/org/ow2/proactive/scheduler/common/job/factories/spi/model/validator/UserFolderValidator.java

+/*
+ * ProActive Parallel Suite(TM):
+ * The Open Source library for parallel and distributed
+ * Workflows & Scheduling, Orchestration, Cloud Automation
+ * and Big Data Analysis on Enterprise Grids & Clouds.
+ *
+ * Copyright (c) 2007 - 2017 ActiveEon
+ * Contact: contact@activeeon.com
+ *
+ * This library is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU Affero General Public License
+ * as published by the Free Software Foundation: version 3 of
+ * the License.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * If needed, contact us to obtain a release under GPL Version 2 or 3
+ * or a different license than the AGPL.
+ */
+package org.ow2.proactive.scheduler.common.job.factories.spi.model.validator;
+
+import static org.ow2.proactive.scheduler.common.SchedulerConstants.USERSPACE_NAME;
+
+import org.apache.commons.lang3.StringUtils;
+import org.apache.log4j.Logger;
+import org.ow2.proactive.scheduler.common.exception.NotConnectedException;
+import org.ow2.proactive.scheduler.common.exception.PermissionException;
+import org.ow2.proactive.scheduler.common.job.factories.spi.model.ModelValidatorContext;
+import org.ow2.proactive.scheduler.common.job.factories.spi.model.exceptions.ValidationException;
+
+
+public class UserFolderValidator implements Validator<String> {
+    private static final Logger logger = Logger.getLogger(UserFolderValidator.class);
+
+    @Override
+    public String validate(String parameterValue, ModelValidatorContext context) throws ValidationException {
+        if (context == null || context.getSpace() == null) {
+            // Sometimes the workflow is parsed and checked without scheduler instance (e.g., submitted from catalog).
+            // In this case, we don't have the access of the scheduler user dataspace, so the validity check is passed.
+            logger.debug(String.format("Can't check the validity of the variable value [%s], because missing the access to the scheduler user data space",
+                                       parameterValue));
+            return parameterValue;
+        }
+
+        // if parameterValue is not a folder existing in data space, we throw ValidationException
+        if (StringUtils.isBlank(parameterValue)) {
+            throw new ValidationException("Please provide a valid folder path in the user space as the variable value.");
+        }
+        try {
+            if (!context.getSpace().checkFileExists(USERSPACE_NAME, parameterValue)) {
+                throw new ValidationException(String.format("Could not find the folder path [%s] in the user data space. Please add the folder into the user data space or change the variable value to a valid path.",
+                                                            parameterValue));
+            }
+            if (!context.getSpace().isFolder(USERSPACE_NAME, parameterValue)) {
+                throw new ValidationException(String.format("The file path [%s] in the user data space is not a folder. Please change the variable value to a valid path of a folder in the user data space.",
+                                                            parameterValue));
+            }
+        } catch (NotConnectedException | PermissionException e) {
+            throw new ValidationException("Could not read user data space files from the scheduler, make sure you are connected and you have permission rights to read user data space files.",
+                                          e);
+        }
+        // the parameterValue should not end with a slash to avoid the problem which may cause in defining data management because of duplicate slash
+        if (parameterValue.endsWith("/")) {
+            throw new ValidationException(String.format("Please remove the slash \"/\" at the end of the folder path [%s].",
+                                                        parameterValue));
+        }
+        return parameterValue;
+    }
+}