summaryrefslogtreecommitdiffstats
path: root/diagnostics/info.sh
blob: f95a4b42f5bfd1f2ebfbec2eaf91eb89f9862d79 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
#!/usr/bin/env bash
_modules=('system' 'bat' 'bat_config' 'bat_wrapper' 'bat_wrapper_function' 'tool')
_modules_consented=()


# -----------------------------------------------------------------------------
# Modules:
# -----------------------------------------------------------------------------

_bat_:description() {
	_collects "Version information for 'bat'."
}

_bat_config_:description() {
	_collects "The environment variables used by 'bat'."
	_collects "The 'bat' configuration file."
}

_bat_wrapper_:description() {
	_collects "Any wrapper script used by 'bat'."
}

_bat_wrapper_function_description() {
	_collects "The wrapper function surrounding 'bat' (if applicable)."
}

_system_:description() {
	_collects "Operating system name."
	_collects "Operating system version."
}

_tool_:description() {
	_collects "Version information for 'less'."
}


# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

_bat_:run() {
	_out bat --version
	_out env | grep '^BAT_\|^PAGER='
}

_bat_config_:run() {
	if [[ -f "$(bat --config-file)" ]]; then 
		_out cat "$(bat --config-file)"; 
	fi
}

_bat_wrapper_:run() {
	if file "$(which bat)" | grep "text executable" &>/dev/null; then
		_out cat "$(which bat)"
		return
	fi
	printf "\nNo wrapper script.\n"
}

_bat_wrapper_function_:run() {
	case "$("$SHELL" --version | head -n 1)" in
		*fish*) 
			if "$SHELL" --login -c 'type bat' 2>&1 | grep 'function' &>/dev/null; then
				_out "$SHELL" --login -c 'functions bat'
			fi ;;

		*bash*)
			if "$SHELL" --login -c 'type bat' 2>&1 | grep 'function' &>/dev/null; then
				_out "$SHELL" --login -c 'declare -f bat'
			fi ;;

		*) 
			echo "Unable to determine if a wrapper function is set."
			return ;;
	esac
	printf "\nNo wrapper function.\n"
}

_system_:run() {
	_out uname -srm

	if command -v "sw_vers" &>/dev/null; then _out sw_vers; fi
	if command -v "lsb_release" &>/dev/null; then _out lsb_release -a; fi
}

_tool_:run() {
	_out less --version | head -n1
}


# -----------------------------------------------------------------------------
# Functions:
# -----------------------------------------------------------------------------

_print_command() {
	printf "\n+" 1>&2
	printf " %s" "$@" 1>&2
	printf "\n" 1>&2
}

_out() {
	_print_command "$@"
	"$@" 2>&1
}

_tput() {
	tput "$@" 1>&2 2>/dev/null
}

_collects() {
	printf " - %s\n" "$1" 1>&2
}

_ask_module() {
	_tput clear
	_tput cup 0 0

cat 1>&2 <<EOF
--------------------------------------------------------------------------------
This script runs some harmless commands to collect information about your
system and bat configuration. It will give you a small preview of the commands
that will be run, and ask consent before running them. Once completed, it will
output a small report that you can review and copy into the issue description.
--------------------------------------------------------------------------------
EOF

	# Print description.
	_tput setaf 3
	printf "The following data will be collected:\n" 1>&2
	_tput sgr0
	"_$1_:description"
	_tput sgr0
	
	# Print preview.
	_tput setaf 3
	printf "\nThe following commands will be run:\n" 1>&2
	_tput sgr0
	declare -f "_$1_:run" \
		| sed 's/^ *//; s/;$//' \
		| grep '^_out\([21]*\) ' \
		| sed 's/^_out\([21]*\) //' 1>&2

	# Prompt
	printf "\n" 1>&2
	local response
	while true; do
		_tput cup "$(( $(tput lines || echo 22) - 2 ))"
		_tput el
		read -er -p "Collect $(sed 's/_/ /' <<< "$1") data? [Y/n] " response
		case "$response" in
			Y|y|yes|'') return 0 ;;
			N|n|no)     return 1 ;;
			*) continue
		esac
	done
}

_run_module() {
	printf "========== %s ==========\n" "$1"
	"_$1_:run"
}


# -----------------------------------------------------------------------------
# Functions:
# -----------------------------------------------------------------------------

# Ask for consent.
if [[ "$1" = '-y' ]]; then
	_modules_consented=("${_modules[@]}")
else
	trap '_tput rmcup; exit 1' INT
	_tput smcup
	for _module in "${_modules[@]}"; do
		if _ask_module "$_module"; then
			_modules_consented+=("$_module")
		fi
	done
	_tput rmcup
fi

# Collect information.
for _module in "${_modules_consented[@]}"; do
	_run_module "$_module"
	printf "\n"
done