File: script

package info (click to toggle)
node-stdlib 0.0.96%2Bds1%2B~cs0.0.429-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 421,476 kB
  • sloc: javascript: 1,562,831; ansic: 109,702; lisp: 49,823; cpp: 27,224; python: 7,871; sh: 6,807; makefile: 6,089; fortran: 3,102; awk: 387
file content (262 lines) | stat: -rwxr-xr-x 5,428 bytes parent folder | download
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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
#!/usr/bin/env bash
#
# @license Apache-2.0
#
# Copyright (c) 2017 The Stdlib Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# Build script to run continuous integration on [Travis CI][1].
#
# [1]: travis-ci.org

# shellcheck disable=SC2181


# VARIABLES #

# Get the name of the build task as the first argument to the build script:
task="$1"

# Define an output file to store log output:
log_file='/var/log/travis-ci.log'

# Define a heartbeat interval to periodically print messages in order to prevent Travis CI from prematurely ending a build due to long running commands:
heartbeat_interval='30s'

# Declare a variable for storing the heartbeat process id:
heartbeat_pid=""


# FUNCTIONS #

# Defines an error handler.
#
# $1 - error status
on_error() {
	echo 'ERROR: An error was encountered during execution.' >&2
	cleanup
	exit "$1"
}

# Runs clean-up tasks.
cleanup() {
	stop_heartbeat
}

# Starts a heartbeat.
#
# $1 - heartbeat interval
start_heartbeat() {
	echo 'Starting heartbeat...' >&2

	# Create a heartbeat and send to background:
	heartbeat "$1" &

	# Capture the heartbeat pid:
	heartbeat_pid=$!
	echo "Heartbeat pid: ${heartbeat_pid}" >&2
}

# Runs an infinite print loop.
#
# $1 - heartbeat interval
heartbeat() {
	while true; do
		echo "$(date) - heartbeat..." >&2;
		sleep "$1";
	done
}

# Stops the heartbeat print loop.
stop_heartbeat() {
	echo 'Stopping heartbeat...' >&2
	kill "${heartbeat_pid}"
}

# Creates an output log file.
#
# $1 - log file path
create_log_file() {
	echo "Creating an output log file: $1." >&2
	sudo touch "$1"
	sudo chown travis "$1"
}

# Prints a success message.
print_success() {
	echo 'Success!' >&2
}

# Runs unit tests.
#
# $1 - log file
run_tests() {
	echo 'Running tests...' >&2
	make test >> "$1" 2>&1
	if [[ "$?" -ne 0 ]]; then
		echo 'Tests failed.' >&2
		return 1
	fi
	echo 'Tests passed.' >&2
	return 0
}

# Runs test coverage.
#
# $1 - log file
run_test_coverage() {
	echo 'Running test coverage...' >&2
	make test-cov >> "$1" 2>&1
	if [[ "$?" -ne 0 ]]; then
		echo 'Tests failed.' >&2
		return 1
	fi
	echo 'Tests passed.' >&2
	return 0
}

# Sends test coverage to coverage service.
#
# $1 - report title
# $2 - log file
send_coverage() {
	echo 'Sending coverage report to coverage service...' >&2
	make COVERAGE_NAME="$1" coverage >> "$2" 2>&1
	if [[ "$?" -ne 0 ]]; then
		echo 'Sending coverage report to coverage service failed.' >&2
		return 1
	fi
	echo 'Coverage report sent to coverage service.' >&2
	return 0
}

# Runs benchmarks.
#
# $1 - log file
run_benchmarks() {
	echo 'Running benchmarks...' >&2
	make benchmark >> "$1" 2>&1
	if [[ "$?" -ne 0 ]]; then
		echo 'Benchmarks failed.' >&2
		return 1
	fi
	echo 'Successfully ran benchmarks.' >&2
	return 0
}

# Runs examples.
#
# $1 - log file
run_examples() {
	echo 'Running examples...' >&2
	make examples >> "$1" 2>&1
	if [[ "$?" -ne 0 ]]; then
		echo 'Examples failed.' >&2
		return 1
	fi
	echo 'Successfully ran examples.' >&2
	return 0
}

# Tests whether the project successfully installs via `npm`.
#
# $1 - log file
test_npm_install() {
	echo 'Testing npm install...' >&2
	make test-npm-install >> "$1" 2>&1
	if [[ "$?" -ne 0 ]]; then
		echo 'Installation failed.' >&2
		return 1
	fi
	echo 'Successfully installed.' >&2

	echo 'Testing npm install (via GitHub)...' >&2
	make test-npm-install-github >> "$1" 2>&1
	if [[ "$?" -ne 0 ]]; then
		echo 'Installation (via GitHub) failed.' >&2
		return 1
	fi
	echo 'Successfully installed (via GitHub).' >&2

	return 0
}

# Checks dependencies.
#
# $1 - log file
check_deps() {
	echo 'Checking dependencies...' >&2
	make check-deps >> "$1" 2>&1
	if [[ "$?" -ne 0 ]]; then
		echo 'Dependencies are out-of-date.' >&2
		return 1
	fi
	echo 'Dependencies are up-to-date.' >&2
	return 0
}

# Main execution sequence.
main() {
	create_log_file "${log_file}"
	start_heartbeat "${heartbeat_interval}"

	echo "Task: ${task}." >&2
	if [[ "${task}" = "test-npm-install" ]]; then
		test_npm_install "${log_file}"
		if [[ "$?" -ne 0 ]]; then
			on_error 1
		fi
	elif [[ "${task}" = "test" ]]; then
		run_tests "${log_file}"
		if [[ "$?" -ne 0 ]]; then
			on_error 1
		fi
	elif [[ "${task}" = "benchmark" ]]; then
		run_benchmarks "${log_file}"
		if [[ "$?" -ne 0 ]]; then
			on_error 1
		fi
	elif [[ "${task}" = "examples" ]]; then
		run_examples "${log_file}"
		if [[ "$?" -ne 0 ]]; then
			on_error 1
		fi
	elif [[ "${task}" = "test-coverage" ]]; then
		run_test_coverage "${log_file}"
		if [[ "$?" -ne 0 ]]; then
			on_error 1
		fi
		send_coverage "unit_test" "${log_file}"
		if [[ "$?" -ne 0 ]]; then
			on_error 1
		fi
	elif [[ "${task}" = "check-deps" ]]; then
		check_deps "${log_file}"
		if [[ "$?" -ne 0 ]]; then
			on_error 1
		fi
	else
		echo "ERROR: unknown task: ${task}." >&2
		on_error 1
	fi
	cleanup
	print_success
	exit 0
}

# Set an error handler to print captured output and perform any clean-up tasks:
trap 'on_error' ERR

# Run main:
main