summaryrefslogtreecommitdiff
path: root/check
blob: 8dd8cd6fa9c31cbd09022c5fe2badcaedd256528 (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
#!/bin/bash

set -euo pipefail

echo Running unit tests ============================================
python3 -m CoverageTestRunner --ignore-missing-from=without-tests yarns vmdb
echo

echo Checking every plugin looks OK ============================================
for file in vmdb/plugins/*.py; do
	case "$file" in
	*_plugin.py) ;;
	*)
		echo "File $file should end in _plugin.py" 1>&2
		exit 1
		;;
	esac
	if ! grep -q 'class .*Plugin' "$file"; then
		echo "File $file does not seem to have a Plugin class" 1>&2
		exit 1
	fi
done
echo

if false && command -v subplot >/dev/null; then
	echo Running Subplot ============================================
	subplot vmdb2.md -o test.py --run
	echo
fi

echo Formatting docs ========================================
./format.sh

plugindocs() {
	ls -1 vmdb/plugins/*.mdwn
}

steps() {
	sed -n '/<h2 id="step-.*> Step: /s///p' vmdb2.html
}

code() {
	steps | grep '<code>' || true
}

panic() {
	echo "ERROR: $*" 1>&2
	exit 1
}

for doc in $(plugindocs); do
	n="$(grep -c '^Step:' "$doc")"
	if [ "$n" != 1 ]; then
		panic "Plugin doc $doc must have exactly 1 step title"
	fi
done

n="$(code | wc -l)"
if [ "$n" != 0 ]; then
	code
	panic "Documentation has steps that use code in title"
fi

if ! diff -u <(steps) <(steps | sort); then
	panic "Steps are not in sorted order"
fi