#!/usr/bin/env expect
############################################################################
# Purpose: Test of Slurm functionality
#          Test of --het-group option.
#
# 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) 2017 SchedMD LLC.
# Written by Isaac Hartung <ihartung@schedmd.com>
#
# 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 test_id     "38.9"
set exit_code	0
set prompt	"PROMPT:"
set task_num	2

print_header $test_id

if {[test_front_end]} {
        send_user "\nWARNING: This test is incompatible with front-end systems\n"
        exit $exit_code
}
if {[test_hetjob_step] == 0} {
	send_user "\nWARNING: heterogeneous steps not currently supported\n"
	exit $exit_code
}

set def_part_name [default_partition]
set nb_nodes [get_node_cnt_in_part $def_part_name]
if {$nb_nodes < 3} {
	send_user "\nWARNING: Need 3 or more nodes in default partition\n"
	exit $exit_code
}

proc end_it { exit_code } {
	global het_job_id scancel
	if {$het_job_id > 0} {
		exec $scancel $het_job_id
	}
	exit $exit_code
}

set het_job_id 0
set matches 0
set index 0
set component(0) 0
set timeout $max_job_delay
set sid [spawn $salloc -t1 -N1 : -N1 : -N1 $bin_bash]
expect {
	-re "Granted job allocation ($number)" {
		set het_job_id $expect_out(1,string)
		send "export PS1=\"$prompt\"\r"
		exp_continue
	}
	-re "export PS1=\"$prompt\"\r" {
		# skip this, just echo of setting prompt"
		exp_continue
	}
	-re "$prompt" {
		#send_user "Job initiated\n"
	}
	timeout {
		log_error "salloc : allocation not granted in $timeout seconds"
		end_it 1
	}
}

if {$het_job_id == 0} {
	log_error "salloc failure"
	end_it 1
}

#
# Reading a second prompt is required by some versions of Expect
#
set timeout 1
expect {
	-re $prompt {
		exp_continue
	}
	timeout {
	}
}
set timeout 30

send_user "\n\nCollect Nodenames\n\n"

send "$squeue -j $het_job_id -o\"NAME=%N\" --noheader \r"
expect {
	-re "--noheader" {
		exp_continue
	}
	-re "NAME=($alpha_numeric_under)" {
		set component($index) $expect_out(1,string)
		incr index
		exp_continue
	}
	-re "$prompt" {
		#break
	}
	timeout {
		log_error "squeue not responding"
		end_it 1
	}
}
if {$index != 3} {
	log_error "squeue failure ($index != 3)"
	end_it 1
}

send_user "\n\nTest Sending Jobs To Various Components\n\n"

set timeout 3
set matches 0

send "$srun --mpi=none --het-group=0 printenv SLURMD_NODENAME\r"
expect {
	-re $component(0) {
		incr matches
		exp_continue
	}
	-re "$prompt" {
		#break
	}
	timeout {
		log_error "srun not responding"
		end_it 1
	}
}
if { $matches != 1} {
	log_error "srun failure $matches $expect_out(buffer)"
	end_it 1
}

set matches 0

send "$srun --mpi=none --het-group=1 printenv SLURMD_NODENAME\r"
expect {
	-re $component(1) {
		incr matches
		exp_continue
	}
	-re "$prompt" {
		#break
	}
	timeout {
		log_error "srun not responding"
		end_it 1
	}
}
if { $matches != 1} {
	log_error "srun failure $matches $expect_out(buffer)"
	end_it 1
}

set matches 0

send "$srun --mpi=none --het-group=2 printenv SLURMD_NODENAME\r"
expect {
	-re $component(2) {
		incr matches
		exp_continue
	}
	-re "$prompt" {
		#break
	}
	timeout {
		log_error "srun not responding"
		end_it 1
	}
}
if { $matches != 1} {
	log_error "srun failure $matches $expect_out(buffer)"
	end_it 1
}

set matches 0

send "$srun --mpi=none --het-group=0-2 printenv SLURMD_NODENAME\r"
expect {
	-re $component(0)|$component(1)|$component(2) {
		incr matches
		exp_continue
	}
	-re "$prompt" {
		#break
	}
	timeout {
		log_error "srun not responding"
		end_it 1
	}
}
if { $matches != 3} {
	log_error "srun failure $matches $expect_out(buffer)"
	end_it 1
}

set matches 0

send "$srun --mpi=none --het-group=0,2 printenv SLURMD_NODENAME\r"
expect {
	-re $component(2)|$component(0) {
		incr matches
		exp_continue
	}
	-re "$prompt" {
		#break
	}
	timeout {
		log_error "srun not responding"
		end_it 1
	}
}
if { $matches != 2} {
	log_error "srun failure $matches $expect_out(buffer)"
	end_it 1
}

send_user "\n\nTesting Error Messages\n\n"


set matches 0

send "$srun --mpi=none --het-group=0-3 printenv SLURMD_NODENAME\r"
expect {
	-re "srun: error: Attempt to run a job step with het group value of 3, but the job allocation has maximum value of 2" {
		send_user "Error is expected, no worries.\n\n"
		incr matches
		exp_continue
	}
	-re "$prompt" {
		#break
	}
	timeout {
		log_error "srun not responding"
		end_it 1
	}
}
if { $matches != 1} {
	log_error "srun failure $matches $expect_out(buffer)"
	end_it 1
}

set matches 0
send "$srun --mpi=none --het-group=0,5 printenv SLURMD_NODENAME\r"
expect {
	-re "srun: error: Attempt to run a job step with het group value of 5, but the job allocation has maximum value of 2" {
		send_user "Error is expected, no worries.\n\n"
		incr matches
		exp_continue
	}
	-re "$prompt" {
		#break
	}
	timeout {
		log_error "srun not responding"
		end_it 1
	}
}
if { $matches != 1} {
	log_error "srun failure $matches $expect_out(buffer)"
	end_it 1
}

set matches 0
send "$srun --mpi=none --het-group=0 printenv SLURMD_NODENAME : --het-group=0 env\r"
expect {
	-re "srun: fatal: Duplicate het groups in single srun not supported" {
		send_user "Error is expected, no worries.\n\n"
		incr matches
		exp_continue
	}
	-re "$prompt" {
		#break
	}
	timeout {
		log_error "srun not responding"
		end_it 1
	}
}
if { $matches != 1} {
	log_error "srun failure $matches $expect_out(buffer)"
	end_it 1
}

send "exit\r"

send_user "\nSUCCESS\n"
exit 0