/*
 *	aegis - project change supervisor
 *	Copyright (C) 2000, 2001 Peter Miller;
 *	All rights reserved.
 *
 *	This program 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.
 *
 *	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 General Public License for more details.
 *
 *	You should have received a copy of the GNU General Public License
 *	along with this program; if not, write to the Free Software
 *	Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
 *
 * MANIFEST: functions to manipulate batchs
 */

#include <change.h>
#include <change/env_set.h>
#include <change/file.h>
#include <change/test/batch.h>
#include <change/test/batch_result.h>
#include <error.h> /* for assert */
#include <fstate.h>
#include <os.h>
#include <pconf.h>
#include <project.h>
#include <project/file.h>
#include <str_list.h>
#include <sub.h>
#include <trace.h>
#include <tstrslt.h>
#include <undo.h>
#include <user.h>


batch_result_list_ty *
change_test_batch(cp, wlp, up, bl)
	change_ty	*cp;
	string_list_ty	*wlp;
	user_ty		*up;
	int		bl;
{
	sub_context_ty	*scp;
	int		flags;
	batch_result_list_ty *result;
	tstrslt		tstrslt_data;
	string_ty	*the_command;
	string_ty	*s;
	string_ty	*output_file_name;
	pconf		pconf_data;
	size_t		j, k;
	string_ty	*dir;
	string_list_ty	wl2;

	trace(("change_test_batch(cp = %08lX, wlp = %08lX, up = %08lX, bl = %d)\n{\n",
		(long)cp, (long)wlp, (long)up, bl));
	pconf_data = change_pconf_get(cp, 1);
	the_command = pconf_data->batch_test_command;
	assert(the_command);

	/*
	 * resolve the file names
	 */
	trace(("mark\n"));
	string_list_constructor(&wl2);
	for (j = 0; j < wlp->nstrings; ++j)
	{
		string_ty	*fn;
		string_ty	*fn_abs;
		fstate_src	src_data;

		fn = wlp->string[j];
		src_data = change_file_find(cp, fn);
		if (src_data)
		{
			fn_abs = change_file_path(cp, fn);
		}
		else
		{
			src_data = project_file_find(cp->pp, fn);
			assert(src_data);
			fn_abs = project_file_path(cp->pp, fn);
		}
		assert(fn_abs);
		string_list_append(&wl2, fn_abs);
		str_free(fn_abs);
	}

	trace(("mark\n"));
	assert(cp->reference_count >= 1);
	scp = sub_context_new();
	s = wl2str(&wl2, 0, wl2.nstrings, (char *)0);
	sub_var_set_string(scp, "File_Names", s);
	str_free(s);
	trace(("mark\n"));
	output_file_name = os_edit_filename(0);
	sub_var_set_string(scp, "Output", output_file_name);
	if (bl && !cp->bogus)
	{
		string_list_ty	spbl;

		string_list_constructor(&spbl);
		project_search_path_get(cp->pp, &spbl, 0);
		s = wl2str(&spbl, 0, spbl.nstrings, ":");
		sub_var_set_string(scp, "Search_Path_Executable", s);
		str_free(s);
		sub_var_override(scp, "Search_Path_Executable");
		string_list_destructor(&spbl);
	}
	user_become(up);
	undo_unlink_errok(output_file_name);
	user_become_undo();
	the_command = substitute(scp, cp, the_command);
	sub_context_delete(scp);

	/*
	 * we need input if any of the tests are manual
	 */
	trace(("mark\n"));
	flags = OS_EXEC_FLAG_NO_INPUT;
	for (j = 0; j < wlp->nstrings; ++j)
	{
		string_ty	*file_name;
		fstate_src	src_data;

		file_name = wlp->string[j];
		src_data = change_file_find(cp,  file_name);
		if (!src_data)
			src_data = project_file_find(cp->pp, file_name);
		assert(src_data);
		if (src_data && src_data->usage == file_usage_manual_test)
		{
			flags = OS_EXEC_FLAG_INPUT;
			break;
		}
	}

	/*
	 * directory depends on the state of the change
	 *
	 * During long tests the automounter can unmount the
	 * directory referenced by the ``dir'' variable.
	 * To minimize this, it is essential that they are
	 * unresolved, and thus always trigger the automounter.
	 */
	trace(("mark\n"));
	dir = project_baseline_path_get(cp->pp, 0);
	if (!bl && !cp->bogus)
	{
		cstate		cstate_data;

		cstate_data = change_cstate_get(cp);
		switch (cstate_data->state)
		{
		case cstate_state_awaiting_development:
			assert(0);

		case cstate_state_completed:
			break;

		case cstate_state_being_integrated:
			dir = change_integration_directory_get(cp, 0);
			break;

		case cstate_state_being_developed:
		case cstate_state_awaiting_review:
		case cstate_state_being_reviewed:
		case cstate_state_awaiting_integration:
			dir = change_development_directory_get(cp, 0);
			break;
		}
	}

	/*
	 * run the command
	 *	This tests all of the files at once.
	 */
	trace(("mark\n"));
	change_env_set(cp, 1);
	user_become(up);
	os_execute(the_command, flags, dir);
	str_free(the_command);

	/*
	 * read the output
	 */
	trace(("mark\n"));
	tstrslt_data = tstrslt_read_file(output_file_name);
	os_unlink_errok(output_file_name);
	os_become_undo();
	if (!tstrslt_data->test_result)
		tstrslt_data->test_result = tstrslt_test_result_list_type.alloc();

	/*
	 * transcribe the result structure
	 */
	trace(("mark\n"));
	result = batch_result_list_new();
	for (j = 0; j < tstrslt_data->test_result->length; ++j)
	{
		/*
		 * perform sanity checks
		 */
		tstrslt_test_result p;
		p = tstrslt_data->test_result->list[j];
		if (!p->file_name)
			goto yuck;
		for (k = 0; k < wlp->nstrings; ++k)
		{
			if (str_equal(p->file_name, wl2.string[k]))
			{
				/*
				 * map abs name to relative name
				 */
				str_free(p->file_name);
				p->file_name = str_copy(wlp->string[k]);
				break;
			}
		}
		if
		(
			!string_list_member(wlp, p->file_name)
		||
			batch_result_list_member(result, p->file_name)
		)
		{
			yuck:
			scp = sub_context_new();
			sub_var_set_string(scp, "File_Name", output_file_name);
			sub_var_set_charstar(scp, "FieLD_Name", "test_result.file_name");
			change_fatal
			(
				cp,
				scp,
			      i18n("$filename: corrupted \"$field_name\" field")
			);
			/* NOTREACHED */
			sub_context_delete(scp);
		}

		/*
		 * add result to list
		 */
		batch_result_list_append(result, p->file_name, p->exit_status);

		/*
		 * emit verbose messages
		 */
		switch (p->exit_status)
		{
		case 1:
			if (bl)
			{
				scp = sub_context_new();
				sub_var_set_string(scp, "File_Name", p->file_name);
				change_verbose(cp, scp, i18n("$filename baseline fail, good"));
				sub_context_delete(scp);
				result->pass_count++;
			}
			else
			{
				scp = sub_context_new();
				sub_var_set_string(scp, "File_Name", p->file_name);
				change_verbose(cp, scp, i18n("$filename fail"));
				sub_context_delete(scp);
				result->fail_count++;
			}
			break;

		case 0:
			if (bl)
			{
				scp = sub_context_new();
				sub_var_set_string(scp, "File_Name", p->file_name);
				change_verbose(cp, scp, i18n("$filename baseline pass, not good"));
				sub_context_delete(scp);
				result->fail_count++;
			}
			else
			{
				scp = sub_context_new();
				sub_var_set_string(scp, "File_Name", p->file_name);
				change_verbose(cp, scp, i18n("$filename pass"));
				sub_context_delete(scp);
				result->pass_count++;
			}
			break;
		
		default:
			scp = sub_context_new();
			sub_var_set_string(scp, "File_Name", p->file_name);
			change_verbose(cp, scp, i18n("$filename no result"));
			sub_context_delete(scp);
			result->no_result_count++;
			break;
		}
	}
	tstrslt_type.free(tstrslt_data);
	str_free(output_file_name);

	/*
	 * all done
	 */
	trace(("return %08lX;\n", (long)result));
	trace(("}\n"));
	return result;
}