SNOW-608095: Create new SQLAlchemy Jenkins test pipeline (#304)

Create new SQLAlchemy Jenkins test pipeline which runs pytest against pre-built sqlalchemy wheel

Author: sfc-gh-aling

ci/test.sh

@@ -0,0 +1,27 @@
+#!/bin/bash -e
+#
+# Test Snowflake SQLAlchemy
+#
+THIS_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+SQLALCHEMY_DIR="$( dirname "${THIS_DIR}")"
+PARAMETERS_DIR="${SQLALCHEMY_DIR}/.github/workflows/parameters"
+
+cd "${SQLALCHEMY_DIR}"
+
+# Check Requirements
+if [ -z "${PARAMETERS_SECRET}" ]; then
+    echo "Missing PARAMETERS_SECRET, failing..."
+    exit 1
+fi
+
+# Decrypt parameters file
+PARAMS_FILE="${PARAMETERS_DIR}/parameters_aws.py.gpg"
+[ ${cloud_provider} == azure ] && PARAMS_FILE="${PARAMETERS_DIR}/parameters_azure.py.gpg"
+[ ${cloud_provider} == gcp ] && PARAMS_FILE="${PARAMETERS_DIR}/parameters_gcp.py.gpg"
+gpg --quiet --batch --yes --decrypt --passphrase="${PARAMETERS_SECRET}" ${PARAMS_FILE} > tests/parameters.py
+
+# Download artifacts made by build
+aws s3 cp --recursive --only-show-errors s3://sfc-jenkins/repository/sqlalchemy/linux/${client_git_branch}/${client_git_commit}/ dist
+
+echo "[Info] Going to run regular tests for Python ${python_env}"
+${THIS_DIR}/test_docker.sh ${python_env}

ci/test_docker.sh

@@ -0,0 +1,53 @@
+#!/bin/bash -e
+# Test Snowflake SQLAlchemy in Docker
+# NOTES:
+#   - By default this script runs Python 3.7 tests, as these are installed in dev vms
+#   - To compile only a specific version(s) pass in versions like: `./test_docker.sh "3.7 3.8"`
+
+set -o pipefail
+
+# In case this is ran from dev-vm
+PYTHON_ENV=${1:-3.7}
+
+# Set constants
+THIS_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+SQLALCHEMY_DIR="$( dirname "${THIS_DIR}")"
+WORKSPACE=${WORKSPACE:-$SQLALCHEMY_DIR}
+source $THIS_DIR/set_base_image.sh
+
+cd $THIS_DIR/docker/sqlalchemy_build
+
+CONTAINER_NAME=test_sqlalchemy
+
+echo "[Info] Building docker image"
+arch=$(uname -p)
+
+echo "[Info] Building docker image"
+if [[ "$arch" == "aarch64" ]]; then
+  BASE_IMAGE=$BASE_IMAGE_MANYLINUX2014AARCH64
+  GOSU_URL=https://github.com/tianon/gosu/releases/download/1.14/gosu-arm64
+else
+  BASE_IMAGE=$BASE_IMAGE_MANYLINUX2014
+  GOSU_URL=https://github.com/tianon/gosu/releases/download/1.14/gosu-amd64
+fi
+
+echo "[Info] Start building docker image and testing"
+
+user_id=$(id -u ${USER})
+docker run \
+    --rm \
+    --network=host \
+    -e TERM=vt102 \
+    -e PIP_DISABLE_PIP_VERSION_CHECK=1 \
+    -e OPENSSL_FIPS=1 \
+    -e LOCAL_USER_ID=${user_id} \
+    -e AWS_ACCESS_KEY_ID \
+    -e AWS_SECRET_ACCESS_KEY \
+    -e SF_REGRESS_LOGS \
+    -e SF_PROJECT_ROOT \
+    -e cloud_provider \
+    -e JENKINS_HOME \
+    -e GITHUB_ACTIONS \
+    --mount type=bind,source="${SQLALCHEMY_DIR}",target=/home/user/snowflake-sqlalchemy \
+    $(docker build --pull --build-arg BASE_IMAGE=$BASE_IMAGE --build-arg GOSU_URL="$GOSU_URL" -q .) \
+    /home/user/snowflake-sqlalchemy/ci/test_linux.sh ${PYTHON_ENV}

ci/test_linux.sh

@@ -0,0 +1,26 @@
+#!/bin/bash -e
+#
+# Test Snowflake SQLAlchemy in Linux
+# NOTES:
+#   - Versions to be tested should be passed in as the first argument, e.g: "3.7 3.8". If omitted 3.7-3.10 will be assumed.
+#   - This script assumes that ../dist/repaired_wheels has the wheel(s) built for all versions to be tested
+#   - This is the script that test_docker.sh runs inside of the docker container
+
+PYTHON_VERSIONS="${1:-3.7 3.8 3.9 3.10}"
+THIS_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+SQLALCHEMY_DIR="$( dirname "${THIS_DIR}")"
+
+# Install one copy of tox
+python3 -m pip install -U tox-external-wheels
+python3 -m pip install --pre tox
+
+# Run tests
+cd $SQLALCHEMY_DIR
+for PYTHON_VERSION in ${PYTHON_VERSIONS}; do
+    echo "[Info] Testing with ${PYTHON_VERSION}"
+    SHORT_VERSION=$(python3 -c "print('${PYTHON_VERSION}'.replace('.', ''))")
+    SQLALCHEMY_WHL=$(ls $SQLALCHEMY_DIR/dist/snowflake_sqlalchemy-*-py2.py3-none-any.whl | sort -r | head -n 1)
+    TEST_ENVLIST=fix_lint,py${SHORT_VERSION}-ci,py${SHORT_VERSION}-coverage
+    echo "[Info] Running tox for ${TEST_ENVLIST}"
+    python3 -m tox -e ${TEST_ENVLIST} --external_wheels ${SQLALCHEMY_WHL}
+done

tox.ini

@@ -11,13 +11,30 @@ description = run the tests with pytest under {basepython}
 extras =
     development
     pandas
+external_wheels =
+    py37-ci: dist/*.whl
+    py38-ci: dist/*.whl
+    py39-ci: dist/.whl
+    py310-ci: dist/.whl
 deps = pip
 passenv =
+    AWS_ACCESS_KEY_ID
+    AWS_SECRET_ACCESS_KEY
+    SF_PROJECT_ROOT
     cloud_provider
+    SF_REGRESS_LOGS
+    ; Github Actions provided environmental variables
     GITHUB_ACTIONS
+    JENKINS_HOME
+    ; This is required on windows. Otherwise pwd module won't be imported successfully,
+    ; see https://github.com/tox-dev/tox/issues/1455
+    USERNAME
     PYTEST_ADDOPTS
-setenv = COVERAGE_FILE = {env:COVERAGE_FILE:{toxworkdir}/.coverage.{envname}}
+setenv =
+    COVERAGE_FILE = {env:COVERAGE_FILE:{toxworkdir}/.coverage.{envname}}
+    ci: SNOWFLAKE_PYTEST_OPTS = -vvv
 commands = pytest \
+           {env:SNOWFLAKE_PYTEST_OPTS:} \
            --cov "snowflake.sqlalchemy" \
            --junitxml {toxworkdir}/junit.{envname}.xml \
            {posargs:tests}