aboutsummaryrefslogtreecommitdiffstats
path: root/scripts/lib/test.sh
blob: a90eb2c7f351a758ad13390c225046326b26fb84 (plain) (blame)
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
# shellcheck shell=bash
[[ -n "${BOLT_TEST_LOADED:-}" ]] && return
readonly BOLT_TEST_LOADED=1

readonly BOLT_TEST_SUITES=("mssql" "sqlite3" "postgresql" "mysql")

source "$(dirname "${BASH_SOURCE[0]}")/log.sh"
source "$(dirname "${BASH_SOURCE[0]}")/docker.sh"
source "$(dirname "${BASH_SOURCE[0]}")/path.sh"
source "$(dirname "${BASH_SOURCE[0]}")/env.sh"

# Run a full test suite with database setup and teardown
#
# DESCRIPTION:
#   Starts database, waits for health checks, runs tests with
#   environment variables, and cleans up afterward. Automatically handles
#   database lifecycle and environment variable loading.
#
# ARGUMENTS:
#   $1: Name of the database test suite to run (e.g., "mssql", "postgresql", "sqlite3", or "mysql")
#
# FILES REQUIRED:
#   .env.{test_name} - Environment file with database configuration
#   docker-compose.{test_name}.yml - Docker Compose configuration (unless $1 is sqlite3)
#
# RETURN:
#   0 - Tests passed successfully
#   1 - Tests failed or setup/teardown failed.
#
# EXAMPLES:
#   test_run_suite "mssql"
#   test_run_suite "postgresql"
#
test_run_suite() {
  local db_test_suite_name="$1"
  local container_name="bolt_${db_test_suite_name}_db"
  local env_file="${PATH_PROJECT_DIR}/.env.${db_test_suite_name}"
  local compose_file="${PATH_PROJECT_DIR}/docker-compose.${db_test_suite_name}.yml"
  local coverage_file="${PATH_PROJECT_DIR}/coverage-${db_test_suite_name}.out"
  local test_result=0

  log_header "$db_test_suite_name Tests"

  if [[ $db_test_suite_name != "sqlite3" ]]; then
    log_step "Starting $container_name..."
    docker_compose_up "$compose_file"

    if ! docker_wait_for_healthy_container "$container_name"; then
      log_error "Failed to start $container_name container"
      docker_compose_down "$compose_file"
      return 1
    fi
  fi

  log_step "Running $db_test_suite_name tests..."
  load_env_file "$env_file"
  if ! test_run_go_tests "$db_test_suite_name" "$coverage_file"; then
    local test_result=1
  fi

  if [[ $db_test_suite_name != "sqlite3" ]]; then
    log_step "Cleaning up..."
    docker_compose_down "$compose_file" || log_warn "Unable to clean up docker compose services"
  fi

  return $test_result
}

# Check if a test suite name is valid
#
# ARGUMENTS:
#   $1: Test suite name to validate
#
# RETURN:
#   0 - Valid test suite name
#   1 - Invalid test suite name
test_is_valid_suite() {
  local suite="$1"
  for valid in "${BOLT_TEST_SUITES[@]}"; do
    [[ "$suite" == "$valid" ]] && return 0
  done
  return 1
}

# Run Go tests with optional tags and coverage
#
# DESCRIPTION:
#   Executes Go tests with optional build tags and coverage reporting.
#   Tests are run with parallelism disabled (-p 1).
#
# ARGUMENTS:
#   $1 - test_tags (optional): Build tags to include (e.g., "mssql", "postgres")
#   $2 - coverage_file (optional): Output file for coverage profile
#
# ENVIRONMENT VARIABLES (required for database tests):
#   BOLT_DB_DSN - Database connection string
#   BOLT_DB_DRIVER - Database driver name (e.g., "mssql", "postgres")
#   BOLT_DB_MIGRATIONS_TABLE - Table name for migration tracking
#
# RETURN:
#   0 - Tests passed successfully
#   1 - Tests failed
#
# EXAMPLES:
#   test_run_go_tests
#   test_run_go_tests "mssql" "coverage-mssql.out"
#
test_run_go_tests() {
  local test_tags="$1"
  local coverage_file="$2"

  # NOTE: -p 1 is used because we want to run tests sequentially.
  # This is because our tests depend on shared resources e.g. a database.
  local cmd="go test -p 1"

  if [[ -n "$test_tags" ]]; then
    cmd="$cmd -tags $test_tags"
    log_step "Running tests with tags: $test_tags"
  else
    log_step "Running tests"
  fi

  if [[ -n "$coverage_file" ]]; then
    cmd="$cmd -covermode=count -coverprofile=$coverage_file"
  fi

  cmd="$cmd ./..."

  if eval "$cmd"; then
    log_success "Tests completed successfully!"
  else
    log_error "Tests failed!"
    return 1
  fi
}

# Combine coverage reports from multiple test suites
#
# DESCRIPTION:
#   Merges coverage files matching pattern coverage-*.out into a single report
#
# ARGUMENTS:
#   $1 - output_file: Output file for combined coverage
#
# RETURN:
#   0 - Coverage combined successfully
#   1 - No coverage files found or merge failed
#
test_combine_coverage() {
  local output_file="$1"

  log_step "Checking for coverage files..."
  if ! ls coverage-*.out >/dev/null 2>&1; then
    log_error "No coverage files found (coverage-*.out)"
    log_error "Run tests first to generate coverage reports"
    return 1
  fi

  log_step "Combining reports into $output_file..."
  if ! go run github.com/wadey/gocovmerge@b5bfa59ec0adc420475f97f89b58045c721d761c coverage-*.out >"$output_file"; then
    log_error "Failed to combine coverage reports"
    return 1
  fi

  log_success "Combined coverage report created: $output_file"
}

# Display coverage summary and HTML generation instructions
#
# ARGUMENTS:
#   $1 - coverage_file: Coverage file to summarize
#
test_show_coverage_summary() {
  local coverage_file="$1"
  log_step "Generating coverage summary..."
  go tool cover -func="$coverage_file"
}