Bug 382682, Add makefile target to launch interactive xpcshell for debugging. Patch by Alex Vincent

config/rules.mk

@@ -1927,6 +1927,17 @@ check::
 	      $(DEPTH)/_tests/xpcshell-simple/$(MODULE)/$$testdir; \
 	done
 
+# Test execution
+check-interactive::
+	@$(EXIT_ON_ERROR) \
+	$(RUN_TEST_PROGRAM) \
+	  $(topsrcdir)/tools/test-harness/xpcshell-simple/test_one.sh \
+	    $(DIST)/bin/xpcshell \
+	    $(FWDSLASH_TOPSRCDIR) \
+	    $(NATIVE_TOPSRCDIR) \
+	    $(DEPTH)/_tests/xpcshell-simple/$(MODULE)/$$testdir \
+	    $(SOLO_FILE);
+
 endif # XPCSHELL_TESTS
 
 endif # ENABLE_TESTS
@@ -2067,7 +2078,7 @@ endif
 # Fake targets.  Always run these rules, even if a file/directory with that
 # name already exists.
 #
-.PHONY: all all_platforms alltags boot checkout chrome realchrome clean clobber clobber_all export install libs makefiles realclean run_viewer run_apprunner tools $(DIRS) $(TOOL_DIRS) FORCE check
+.PHONY: all all_platforms alltags boot checkout chrome realchrome clean clobber clobber_all export install libs makefiles realclean run_viewer run_apprunner tools $(DIRS) $(TOOL_DIRS) FORCE check check-interactive
 
 # Used as a dependency to force targets to rebuild
 FORCE:
@@ -2202,3 +2213,7 @@ documentation:
 check:: $(SUBMAKEFILES) $(MAKE_DIRS)
 	+$(LOOP_OVER_DIRS)
 	+$(LOOP_OVER_TOOL_DIRS)
+
+check-interactive:: $(SUBMAKEFILES) $(MAKE_DIRS)
+	+$(LOOP_OVER_DIRS)
+	+$(LOOP_OVER_TOOL_DIRS)

tools/test-harness/xpcshell-simple/execute_test.js

@@ -0,0 +1,38 @@
+/* ***** BEGIN LICENSE BLOCK *****
+ * Version: MPL 1.1/GPL 2.0/LGPL 2.1
+ *
+ * The contents of this file are subject to the Mozilla Public License Version
+ * 1.1 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ * http://www.mozilla.org/MPL/
+ *
+ * Software distributed under the License is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+ * for the specific language governing rights and limitations under the
+ * License.
+ *
+ * The Original Code is mozilla.org code.
+ *
+ * The Initial Developer of the Original Code is
+ * Alexander J. Vincent <ajvincent@gmail.com>
+ *
+ * Portions created by the Initial Developer are Copyright (C) 2007
+ * the Initial Developer. All Rights Reserved.
+ *
+ * Contributor(s):
+ *
+ * Alternatively, the contents of this file may be used under the terms of
+ * either the GNU General Public License Version 2 or later (the "GPL"), or
+ * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
+ * in which case the provisions of the GPL or the LGPL are applicable instead
+ * of those above. If you wish to allow use of your version of this file only
+ * under the terms of either the GPL or the LGPL, and not to allow others to
+ * use your version of this file under the terms of the MPL, indicate your
+ * decision by deleting the provisions above and replace them with the notice
+ * and other provisions required by the GPL or the LGPL. If you do not delete
+ * the provisions above, a recipient may use your version of this file under
+ * the terms of any one of the MPL, the GPL or the LGPL.
+ *
+ * ***** END LICENSE BLOCK ***** */
+
+_execute_test();

tools/test-harness/xpcshell-simple/tail.js

@@ -35,18 +35,19 @@
  * the terms of any one of the MPL, the GPL or the LGPL.
  *
  * ***** END LICENSE BLOCK ***** */
+function _execute_test() {
+  try {
+    do_test_pending();
+    run_test();
+    do_test_finished();
+    _do_main();
+  } catch (e) {
+    _fail = true;
+    dump(e + "\n");
+  }
 
-try {
-  do_test_pending();
-  run_test();
-  do_test_finished();
-  _do_main();
-} catch (e) {
-  _fail = true;
-  dump(e + "\n");
+  if (_fail)
+    dump("*** FAIL ***\n");
+  else
+    dump("*** PASS ***\n");
 }
-
-if (_fail)
-  dump("*** FAIL ***\n");
-else
-  dump("*** PASS ***\n");

tools/test-harness/xpcshell-simple/test_all.sh

@@ -95,6 +95,7 @@ done
 # files matching the pattern tail_*.js are treated like teardown files
 # - they are run after tail.js
 tailfiles="-f $topsrcdir/tools/test-harness/xpcshell-simple/tail.js"
+tailfiles="$tailfiles -f $topsrcdir/tools/test-harness/xpcshell-simple/execute_test.js"
 for t in $testdir/tail_*.js
 do
     if [ -f $t ]; then

tools/test-harness/xpcshell-simple/test_one.sh

@@ -0,0 +1,134 @@
+#!/bin/sh
+#
+# vim:set ts=2 sw=2 sts=2 et:
+#
+# ***** BEGIN LICENSE BLOCK *****
+# Version: MPL 1.1/GPL 2.0/LGPL 2.1
+#
+# The contents of this file are subject to the Mozilla Public License Version
+# 1.1 (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+# http://www.mozilla.org/MPL/
+#
+# Software distributed under the License is distributed on an "AS IS" basis,
+# WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+# for the specific language governing rights and limitations under the
+# License.
+#
+# The Original Code is mozilla.org code.
+#
+# The Initial Developer of the Original Code is Google Inc.
+# Portions created by the Initial Developer are Copyright (C) 2005
+# the Initial Developer. All Rights Reserved.
+#
+# Contributor(s):
+#  Darin Fisher <darin@meer.net>
+#  Dave Liebreich <davel@mozilla.com>
+#  Jeff Walden <jwalden+code@mit.edu>
+#  Alexander J. Vincent <ajvincent@gmail.com> (single-test mode)
+#
+# Alternatively, the contents of this file may be used under the terms of
+# either the GNU General Public License Version 2 or later (the "GPL"), or
+# the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
+# in which case the provisions of the GPL or the LGPL are applicable instead
+# of those above. If you wish to allow use of your version of this file only
+# under the terms of either the GPL or the LGPL, and not to allow others to
+# use your version of this file under the terms of the MPL, indicate your
+# decision by deleting the provisions above and replace them with the notice
+# and other provisions required by the GPL or the LGPL. If you do not delete
+# the provisions above, a recipient may use your version of this file under
+# the terms of any one of the MPL, the GPL or the LGPL.
+#
+# ***** END LICENSE BLOCK ***** */
+
+# allow core dumps
+ulimit -c 20480 2> /dev/null
+
+# Make assertions fatal
+export XPCOM_DEBUG_BREAK=abort
+
+exit_status=0
+
+# Launch single tests by calling:
+# make SOLO_FILE=(filename) -C (test directory) check-interactive
+# js>_execute_test();
+# js>quit();
+
+##########################
+# COMMAND-LINE ARGUMENTS #
+##########################
+
+# This provides the path to xpcshell.
+xpcshell="$1"
+
+# The directory containing Mozilla source code is specified as the first
+# argument to this script, in a format usable by load() in xpcshell.  This
+# enables do_import_script to work for any JS file in the source tree.
+topsrcdir="$2"
+
+# Tests which depend on files in the source directory will need a native path
+# to actually access those files, or otherwise they must rely on hacks such as
+# getting the current working/process directory and committing other atrocities.
+# This argument is a native path to the top-level source directory, useful for
+# tests which require access to files so that they can access them in a vaguely
+# clean manner.
+native_topsrcdir="$3"
+
+# The sample Makefile for the xpcshell-simple harness adds the directory where
+# the test_*.js files reside as an arg.  If no arg is specified, assume the
+# current directory is where the *.js files live.
+testdir="$4"
+if [ "x$testdir" = "x" ]; then
+    testdir=.
+fi
+
+# The actual JS test to run.
+target_js="$5"
+
+###############################
+# SETUP FOR RUNNING THE TESTS #
+###############################
+
+# files matching the pattern head_*.js are treated like test setup files
+# - they are run after head.js but before the test file
+headfiles="-f $topsrcdir/tools/test-harness/xpcshell-simple/head.js"
+for h in $testdir/head_*.js
+do
+    if [ -f $h ]; then
+	headfiles="$headfiles -f $h"
+    fi
+done
+
+# files matching the pattern tail_*.js are treated like teardown files
+# - they are run after tail.js
+tailfiles="-f $topsrcdir/tools/test-harness/xpcshell-simple/tail.js"
+#tailfiles="$tailfiles -f $topsrcdir/tools/test-harness/xpcshell-simple/execute_test.js"
+for t in $testdir/tail_*.js
+do
+    if [ -f $t ]; then
+	tailfiles="$tailfiles -f $t"
+    fi
+done
+
+
+############
+# RUN TEST #
+############
+
+echo "NATIVE_TOPSRCDIR='$native_topsrcdir' TOPSRCDIR='$topsrcdir' $xpcshell -s $headfiles -f $testdir/unit/$target_js $tailfiles 2>&1"
+echo -n "$target_js: "
+NATIVE_TOPSRCDIR="$native_topsrcdir" TOPSRCDIR="$topsrcdir" $xpcshell -s $headfiles -f $testdir/unit/$target_js $tailfiles -i 2>&1
+if [ `grep -c '\*\*\* PASS' $testdir/unit/$target_js.log` = 0 ]
+then
+    echo "FAIL"
+    echo "$target_js.log:"
+    echo ">>>>>>>"
+    cat $testdir/unit/$target_js.log
+    echo ""
+    echo "<<<<<<<"
+    exit_status=1
+else
+    echo "PASS"
+fi
+
+exit $exit_status