Tests and repairs for stg log

Add t0009-log.sh to test `stg log`.

Use `tformat` instead of `format` in default output format. There is no
trailing newline when regular `format`, while `tformat` ensures a
terminating newline.

Check for invalid option and argument combination before performing any
actions. New checks ensure that --clear is used by itself.

Signed-off-by: Peter Grayson <[email protected]>

Author: jpgrayson

stgit/commands/log.py

@@ -95,17 +95,30 @@ def show_log(stacklog, pathlim, num, full, show_diff):
     if show_diff:
         cmd.append('-p')
     elif not full:
-        cmd.append('--pretty=format:%h   %aD   %s')
+        cmd.append('--pretty=tformat:%h   %aD   %s')
     cmd.extend([stacklog.sha1, '--'])
     cmd.extend(pathlim)
     Run(*cmd).run()
 
 
 def func(parser, options, args):
-    if options.branch:
-        stack = directory.repository.get_stack(options.branch)
-    else:
-        stack = directory.repository.current_stack
+    if options.clear:
+        if (
+            options.diff
+            or options.number
+            or options.full
+            or options.graphical
+        ):
+            parser.error('cannot combine --clear with other options')
+        elif args:
+            parser.error('cannot combine --clear with patch arguments')
+
+    if options.graphical:
+        for o in ['diff', 'number', 'full']:
+            if getattr(options, o):
+                parser.error('cannot combine --graphical and --%s' % o)
+
+    stack = directory.repository.get_stack(options.branch)
     patches = common.parse_patches(args, list(stack.patchorder.all))
     logref = log.log_ref(stack.name)
     try:
@@ -122,9 +135,6 @@ def func(parser, options, args):
     pathlim = [os.path.join('patches', pn) for pn in patches]
 
     if options.graphical:
-        for o in ['diff', 'number', 'full']:
-            if getattr(options, o):
-                parser.error('cannot combine --graphical and --%s' % o)
         cmd = ['gitk', stacklog.simplified.sha1, '--'] + pathlim
         # Discard the exit codes generated by SIGINT, SIGKILL, and SIGTERM.
         Run(*cmd).returns([0, -2, -9, -15]).run()

t/t0009-log.sh

@@ -0,0 +1,130 @@
+#!/bin/sh
+
+test_description='Test the log command.'
+
+. ./test-lib.sh
+
+test_expect_success 'Attempt log on uninitialized branch' '
+    command_error stg log 2>&1 >/dev/null | grep -e "branch not initialized"
+'
+
+test_expect_success 'Initialize the StGIT repository' '
+    stg init
+'
+
+test_expect_success 'Empty log' '
+    stg log 2>&1 >/dev/null | grep -e "Log is empty"
+'
+
+test_expect_success 'Add some patches' '
+    test_commit p0 file0.txt foo0 &&
+    test_commit p1 file1.txt foo1 &&
+    test_commit p2 file2.txt foo2 &&
+    test_commit p3 file3.txt foo3 &&
+    stg uncommit -n 4
+'
+
+test_expect_success 'Test log of all patches' '
+    stg log | head -n 1 | grep -e "uncommit"
+'
+
+test_expect_success 'Test invalid opts with clear' '
+    command_error stg log --diff --clear 2>&1 >/dev/null |
+    grep -e "cannot combine --clear with other options" &&
+    stg log | head -n 1 | grep -e "uncommit"
+'
+
+test_expect_success 'Test invalid args with clear' '
+    command_error stg log --clear p0 p1 2>&1 >/dev/null |
+    grep -e "cannot combine --clear with patch arguments" &&
+    stg log | head -n 1 | grep -e "uncommit"
+'
+
+test_expect_success 'Test invalid opts with graphical' '
+    command_error stg log --graphical -n 5 p0 p1 2>&1 >/dev/null |
+    grep -e "cannot combine --graphical and --number"
+'
+
+test_expect_success 'Test log full' '
+    stg log --full > log.txt &&
+    test_line_count = 5 log.txt &&
+    head -n 1 log.txt | tail -n 1 | grep -e "commit"
+    head -n 2 log.txt | tail -n 1 | grep -e "Author: A Ú Thor"
+    head -n 3 log.txt | tail -n 1 | grep -e "Date: "
+    head -n 4 log.txt | tail -n 1 | grep -E "^$"
+    head -n 5 log.txt | tail -n 1 | grep -E "^    uncommit"
+'
+
+test_expect_success 'Make changes to patches' '
+    stg goto p1 &&
+    echo "bar1" > file1.txt &&
+    stg refresh &&
+    echo "baz1" > file1.txt &&
+    stg refresh &&
+    stg goto p2 &&
+    echo "bar2" > file2.txt &&
+    stg refresh &&
+    stg goto p3 &&
+    stg edit --sign
+'
+
+test_expect_success 'Verify log for p0' '
+    stg log p0 > log.txt &&
+    test_line_count = 1 log.txt &&
+    grep -e "uncommit" log.txt
+'
+
+test_expect_success 'Log with diff' '
+    stg log --diff p0 > log.txt &&
+    grep -e "diff --git a/patches/p0 b/patches/p0" log.txt
+'
+
+test_expect_success 'Verify log for p1' '
+    stg log p1 > log.txt &&
+    test_line_count = 3 log.txt &&
+    head -n 1 log.txt | tail -n 1 | grep -e "refresh" &&
+    head -n 2 log.txt | tail -n 1 | grep -e "refresh" &&
+    head -n 3 log.txt | tail -n 1 | grep -e "uncommit"
+'
+
+test_expect_success 'Verify log for p2' '
+    stg log p2 > log.txt &&
+    test_line_count = 3 log.txt &&
+    head -n 1 log.txt | tail -n 1 | grep -e "refresh" &&
+    head -n 2 log.txt | tail -n 1 | grep -e "goto" &&
+    head -n 3 log.txt | tail -n 1 | grep -e "uncommit"
+'
+
+test_expect_success 'Verify log for p3' '
+    stg log p3 > log.txt &&
+    test_line_count = 3 log.txt &&
+    head -n 1 log.txt | tail -n 1 | grep -e "edit" &&
+    head -n 2 log.txt | tail -n 1 | grep -e "goto" &&
+    head -n 3 log.txt | tail -n 1 | grep -e "uncommit"
+'
+
+test_expect_success 'Verify log for p2 and p3' '
+    stg log p2 p3 > log.txt &&
+    test_line_count = 5 log.txt &&
+    head -n 1 log.txt | tail -n 1 | grep -e "edit" &&
+    head -n 2 log.txt | tail -n 1 | grep -e "goto" &&
+    head -n 3 log.txt | tail -n 1 | grep -e "refresh" &&
+    head -n 4 log.txt | tail -n 1 | grep -e "goto" &&
+    head -n 5 log.txt | tail -n 1 | grep -e "uncommit"
+'
+
+test_expect_success 'Log with number' '
+    stg log -n3 p2 p3 > log.txt &&
+    test_line_count = 3 log.txt &&
+    head -n 1 log.txt | tail -n 1 | grep -e "edit" &&
+    head -n 2 log.txt | tail -n 1 | grep -e "goto" &&
+    head -n 3 log.txt | tail -n 1 | grep -e "refresh"
+'
+
+test_expect_success 'Clear the log' '
+    stg log --clear &&
+    test "$(echo $(stg series --noprefix))" = "p0 p1 p2 p3" &&
+    stg log 2>&1 >/dev/null | grep -e "Log is empty"
+'
+
+test_done