Skip to content

Commit 0ea4a11

Browse files
lowplylowply
authored
Make ghe_debug handle piped stdin (#592)
Make ghe_debug to accept piped stdin
1 parent e6b9fbe commit 0ea4a11

File tree

8 files changed

+47
-18
lines changed

8 files changed

+47
-18
lines changed

‎share/github-backup-utils/ghe-backup-config

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -336,11 +336,19 @@ ghe_verbose() {
336336
fi
337337
}
338338

339-
# Usage: ghe_debug <message>
339+
# Usage: ghe_debug <message> OR echo <message> | ghe_debug
340340
# Log if debug mode is enabled (GHE_DEBUG).
341341
ghe_debug() {
342-
if [ -n "$GHE_DEBUG" ]; then
342+
[ -z "$GHE_DEBUG" ] && return
343+
344+
if [ $# -ne 0 ]; then
343345
echo -e "Debug: $*" 1>&3
346+
elif [ -p /dev/stdin ]; then
347+
echo "\n" 1>&3
348+
while read line
349+
do
350+
echo -e "Debug: $line" 1>&3
351+
done < /dev/stdin
344352
fi
345353
}
346354

‎share/github-backup-utils/ghe-backup-repositories

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,12 +124,12 @@ fi
124124
#
125125
bm_start "$(basename $0) - Generating routes"
126126
echo "github-env ./bin/dgit-cluster-backup-routes > $remote_routes_list" | ghe-ssh "$GHE_HOSTNAME" -- /bin/bash
127-
ghe_debug "\n$(ghe-ssh "$GHE_HOSTNAME" -- cat $remote_routes_list)"
127+
ghe-ssh "$GHE_HOSTNAME" -- cat $remote_routes_list | ghe_debug
128128
bm_end "$(basename $0) - Generating routes"
129129

130130
bm_start "$(basename $0) - Fetching routes"
131131
ghe-ssh "$GHE_HOSTNAME" -- cat $remote_routes_list > $routes_list
132-
ghe_debug "\n$(cat $routes_list)"
132+
cat $routes_list | ghe_debug
133133
bm_end "$(basename $0) - Fetching routes"
134134

135135
bm_start "$(basename $0) - Processing routes"

‎share/github-backup-utils/ghe-backup-storage

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,12 +92,12 @@ fi
9292
#
9393
bm_start "$(basename $0) - Generating routes"
9494
echo "github-env ./bin/storage-cluster-backup-routes > $remote_routes_list" | ghe-ssh "$GHE_HOSTNAME" -- /bin/bash
95-
ghe_debug "\n$(ghe-ssh "$GHE_HOSTNAME" -- cat $remote_routes_list)"
95+
ghe-ssh "$GHE_HOSTNAME" -- cat $remote_routes_list | ghe_debug
9696
bm_end "$(basename $0) - Generating routes"
9797

9898
bm_start "$(basename $0) - Fetching routes"
9999
ghe-ssh "$GHE_HOSTNAME" -- cat $remote_routes_list > $routes_list
100-
ghe_debug "\n$(cat $routes_list)"
100+
cat $routes_list | ghe_debug
101101
bm_end "$(basename $0) - Fetching routes"
102102

103103
bm_start "$(basename $0) - Processing routes"

‎share/github-backup-utils/ghe-restore-pages

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -104,17 +104,17 @@ bm_end "$(basename $0) - Building pages list"
104104
#
105105
bm_start "$(basename $0) - Transferring pages list"
106106
cat $tmp_list | ghe-ssh "$GHE_HOSTNAME" -- sponge $remote_tmp_list
107-
ghe_debug "\n$(cat $tmp_list)"
107+
cat $tmp_list | ghe_debug
108108
bm_end "$(basename $0) - Transferring pages list"
109109

110110
bm_start "$(basename $0) - Generating routes"
111111
echo "cat $remote_tmp_list | github-env ./bin/dpages-cluster-restore-routes > $remote_routes_list" | ghe-ssh "$GHE_HOSTNAME" /bin/bash
112-
ghe_debug "\n$(ghe-ssh "$GHE_HOSTNAME" -- cat $remote_routes_list)"
112+
ghe-ssh "$GHE_HOSTNAME" -- cat $remote_routes_list | ghe_debug
113113
bm_end "$(basename $0) - Generating routes"
114114

115115
bm_start "$(basename $0) - Fetching routes"
116116
ghe-ssh "$GHE_HOSTNAME" -- cat $remote_routes_list > $routes_list
117-
ghe_debug "\n$(cat $routes_list)"
117+
cat $routes_list | ghe_debug
118118
bm_end "$(basename $0) - Fetching routes"
119119

120120
bm_start "$(basename $0) - Processing routes"

‎share/github-backup-utils/ghe-restore-repositories

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,17 +116,17 @@ bm_end "$(basename $0) - Building network list"
116116
#
117117
bm_start "$(basename $0) - Transferring network list"
118118
cat $tmp_list | ghe-ssh "$GHE_HOSTNAME" -- sponge $remote_tmp_list
119-
ghe_debug "\n$(cat $tmp_list)"
119+
cat $tmp_list | ghe_debug
120120
bm_end "$(basename $0) - Transferring network list"
121121

122122
bm_start "$(basename $0) - Generating routes"
123123
echo "cat $remote_tmp_list | github-env ./bin/dgit-cluster-restore-routes > $remote_routes_list" | ghe-ssh "$GHE_HOSTNAME" -- /bin/bash
124-
ghe_debug "\n$(ghe-ssh "$GHE_HOSTNAME" -- cat $remote_routes_list)"
124+
ghe-ssh "$GHE_HOSTNAME" -- cat $remote_routes_list | ghe_debug
125125
bm_end "$(basename $0) - Generating routes"
126126

127127
bm_start "$(basename $0) - Fetching routes"
128128
ghe-ssh "$GHE_HOSTNAME" -- cat $remote_routes_list > $routes_list
129-
ghe_debug "\n$(cat $routes_list)"
129+
cat $routes_list | ghe_debug
130130
bm_end "$(basename $0) - Fetching routes"
131131

132132
bm_start "$(basename $0) - Processing routes"

‎share/github-backup-utils/ghe-restore-repositories-gist

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -106,17 +106,17 @@ bm_end "$(basename $0) - Building gist list"
106106
#
107107
bm_start "$(basename $0) - Transferring gist list"
108108
cat $tmp_list | ghe-ssh "$GHE_HOSTNAME" -- sponge $remote_tmp_list
109-
ghe_debug "\n$(cat $tmp_list)"
109+
cat $tmp_list | ghe_debug
110110
bm_end "$(basename $0) - Transferring gist list"
111111

112112
bm_start "$(basename $0) - Generating routes"
113113
echo "cat $remote_tmp_list | github-env ./bin/gist-cluster-restore-routes > $remote_routes_list" | ghe-ssh "$GHE_HOSTNAME" -- /bin/bash
114-
ghe_debug "\n$(ghe-ssh "$GHE_HOSTNAME" -- cat $remote_routes_list)"
114+
ghe-ssh "$GHE_HOSTNAME" -- cat $remote_routes_list | ghe_debug
115115
bm_end "$(basename $0) - Generating routes"
116116

117117
bm_start "$(basename $0) - Transferring routes"
118118
ghe-ssh "$GHE_HOSTNAME" -- cat $remote_routes_list > $routes_list
119-
ghe_debug "\n$(cat $routes_list)"
119+
cat $routes_list | ghe_debug
120120
bm_end "$(basename $0) - Transferring routes"
121121

122122
bm_start "$(basename $0) - Processing routes"

‎share/github-backup-utils/ghe-restore-storage

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,17 +96,17 @@ bm_end "$(basename $0) - Building object list"
9696
#
9797
bm_start "$(basename $0) - Transferring object list"
9898
cat $tmp_list | ghe-ssh "$GHE_HOSTNAME" -- sponge $remote_tmp_list
99-
ghe_debug "\n$(cat $tmp_list)"
99+
cat $tmp_list | ghe_debug
100100
bm_end "$(basename $0) - Transferring object list"
101101

102102
bm_start "$(basename $0) - Generating routes"
103103
echo "cat $remote_tmp_list | github-env ./bin/storage-cluster-restore-routes > $remote_routes_list" | ghe-ssh "$GHE_HOSTNAME" /bin/bash
104-
ghe_debug "\n$(ghe-ssh "$GHE_HOSTNAME" -- cat $remote_routes_list)"
104+
ghe-ssh "$GHE_HOSTNAME" -- cat $remote_routes_list | ghe_debug
105105
bm_end "$(basename $0) - Generating routes"
106106

107107
bm_start "$(basename $0) - Fetching routes"
108108
ghe-ssh "$GHE_HOSTNAME" -- cat $remote_routes_list > $routes_list
109-
ghe_debug "\n$(cat $routes_list)"
109+
cat $routes_list | ghe_debug
110110
bm_end "$(basename $0) - Fetching routes"
111111

112112
bm_start "$(basename $0) - Processing routes"

‎test/test-ghe-backup-config.sh

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,3 +163,24 @@ begin_test "ghe-backup-config verbose log redirects to file under parallel"
163163
exit 1
164164
)
165165
end_test
166+
167+
begin_test "ghe-backup-config ghe_debug accepts stdin as well as argument"
168+
(
169+
set -e
170+
171+
export GHE_DEBUG=1
172+
export GHE_VERBOSE=1
173+
export GHE_VERBOSE_LOG="$TRASHDIR/verbose.log"
174+
. "share/github-backup-utils/ghe-backup-config"
175+
176+
ghe_debug "debug arg"
177+
grep -q "debug arg" ${GHE_VERBOSE_LOG}
178+
179+
echo "debug stdin" | ghe_debug
180+
grep -q "debug stdin" ${GHE_VERBOSE_LOG}
181+
182+
unset GHE_DEBUG
183+
unset GHE_VERBOSE
184+
unset GHE_VERBOSE_LOG
185+
)
186+
end_test

0 commit comments

Comments
 (0)