improve verbosity

only output debug information if there is a failure

.forgejo/workflows/integration.yml

@@ -26,7 +26,7 @@ jobs:
           runner_config=/tmp/runner-config.yaml
           sed -e 's|file: .runner|file: ${{ steps.forgejo.outputs.runner-file }}|' < tests/runner-config.yaml > $runner_config
           FORGEJO_RUNNER_CONFIG=$runner_config forgejo-runner.sh reload
-          if ! tests/run.sh --debug --host_port ${{ steps.forgejo.outputs.host-port }} --url ${{ steps.forgejo.outputs.url }} --token ${{ steps.forgejo.outputs.token }} ; then
+          if ! tests/run.sh --verbose --host_port ${{ steps.forgejo.outputs.host-port }} --url ${{ steps.forgejo.outputs.url }} --token ${{ steps.forgejo.outputs.token }} ; then
              sed -e 's/^/[RUNNER LOGS] /' ${{ steps.forgejo.outputs.runner-logs }}
              docker logs forgejo | sed -e 's/^/[FORGEJO LOGS]/'
              exit 1

cascading-pr-lib.sh

@@ -29,14 +29,14 @@ function dependencies() {
 
 function retry() {
     rm -f $TMPDIR/retry.out
-    success=false
+    local success=false
     for delay in $RETRY_DELAYS ; do
-        if "$@" | tee -a $TMPDIR/retry.out > $TMPDIR/retry-attempt.out 2>&1 ; then
+        if "$@" |& tee -a $TMPDIR/retry.out > $TMPDIR/retry-attempt.out ; then
             success=true
             break
         fi
         cat $TMPDIR/retry-attempt.out >&2
-        log_verbose waiting $delay "$@"
+        log waiting $delay "$@"
         sleep $delay
     done
     if $success ; then
@@ -51,6 +51,7 @@ function retry() {
 
 function debug() {
     DEBUG=true
+    VERBOSE=true
     set -x
     PS4='${BASH_SOURCE[0]}:$LINENO: ${FUNCNAME[0]}:  '
 }
@@ -69,7 +70,7 @@ function log_error() {
 
 function log_verbose() {
     if $VERBOSE ; then
-	log "$@"
+	log_info "$@"
     fi
 }
 

tests/run.sh

@@ -11,6 +11,7 @@ mkdir -p $TMPDIR
 source $SELF_DIR/../cascading-pr-lib.sh
 
 function push_self() {
+    log_verbose "push cascading-pr action to user1/cascading-pr"
     forgejo-test-helper.sh push_self_action http://user1:admin1234@${options[host_port]} user1 cascading-pr vTest
 }
 
@@ -38,6 +39,7 @@ function user_token() {
 function user_secret() {
     local username=$1 name=$2 token=$3
 
+    log_verbose "(re)set ${username} secret ${name}"
     user_curl $username api_json -X PUT --data '{"data":"'$token'"}' ${options[url]}/api/v1/user/actions/secrets/$name
 }
 
@@ -52,6 +54,7 @@ function orgs_delete() {
 
 function user_create() {
     local username="$1" email="$2"
+    log_verbose "(re)create user $username"
     forgejo-curl.sh api_json -X DELETE ${options[url]}/api/v1/admin/users/$username?purge=true >& /dev/null || true
     forgejo-curl.sh api_json --data '{"username":"'$username'","email":"'$email'","password":"'${options[password]}'","must_change_password":false}' ${options[url]}/api/v1/admin/users
     user_login $username
@@ -60,6 +63,7 @@ function user_create() {
 function close_pull_request() {
     local repo=$1
 
+    log_verbose "close all pull requests in user1/$repo"
     forgejo-curl.sh api_json ${options[url]}/api/v1/repos/user1/${repo}/pulls | jq --raw-output '.[] | .number' | while read pr ; do
 	forgejo-curl.sh api_json -X PATCH --data '{"state":"closed"}' ${options[url]}/api/v1/repos/user1/${repo}/issues/$pr
     done
@@ -68,19 +72,30 @@ function close_pull_request() {
 function merge_pull_request() {
     local repo=$1
 
+    log_verbose "merge all pull requests in user1/$repo"
     forgejo-curl.sh api_json ${options[url]}/api/v1/repos/user1/${repo}/pulls | jq --raw-output '.[] | .number' | while read pr ; do
 	forgejo-curl.sh api_json --data '{"Do":"merge"}' ${options[url]}/api/v1/repos/user1/${repo}/pulls/$pr/merge
     done
 }
 
 function has_cascade_pull_request() {
-    pr_count=$(forgejo-curl.sh api_json ${options[url]}/api/v1/repos/user2/destinationrepo/pulls | jq '[ .[] | select(.state == "open") ] | length')
+    log_verbose "verify a cascade pull request exists"
-    test $pr_count -gt 0
+    test "$(cascade_pull_request_count)" -gt 0
+}
+
+function has_no_cascade_pull_request() {
+    log_verbose "verify there is no cascade pull request"
+    test "$(cascade_pull_request_count)" = 0
+}
+
+function cascade_pull_request_count() {
+    forgejo-curl.sh api_json ${options[url]}/api/v1/repos/user2/destinationrepo/pulls | jq '[ .[] | select(.state == "open") ] | length'
 }
 
 function create_branch1() {
     local owner=$1 repo=$2 modify=$3
 
+    log_verbose "(re)create branch1 in $owner/$repo"
     forgejo-curl.sh api_json -X DELETE ${options[url]}/api/v1/repos/$owner/${repo}/branches/branch1 >& /dev/null || true
     forgejo-curl.sh api_json --data '{"new_branch_name":"branch1"}' ${options[url]}/api/v1/repos/$owner/${repo}/branches
     (
@@ -89,7 +104,10 @@ function create_branch1() {
 	git clone -b branch1 http://user1:admin1234@${options[host_port]}/$owner/${repo}
 	cd ${repo}
 	echo CONTENT > README
-	$modify
+	if test "$modify" ; then
+	    log_verbose "modify branch1 in $owner/$repo with $modify"
+	    $modify
+	fi
 	git config user.email root@example.com
 	git config user.name username
 	git add .
@@ -120,6 +138,7 @@ function create_pull_request() {
     cat > $TMPDIR/data <<EOF
 {"title":"PR","base":"main","head":"$head"}
 EOF
+    log_verbose "create pull request in $baseowner/$repo from $head"
     forgejo-curl.sh api_json --data @$TMPDIR/data ${options[url]}/api/v1/repos/$baseowner/${repo}/pulls
 }
 
@@ -131,17 +150,6 @@ function create_pull_request_case1() {
     create_pull_request $baseowner $headowner $repo
 }
 
-function finalize_options() {
-    if test -f forgejo-ip; then
-	: ${options[host_port]:=$(cat forgejo-ip):3000}
-    fi
-    options[url]=http://${options[host_port]}
-    if test -f forgejo-token; then
-	: ${options[token]:=$(cat forgejo-token)}
-    fi
-    options[password]=admin1234
-}
-
 function unit_retry_fail() {
     local file=$1
     local value=$(cat $file)
@@ -163,16 +171,17 @@ function unit_retry() {
     # Succeeds after two tries
     #
     echo 2 > $TMPDIR/unit_retry_two
-    RETRY_DELAYS='1 1 1 1' retry unit_retry_fail $two > $TMPDIR/retry.result 2> $TMPDIR/retry.log
+    RETRY_DELAYS='1 1 1 1' retry unit_retry_fail $two > $TMPDIR/retry.test-result 2> $TMPDIR/retry.test-log
-    test "$(cat $TMPDIR/retry.result)" = "RESULT"
+    test "$(cat $TMPDIR/retry.test-result)" = "RESULT"
-    test "$(grep -c 'waiting 1 unit_retry_fail' $TMPDIR/retry.log)" = 2
+    cat $TMPDIR/retry.test-log
+    test "$(grep -c 'waiting 1 unit_retry_fail' $TMPDIR/retry.test-log)" = 2
 
     #
     # Succeeds immediately
     #
-    RETRY_DELAYS='1' retry unit_retry_fail $two > $TMPDIR/retry.result 2> $TMPDIR/retry.log
+    RETRY_DELAYS='1' retry unit_retry_fail $two > $TMPDIR/retry.test-result 2> $TMPDIR/retry.test-log
-    test "$(cat $TMPDIR/retry.result)" = "RESULT"
+    test "$(cat $TMPDIR/retry.test-result)" = "RESULT"
-    test "$(grep -c 'waiting 1 unit_retry_fail' $TMPDIR/retry.log)" = 0
+    test "$(grep -c 'waiting 1 unit_retry_fail' $TMPDIR/retry.test-log)" = 0
 
     #
     # Verify the output is only the output of the last run and is not polluted by
@@ -185,10 +194,10 @@ function unit_retry() {
     # Fails after one try
     #
     echo 2 > $TMPDIR/unit_retry_two
-    if RETRY_DELAYS='1' retry unit_retry_fail $two |& tee $TMPDIR/retry.log ; then
+    if RETRY_DELAYS='1' retry unit_retry_fail $two |& tee $TMPDIR/retry.test-log ; then
 	return 1
     fi
-    grep --quiet 'retry failed' $TMPDIR/retry.log
+    grep --quiet 'retry failed' $TMPDIR/retry.test-log
 }
 
 function fixture() {
@@ -198,14 +207,19 @@ function fixture() {
     orgs_delete
 
     user_create user3 user3@example.com
+    log_verbose create organization destination-fork
     user_curl user3 api_json --data '{"username":"destination-fork"}' ${options[url]}/api/v1/orgs
 
     user_create user2 user2@example.com
+    log_verbose push tests/${destination} repository to user2/${destination}
     forgejo-test-helper.sh push tests/${destination} http://user2:admin1234@${options[host_port]} user2 ${destination}
 
     user_create user1 user1@example.com
+    log_verbose push tests/${origin} repository to user1/${origin}
     forgejo-test-helper.sh push tests/${origin} http://user1:admin1234@${options[host_port]} user1 ${origin} cascading-pr
+    log_verbose create organization origin-fork
     user_curl user1 api_json --data '{"username":"origin-fork"}' ${options[url]}/api/v1/orgs
+    log_verbose fork user1/${origin} to origin-fork/${origin}
     user_curl user1 api_json --data '{"organization":"origin-fork"}' ${options[url]}/api/v1/repos/user1/${origin}/forks
     user_secret user1 ORIGIN_TOKEN $(user_token user1 ORIGIN_TOKEN)
 
@@ -218,7 +232,7 @@ function no_change_no_cascade_pr() {
 
     create_pull_request_case1 user1 user1 originrepo-do-nothing
     wait_success ${options[url]}/api/v1/repos/user1/originrepo-do-nothing $(cat $TMPDIR/user1-originrepo-do-nothing.sha)
-    ! has_cascade_pull_request
+    has_no_cascade_pull_request
 }
 
 function create_and_close() {
@@ -289,25 +303,61 @@ function create_and_merge_close() {
     has_cascade_pull_request
     merge_pull_request originrepo-close-merge
     wait_success ${options[url]}/api/v1/repos/user1/originrepo-close-merge $(cat $TMPDIR/user1-originrepo-close-merge.sha)
-    ! has_cascade_pull_request
+    has_no_cascade_pull_request
-}
-
-function integration() {
-    for t in create_in_destination_fork_and_close no_change_no_cascade_pr create_from_origin_fork_and_close create_and_close create_and_merge create_and_merge_close; do
-	log_info "running $t"
-	$t
-    done
-}
-
-function unit() {
-    unit_retry
 }
 
 function run() {
+    local fun=$1
+    shift
+
+    echo "Start running $fun ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
+    if $DEBUG ; then
+	$fun "$@"
+    else
+	mkdir -p $TMPDIR
+	> $TMPDIR/$fun.out
+	tail --follow $TMPDIR/$fun.out | sed --unbuffered -n -e "/^$PREFIX/s/^$PREFIX //p" &
+	pid=$!
+	if ! ${BASH_SOURCE[0]} --debug ${options[args]} $fun "$@" >& $TMPDIR/$fun.out ; then
+	    kill $pid
+	    cat $TMPDIR/$fun.out
+	    echo Failure running $fun
+	    return 1
+	fi
+	kill $pid
+    fi
+    echo "Success running $fun ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
+}
+
+function integration() {
+    run create_in_destination_fork_and_close
+    run no_change_no_cascade_pr
+    run create_from_origin_fork_and_close
+    run create_and_close create_and_merge
+    run create_and_merge_close
+}
+
+function unit() {
+    # do not run in debug mode, it will polute the output and fail
+    ${BASH_SOURCE[0]} --verbose unit_retry
+}
+
+function run_tests() {
     unit
     integration
 }
 
+function finalize_options() {
+    if test -f forgejo-ip; then
+	: ${options[host_port]:=$(cat forgejo-ip):3000}
+    fi
+    options[url]=http://${options[host_port]}
+    if test -f forgejo-token; then
+	: ${options[token]:=$(cat forgejo-token)}
+    fi
+    options[password]=admin1234
+}
+
 function main() {
     local command=run
 
@@ -323,22 +373,25 @@ function main() {
 		;;
 	    --host_port)
 		shift
+		options[args]="${options[args]} --host_port $1"
 		options[host_port]=$1
 		shift
 		;;
 	    --url)
 		shift
+		options[args]="${options[args]} --url $1"
 		options[url]=$1
 		shift
 		;;
 	    --token)
 		shift
+		options[args]="${options[args]} --token $1"
 		options[token]=$1
 		shift
 		;;
 	    *)
 		finalize_options
-		"${1:-run}"
+		"${1:-run_tests}" "${@:2}"
 		return 0
 		;;
 	esac