comm: ensure that input files are sorted

* NEWS: List new behavior.
* doc/coreutils.texi (checkOrderOption) New macro for
describing `--check-order' and `--nocheck-order', used in
both join and comm.
* src/comm.c (main): Initialize new options.
(usage): Describe new options.
(compare_files): Keep an extra pair of buffers for the previous
line from each file to check the internal order.
(check_order): If an order-check is required, compare and handle
the result appropriately.
(copylinebuffer): Copy a linebuffer; used for copy before read.
* tests/misc/Makefile.am: List new test.
* tests/misc/comm: Tests for the comm program, including the
new order-checking functionality and attendant command-line options.

2 files changed, 125 insertions, 0 deletions

diff --git a/tests/Makefile.am b/tests/Makefile.am
index d33005a5f..f07837b5d 100644
--- a/tests/Makefile.am
+++ b/tests/Makefile.am
@@ -146,6 +146,7 @@ TESTS =						\
   misc/base64					\
   misc/basename					\
   misc/close-stdout				\
+  misc/comm					\
   misc/csplit					\
   misc/date-sec					\
   misc/dircolors				\
diff --git a/tests/misc/comm b/tests/misc/comm
new file mode 100755
index 000000000..39557d2c1
--- /dev/null
+++ b/tests/misc/comm
@@ -0,0 +1,124 @@
+#!/usr/bin/perl
+# -*- perl -*-
+# Test comm
+
+# Copyright (C) 2008 Free Software Foundation, Inc.
+
+# 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 3 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, see <http://www.gnu.org/licenses/>.
+
+require 5.003;
+use strict;
+
+(my $program_name = $0) =~ s|.*/||;
+
+my $prog = 'comm';
+
+# Turn off localization of executable's ouput.
+@ENV{qw(LANGUAGE LANG LC_ALL)} = ('C') x 3;
+
+my @inputs = ({IN=>{a=>"1\n3"}}, {IN=>{b=>"2\n3"}});
+
+my @Tests =
+  (
+   # basic operation
+   ['basic', @inputs, {OUT=>"1\n\t2\n\t\t3\n"} ],
+
+   # supress lines unique to file 1
+   ['opt-1', '-1', @inputs, {OUT=>"2\n\t3\n"} ],
+
+   # supress lines unique to file 2
+   ['opt-2', '-2', @inputs, {OUT=>"1\n\t3\n"} ],
+
+   # supress lines that appear in both files
+   ['opt-3', '-3', @inputs, {OUT=>"1\n\t2\n"} ],
+
+   # supress lines unique to file 1 and lines unique to file 2
+   ['opt-12', '-1', '-2', @inputs, {OUT=>"3\n"} ],
+
+   # supress lines unique to file 1 and those that appear in both files
+   ['opt-13', '-1', '-3', @inputs, {OUT=>"2\n"} ],
+
+   # supress lines unique to file 2 and those that appear in both files
+   ['opt-23', '-2', '-3', @inputs, {OUT=>"1\n"} ],
+
+   # supress all output (really?)
+   ['opt-123', '-1', '-2', '-3', @inputs, {OUT=>""} ],
+
+   # invalid missing command line argument (1)
+   ['missing-arg1', $inputs[0], {EXIT=>1},
+    {ERR => "$prog: missing operand after `a'\n"
+	. "Try `$prog --help' for more information.\n"}],
+
+   # invalid missing command line argument (both)
+   ['missing-arg2', {EXIT=>1},
+    {ERR => "$prog: missing operand\n"
+	. "Try `$prog --help' for more information.\n"}],
+
+   # invalid extra command line argument
+   ['extra-arg', @inputs, 'no-such', {EXIT=>1},
+    {ERR => "$prog: extra operand `no-such'\n"
+	. "Try `$prog --help' for more information.\n"}],
+
+   # out-of-order input
+   ['ooo', {IN=>{a=>"1\n3"}}, {IN=>{b=>"3\n2"}}, {EXIT=>1},
+    {OUT => "1\n\t\t3\n\t2\n"},
+    {ERR => "$prog: file 2 is not in sorted order\n"}],
+
+   # out-of-order input, fatal
+   ['ooo2', '--check-order', {IN=>{a=>"1\n3"}}, {IN=>{b=>"3\n2"}}, {EXIT=>1},
+    {OUT => "1\n\t\t3\n"},
+    {ERR => "$prog: file 2 is not in sorted order\n"}],
+
+   # out-of-order input, ignored
+   ['ooo3', '--nocheck-order', {IN=>{a=>"1\n3"}}, {IN=>{b=>"3\n2"}},
+    {OUT => "1\n\t\t3\n\t2\n"}],
+
+   # both inputs out-of-order
+   ['ooo4', {IN=>{a=>"3\n1\n0"}}, {IN=>{b=>"3\n2\n0"}}, {EXIT=>1},
+    {OUT => "\t\t3\n1\n0\n\t2\n\t0\n"},
+    {ERR => "$prog: file 1 is not in sorted order\n".
+	    "$prog: file 2 is not in sorted order\n" }],
+
+   # both inputs out-of-order on last pair
+   ['ooo5', {IN=>{a=>"3\n1"}}, {IN=>{b=>"3\n2"}}, {EXIT=>1},
+    {OUT => "\t\t3\n1\n\t2\n"},
+    {ERR => "$prog: file 1 is not in sorted order\n".
+	    "$prog: file 2 is not in sorted order\n" }],
+
+   # first input out-of-order extended
+   ['ooo5b', {IN=>{a=>"0\n3\n1"}}, {IN=>{b=>"2\n3"}}, {EXIT=>1},
+    {OUT => "0\n\t2\n\t\t3\n1\n"},
+    {ERR => "$prog: file 1 is not in sorted order\n"}],
+
+   # second input out-of-order extended
+   ['ooo5c', {IN=>{a=>"0\n3"}}, {IN=>{b=>"2\n3\n1"}}, {EXIT=>1},
+    {OUT => "0\n\t2\n\t\t3\n\t1\n"},
+    {ERR => "$prog: file 2 is not in sorted order\n"}],
+
+   # both inputs out-of-order, but fully pairable
+   ['ooo6', {IN=>{a=>"2\n1\n0"}}, {IN=>{b=>"2\n1\n0"}}, {EXIT=>0},
+    {OUT => "\t\t2\n\t\t1\n\t\t0\n"}],
+
+   # both inputs out-of-order, fully pairable, but forced to fail
+   ['ooo7', '--check-order', {IN=>{a=>"2\n1\n0"}}, {IN=>{b=>"2\n1\n0"}},
+    {EXIT=>1},
+    {OUT => "\t\t2\n"},
+    {ERR => "$prog: file 1 is not in sorted order\n"}],
+ );
+
+my $save_temps = $ENV{DEBUG};
+my $verbose = $ENV{VERBOSE};
+
+my $fail = run_tests ($program_name, $prog, \@Tests, $save_temps, $verbose);
+exit $fail;