#!/usr/bin/env expect
############################################################################
# Purpose: Test of Slurm functionality
#          Test that a job executes with the specified nodes, requires multiple
#          nodes (--nodes, --nodelist and --exclude options).
############################################################################
# Copyright (C) 2002-2006 The Regents of the University of California.
# Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
# Written by Morris Jette <jette1@llnl.gov>
# CODE-OCEC-09-009. All rights reserved.
#
# This file is part of Slurm, a resource management program.
# For details, see <https://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 exit_code        0
set file_in          "test$test_id.input"
set file_out         "test$test_id.output"
set job_id           0

#
# Submit a 3+ node job
#
set host_0      ""
set host_1      ""
set host_2      ""
set host_3      ""
set node_cnt 3

set available [available_nodes]
if {$available < $node_cnt} {
    skip "Not enough nodes currently available ($available avail, $node_cnt needed)"
}

#
# Build input script file
#
make_bash_script $file_in "$srun -l $bin_printenv SLURMD_NODENAME"

#
# Run job to determine what nodes are available
#
spawn $sbatch -N$node_cnt -vv -t1 --output=$file_out $file_in
expect {
	-re "nodes *: ($number)" {
		if {$expect_out(1,string) != $node_cnt} {
			log_error "Failed to process --nodes option ($expect_out(1,string) != $node_cnt)"
			set exit_code 1
		}
		exp_continue
	}
	-re "Submitted batch job ($number)" {
		set job_id $expect_out(1,string)
		exp_continue
	}
	timeout {
		log_error "sbatch not responding"
		set exit_code 1
	}
	eof {
		wait
	}
}
if {$job_id == 0} {
	fail "Job not submitted"
}
if {[wait_for_job $job_id "DONE"] != 0} {
	cancel_job $job_id
	fail "Job did not complete"
}
if {[wait_for_file $file_out] != 0} {
	fail "No output file"
}
spawn $bin_cat $file_out
expect {
	-re "($number): *($re_word_str)" {
		if {$expect_out(1,string) == 0} {
			set host_0 $expect_out(2,string)
		}
		if {$expect_out(1,string) == 1} {
			set host_1 $expect_out(2,string)
		}
		if {$expect_out(1,string) == 2} {
			set host_2 $expect_out(2,string)
		}
		if {$expect_out(1,string) == 3} {
			set host_3 $expect_out(2,string)
		}
		exp_continue
	}
	eof {
		wait
	}
}

#
# Verify node count
#
if {[string compare $host_0 ""] == 0} {
	log_error "Did not get hostname of task 0"
	set exit_code   1
}
if {[string compare $host_1 ""] == 0} {
	log_error "Did not get hostname of task 1"
	set exit_code   1
}
if {[string compare $host_2 ""] == 0} {
	log_error "Did not get hostname of task 2"
	set exit_code   1
}
if {[test_front_end] != 0} {
	if {$exit_code == 0} {
		exec $bin_rm -f $file_in $file_out
	}
	skip "Additional testing is incompatible with front-end systems"
}
if {[string compare $host_3 ""] != 0} {
	log_error "Started more than three tasks"
	set exit_code   1
}

set dup_hostname 0
if {[string compare $host_0 $host_1] == 0} {
	incr dup_hostname
}
if {[string compare $host_0 $host_2] == 0} {
	incr dup_hostname 1
}
if {$dup_hostname == 1} {
	log_error "Re-used a node in the allocation"
	set exit_code   1
}
set exclude_node $host_0
set include_node $host_2

#
# Submit a job explicitly excluding a node
#
set job_id      0
set host_0      ""
set host_1      ""
set host_2      ""
exec $bin_rm -f $file_out
spawn $sbatch -N2 --exclude=$exclude_node -t1 --output=$file_out $file_in
expect {
	-re "Submitted batch job ($number)" {
		set job_id $expect_out(1,string)
		exp_continue
	}
	timeout {
		log_error "sbatch not responding"
		set exit_code 1
	}
	eof {
		wait
	}
}
if {[wait_for_job $job_id "DONE"] != 0} {
	log_error "Job did not complete"
	set exit_code 1
}
if {[wait_for_file $file_out] != 0} {
	fail "No output file"
}
spawn $bin_cat $file_out
expect {
	-re "($number): *($re_word_str)" {
		if {$expect_out(1,string) == 0} {
			set host_0 $expect_out(2,string)
		}
		if {$expect_out(1,string) == 1} {
			set host_1 $expect_out(2,string)
		}
		if {$expect_out(1,string) == 2} {
			set host_2 $expect_out(2,string)
		}
		exp_continue
	}
	eof {
		wait
	}
}

#
# Verify node count and names
#
if {[string compare $host_0 ""] == 0} {
	log_error "Did not get hostname of task 0"
	set exit_code   1
}
if {[string compare $host_1 ""] == 0} {
	log_error "Did not get hostname of task 1"
	set exit_code   1
}
if {[string compare $host_2 ""] != 0} {
	log_error "Started more than two tasks"
	set exit_code   1
}
set dup_hostname 0
if {[string compare $host_0 $exclude_node] == 0} {
	set dup_hostname 1
}
if {[string compare $host_1 $exclude_node] == 0} {
	set dup_hostname 1
}
if {$dup_hostname == 1} {
	log_error "Allocated an excluded node"
	set exit_code   1
}

#
# Submit a job explicitly including a node
#
set job_id      0
set host_0      ""
set host_1      ""
exec $bin_rm -f $file_out
spawn $sbatch -N1 --nodelist=$include_node -t1 --output=$file_out $file_in
expect {
	-re "Submitted batch job ($number)" {
		set job_id $expect_out(1,string)
		exp_continue
	}
	timeout {
		log_error "sbatch not responding"
		set exit_code 1
	}
	eof {
		wait
	}
}
if {[wait_for_job $job_id "DONE"] != 0} {
	log_error "Job did not complete"
	set exit_code 1
}
if {[wait_for_file $file_out] != 0} {
	fail "No output file"
}
spawn $bin_cat $file_out
expect {

	-re "($number): *($re_word_str)" {
		if {$expect_out(1,string) == 0} {
			set host_0 $expect_out(2,string)
		}
		if {$expect_out(1,string) == 1} {
			set host_1 $expect_out(2,string)
		}
		exp_continue
	}
	eof {
		wait
	}
}

#
# Verify node count and names
#
if {[string compare $host_0 ""] == 0} {
	fail "Did not get hostname of task 0"
}
if {[string compare $host_1 ""] != 0} {
	fail "Started more than one task"
}
set dup_hostname 0
if {[string compare $host_0 $include_node] == 0} {
	set dup_hostname 1
}
if {$dup_hostname == 0} {
	fail "Allocation lacked an included node"
}

if {$exit_code == 0} {
	exec $bin_rm -f $file_in $file_out
} else {
	fail "Test failed due to previous errors (\$exit_code = $exit_code)"
}