#!/usr/bin/expect
############################################################################
# Purpose: Test of SLURM functionality
#          Validate scontrol requeue of failed or completed job.
#
#
# Output:  "TEST: #.#" followed by "SUCCESS" if test was successful, OR
#          "FAILURE: ..." otherwise with an explanation of the failure, OR
#          anything else indicates a failure mode that must be investigated.
############################################################################
# Copyright (C) 2013 SchedMD LLC
# Written by Nathan Yee <nyee32@schedmd.com>
#
# This file is part of SLURM, a resource management program.
# For details, see <http://slurm.schedmd.com/>.
# Please also read the included file: DISCLAIMER.
#
# SLURM is free software; you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free
# Software Foundation; either version 2 of the License, or (at your option)
# any later version.
#
# SLURM 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 General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along
# with SLURM; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA.
############################################################################
source ./globals

set test_id            "2.21"
set complete_script    "test$test_id\.bash"
set fail_script        "test$test_id\.fail"
set job_id             0
set exit_code          0

print_header $test_id

set min_age [get_min_job_age]
if {$min_age < 10} {
	send_user "\nWARNING: MinJobAge too low for this test ($min_age < 10)\n"
	exit 0
}

# Remove any vestigial scripts
exec $bin_rm -f $complete_script $fail_script

make_bash_script $complete_script "$bin_sleep 20"

make_bash_script $fail_script "BadCommand"

proc check_state { id } {
	global scontrol exit_code

	set job_state 0
	spawn $scontrol show job $id
	expect {
		-re "JobState=PENDING" {
			set job_state 1
			exp_continue
		}
		timeout {
			send_user "\nFAILURE: scontrol is not responding\n"
			set exit_code 0
		}
		eof {
			wait
		}
	}

	if {$job_state != 1} {
		send_user "\nFAILURE: Job $id state was not PENDING after it was requeued\n"
		set exit_code 1
	}
}

proc requeue_job { id } {

	global scontrol exit_code

	spawn $scontrol requeue $id
	expect {
		timeout {
			send_user "\nFAILURE: scontrol is not responding\n"
			set exit_code 1
		}
		eof {
			wait
		}
	}
}

#
# Run a job that will complete
#
spawn $sbatch -N1 -o /dev/null -e /dev/null -t1 $complete_script
expect {
	-re "Submitted batch job ($number)" {
		set job_id $expect_out(1,string)
		exp_continue
	}
	timeout {
		send_user "\nFAILURE: sbatch is not responding\n"
		set exit_code 1
	}
	eof {
		wait
	}
}

if { $job_id == 0 } {
	send_user "\nFAILURE: sbatch did not submit job\n"
	exit 1
}

# Wait for the job to be in the complete state
wait_for_job $job_id DONE

# Requeue the job when it is complete
requeue_job $job_id

# Check to see if the job state is PENDING after the requeue
check_state $job_id

cancel_job $job_id

#
# Run a job that will fail
#
set job_id 0
spawn $sbatch -N1 -o /dev/null -e /dev/null -t 1 $fail_script
expect {
	-re "Submitted batch job ($number)" {
		set job_id $expect_out(1,string)
		exp_continue
	}
	timeout {
		send_user "\nFAILURE: sbatch is not responding\n"
		set exit_code 1
	}
	eof {
		wait
	}
}

if { $job_id == 0 } {
	send_user "\nFAILURE: sbatch did not submit job\n"
	exit
}

# Wait for the job to be in the complete state
wait_for_job $job_id DONE

# Requeue the job when it is complete
requeue_job $job_id

# Check to see if the job state is PENDING after the requeue
check_state $job_id

cancel_job $job_id

if {$exit_code == 0} {
	send_user "\nSUCCESS\n"
	exec $bin_rm -f $complete_script $fail_script
}
exit $exit_code
