SchedulingTaskComparator.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.core;

import org.ow2.proactive.scheduler.common.SchedulerConstants;
import org.ow2.proactive.scheduler.job.InternalJob;
import org.ow2.proactive.scheduler.task.internal.InternalTask;
import org.ow2.proactive.scripting.SelectionScript;


/**
 * SchedulingJobComparator is used to compare jobs for scheduling.
 * The comparison is made on some particular fields described in this class.
 *
 * @author The ProActive Team
 * @since ProActive Scheduling 1.1
 */
public class SchedulingTaskComparator {

    private InternalTask task;

    private int ssHashCode;

    private InternalJob job;

    /**
     * Create a new instance of SchedulingTaskComparator
     *
     * @param task
     */
    public SchedulingTaskComparator(InternalTask task, InternalJob job) {
        this.task = task;
        this.ssHashCode = SelectionScript.hashCodeFromList(task.getSelectionScripts());
        this.job = job;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean equals(Object obj) {
        if (obj == null) {
            return false;
        }
        if (!(obj instanceof SchedulingTaskComparator)) {
            return false;
        }
        if (this == obj) {
            return true;
        }
        //ELSE : get given task comparator
        SchedulingTaskComparator tcomp = (SchedulingTaskComparator) obj;
        if (task == tcomp.task) {
            return true;
        }
        //test whether the selections script are the same
        boolean sameSsHash = (ssHashCode == tcomp.ssHashCode);
        //test whether nodes exclusion are the same (both is null...
        boolean sameNodeEx = (task.getNodeExclusion() == null) && (tcomp.task.getNodeExclusion() == null);
        //...or they are equals
        sameNodeEx = sameNodeEx ||
                     (task.getNodeExclusion() != null && task.getNodeExclusion().equals(tcomp.task.getNodeExclusion()));
        //test whether owner is the same
        boolean sameOwner = this.job.getOwner().equals(tcomp.job.getOwner());
        //test that both tasks have the same priority (to ensure that higher priority tasks are not executed concurrently
        // with lower priority ones)
        boolean samePriority = this.job.getPriority().equals(tcomp.job.getPriority());
        //if the parallel environment is specified for any of tasks => not equal
        boolean isParallel = task.isParallel() || tcomp.task.isParallel();

        boolean selectionScriptUseVariables = (doesSelectionScriptsUseVariables(task) ||
                                               doesSelectionScriptsUseVariables(tcomp.task));

        boolean requireNodeWithTokern = task.getRuntimeGenericInformation()
                                            .containsKey(SchedulerConstants.NODE_ACCESS_TOKEN) ||
                                        tcomp.task.getRuntimeGenericInformation()
                                                  .containsKey(SchedulerConstants.NODE_ACCESS_TOKEN);

        // if topology is specified for any of task => not equal
        // for now topology is allowed only for parallel tasks which is
        // checked before

        //add the 6 tests to the returned value
        return sameSsHash && sameNodeEx && sameOwner && samePriority && !isParallel && !selectionScriptUseVariables &&
               !requireNodeWithTokern;
    }

    private boolean doesSelectionScriptsUseVariables(InternalTask task) {
        if (task.getSelectionScripts() != null) {
            for (SelectionScript script : task.getSelectionScripts()) {
                if (script.getScript().contains(SchedulerConstants.VARIABLES_BINDING_NAME.toString())) {
                    return true;
                }
            }
        }
        return false;
    }

    /**
     * Get the ssHashCode
     *
     * @return the ssHashCode
     */
    public int getSsHashCode() {
        return ssHashCode;
    }

}