safe-migrate 0.8.0

Check PostgreSQL migrations against a synchronized database baseline
Documentation 
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

#!/bin/sh
# shellcheck disable=SC2016
set -eu

repo_root=$(CDPATH='' cd -- "$(dirname -- "$0")/.." && pwd)
resolver="$repo_root/scripts/action-resolve-version"
gate="$repo_root/scripts/action-final-gate"
baseline="$repo_root/scripts/action-baseline"
manifest="$repo_root/action.yml"
workflow="$repo_root/.github/workflows/ci.yml"

test "$(/bin/sh "$resolver" v0.8.0 "$repo_root/Cargo.toml")" = v0.8.0
test "$(/bin/sh "$resolver" 0123456789abcdef0123456789abcdef01234567 "$repo_root/Cargo.toml")" = source

if /bin/sh "$resolver" main "$repo_root/Cargo.toml" >/dev/null 2>&1; then
  printf '%s\n' 'mutable Action branch reference was accepted' >&2
  exit 1
fi
if /bin/sh "$resolver" v0.5.0 "$repo_root/Cargo.toml" >/dev/null 2>&1; then
  printf '%s\n' 'mismatched Action tag was accepted' >&2
  exit 1
fi

/bin/sh "$gate" 0 false
/bin/sh "$gate" 2 true
set +e
/bin/sh "$gate" 2 false >/dev/null 2>&1
blocking_status=$?
/bin/sh "$gate" 1 true >/dev/null 2>&1
operational_status=$?
set -e
test "$blocking_status" -eq 2
test "$operational_status" -eq 1

tmp_dir=$(mktemp -d)
trap 'rm -rf "$tmp_dir"' EXIT HUP INT TERM
migration_file="$tmp_dir/migration.sql"
migration_dir="$tmp_dir/migrations"
output_dir=artifacts
printf '%s\n' 'SELECT 1;' > "$migration_file"
mkdir -p "$migration_dir"
cd "$tmp_dir"

test "$(/bin/sh "$baseline" validate false false false false '' '' default \
  auto false "$migration_file" '' "$output_dir")" = lint
test "$(/bin/sh "$baseline" validate true false true true '' public production \
  auto true "$migration_dir" '' "$output_dir")" = lint-chain
test "$(/bin/sh "$baseline" validate true false true true '' '' production \
  auto false '' '' "$output_dir")" = sync-only
test "$(/bin/sh "$baseline" validate false false false false reviewed.cache '' default \
  lint false "$migration_file" '' '-artifacts')" = lint
test "$(/bin/sh "$baseline" validate false true true false '' '' default \
  lint false "$migration_file" '' "$output_dir")" = lint

assert_baseline_rejected() {
  if /bin/sh "$baseline" validate "$@" >/dev/null 2>&1; then
    printf '%s\n' "invalid Action baseline inputs were accepted: $*" >&2
    exit 1
  fi
}

assert_baseline_rejected maybe false false false '' '' default \
  lint false "$migration_file" '' "$output_dir"
assert_baseline_rejected true true false false '' '' default \
  lint false "$migration_file" '' "$output_dir"
assert_baseline_rejected false false false false '' public default \
  lint false "$migration_file" '' "$output_dir"
assert_baseline_rejected true false true false '' '' default \
  lint false "$migration_file" '' "$output_dir"
assert_baseline_rejected false false true false '' '' default \
  lint false "$migration_file" '' "$output_dir"
assert_baseline_rejected false true false false reviewed.cache '' default \
  lint false "$migration_file" '' "$output_dir"
assert_baseline_rejected false false false false '' '' '' \
  lint false "$migration_file" '' "$output_dir"
assert_baseline_rejected false false false false '' '' . \
  lint false "$migration_file" '' "$output_dir"
assert_baseline_rejected false false false false '' '' .. \
  lint false "$migration_file" '' "$output_dir"
assert_baseline_rejected false false false false '' '' 'invalid key' \
  lint false "$migration_file" '' "$output_dir"
assert_baseline_rejected false false false false '' '' default \
  invalid false "$migration_file" '' "$output_dir"
assert_baseline_rejected false false false false '' '' default \
  lint maybe "$migration_file" '' "$output_dir"
assert_baseline_rejected false false false false '' '' default \
  lint false "$tmp_dir/missing.sql" '' "$output_dir"
assert_baseline_rejected false false false false '' '' default \
  lint false "$migration_dir" '' "$output_dir"
assert_baseline_rejected false false false false '' '' default \
  lint-chain false "$migration_file" '' "$output_dir"
assert_baseline_rejected false false false false '' '' default \
  lint false "$migration_file" '' ''
assert_baseline_rejected false false false false '' '' default \
  lint false "$migration_file" '' "$tmp_dir/absolute-artifacts"
assert_baseline_rejected false false false false '' '' default \
  lint false "$migration_file" '' '../artifacts'
assert_baseline_rejected false false false false '' '' default \
  lint false "$migration_file" '' 'nested/./artifacts'
mkdir -p output-target
ln -s output-target output-link
assert_baseline_rejected false false false false '' '' default \
  lint false "$migration_file" '' 'output-link/artifacts'
line_feed_value=$(printf 'first\nsecond')
carriage_return_value=$(printf 'first\rsecond')
assert_baseline_rejected false false false false "$line_feed_value" '' default \
  lint false "$migration_file" '' "$output_dir"
assert_baseline_rejected false false false false '' '' default \
  lint false "$migration_file" "$carriage_return_value" "$output_dir"

plain_config="$tmp_dir/plain.toml"
encrypted_config="$tmp_dir/encrypted.toml"
quoted_encrypted_config="$tmp_dir/quoted-encrypted.toml"
printf '%s\n' 'cache_encryption = false' > "$plain_config"
printf '%s\n' 'cache_encryption = true # reviewed' > "$encrypted_config"
printf '%s\n' '"cache_encryption" = true' > "$quoted_encrypted_config"
/bin/sh "$baseline" validate-config "$plain_config" false false
/bin/sh "$baseline" validate-config "$encrypted_config" true false
/bin/sh "$baseline" validate-config "$quoted_encrypted_config" true false
/bin/sh "$baseline" validate-config "$plain_config" true true
if /bin/sh "$baseline" validate-config "$plain_config" true false >/dev/null 2>&1; then
  printf '%s\n' 'plaintext config was accepted for encrypted Action mode' >&2
  exit 1
fi
if /bin/sh "$baseline" validate-config "$encrypted_config" false false >/dev/null 2>&1; then
  printf '%s\n' 'encrypted config was accepted for plaintext Action mode' >&2
  exit 1
fi
if /bin/sh "$baseline" validate-config "$tmp_dir/missing.toml" false false >/dev/null 2>&1; then
  printf '%s\n' 'missing explicit Action config was accepted' >&2
  exit 1
fi

fake_binary="$tmp_dir/safe-migrate"
argument_log="$tmp_dir/arguments"
printf '%s\n' \
  '#!/bin/sh' \
  'printf "%s\n" "$@" > "$ARGUMENT_LOG"' \
  > "$fake_binary"
chmod +x "$fake_binary"
ARGUMENT_LOG="$argument_log" /bin/sh "$baseline" sync \
  "$fake_binary" "$tmp_dir/cache" "$tmp_dir/config" 'public,auth'
printf '%s\n' \
  sync --out "$tmp_dir/cache" --config "$tmp_dir/config" \
  --schemas 'public,auth' > "$tmp_dir/expected-arguments"
cmp "$tmp_dir/expected-arguments" "$argument_log"

grep -A4 '^  sync:$' "$manifest" | grep -F 'default: "false"' >/dev/null
grep -A4 '^  baseline:$' "$manifest" | grep -F 'default: default' >/dev/null
grep -A4 '^  mode:$' "$manifest" | grep -F 'default: auto' >/dev/null
grep -A5 '^  path:$' "$manifest" | grep -F 'required: false' >/dev/null
grep -A4 '^  encrypted-cache:$' "$manifest" | grep -F 'default: "true"' >/dev/null
grep -A4 '^  no-cache:$' "$manifest" | grep -F 'default: "false"' >/dev/null
grep -F 'cache_dir="$(mktemp -d "${cache_root}/invocation.XXXXXX")"' "$manifest" >/dev/null
grep -F 'managed_root="${HOME}/.cache/safe-migrate-action"' "$manifest" >/dev/null
grep -F 'baseline_root="${managed_root}/baselines"' "$manifest" >/dev/null
grep -F 'cache_dir="${baseline_root}/${INPUT_BASELINE}"' "$manifest" >/dev/null
grep -F 'cache_transport_path="~/.cache/safe-migrate-action/baselines/${INPUT_BASELINE}/baseline-v7.cache"' "$manifest" >/dev/null
test "$(grep -Fc 'path: ${{ steps.baseline.outputs.cache-transport-path }}' "$manifest")" -eq 2
if grep -F '../.safe-migrate-action-cache' "$manifest" >/dev/null; then
  printf '%s\n' "Action cache paths cannot contain '..'" >&2
  exit 1
fi
grep -F 'Managed cache root must be a directory, not a symlink' "$manifest" >/dev/null
grep -F 'Managed baseline root must be a directory, not a symlink' "$manifest" >/dev/null
grep -F 'rm -rf -- "$cache_dir"' "$manifest" >/dev/null
if grep -F 'rm -rf -- "$managed_root"' "$manifest" >/dev/null; then
  printf '%s\n' 'Action still removes every managed baseline' >&2
  exit 1
fi
grep -F 'uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9' "$manifest" >/dev/null
grep -F 'uses: actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9' "$manifest" >/dev/null
grep -F "inputs.sync != 'true'" "$manifest" >/dev/null
grep -F 'cache_prefix="safe-migrate-v7-${RUNNER_OS}-${cache_mode}-${INPUT_BASELINE}-"' "$manifest" >/dev/null
grep -F '[[ ! "$SAFE_MIGRATE_CACHE_KEY" =~ ^[0-9A-Fa-f]{64}$ ]]' "$manifest" >/dev/null
test "$(grep -Ec '^[[:space:]]+SAFE_MIGRATE_CACHE_KEY: "[0-9A-Fa-f]{64}"$' "$workflow")" -eq 5
if grep -Eq '^[[:space:]]+SAFE_MIGRATE_CACHE_KEY: [0-9A-Fa-f]{64}$' "$workflow"; then
  printf '%s\n' 'workflow contains an unquoted hexadecimal cache key' >&2
  exit 1
fi
grep -F 'cache-prefix=${cache_prefix}' "$manifest" >/dev/null
grep -F 'sync-status=${sync_status}' "$manifest" >/dev/null
grep -F 'baseline-source=${baseline_source}' "$manifest" >/dev/null
grep -F 'await core.summary.addRaw(markdown).write();' "$manifest" >/dev/null
grep -F 'core.error(message, properties);' "$manifest" >/dev/null
grep -F 'core.warning(message, properties);' "$manifest" >/dev/null
grep -F "finding.rule_title || finding.rule_id" "$manifest" >/dev/null
grep -F "finding.rule_summary" "$manifest" >/dev/null
grep -F 'actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0' "$manifest" >/dev/null
grep -F 'env -u DATABASE_URL' "$manifest" >/dev/null
grep -F "printf '::add-mask::%s\\n'" "$manifest" >/dev/null
grep -F 'analysis-mode=${analysis_mode}' "$manifest" >/dev/null
grep -F -- 'command+=(--cache "$RESOLVED_CACHE" --config "$config_path" --no-auto-sync)' "$manifest" >/dev/null
grep -F 'mkdir -p -- "$INPUT_OUTPUT_DIR"' "$manifest" >/dev/null
grep -F 'mktemp "${RUNNER_TEMP}/safe-migrate-redacted.XXXXXX"' "$manifest" >/dev/null
if grep -F 'safe-migrate-redacted."*' "$manifest" >/dev/null; then
  printf '%s\n' 'Action still removes other redaction temporary files' >&2
  exit 1
fi
grep -F "steps.action-install.outputs.install-mode == 'source'" "$manifest" >/dev/null
grep -F 'Windows ARM64 runners are not supported' "$manifest" >/dev/null
if grep -F 'aarch64-pc-windows-msvc' "$manifest" >/dev/null; then
  printf '%s\n' 'Action still advertises an unpublished Windows ARM64 artifact' >&2
  exit 1
fi
grep -F 'No synchronized baseline was restored' "$manifest" >/dev/null
grep -F 'if [ "$preflight_failed" != true ] && [ "$operational_failed" != true ]; then' "$manifest" >/dev/null
grep -F 'if [ "$INPUT_NO_CACHE" = "true" ]; then' "$manifest" >/dev/null
if grep -F 'running Tainted analysis without the baseline' "$manifest" >/dev/null; then
  printf '%s\n' 'Action still silently falls back to degraded analysis' >&2
  exit 1
fi
grep -F 'Explicit cache does not exist or is not a file' "$manifest" >/dev/null