google-datacatalog-connectors-commons-test

Common test resources for Data Catalog connectors

Disclaimer: This is not an officially supported Google product.

Table of Contents

• 1. Installable file build process
  • 1.1. Get the code
  • 1.2. Virtualenv
    • 1.2.1. Install Python 3.5
    • 1.2.2. Create and activate a virtualenv
  • 1.3. Generate a wheel file
• 2. Developer environment
  • 2.1. Install and run YAPF formatter
  • 2.2. Install and run Flake8 linter
  • 2.3. Install the package in editable mode (i.e. setuptools “develop mode”)
  • 2.4. Run the unit tests

1. Installable file build process

1.1. Get the code

git clone https://github.com/GoogleCloudPlatform/datacatalog-connectors
cd google-datacatalog-connectors-commons-test

1.2. Virtualenv

Using virtualenv is optional, but strongly recommended.

1.2.1. Install Python 3.5

1.2.2. Create and activate a virtualenv

pip install --upgrade virtualenv
python3 -m virtualenv --python python3 env
source ./env/bin/activate

1.3. Generate a wheel file

python setup.py bdist_wheel

The wheel file can used to install the package as a local pip dependency to other projects while it's not published to The Python Package Index (PyPI).

2. Developer environment

2.1. Install and run YAPF formatter

pip install --upgrade yapf

# Auto update files
yapf --in-place --recursive src tests

# Show diff
yapf --diff --recursive src tests

# Set up pre-commit hook
# From the root of your git project.
curl -o pre-commit.sh https://raw.githubusercontent.com/google/yapf/master/plugins/pre-commit.sh
chmod a+x pre-commit.sh
mv pre-commit.sh .git/hooks/pre-commit

2.2. Install and run Flake8 linter

pip install --upgrade flake8
flake8 src tests

2.3. Install the package in editable mode (i.e. setuptools “develop mode”)

pip install --editable .

2.4. Run the unit tests

python setup.py test