Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,4 @@
!/.kokoro
!/tsconfig*.json
!/.ci
!/build.sh
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: is this intended? 😅

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. The node repo by default excludes all files. You have to explicitly add files and folders to .gitignore that you want included in the git repo. This says "don't ignore /build.sh"

151 changes: 151 additions & 0 deletions build.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
#!/usr/bin/env bash

# Copyright 2025 Google LLC.
#
# 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.

# Set SCRIPT_DIR to the current directory of this file.
SCRIPT_DIR=$(cd -P "$(dirname "$0")" >/dev/null 2>&1 && pwd)
SCRIPT_FILE="${SCRIPT_DIR}/$(basename "$0")"

##
## Local Development
##
## These functions should be used to run the local development process
##

## clean - Cleans the build output
function clean() {
if [[ -d '.tools' ]] ; then
rm -rf .tools
fi
npm run clean
}

## build - Builds the project without running tests.
function build() {
npm run compile
}

## test - Runs local unit tests.
function test() {
npm run test
}

## e2e - Runs end-to-end integration tests.
function e2e() {
if [[ ! -f .envrc ]] ; then
write_e2e_env .envrc
fi
source .envrc
npm run prepare
node_modules/.bin/tap -t25 --disable-coverage --allow-empty-coverage -o pgconnect.tap \
system-test/pg-connect.{ts,cjs,mjs} system-test/mysql2-connect.{ts,cjs,mjs} system-test/tedious-connect.{ts,cjs,mjs}

node_modules/.bin/tap -c -t60 --disable-coverage --allow-empty-coverage -o test_results.tap \
examples/*/*/test/*.ts
}

## fix - Fixes code format.
function fix() {
npm run fix
}

## lint - runs the linters
function lint() {
npm run lint
}

## deps - updates project dependencies to latest
function deps() {
npm update --save
}

# write_e2e_env - Loads secrets from the gcloud project and writes
# them to target/e2e.env to run e2e tests.
function write_e2e_env(){
# All secrets used by the e2e tests in the form <env_name>=<secret_name>
secret_vars=(
MYSQL_CONNECTION_NAME=MYSQL_CONNECTION_NAME
MYSQL_USER=MYSQL_USER
MYSQL_USER_IAM=MYSQL_USER_IAM_GO
MYSQL_PASS=MYSQL_PASS
MYSQL_DB=MYSQL_DB
MYSQL_MCP_CONNECTION_NAME=MYSQL_MCP_CONNECTION_NAME
MYSQL_MCP_PASS=MYSQL_MCP_PASS
POSTGRES_CONNECTION_NAME=POSTGRES_CONNECTION_NAME
POSTGRES_USER=POSTGRES_USER
POSTGRES_USER_IAM=POSTGRES_USER_IAM_GO
POSTGRES_PASS=POSTGRES_PASS
POSTGRES_DB=POSTGRES_DB
POSTGRES_CAS_CONNECTION_NAME=POSTGRES_CAS_CONNECTION_NAME
POSTGRES_CAS_PASS=POSTGRES_CAS_PASS
POSTGRES_CUSTOMER_CAS_CONNECTION_NAME=POSTGRES_CUSTOMER_CAS_CONNECTION_NAME
POSTGRES_CUSTOMER_CAS_PASS=POSTGRES_CUSTOMER_CAS_PASS
POSTGRES_CUSTOMER_CAS_DOMAIN_NAME=POSTGRES_CUSTOMER_CAS_DOMAIN_NAME
POSTGRES_CUSTOMER_CAS_INVALID_DOMAIN_NAME=POSTGRES_CUSTOMER_CAS_INVALID_DOMAIN_NAME
POSTGRES_MCP_CONNECTION_NAME=POSTGRES_MCP_CONNECTION_NAME
POSTGRES_MCP_PASS=POSTGRES_MCP_PASS
SQLSERVER_CONNECTION_NAME=SQLSERVER_CONNECTION_NAME
SQLSERVER_USER=SQLSERVER_USER
SQLSERVER_PASS=SQLSERVER_PASS
SQLSERVER_DB=SQLSERVER_DB
QUOTA_PROJECT=QUOTA_PROJECT
)

if [[ -z "$TEST_PROJECT" ]] ; then
echo "Set TEST_PROJECT environment variable to the project containing"
echo "the e2e test suite secrets."
exit 1
fi

echo "Getting test secrets from $TEST_PROJECT into $1"
{
for env_name in "${secret_vars[@]}" ; do
env_var_name="${env_name%%=*}"
secret_name="${env_name##*=}"
set -x
val=$(gcloud secrets versions access latest --project "$TEST_PROJECT" --secret="$secret_name")
echo "export $env_var_name='$val'"
done
} > "$1"

}

## help - prints the help details
##
function help() {
# This will print the comments beginning with ## above each function
# in this file.

echo "build.sh <command> <arguments>"
echo
echo "Commands to assist with local development and CI builds."
echo
echo "Commands:"
echo
grep -e '^##' "$SCRIPT_FILE" | sed -e 's/##/ /'
}

set -euo pipefail

# Check CLI Arguments
if [[ "$#" -lt 1 ]] ; then
help
exit 1
fi

cd "$SCRIPT_DIR"

"$@"

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
"prepare": "rm -rf dist && npm run compile && node ./scripts/fixup.cjs",
"pretest": "npm run prepare",
"presnap": "npm run prepare",
"test": "tap test",
"test": "tap -t0 -c test",
"presystem-test": "npm run prepare",
"system-test": "tap --disable-coverage --allow-empty-coverage system-test",
"sample-test": "tap --disable-coverage --allow-empty-coverage examples",
Expand Down
Loading