Ct 177/add precommit hooks (#107)

* Adding precheck manager, make tasks, workflows, and dev requirements to facilitate these workflows.
* Add commit hooks and get them working.
* Update Makefile for use in this repo.
* Add linecheck recipe (all Python lines over 99).
* Bring flake8 into compliance with dbt core.
* use checks over code and rewrite repo to conform to style conventions
* Mix in released snowflake 1.1.0b1
* Resolve a Black library issue
* Add changelog entry.

.bumpversion.cfg

@@ -4,7 +4,7 @@ parse = (?P<major>\d+)
 	\.(?P<minor>\d+)
 	\.(?P<patch>\d+)
 	((?P<prerelease>a|b|rc)(?P<num>\d+))?
-serialize = 
+serialize =
 	{major}.{minor}.{patch}{prerelease}{num}
 	{major}.{minor}.{patch}
 commit = False
@@ -13,7 +13,7 @@ tag = False
 [bumpversion:part:prerelease]
 first_value = a
 optional_value = final
-values = 
+values =
 	a
 	b
 	rc

.flake8

@@ -0,0 +1,12 @@
+[flake8]
+select =
+    E
+    W
+    F
+ignore =
+    W503 # makes Flake8 work like black
+    W504
+    E203 # makes Flake8 work like black
+    E741
+    E501
+exclude = test

.github/pull_request_template.md

@@ -18,4 +18,4 @@ resolves #
 - [ ] I have signed the [CLA](https://docs.getdbt.com/docs/contributor-license-agreements)
 - [ ] I have run this code in development and it appears to resolve the stated issue
 - [ ] This PR includes tests, or tests are not required/relevant for this PR
-- [ ] I have updated the `CHANGELOG.md` and added information about my change to the "dbt-snowflake next" section.
+- [ ] I have updated the `CHANGELOG.md` and added information about my change to the "dbt-snowflake next" section.

.github/workflows/integration.yml

@@ -221,9 +221,9 @@ jobs:
 
   post-failure:
     runs-on: ubuntu-latest
-    needs: test 
+    needs: test
     if: ${{ failure() }}
-    
+
     steps:
       - name: Posting scheduled run failures
         uses: ravsamhq/notify-slack-action@v1

.github/workflows/jira-creation.yml

@@ -13,7 +13,7 @@ name: Jira Issue Creation
 on:
   issues:
     types: [opened, labeled]
-    
+
 permissions:
   issues: write
 

.github/workflows/jira-label.yml

@@ -13,7 +13,7 @@ name: Jira Label Mirroring
 on:
   issues:
     types: [labeled, unlabeled]
-    
+
 permissions:
   issues: read
 
@@ -24,4 +24,3 @@ jobs:
       JIRA_BASE_URL: ${{ secrets.JIRA_BASE_URL }}
       JIRA_USER_EMAIL: ${{ secrets.JIRA_USER_EMAIL }}
       JIRA_API_TOKEN: ${{ secrets.JIRA_API_TOKEN }}
-

.github/workflows/jira-transition.yml

@@ -21,4 +21,4 @@ jobs:
     secrets:
       JIRA_BASE_URL: ${{ secrets.JIRA_BASE_URL }}
       JIRA_USER_EMAIL: ${{ secrets.JIRA_USER_EMAIL }}
-      JIRA_API_TOKEN: ${{ secrets.JIRA_API_TOKEN }}
+      JIRA_API_TOKEN: ${{ secrets.JIRA_API_TOKEN }}

.github/workflows/main.yml

@@ -37,19 +37,10 @@ defaults:
 
 jobs:
   code-quality:
-    name: ${{ matrix.toxenv }}
+    name: code-quality
 
     runs-on: ubuntu-latest
 
-    strategy:
-      fail-fast: false
-      matrix:
-        toxenv: [flake8]
-
-    env:
-      TOXENV: ${{ matrix.toxenv }}
-      PYTEST_ADDOPTS: "-v --color=yes"
-
     steps:
       - name: Check out the repository
         uses: actions/checkout@v2
@@ -62,12 +53,16 @@ jobs:
       - name: Install python dependencies
         run: |
           pip install --user --upgrade pip
-          pip install tox
+          pip install pre-commit
+          pip install mypy==0.782
+          pip install -r dev_requirements.txt
           pip --version
-          tox --version
+          pre-commit --version
+          mypy --version
+          dbt --version
 
-      - name: Run tox
-        run: tox
+      - name: Run pre-commit hooks
+        run: pre-commit run --all-files --show-diff-on-failure
 
   unit:
     name: unit test / python ${{ matrix.python-version }}

.github/workflows/stale.yml

@@ -13,5 +13,3 @@ jobs:
           stale-pr-message: "This PR has been marked as Stale because it has been open for 180 days with no activity. If you would like the PR to remain open, please remove the stale label or comment on the PR, or it will be closed in 7 days."
           # mark issues/PRs stale when they haven't seen activity in 180 days
           days-before-stale: 180
-          # ignore checking issues with the following labels
-          exempt-issue-labels: "epic, discussion"

.github/workflows/version-bump.yml

@@ -1,16 +1,16 @@
 # **what?**
 # This workflow will take a version number and a dry run flag. With that
-# it will run versionbump to update the version number everywhere in the 
+# it will run versionbump to update the version number everywhere in the
 # code base and then generate an update Docker requirements file. If this
 # is a dry run, a draft PR will open with the changes. If this isn't a dry
 # run, the changes will be committed to the branch this is run on.
 
 # **why?**
-# This is to aid in releasing dbt and making sure we have updated 
+# This is to aid in releasing dbt and making sure we have updated
 # the versions and Docker requirements in all places.
 
 # **when?**
-# This is triggered either manually OR 
+# This is triggered either manually OR
 # from the repository_dispatch event "version-bump" which is sent from
 # the dbt-release repo Action
 
@@ -25,11 +25,11 @@ on:
       is_dry_run:
        description: 'Creates a draft PR to allow testing instead of committing to a branch'
        required: true
-       default: 'true'  
+       default: 'true'
   repository_dispatch:
     types: [version-bump]
 
-jobs:          
+jobs:
   bump:
     runs-on: ubuntu-latest
     steps:
@@ -57,19 +57,19 @@ jobs:
         run: |
           python3 -m venv env
           source env/bin/activate
-          pip install --upgrade pip     
-          
+          pip install --upgrade pip
+
       - name: Create PR branch
         if: ${{ steps.variables.outputs.IS_DRY_RUN  == 'true' }}
         run: |
           git checkout -b bumping-version/${{steps.variables.outputs.VERSION_NUMBER}}_$GITHUB_RUN_ID
           git push origin bumping-version/${{steps.variables.outputs.VERSION_NUMBER}}_$GITHUB_RUN_ID
           git branch --set-upstream-to=origin/bumping-version/${{steps.variables.outputs.VERSION_NUMBER}}_$GITHUB_RUN_ID bumping-version/${{steps.variables.outputs.VERSION_NUMBER}}_$GITHUB_RUN_ID
-   
+
       - name: Bumping version
         run: |
           source env/bin/activate
-          pip install -r dev_requirements.txt 
+          pip install -r dev_requirements.txt
           env/bin/bumpversion --allow-dirty --new-version ${{steps.variables.outputs.VERSION_NUMBER}} major
           git status
 
@@ -99,4 +99,4 @@ jobs:
           draft: true
           base: ${{github.ref}}
           title: 'Bumping version to ${{steps.variables.outputs.VERSION_NUMBER}}'
-          branch: 'bumping-version/${{steps.variables.outputs.VERSION_NUMBER}}_${{GITHUB.RUN_ID}}'    
+          branch: 'bumping-version/${{steps.variables.outputs.VERSION_NUMBER}}_${{GITHUB.RUN_ID}}'

.gitignore

@@ -49,9 +49,7 @@ coverage.xml
 *,cover
 .hypothesis/
 test.env
-
-# Mypy
-.mypy_cache/
+*.pytest_cache/
 
 # Translations
 *.mo
@@ -66,10 +64,10 @@ docs/_build/
 # PyBuilder
 target/
 
-#Ipython Notebook
+# Ipython Notebook
 .ipynb_checkpoints
 
-#Emacs
+# Emacs
 *~
 
 # Sublime Text
@@ -78,6 +76,7 @@ target/
 # Vim
 *.sw*
 
+# Pyenv
 .python-version
 
 # Vim
@@ -90,6 +89,7 @@ venv/
 # AWS credentials
 .aws/
 
+# MacOS
 .DS_Store
 
 # vscode

.pre-commit-config.yaml

@@ -0,0 +1,66 @@
+# For more on configuring pre-commit hooks (see https://pre-commit.com/)
+
+# TODO: remove global exclusion of tests when testing overhaul is complete
+exclude: '^tests/.*'
+
+# Force all unspecified python hooks to run python 3.8
+default_language_version:
+  python: python3.8
+
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v3.2.0
+  hooks:
+  - id: check-yaml
+    args: [--unsafe]
+  - id: check-json
+  - id: end-of-file-fixer
+  - id: trailing-whitespace
+  - id: check-case-conflict
+- repo: https://github.com/psf/black
+  rev: 21.12b0
+  hooks:
+  - id: black
+    additional_dependencies: ['click==8.0.4']
+    args:
+    - "--line-length=99"
+    - "--target-version=py38"
+  - id: black
+    alias: black-check
+    stages: [manual]
+    additional_dependencies: ['click==8.0.4']
+    args:
+    - "--line-length=99"
+    - "--target-version=py38"
+    - "--check"
+    - "--diff"
+- repo: https://gitlab.com/pycqa/flake8
+  rev: 4.0.1
+  hooks:
+  - id: flake8
+  - id: flake8
+    alias: flake8-check
+    stages: [manual]
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: v0.782
+  hooks:
+  - id: mypy
+    # N.B.: Mypy is... a bit fragile.
+    #
+    # By using `language: system` we run this hook in the local
+    # environment instead of a pre-commit isolated one.  This is needed
+    # to ensure mypy correctly parses the project.
+
+    # It may cause trouble in that it adds environmental variables out
+    # of our control to the mix.  Unfortunately, there's nothing we can
+    # do about per pre-commit's author.
+    # See https://github.com/pre-commit/pre-commit/issues/730 for details.
+    args: [--show-error-codes, --ignore-missing-imports]
+    files: ^dbt/adapters/.*
+    language: system
+  - id: mypy
+    alias: mypy-check
+    stages: [manual]
+    args: [--show-error-codes, --pretty, --ignore-missing-imports]
+    files: ^dbt/adapters
+    language: system

CHANGELOG.md

@@ -1,3 +1,8 @@
+## dbt-snowflake 1.2.0 (tbd)
+
+### Under the hood
+- Add precommits for this repo ([#107](https://github.com/dbt-labs/dbt-snowflake/pull/107))
+
 ## dbt-snowflake 1.1.0b1 (March 23, 2022)
 
 ### Features

MANIFEST.in

@@ -1 +1 @@
-recursive-include dbt/include *.sql *.yml *.md
+recursive-include dbt/include *.sql *.yml *.md

Makefile

@@ -0,0 +1,61 @@
+.DEFAULT_GOAL:=help
+
+.PHONY: dev
+dev: ## Installs adapter in develop mode along with development depedencies
+	@\
+	pip install -r dev_requirements.txt && pre-commit install
+
+.PHONY: mypy
+mypy: ## Runs mypy against staged changes for static type checking.
+	@\
+	pre-commit run --hook-stage manual mypy-check | grep -v "INFO"
+
+.PHONY: flake8
+flake8: ## Runs flake8 against staged changes to enforce style guide.
+	@\
+	pre-commit run --hook-stage manual flake8-check | grep -v "INFO"
+
+.PHONY: black
+black: ## Runs black  against staged changes to enforce style guide.
+	@\
+	pre-commit run --hook-stage manual black-check -v | grep -v "INFO"
+
+.PHONY: lint
+lint: ## Runs flake8 and mypy code checks against staged changes.
+	@\
+	pre-commit run flake8-check --hook-stage manual | grep -v "INFO"; \
+	pre-commit run mypy-check --hook-stage manual | grep -v "INFO"
+
+.PHONY: linecheck
+linecheck: ## Checks for all Python lines 100 characters or more
+	@\
+	find dbt -type f -name "*.py" -exec grep -I -r -n '.\{100\}' {} \;
+
+.PHONY: unit
+unit: ## Runs unit tests with py38.
+	@\
+	tox -e py38
+
+.PHONY: test
+test: ## Runs unit tests with py38 and code checks against staged changes.
+	@\
+	tox -p -e py38; \
+	pre-commit run black-check --hook-stage manual | grep -v "INFO"; \
+	pre-commit run flake8-check --hook-stage manual | grep -v "INFO"; \
+	pre-commit run mypy-check --hook-stage manual | grep -v "INFO"
+
+.PHONY: integration
+integration: ## Runs snowflake integration tests with py38.
+	@\
+	tox -e py38-snowflake --
+
+.PHONY: clean
+	@echo "cleaning repo"
+	@git clean -f -X
+
+.PHONY: help
+help: ## Show this help message.
+	@echo 'usage: make [target]'
+	@echo
+	@echo 'targets:'
+	@grep -E '^[7+a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'

dbt/adapters/snowflake/__init__.py

@@ -4,10 +4,9 @@
 from dbt.adapters.snowflake.relation import SnowflakeRelation  # noqa
 from dbt.adapters.snowflake.impl import SnowflakeAdapter
 
-from dbt.adapters.base import AdapterPlugin
-from dbt.include import snowflake
+from dbt.adapters.base import AdapterPlugin  # type: ignore
+from dbt.include import snowflake  # type: ignore
 
 Plugin = AdapterPlugin(
-    adapter=SnowflakeAdapter,
-    credentials=SnowflakeCredentials,
-    include_path=snowflake.PACKAGE_PATH)
+    adapter=SnowflakeAdapter, credentials=SnowflakeCredentials, include_path=snowflake.PACKAGE_PATH
+)

dbt/adapters/snowflake/__version__.py

@@ -1 +1 @@
-version = '1.1.0b1'
+version = "1.1.0b1"