Compare commits

..

1 Commits

Author SHA1 Message Date
Kyle Wigley
03dfb11d2b wait for successful connection before setting up db 2021-09-13 11:43:17 -04:00
5729 changed files with 61181 additions and 70516 deletions

View File

@@ -1,12 +1,12 @@
[bumpversion] [bumpversion]
current_version = 1.3.0a1 current_version = 0.21.0b1
parse = (?P<major>\d+) parse = (?P<major>\d+)
\.(?P<minor>\d+) \.(?P<minor>\d+)
\.(?P<patch>\d+) \.(?P<patch>\d+)
((?P<prekind>a|b|rc) ((?P<prekind>a|b|rc)
(?P<pre>\d+) # pre-release version num (?P<pre>\d+) # pre-release version num
)? )?
serialize = serialize =
{major}.{minor}.{patch}{prekind}{pre} {major}.{minor}.{patch}{prekind}{pre}
{major}.{minor}.{patch} {major}.{minor}.{patch}
commit = False commit = False
@@ -15,7 +15,7 @@ tag = False
[bumpversion:part:prekind] [bumpversion:part:prekind]
first_value = a first_value = a
optional_value = final optional_value = final
values = values =
a a
b b
rc rc
@@ -24,16 +24,27 @@ values =
[bumpversion:part:pre] [bumpversion:part:pre]
first_value = 1 first_value = 1
[bumpversion:file:setup.py]
[bumpversion:file:core/setup.py] [bumpversion:file:core/setup.py]
[bumpversion:file:core/dbt/version.py] [bumpversion:file:core/dbt/version.py]
[bumpversion:file:core/scripts/create_adapter_plugins.py]
[bumpversion:file:plugins/postgres/setup.py] [bumpversion:file:plugins/postgres/setup.py]
[bumpversion:file:plugins/redshift/setup.py]
[bumpversion:file:plugins/snowflake/setup.py]
[bumpversion:file:plugins/bigquery/setup.py]
[bumpversion:file:plugins/postgres/dbt/adapters/postgres/__version__.py] [bumpversion:file:plugins/postgres/dbt/adapters/postgres/__version__.py]
[bumpversion:file:docker/Dockerfile] [bumpversion:file:plugins/redshift/dbt/adapters/redshift/__version__.py]
[bumpversion:file:tests/adapter/setup.py] [bumpversion:file:plugins/snowflake/dbt/adapters/snowflake/__version__.py]
[bumpversion:file:plugins/bigquery/dbt/adapters/bigquery/__version__.py]
[bumpversion:file:tests/adapter/dbt/tests/adapter/__version__.py]

View File

@@ -1,19 +0,0 @@
## Previous Releases
For information on prior major and minor releases, see their changelogs:
* [1.2](https://github.com/dbt-labs/dbt-core/blob/1.2.latest/CHANGELOG.md)
* [1.1](https://github.com/dbt-labs/dbt-core/blob/1.1.latest/CHANGELOG.md)
* [1.0](https://github.com/dbt-labs/dbt-core/blob/1.0.latest/CHANGELOG.md)
* [0.21](https://github.com/dbt-labs/dbt-core/blob/0.21.latest/CHANGELOG.md)
* [0.20](https://github.com/dbt-labs/dbt-core/blob/0.20.latest/CHANGELOG.md)
* [0.19](https://github.com/dbt-labs/dbt-core/blob/0.19.latest/CHANGELOG.md)
* [0.18](https://github.com/dbt-labs/dbt-core/blob/0.18.latest/CHANGELOG.md)
* [0.17](https://github.com/dbt-labs/dbt-core/blob/0.17.latest/CHANGELOG.md)
* [0.16](https://github.com/dbt-labs/dbt-core/blob/0.16.latest/CHANGELOG.md)
* [0.15](https://github.com/dbt-labs/dbt-core/blob/0.15.latest/CHANGELOG.md)
* [0.14](https://github.com/dbt-labs/dbt-core/blob/0.14.latest/CHANGELOG.md)
* [0.13](https://github.com/dbt-labs/dbt-core/blob/0.13.latest/CHANGELOG.md)
* [0.12](https://github.com/dbt-labs/dbt-core/blob/0.12.latest/CHANGELOG.md)
* [0.11 and earlier](https://github.com/dbt-labs/dbt-core/blob/0.11.latest/CHANGELOG.md)

View File

@@ -1,53 +0,0 @@
# CHANGELOG Automation
We use [changie](https://changie.dev/) to automate `CHANGELOG` generation. For installation and format/command specifics, see the documentation.
### Quick Tour
- All new change entries get generated under `/.changes/unreleased` as a yaml file
- `header.tpl.md` contains the contents of the entire CHANGELOG file
- `0.0.0.md` contains the contents of the footer for the entire CHANGELOG file. changie looks to be in the process of supporting a footer file the same as it supports a header file. Switch to that when available. For now, the 0.0.0 in the file name forces it to the bottom of the changelog no matter what version we are releasing.
- `.changie.yaml` contains the fields in a change, the format of a single change, as well as the format of the Contributors section for each version.
### Workflow
#### Daily workflow
Almost every code change we make associated with an issue will require a `CHANGELOG` entry. After you have created the PR in GitHub, run `changie new` and follow the command prompts to generate a yaml file with your change details. This only needs to be done once per PR.
The `changie new` command will ensure correct file format and file name. There is a one to one mapping of issues to changes. Multiple issues cannot be lumped into a single entry. If you make a mistake, the yaml file may be directly modified and saved as long as the format is preserved.
Note: If your PR has been cleared by the Core Team as not needing a changelog entry, the `Skip Changelog` label may be put on the PR to bypass the GitHub action that blacks PRs from being merged when they are missing a `CHANGELOG` entry.
#### Prerelease Workflow
These commands batch up changes in `/.changes/unreleased` to be included in this prerelease and move those files to a directory named for the release version. The `--move-dir` will be created if it does not exist and is created in `/.changes`.
```
changie batch <version> --move-dir '<version>' --prerelease 'rc1'
changie merge
```
Example
```
changie batch 1.0.5 --move-dir '1.0.5' --prerelease 'rc1'
changie merge
```
#### Final Release Workflow
These commands batch up changes in `/.changes/unreleased` as well as `/.changes/<version>` to be included in this final release and delete all prereleases. This rolls all prereleases up into a single final release. All `yaml` files in `/unreleased` and `<version>` will be deleted at this point.
```
changie batch <version> --include '<version>' --remove-prereleases
changie merge
```
Example
```
changie batch 1.0.5 --include '1.0.5' --remove-prereleases
changie merge
```
### A Note on Manual Edits & Gotchas
- Changie generates markdown files in the `.changes` directory that are parsed together with the `changie merge` command. Every time `changie merge` is run, it regenerates the entire file. For this reason, any changes made directly to `CHANGELOG.md` will be overwritten on the next run of `changie merge`.
- If changes need to be made to the `CHANGELOG.md`, make the changes to the relevant `<version>.md` file located in the `/.changes` directory. You will then run `changie merge` to regenerate the `CHANGELOG.MD`.
- Do not run `changie batch` again on released versions. Our final release workflow deletes all of the yaml files associated with individual changes. If for some reason modifications to the `CHANGELOG.md` are required after we've generated the final release `CHANGELOG.md`, the modifications need to be done manually to the `<version>.md` file in the `/.changes` directory.
- changie can modify, create and delete files depending on the command you run. This is expected. Be sure to commit everything that has been modified and deleted.

View File

@@ -1,6 +0,0 @@
# dbt Core Changelog
- This file provides a full account of all changes to `dbt-core` and `dbt-postgres`
- Changes are listed under the (pre)release in which they first appear. Subsequent releases include changes from previous releases.
- "Breaking changes" listed under a version may require action from end users or external maintainers when upgrading to that version.
- Do not edit this file directly. This file is auto-generated using [changie](https://github.com/miniscruff/changie). For details on how to document a change, see [the contributing guide](https://github.com/dbt-labs/dbt-core/blob/main/CONTRIBUTING.md#adding-changelog-entry)

View File

@@ -1,8 +0,0 @@
kind: Features
body: Add reusable function for retrying adapter connections. Utilize said function
to add retries for Postgres (and Redshift).
time: 2022-07-15T03:55:55.270637265+02:00
custom:
Author: tomasfarias
Issue: "5022"
PR: "5432"

View File

@@ -1,7 +0,0 @@
kind: Fixes
body: Rename try to strict for more intuitiveness
time: 2022-07-15T23:11:48.327928+12:00
custom:
Author: jeremyyeo
Issue: "5475"
PR: "5477"

View File

@@ -1,61 +0,0 @@
changesDir: .changes
unreleasedDir: unreleased
headerPath: header.tpl.md
versionHeaderPath: ""
changelogPath: CHANGELOG.md
versionExt: md
versionFormat: '## dbt-core {{.Version}} - {{.Time.Format "January 02, 2006"}}'
kindFormat: '### {{.Kind}}'
changeFormat: '- {{.Body}} ([#{{.Custom.Issue}}](https://github.com/dbt-labs/dbt-core/issues/{{.Custom.Issue}}), [#{{.Custom.PR}}](https://github.com/dbt-labs/dbt-core/pull/{{.Custom.PR}}))'
kinds:
- label: Breaking Changes
- label: Features
- label: Fixes
- label: Docs
- label: Under the Hood
- label: Dependencies
- label: Security
custom:
- key: Author
label: GitHub Username(s) (separated by a single space if multiple)
type: string
minLength: 3
- key: Issue
label: GitHub Issue Number
type: int
minLength: 4
- key: PR
label: GitHub Pull Request Number
type: int
minLength: 4
footerFormat: |
{{- $contributorDict := dict }}
{{- /* any names added to this list should be all lowercase for later matching purposes */}}
{{- $core_team := list "emmyoop" "nathaniel-may" "gshank" "leahwicz" "chenyulinx" "stu-k" "iknox-fa" "versusfacit" "mcknight-42" "jtcohen6" "dependabot" }}
{{- range $change := .Changes }}
{{- $authorList := splitList " " $change.Custom.Author }}
{{- /* loop through all authors for a PR */}}
{{- range $author := $authorList }}
{{- $authorLower := lower $author }}
{{- /* we only want to include non-core team contributors */}}
{{- if not (has $authorLower $core_team)}}
{{- $pr := $change.Custom.PR }}
{{- /* check if this contributor has other PRs associated with them already */}}
{{- if hasKey $contributorDict $author }}
{{- $prList := get $contributorDict $author }}
{{- $prList = append $prList $pr }}
{{- $contributorDict := set $contributorDict $author $prList }}
{{- else }}
{{- $prList := list $change.Custom.PR }}
{{- $contributorDict := set $contributorDict $author $prList }}
{{- end }}
{{- end}}
{{- end}}
{{- end }}
{{- /* no indentation here for formatting so the final markdown doesn't have unneeded indentations */}}
{{- if $contributorDict}}
### Contributors
{{- range $k,$v := $contributorDict }}
- [@{{$k}}](https://github.com/{{$k}}) ({{ range $index, $element := $v }}{{if $index}}, {{end}}[#{{$element}}](https://github.com/dbt-labs/dbt-core/pull/{{$element}}){{end}})
{{- end }}
{{- end }}

12
.flake8
View File

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

View File

@@ -1,2 +0,0 @@
# Reformatting dbt-core via black, flake8, mypy, and assorted pre-commit hooks.
43e3fc22c4eae4d3d901faba05e33c40f1f1dc5a

43
.github/CODEOWNERS vendored
View File

@@ -1,43 +0,0 @@
# This file contains the code owners for the dbt-core repo.
# PRs will be automatically assigned for review to the associated
# team(s) or person(s) that touches any files that are mapped to them.
#
# A statement takes precedence over the statements above it so more general
# assignments are found at the top with specific assignments being lower in
# the ordering (i.e. catch all assignment should be the first item)
#
# Consult GitHub documentation for formatting guidelines:
# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners#example-of-a-codeowners-file
# As a default for areas with no assignment,
# the core team as a whole will be assigned
* @dbt-labs/core
# Changes to GitHub configurations including Actions
/.github/ @leahwicz
# Language core modules
/core/dbt/config/ @dbt-labs/core-language
/core/dbt/context/ @dbt-labs/core-language
/core/dbt/contracts/ @dbt-labs/core-language
/core/dbt/deps/ @dbt-labs/core-language
/core/dbt/parser/ @dbt-labs/core-language
# Execution core modules
/core/dbt/events/ @dbt-labs/core-execution @dbt-labs/core-language # eventually remove language but they have knowledge here now
/core/dbt/graph/ @dbt-labs/core-execution
/core/dbt/task/ @dbt-labs/core-execution
# Adapter interface, scaffold, Postgres plugin
/core/dbt/adapters @dbt-labs/core-adapters
/core/scripts/create_adapter_plugin.py @dbt-labs/core-adapters
/plugins/ @dbt-labs/core-adapters
# Global project: default macros, including generic tests + materializations
/core/dbt/include/global_project @dbt-labs/core-execution @dbt-labs/core-adapters
# Perf regression testing framework
# This excludes the test project files itself since those aren't specific
# framework changes (excluded by not setting an owner next to it- no owner)
/performance @nathaniel-may
/performance/projects

View File

@@ -0,0 +1,27 @@
---
name: Beta minor version release
about: Creates a tracking checklist of items for a Beta minor version release
title: "[Tracking] v#.##.#B# release "
labels: 'release'
assignees: ''
---
### Release Core
- [ ] [Engineering] Follow [dbt-release workflow](https://www.notion.so/dbtlabs/Releasing-b97c5ea9a02949e79e81db3566bbc8ef#03ff37da697d4d8ba63d24fae1bfa817)
- [ ] [Engineering] Verify new release branch is created in the repo
- [ ] [Product] Finalize migration guide (next.docs.getdbt.com)
### Release Cloud
- [ ] [Engineering] Create a platform issue to update dbt Cloud and verify it is completed. [Example issue](https://github.com/dbt-labs/dbt-cloud/issues/3481)
- [ ] [Engineering] Determine if schemas have changed. If so, generate new schemas and push to schemas.getdbt.com
### Announce
- [ ] [Product] Announce in dbt Slack
### Post-release
- [ ] [Engineering] [Bump plugin versions](https://www.notion.so/dbtlabs/Releasing-b97c5ea9a02949e79e81db3566bbc8ef#f01854e8da3641179fbcbe505bdf515c) (dbt-spark + dbt-presto), add compatibility as needed
- [ ] [Spark](https://github.com/dbt-labs/dbt-spark)
- [ ] [Presto](https://github.com/dbt-labs/dbt-presto)
- [ ] [Engineering] Create a platform issue to update dbt-spark versions to dbt Cloud. [Example issue](https://github.com/dbt-labs/dbt-cloud/issues/3481)
- [ ] [Engineering] Create an epic for the RC release

View File

@@ -1,85 +0,0 @@
name: 🐞 Bug
description: Report a bug or an issue you've found with dbt
title: "[Bug] <title>"
labels: ["bug", "triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Current Behavior
description: A concise description of what you're experiencing.
validations:
required: false
- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
validations:
required: false
- type: textarea
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior.
placeholder: |
1. In this environment...
2. With this config...
3. Run '...'
4. See error...
validations:
required: false
- type: textarea
id: logs
attributes:
label: Relevant log output
description: |
If applicable, log output to help explain your problem.
render: shell
validations:
required: false
- type: textarea
attributes:
label: Environment
description: |
examples:
- **OS**: Ubuntu 20.04
- **Python**: 3.7.2 (`python --version`)
- **dbt**: 0.21.0 (`dbt --version`)
value: |
- OS:
- Python:
- dbt:
render: markdown
validations:
required: false
- type: dropdown
id: database
attributes:
label: What database are you using dbt with?
multiple: true
options:
- postgres
- redshift
- snowflake
- bigquery
- other (mention it in "Additional Context")
validations:
required: false
- type: textarea
attributes:
label: Additional Context
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false

41
.github/ISSUE_TEMPLATE/bug_report.md vendored Normal file
View File

@@ -0,0 +1,41 @@
---
name: Bug report
about: Report a bug or an issue you've found with dbt
title: ''
labels: bug, triage
assignees: ''
---
### Describe the bug
A clear and concise description of what the bug is. What command did you run? What happened?
### Steps To Reproduce
In as much detail as possible, please provide steps to reproduce the issue. Sample data that triggers the issue, example model code, etc is all very helpful here.
### Expected behavior
A clear and concise description of what you expected to happen.
### Screenshots and log output
If applicable, add screenshots or log output to help explain your problem.
### System information
**Which database are you using dbt with?**
- [ ] postgres
- [ ] redshift
- [ ] bigquery
- [ ] snowflake
- [ ] other (specify: ____________)
**The output of `dbt --version`:**
```
<output goes here>
```
**The operating system you're using:**
**The output of `python --version`:**
### Additional context
Add any other context about the problem here.

View File

@@ -1,16 +0,0 @@
contact_links:
- name: Create an issue for dbt-redshift
url: https://github.com/dbt-labs/dbt-redshift/issues/new/choose
about: Report a bug or request a feature for dbt-redshift
- name: Create an issue for dbt-bigquery
url: https://github.com/dbt-labs/dbt-bigquery/issues/new/choose
about: Report a bug or request a feature for dbt-bigquery
- name: Create an issue for dbt-snowflake
url: https://github.com/dbt-labs/dbt-snowflake/issues/new/choose
about: Report a bug or request a feature for dbt-snowflake
- name: Ask a question or get support
url: https://docs.getdbt.com/docs/guides/getting-help
about: Ask a question or request support
- name: Questions on Stack Overflow
url: https://stackoverflow.com/questions/tagged/dbt
about: Look at questions/answers at Stack Overflow

View File

@@ -1,53 +0,0 @@
name: ✨ Feature
description: Suggest an idea for dbt
title: "[Feature] <title>"
labels: ["enhancement", "triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature request!
- type: checkboxes
attributes:
label: Is there an existing feature request for this?
description: Please search to see if an issue already exists for the feature you would like.
options:
- label: I have searched the existing issues
required: true
label: Is this your first time opening an issue?
options:
- label: I have read the [expectations for open source contributors](https://docs.getdbt.com/docs/contributing/oss-expectations)
required: true
- type: textarea
attributes:
label: Describe the Feature
description: A clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
attributes:
label: Describe alternatives you've considered
description: |
A clear and concise description of any alternative solutions or features you've considered.
validations:
required: false
- type: textarea
attributes:
label: Who will this benefit?
description: |
What kind of use case will this feature be useful for? Please be specific and provide examples, this will help us prioritize properly.
validations:
required: false
- type: input
attributes:
label: Are you interested in contributing this feature?
description: Let us know if you want to write some code, and how we can help.
validations:
required: false
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the feature you are suggesting!
validations:
required: false

View File

@@ -0,0 +1,23 @@
---
name: Feature request
about: Suggest an idea for dbt
title: ''
labels: enhancement, triage
assignees: ''
---
### Describe the feature
A clear and concise description of what you want to happen.
### Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.
### Additional context
Is this feature database-specific? Which database(s) is/are relevant? Please include any other relevant context here.
### Who will this benefit?
What kind of use case will this feature be useful for? Please be specific and provide examples, this will help us prioritize properly.
### Are you interested in contributing this feature?
Let us know if you want to write some code, and how we can help.

View File

@@ -0,0 +1,28 @@
---
name: Final minor version release
about: Creates a tracking checklist of items for a final minor version release
title: "[Tracking] v#.##.# final release "
labels: 'release'
assignees: ''
---
### Release Core
- [ ] [Engineering] Verify all necessary changes exist on the release branch
- [ ] [Engineering] Follow [dbt-release workflow](https://www.notion.so/dbtlabs/Releasing-b97c5ea9a02949e79e81db3566bbc8ef#03ff37da697d4d8ba63d24fae1bfa817)
- [ ] [Product] Merge `next` into `current` for docs.getdbt.com
### Release Cloud
- [ ] [Engineering] Create a platform issue to update dbt Cloud and verify it is completed. [Example issue](https://github.com/dbt-labs/dbt-cloud/issues/3481)
- [ ] [Engineering] Determine if schemas have changed. If so, generate new schemas and push to schemas.getdbt.com
### Announce
- [ ] [Product] Update discourse
- [ ] [Product] Announce in dbt Slack
### Post-release
- [ ] [Engineering] [Bump plugin versions](https://www.notion.so/dbtlabs/Releasing-b97c5ea9a02949e79e81db3566bbc8ef#f01854e8da3641179fbcbe505bdf515c) (dbt-spark + dbt-presto), add compatibility as needed
- [ ] [Spark](https://github.com/dbt-labs/dbt-spark)
- [ ] [Presto](https://github.com/dbt-labs/dbt-presto)
- [ ] [Engineering] Create a platform issue to update dbt-spark versions to dbt Cloud. [Example issue](https://github.com/dbt-labs/dbt-cloud/issues/3481)
- [ ] [Product] Release new version of dbt-utils with new dbt version compatibility. If there are breaking changes requiring a minor version, plan upgrades of other packages that depend on dbt-utils.

View File

@@ -0,0 +1,29 @@
---
name: RC minor version release
about: Creates a tracking checklist of items for a RC minor version release
title: "[Tracking] v#.##.#RC# release "
labels: 'release'
assignees: ''
---
### Release Core
- [ ] [Engineering] Verify all necessary changes exist on the release branch
- [ ] [Engineering] Follow [dbt-release workflow](https://www.notion.so/dbtlabs/Releasing-b97c5ea9a02949e79e81db3566bbc8ef#03ff37da697d4d8ba63d24fae1bfa817)
- [ ] [Product] Update migration guide (next.docs.getdbt.com)
### Release Cloud
- [ ] [Engineering] Create a platform issue to update dbt Cloud and verify it is completed. [Example issue](https://github.com/dbt-labs/dbt-cloud/issues/3481)
- [ ] [Engineering] Determine if schemas have changed. If so, generate new schemas and push to schemas.getdbt.com
### Announce
- [ ] [Product] Publish discourse
- [ ] [Product] Announce in dbt Slack
### Post-release
- [ ] [Engineering] [Bump plugin versions](https://www.notion.so/dbtlabs/Releasing-b97c5ea9a02949e79e81db3566bbc8ef#f01854e8da3641179fbcbe505bdf515c) (dbt-spark + dbt-presto), add compatibility as needed
- [ ] [Spark](https://github.com/dbt-labs/dbt-spark)
- [ ] [Presto](https://github.com/dbt-labs/dbt-presto)
- [ ] [Engineering] Create a platform issue to update dbt-spark versions to dbt Cloud. [Example issue](https://github.com/dbt-labs/dbt-cloud/issues/3481)
- [ ] [Product] Release new version of dbt-utils with new dbt version compatibility. If there are breaking changes requiring a minor version, plan upgrades of other packages that depend on dbt-utils.
- [ ] [Engineering] Create an epic for the final release

View File

@@ -1,14 +0,0 @@
FROM python:3-slim AS builder
ADD . /app
WORKDIR /app
# We are installing a dependency here directly into our app source dir
RUN pip install --target=/app requests packaging
# A distroless container image with Python and some basics like SSL certificates
# https://github.com/GoogleContainerTools/distroless
FROM gcr.io/distroless/python3-debian10
COPY --from=builder /app /app
WORKDIR /app
ENV PYTHONPATH /app
CMD ["/app/main.py"]

View File

@@ -1,50 +0,0 @@
# Github package 'latest' tag wrangler for containers
## Usage
Plug in the necessary inputs to determine if the container being built should be tagged 'latest; at the package level, for example `dbt-redshift:latest`.
## Inputs
| Input | Description |
| - | - |
| `package` | Name of the GH package to check against |
| `new_version` | Semver of new container |
| `gh_token` | GH token with package read scope|
| `halt_on_missing` | Return non-zero exit code if requested package does not exist. (defaults to false)|
## Outputs
| Output | Description |
| - | - |
| `latest` | Wether or not the new container should be tagged 'latest'|
| `minor_latest` | Wether or not the new container should be tagged major.minor.latest |
## Example workflow
```yaml
name: Ship it!
on:
workflow_dispatch:
inputs:
package:
description: The package to publish
required: true
version_number:
description: The version number
required: true
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: Wrangle latest tag
id: is_latest
uses: ./.github/actions/latest-wrangler
with:
package: ${{ github.event.inputs.package }}
new_version: ${{ github.event.inputs.new_version }}
gh_token: ${{ secrets.GITHUB_TOKEN }}
- name: Print the results
run: |
echo "Is it latest? Survey says: ${{ steps.is_latest.outputs.latest }} !"
echo "Is it minor.latest? Survey says: ${{ steps.is_latest.outputs.minor_latest }} !"
```

View File

@@ -1,20 +0,0 @@
name: "Github package 'latest' tag wrangler for containers"
description: "Determines wether or not a given dbt container should be given a bare 'latest' tag (I.E. dbt-core:latest)"
inputs:
package_name:
description: "Package to check (I.E. dbt-core, dbt-redshift, etc)"
required: true
new_version:
description: "Semver of the container being built (I.E. 1.0.4)"
required: true
gh_token:
description: "Auth token for github (must have view packages scope)"
required: true
outputs:
latest:
description: "Wether or not built container should be tagged latest (bool)"
minor_latest:
description: "Wether or not built container should be tagged minor.latest (bool)"
runs:
using: "docker"
image: "Dockerfile"

View File

@@ -1,26 +0,0 @@
name: Ship it!
on:
workflow_dispatch:
inputs:
package:
description: The package to publish
required: true
version_number:
description: The version number
required: true
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: Wrangle latest tag
id: is_latest
uses: ./.github/actions/latest-wrangler
with:
package: ${{ github.event.inputs.package }}
new_version: ${{ github.event.inputs.new_version }}
gh_token: ${{ secrets.GITHUB_TOKEN }}
- name: Print the results
run: |
echo "Is it latest? Survey says: ${{ steps.is_latest.outputs.latest }} !"

View File

@@ -1,6 +0,0 @@
{
"inputs": {
"version_number": "1.0.1",
"package": "dbt-redshift"
}
}

View File

@@ -1,95 +0,0 @@
import os
import sys
import requests
from distutils.util import strtobool
from typing import Union
from packaging.version import parse, Version
if __name__ == "__main__":
# get inputs
package = os.environ["INPUT_PACKAGE"]
new_version = parse(os.environ["INPUT_NEW_VERSION"])
gh_token = os.environ["INPUT_GH_TOKEN"]
halt_on_missing = strtobool(os.environ.get("INPUT_HALT_ON_MISSING", "False"))
# get package metadata from github
package_request = requests.get(
f"https://api.github.com/orgs/dbt-labs/packages/container/{package}/versions",
auth=("", gh_token),
)
package_meta = package_request.json()
# Log info if we don't get a 200
if package_request.status_code != 200:
print(f"Call to GH API failed: {package_request.status_code} {package_meta['message']}")
# Make an early exit if there is no matching package in github
if package_request.status_code == 404:
if halt_on_missing:
sys.exit(1)
else:
# everything is the latest if the package doesn't exist
print(f"::set-output name=latest::{True}")
print(f"::set-output name=minor_latest::{True}")
sys.exit(0)
# TODO: verify package meta is "correct"
# https://github.com/dbt-labs/dbt-core/issues/4640
# map versions and tags
version_tag_map = {
version["id"]: version["metadata"]["container"]["tags"] for version in package_meta
}
# is pre-release
pre_rel = True if any(x in str(new_version) for x in ["a", "b", "rc"]) else False
# semver of current latest
for version, tags in version_tag_map.items():
if "latest" in tags:
# N.B. This seems counterintuitive, but we expect any version tagged
# 'latest' to have exactly three associated tags:
# latest, major.minor.latest, and major.minor.patch.
# Subtracting everything that contains the string 'latest' gets us
# the major.minor.patch which is what's needed for comparison.
current_latest = parse([tag for tag in tags if "latest" not in tag][0])
else:
current_latest = False
# semver of current_minor_latest
for version, tags in version_tag_map.items():
if f"{new_version.major}.{new_version.minor}.latest" in tags:
# Similar to above, only now we expect exactly two tags:
# major.minor.patch and major.minor.latest
current_minor_latest = parse([tag for tag in tags if "latest" not in tag][0])
else:
current_minor_latest = False
def is_latest(
pre_rel: bool, new_version: Version, remote_latest: Union[bool, Version]
) -> bool:
"""Determine if a given contaier should be tagged 'latest' based on:
- it's pre-release status
- it's version
- the version of a previously identified container tagged 'latest'
:param pre_rel: Wether or not the version of the new container is a pre-release
:param new_version: The version of the new container
:param remote_latest: The version of the previously identified container that's
already tagged latest or False
"""
# is a pre-release = not latest
if pre_rel:
return False
# + no latest tag found = is latest
if not remote_latest:
return True
# + if remote version is lower than current = is latest, else not latest
return True if remote_latest <= new_version else False
latest = is_latest(pre_rel, new_version, current_latest)
minor_latest = is_latest(pre_rel, new_version, current_minor_latest)
print(f"::set-output name=latest::{latest}")
print(f"::set-output name=minor_latest::{minor_latest}")

View File

@@ -11,11 +11,26 @@ updates:
schedule: schedule:
interval: "daily" interval: "daily"
rebase-strategy: "disabled" rebase-strategy: "disabled"
- package-ecosystem: "pip"
directory: "/plugins/bigquery"
schedule:
interval: "daily"
rebase-strategy: "disabled"
- package-ecosystem: "pip" - package-ecosystem: "pip"
directory: "/plugins/postgres" directory: "/plugins/postgres"
schedule: schedule:
interval: "daily" interval: "daily"
rebase-strategy: "disabled" rebase-strategy: "disabled"
- package-ecosystem: "pip"
directory: "/plugins/redshift"
schedule:
interval: "daily"
rebase-strategy: "disabled"
- package-ecosystem: "pip"
directory: "/plugins/snowflake"
schedule:
interval: "daily"
rebase-strategy: "disabled"
# docker dependencies # docker dependencies
- package-ecosystem: "docker" - package-ecosystem: "docker"

View File

@@ -4,20 +4,18 @@ resolves #
Include the number of the issue addressed by this PR above if applicable. Include the number of the issue addressed by this PR above if applicable.
PRs for code changes without an associated issue *will not be merged*. PRs for code changes without an associated issue *will not be merged*.
See CONTRIBUTING.md for more information. See CONTRIBUTING.md for more information.
Example:
resolves #1234
--> -->
### Description ### Description
<!--- <!--- Describe the Pull Request here -->
Describe the Pull Request here. Add any references and info to help reviewers
understand your changes. Include any tradeoffs you considered.
-->
### Checklist ### Checklist
- [ ] I have read [the contributing guide](https://github.com/dbt-labs/dbt-core/blob/main/CONTRIBUTING.md) and understand what's expected of me
- [ ] I have signed the [CLA](https://docs.getdbt.com/docs/contributor-license-agreements) - [ ] 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 - [ ] 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 - [ ] This PR includes tests, or tests are not required/relevant for this PR
- [ ] I have [opened an issue to add/update docs](https://github.com/dbt-labs/docs.getdbt.com/issues/new/choose), or docs changes are not required/relevant for this PR - [ ] I have updated the `CHANGELOG.md` and added information about my change to the "dbt next" section.
- [ ] I have run `changie new` to [create a changelog entry](https://github.com/dbt-labs/dbt-core/blob/main/CONTRIBUTING.md#Adding-CHANGELOG-Entry)

View File

@@ -0,0 +1,95 @@
module.exports = ({ context }) => {
const defaultPythonVersion = "3.8";
const supportedPythonVersions = ["3.6", "3.7", "3.8", "3.9"];
const supportedAdapters = ["snowflake", "postgres", "bigquery", "redshift"];
// if PR, generate matrix based on files changed and PR labels
if (context.eventName.includes("pull_request")) {
// `changes` is a list of adapter names that have related
// file changes in the PR
// ex: ['postgres', 'snowflake']
const changes = JSON.parse(process.env.CHANGES);
const labels = context.payload.pull_request.labels.map(({ name }) => name);
console.log("labels", labels);
console.log("changes", changes);
const testAllLabel = labels.includes("test all");
const include = [];
for (const adapter of supportedAdapters) {
if (
changes.includes(adapter) ||
testAllLabel ||
labels.includes(`test ${adapter}`)
) {
for (const pythonVersion of supportedPythonVersions) {
if (
pythonVersion === defaultPythonVersion ||
labels.includes(`test python${pythonVersion}`) ||
testAllLabel
) {
// always run tests on ubuntu by default
include.push({
os: "ubuntu-latest",
adapter,
"python-version": pythonVersion,
});
if (labels.includes("test windows") || testAllLabel) {
include.push({
os: "windows-latest",
adapter,
"python-version": pythonVersion,
});
}
if (labels.includes("test macos") || testAllLabel) {
include.push({
os: "macos-latest",
adapter,
"python-version": pythonVersion,
});
}
}
}
}
}
console.log("matrix", { include });
return {
include,
};
}
// if not PR, generate matrix of python version, adapter, and operating
// system to run integration tests on
const include = [];
// run for all adapters and python versions on ubuntu
for (const adapter of supportedAdapters) {
for (const pythonVersion of supportedPythonVersions) {
include.push({
os: 'ubuntu-latest',
adapter: adapter,
"python-version": pythonVersion,
});
}
}
// additionally include runs for all adapters, on macos and windows,
// but only for the default python version
for (const adapter of supportedAdapters) {
for (const operatingSystem of ["windows-latest", "macos-latest"]) {
include.push({
os: operatingSystem,
adapter: adapter,
"python-version": defaultPythonVersion,
});
}
}
console.log("matrix", { include });
return {
include,
};
};

View File

@@ -1,40 +0,0 @@
# **what?**
# When a PR is merged, if it has the backport label, it will create
# a new PR to backport those changes to the given branch. If it can't
# cleanly do a backport, it will comment on the merged PR of the failure.
#
# Label naming convention: "backport <branch name to backport to>"
# Example: backport 1.0.latest
#
# You MUST "Squash and merge" the original PR or this won't work.
# **why?**
# Changes sometimes need to be backported to release branches.
# This automates the backporting process
# **when?**
# Once a PR is "Squash and merge"'d, by adding a backport label, this is triggered
name: Backport
on:
pull_request:
types:
- labeled
permissions:
contents: write
pull-requests: write
jobs:
backport:
name: Backport
runs-on: ubuntu-latest
# Only react to merged PRs for security reasons.
# See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target.
if: >
github.event.pull_request.merged
&& contains(github.event.label.name, 'backport')
steps:
- uses: tibdex/backport@v2.0.2
with:
github_token: ${{ secrets.GITHUB_TOKEN }}

View File

@@ -1,78 +0,0 @@
# **what?**
# Checks that a file has been committed under the /.changes directory
# as a new CHANGELOG entry. Cannot check for a specific filename as
# it is dynamically generated by change type and timestamp.
# This workflow should not require any secrets since it runs for PRs
# from forked repos.
# By default, secrets are not passed to workflows running from
# a forked repo.
# **why?**
# Ensure code change gets reflected in the CHANGELOG.
# **when?**
# This will run for all PRs going into main and *.latest. It will
# run when they are opened, reopened, when any label is added or removed
# and when new code is pushed to the branch. The action will then get
# skipped if the 'Skip Changelog' label is present is any of the labels.
name: Check Changelog Entry
on:
pull_request:
types: [opened, reopened, labeled, unlabeled, synchronize]
workflow_dispatch:
defaults:
run:
shell: bash
permissions:
contents: read
pull-requests: write
env:
changelog_comment: 'Thank you for your pull request! We could not find a changelog entry for this change. For details on how to document a change, see [the contributing guide](https://github.com/dbt-labs/dbt-core/blob/main/CONTRIBUTING.md#adding-changelog-entry).'
jobs:
changelog:
name: changelog
if: "!contains(github.event.pull_request.labels.*.name, 'Skip Changelog')"
runs-on: ubuntu-latest
steps:
- name: Check if changelog file was added
# https://github.com/marketplace/actions/paths-changes-filter
# For each filter, it sets output variable named by the filter to the text:
# 'true' - if any of changed files matches any of filter rules
# 'false' - if none of changed files matches any of filter rules
# also, returns:
# `changes` - JSON array with names of all filters matching any of the changed files
uses: dorny/paths-filter@v2
id: filter
with:
token: ${{ secrets.GITHUB_TOKEN }}
filters: |
changelog:
- added: '.changes/unreleased/**.yaml'
- name: Check if comment already exists
uses: peter-evans/find-comment@v1
id: changelog_comment
with:
issue-number: ${{ github.event.pull_request.number }}
comment-author: 'github-actions[bot]'
body-includes: ${{ env.changelog_comment }}
- name: Create PR comment if changelog entry is missing, required, and does not exist
if: |
steps.filter.outputs.changelog == 'false' &&
steps.changelog_comment.outputs.comment-body == ''
uses: peter-evans/create-or-update-comment@v1
with:
issue-number: ${{ github.event.pull_request.number }}
body: ${{ env.changelog_comment }}
- name: Fail job if changelog entry is missing and required
if: steps.filter.outputs.changelog == 'false'
uses: actions/github-script@v6
with:
script: core.setFailed('Changelog entry required to merge.')

View File

@@ -1,114 +0,0 @@
# **what?**
# When dependabot create a PR, it always adds the `dependencies` label. This
# action will add a corresponding changie yaml file to that PR when that label is added.
# The file is created off a template:
#
# kind: Dependencies
# body: <PR title>
# time: <current timestamp>
# custom:
# Author: dependabot
# Issue: 4904
# PR: <PR number>
#
# **why?**
# Automate changelog generation for more visability with automated dependency updates via dependabot.
# **when?**
# Once a PR is created and it has been correctly labeled with `dependencies`. The intended use
# is for the PRs created by dependabot. You can also manually trigger this by adding the
# `dependencies` label at any time.
name: Dependency Changelog
on:
pull_request:
# catch when the PR is opened with the label or when the label is added
types: [opened, labeled]
permissions:
contents: write
pull-requests: read
jobs:
dependency_changelog:
if: "contains(github.event.pull_request.labels.*.name, 'dependencies')"
runs-on: ubuntu-latest
steps:
# timestamp changes the order the changelog entries are listed in the final Changelog.md file. Precision is not
# important here.
# The timestamp on the filename and the timestamp in the contents of the file have different expected formats.
- name: Get File Name Timestamp
id: filename_time
uses: nanzm/get-time-action@v1.1
with:
format: 'YYYYMMDD-HHmmss'
- name: Get File Content Timestamp
id: file_content_time
uses: nanzm/get-time-action@v1.1
with:
format: 'YYYY-MM-DDTHH:mm:ss.000000-05:00'
# changie expects files to be named in a specific pattern.
- name: Generate Filepath
id: fp
run: |
FILEPATH=.changes/unreleased/Dependencies-${{ steps.filename_time.outputs.time }}.yaml
echo "::set-output name=FILEPATH::$FILEPATH"
- name: Check if changelog file exists already
# if there's already a changelog entry, don't add another one!
# https://github.com/marketplace/actions/paths-changes-filter
# For each filter, it sets output variable named by the filter to the text:
# 'true' - if any of changed files matches any of filter rules
# 'false' - if none of changed files matches any of filter rules
# also, returns:
# `changes` - JSON array with names of all filters matching any of the changed files
uses: dorny/paths-filter@v2
id: changelog_check
with:
token: ${{ secrets.GITHUB_TOKEN }}
filters: |
exists:
- added: '.changes/unreleased/**.yaml'
- name: Checkout Branch
if: steps.changelog_check.outputs.exists == 'false'
uses: actions/checkout@v2
with:
# specifying the ref avoids checking out the repository in a detached state
ref: ${{ github.event.pull_request.head.ref }}
# If this is not set to false, Git push is performed with github.token and not the token
# configured using the env: GITHUB_TOKEN in commit step
persist-credentials: false
- name: Create file from template
if: steps.changelog_check.outputs.exists == 'false'
run: |
echo kind: Dependencies > "${{ steps.fp.outputs.FILEPATH }}"
echo 'body: "${{ github.event.pull_request.title }}"' >> "${{ steps.fp.outputs.FILEPATH }}"
echo time: "${{ steps.file_content_time.outputs.time }}" >> "${{ steps.fp.outputs.FILEPATH }}"
echo custom: >> "${{ steps.fp.outputs.FILEPATH }}"
echo ' Author: ${{ github.event.pull_request.user.login }}' >> "${{ steps.fp.outputs.FILEPATH }}"
echo ' Issue: "4904"' >> "${{ steps.fp.outputs.FILEPATH }}" # github.event.pull_request.issue for auto id?
echo ' PR: "${{ github.event.pull_request.number }}"' >> "${{ steps.fp.outputs.FILEPATH }}"
- name: Commit Changelog File
if: steps.changelog_check.outputs.exists == 'false'
uses: gr2m/create-or-update-pull-request-action@v1
env:
# When using the GITHUB_TOKEN, the resulting commit will not trigger another GitHub Actions
# Workflow run. This is due to limitations set by GitHub.
# See: https://docs.github.com/en/actions/security-guides/automatic-token-authentication#using-the-github_token-in-a-workflow
# When you use the repository's GITHUB_TOKEN to perform tasks on behalf of the GitHub Actions
# app, events triggered by the GITHUB_TOKEN will not create a new workflow run. This prevents
# you from accidentally creating recursive workflow runs. To get around this, use a Personal
# Access Token to commit changes.
GITHUB_TOKEN: ${{ secrets.FISHTOWN_BOT_PAT }}
with:
branch: ${{ github.event.pull_request.head.ref }}
# author expected in the format "Lorem J. Ipsum <lorem@example.com>"
author: "Github Build Bot <buildbot@fishtownanalytics.com>"
commit-message: "Add automated changelog yaml from template"

266
.github/workflows/integration.yml vendored Normal file
View File

@@ -0,0 +1,266 @@
# **what?**
# This workflow runs all integration tests for supported OS
# and python versions and core adapters. If triggered by PR,
# the workflow will only run tests for adapters related
# to code changes. Use the `test all` and `test ${adapter}`
# label to run all or additional tests. Use `ok to test`
# label to mark PRs from forked repositories that are safe
# to run integration tests for. Requires secrets to run
# against different warehouses.
# **why?**
# This checks the functionality of dbt from a user's perspective
# and attempts to catch functional regressions.
# **when?**
# This workflow will run on every push to a protected branch
# and when manually triggered. It will also run for all PRs, including
# PRs from forks. The workflow will be skipped until there is a label
# to mark the PR as safe to run.
name: Adapter Integration Tests
on:
# pushes to release branches
push:
branches:
- "main"
- "develop"
- "*.latest"
- "releases/*"
# all PRs, important to note that `pull_request_target` workflows
# will run in the context of the target branch of a PR
pull_request_target:
# manual tigger
workflow_dispatch:
# explicitly turn off permissions for `GITHUB_TOKEN`
permissions: read-all
# will cancel previous workflows triggered by the same event and for the same ref for PRs or same SHA otherwise
concurrency:
group: ${{ github.workflow }}-${{ github.event_name }}-${{ contains(github.event_name, 'pull_request') && github.event.pull_request.head.ref || github.sha }}
cancel-in-progress: true
# sets default shell to bash, for all operating systems
defaults:
run:
shell: bash
jobs:
# generate test metadata about what files changed and the testing matrix to use
test-metadata:
# run if not a PR from a forked repository or has a label to mark as safe to test
if: >-
github.event_name != 'pull_request_target' ||
github.event.pull_request.head.repo.full_name == github.repository ||
contains(github.event.pull_request.labels.*.name, 'ok to test')
runs-on: ubuntu-latest
outputs:
matrix: ${{ steps.generate-matrix.outputs.result }}
steps:
- name: Check out the repository (non-PR)
if: github.event_name != 'pull_request_target'
uses: actions/checkout@v2
with:
persist-credentials: false
- name: Check out the repository (PR)
if: github.event_name == 'pull_request_target'
uses: actions/checkout@v2
with:
persist-credentials: false
ref: ${{ github.event.pull_request.head.sha }}
- name: Check if relevant files changed
# https://github.com/marketplace/actions/paths-changes-filter
# For each filter, it sets output variable named by the filter to the text:
# 'true' - if any of changed files matches any of filter rules
# 'false' - if none of changed files matches any of filter rules
# also, returns:
# `changes` - JSON array with names of all filters matching any of the changed files
uses: dorny/paths-filter@v2
id: get-changes
with:
token: ${{ secrets.GITHUB_TOKEN }}
filters: |
postgres:
- 'core/**'
- 'plugins/postgres/**'
- 'dev-requirements.txt'
snowflake:
- 'core/**'
- 'plugins/snowflake/**'
bigquery:
- 'core/**'
- 'plugins/bigquery/**'
redshift:
- 'core/**'
- 'plugins/redshift/**'
- 'plugins/postgres/**'
- name: Generate integration test matrix
id: generate-matrix
uses: actions/github-script@v4
env:
CHANGES: ${{ steps.get-changes.outputs.changes }}
with:
script: |
const script = require('./.github/scripts/integration-test-matrix.js')
const matrix = script({ context })
console.log(matrix)
return matrix
test:
name: ${{ matrix.adapter }} / python ${{ matrix.python-version }} / ${{ matrix.os }}
# run if not a PR from a forked repository or has a label to mark as safe to test
# also checks that the matrix generated is not empty
if: >-
needs.test-metadata.outputs.matrix &&
fromJSON( needs.test-metadata.outputs.matrix ).include[0] &&
(
github.event_name != 'pull_request_target' ||
github.event.pull_request.head.repo.full_name == github.repository ||
contains(github.event.pull_request.labels.*.name, 'ok to test')
)
runs-on: ${{ matrix.os }}
needs: test-metadata
strategy:
fail-fast: false
matrix: ${{ fromJSON(needs.test-metadata.outputs.matrix) }}
env:
TOXENV: integration-${{ matrix.adapter }}
PYTEST_ADDOPTS: "-v --color=yes -n4 --csv integration_results.csv"
DBT_INVOCATION_ENV: github-actions
steps:
- name: Check out the repository
if: github.event_name != 'pull_request_target'
uses: actions/checkout@v2
with:
persist-credentials: false
# explicity checkout the branch for the PR,
# this is necessary for the `pull_request_target` event
- name: Check out the repository (PR)
if: github.event_name == 'pull_request_target'
uses: actions/checkout@v2
with:
persist-credentials: false
ref: ${{ github.event.pull_request.head.sha }}
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}
- name: Set up postgres (linux)
if: |
matrix.adapter == 'postgres' &&
runner.os == 'Linux'
uses: ./.github/actions/setup-postgres-linux
- name: Set up postgres (macos)
if: |
matrix.adapter == 'postgres' &&
runner.os == 'macOS'
uses: ./.github/actions/setup-postgres-macos
- name: Set up postgres (windows)
if: |
matrix.adapter == 'postgres' &&
runner.os == 'Windows'
uses: ./.github/actions/setup-postgres-windows
- name: Install python dependencies
run: |
pip install --upgrade pip
pip install tox
pip --version
tox --version
- name: Run tox (postgres)
if: matrix.adapter == 'postgres'
run: tox
- name: Run tox (redshift)
if: matrix.adapter == 'redshift'
env:
REDSHIFT_TEST_DBNAME: ${{ secrets.REDSHIFT_TEST_DBNAME }}
REDSHIFT_TEST_PASS: ${{ secrets.REDSHIFT_TEST_PASS }}
REDSHIFT_TEST_USER: ${{ secrets.REDSHIFT_TEST_USER }}
REDSHIFT_TEST_PORT: ${{ secrets.REDSHIFT_TEST_PORT }}
REDSHIFT_TEST_HOST: ${{ secrets.REDSHIFT_TEST_HOST }}
run: tox
- name: Run tox (snowflake)
if: matrix.adapter == 'snowflake'
env:
SNOWFLAKE_TEST_ACCOUNT: ${{ secrets.SNOWFLAKE_TEST_ACCOUNT }}
SNOWFLAKE_TEST_PASSWORD: ${{ secrets.SNOWFLAKE_TEST_PASSWORD }}
SNOWFLAKE_TEST_USER: ${{ secrets.SNOWFLAKE_TEST_USER }}
SNOWFLAKE_TEST_WAREHOUSE: ${{ secrets.SNOWFLAKE_TEST_WAREHOUSE }}
SNOWFLAKE_TEST_OAUTH_REFRESH_TOKEN: ${{ secrets.SNOWFLAKE_TEST_OAUTH_REFRESH_TOKEN }}
SNOWFLAKE_TEST_OAUTH_CLIENT_ID: ${{ secrets.SNOWFLAKE_TEST_OAUTH_CLIENT_ID }}
SNOWFLAKE_TEST_OAUTH_CLIENT_SECRET: ${{ secrets.SNOWFLAKE_TEST_OAUTH_CLIENT_SECRET }}
SNOWFLAKE_TEST_ALT_DATABASE: ${{ secrets.SNOWFLAKE_TEST_ALT_DATABASE }}
SNOWFLAKE_TEST_ALT_WAREHOUSE: ${{ secrets.SNOWFLAKE_TEST_ALT_WAREHOUSE }}
SNOWFLAKE_TEST_DATABASE: ${{ secrets.SNOWFLAKE_TEST_DATABASE }}
SNOWFLAKE_TEST_QUOTED_DATABASE: ${{ secrets.SNOWFLAKE_TEST_QUOTED_DATABASE }}
SNOWFLAKE_TEST_ROLE: ${{ secrets.SNOWFLAKE_TEST_ROLE }}
run: tox
- name: Run tox (bigquery)
if: matrix.adapter == 'bigquery'
env:
BIGQUERY_TEST_SERVICE_ACCOUNT_JSON: ${{ secrets.BIGQUERY_TEST_SERVICE_ACCOUNT_JSON }}
BIGQUERY_TEST_ALT_DATABASE: ${{ secrets.BIGQUERY_TEST_ALT_DATABASE }}
run: tox
- uses: actions/upload-artifact@v2
if: always()
with:
name: logs
path: ./logs
- name: Get current date
if: always()
id: date
run: echo "::set-output name=date::$(date +'%Y-%m-%dT%H_%M_%S')" #no colons allowed for artifacts
- uses: actions/upload-artifact@v2
if: always()
with:
name: integration_results_${{ matrix.python-version }}_${{ matrix.os }}_${{ matrix.adapter }}-${{ steps.date.outputs.date }}.csv
path: integration_results.csv
require-label-comment:
runs-on: ubuntu-latest
needs: test
permissions:
pull-requests: write
steps:
- name: Needs permission PR comment
if: >-
needs.test.result == 'skipped' &&
github.event_name == 'pull_request_target' &&
github.event.pull_request.head.repo.full_name != github.repository
uses: unsplash/comment-on-pr@master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
msg: |
"You do not have permissions to run integration tests, @dbt-labs/core "\
"needs to label this PR with `ok to test` in order to run integration tests!"
check_for_duplicate_msg: true

View File

@@ -1,26 +0,0 @@
# **what?**
# Mirrors issues into Jira. Includes the information: title,
# GitHub Issue ID and URL
# **why?**
# Jira is our tool for tracking and we need to see these issues in there
# **when?**
# On issue creation or when an issue is labeled `Jira`
name: Jira Issue Creation
on:
issues:
types: [opened, labeled]
permissions:
issues: write
jobs:
call-label-action:
uses: dbt-labs/jira-actions/.github/workflows/jira-creation.yml@main
secrets:
JIRA_BASE_URL: ${{ secrets.JIRA_BASE_URL }}
JIRA_USER_EMAIL: ${{ secrets.JIRA_USER_EMAIL }}
JIRA_API_TOKEN: ${{ secrets.JIRA_API_TOKEN }}

View File

@@ -1,26 +0,0 @@
# **what?**
# Calls mirroring Jira label Action. Includes adding a new label
# to an existing issue or removing a label as well
# **why?**
# Jira is our tool for tracking and we need to see these labels in there
# **when?**
# On labels being added or removed from issues
name: Jira Label Mirroring
on:
issues:
types: [labeled, unlabeled]
permissions:
issues: read
jobs:
call-label-action:
uses: dbt-labs/jira-actions/.github/workflows/jira-label.yml@main
secrets:
JIRA_BASE_URL: ${{ secrets.JIRA_BASE_URL }}
JIRA_USER_EMAIL: ${{ secrets.JIRA_USER_EMAIL }}
JIRA_API_TOKEN: ${{ secrets.JIRA_API_TOKEN }}

View File

@@ -1,24 +0,0 @@
# **what?**
# Transition a Jira issue to a new state
# Only supports these GitHub Issue transitions:
# closed, deleted, reopened
# **why?**
# Jira needs to be kept up-to-date
# **when?**
# On issue closing, deletion, reopened
name: Jira Issue Transition
on:
issues:
types: [closed, deleted, reopened]
jobs:
call-label-action:
uses: dbt-labs/jira-actions/.github/workflows/jira-transition.yml@main
secrets:
JIRA_BASE_URL: ${{ secrets.JIRA_BASE_URL }}
JIRA_USER_EMAIL: ${{ secrets.JIRA_USER_EMAIL }}
JIRA_API_TOKEN: ${{ secrets.JIRA_API_TOKEN }}

View File

@@ -1,8 +1,9 @@
# **what?** # **what?**
# Runs code quality checks, unit tests, integration tests and # Runs code quality checks, unit tests, and verifies python build on
# verifies python build on all code commited to the repository. This workflow # all code commited to the repository. This workflow should not
# should not require any secrets since it runs for PRs from forked repos. By # require any secrets since it runs for PRs from forked repos.
# default, secrets are not passed to workflows running from a forked repos. # By default, secrets are not passed to workflows running from
# a forked repo.
# **why?** # **why?**
# Ensure code for dbt meets a certain quality standard. # Ensure code for dbt meets a certain quality standard.
@@ -17,6 +18,7 @@ on:
push: push:
branches: branches:
- "main" - "main"
- "develop"
- "*.latest" - "*.latest"
- "releases/*" - "releases/*"
pull_request: pull_request:
@@ -35,43 +37,47 @@ defaults:
jobs: jobs:
code-quality: code-quality:
name: code-quality name: ${{ matrix.toxenv }}
runs-on: ubuntu-latest runs-on: ubuntu-latest
timeout-minutes: 10
strategy:
fail-fast: false
matrix:
toxenv: [flake8, mypy]
env:
TOXENV: ${{ matrix.toxenv }}
PYTEST_ADDOPTS: "-v --color=yes"
steps: steps:
- name: Check out the repository - name: Check out the repository
uses: actions/checkout@v2 uses: actions/checkout@v2
with:
persist-credentials: false
- name: Set up Python - name: Set up Python
uses: actions/setup-python@v2 uses: actions/setup-python@v2
- name: Install python dependencies - name: Install python dependencies
run: | run: |
python -m pip install --user --upgrade pip pip install --upgrade pip
python -m pip --version pip install tox
python -m pip install pre-commit pip --version
pre-commit --version tox --version
python -m pip install mypy==0.942
mypy --version
python -m pip install -r requirements.txt
python -m pip install -r dev-requirements.txt
dbt --version
- name: Run pre-commit hooks - name: Run tox
run: pre-commit run --all-files --show-diff-on-failure run: tox
unit: unit:
name: unit test / python ${{ matrix.python-version }} name: unit test / python ${{ matrix.python-version }}
runs-on: ubuntu-latest runs-on: ubuntu-latest
timeout-minutes: 10
strategy: strategy:
fail-fast: false fail-fast: false
matrix: matrix:
python-version: ["3.7", "3.8", "3.9", "3.10"] python-version: [3.6, 3.7, 3.8] # TODO: support unit testing for python 3.9 (https://github.com/dbt-labs/dbt/issues/3689)
env: env:
TOXENV: "unit" TOXENV: "unit"
@@ -80,6 +86,8 @@ jobs:
steps: steps:
- name: Check out the repository - name: Check out the repository
uses: actions/checkout@v2 uses: actions/checkout@v2
with:
persist-credentials: false
- name: Set up Python ${{ matrix.python-version }} - name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2 uses: actions/setup-python@v2
@@ -88,9 +96,9 @@ jobs:
- name: Install python dependencies - name: Install python dependencies
run: | run: |
python -m pip install --user --upgrade pip pip install --upgrade pip
python -m pip --version pip install tox
python -m pip install tox pip --version
tox --version tox --version
- name: Run tox - name: Run tox
@@ -107,79 +115,6 @@ jobs:
name: unit_results_${{ matrix.python-version }}-${{ steps.date.outputs.date }}.csv name: unit_results_${{ matrix.python-version }}-${{ steps.date.outputs.date }}.csv
path: unit_results.csv path: unit_results.csv
integration:
name: integration test / python ${{ matrix.python-version }} / ${{ matrix.os }}
runs-on: ${{ matrix.os }}
timeout-minutes: 45
strategy:
fail-fast: false
matrix:
python-version: ["3.7", "3.8", "3.9", "3.10"]
os: [ubuntu-latest]
include:
- python-version: 3.8
os: windows-latest
- python-version: 3.8
os: macos-latest
env:
TOXENV: integration
PYTEST_ADDOPTS: "-v --color=yes -n4 --csv integration_results.csv"
DBT_INVOCATION_ENV: github-actions
DBT_TEST_USER_1: dbt_test_user_1
DBT_TEST_USER_2: dbt_test_user_2
DBT_TEST_USER_3: dbt_test_user_3
steps:
- name: Check out the repository
uses: actions/checkout@v2
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}
- name: Set up postgres (linux)
if: runner.os == 'Linux'
uses: ./.github/actions/setup-postgres-linux
- name: Set up postgres (macos)
if: runner.os == 'macOS'
uses: ./.github/actions/setup-postgres-macos
- name: Set up postgres (windows)
if: runner.os == 'Windows'
uses: ./.github/actions/setup-postgres-windows
- name: Install python tools
run: |
python -m pip install --user --upgrade pip
python -m pip --version
python -m pip install tox
tox --version
- name: Run tests
run: tox
- name: Get current date
if: always()
id: date
run: echo "::set-output name=date::$(date +'%Y_%m_%dT%H_%M_%S')" #no colons allowed for artifacts
- uses: actions/upload-artifact@v2
if: always()
with:
name: logs_${{ matrix.python-version }}_${{ matrix.os }}_${{ steps.date.outputs.date }}
path: ./logs
- uses: actions/upload-artifact@v2
if: always()
with:
name: integration_results_${{ matrix.python-version }}_${{ matrix.os }}_${{ steps.date.outputs.date }}.csv
path: integration_results.csv
build: build:
name: build packages name: build packages
@@ -188,6 +123,8 @@ jobs:
steps: steps:
- name: Check out the repository - name: Check out the repository
uses: actions/checkout@v2 uses: actions/checkout@v2
with:
persist-credentials: false
- name: Set up Python - name: Set up Python
uses: actions/setup-python@v2 uses: actions/setup-python@v2
@@ -196,9 +133,9 @@ jobs:
- name: Install python dependencies - name: Install python dependencies
run: | run: |
python -m pip install --user --upgrade pip pip install --upgrade pip
python -m pip install --upgrade setuptools wheel twine check-wheel-contents pip install --upgrade setuptools wheel twine check-wheel-contents
python -m pip --version pip --version
- name: Build distributions - name: Build distributions
run: ./scripts/build-dist.sh run: ./scripts/build-dist.sh
@@ -214,18 +151,55 @@ jobs:
run: | run: |
check-wheel-contents dist/*.whl --ignore W007,W008 check-wheel-contents dist/*.whl --ignore W007,W008
- uses: actions/upload-artifact@v2
with:
name: dist
path: dist/
test-build:
name: verify packages / python ${{ matrix.python-version }} / ${{ matrix.os }}
needs: build
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]
python-version: [3.6, 3.7, 3.8, 3.9]
steps:
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}
- name: Install python dependencies
run: |
pip install --upgrade pip
pip install --upgrade wheel
pip --version
- uses: actions/download-artifact@v2
with:
name: dist
path: dist/
- name: Show distributions
run: ls -lh dist/
- name: Install wheel distributions - name: Install wheel distributions
run: | run: |
find ./dist/*.whl -maxdepth 1 -type f | xargs python -m pip install --force-reinstall --find-links=dist/ find ./dist/*.whl -maxdepth 1 -type f | xargs pip install --force-reinstall --find-links=dist/
- name: Check wheel distributions - name: Check wheel distributions
run: | run: |
dbt --version dbt --version
- name: Install source distributions - name: Install source distributions
# ignore dbt-1.0.0, which intentionally raises an error when installed from source
run: | run: |
find ./dist/dbt-[a-z]*.gz -maxdepth 1 -type f | xargs python -m pip install --force-reinstall --find-links=dist/ find ./dist/*.gz -maxdepth 1 -type f | xargs pip install --force-reinstall --find-links=dist/
- name: Check source distributions - name: Check source distributions
run: | run: |

174
.github/workflows/performance.yml vendored Normal file
View File

@@ -0,0 +1,174 @@
name: Performance Regression Tests
# Schedule triggers
on:
# runs twice a day at 10:05am and 10:05pm
schedule:
- cron: "5 10,22 * * *"
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
jobs:
# checks fmt of runner code
# purposefully not a dependency of any other job
# will block merging, but not prevent developing
fmt:
name: Cargo fmt
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: stable
override: true
- run: rustup component add rustfmt
- uses: actions-rs/cargo@v1
with:
command: fmt
args: --manifest-path performance/runner/Cargo.toml --all -- --check
# runs any tests associated with the runner
# these tests make sure the runner logic is correct
test-runner:
name: Test Runner
runs-on: ubuntu-latest
env:
# turns errors into warnings
RUSTFLAGS: "-D warnings"
steps:
- uses: actions/checkout@v2
- uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: stable
override: true
- uses: actions-rs/cargo@v1
with:
command: test
args: --manifest-path performance/runner/Cargo.toml
# build an optimized binary to be used as the runner in later steps
build-runner:
needs: [test-runner]
name: Build Runner
runs-on: ubuntu-latest
env:
RUSTFLAGS: "-D warnings"
steps:
- uses: actions/checkout@v2
- uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: stable
override: true
- uses: actions-rs/cargo@v1
with:
command: build
args: --release --manifest-path performance/runner/Cargo.toml
- uses: actions/upload-artifact@v2
with:
name: runner
path: performance/runner/target/release/runner
# run the performance measurements on the current or default branch
measure-dev:
needs: [build-runner]
name: Measure Dev Branch
runs-on: ubuntu-latest
steps:
- name: checkout dev
uses: actions/checkout@v2
- name: Setup Python
uses: actions/setup-python@v2.2.2
with:
python-version: "3.8"
- name: install dbt
run: pip install -r dev-requirements.txt -r editable-requirements.txt
- name: install hyperfine
run: wget https://github.com/sharkdp/hyperfine/releases/download/v1.11.0/hyperfine_1.11.0_amd64.deb && sudo dpkg -i hyperfine_1.11.0_amd64.deb
- uses: actions/download-artifact@v2
with:
name: runner
- name: change permissions
run: chmod +x ./runner
- name: run
run: ./runner measure -b dev -p ${{ github.workspace }}/performance/projects/
- uses: actions/upload-artifact@v2
with:
name: dev-results
path: performance/results/
# run the performance measurements on the release branch which we use
# as a performance baseline. This part takes by far the longest, so
# we do everything we can first so the job fails fast.
# -----
# we need to checkout dbt twice in this job: once for the baseline dbt
# version, and once to get the latest regression testing projects,
# metrics, and runner code from the develop or current branch so that
# the calculations match for both versions of dbt we are comparing.
measure-baseline:
needs: [build-runner]
name: Measure Baseline Branch
runs-on: ubuntu-latest
steps:
- name: checkout latest
uses: actions/checkout@v2
with:
ref: "0.20.latest"
- name: Setup Python
uses: actions/setup-python@v2.2.2
with:
python-version: "3.8"
- name: move repo up a level
run: mkdir ${{ github.workspace }}/../baseline/ && cp -r ${{ github.workspace }} ${{ github.workspace }}/../baseline
- name: "[debug] ls new dbt location"
run: ls ${{ github.workspace }}/../baseline/dbt/
# installation creates egg-links so we have to preserve source
- name: install dbt from new location
run: cd ${{ github.workspace }}/../baseline/dbt/ && pip install -r dev-requirements.txt -r editable-requirements.txt
# checkout the current branch to get all the target projects
# this deletes the old checked out code which is why we had to copy before
- name: checkout dev
uses: actions/checkout@v2
- name: install hyperfine
run: wget https://github.com/sharkdp/hyperfine/releases/download/v1.11.0/hyperfine_1.11.0_amd64.deb && sudo dpkg -i hyperfine_1.11.0_amd64.deb
- uses: actions/download-artifact@v2
with:
name: runner
- name: change permissions
run: chmod +x ./runner
- name: run runner
run: ./runner measure -b baseline -p ${{ github.workspace }}/performance/projects/
- uses: actions/upload-artifact@v2
with:
name: baseline-results
path: performance/results/
# detect regressions on the output generated from measuring
# the two branches. Exits with non-zero code if a regression is detected.
calculate-regressions:
needs: [measure-dev, measure-baseline]
name: Compare Results
runs-on: ubuntu-latest
steps:
- uses: actions/download-artifact@v2
with:
name: dev-results
- uses: actions/download-artifact@v2
with:
name: baseline-results
- name: "[debug] ls result files"
run: ls
- uses: actions/download-artifact@v2
with:
name: runner
- name: change permissions
run: chmod +x ./runner
- name: run calculation
run: ./runner calculate -r ./
# always attempt to upload the results even if there were regressions found
- uses: actions/upload-artifact@v2
if: ${{ always() }}
with:
name: final-calculations
path: ./final_calculations.json

View File

@@ -1,62 +0,0 @@
# **what?**
# The purpose of this workflow is to trigger CI to run for each
# release branch and main branch on a regular cadence. If the CI workflow
# fails for a branch, it will post to dev-core-alerts to raise awareness.
# The 'aurelien-baudet/workflow-dispatch' Action triggers the existing
# CI worklow file on the given branch to run so that even if we change the
# CI workflow file in the future, the one that is tailored for the given
# release branch will be used.
# **why?**
# Ensures release branches and main are always shippable and not broken.
# Also, can catch any dependencies shifting beneath us that might
# introduce breaking changes (could also impact Cloud).
# **when?**
# Mainly on a schedule of 9:00, 13:00, 18:00 UTC everyday.
# Manual trigger can also test on demand
name: Release branch scheduled testing
on:
schedule:
- cron: '0 9,13,18 * * *' # 9:00, 13:00, 18:00 UTC
workflow_dispatch: # for manual triggering
# no special access is needed
permissions: read-all
jobs:
kick-off-ci:
name: Kick-off CI
runs-on: ubuntu-latest
strategy:
# must run CI 1 branch at a time b/c the workflow-dispatch Action polls for
# latest run for results and it gets confused when we kick off multiple runs
# at once. There is a race condition so we will just run in sequential order.
max-parallel: 1
fail-fast: false
matrix:
branch: [1.0.latest, 1.1.latest, main]
steps:
- name: Call CI workflow for ${{ matrix.branch }} branch
id: trigger-step
uses: aurelien-baudet/workflow-dispatch@v2.1.1
with:
workflow: main.yml
ref: ${{ matrix.branch }}
token: ${{ secrets.FISHTOWN_BOT_PAT }}
- name: Post failure to Slack
uses: ravsamhq/notify-slack-action@v1
if: ${{ always() && !contains(steps.trigger-step.outputs.workflow-conclusion,'success') }}
with:
status: ${{ job.status }}
notification_title: 'dbt-core scheduled run of "${{ matrix.branch }}" branch not successful'
message_format: ':x: CI on branch "${{ matrix.branch }}" ${{ steps.trigger-step.outputs.workflow-conclusion }}'
footer: 'Linked failed CI run ${{ steps.trigger-step.outputs.workflow-url }}'
env:
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_DEV_CORE_ALERTS }}

View File

@@ -1,116 +0,0 @@
# **what?**
# This workflow will generate a series of docker images for dbt and push them to the github container registry
# **why?**
# Docker images for dbt are used in a number of important places throughout the dbt ecosystem. This is how we keep those images up-to-date.
# **when?**
# This is triggered manually
# **next steps**
# - build this into the release workflow (or conversly, break out the different release methods into their own workflow files)
name: Docker release
permissions:
packages: write
on:
workflow_dispatch:
inputs:
package:
description: The package to release. _One_ of [dbt-core, dbt-redshift, dbt-bigquery, dbt-snowflake, dbt-spark, dbt-postgres]
required: true
version_number:
description: The release version number (i.e. 1.0.0b1). Do not include `latest` tags or a leading `v`!
required: true
jobs:
get_version_meta:
name: Get version meta
runs-on: ubuntu-latest
outputs:
major: ${{ steps.version.outputs.major }}
minor: ${{ steps.version.outputs.minor }}
patch: ${{ steps.version.outputs.patch }}
latest: ${{ steps.latest.outputs.latest }}
minor_latest: ${{ steps.latest.outputs.minor_latest }}
steps:
- uses: actions/checkout@v1
- name: Split version
id: version
run: |
IFS="." read -r MAJOR MINOR PATCH <<< ${{ github.event.inputs.version_number }}
echo "::set-output name=major::$MAJOR"
echo "::set-output name=minor::$MINOR"
echo "::set-output name=patch::$PATCH"
- name: Is pkg 'latest'
id: latest
uses: ./.github/actions/latest-wrangler
with:
package: ${{ github.event.inputs.package }}
new_version: ${{ github.event.inputs.version_number }}
gh_token: ${{ secrets.GITHUB_TOKEN }}
halt_on_missing: False
setup_image_builder:
name: Set up docker image builder
runs-on: ubuntu-latest
needs: [get_version_meta]
steps:
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v1
build_and_push:
name: Build images and push to GHCR
runs-on: ubuntu-latest
needs: [setup_image_builder, get_version_meta]
steps:
- name: Get docker build arg
id: build_arg
run: |
echo "::set-output name=build_arg_name::"$(echo ${{ github.event.inputs.package }} | sed 's/\-/_/g')
echo "::set-output name=build_arg_value::"$(echo ${{ github.event.inputs.package }} | sed 's/postgres/core/g')
- name: Log in to the GHCR
uses: docker/login-action@v1
with:
registry: ghcr.io
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Build and push MAJOR.MINOR.PATCH tag
uses: docker/build-push-action@v2
with:
file: docker/Dockerfile
push: True
target: ${{ github.event.inputs.package }}
build-args: |
${{ steps.build_arg.outputs.build_arg_name }}_ref=${{ steps.build_arg.outputs.build_arg_value }}@v${{ github.event.inputs.version_number }}
tags: |
ghcr.io/dbt-labs/${{ github.event.inputs.package }}:${{ github.event.inputs.version_number }}
- name: Build and push MINOR.latest tag
uses: docker/build-push-action@v2
if: ${{ needs.get_version_meta.outputs.minor_latest == 'True' }}
with:
file: docker/Dockerfile
push: True
target: ${{ github.event.inputs.package }}
build-args: |
${{ steps.build_arg.outputs.build_arg_name }}_ref=${{ steps.build_arg.outputs.build_arg_value }}@v${{ github.event.inputs.version_number }}
tags: |
ghcr.io/dbt-labs/${{ github.event.inputs.package }}:${{ needs.get_version_meta.outputs.major }}.${{ needs.get_version_meta.outputs.minor }}.latest
- name: Build and push latest tag
uses: docker/build-push-action@v2
if: ${{ needs.get_version_meta.outputs.latest == 'True' }}
with:
file: docker/Dockerfile
push: True
target: ${{ github.event.inputs.package }}
build-args: |
${{ steps.build_arg.outputs.build_arg_name }}_ref=${{ steps.build_arg.outputs.build_arg_value }}@v${{ github.event.inputs.version_number }}
tags: |
ghcr.io/dbt-labs/${{ github.event.inputs.package }}:latest

View File

@@ -1,199 +0,0 @@
# **what?**
# Take the given commit, run unit tests specifically on that sha, build and
# package it, and then release to GitHub and PyPi with that specific build
# **why?**
# Ensure an automated and tested release process
# **when?**
# This will only run manually with a given sha and version
name: Release to GitHub and PyPi
on:
workflow_dispatch:
inputs:
sha:
description: 'The last commit sha in the release'
required: true
version_number:
description: 'The release version number (i.e. 1.0.0b1)'
required: true
defaults:
run:
shell: bash
jobs:
unit:
name: Unit test
runs-on: ubuntu-latest
env:
TOXENV: "unit"
steps:
- name: Check out the repository
uses: actions/checkout@v2
with:
persist-credentials: false
ref: ${{ github.event.inputs.sha }}
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: 3.8
- name: Install python dependencies
run: |
pip install --user --upgrade pip
pip install tox
pip --version
tox --version
- name: Run tox
run: tox
build:
name: build packages
runs-on: ubuntu-latest
steps:
- name: Check out the repository
uses: actions/checkout@v2
with:
persist-credentials: false
ref: ${{ github.event.inputs.sha }}
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: 3.8
- name: Install python dependencies
run: |
pip install --user --upgrade pip
pip install --upgrade setuptools wheel twine check-wheel-contents
pip --version
- name: Build distributions
run: ./scripts/build-dist.sh
- name: Show distributions
run: ls -lh dist/
- name: Check distribution descriptions
run: |
twine check dist/*
- name: Check wheel contents
run: |
check-wheel-contents dist/*.whl --ignore W007,W008
- uses: actions/upload-artifact@v2
with:
name: dist
path: |
dist/
!dist/dbt-${{github.event.inputs.version_number}}.tar.gz
test-build:
name: verify packages
needs: [build, unit]
runs-on: ubuntu-latest
steps:
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: 3.8
- name: Install python dependencies
run: |
pip install --user --upgrade pip
pip install --upgrade wheel
pip --version
- uses: actions/download-artifact@v2
with:
name: dist
path: dist/
- name: Show distributions
run: ls -lh dist/
- name: Install wheel distributions
run: |
find ./dist/*.whl -maxdepth 1 -type f | xargs pip install --force-reinstall --find-links=dist/
- name: Check wheel distributions
run: |
dbt --version
- name: Install source distributions
run: |
find ./dist/*.gz -maxdepth 1 -type f | xargs pip install --force-reinstall --find-links=dist/
- name: Check source distributions
run: |
dbt --version
github-release:
name: GitHub Release
needs: test-build
runs-on: ubuntu-latest
steps:
- uses: actions/download-artifact@v2
with:
name: dist
path: '.'
# Need to set an output variable because env variables can't be taken as input
# This is needed for the next step with releasing to GitHub
- name: Find release type
id: release_type
env:
IS_PRERELEASE: ${{ contains(github.event.inputs.version_number, 'rc') || contains(github.event.inputs.version_number, 'b') }}
run: |
echo ::set-output name=isPrerelease::$IS_PRERELEASE
- name: Creating GitHub Release
uses: softprops/action-gh-release@v1
with:
name: dbt-core v${{github.event.inputs.version_number}}
tag_name: v${{github.event.inputs.version_number}}
prerelease: ${{ steps.release_type.outputs.isPrerelease }}
target_commitish: ${{github.event.inputs.sha}}
body: |
[Release notes](https://github.com/dbt-labs/dbt-core/blob/main/CHANGELOG.md)
files: |
dbt_postgres-${{github.event.inputs.version_number}}-py3-none-any.whl
dbt_core-${{github.event.inputs.version_number}}-py3-none-any.whl
dbt-postgres-${{github.event.inputs.version_number}}.tar.gz
dbt-core-${{github.event.inputs.version_number}}.tar.gz
pypi-release:
name: Pypi release
runs-on: ubuntu-latest
needs: github-release
environment: PypiProd
steps:
- uses: actions/download-artifact@v2
with:
name: dist
path: 'dist'
- name: Publish distribution to PyPI
uses: pypa/gh-action-pypi-publish@v1.4.2
with:
password: ${{ secrets.PYPI_API_TOKEN }}

View File

@@ -1,87 +0,0 @@
# **what?**
# Compares the schema of the dbt version of the given ref vs
# the latest official schema releases found in schemas.getdbt.com.
# If there are differences, the workflow will fail and upload the
# diff as an artifact. The metadata team should be alerted to the change.
#
# **why?**
# Reaction work may need to be done if artifact schema changes
# occur so we want to proactively alert to it.
#
# **when?**
# On pushes to `develop` and release branches. Manual runs are also enabled.
name: Artifact Schema Check
on:
workflow_dispatch:
pull_request: #TODO: remove before merging
push:
branches:
- "develop"
- "*.latest"
- "releases/*"
env:
LATEST_SCHEMA_PATH: ${{ github.workspace }}/new_schemas
SCHEMA_DIFF_ARTIFACT: ${{ github.workspace }}//schema_schanges.txt
DBT_REPO_DIRECTORY: ${{ github.workspace }}/dbt
SCHEMA_REPO_DIRECTORY: ${{ github.workspace }}/schemas.getdbt.com
jobs:
checking-schemas:
name: "Checking schemas"
runs-on: ubuntu-latest
steps:
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: 3.8
- name: Checkout dbt repo
uses: actions/checkout@v2.3.4
with:
path: ${{ env.DBT_REPO_DIRECTORY }}
- name: Checkout schemas.getdbt.com repo
uses: actions/checkout@v2.3.4
with:
repository: dbt-labs/schemas.getdbt.com
ref: 'main'
ssh-key: ${{ secrets.SCHEMA_SSH_PRIVATE_KEY }}
path: ${{ env.SCHEMA_REPO_DIRECTORY }}
- name: Generate current schema
run: |
cd ${{ env.DBT_REPO_DIRECTORY }}
python3 -m venv env
source env/bin/activate
pip install --upgrade pip
pip install -r dev-requirements.txt -r editable-requirements.txt
python scripts/collect-artifact-schema.py --path ${{ env.LATEST_SCHEMA_PATH }}
# Copy generated schema files into the schemas.getdbt.com repo
# Do a git diff to find any changes
# Ignore any date or version changes though
- name: Compare schemas
run: |
cp -r ${{ env.LATEST_SCHEMA_PATH }}/dbt ${{ env.SCHEMA_REPO_DIRECTORY }}
cd ${{ env.SCHEMA_REPO_DIRECTORY }}
diff_results=$(git diff -I='*[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T' \
-I='*[0-9]{1}.[0-9]{2}.[0-9]{1}(rc[0-9]|b[0-9]| )' --compact-summary)
if [[ $(echo diff_results) ]]; then
echo $diff_results
echo "Schema changes detected!"
git diff -I='*[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T' \
-I='*[0-9]{1}.[0-9]{2}.[0-9]{1}(rc[0-9]|b[0-9]| )' > ${{ env.SCHEMA_DIFF_ARTIFACT }}
exit 1
else
echo "No schema changes detected"
fi
- name: Upload schema diff
uses: actions/upload-artifact@v2.2.4
if: ${{ failure() }}
with:
name: 'schema_schanges.txt'
path: '${{ env.SCHEMA_DIFF_ARTIFACT }}'

View File

@@ -1,17 +0,0 @@
name: "Close stale issues and PRs"
on:
schedule:
- cron: "30 1 * * *"
jobs:
stale:
runs-on: ubuntu-latest
steps:
# pinned at v4 (https://github.com/actions/stale/releases/tag/v4.0.0)
- uses: actions/stale@cdf15f641adb27a71842045a94023bef6945e3aa
with:
stale-issue-message: "This issue has been marked as Stale because it has been open for 180 days with no activity. If you would like the issue to remain open, please remove the stale label or comment on the issue, or it will be closed in 7 days."
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."
close-issue-message: "Although we are closing this issue as stale, it's not gone forever. Issues can be reopened if there is renewed community interest; add a comment to notify the maintainers."
# mark issues/PRs stale when they haven't seen activity in 180 days
days-before-stale: 180

View File

@@ -1,78 +0,0 @@
# This Action checks makes a dbt run to sample json structured logs
# and checks that they conform to the currently documented schema.
#
# If this action fails it either means we have unintentionally deviated
# from our documented structured logging schema, or we need to bump the
# version of our structured logging and add new documentation to
# communicate these changes.
name: Structured Logging Schema Check
on:
push:
branches:
- "main"
- "*.latest"
- "releases/*"
pull_request:
workflow_dispatch:
permissions: read-all
jobs:
# run the performance measurements on the current or default branch
test-schema:
name: Test Log Schema
runs-on: ubuntu-latest
env:
# turns warnings into errors
RUSTFLAGS: "-D warnings"
# points tests to the log file
LOG_DIR: "/home/runner/work/dbt-core/dbt-core/logs"
# tells integration tests to output into json format
DBT_LOG_FORMAT: "json"
# Additional test users
DBT_TEST_USER_1: dbt_test_user_1
DBT_TEST_USER_2: dbt_test_user_2
DBT_TEST_USER_3: dbt_test_user_3
steps:
- name: checkout dev
uses: actions/checkout@v2
with:
persist-credentials: false
- name: Setup Python
uses: actions/setup-python@v2.2.2
with:
python-version: "3.8"
- uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: stable
override: true
- name: Install python dependencies
run: |
pip install --user --upgrade pip
pip --version
pip install tox
tox --version
- name: Set up postgres
uses: ./.github/actions/setup-postgres-linux
- name: ls
run: ls
# integration tests generate a ton of logs in different files. the next step will find them all.
# we actually care if these pass, because the normal test run doesn't usually include many json log outputs
- name: Run integration tests
run: tox -e integration -- -nauto
# apply our schema tests to every log event from the previous step
# skips any output that isn't valid json
- uses: actions-rs/cargo@v1
with:
command: run
args: --manifest-path test/interop/log_parsing/Cargo.toml

View File

@@ -1 +0,0 @@
-P ubuntu-latest=ghcr.io/catthehacker/ubuntu:act-latest

View File

@@ -1 +0,0 @@
.secrets

View File

@@ -1 +0,0 @@
GITHUB_TOKEN=GH_PERSONAL_ACCESS_TOKEN_GOES_HERE

View File

@@ -1,6 +0,0 @@
{
"inputs": {
"version_number": "1.0.1",
"package": "dbt-postgres"
}
}

View File

@@ -1,33 +0,0 @@
# **what?**
# When the core team triages, we sometimes need more information from the issue creator. In
# those cases we remove the `triage` label and add the `awaiting_response` label. Once we
# recieve a response in the form of a comment, we want the `awaiting_response` label removed
# in favor of the `triage` label so we are aware that the issue needs action.
# **why?**
# To help with out team triage issue tracking
# **when?**
# This will run when a comment is added to an issue and that issue has to `awaiting_response` label.
name: Update Triage Label
on: issue_comment
defaults:
run:
shell: bash
permissions:
issues: write
jobs:
triage_label:
if: contains(github.event.issue.labels.*.name, 'awaiting_response')
runs-on: ubuntu-latest
steps:
- name: initial labeling
uses: andymckay/labeler@master
with:
add-labels: "triage"
remove-labels: "awaiting_response"

View File

@@ -1,111 +0,0 @@
# **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
# 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
# the versions and Docker requirements in all places.
# **when?**
# This is triggered either manually OR
# from the repository_dispatch event "version-bump" which is sent from
# the dbt-release repo Action
name: Version Bump
on:
workflow_dispatch:
inputs:
version_number:
description: 'The version number to bump to'
required: true
is_dry_run:
description: 'Creates a draft PR to allow testing instead of committing to a branch'
required: true
default: 'true'
repository_dispatch:
types: [version-bump]
jobs:
bump:
runs-on: ubuntu-latest
steps:
- name: Check out the repository
uses: actions/checkout@v2
- name: Set version and dry run values
id: variables
env:
VERSION_NUMBER: "${{ github.event.client_payload.version_number == '' && github.event.inputs.version_number || github.event.client_payload.version_number }}"
IS_DRY_RUN: "${{ github.event.client_payload.is_dry_run == '' && github.event.inputs.is_dry_run || github.event.client_payload.is_dry_run }}"
run: |
echo Repository dispatch event version: ${{ github.event.client_payload.version_number }}
echo Repository dispatch event dry run: ${{ github.event.client_payload.is_dry_run }}
echo Workflow dispatch event version: ${{ github.event.inputs.version_number }}
echo Workflow dispatch event dry run: ${{ github.event.inputs.is_dry_run }}
echo ::set-output name=VERSION_NUMBER::$VERSION_NUMBER
echo ::set-output name=IS_DRY_RUN::$IS_DRY_RUN
- uses: actions/setup-python@v2
with:
python-version: "3.8"
- name: Install python dependencies
run: |
python3 -m venv env
source env/bin/activate
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: Generate Docker requirements
# run: |
# source env/bin/activate
# pip install -r requirements.txt
# pip freeze -l > docker/requirements/requirements.txt
# git status
- name: Bump version
run: |
source env/bin/activate
pip install -r dev-requirements.txt
env/bin/bumpversion --allow-dirty --new-version ${{steps.variables.outputs.VERSION_NUMBER}} major
git status
- name: Commit version bump directly
uses: EndBug/add-and-commit@v7
if: ${{ steps.variables.outputs.IS_DRY_RUN == 'false' }}
with:
author_name: 'Github Build Bot'
author_email: 'buildbot@fishtownanalytics.com'
message: 'Bumping version to ${{steps.variables.outputs.VERSION_NUMBER}}'
- name: Commit version bump to branch
uses: EndBug/add-and-commit@v7
if: ${{ steps.variables.outputs.IS_DRY_RUN == 'true' }}
with:
author_name: 'Github Build Bot'
author_email: 'buildbot@fishtownanalytics.com'
message: 'Bumping version to ${{steps.variables.outputs.VERSION_NUMBER}}'
branch: 'bumping-version/${{steps.variables.outputs.VERSION_NUMBER}}_${{GITHUB.RUN_ID}}'
push: 'origin origin/bumping-version/${{steps.variables.outputs.VERSION_NUMBER}}_${{GITHUB.RUN_ID}}'
- name: Create Pull Request
uses: peter-evans/create-pull-request@v3
if: ${{ steps.variables.outputs.IS_DRY_RUN == 'true' }}
with:
author: 'Github Build Bot <buildbot@fishtownanalytics.com>'
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}}'
labels: |
Skip Changelog

9
.gitignore vendored
View File

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

View File

@@ -1,68 +0,0 @@
# Configuration for pre-commit hooks (see https://pre-commit.com/).
# Eventually the hooks described here will be run as tests before merging each PR.
# TODO: remove global exclusion of tests when testing overhaul is complete
exclude: ^test/
# 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
exclude_types:
- "markdown"
- id: check-case-conflict
- repo: https://github.com/psf/black
rev: 22.3.0
hooks:
- id: black
args:
- "--line-length=99"
- "--target-version=py38"
- id: black
alias: black-check
stages: [manual]
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.942
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]
files: ^core/dbt/
language: system
- id: mypy
alias: mypy-check
stages: [manual]
args: [--show-error-codes, --pretty]
files: ^core/dbt/
language: system

View File

@@ -1,39 +1,34 @@
The core function of dbt is SQL compilation and execution. Users create projects of dbt resources (models, tests, seeds, snapshots, ...), defined in SQL and YAML files, and they invoke dbt to create, update, or query associated views and tables. Today, dbt makes heavy use of Jinja2 to enable the templating of SQL, and to construct a DAG (Directed Acyclic Graph) from all of the resources in a project. Users can also extend their projects by installing resources (including Jinja macros) from other projects, called "packages." The core function of dbt is SQL compilation and execution. Users create projects of dbt resources (models, tests, seeds, snapshots, ...), defined in SQL and YAML files, and they invoke dbt to create, update, or query associated views and tables. Today, dbt makes heavy use of Jinja2 to enable the templating of SQL, and to construct a DAG (Directed Acyclic Graph) from all of the resources in a project. Users can also extend their projects by installing resources (including Jinja macros) from other projects, called "packages."
## dbt-core ## dbt-core
Most of the python code in the repository is within the `core/dbt` directory. Most of the python code in the repository is within the `core/dbt` directory. Currently the main subdirectories are:
- [`single python files`](core/dbt/README.md): A number of individual files, such as 'compilation.py' and 'exceptions.py' - [`adapters`](core/dbt/adapters): Define base classes for behavior that is likely to differ across databases
- [`clients`](core/dbt/clients): Interface with dependencies (agate, jinja) or across operating systems
The main subdirectories of core/dbt: - [`config`](core/dbt/config): Reconcile user-supplied configuration from connection profiles, project files, and Jinja macros
- [`adapters`](core/dbt/adapters/README.md): Define base classes for behavior that is likely to differ across databases - [`context`](core/dbt/context): Build and expose dbt-specific Jinja functionality
- [`clients`](core/dbt/clients/README.md): Interface with dependencies (agate, jinja) or across operating systems - [`contracts`](core/dbt/contracts): Define Python objects (dataclasses) that dbt expects to create and validate
- [`config`](core/dbt/config/README.md): Reconcile user-supplied configuration from connection profiles, project files, and Jinja macros - [`deps`](core/dbt/deps): Package installation and dependency resolution
- [`context`](core/dbt/context/README.md): Build and expose dbt-specific Jinja functionality - [`graph`](core/dbt/graph): Produce a `networkx` DAG of project resources, and selecting those resources given user-supplied criteria
- [`contracts`](core/dbt/contracts/README.md): Define Python objects (dataclasses) that dbt expects to create and validate - [`include`](core/dbt/include): The dbt "global project," which defines default implementations of Jinja2 macros
- [`deps`](core/dbt/deps/README.md): Package installation and dependency resolution - [`parser`](core/dbt/parser): Read project files, validate, construct python objects
- [`events`](core/dbt/events/README.md): Logging events - [`rpc`](core/dbt/rpc): Provide remote procedure call server for invoking dbt, following JSON-RPC 2.0 spec
- [`graph`](core/dbt/graph/README.md): Produce a `networkx` DAG of project resources, and selecting those resources given user-supplied criteria - [`task`](core/dbt/task): Set forth the actions that dbt can perform when invoked
- [`include`](core/dbt/include/README.md): The dbt "global project," which defines default implementations of Jinja2 macros
- [`parser`](core/dbt/parser/README.md): Read project files, validate, construct python objects
- [`task`](core/dbt/task/README.md): Set forth the actions that dbt can perform when invoked
Legacy tests are found in the 'test' directory:
- [`unit tests`](core/dbt/test/unit/README.md): Unit tests
- [`integration tests`](core/dbt/test/integration/README.md): Integration tests
### Invoking dbt ### Invoking dbt
The "tasks" map to top-level dbt commands. So `dbt run` => task.run.RunTask, etc. Some are more like abstract base classes (GraphRunnableTask, for example) but all the concrete types outside of task should map to tasks. Currently one executes at a time. The tasks kick off their “Runners” and those do execute in parallel. The parallelism is managed via a thread pool, in GraphRunnableTask. There are two supported ways of invoking dbt: from the command line and using an RPC server.
The "tasks" map to top-level dbt commands. So `dbt run` => task.run.RunTask, etc. Some are more like abstract base classes (GraphRunnableTask, for example) but all the concrete types outside of task/rpc should map to tasks. Currently one executes at a time. The tasks kick off their “Runners” and those do execute in parallel. The parallelism is managed via a thread pool, in GraphRunnableTask.
core/dbt/include/index.html core/dbt/include/index.html
This is the docs website code. It comes from the dbt-docs repository, and is generated when a release is packaged. This is the docs website code. It comes from the dbt-docs repository, and is generated when a release is packaged.
## Adapters ## Adapters
dbt uses an adapter-plugin pattern to extend support to different databases, warehouses, query engines, etc. For testing and development purposes, the dbt-postgres plugin lives alongside the dbt-core codebase, in the [`plugins`](plugins) subdirectory. Like other adapter plugins, it is a self-contained codebase and package that builds on top of dbt-core. dbt uses an adapter-plugin pattern to extend support to different databases, warehouses, query engines, etc. The four core adapters that are in the main repository, contained within the [`plugins`](plugins) subdirectory, are: Postgres Redshift, Snowflake and BigQuery. Other warehouses use adapter plugins defined in separate repositories (e.g. [dbt-spark](https://github.com/dbt-labs/dbt-spark), [dbt-presto](https://github.com/dbt-labs/dbt-presto)).
Each adapter is a mix of python, Jinja2, and SQL. The adapter code also makes heavy use of Jinja2 to wrap modular chunks of SQL functionality, define default implementations, and allow plugins to override it. Each adapter is a mix of python, Jinja2, and SQL. The adapter code also makes heavy use of Jinja2 to wrap modular chunks of SQL functionality, define default implementations, and allow plugins to override it.
Each adapter plugin is a standalone python package that includes: Each adapter plugin is a standalone python package that includes:
@@ -51,4 +46,4 @@ The [`test/`](test/) subdirectory includes unit and integration tests that run a
- [docker](docker/): All dbt versions are published as Docker images on DockerHub. This subfolder contains the `Dockerfile` (constant) and `requirements.txt` (one for each version). - [docker](docker/): All dbt versions are published as Docker images on DockerHub. This subfolder contains the `Dockerfile` (constant) and `requirements.txt` (one for each version).
- [etc](etc/): Images for README - [etc](etc/): Images for README
- [scripts](scripts/): Helper scripts for testing, releasing, and producing JSON schemas. These are not included in distributions of dbt, nor are they rigorously tested—they're just handy tools for the dbt maintainers :) - [scripts](scripts/): Helper scripts for testing, releasing, and producing JSON schemas. These are not included in distributions of dbt, not are they rigorously tested—they're just handy tools for the dbt maintainers :)

3232
CHANGELOG.md Executable file → Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -1,72 +1,116 @@
# Contributing to `dbt-core` # Contributing to `dbt`
`dbt-core` is open source software. It is what it is today because community members have opened issues, provided feedback, and [contributed to the knowledge loop](https://www.getdbt.com/dbt-labs/values/). Whether you are a seasoned open source contributor or a first-time committer, we welcome and encourage you to contribute code, documentation, ideas, or problem statements to this project.
1. [About this document](#about-this-document) 1. [About this document](#about-this-document)
2. [Getting the code](#getting-the-code) 2. [Proposing a change](#proposing-a-change)
3. [Setting up an environment](#setting-up-an-environment) 3. [Getting the code](#getting-the-code)
4. [Running `dbt` in development](#running-dbt-core-in-development) 4. [Setting up an environment](#setting-up-an-environment)
5. [Testing dbt-core](#testing) 5. [Running `dbt` in development](#running-dbt-in-development)
6. [Submitting a Pull Request](#submitting-a-pull-request) 6. [Testing](#testing)
7. [Submitting a Pull Request](#submitting-a-pull-request)
## About this document ## About this document
There are many ways to contribute to the ongoing development of `dbt-core`, such as by participating in discussions and issues. We encourage you to first read our higher-level document: ["Expectations for Open Source Contributors"](https://docs.getdbt.com/docs/contributing/oss-expectations). This document is a guide intended for folks interested in contributing to `dbt`. Below, we document the process by which members of the community should create issues and submit pull requests (PRs) in this repository. It is not intended as a guide for using `dbt`, and it assumes a certain level of familiarity with Python concepts such as virtualenvs, `pip`, python modules, filesystems, and so on. This guide assumes you are using macOS or Linux and are comfortable with the command line.
The rest of this document serves as a more granular guide for contributing code changes to `dbt-core` (this repository). It is not intended as a guide for using `dbt-core`, and some pieces assume a level of familiarity with Python development (virtualenvs, `pip`, etc). Specific code snippets in this guide assume you are using macOS or Linux and are comfortable with the command line. If you're new to python development or contributing to open-source software, we encourage you to read this document from start to finish. If you get stuck, drop us a line in the `#dbt-core-development` channel on [slack](https://community.getdbt.com).
If you get stuck, we're happy to help! Drop us a line in the `#dbt-core-development` channel in the [dbt Community Slack](https://community.getdbt.com). ### Signing the CLA
### Notes Please note that all contributors to `dbt` must sign the [Contributor License Agreement](https://docs.getdbt.com/docs/contributor-license-agreements) to have their Pull Request merged into the `dbt` codebase. If you are unable to sign the CLA, then the `dbt` maintainers will unfortunately be unable to merge your Pull Request. You are, however, welcome to open issues and comment on existing ones.
- **Adapters:** Is your issue or proposed code change related to a specific [database adapter](https://docs.getdbt.com/docs/available-adapters)? If so, please open issues, PRs, and discussions in that adapter's repository instead. The sole exception is Postgres; the `dbt-postgres` plugin lives in this repository (`dbt-core`). ## Proposing a change
- **CLA:** Please note that anyone contributing code to `dbt-core` must sign the [Contributor License Agreement](https://docs.getdbt.com/docs/contributor-license-agreements). If you are unable to sign the CLA, the `dbt-core` maintainers will unfortunately be unable to merge any of your Pull Requests. We welcome you to participate in discussions, open issues, and comment on existing ones.
- **Branches:** All pull requests from community contributors should target the `main` branch (default). If the change is needed as a patch for a minor version of dbt that has already been released (or is already a release candidate), a maintainer will backport the changes in your PR to the relevant "latest" release branch (`1.0.latest`, `1.1.latest`, ...) `dbt` is Apache 2.0-licensed open source software. `dbt` is what it is today because community members like you have opened issues, provided feedback, and contributed to the knowledge loop for the entire communtiy. Whether you are a seasoned open source contributor or a first-time committer, we welcome and encourage you to contribute code, documentation, ideas, or problem statements to this project.
### Defining the problem
If you have an idea for a new feature or if you've discovered a bug in `dbt`, the first step is to open an issue. Please check the list of [open issues](https://github.com/dbt-labs/dbt/issues) before creating a new one. If you find a relevant issue, please add a comment to the open issue instead of creating a new one. There are hundreds of open issues in this repository and it can be hard to know where to look for a relevant open issue. **The `dbt` maintainers are always happy to point contributors in the right direction**, so please err on the side of documenting your idea in a new issue if you are unsure where a problem statement belongs.
> **Note:** All community-contributed Pull Requests _must_ be associated with an open issue. If you submit a Pull Request that does not pertain to an open issue, you will be asked to create an issue describing the problem before the Pull Request can be reviewed.
### Discussing the idea
After you open an issue, a `dbt` maintainer will follow up by commenting on your issue (usually within 1-3 days) to explore your idea further and advise on how to implement the suggested changes. In many cases, community members will chime in with their own thoughts on the problem statement. If you as the issue creator are interested in submitting a Pull Request to address the issue, you should indicate this in the body of the issue. The `dbt` maintainers are _always_ happy to help contributors with the implementation of fixes and features, so please also indicate if there's anything you're unsure about or could use guidance around in the issue.
### Submitting a change
If an issue is appropriately well scoped and describes a beneficial change to the `dbt` codebase, then anyone may submit a Pull Request to implement the functionality described in the issue. See the sections below on how to do this.
The `dbt` maintainers will add a `good first issue` label if an issue is suitable for a first-time contributor. This label often means that the required code change is small, limited to one database adapter, or a net-new addition that does not impact existing functionality. You can see the list of currently open issues on the [Contribute](https://github.com/dbt-labs/dbt/contribute) page.
Here's a good workflow:
- Comment on the open issue, expressing your interest in contributing the required code change
- Outline your planned implementation. If you want help getting started, ask!
- Follow the steps outlined below to develop locally. Once you have opened a PR, one of the `dbt` maintainers will work with you to review your code.
- Add a test! Tests are crucial for both fixes and new features alike. We want to make sure that code works as intended, and that it avoids any bugs previously encountered. Currently, the best resource for understanding `dbt`'s [unit](test/unit) and [integration](test/integration) tests is the tests themselves. One of the maintainers can help by pointing out relevant examples.
In some cases, the right resolution to an open issue might be tangential to the `dbt` codebase. The right path forward might be a documentation update or a change that can be made in user-space. In other cases, the issue might describe functionality that the `dbt` maintainers are unwilling or unable to incorporate into the `dbt` codebase. When it is determined that an open issue describes functionality that will not translate to a code change in the `dbt` repository, the issue will be tagged with the `wontfix` label (see below) and closed.
### Using issue labels
The `dbt` maintainers use labels to categorize open issues. Some labels indicate the databases impacted by the issue, while others describe the domain in the `dbt` codebase germane to the discussion. While most of these labels are self-explanatory (eg. `snowflake` or `bigquery`), there are others that are worth describing.
| tag | description |
| --- | ----------- |
| [triage](https://github.com/dbt-labs/dbt/labels/triage) | This is a new issue which has not yet been reviewed by a `dbt` maintainer. This label is removed when a maintainer reviews and responds to the issue. |
| [bug](https://github.com/dbt-labs/dbt/labels/bug) | This issue represents a defect or regression in `dbt` |
| [enhancement](https://github.com/dbt-labs/dbt/labels/enhancement) | This issue represents net-new functionality in `dbt` |
| [good first issue](https://github.com/dbt-labs/dbt/labels/good%20first%20issue) | This issue does not require deep knowledge of the `dbt` codebase to implement. This issue is appropriate for a first-time contributor. |
| [help wanted](https://github.com/dbt-labs/dbt/labels/help%20wanted) / [discussion](https://github.com/dbt-labs/dbt/labels/discussion) | Conversation around this issue in ongoing, and there isn't yet a clear path forward. Input from community members is most welcome. |
| [duplicate](https://github.com/dbt-labs/dbt/issues/duplicate) | This issue is functionally identical to another open issue. The `dbt` maintainers will close this issue and encourage community members to focus conversation on the other one. |
| [snoozed](https://github.com/dbt-labs/dbt/labels/snoozed) | This issue describes a good idea, but one which will probably not be addressed in a six-month time horizon. The `dbt` maintainers will revist these issues periodically and re-prioritize them accordingly. |
| [stale](https://github.com/dbt-labs/dbt/labels/stale) | This is an old issue which has not recently been updated. Stale issues will periodically be closed by `dbt` maintainers, but they can be re-opened if the discussion is restarted. |
| [wontfix](https://github.com/dbt-labs/dbt/labels/wontfix) | This issue does not require a code change in the `dbt` repository, or the maintainers are unwilling/unable to merge a Pull Request which implements the behavior described in the issue. |
#### Branching Strategy
`dbt` has three types of branches:
- **Trunks** are where active development of the next release takes place. There is one trunk named `develop` at the time of writing this, and will be the default branch of the repository.
- **Release Branches** track a specific, not yet complete release of `dbt`. Each minor version release has a corresponding release branch. For example, the `0.11.x` series of releases has a branch called `0.11.latest`. This allows us to release new patch versions under `0.11` without necessarily needing to pull them into the latest version of `dbt`.
- **Feature Branches** track individual features and fixes. On completion they should be merged into the trunk brnach or a specific release branch.
## Getting the code ## Getting the code
### Installing git ### Installing git
You will need `git` in order to download and modify the `dbt-core` source code. On macOS, the best way to download git is to just install [Xcode](https://developer.apple.com/support/xcode/). You will need `git` in order to download and modify the `dbt` source code. On macOS, the best way to download git is to just install [Xcode](https://developer.apple.com/support/xcode/).
### External contributors ### External contributors
If you are not a member of the `dbt-labs` GitHub organization, you can contribute to `dbt-core` by forking the `dbt-core` repository. For a detailed overview on forking, check out the [GitHub docs on forking](https://help.github.com/en/articles/fork-a-repo). In short, you will need to: If you are not a member of the `dbt-labs` GitHub organization, you can contribute to `dbt` by forking the `dbt` repository. For a detailed overview on forking, check out the [GitHub docs on forking](https://help.github.com/en/articles/fork-a-repo). In short, you will need to:
1. Fork the `dbt-core` repository 1. fork the `dbt` repository
2. Clone your fork locally 2. clone your fork locally
3. Check out a new branch for your proposed changes 3. check out a new branch for your proposed changes
4. Push changes to your fork 4. push changes to your fork
5. Open a pull request against `dbt-labs/dbt-core` from your forked repository 5. open a pull request against `dbt-labs/dbt` from your forked repository
### dbt Labs contributors ### Core contributors
If you are a member of the `dbt-labs` GitHub organization, you will have push access to the `dbt-core` repo. Rather than forking `dbt-core` to make your changes, just clone the repository, check out a new branch, and push directly to that branch. If you are a member of the `dbt-labs` GitHub organization, you will have push access to the `dbt` repo. Rather than forking `dbt` to make your changes, just clone the repository, check out a new branch, and push directly to that branch.
## Setting up an environment ## Setting up an environment
There are some tools that will be helpful to you in developing locally. While this is the list relevant for `dbt-core` development, many of these tools are used commonly across open-source python projects. There are some tools that will be helpful to you in developing locally. While this is the list relevant for `dbt` development, many of these tools are used commonly across open-source python projects.
### Tools ### Tools
These are the tools used in `dbt-core` development and testing: A short list of tools used in `dbt` testing that will be helpful to your understanding:
- [`tox`](https://tox.readthedocs.io/en/latest/) to manage virtualenvs across python versions. We currently target the latest patch releases for Python 3.7, 3.8, 3.9, and 3.10 - [`tox`](https://tox.readthedocs.io/en/latest/) to manage virtualenvs across python versions. We currently target the latest patch releases for Python 3.6, Python 3.7, Python 3.8, and Python 3.9
- [`pytest`](https://docs.pytest.org/en/latest/) to define, discover, and run tests - [`pytest`](https://docs.pytest.org/en/latest/) to discover/run tests
- [`make`](https://users.cs.duke.edu/~ola/courses/programming/Makefiles/Makefiles.html) - but don't worry too much, nobody _really_ understands how make works and our Makefile is super simple
- [`flake8`](https://flake8.pycqa.org/en/latest/) for code linting - [`flake8`](https://flake8.pycqa.org/en/latest/) for code linting
- [`black`](https://github.com/psf/black) for code formatting
- [`mypy`](https://mypy.readthedocs.io/en/stable/) for static type checking - [`mypy`](https://mypy.readthedocs.io/en/stable/) for static type checking
- [`pre-commit`](https://pre-commit.com) to easily run those checks - [CircleCI](https://circleci.com/product/) and [Azure Pipelines](https://azure.microsoft.com/en-us/services/devops/pipelines/)
- [`changie`](https://changie.dev/) to create changelog entries, without merge conflicts
- [`make`](https://users.cs.duke.edu/~ola/courses/programming/Makefiles/Makefiles.html) to run multiple setup or test steps in combination. Don't worry too much, nobody _really_ understands how `make` works, and our Makefile aims to be super simple.
- [GitHub Actions](https://github.com/features/actions) for automating tests and checks, once a PR is pushed to the `dbt-core` repository
A deep understanding of these tools in not required to effectively contribute to `dbt-core`, but we recommend checking out the attached documentation if you're interested in learning more about each one. A deep understanding of these tools in not required to effectively contribute to `dbt`, but we recommend checking out the attached documentation if you're interested in learning more about them.
#### Virtual environments #### virtual environments
We strongly recommend using virtual environments when developing code in `dbt-core`. We recommend creating this virtualenv We strongly recommend using virtual environments when developing code in `dbt`. We recommend creating this virtualenv
in the root of the `dbt-core` repository. To create a new virtualenv, run: in the root of the `dbt` repository. To create a new virtualenv, run:
```sh ```sh
python3 -m venv env python3 -m venv env
source env/bin/activate source env/bin/activate
@@ -74,12 +118,12 @@ source env/bin/activate
This will create and activate a new Python virtual environment. This will create and activate a new Python virtual environment.
#### Docker and `docker-compose` #### docker and docker-compose
Docker and `docker-compose` are both used in testing. Specific instructions for you OS can be found [here](https://docs.docker.com/get-docker/). Docker and docker-compose are both used in testing. Specific instructions for you OS can be found [here](https://docs.docker.com/get-docker/).
#### Postgres (optional) #### postgres (optional)
For testing, and later in the examples in this document, you may want to have `psql` available so you can poke around in the database and see what happened. We recommend that you use [homebrew](https://brew.sh/) for that on macOS, and your package manager on Linux. You can install any version of the postgres client that you'd like. On macOS, with homebrew setup, you can run: For testing, and later in the examples in this document, you may want to have `psql` available so you can poke around in the database and see what happened. We recommend that you use [homebrew](https://brew.sh/) for that on macOS, and your package manager on Linux. You can install any version of the postgres client that you'd like. On macOS, with homebrew setup, you can run:
@@ -87,11 +131,11 @@ For testing, and later in the examples in this document, you may want to have `p
brew install postgresql brew install postgresql
``` ```
## Running `dbt-core` in development ## Running `dbt` in development
### Installation ### Installation
First make sure that you set up your `virtualenv` as described in [Setting up an environment](#setting-up-an-environment). Also ensure you have the latest version of pip installed with `pip install --upgrade pip`. Next, install `dbt-core` (and its dependencies) with: First make sure that you set up your `virtualenv` as described in [Setting up an environment](#setting-up-an-environment). Next, install `dbt` (and its dependencies) with:
```sh ```sh
make dev make dev
@@ -99,26 +143,23 @@ make dev
pip install -r dev-requirements.txt -r editable-requirements.txt pip install -r dev-requirements.txt -r editable-requirements.txt
``` ```
When installed in this way, any changes you make to your local copy of the source code will be reflected immediately in your next `dbt` run. When `dbt` is installed this way, any changes you make to the `dbt` source code will be reflected immediately in your next `dbt` run.
### Running `dbt-core` ### Running `dbt`
With your virtualenv activated, the `dbt` script should point back to the source code you've cloned on your machine. You can verify this by running `which dbt`. This command should show you a path to an executable in your virtualenv. With your virtualenv activated, the `dbt` script should point back to the source code you've cloned on your machine. You can verify this by running `which dbt`. This command should show you a path to an executable in your virtualenv.
Configure your [profile](https://docs.getdbt.com/docs/configure-your-profile) as necessary to connect to your target databases. It may be a good idea to add a new profile pointing to a local Postgres instance, or a specific test sandbox within your data warehouse if appropriate. Configure your [profile](https://docs.getdbt.com/docs/configure-your-profile) as necessary to connect to your target databases. It may be a good idea to add a new profile pointing to a local postgres instance, or a specific test sandbox within your data warehouse if appropriate.
## Testing ## Testing
Once you're able to manually test that your code change is working as expected, it's important to run existing automated tests, as well as adding some new ones. These tests will ensure that: Getting the `dbt` integration tests set up in your local environment will be very helpful as you start to make changes to your local version of `dbt`. The section that follows outlines some helpful tips for setting up the test environment.
- Your code changes do not unexpectedly break other established functionality
- Your code changes can handle all known edge cases
- The functionality you're adding will _keep_ working in the future
Although `dbt-core` works with a number of different databases, you won't need to supply credentials for every one of these databases in your test environment. Instead, you can test most `dbt-core` code changes with Python and Postgres. Since `dbt` works with a number of different databases, you will need to supply credentials for one or more of these databases in your test environment. Most organizations don't have access to each of a BigQuery, Redshift, Snowflake, and Postgres database, so it's likely that you will be unable to run every integration test locally. Fortunately, dbt Labs provides a CI environment with access to sandboxed Redshift, Snowflake, BigQuery, and Postgres databases. See the section on [_Submitting a Pull Request_](#submitting-a-pull-request) below for more information on this CI setup.
### Initial setup ### Initial setup
Postgres offers the easiest way to test most `dbt-core` functionality today. They are the fastest to run, and the easiest to set up. To run the Postgres integration tests, you'll have to do one extra step of setting up the test database: We recommend starting with `dbt`'s Postgres tests. These tests cover most of the functionality in `dbt`, are the fastest to run, and are the easiest to set up. To run the Postgres integration tests, you'll have to do one extra step of setting up the test database:
```sh ```sh
make setup-db make setup-db
@@ -129,6 +170,15 @@ docker-compose up -d database
PGHOST=localhost PGUSER=root PGPASSWORD=password PGDATABASE=postgres bash test/setup_db.sh PGHOST=localhost PGUSER=root PGPASSWORD=password PGDATABASE=postgres bash test/setup_db.sh
``` ```
`dbt` uses test credentials specified in a `test.env` file in the root of the repository for non-Postgres databases. This `test.env` file is git-ignored, but please be _extra_ careful to never check in credentials or other sensitive information when developing against `dbt`. To create your `test.env` file, copy the provided sample file, then supply your relevant credentials. This step is only required to use non-Postgres databases.
```
cp test.env.sample test.env
$EDITOR test.env
```
> In general, it's most important to have successful unit and Postgres tests. Once you open a PR, `dbt` will automatically run integration tests for the other three core database adapters. Of course, if you are a BigQuery user, contributing a BigQuery-only feature, it's important to run BigQuery tests as well.
### Test commands ### Test commands
There are a few methods for running tests locally. There are a few methods for running tests locally.
@@ -144,50 +194,38 @@ make test
# Runs postgres integration tests with py38 in "fail fast" mode. # Runs postgres integration tests with py38 in "fail fast" mode.
make integration make integration
``` ```
> These make targets assume you have a local installation of a recent version of [`tox`](https://tox.readthedocs.io/en/latest/) for unit/integration testing and pre-commit for code quality checks, > These make targets assume you have a recent version of [`tox`](https://tox.readthedocs.io/en/latest/) installed locally,
> unless you use choose a Docker container to run tests. Run `make help` for more info. > unless you use choose a Docker container to run tests. Run `make help` for more info.
Check out the other targets in the Makefile to see other commonly used test Check out the other targets in the Makefile to see other commonly used test
suites. suites.
#### `pre-commit`
[`pre-commit`](https://pre-commit.com) takes care of running all code-checks for formatting and linting. Run `make dev` to install `pre-commit` in your local environment. Once this is done you can use any of the linter-based make targets as well as a git pre-commit hook that will ensure proper formatting and linting.
#### `tox` #### `tox`
[`tox`](https://tox.readthedocs.io/en/latest/) takes care of managing virtualenvs and install dependencies in order to run tests. You can also run tests in parallel, for example, you can run unit tests for Python 3.7, Python 3.8, Python 3.9, and Python 3.10 checks in parallel with `tox -p`. Also, you can run unit tests for specific python versions with `tox -e py37`. The configuration for these tests in located in `tox.ini`. [`tox`](https://tox.readthedocs.io/en/latest/) takes care of managing virtualenvs and install dependencies in order to run
tests. You can also run tests in parallel, for example, you can run unit tests
for Python 3.6, Python 3.7, Python 3.8, `flake8` checks, and `mypy` checks in
parallel with `tox -p`. Also, you can run unit tests for specific python versions
with `tox -e py36`. The configuration for these tests in located in `tox.ini`.
#### `pytest` #### `pytest`
Finally, you can also run a specific test or group of tests using [`pytest`](https://docs.pytest.org/en/latest/) directly. With a virtualenv active and dev dependencies installed you can do things like: Finally, you can also run a specific test or group of tests using [`pytest`](https://docs.pytest.org/en/latest/) directly. With a virtualenv
active and dev dependencies installed you can do things like:
```sh ```sh
# run specific postgres integration tests
python -m pytest -m profile_postgres test/integration/001_simple_copy_test
# run all unit tests in a file # run all unit tests in a file
python3 -m pytest test/unit/test_graph.py python -m pytest test/unit/test_graph.py
# run a specific unit test # run a specific unit test
python3 -m pytest test/unit/test_graph.py::GraphTest::test__dependency_list python -m pytest test/unit/test_graph.py::GraphTest::test__dependency_list
# run specific Postgres integration tests (old way)
python3 -m pytest -m profile_postgres test/integration/074_postgres_unlogged_table_tests
# run specific Postgres integration tests (new way)
python3 -m pytest tests/functional/sources
``` ```
> [Here](https://docs.pytest.org/en/reorganize-docs/new-docs/user/commandlineuseful.html)
> See [pytest usage docs](https://docs.pytest.org/en/6.2.x/usage.html) for an overview of useful command-line options. > is a list of useful command-line options for `pytest` to use while developing.
## Adding CHANGELOG Entry
We use [changie](https://changie.dev) to generate `CHANGELOG` entries. **Note:** Do not edit the `CHANGELOG.md` directly. Your modifications will be lost.
Follow the steps to [install `changie`](https://changie.dev/guide/installation/) for your system.
Once changie is installed and your PR is created, simply run `changie new` and changie will walk you through the process of creating a changelog entry. Commit the file that's created and your changelog entry is complete!
You don't need to worry about which `dbt-core` version your change will go into. Just create the changelog entry with `changie`, and open your PR against the `main` branch. All merged changes will be included in the next minor version of `dbt-core`. The Core maintainers _may_ choose to "backport" specific changes in order to patch older minor versions. In that case, a maintainer will take care of that backport after merging your PR, before releasing the new version of `dbt-core`.
## Submitting a Pull Request ## Submitting a Pull Request
A `dbt-core` maintainer will review your PR. They may suggest code revision for style or clarity, or request that you add unit or integration test(s). These are good things! We believe that, with a little bit of help, anyone can contribute high-quality code. dbt Labs provides a sandboxed Redshift, Snowflake, and BigQuery database for use in a CI environment. When pull requests are submitted to the `dbt-labs/dbt` repo, GitHub will trigger automated tests in CircleCI and Azure Pipelines.
Automated tests run via GitHub Actions. If you're a first-time contributor, all tests (including code checks and unit tests) will require a maintainer to approve. Changes in the `dbt-core` repository trigger integration tests against Postgres. dbt Labs also provides CI environments in which to test changes to other adapters, triggered by PRs in those adapters' repositories, as well as periodic maintenance checks of each adapter in concert with the latest `dbt-core` code changes. A `dbt` maintainer will review your PR. They may suggest code revision for style or clarity, or request that you add unit or integration test(s). These are good things! We believe that, with a little bit of help, anyone can contribute high-quality code.
Once all tests are passing and your PR has been approved, a `dbt-core` maintainer will merge your changes into the active development branch. And that's it! Happy developing :tada: Once all tests are passing and your PR has been approved, a `dbt` maintainer will merge your changes into the active development branch. And that's it! Happy developing :tada:

View File

@@ -1,9 +1,4 @@
## FROM ubuntu:20.04
# This dockerfile is used for local development and adapter testing only.
# See `/docker` for a generic and production-ready docker file
##
FROM ubuntu:22.04
ENV DEBIAN_FRONTEND noninteractive ENV DEBIAN_FRONTEND noninteractive
@@ -32,7 +27,7 @@ RUN apt-get update \
&& apt-get install -y \ && apt-get install -y \
python \ python \
python-dev \ python-dev \
python3-pip \ python-pip \
python3.6 \ python3.6 \
python3.6-dev \ python3.6-dev \
python3-pip \ python3-pip \
@@ -46,9 +41,6 @@ RUN apt-get update \
python3.9 \ python3.9 \
python3.9-dev \ python3.9-dev \
python3.9-venv \ python3.9-venv \
python3.10 \
python3.10-dev \
python3.10-venv \
&& apt-get clean \ && apt-get clean \
&& rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*

110
Makefile
View File

@@ -8,57 +8,69 @@ endif
.PHONY: dev .PHONY: dev
dev: ## Installs dbt-* packages in develop mode along with development dependencies. dev: ## Installs dbt-* packages in develop mode along with development dependencies.
@\
pip install -r dev-requirements.txt -r editable-requirements.txt pip install -r dev-requirements.txt -r editable-requirements.txt
.PHONY: mypy .PHONY: mypy
mypy: .env ## Runs mypy against staged changes for static type checking. mypy: .env ## Runs mypy for static type checking.
@\ $(DOCKER_CMD) tox -e mypy
$(DOCKER_CMD) pre-commit run --hook-stage manual mypy-check | grep -v "INFO"
.PHONY: flake8 .PHONY: flake8
flake8: .env ## Runs flake8 against staged changes to enforce style guide. flake8: .env ## Runs flake8 to enforce style guide.
@\ $(DOCKER_CMD) tox -e flake8
$(DOCKER_CMD) pre-commit run --hook-stage manual flake8-check | grep -v "INFO"
.PHONY: black
black: .env ## Runs black against staged changes to enforce style guide.
@\
$(DOCKER_CMD) pre-commit run --hook-stage manual black-check -v | grep -v "INFO"
.PHONY: lint .PHONY: lint
lint: .env ## Runs flake8 and mypy code checks against staged changes. lint: .env ## Runs all code checks in parallel.
@\ $(DOCKER_CMD) tox -p -e flake8,mypy
$(DOCKER_CMD) pre-commit run flake8-check --hook-stage manual | grep -v "INFO"; \
$(DOCKER_CMD) pre-commit run mypy-check --hook-stage manual | grep -v "INFO"
.PHONY: unit .PHONY: unit
unit: .env ## Runs unit tests with py unit: .env ## Runs unit tests with py38.
@\ $(DOCKER_CMD) tox -e py38
$(DOCKER_CMD) tox -e py
.PHONY: test .PHONY: test
test: .env ## Runs unit tests with py and code checks against staged changes. test: .env ## Runs unit tests with py38 and code checks in parallel.
@\ $(DOCKER_CMD) tox -p -e py38,flake8,mypy
$(DOCKER_CMD) tox -e py; \
$(DOCKER_CMD) pre-commit run black-check --hook-stage manual | grep -v "INFO"; \
$(DOCKER_CMD) pre-commit run flake8-check --hook-stage manual | grep -v "INFO"; \
$(DOCKER_CMD) pre-commit run mypy-check --hook-stage manual | grep -v "INFO"
.PHONY: integration .PHONY: integration
integration: .env ## Runs postgres integration tests with py-integration integration: .env integration-postgres ## Alias for integration-postgres.
@\
$(DOCKER_CMD) tox -e py-integration -- -nauto
.PHONY: integration-fail-fast .PHONY: integration-fail-fast
integration-fail-fast: .env ## Runs postgres integration tests with py-integration in "fail fast" mode. integration-fail-fast: .env integration-postgres-fail-fast ## Alias for integration-postgres-fail-fast.
@\
$(DOCKER_CMD) tox -e py-integration -- -x -nauto .PHONY: integration-postgres
integration-postgres: .env ## Runs postgres integration tests with py38.
$(DOCKER_CMD) tox -e py38-postgres -- -nauto
.PHONY: integration-postgres-fail-fast
integration-postgres-fail-fast: .env ## Runs postgres integration tests with py38 in "fail fast" mode.
$(DOCKER_CMD) tox -e py38-postgres -- -x -nauto
.PHONY: integration-redshift
integration-redshift: .env ## Runs redshift integration tests with py38.
$(DOCKER_CMD) tox -e py38-redshift -- -nauto
.PHONY: integration-redshift-fail-fast
integration-redshift-fail-fast: .env ## Runs redshift integration tests with py38 in "fail fast" mode.
$(DOCKER_CMD) tox -e py38-redshift -- -x -nauto
.PHONY: integration-snowflake
integration-snowflake: .env ## Runs snowflake integration tests with py38.
$(DOCKER_CMD) tox -e py38-snowflake -- -nauto
.PHONY: integration-snowflake-fail-fast
integration-snowflake-fail-fast: .env ## Runs snowflake integration tests with py38 in "fail fast" mode.
$(DOCKER_CMD) tox -e py38-snowflake -- -x -nauto
.PHONY: integration-bigquery
integration-bigquery: .env ## Runs bigquery integration tests with py38.
$(DOCKER_CMD) tox -e py38-bigquery -- -nauto
.PHONY: integration-bigquery-fail-fast
integration-bigquery-fail-fast: .env ## Runs bigquery integration tests with py38 in "fail fast" mode.
$(DOCKER_CMD) tox -e py38-bigquery -- -x -nauto
.PHONY: setup-db .PHONY: setup-db
setup-db: ## Setup Postgres database with docker-compose for system testing. setup-db: ## Setup Postgres database with docker-compose for system testing.
@\ docker-compose up -d database
docker-compose up -d database && \
PGHOST=localhost PGUSER=root PGPASSWORD=password PGDATABASE=postgres bash test/setup_db.sh PGHOST=localhost PGUSER=root PGPASSWORD=password PGDATABASE=postgres bash test/setup_db.sh
# This rule creates a file named .env that is used by docker-compose for passing # This rule creates a file named .env that is used by docker-compose for passing
@@ -74,29 +86,27 @@ endif
.PHONY: clean .PHONY: clean
clean: ## Resets development environment. clean: ## Resets development environment.
@echo 'cleaning repo...' rm -f .coverage
@rm -f .coverage rm -rf .eggs/
@rm -rf .eggs/ rm -f .env
@rm -f .env rm -rf .tox/
@rm -rf .tox/ rm -rf build/
@rm -rf build/ rm -rf dbt.egg-info/
@rm -rf dbt.egg-info/ rm -f dbt_project.yml
@rm -f dbt_project.yml rm -rf dist/
@rm -rf dist/ rm -f htmlcov/*.{css,html,js,json,png}
@rm -f htmlcov/*.{css,html,js,json,png} rm -rf logs/
@rm -rf logs/ rm -rf target/
@rm -rf target/ find . -type f -name '*.pyc' -delete
@find . -type f -name '*.pyc' -delete find . -type d -name '__pycache__' -depth -delete
@find . -type d -name '__pycache__' -depth -delete
@echo 'done.'
.PHONY: help .PHONY: help
help: ## Show this help message. help: ## Show this help message.
@echo 'usage: make [target] [USE_DOCKER=true]' @echo 'usage: make [target] [USE_DOCKER=true]'
@echo @echo
@echo 'targets:' @echo 'targets:'
@grep -E '^[8+a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' @grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
@echo @echo
@echo 'options:' @echo 'options:'
@echo 'use USE_DOCKER=true to run target in a docker container' @echo 'use USE_DOCKER=true to run target in a docker container'

View File

@@ -1,15 +1,18 @@
<p align="center"> <p align="center">
<img src="https://raw.githubusercontent.com/dbt-labs/dbt-core/fa1ea14ddfb1d5ae319d5141844910dd53ab2834/etc/dbt-core.svg" alt="dbt logo" width="750"/> <img src="https://raw.githubusercontent.com/dbt-labs/dbt/ec7dee39f793aa4f7dd3dae37282cc87664813e4/etc/dbt-logo-full.svg" alt="dbt logo" width="500"/>
</p> </p>
<p align="center"> <p align="center">
<a href="https://github.com/dbt-labs/dbt-core/actions/workflows/main.yml"> <a href="https://github.com/dbt-labs/dbt/actions/workflows/main.yml">
<img src="https://github.com/dbt-labs/dbt-core/actions/workflows/main.yml/badge.svg?event=push" alt="CI Badge"/> <img src="https://github.com/dbt-labs/dbt/actions/workflows/main.yml/badge.svg?event=push" alt="Unit Tests Badge"/>
</a>
<a href="https://github.com/dbt-labs/dbt/actions/workflows/integration.yml">
<img src="https://github.com/dbt-labs/dbt/actions/workflows/integration.yml/badge.svg?event=push" alt="Integration Tests Badge"/>
</a> </a>
</p> </p>
**[dbt](https://www.getdbt.com/)** enables data analysts and engineers to transform their data using the same practices that software engineers use to build applications. **[dbt](https://www.getdbt.com/)** enables data analysts and engineers to transform their data using the same practices that software engineers use to build applications.
![architecture](https://github.com/dbt-labs/dbt-core/blob/202cb7e51e218c7b29eb3b11ad058bd56b7739de/etc/dbt-transform.png) ![architecture](https://raw.githubusercontent.com/dbt-labs/dbt/6c6649f9129d5d108aa3b0526f634cd8f3a9d1ed/etc/dbt-arch.png)
## Understanding dbt ## Understanding dbt
@@ -17,7 +20,7 @@ Analysts using dbt can transform their data by simply writing select statements,
These select statements, or "models", form a dbt project. Models frequently build on top of one another dbt makes it easy to [manage relationships](https://docs.getdbt.com/docs/ref) between models, and [visualize these relationships](https://docs.getdbt.com/docs/documentation), as well as assure the quality of your transformations through [testing](https://docs.getdbt.com/docs/testing). These select statements, or "models", form a dbt project. Models frequently build on top of one another dbt makes it easy to [manage relationships](https://docs.getdbt.com/docs/ref) between models, and [visualize these relationships](https://docs.getdbt.com/docs/documentation), as well as assure the quality of your transformations through [testing](https://docs.getdbt.com/docs/testing).
![dbt dag](https://raw.githubusercontent.com/dbt-labs/dbt-core/6c6649f9129d5d108aa3b0526f634cd8f3a9d1ed/etc/dbt-dag.png) ![dbt dag](https://raw.githubusercontent.com/dbt-labs/dbt/6c6649f9129d5d108aa3b0526f634cd8f3a9d1ed/etc/dbt-dag.png)
## Getting started ## Getting started
@@ -31,8 +34,8 @@ These select statements, or "models", form a dbt project. Models frequently buil
## Reporting bugs and contributing code ## Reporting bugs and contributing code
- Want to report a bug or request a feature? Let us know on [Slack](http://community.getdbt.com/), or open [an issue](https://github.com/dbt-labs/dbt-core/issues/new) - Want to report a bug or request a feature? Let us know on [Slack](http://community.getdbt.com/), or open [an issue](https://github.com/dbt-labs/dbt/issues/new)
- Want to help us build dbt? Check out the [Contributing Guide](https://github.com/dbt-labs/dbt-core/blob/HEAD/CONTRIBUTING.md) - Want to help us build dbt? Check out the [Contributing Guide](https://github.com/dbt-labs/dbt/blob/HEAD/CONTRIBUTING.md)
## Code of Conduct ## Code of Conduct

View File

@@ -1,39 +0,0 @@
<p align="center">
<img src="https://raw.githubusercontent.com/dbt-labs/dbt-core/fa1ea14ddfb1d5ae319d5141844910dd53ab2834/etc/dbt-core.svg" alt="dbt logo" width="750"/>
</p>
<p align="center">
<a href="https://github.com/dbt-labs/dbt-core/actions/workflows/main.yml">
<img src="https://github.com/dbt-labs/dbt-core/actions/workflows/main.yml/badge.svg?event=push" alt="CI Badge"/>
</a>
</p>
**[dbt](https://www.getdbt.com/)** enables data analysts and engineers to transform their data using the same practices that software engineers use to build applications.
![architecture](https://raw.githubusercontent.com/dbt-labs/dbt-core/6c6649f9129d5d108aa3b0526f634cd8f3a9d1ed/etc/dbt-arch.png)
## Understanding dbt
Analysts using dbt can transform their data by simply writing select statements, while dbt handles turning these statements into tables and views in a data warehouse.
These select statements, or "models", form a dbt project. Models frequently build on top of one another dbt makes it easy to [manage relationships](https://docs.getdbt.com/docs/ref) between models, and [visualize these relationships](https://docs.getdbt.com/docs/documentation), as well as assure the quality of your transformations through [testing](https://docs.getdbt.com/docs/testing).
![dbt dag](https://raw.githubusercontent.com/dbt-labs/dbt-core/6c6649f9129d5d108aa3b0526f634cd8f3a9d1ed/etc/dbt-dag.png)
## Getting started
- [Install dbt](https://docs.getdbt.com/docs/installation)
- Read the [introduction](https://docs.getdbt.com/docs/introduction/) and [viewpoint](https://docs.getdbt.com/docs/about/viewpoint/)
## Join the dbt Community
- Be part of the conversation in the [dbt Community Slack](http://community.getdbt.com/)
- Read more on the [dbt Community Discourse](https://discourse.getdbt.com)
## Reporting bugs and contributing code
- Want to report a bug or request a feature? Let us know on [Slack](http://community.getdbt.com/), or open [an issue](https://github.com/dbt-labs/dbt-core/issues/new)
- Want to help us build dbt? Check out the [Contributing Guide](https://github.com/dbt-labs/dbt-core/blob/HEAD/CONTRIBUTING.md)
## Code of Conduct
Everyone interacting in the dbt project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [dbt Code of Conduct](https://community.getdbt.com/code-of-conduct).

View File

@@ -1,51 +0,0 @@
# core/dbt directory README
## The following are individual files in this directory.
### deprecations.py
### flags.py
### main.py
### tracking.py
### version.py
### lib.py
### node_types.py
### helper_types.py
### links.py
### semver.py
### ui.py
### compilation.py
### dataclass_schema.py
### exceptions.py
### hooks.py
### logger.py
### profiler.py
### utils.py
## The subdirectories will be documented in a README in the subdirectory
* config
* include
* adapters
* context
* deps
* graph
* task
* clients
* events

View File

@@ -1,7 +0,0 @@
# N.B.
# This will add to the packages __path__ all subdirectories of directories on sys.path named after the package which effectively combines both modules into a single namespace (dbt.adapters)
# The matching statement is in plugins/postgres/dbt/__init__.py
from pkgutil import extend_path
__path__ = extend_path(__path__, __name__)

View File

@@ -1,30 +0,0 @@
# Adapters README
The Adapters module is responsible for defining database connection methods, caching information from databases, how relations are defined, and the two major connection types we have - base and sql.
# Directories
## `base`
Defines the base implementation Adapters can use to build out full functionality.
## `sql`
Defines a sql implementation for adapters that initially inherits the above base implementation and comes with some premade methods and macros that can be overwritten as needed per adapter. (most common type of adapter.)
# Files
## `cache.py`
Cached information from the database.
## `factory.py`
Defines how we generate adapter objects
## `protocol.py`
Defines various interfaces for various adapter objects. Helps mypy correctly resolve methods.
## `reference_keys.py`
Configures naming scheme for cache elements to be universal.

View File

@@ -1,7 +0,0 @@
# N.B.
# This will add to the packages __path__ all subdirectories of directories on sys.path named after the package which effectively combines both modules into a single namespace (dbt.adapters)
# The matching statement is in plugins/postgres/dbt/adapters/__init__.py
from pkgutil import extend_path
__path__ = extend_path(__path__, __name__)

View File

@@ -8,10 +8,10 @@ from dbt.exceptions import RuntimeException
@dataclass @dataclass
class Column: class Column:
TYPE_LABELS: ClassVar[Dict[str, str]] = { TYPE_LABELS: ClassVar[Dict[str, str]] = {
"STRING": "TEXT", 'STRING': 'TEXT',
"TIMESTAMP": "TIMESTAMP", 'TIMESTAMP': 'TIMESTAMP',
"FLOAT": "FLOAT", 'FLOAT': 'FLOAT',
"INTEGER": "INT", 'INTEGER': 'INT'
} }
column: str column: str
dtype: str dtype: str
@@ -24,7 +24,7 @@ class Column:
return cls.TYPE_LABELS.get(dtype.upper(), dtype) return cls.TYPE_LABELS.get(dtype.upper(), dtype)
@classmethod @classmethod
def create(cls, name, label_or_dtype: str) -> "Column": def create(cls, name, label_or_dtype: str) -> 'Column':
column_type = cls.translate_type(label_or_dtype) column_type = cls.translate_type(label_or_dtype)
return cls(name, column_type) return cls(name, column_type)
@@ -39,14 +39,16 @@ class Column:
@property @property
def data_type(self) -> str: def data_type(self) -> str:
if self.is_string(): if self.is_string():
return self.string_type(self.string_size()) return Column.string_type(self.string_size())
elif self.is_numeric(): elif self.is_numeric():
return self.numeric_type(self.dtype, self.numeric_precision, self.numeric_scale) return Column.numeric_type(self.dtype, self.numeric_precision,
self.numeric_scale)
else: else:
return self.dtype return self.dtype
def is_string(self) -> bool: def is_string(self) -> bool:
return self.dtype.lower() in ["text", "character varying", "character", "varchar"] return self.dtype.lower() in ['text', 'character varying', 'character',
'varchar']
def is_number(self): def is_number(self):
return any([self.is_integer(), self.is_numeric(), self.is_float()]) return any([self.is_integer(), self.is_numeric(), self.is_float()])
@@ -54,45 +56,33 @@ class Column:
def is_float(self): def is_float(self):
return self.dtype.lower() in [ return self.dtype.lower() in [
# floats # floats
"real", 'real', 'float4', 'float', 'double precision', 'float8'
"float4",
"float",
"double precision",
"float8",
] ]
def is_integer(self) -> bool: def is_integer(self) -> bool:
return self.dtype.lower() in [ return self.dtype.lower() in [
# real types # real types
"smallint", 'smallint', 'integer', 'bigint',
"integer", 'smallserial', 'serial', 'bigserial',
"bigint",
"smallserial",
"serial",
"bigserial",
# aliases # aliases
"int2", 'int2', 'int4', 'int8',
"int4", 'serial2', 'serial4', 'serial8',
"int8",
"serial2",
"serial4",
"serial8",
] ]
def is_numeric(self) -> bool: def is_numeric(self) -> bool:
return self.dtype.lower() in ["numeric", "decimal"] return self.dtype.lower() in ['numeric', 'decimal']
def string_size(self) -> int: def string_size(self) -> int:
if not self.is_string(): if not self.is_string():
raise RuntimeException("Called string_size() on non-string field!") raise RuntimeException("Called string_size() on non-string field!")
if self.dtype == "text" or self.char_size is None: if self.dtype == 'text' or self.char_size is None:
# char_size should never be None. Handle it reasonably just in case # char_size should never be None. Handle it reasonably just in case
return 256 return 256
else: else:
return int(self.char_size) return int(self.char_size)
def can_expand_to(self, other_column: "Column") -> bool: def can_expand_to(self, other_column: 'Column') -> bool:
"""returns True if this column can be expanded to the size of the """returns True if this column can be expanded to the size of the
other column""" other column"""
if not self.is_string() or not other_column.is_string(): if not self.is_string() or not other_column.is_string():
@@ -120,10 +110,12 @@ class Column:
return "<Column {} ({})>".format(self.name, self.data_type) return "<Column {} ({})>".format(self.name, self.data_type)
@classmethod @classmethod
def from_description(cls, name: str, raw_data_type: str) -> "Column": def from_description(cls, name: str, raw_data_type: str) -> 'Column':
match = re.match(r"([^(]+)(\([^)]+\))?", raw_data_type) match = re.match(r'([^(]+)(\([^)]+\))?', raw_data_type)
if match is None: if match is None:
raise RuntimeException(f'Could not interpret data type "{raw_data_type}"') raise RuntimeException(
f'Could not interpret data type "{raw_data_type}"'
)
data_type, size_info = match.groups() data_type, size_info = match.groups()
char_size = None char_size = None
numeric_precision = None numeric_precision = None
@@ -131,7 +123,7 @@ class Column:
if size_info is not None: if size_info is not None:
# strip out the parentheses # strip out the parentheses
size_info = size_info[1:-1] size_info = size_info[1:-1]
parts = size_info.split(",") parts = size_info.split(',')
if len(parts) == 1: if len(parts) == 1:
try: try:
char_size = int(parts[0]) char_size = int(parts[0])
@@ -156,4 +148,6 @@ class Column:
f'could not convert "{parts[1]}" to an integer' f'could not convert "{parts[1]}" to an integer'
) )
return cls(name, data_type, char_size, numeric_precision, numeric_scale) return cls(
name, data_type, char_size, numeric_precision, numeric_scale
)

View File

@@ -1,57 +1,26 @@
import abc import abc
import os import os
from time import sleep
import sys
# multiprocessing.RLock is a function returning this type # multiprocessing.RLock is a function returning this type
from multiprocessing.synchronize import RLock from multiprocessing.synchronize import RLock
from threading import get_ident from threading import get_ident
from typing import ( from typing import (
Any, Dict, Tuple, Hashable, Optional, ContextManager, List, Union
Dict,
Tuple,
Hashable,
Optional,
ContextManager,
List,
Type,
Union,
Iterable,
Callable,
) )
import agate import agate
import dbt.exceptions import dbt.exceptions
from dbt.contracts.connection import ( from dbt.contracts.connection import (
Connection, Connection, Identifier, ConnectionState,
Identifier, AdapterRequiredConfig, LazyHandle, AdapterResponse
ConnectionState,
AdapterRequiredConfig,
LazyHandle,
AdapterResponse,
) )
from dbt.contracts.graph.manifest import Manifest from dbt.contracts.graph.manifest import Manifest
from dbt.adapters.base.query_headers import ( from dbt.adapters.base.query_headers import (
MacroQueryStringSetter, MacroQueryStringSetter,
) )
from dbt.events import AdapterLogger from dbt.logger import GLOBAL_LOGGER as logger
from dbt.events.functions import fire_event
from dbt.events.types import (
NewConnection,
ConnectionReused,
ConnectionLeftOpen,
ConnectionLeftOpen2,
ConnectionClosed,
ConnectionClosed2,
Rollback,
RollbackFailed,
)
from dbt import flags from dbt import flags
SleepTime = Union[int, float] # As taken by time.sleep.
AdapterHandle = Any # Adapter connection handle objects can be any class.
class BaseConnectionManager(metaclass=abc.ABCMeta): class BaseConnectionManager(metaclass=abc.ABCMeta):
"""Methods to implement: """Methods to implement:
@@ -66,7 +35,6 @@ class BaseConnectionManager(metaclass=abc.ABCMeta):
You must also set the 'TYPE' class attribute with a class-unique constant You must also set the 'TYPE' class attribute with a class-unique constant
string. string.
""" """
TYPE: str = NotImplemented TYPE: str = NotImplemented
def __init__(self, profile: AdapterRequiredConfig): def __init__(self, profile: AdapterRequiredConfig):
@@ -88,14 +56,16 @@ class BaseConnectionManager(metaclass=abc.ABCMeta):
key = self.get_thread_identifier() key = self.get_thread_identifier()
with self.lock: with self.lock:
if key not in self.thread_connections: if key not in self.thread_connections:
raise dbt.exceptions.InvalidConnectionException(key, list(self.thread_connections)) raise dbt.exceptions.InvalidConnectionException(
key, list(self.thread_connections)
)
return self.thread_connections[key] return self.thread_connections[key]
def set_thread_connection(self, conn: Connection) -> None: def set_thread_connection(self, conn: Connection) -> None:
key = self.get_thread_identifier() key = self.get_thread_identifier()
if key in self.thread_connections: if key in self.thread_connections:
raise dbt.exceptions.InternalException( raise dbt.exceptions.InternalException(
"In set_thread_connection, existing connection exists for {}" 'In set_thread_connection, existing connection exists for {}'
) )
self.thread_connections[key] = conn self.thread_connections[key] = conn
@@ -135,19 +105,18 @@ class BaseConnectionManager(metaclass=abc.ABCMeta):
underlying database. underlying database.
""" """
raise dbt.exceptions.NotImplementedException( raise dbt.exceptions.NotImplementedException(
"`exception_handler` is not implemented for this adapter!" '`exception_handler` is not implemented for this adapter!')
)
def set_connection_name(self, name: Optional[str] = None) -> Connection: def set_connection_name(self, name: Optional[str] = None) -> Connection:
conn_name: str conn_name: str
if name is None: if name is None:
# if a name isn't specified, we'll re-use a single handle # if a name isn't specified, we'll re-use a single handle
# named 'master' # named 'master'
conn_name = "master" conn_name = 'master'
else: else:
if not isinstance(name, str): if not isinstance(name, str):
raise dbt.exceptions.CompilerException( raise dbt.exceptions.CompilerException(
f"For connection name, got {name} - not a string!" f'For connection name, got {name} - not a string!'
) )
assert isinstance(name, str) assert isinstance(name, str)
conn_name = name conn_name = name
@@ -160,120 +129,35 @@ class BaseConnectionManager(metaclass=abc.ABCMeta):
state=ConnectionState.INIT, state=ConnectionState.INIT,
transaction_open=False, transaction_open=False,
handle=None, handle=None,
credentials=self.profile.credentials, credentials=self.profile.credentials
) )
self.set_thread_connection(conn) self.set_thread_connection(conn)
if conn.name == conn_name and conn.state == "open": if conn.name == conn_name and conn.state == 'open':
return conn return conn
fire_event(NewConnection(conn_name=conn_name, conn_type=self.TYPE)) logger.debug(
'Acquiring new {} connection "{}".'.format(self.TYPE, conn_name))
if conn.state == "open": if conn.state == 'open':
fire_event(ConnectionReused(conn_name=conn_name)) logger.debug(
'Re-using an available connection from the pool (formerly {}).'
.format(conn.name)
)
else: else:
conn.handle = LazyHandle(self.open) conn.handle = LazyHandle(self.open)
conn.name = conn_name conn.name = conn_name
return conn return conn
@classmethod
def retry_connection(
cls,
connection: Connection,
connect: Callable[[], AdapterHandle],
logger: AdapterLogger,
retryable_exceptions: Iterable[Type[Exception]],
retry_limit: int = 1,
retry_timeout: Union[Callable[[int], SleepTime], SleepTime] = 1,
_attempts: int = 0,
) -> Connection:
"""Given a Connection, set its handle by calling connect.
The calls to connect will be retried up to retry_limit times to deal with transient
connection errors. By default, one retry will be attempted if retryable_exceptions is set.
:param Connection connection: An instance of a Connection that needs a handle to be set,
usually when attempting to open it.
:param connect: A callable that returns the appropiate connection handle for a
given adapter. This callable will be retried retry_limit times if a subclass of any
Exception in retryable_exceptions is raised by connect.
:type connect: Callable[[], AdapterHandle]
:param AdapterLogger logger: A logger to emit messages on retry attempts or errors. When
handling expected errors, we call debug, and call warning on unexpected errors or when
all retry attempts have been exhausted.
:param retryable_exceptions: An iterable of exception classes that if raised by
connect should trigger a retry.
:type retryable_exceptions: Iterable[Type[Exception]]
:param int retry_limit: How many times to retry the call to connect. If this limit
is exceeded before a successful call, a FailedToConnectException will be raised.
Must be non-negative.
:param retry_timeout: Time to wait between attempts to connect. Can also take a
Callable that takes the number of attempts so far, beginning at 0, and returns an int
or float to be passed to time.sleep.
:type retry_timeout: Union[Callable[[int], SleepTime], SleepTime] = 1
:param int _attempts: Parameter used to keep track of the number of attempts in calling the
connect function across recursive calls. Passed as an argument to retry_timeout if it
is a Callable. This parameter should not be set by the initial caller.
:raises dbt.exceptions.FailedToConnectException: Upon exhausting all retry attempts without
successfully acquiring a handle.
:return: The given connection with its appropriate state and handle attributes set
depending on whether we successfully acquired a handle or not.
"""
timeout = retry_timeout(_attempts) if callable(retry_timeout) else retry_timeout
if timeout < 0:
raise dbt.exceptions.FailedToConnectException(
"retry_timeout cannot be negative or return a negative time."
)
if retry_limit < 0 or retry_limit > sys.getrecursionlimit():
# This guard is not perfect others may add to the recursion limit (e.g. built-ins).
connection.handle = None
connection.state = ConnectionState.FAIL
raise dbt.exceptions.FailedToConnectException("retry_limit cannot be negative")
try:
connection.handle = connect()
connection.state = ConnectionState.OPEN
return connection
except tuple(retryable_exceptions) as e:
if retry_limit <= 0:
connection.handle = None
connection.state = ConnectionState.FAIL
raise dbt.exceptions.FailedToConnectException(str(e))
logger.debug(
f"Got a retryable error when attempting to open a {cls.TYPE} connection.\n"
f"{retry_limit} attempts remaining. Retrying in {timeout} seconds.\n"
f"Error:\n{e}"
)
sleep(timeout)
return cls.retry_connection(
connection=connection,
connect=connect,
logger=logger,
retry_limit=retry_limit - 1,
retry_timeout=retry_timeout,
retryable_exceptions=retryable_exceptions,
_attempts=_attempts + 1,
)
except Exception as e:
connection.handle = None
connection.state = ConnectionState.FAIL
raise dbt.exceptions.FailedToConnectException(str(e))
@abc.abstractmethod @abc.abstractmethod
def cancel_open(self) -> Optional[List[str]]: def cancel_open(self) -> Optional[List[str]]:
"""Cancel all open connections on the adapter. (passable)""" """Cancel all open connections on the adapter. (passable)"""
raise dbt.exceptions.NotImplementedException( raise dbt.exceptions.NotImplementedException(
"`cancel_open` is not implemented for this adapter!" '`cancel_open` is not implemented for this adapter!'
) )
@classmethod @abc.abstractclassmethod
@abc.abstractmethod
def open(cls, connection: Connection) -> Connection: def open(cls, connection: Connection) -> Connection:
"""Open the given connection on the adapter and return it. """Open the given connection on the adapter and return it.
@@ -283,7 +167,9 @@ class BaseConnectionManager(metaclass=abc.ABCMeta):
This should be thread-safe, or hold the lock if necessary. The given This should be thread-safe, or hold the lock if necessary. The given
connection should not be in either in_use or available. connection should not be in either in_use or available.
""" """
raise dbt.exceptions.NotImplementedException("`open` is not implemented for this adapter!") raise dbt.exceptions.NotImplementedException(
'`open` is not implemented for this adapter!'
)
def release(self) -> None: def release(self) -> None:
with self.lock: with self.lock:
@@ -303,10 +189,12 @@ class BaseConnectionManager(metaclass=abc.ABCMeta):
def cleanup_all(self) -> None: def cleanup_all(self) -> None:
with self.lock: with self.lock:
for connection in self.thread_connections.values(): for connection in self.thread_connections.values():
if connection.state not in {"closed", "init"}: if connection.state not in {'closed', 'init'}:
fire_event(ConnectionLeftOpen(conn_name=connection.name)) logger.debug("Connection '{}' was left open."
.format(connection.name))
else: else:
fire_event(ConnectionClosed(conn_name=connection.name)) logger.debug("Connection '{}' was properly closed."
.format(connection.name))
self.close(connection) self.close(connection)
# garbage collect these connections # garbage collect these connections
@@ -316,14 +204,14 @@ class BaseConnectionManager(metaclass=abc.ABCMeta):
def begin(self) -> None: def begin(self) -> None:
"""Begin a transaction. (passable)""" """Begin a transaction. (passable)"""
raise dbt.exceptions.NotImplementedException( raise dbt.exceptions.NotImplementedException(
"`begin` is not implemented for this adapter!" '`begin` is not implemented for this adapter!'
) )
@abc.abstractmethod @abc.abstractmethod
def commit(self) -> None: def commit(self) -> None:
"""Commit a transaction. (passable)""" """Commit a transaction. (passable)"""
raise dbt.exceptions.NotImplementedException( raise dbt.exceptions.NotImplementedException(
"`commit` is not implemented for this adapter!" '`commit` is not implemented for this adapter!'
) )
@classmethod @classmethod
@@ -332,40 +220,55 @@ class BaseConnectionManager(metaclass=abc.ABCMeta):
try: try:
connection.handle.rollback() connection.handle.rollback()
except Exception: except Exception:
fire_event(RollbackFailed(conn_name=connection.name)) logger.debug(
'Failed to rollback {}'.format(connection.name),
exc_info=True
)
@classmethod @classmethod
def _close_handle(cls, connection: Connection) -> None: def _close_handle(cls, connection: Connection) -> None:
"""Perform the actual close operation.""" """Perform the actual close operation."""
# On windows, sometimes connection handles don't have a close() attr. # On windows, sometimes connection handles don't have a close() attr.
if hasattr(connection.handle, "close"): if hasattr(connection.handle, 'close'):
fire_event(ConnectionClosed2(conn_name=connection.name)) logger.debug(f'On {connection.name}: Close')
connection.handle.close() connection.handle.close()
else: else:
fire_event(ConnectionLeftOpen2(conn_name=connection.name)) logger.debug(f'On {connection.name}: No close available on handle')
@classmethod @classmethod
def _rollback(cls, connection: Connection) -> None: def _rollback(cls, connection: Connection) -> None:
"""Roll back the given connection.""" """Roll back the given connection."""
if flags.STRICT_MODE:
if not isinstance(connection, Connection):
raise dbt.exceptions.CompilerException(
f'In _rollback, got {connection} - not a Connection!'
)
if connection.transaction_open is False: if connection.transaction_open is False:
raise dbt.exceptions.InternalException( raise dbt.exceptions.InternalException(
f"Tried to rollback transaction on connection " f'Tried to rollback transaction on connection '
f'"{connection.name}", but it does not have one open!' f'"{connection.name}", but it does not have one open!'
) )
fire_event(Rollback(conn_name=connection.name)) logger.debug(f'On {connection.name}: ROLLBACK')
cls._rollback_handle(connection) cls._rollback_handle(connection)
connection.transaction_open = False connection.transaction_open = False
@classmethod @classmethod
def close(cls, connection: Connection) -> Connection: def close(cls, connection: Connection) -> Connection:
if flags.STRICT_MODE:
if not isinstance(connection, Connection):
raise dbt.exceptions.CompilerException(
f'In close, got {connection} - not a Connection!'
)
# if the connection is in closed or init, there's nothing to do # if the connection is in closed or init, there's nothing to do
if connection.state in {ConnectionState.CLOSED, ConnectionState.INIT}: if connection.state in {ConnectionState.CLOSED, ConnectionState.INIT}:
return connection return connection
if connection.transaction_open and connection.handle: if connection.transaction_open and connection.handle:
fire_event(Rollback(conn_name=connection.name)) logger.debug('On {}: ROLLBACK'.format(connection.name))
cls._rollback_handle(connection) cls._rollback_handle(connection)
connection.transaction_open = False connection.transaction_open = False
@@ -388,16 +291,16 @@ class BaseConnectionManager(metaclass=abc.ABCMeta):
@abc.abstractmethod @abc.abstractmethod
def execute( def execute(
self, sql: str, auto_begin: bool = False, fetch: bool = False self, sql: str, auto_begin: bool = False, fetch: bool = False
) -> Tuple[AdapterResponse, agate.Table]: ) -> Tuple[Union[str, AdapterResponse], agate.Table]:
"""Execute the given SQL. """Execute the given SQL.
:param str sql: The sql to execute. :param str sql: The sql to execute.
:param bool auto_begin: If set, and dbt is not currently inside a :param bool auto_begin: If set, and dbt is not currently inside a
transaction, automatically begin one. transaction, automatically begin one.
:param bool fetch: If set, fetch results. :param bool fetch: If set, fetch results.
:return: A tuple of the query status and results (empty if fetch=False). :return: A tuple of the status and the results (empty if fetch=False).
:rtype: Tuple[AdapterResponse, agate.Table] :rtype: Tuple[Union[str, AdapterResponse], agate.Table]
""" """
raise dbt.exceptions.NotImplementedException( raise dbt.exceptions.NotImplementedException(
"`execute` is not implemented for this adapter!" '`execute` is not implemented for this adapter!'
) )

File diff suppressed because it is too large Load Diff

View File

@@ -30,11 +30,9 @@ class _Available:
x.update(big_expensive_db_query()) x.update(big_expensive_db_query())
return x return x
""" """
def inner(func): def inner(func):
func._parse_replacement_ = parse_replacement func._parse_replacement_ = parse_replacement
return self(func) return self(func)
return inner return inner
def deprecated( def deprecated(
@@ -59,14 +57,13 @@ class _Available:
The optional parse_replacement, if provided, will provide a parse-time The optional parse_replacement, if provided, will provide a parse-time
replacement for the actual method (see `available.parse`). replacement for the actual method (see `available.parse`).
""" """
def wrapper(func): def wrapper(func):
func_name = func.__name__ func_name = func.__name__
renamed_method(func_name, supported_name) renamed_method(func_name, supported_name)
@wraps(func) @wraps(func)
def inner(*args, **kwargs): def inner(*args, **kwargs):
warn("adapter:{}".format(func_name)) warn('adapter:{}'.format(func_name))
return func(*args, **kwargs) return func(*args, **kwargs)
if parse_replacement: if parse_replacement:
@@ -74,7 +71,6 @@ class _Available:
else: else:
available_function = self available_function = self
return available_function(inner) return available_function(inner)
return wrapper return wrapper
def parse_none(self, func: Callable) -> Callable: def parse_none(self, func: Callable) -> Callable:
@@ -99,7 +95,9 @@ class AdapterMeta(abc.ABCMeta):
# I'm not sure there is any benefit to it after poking around a bit, # I'm not sure there is any benefit to it after poking around a bit,
# but having it doesn't hurt on the python side (and omitting it could # but having it doesn't hurt on the python side (and omitting it could
# hurt for obscure metaclass reasons, for all I know) # hurt for obscure metaclass reasons, for all I know)
cls = abc.ABCMeta.__new__(mcls, name, bases, namespace, **kwargs) # type: ignore cls = abc.ABCMeta.__new__( # type: ignore
mcls, name, bases, namespace, **kwargs
)
# this is very much inspired by ABCMeta's own implementation # this is very much inspired by ABCMeta's own implementation
@@ -111,14 +109,14 @@ class AdapterMeta(abc.ABCMeta):
# collect base class data first # collect base class data first
for base in bases: for base in bases:
available.update(getattr(base, "_available_", set())) available.update(getattr(base, '_available_', set()))
replacements.update(getattr(base, "_parse_replacements_", set())) replacements.update(getattr(base, '_parse_replacements_', set()))
# override with local data if it exists # override with local data if it exists
for name, value in namespace.items(): for name, value in namespace.items():
if getattr(value, "_is_available_", False): if getattr(value, '_is_available_', False):
available.add(name) available.add(name)
parse_replacement = getattr(value, "_parse_replacement_", None) parse_replacement = getattr(value, '_parse_replacement_', None)
if parse_replacement is not None: if parse_replacement is not None:
replacements[name] = parse_replacement replacements[name] = parse_replacement

View File

@@ -8,10 +8,11 @@ from dbt.adapters.protocol import AdapterProtocol
def project_name_from_path(include_path: str) -> str: def project_name_from_path(include_path: str) -> str:
# avoid an import cycle # avoid an import cycle
from dbt.config.project import Project from dbt.config.project import Project
partial = Project.partial_load(include_path) partial = Project.partial_load(include_path)
if partial.project_name is None: if partial.project_name is None:
raise CompilationException(f"Invalid project at {include_path}: name not set!") raise CompilationException(
f'Invalid project at {include_path}: name not set!'
)
return partial.project_name return partial.project_name
@@ -22,13 +23,12 @@ class AdapterPlugin:
:param dependencies: A list of adapter names that this adapter depends :param dependencies: A list of adapter names that this adapter depends
upon. upon.
""" """
def __init__( def __init__(
self, self,
adapter: Type[AdapterProtocol], adapter: Type[AdapterProtocol],
credentials: Type[Credentials], credentials: Type[Credentials],
include_path: str, include_path: str,
dependencies: Optional[List[str]] = None, dependencies: Optional[List[str]] = None
): ):
self.adapter: Type[AdapterProtocol] = adapter self.adapter: Type[AdapterProtocol] = adapter

View File

@@ -15,7 +15,7 @@ class NodeWrapper:
self._inner_node = node self._inner_node = node
def __getattr__(self, name): def __getattr__(self, name):
return getattr(self._inner_node, name, "") return getattr(self._inner_node, name, '')
class _QueryComment(local): class _QueryComment(local):
@@ -24,7 +24,6 @@ class _QueryComment(local):
- the current thread's query comment. - the current thread's query comment.
- a source_name indicating what set the current thread's query comment - a source_name indicating what set the current thread's query comment
""" """
def __init__(self, initial): def __init__(self, initial):
self.query_comment: Optional[str] = initial self.query_comment: Optional[str] = initial
self.append = False self.append = False
@@ -36,19 +35,21 @@ class _QueryComment(local):
if self.append: if self.append:
# replace last ';' with '<comment>;' # replace last ';' with '<comment>;'
sql = sql.rstrip() sql = sql.rstrip()
if sql[-1] == ";": if sql[-1] == ';':
sql = sql[:-1] sql = sql[:-1]
return "{}\n/* {} */;".format(sql, self.query_comment.strip()) return '{}\n/* {} */;'.format(sql, self.query_comment.strip())
return "{}\n/* {} */".format(sql, self.query_comment.strip()) return '{}\n/* {} */'.format(sql, self.query_comment.strip())
return "/* {} */\n{}".format(self.query_comment.strip(), sql) return '/* {} */\n{}'.format(self.query_comment.strip(), sql)
def set(self, comment: Optional[str], append: bool): def set(self, comment: Optional[str], append: bool):
if isinstance(comment, str) and "*/" in comment: if isinstance(comment, str) and '*/' in comment:
# tell the user "no" so they don't hurt themselves by writing # tell the user "no" so they don't hurt themselves by writing
# garbage # garbage
raise RuntimeException(f'query comment contains illegal value "*/": {comment}') raise RuntimeException(
f'query comment contains illegal value "*/": {comment}'
)
self.query_comment = comment self.query_comment = comment
self.append = append self.append = append
@@ -62,17 +63,15 @@ class MacroQueryStringSetter:
self.config = config self.config = config
comment_macro = self._get_comment_macro() comment_macro = self._get_comment_macro()
self.generator: QueryStringFunc = lambda name, model: "" self.generator: QueryStringFunc = lambda name, model: ''
# if the comment value was None or the empty string, just skip it # if the comment value was None or the empty string, just skip it
if comment_macro: if comment_macro:
assert isinstance(comment_macro, str) assert isinstance(comment_macro, str)
macro = "\n".join( macro = '\n'.join((
( '{%- macro query_comment_macro(connection_name, node) -%}',
"{%- macro query_comment_macro(connection_name, node) -%}", comment_macro,
comment_macro, '{% endmacro %}'
"{% endmacro %}", ))
)
)
ctx = self._get_context() ctx = self._get_context()
self.generator = QueryStringGenerator(macro, ctx) self.generator = QueryStringGenerator(macro, ctx)
self.comment = _QueryComment(None) self.comment = _QueryComment(None)
@@ -88,7 +87,7 @@ class MacroQueryStringSetter:
return self.comment.add(sql) return self.comment.add(sql)
def reset(self): def reset(self):
self.set("master", None) self.set('master', None)
def set(self, name: str, node: Optional[CompileResultNode]): def set(self, name: str, node: Optional[CompileResultNode]):
wrapped: Optional[NodeWrapper] = None wrapped: Optional[NodeWrapper] = None

View File

@@ -1,16 +1,13 @@
from collections.abc import Hashable from collections.abc import Hashable
from dataclasses import dataclass from dataclasses import dataclass
from typing import Optional, TypeVar, Any, Type, Dict, Union, Iterator, Tuple, Set from typing import (
Optional, TypeVar, Any, Type, Dict, Union, Iterator, Tuple, Set
)
from dbt.contracts.graph.compiled import CompiledNode from dbt.contracts.graph.compiled import CompiledNode
from dbt.contracts.graph.parsed import ParsedSourceDefinition, ParsedNode from dbt.contracts.graph.parsed import ParsedSourceDefinition, ParsedNode
from dbt.contracts.relation import ( from dbt.contracts.relation import (
RelationType, RelationType, ComponentName, HasQuoting, FakeAPIObject, Policy, Path
ComponentName,
HasQuoting,
FakeAPIObject,
Policy,
Path,
) )
from dbt.exceptions import InternalException from dbt.exceptions import InternalException
from dbt.node_types import NodeType from dbt.node_types import NodeType
@@ -19,7 +16,7 @@ from dbt.utils import filter_null_values, deep_merge, classproperty
import dbt.exceptions import dbt.exceptions
Self = TypeVar("Self", bound="BaseRelation") Self = TypeVar('Self', bound='BaseRelation')
@dataclass(frozen=True, eq=False, repr=False) @dataclass(frozen=True, eq=False, repr=False)
@@ -43,7 +40,7 @@ class BaseRelation(FakeAPIObject, Hashable):
if field.name == field_name: if field.name == field_name:
return field return field
# this should be unreachable # this should be unreachable
raise ValueError(f"BaseRelation has no {field_name} field!") raise ValueError(f'BaseRelation has no {field_name} field!')
def __eq__(self, other): def __eq__(self, other):
if not isinstance(other, self.__class__): if not isinstance(other, self.__class__):
@@ -52,18 +49,20 @@ class BaseRelation(FakeAPIObject, Hashable):
@classmethod @classmethod
def get_default_quote_policy(cls) -> Policy: def get_default_quote_policy(cls) -> Policy:
return cls._get_field_named("quote_policy").default return cls._get_field_named('quote_policy').default
@classmethod @classmethod
def get_default_include_policy(cls) -> Policy: def get_default_include_policy(cls) -> Policy:
return cls._get_field_named("include_policy").default return cls._get_field_named('include_policy').default
def get(self, key, default=None): def get(self, key, default=None):
"""Override `.get` to return a metadata object so we don't break """Override `.get` to return a metadata object so we don't break
dbt_utils. dbt_utils.
""" """
if key == "metadata": if key == 'metadata':
return {"type": self.__class__.__name__} return {
'type': self.__class__.__name__
}
return super().get(key, default) return super().get(key, default)
def matches( def matches(
@@ -72,19 +71,16 @@ class BaseRelation(FakeAPIObject, Hashable):
schema: Optional[str] = None, schema: Optional[str] = None,
identifier: Optional[str] = None, identifier: Optional[str] = None,
) -> bool: ) -> bool:
search = filter_null_values( search = filter_null_values({
{ ComponentName.Database: database,
ComponentName.Database: database, ComponentName.Schema: schema,
ComponentName.Schema: schema, ComponentName.Identifier: identifier
ComponentName.Identifier: identifier, })
}
)
if not search: if not search:
# nothing was passed in # nothing was passed in
raise dbt.exceptions.RuntimeException( raise dbt.exceptions.RuntimeException(
"Tried to match relation, but no search path was passed!" "Tried to match relation, but no search path was passed!")
)
exact_match = True exact_match = True
approximate_match = True approximate_match = True
@@ -92,13 +88,14 @@ class BaseRelation(FakeAPIObject, Hashable):
for k, v in search.items(): for k, v in search.items():
if not self._is_exactish_match(k, v): if not self._is_exactish_match(k, v):
exact_match = False exact_match = False
if str(self.path.get_lowered_part(k)).strip(self.quote_character) != v.lower().strip(
self.quote_character if self.path.get_lowered_part(k) != v.lower():
): approximate_match = False
approximate_match = False # type: ignore[union-attr]
if approximate_match and not exact_match: if approximate_match and not exact_match:
target = self.create(database=database, schema=schema, identifier=identifier) target = self.create(
database=database, schema=schema, identifier=identifier
)
dbt.exceptions.approximate_relation_match(target, self) dbt.exceptions.approximate_relation_match(target, self)
return exact_match return exact_match
@@ -112,13 +109,11 @@ class BaseRelation(FakeAPIObject, Hashable):
schema: Optional[bool] = None, schema: Optional[bool] = None,
identifier: Optional[bool] = None, identifier: Optional[bool] = None,
) -> Self: ) -> Self:
policy = filter_null_values( policy = filter_null_values({
{ ComponentName.Database: database,
ComponentName.Database: database, ComponentName.Schema: schema,
ComponentName.Schema: schema, ComponentName.Identifier: identifier
ComponentName.Identifier: identifier, })
}
)
new_quote_policy = self.quote_policy.replace_dict(policy) new_quote_policy = self.quote_policy.replace_dict(policy)
return self.replace(quote_policy=new_quote_policy) return self.replace(quote_policy=new_quote_policy)
@@ -129,18 +124,16 @@ class BaseRelation(FakeAPIObject, Hashable):
schema: Optional[bool] = None, schema: Optional[bool] = None,
identifier: Optional[bool] = None, identifier: Optional[bool] = None,
) -> Self: ) -> Self:
policy = filter_null_values( policy = filter_null_values({
{ ComponentName.Database: database,
ComponentName.Database: database, ComponentName.Schema: schema,
ComponentName.Schema: schema, ComponentName.Identifier: identifier
ComponentName.Identifier: identifier, })
}
)
new_include_policy = self.include_policy.replace_dict(policy) new_include_policy = self.include_policy.replace_dict(policy)
return self.replace(include_policy=new_include_policy) return self.replace(include_policy=new_include_policy)
def information_schema(self, view_name=None) -> "InformationSchema": def information_schema(self, view_name=None) -> 'InformationSchema':
# some of our data comes from jinja, where things can be `Undefined`. # some of our data comes from jinja, where things can be `Undefined`.
if not isinstance(view_name, str): if not isinstance(view_name, str):
view_name = None view_name = None
@@ -150,10 +143,10 @@ class BaseRelation(FakeAPIObject, Hashable):
info_schema = InformationSchema.from_relation(self, view_name) info_schema = InformationSchema.from_relation(self, view_name)
return info_schema.incorporate(path={"schema": None}) return info_schema.incorporate(path={"schema": None})
def information_schema_only(self) -> "InformationSchema": def information_schema_only(self) -> 'InformationSchema':
return self.information_schema() return self.information_schema()
def without_identifier(self) -> "BaseRelation": def without_identifier(self) -> 'BaseRelation':
"""Return a form of this relation that only has the database and schema """Return a form of this relation that only has the database and schema
set to included. To get the appropriately-quoted form the schema out of set to included. To get the appropriately-quoted form the schema out of
the result (for use as part of a query), use `.render()`. To get the the result (for use as part of a query), use `.render()`. To get the
@@ -163,7 +156,9 @@ class BaseRelation(FakeAPIObject, Hashable):
""" """
return self.include(identifier=False).replace_path(identifier=None) return self.include(identifier=False).replace_path(identifier=None)
def _render_iterator(self) -> Iterator[Tuple[Optional[ComponentName], Optional[str]]]: def _render_iterator(
self
) -> Iterator[Tuple[Optional[ComponentName], Optional[str]]]:
for key in ComponentName: for key in ComponentName:
path_part: Optional[str] = None path_part: Optional[str] = None
@@ -175,22 +170,27 @@ class BaseRelation(FakeAPIObject, Hashable):
def render(self) -> str: def render(self) -> str:
# if there is nothing set, this will return the empty string. # if there is nothing set, this will return the empty string.
return ".".join(part for _, part in self._render_iterator() if part is not None) return '.'.join(
part for _, part in self._render_iterator()
if part is not None
)
def quoted(self, identifier): def quoted(self, identifier):
return "{quote_char}{identifier}{quote_char}".format( return '{quote_char}{identifier}{quote_char}'.format(
quote_char=self.quote_character, quote_char=self.quote_character,
identifier=identifier, identifier=identifier,
) )
@classmethod @classmethod
def create_from_source(cls: Type[Self], source: ParsedSourceDefinition, **kwargs: Any) -> Self: def create_from_source(
cls: Type[Self], source: ParsedSourceDefinition, **kwargs: Any
) -> Self:
source_quoting = source.quoting.to_dict(omit_none=True) source_quoting = source.quoting.to_dict(omit_none=True)
source_quoting.pop("column", None) source_quoting.pop('column', None)
quote_policy = deep_merge( quote_policy = deep_merge(
cls.get_default_quote_policy().to_dict(omit_none=True), cls.get_default_quote_policy().to_dict(omit_none=True),
source_quoting, source_quoting,
kwargs.get("quote_policy", {}), kwargs.get('quote_policy', {}),
) )
return cls.create( return cls.create(
@@ -198,12 +198,12 @@ class BaseRelation(FakeAPIObject, Hashable):
schema=source.schema, schema=source.schema,
identifier=source.identifier, identifier=source.identifier,
quote_policy=quote_policy, quote_policy=quote_policy,
**kwargs, **kwargs
) )
@staticmethod @staticmethod
def add_ephemeral_prefix(name: str): def add_ephemeral_prefix(name: str):
return f"__dbt__cte__{name}" return f'__dbt__cte__{name}'
@classmethod @classmethod
def create_ephemeral_from_node( def create_ephemeral_from_node(
@@ -236,8 +236,7 @@ class BaseRelation(FakeAPIObject, Hashable):
schema=node.schema, schema=node.schema,
identifier=node.alias, identifier=node.alias,
quote_policy=quote_policy, quote_policy=quote_policy,
**kwargs, **kwargs)
)
@classmethod @classmethod
def create_from( def create_from(
@@ -249,14 +248,15 @@ class BaseRelation(FakeAPIObject, Hashable):
if node.resource_type == NodeType.Source: if node.resource_type == NodeType.Source:
if not isinstance(node, ParsedSourceDefinition): if not isinstance(node, ParsedSourceDefinition):
raise InternalException( raise InternalException(
"type mismatch, expected ParsedSourceDefinition but got {}".format(type(node)) 'type mismatch, expected ParsedSourceDefinition but got {}'
.format(type(node))
) )
return cls.create_from_source(node, **kwargs) return cls.create_from_source(node, **kwargs)
else: else:
if not isinstance(node, (ParsedNode, CompiledNode)): if not isinstance(node, (ParsedNode, CompiledNode)):
raise InternalException( raise InternalException(
"type mismatch, expected ParsedNode or CompiledNode but " 'type mismatch, expected ParsedNode or CompiledNode but '
"got {}".format(type(node)) 'got {}'.format(type(node))
) )
return cls.create_from_node(config, node, **kwargs) return cls.create_from_node(config, node, **kwargs)
@@ -269,16 +269,14 @@ class BaseRelation(FakeAPIObject, Hashable):
type: Optional[RelationType] = None, type: Optional[RelationType] = None,
**kwargs, **kwargs,
) -> Self: ) -> Self:
kwargs.update( kwargs.update({
{ 'path': {
"path": { 'database': database,
"database": database, 'schema': schema,
"schema": schema, 'identifier': identifier,
"identifier": identifier, },
}, 'type': type,
"type": type, })
}
)
return cls.from_dict(kwargs) return cls.from_dict(kwargs)
def __repr__(self) -> str: def __repr__(self) -> str:
@@ -344,7 +342,7 @@ class BaseRelation(FakeAPIObject, Hashable):
return RelationType return RelationType
Info = TypeVar("Info", bound="InformationSchema") Info = TypeVar('Info', bound='InformationSchema')
@dataclass(frozen=True, eq=False, repr=False) @dataclass(frozen=True, eq=False, repr=False)
@@ -354,15 +352,17 @@ class InformationSchema(BaseRelation):
def __post_init__(self): def __post_init__(self):
if not isinstance(self.information_schema_view, (type(None), str)): if not isinstance(self.information_schema_view, (type(None), str)):
raise dbt.exceptions.CompilationException( raise dbt.exceptions.CompilationException(
"Got an invalid name: {}".format(self.information_schema_view) 'Got an invalid name: {}'.format(self.information_schema_view)
) )
@classmethod @classmethod
def get_path(cls, relation: BaseRelation, information_schema_view: Optional[str]) -> Path: def get_path(
cls, relation: BaseRelation, information_schema_view: Optional[str]
) -> Path:
return Path( return Path(
database=relation.database, database=relation.database,
schema=relation.schema, schema=relation.schema,
identifier="INFORMATION_SCHEMA", identifier='INFORMATION_SCHEMA',
) )
@classmethod @classmethod
@@ -393,7 +393,9 @@ class InformationSchema(BaseRelation):
relation: BaseRelation, relation: BaseRelation,
information_schema_view: Optional[str], information_schema_view: Optional[str],
) -> Info: ) -> Info:
include_policy = cls.get_include_policy(relation, information_schema_view) include_policy = cls.get_include_policy(
relation, information_schema_view
)
quote_policy = cls.get_quote_policy(relation, information_schema_view) quote_policy = cls.get_quote_policy(relation, information_schema_view)
path = cls.get_path(relation, information_schema_view) path = cls.get_path(relation, information_schema_view)
return cls( return cls(
@@ -415,7 +417,6 @@ class SchemaSearchMap(Dict[InformationSchema, Set[Optional[str]]]):
search for what schemas. The schema values are all lowercased to avoid search for what schemas. The schema values are all lowercased to avoid
duplication. duplication.
""" """
def add(self, relation: BaseRelation): def add(self, relation: BaseRelation):
key = relation.information_schema_only() key = relation.information_schema_only()
if key not in self: if key not in self:
@@ -425,7 +426,9 @@ class SchemaSearchMap(Dict[InformationSchema, Set[Optional[str]]]):
schema = relation.schema.lower() schema = relation.schema.lower()
self[key].add(schema) self[key].add(schema)
def search(self) -> Iterator[Tuple[InformationSchema, Optional[str]]]: def search(
self
) -> Iterator[Tuple[InformationSchema, Optional[str]]]:
for information_schema_name, schemas in self.items(): for information_schema_name, schemas in self.items():
for schema in schemas: for schema in schemas:
yield information_schema_name, schema yield information_schema_name, schema
@@ -440,13 +443,14 @@ class SchemaSearchMap(Dict[InformationSchema, Set[Optional[str]]]):
dbt.exceptions.raise_compiler_error(str(seen)) dbt.exceptions.raise_compiler_error(str(seen))
for information_schema_name, schema in self.search(): for information_schema_name, schema in self.search():
path = {"database": information_schema_name.database, "schema": schema} path = {
new.add( 'database': information_schema_name.database,
information_schema_name.incorporate( 'schema': schema
path=path, }
quote_policy={"database": False}, new.add(information_schema_name.incorporate(
include_policy={"database": False}, path=path,
) quote_policy={'database': False},
) include_policy={'database': False},
))
return new return new

View File

@@ -1,27 +1,23 @@
import threading from collections import namedtuple
from copy import deepcopy from copy import deepcopy
from typing import Any, Dict, Iterable, List, Optional, Set, Tuple from typing import List, Iterable, Optional, Dict, Set, Tuple, Any
import threading
from dbt.adapters.reference_keys import _make_key, _ReferenceKey from dbt.logger import CACHE_LOGGER as logger
import dbt.exceptions
from dbt.events.functions import fire_event
from dbt.events.types import (
AddLink,
AddRelation,
DropCascade,
DropMissingRelation,
DropRelation,
DumpAfterAddGraph,
DumpAfterRenameSchema,
DumpBeforeAddGraph,
DumpBeforeRenameSchema,
RenameSchema,
TemporaryRelation,
UncachedRelation,
UpdateReference,
)
from dbt.utils import lowercase from dbt.utils import lowercase
from dbt.helper_types import Lazy import dbt.exceptions
_ReferenceKey = namedtuple('_ReferenceKey', 'database schema identifier')
def _make_key(relation) -> _ReferenceKey:
"""Make _ReferenceKeys with lowercase values for the cache so we don't have
to keep track of quoting
"""
# databases and schemas can both be None
return _ReferenceKey(lowercase(relation.database),
lowercase(relation.schema),
lowercase(relation.identifier))
def dot_separated(key: _ReferenceKey) -> str: def dot_separated(key: _ReferenceKey) -> str:
@@ -29,7 +25,7 @@ def dot_separated(key: _ReferenceKey) -> str:
:param _ReferenceKey key: The key to stringify. :param _ReferenceKey key: The key to stringify.
""" """
return ".".join(map(str, key)) return '.'.join(map(str, key))
class _CachedRelation: class _CachedRelation:
@@ -41,15 +37,14 @@ class _CachedRelation:
that refer to this relation. that refer to this relation.
:attr BaseRelation inner: The underlying dbt relation. :attr BaseRelation inner: The underlying dbt relation.
""" """
def __init__(self, inner): def __init__(self, inner):
self.referenced_by = {} self.referenced_by = {}
self.inner = inner self.inner = inner
def __str__(self) -> str: def __str__(self) -> str:
return ("_CachedRelation(database={}, schema={}, identifier={}, inner={})").format( return (
self.database, self.schema, self.identifier, self.inner '_CachedRelation(database={}, schema={}, identifier={}, inner={})'
) ).format(self.database, self.schema, self.identifier, self.inner)
@property @property
def database(self) -> Optional[str]: def database(self) -> Optional[str]:
@@ -83,7 +78,7 @@ class _CachedRelation:
""" """
return _make_key(self) return _make_key(self)
def add_reference(self, referrer: "_CachedRelation"): def add_reference(self, referrer: '_CachedRelation'):
"""Add a reference from referrer to self, indicating that if this node """Add a reference from referrer to self, indicating that if this node
were drop...cascaded, the referrer would be dropped as well. were drop...cascaded, the referrer would be dropped as well.
@@ -127,9 +122,9 @@ class _CachedRelation:
# table_name is ever anything but the identifier (via .create()) # table_name is ever anything but the identifier (via .create())
self.inner = self.inner.incorporate( self.inner = self.inner.incorporate(
path={ path={
"database": new_relation.inner.database, 'database': new_relation.inner.database,
"schema": new_relation.inner.schema, 'schema': new_relation.inner.schema,
"identifier": new_relation.inner.identifier, 'identifier': new_relation.inner.identifier
}, },
) )
@@ -145,9 +140,8 @@ class _CachedRelation:
""" """
if new_key in self.referenced_by: if new_key in self.referenced_by:
dbt.exceptions.raise_cache_inconsistent( dbt.exceptions.raise_cache_inconsistent(
'in rename of "{}" -> "{}", new name is in the cache already'.format( 'in rename of "{}" -> "{}", new name is in the cache already'
old_key, new_key .format(old_key, new_key)
)
) )
if old_key not in self.referenced_by: if old_key not in self.referenced_by:
@@ -163,6 +157,12 @@ class _CachedRelation:
return [dot_separated(r) for r in self.referenced_by] return [dot_separated(r) for r in self.referenced_by]
def lazy_log(msg, func):
if logger.disabled:
return
logger.debug(msg.format(func()))
class RelationsCache: class RelationsCache:
"""A cache of the relations known to dbt. Keeps track of relationships """A cache of the relations known to dbt. Keeps track of relationships
declared between tables and handles renames/drops as a real database would. declared between tables and handles renames/drops as a real database would.
@@ -172,16 +172,13 @@ class RelationsCache:
The adapters also hold this lock while filling the cache. The adapters also hold this lock while filling the cache.
:attr Set[str] schemas: The set of known/cached schemas, all lowercased. :attr Set[str] schemas: The set of known/cached schemas, all lowercased.
""" """
def __init__(self) -> None: def __init__(self) -> None:
self.relations: Dict[_ReferenceKey, _CachedRelation] = {} self.relations: Dict[_ReferenceKey, _CachedRelation] = {}
self.lock = threading.RLock() self.lock = threading.RLock()
self.schemas: Set[Tuple[Optional[str], Optional[str]]] = set() self.schemas: Set[Tuple[Optional[str], Optional[str]]] = set()
def add_schema( def add_schema(
self, self, database: Optional[str], schema: Optional[str],
database: Optional[str],
schema: Optional[str],
) -> None: ) -> None:
"""Add a schema to the set of known schemas (case-insensitive) """Add a schema to the set of known schemas (case-insensitive)
@@ -191,9 +188,7 @@ class RelationsCache:
self.schemas.add((lowercase(database), lowercase(schema))) self.schemas.add((lowercase(database), lowercase(schema)))
def drop_schema( def drop_schema(
self, self, database: Optional[str], schema: Optional[str],
database: Optional[str],
schema: Optional[str],
) -> None: ) -> None:
"""Drop the given schema and remove it from the set of known schemas. """Drop the given schema and remove it from the set of known schemas.
@@ -237,7 +232,10 @@ class RelationsCache:
# self.relations or any cache entry's referenced_by during iteration # self.relations or any cache entry's referenced_by during iteration
# it's a runtime error! # it's a runtime error!
with self.lock: with self.lock:
return {dot_separated(k): v.dump_graph_entry() for k, v in self.relations.items()} return {
dot_separated(k): v.dump_graph_entry()
for k, v in self.relations.items()
}
def _setdefault(self, relation: _CachedRelation): def _setdefault(self, relation: _CachedRelation):
"""Add a relation to the cache, or return it if it already exists. """Add a relation to the cache, or return it if it already exists.
@@ -265,20 +263,21 @@ class RelationsCache:
return return
if referenced is None: if referenced is None:
dbt.exceptions.raise_cache_inconsistent( dbt.exceptions.raise_cache_inconsistent(
"in add_link, referenced link key {} not in cache!".format(referenced_key) 'in add_link, referenced link key {} not in cache!'
.format(referenced_key)
) )
dependent = self.relations.get(dependent_key) dependent = self.relations.get(dependent_key)
if dependent is None: if dependent is None:
dbt.exceptions.raise_cache_inconsistent( dbt.exceptions.raise_cache_inconsistent(
"in add_link, dependent link key {} not in cache!".format(dependent_key) 'in add_link, dependent link key {} not in cache!'
.format(dependent_key)
) )
assert dependent is not None # we just raised! assert dependent is not None # we just raised!
referenced.add_reference(dependent) referenced.add_reference(dependent)
# TODO: Is this dead code? I can't seem to find it grepping the codebase.
def add_link(self, referenced, dependent): def add_link(self, referenced, dependent):
"""Add a link between two relations to the database. If either relation """Add a link between two relations to the database. If either relation
does not exist, it will be added as an "external" relation. does not exist, it will be added as an "external" relation.
@@ -294,22 +293,33 @@ class RelationsCache:
:raises InternalError: If either entry does not exist. :raises InternalError: If either entry does not exist.
""" """
ref_key = _make_key(referenced) ref_key = _make_key(referenced)
dep_key = _make_key(dependent)
if (ref_key.database, ref_key.schema) not in self: if (ref_key.database, ref_key.schema) not in self:
# if we have not cached the referenced schema at all, we must be # if we have not cached the referenced schema at all, we must be
# referring to a table outside our control. There's no need to make # referring to a table outside our control. There's no need to make
# a link - we will never drop the referenced relation during a run. # a link - we will never drop the referenced relation during a run.
fire_event(UncachedRelation(dep_key=dep_key, ref_key=ref_key)) logger.debug(
'{dep!s} references {ref!s} but {ref.database}.{ref.schema} '
'is not in the cache, skipping assumed external relation'
.format(dep=dependent, ref=ref_key)
)
return return
if ref_key not in self.relations: if ref_key not in self.relations:
# Insert a dummy "external" relation. # Insert a dummy "external" relation.
referenced = referenced.replace(type=referenced.External) referenced = referenced.replace(
type=referenced.External
)
self.add(referenced) self.add(referenced)
dep_key = _make_key(dependent)
if dep_key not in self.relations: if dep_key not in self.relations:
# Insert a dummy "external" relation. # Insert a dummy "external" relation.
dependent = dependent.replace(type=referenced.External) dependent = dependent.replace(
type=referenced.External
)
self.add(dependent) self.add(dependent)
fire_event(AddLink(dep_key=dep_key, ref_key=ref_key)) logger.debug(
'adding link, {!s} references {!s}'.format(dep_key, ref_key)
)
with self.lock: with self.lock:
self._add_link(ref_key, dep_key) self._add_link(ref_key, dep_key)
@@ -320,12 +330,14 @@ class RelationsCache:
:param BaseRelation relation: The underlying relation. :param BaseRelation relation: The underlying relation.
""" """
cached = _CachedRelation(relation) cached = _CachedRelation(relation)
fire_event(AddRelation(relation=_make_key(cached))) logger.debug('Adding relation: {!s}'.format(cached))
fire_event(DumpBeforeAddGraph(dump=Lazy.defer(lambda: self.dump_graph())))
lazy_log('before adding: {!s}', self.dump_graph)
with self.lock: with self.lock:
self._setdefault(cached) self._setdefault(cached)
fire_event(DumpAfterAddGraph(dump=Lazy.defer(lambda: self.dump_graph())))
lazy_log('after adding: {!s}', self.dump_graph)
def _remove_refs(self, keys): def _remove_refs(self, keys):
"""Removes all references to all entries in keys. This does not """Removes all references to all entries in keys. This does not
@@ -340,17 +352,20 @@ class RelationsCache:
for cached in self.relations.values(): for cached in self.relations.values():
cached.release_references(keys) cached.release_references(keys)
def _drop_cascade_relation(self, dropped_key): def _drop_cascade_relation(self, dropped):
"""Drop the given relation and cascade it appropriately to all """Drop the given relation and cascade it appropriately to all
dependent relations. dependent relations.
:param _CachedRelation dropped: An existing _CachedRelation to drop. :param _CachedRelation dropped: An existing _CachedRelation to drop.
""" """
if dropped_key not in self.relations: if dropped not in self.relations:
fire_event(DropMissingRelation(relation=dropped_key)) logger.debug('dropped a nonexistent relationship: {!s}'
.format(dropped))
return return
consequences = self.relations[dropped_key].collect_consequences() consequences = self.relations[dropped].collect_consequences()
fire_event(DropCascade(dropped=dropped_key, consequences=consequences)) logger.debug(
'drop {} is cascading to {}'.format(dropped, consequences)
)
self._remove_refs(consequences) self._remove_refs(consequences)
def drop(self, relation): def drop(self, relation):
@@ -364,10 +379,10 @@ class RelationsCache:
:param str schema: The schema of the relation to drop. :param str schema: The schema of the relation to drop.
:param str identifier: The identifier of the relation to drop. :param str identifier: The identifier of the relation to drop.
""" """
dropped_key = _make_key(relation) dropped = _make_key(relation)
fire_event(DropRelation(dropped=dropped_key)) logger.debug('Dropping relation: {!s}'.format(dropped))
with self.lock: with self.lock:
self._drop_cascade_relation(dropped_key) self._drop_cascade_relation(dropped)
def _rename_relation(self, old_key, new_relation): def _rename_relation(self, old_key, new_relation):
"""Rename a relation named old_key to new_key, updating references. """Rename a relation named old_key to new_key, updating references.
@@ -388,8 +403,9 @@ class RelationsCache:
# update all the relations that refer to it # update all the relations that refer to it
for cached in self.relations.values(): for cached in self.relations.values():
if cached.is_referenced_by(old_key): if cached.is_referenced_by(old_key):
fire_event( logger.debug(
UpdateReference(old_key=old_key, new_key=new_key, cached_key=cached.key()) 'updated reference from {0} -> {2} to {1} -> {2}'
.format(old_key, new_key, cached.key())
) )
cached.rename_key(old_key, new_key) cached.rename_key(old_key, new_key)
@@ -414,13 +430,15 @@ class RelationsCache:
""" """
if new_key in self.relations: if new_key in self.relations:
dbt.exceptions.raise_cache_inconsistent( dbt.exceptions.raise_cache_inconsistent(
"in rename, new key {} already in cache: {}".format( 'in rename, new key {} already in cache: {}'
new_key, list(self.relations.keys()) .format(new_key, list(self.relations.keys()))
)
) )
if old_key not in self.relations: if old_key not in self.relations:
fire_event(TemporaryRelation(key=old_key)) logger.debug(
'old key {} not found in self.relations, assuming temporary'
.format(old_key)
)
return False return False
return True return True
@@ -438,9 +456,11 @@ class RelationsCache:
""" """
old_key = _make_key(old) old_key = _make_key(old)
new_key = _make_key(new) new_key = _make_key(new)
fire_event(RenameSchema(old_key=old_key, new_key=new_key)) logger.debug('Renaming relation {!s} to {!s}'.format(
old_key, new_key
))
fire_event(DumpBeforeRenameSchema(dump=Lazy.defer(lambda: self.dump_graph()))) lazy_log('before rename: {!s}', self.dump_graph)
with self.lock: with self.lock:
if self._check_rename_constraints(old_key, new_key): if self._check_rename_constraints(old_key, new_key):
@@ -448,9 +468,11 @@ class RelationsCache:
else: else:
self._setdefault(_CachedRelation(new)) self._setdefault(_CachedRelation(new))
fire_event(DumpAfterRenameSchema(dump=Lazy.defer(lambda: self.dump_graph()))) lazy_log('after rename: {!s}', self.dump_graph)
def get_relations(self, database: Optional[str], schema: Optional[str]) -> List[Any]: def get_relations(
self, database: Optional[str], schema: Optional[str]
) -> List[Any]:
"""Case-insensitively yield all relations matching the given schema. """Case-insensitively yield all relations matching the given schema.
:param str schema: The case-insensitive schema name to list from. :param str schema: The case-insensitive schema name to list from.
@@ -461,14 +483,14 @@ class RelationsCache:
schema = lowercase(schema) schema = lowercase(schema)
with self.lock: with self.lock:
results = [ results = [
r.inner r.inner for r in self.relations.values()
for r in self.relations.values() if (lowercase(r.schema) == schema and
if (lowercase(r.schema) == schema and lowercase(r.database) == database) lowercase(r.database) == database)
] ]
if None in results: if None in results:
dbt.exceptions.raise_cache_inconsistent( dbt.exceptions.raise_cache_inconsistent(
"in get_relations, a None relation was found in the cache!" 'in get_relations, a None relation was found in the cache!'
) )
return results return results

View File

@@ -8,9 +8,10 @@ from dbt.include.global_project import (
PACKAGE_PATH as GLOBAL_PROJECT_PATH, PACKAGE_PATH as GLOBAL_PROJECT_PATH,
PROJECT_NAME as GLOBAL_PROJECT_NAME, PROJECT_NAME as GLOBAL_PROJECT_NAME,
) )
from dbt.events.functions import fire_event from dbt.logger import GLOBAL_LOGGER as logger
from dbt.events.types import AdapterImportError, PluginLoadError
from dbt.contracts.connection import Credentials, AdapterRequiredConfig from dbt.contracts.connection import Credentials, AdapterRequiredConfig
from dbt.adapters.protocol import ( from dbt.adapters.protocol import (
AdapterProtocol, AdapterProtocol,
AdapterConfig, AdapterConfig,
@@ -49,7 +50,9 @@ class AdapterContainer:
adapter = self.get_adapter_class_by_name(name) adapter = self.get_adapter_class_by_name(name)
return adapter.Relation return adapter.Relation
def get_config_class_by_name(self, name: str) -> Type[AdapterConfig]: def get_config_class_by_name(
self, name: str
) -> Type[AdapterConfig]:
adapter = self.get_adapter_class_by_name(name) adapter = self.get_adapter_class_by_name(name)
return adapter.AdapterSpecificConfigs return adapter.AdapterSpecificConfigs
@@ -59,25 +62,24 @@ class AdapterContainer:
# singletons # singletons
try: try:
# mypy doesn't think modules have any attributes. # mypy doesn't think modules have any attributes.
mod: Any = import_module("." + name, "dbt.adapters") mod: Any = import_module('.' + name, 'dbt.adapters')
except ModuleNotFoundError as exc: except ModuleNotFoundError as exc:
# if we failed to import the target module in particular, inform # if we failed to import the target module in particular, inform
# the user about it via a runtime error # the user about it via a runtime error
if exc.name == "dbt.adapters." + name: if exc.name == 'dbt.adapters.' + name:
fire_event(AdapterImportError(exc=exc)) raise RuntimeException(f'Could not find adapter type {name}!')
raise RuntimeException(f"Could not find adapter type {name}!") logger.info(f'Error importing adapter: {exc}')
# otherwise, the error had to have come from some underlying # otherwise, the error had to have come from some underlying
# library. Log the stack trace. # library. Log the stack trace.
logger.debug('', exc_info=True)
fire_event(PluginLoadError())
raise raise
plugin: AdapterPlugin = mod.Plugin plugin: AdapterPlugin = mod.Plugin
plugin_type = plugin.adapter.type() plugin_type = plugin.adapter.type()
if plugin_type != name: if plugin_type != name:
raise RuntimeException( raise RuntimeException(
f"Expected to find adapter with type named {name}, got " f'Expected to find adapter with type named {name}, got '
f"adapter with type {plugin_type}" f'adapter with type {plugin_type}'
) )
with self.lock: with self.lock:
@@ -107,7 +109,8 @@ class AdapterContainer:
return self.adapters[adapter_name] return self.adapters[adapter_name]
def reset_adapters(self): def reset_adapters(self):
"""Clear the adapters. This is useful for tests, which change configs.""" """Clear the adapters. This is useful for tests, which change configs.
"""
with self.lock: with self.lock:
for adapter in self.adapters.values(): for adapter in self.adapters.values():
adapter.cleanup_connections() adapter.cleanup_connections()
@@ -137,16 +140,22 @@ class AdapterContainer:
try: try:
plugin = self.plugins[plugin_name] plugin = self.plugins[plugin_name]
except KeyError: except KeyError:
raise InternalException(f"No plugin found for {plugin_name}") from None raise InternalException(
f'No plugin found for {plugin_name}'
) from None
plugins.append(plugin) plugins.append(plugin)
seen.add(plugin_name) seen.add(plugin_name)
if plugin.dependencies is None:
continue
for dep in plugin.dependencies: for dep in plugin.dependencies:
if dep not in seen: if dep not in seen:
plugin_names.append(dep) plugin_names.append(dep)
return plugins return plugins
def get_adapter_package_names(self, name: Optional[str]) -> List[str]: def get_adapter_package_names(self, name: Optional[str]) -> List[str]:
package_names: List[str] = [p.project_name for p in self.get_adapter_plugins(name)] package_names: List[str] = [
p.project_name for p in self.get_adapter_plugins(name)
]
package_names.append(GLOBAL_PROJECT_NAME) package_names.append(GLOBAL_PROJECT_NAME)
return package_names return package_names
@@ -156,7 +165,9 @@ class AdapterContainer:
try: try:
path = self.packages[package_name] path = self.packages[package_name]
except KeyError: except KeyError:
raise InternalException(f"No internal package listing found for {package_name}") raise InternalException(
f'No internal package listing found for {package_name}'
)
paths.append(path) paths.append(path)
return paths return paths
@@ -175,12 +186,9 @@ def get_adapter(config: AdapterRequiredConfig):
return FACTORY.lookup_adapter(config.credentials.type) return FACTORY.lookup_adapter(config.credentials.type)
def get_adapter_by_type(adapter_type):
return FACTORY.lookup_adapter(adapter_type)
def reset_adapters(): def reset_adapters():
"""Clear the adapters. This is useful for tests, which change configs.""" """Clear the adapters. This is useful for tests, which change configs.
"""
FACTORY.reset_adapters() FACTORY.reset_adapters()

View File

@@ -1,23 +1,18 @@
from dataclasses import dataclass from dataclasses import dataclass
from typing import ( from typing import (
Type, Type, Hashable, Optional, ContextManager, List, Generic, TypeVar, ClassVar,
Hashable, Tuple, Union, Dict, Any
Optional,
ContextManager,
List,
Generic,
TypeVar,
Tuple,
Union,
Dict,
Any,
) )
from typing_extensions import Protocol from typing_extensions import Protocol
import agate import agate
from dbt.contracts.connection import Connection, AdapterRequiredConfig, AdapterResponse from dbt.contracts.connection import (
from dbt.contracts.graph.compiled import CompiledNode, ManifestNode, NonSourceCompiledNode Connection, AdapterRequiredConfig, AdapterResponse
)
from dbt.contracts.graph.compiled import (
CompiledNode, ManifestNode, NonSourceCompiledNode
)
from dbt.contracts.graph.parsed import ParsedNode, ParsedSourceDefinition from dbt.contracts.graph.parsed import ParsedNode, ParsedSourceDefinition
from dbt.contracts.graph.model_config import BaseConfig from dbt.contracts.graph.model_config import BaseConfig
from dbt.contracts.graph.manifest import Manifest from dbt.contracts.graph.manifest import Manifest
@@ -39,7 +34,7 @@ class ColumnProtocol(Protocol):
pass pass
Self = TypeVar("Self", bound="RelationProtocol") Self = TypeVar('Self', bound='RelationProtocol')
class RelationProtocol(Protocol): class RelationProtocol(Protocol):
@@ -69,15 +64,22 @@ class CompilerProtocol(Protocol):
... ...
AdapterConfig_T = TypeVar("AdapterConfig_T", bound=AdapterConfig) AdapterConfig_T = TypeVar(
ConnectionManager_T = TypeVar("ConnectionManager_T", bound=ConnectionManagerProtocol) 'AdapterConfig_T', bound=AdapterConfig
Relation_T = TypeVar("Relation_T", bound=RelationProtocol) )
Column_T = TypeVar("Column_T", bound=ColumnProtocol) ConnectionManager_T = TypeVar(
Compiler_T = TypeVar("Compiler_T", bound=CompilerProtocol) 'ConnectionManager_T', bound=ConnectionManagerProtocol
)
Relation_T = TypeVar(
'Relation_T', bound=RelationProtocol
)
Column_T = TypeVar(
'Column_T', bound=ColumnProtocol
)
Compiler_T = TypeVar('Compiler_T', bound=CompilerProtocol)
# TODO CT-211 class AdapterProtocol(
class AdapterProtocol( # type: ignore[misc]
Protocol, Protocol,
Generic[ Generic[
AdapterConfig_T, AdapterConfig_T,
@@ -85,15 +87,12 @@ class AdapterProtocol( # type: ignore[misc]
Relation_T, Relation_T,
Column_T, Column_T,
Compiler_T, Compiler_T,
], ]
): ):
# N.B. Technically these are ClassVars, but mypy doesn't support putting type vars in a AdapterSpecificConfigs: ClassVar[Type[AdapterConfig_T]]
# ClassVar due to the restirctiveness of PEP-526 Column: ClassVar[Type[Column_T]]
# See: https://github.com/python/mypy/issues/5144 Relation: ClassVar[Type[Relation_T]]
AdapterSpecificConfigs: Type[AdapterConfig_T] ConnectionManager: ClassVar[Type[ConnectionManager_T]]
Column: Type[Column_T]
Relation: Type[Relation_T]
ConnectionManager: Type[ConnectionManager_T]
connections: ConnectionManager_T connections: ConnectionManager_T
def __init__(self, config: AdapterRequiredConfig): def __init__(self, config: AdapterRequiredConfig):
@@ -157,7 +156,7 @@ class AdapterProtocol( # type: ignore[misc]
def execute( def execute(
self, sql: str, auto_begin: bool = False, fetch: bool = False self, sql: str, auto_begin: bool = False, fetch: bool = False
) -> Tuple[AdapterResponse, agate.Table]: ) -> Tuple[Union[str, AdapterResponse], agate.Table]:
... ...
def get_compiler(self) -> Compiler_T: def get_compiler(self) -> Compiler_T:

View File

@@ -1,24 +0,0 @@
# this module exists to resolve circular imports with the events module
from collections import namedtuple
from typing import Any, Optional
_ReferenceKey = namedtuple("_ReferenceKey", "database schema identifier")
def lowercase(value: Optional[str]) -> Optional[str]:
if value is None:
return None
else:
return value.lower()
def _make_key(relation: Any) -> _ReferenceKey:
"""Make _ReferenceKeys with lowercase values for the cache so we don't have
to keep track of quoting
"""
# databases and schemas can both be None
return _ReferenceKey(
lowercase(relation.database), lowercase(relation.schema), lowercase(relation.identifier)
)

View File

@@ -1,15 +1,17 @@
import abc import abc
import time import time
from typing import List, Optional, Tuple, Any, Iterable, Dict from typing import List, Optional, Tuple, Any, Iterable, Dict, Union
import agate import agate
import dbt.clients.agate_helper import dbt.clients.agate_helper
import dbt.exceptions import dbt.exceptions
from dbt.adapters.base import BaseConnectionManager from dbt.adapters.base import BaseConnectionManager
from dbt.contracts.connection import Connection, ConnectionState, AdapterResponse from dbt.contracts.connection import (
from dbt.events.functions import fire_event Connection, ConnectionState, AdapterResponse
from dbt.events.types import ConnectionUsed, SQLQuery, SQLCommit, SQLQueryStatus )
from dbt.logger import GLOBAL_LOGGER as logger
from dbt import flags
class SQLConnectionManager(BaseConnectionManager): class SQLConnectionManager(BaseConnectionManager):
@@ -21,12 +23,11 @@ class SQLConnectionManager(BaseConnectionManager):
- get_response - get_response
- open - open
""" """
@abc.abstractmethod @abc.abstractmethod
def cancel(self, connection: Connection): def cancel(self, connection: Connection):
"""Cancel the given connection.""" """Cancel the given connection."""
raise dbt.exceptions.NotImplementedException( raise dbt.exceptions.NotImplementedException(
"`cancel` is not implemented for this adapter!" '`cancel` is not implemented for this adapter!'
) )
def cancel_open(self) -> List[str]: def cancel_open(self) -> List[str]:
@@ -39,7 +40,10 @@ class SQLConnectionManager(BaseConnectionManager):
# if the connection failed, the handle will be None so we have # if the connection failed, the handle will be None so we have
# nothing to cancel. # nothing to cancel.
if connection.handle is not None and connection.state == ConnectionState.OPEN: if (
connection.handle is not None and
connection.state == ConnectionState.OPEN
):
self.cancel(connection) self.cancel(connection)
if connection.name is not None: if connection.name is not None:
names.append(connection.name) names.append(connection.name)
@@ -50,58 +54,59 @@ class SQLConnectionManager(BaseConnectionManager):
sql: str, sql: str,
auto_begin: bool = True, auto_begin: bool = True,
bindings: Optional[Any] = None, bindings: Optional[Any] = None,
abridge_sql_log: bool = False, abridge_sql_log: bool = False
) -> Tuple[Connection, Any]: ) -> Tuple[Connection, Any]:
connection = self.get_thread_connection() connection = self.get_thread_connection()
if auto_begin and connection.transaction_open is False: if auto_begin and connection.transaction_open is False:
self.begin() self.begin()
fire_event(ConnectionUsed(conn_type=self.TYPE, conn_name=connection.name))
logger.debug('Using {} connection "{}".'
.format(self.TYPE, connection.name))
with self.exception_handler(sql): with self.exception_handler(sql):
if abridge_sql_log: if abridge_sql_log:
log_sql = "{}...".format(sql[:512]) log_sql = '{}...'.format(sql[:512])
else: else:
log_sql = sql log_sql = sql
fire_event(SQLQuery(conn_name=connection.name, sql=log_sql)) logger.debug(
'On {connection_name}: {sql}',
connection_name=connection.name,
sql=log_sql,
)
pre = time.time() pre = time.time()
cursor = connection.handle.cursor() cursor = connection.handle.cursor()
cursor.execute(sql, bindings) cursor.execute(sql, bindings)
logger.debug(
fire_event( "SQL status: {status} in {elapsed:0.2f} seconds",
SQLQueryStatus( status=self.get_response(cursor),
status=str(self.get_response(cursor)), elapsed=round((time.time() - pre), 2) elapsed=(time.time() - pre)
)
) )
return connection, cursor return connection, cursor
@classmethod @abc.abstractclassmethod
@abc.abstractmethod def get_response(cls, cursor: Any) -> Union[AdapterResponse, str]:
def get_response(cls, cursor: Any) -> AdapterResponse:
"""Get the status of the cursor.""" """Get the status of the cursor."""
raise dbt.exceptions.NotImplementedException( raise dbt.exceptions.NotImplementedException(
"`get_response` is not implemented for this adapter!" '`get_response` is not implemented for this adapter!'
) )
@classmethod @classmethod
def process_results( def process_results(
cls, column_names: Iterable[str], rows: Iterable[Any] cls,
column_names: Iterable[str],
rows: Iterable[Any]
) -> List[Dict[str, Any]]: ) -> List[Dict[str, Any]]:
# TODO CT-211 unique_col_names = dict()
unique_col_names = dict() # type: ignore[var-annotated] for idx in range(len(column_names)):
# TODO CT-211 col_name = column_names[idx]
for idx in range(len(column_names)): # type: ignore[arg-type]
# TODO CT-211
col_name = column_names[idx] # type: ignore[index]
if col_name in unique_col_names: if col_name in unique_col_names:
unique_col_names[col_name] += 1 unique_col_names[col_name] += 1
# TODO CT-211 column_names[idx] = f'{col_name}_{unique_col_names[col_name]}'
column_names[idx] = f"{col_name}_{unique_col_names[col_name]}" # type: ignore[index] # noqa
else: else:
# TODO CT-211 unique_col_names[column_names[idx]] = 1
unique_col_names[column_names[idx]] = 1 # type: ignore[index]
return [dict(zip(column_names, row)) for row in rows] return [dict(zip(column_names, row)) for row in rows]
@classmethod @classmethod
@@ -114,11 +119,14 @@ class SQLConnectionManager(BaseConnectionManager):
rows = cursor.fetchall() rows = cursor.fetchall()
data = cls.process_results(column_names, rows) data = cls.process_results(column_names, rows)
return dbt.clients.agate_helper.table_from_data_flat(data, column_names) return dbt.clients.agate_helper.table_from_data_flat(
data,
column_names
)
def execute( def execute(
self, sql: str, auto_begin: bool = False, fetch: bool = False self, sql: str, auto_begin: bool = False, fetch: bool = False
) -> Tuple[AdapterResponse, agate.Table]: ) -> Tuple[Union[AdapterResponse, str], agate.Table]:
sql = self._add_query_comment(sql) sql = self._add_query_comment(sql)
_, cursor = self.add_query(sql, auto_begin) _, cursor = self.add_query(sql, auto_begin)
response = self.get_response(cursor) response = self.get_response(cursor)
@@ -129,18 +137,24 @@ class SQLConnectionManager(BaseConnectionManager):
return response, table return response, table
def add_begin_query(self): def add_begin_query(self):
return self.add_query("BEGIN", auto_begin=False) return self.add_query('BEGIN', auto_begin=False)
def add_commit_query(self): def add_commit_query(self):
return self.add_query("COMMIT", auto_begin=False) return self.add_query('COMMIT', auto_begin=False)
def begin(self): def begin(self):
connection = self.get_thread_connection() connection = self.get_thread_connection()
if flags.STRICT_MODE:
if not isinstance(connection, Connection):
raise dbt.exceptions.CompilerException(
f'In begin, got {connection} - not a Connection!'
)
if connection.transaction_open is True: if connection.transaction_open is True:
raise dbt.exceptions.InternalException( raise dbt.exceptions.InternalException(
'Tried to begin a new transaction on connection "{}", but ' 'Tried to begin a new transaction on connection "{}", but '
"it already had one open!".format(connection.name) 'it already had one open!'.format(connection.name))
)
self.add_begin_query() self.add_begin_query()
@@ -149,13 +163,18 @@ class SQLConnectionManager(BaseConnectionManager):
def commit(self): def commit(self):
connection = self.get_thread_connection() connection = self.get_thread_connection()
if flags.STRICT_MODE:
if not isinstance(connection, Connection):
raise dbt.exceptions.CompilerException(
f'In commit, got {connection} - not a Connection!'
)
if connection.transaction_open is False: if connection.transaction_open is False:
raise dbt.exceptions.InternalException( raise dbt.exceptions.InternalException(
'Tried to commit transaction on connection "{}", but ' 'Tried to commit transaction on connection "{}", but '
"it does not have one open!".format(connection.name) 'it does not have one open!'.format(connection.name))
)
fire_event(SQLCommit(conn_name=connection.name)) logger.debug('On {}: COMMIT'.format(connection.name))
self.add_commit_query() self.add_commit_query()
connection.transaction_open = False connection.transaction_open = False

View File

@@ -5,29 +5,26 @@ import dbt.clients.agate_helper
from dbt.contracts.connection import Connection from dbt.contracts.connection import Connection
import dbt.exceptions import dbt.exceptions
from dbt.adapters.base import BaseAdapter, available from dbt.adapters.base import BaseAdapter, available
from dbt.adapters.cache import _make_key
from dbt.adapters.sql import SQLConnectionManager from dbt.adapters.sql import SQLConnectionManager
from dbt.events.functions import fire_event from dbt.logger import GLOBAL_LOGGER as logger
from dbt.events.types import ColTypeChange, SchemaCreation, SchemaDrop
from dbt.adapters.base.relation import BaseRelation from dbt.adapters.base.relation import BaseRelation
LIST_RELATIONS_MACRO_NAME = "list_relations_without_caching" LIST_RELATIONS_MACRO_NAME = 'list_relations_without_caching'
GET_COLUMNS_IN_RELATION_MACRO_NAME = "get_columns_in_relation" GET_COLUMNS_IN_RELATION_MACRO_NAME = 'get_columns_in_relation'
LIST_SCHEMAS_MACRO_NAME = "list_schemas" LIST_SCHEMAS_MACRO_NAME = 'list_schemas'
CHECK_SCHEMA_EXISTS_MACRO_NAME = "check_schema_exists" CHECK_SCHEMA_EXISTS_MACRO_NAME = 'check_schema_exists'
CREATE_SCHEMA_MACRO_NAME = "create_schema" CREATE_SCHEMA_MACRO_NAME = 'create_schema'
DROP_SCHEMA_MACRO_NAME = "drop_schema" DROP_SCHEMA_MACRO_NAME = 'drop_schema'
RENAME_RELATION_MACRO_NAME = "rename_relation" RENAME_RELATION_MACRO_NAME = 'rename_relation'
TRUNCATE_RELATION_MACRO_NAME = "truncate_relation" TRUNCATE_RELATION_MACRO_NAME = 'truncate_relation'
DROP_RELATION_MACRO_NAME = "drop_relation" DROP_RELATION_MACRO_NAME = 'drop_relation'
ALTER_COLUMN_TYPE_MACRO_NAME = "alter_column_type" ALTER_COLUMN_TYPE_MACRO_NAME = 'alter_column_type'
class SQLAdapter(BaseAdapter): class SQLAdapter(BaseAdapter):
"""The default adapter with the common agate conversions and some SQL """The default adapter with the common agate conversions and some SQL
methods was implemented. This adapter has a different much shorter list of methods implemented. This adapter has a different much shorter list of
methods to implement, but some more macros that must be implemented. methods to implement, but some more macros that must be implemented.
To implement a macro, implement "${adapter_type}__${macro_name}". in the To implement a macro, implement "${adapter_type}__${macro_name}". in the
@@ -63,24 +60,30 @@ class SQLAdapter(BaseAdapter):
:param abridge_sql_log: If set, limit the raw sql logged to 512 :param abridge_sql_log: If set, limit the raw sql logged to 512
characters characters
""" """
return self.connections.add_query(sql, auto_begin, bindings, abridge_sql_log) return self.connections.add_query(sql, auto_begin, bindings,
abridge_sql_log)
@classmethod @classmethod
def convert_text_type(cls, agate_table: agate.Table, col_idx: int) -> str: def convert_text_type(cls, agate_table: agate.Table, col_idx: int) -> str:
return "text" return "text"
@classmethod @classmethod
def convert_number_type(cls, agate_table: agate.Table, col_idx: int) -> str: def convert_number_type(
# TODO CT-211 cls, agate_table: agate.Table, col_idx: int
decimals = agate_table.aggregate(agate.MaxPrecision(col_idx)) # type: ignore[attr-defined] ) -> str:
decimals = agate_table.aggregate(agate.MaxPrecision(col_idx))
return "float8" if decimals else "integer" return "float8" if decimals else "integer"
@classmethod @classmethod
def convert_boolean_type(cls, agate_table: agate.Table, col_idx: int) -> str: def convert_boolean_type(
cls, agate_table: agate.Table, col_idx: int
) -> str:
return "boolean" return "boolean"
@classmethod @classmethod
def convert_datetime_type(cls, agate_table: agate.Table, col_idx: int) -> str: def convert_datetime_type(
cls, agate_table: agate.Table, col_idx: int
) -> str:
return "timestamp without time zone" return "timestamp without time zone"
@classmethod @classmethod
@@ -96,27 +99,31 @@ class SQLAdapter(BaseAdapter):
return True return True
def expand_column_types(self, goal, current): def expand_column_types(self, goal, current):
reference_columns = {c.name: c for c in self.get_columns_in_relation(goal)} reference_columns = {
c.name: c for c in
self.get_columns_in_relation(goal)
}
target_columns = {c.name: c for c in self.get_columns_in_relation(current)} target_columns = {
c.name: c for c
in self.get_columns_in_relation(current)
}
for column_name, reference_column in reference_columns.items(): for column_name, reference_column in reference_columns.items():
target_column = target_columns.get(column_name) target_column = target_columns.get(column_name)
if target_column is not None and target_column.can_expand_to(reference_column): if target_column is not None and \
target_column.can_expand_to(reference_column):
col_string_size = reference_column.string_size() col_string_size = reference_column.string_size()
new_type = self.Column.string_type(col_string_size) new_type = self.Column.string_type(col_string_size)
fire_event( logger.debug("Changing col type from {} to {} in table {}",
ColTypeChange( target_column.data_type, new_type, current)
orig_type=target_column.data_type,
new_type=new_type,
table=_make_key(current),
)
)
self.alter_column_type(current, column_name, new_type) self.alter_column_type(current, column_name, new_type)
def alter_column_type(self, relation, column_name, new_column_type) -> None: def alter_column_type(
self, relation, column_name, new_column_type
) -> None:
""" """
1. Create a new column (w/ temp name and correct type) 1. Create a new column (w/ temp name and correct type)
2. Copy data over to it 2. Copy data over to it
@@ -124,40 +131,53 @@ class SQLAdapter(BaseAdapter):
4. Rename the new column to existing column 4. Rename the new column to existing column
""" """
kwargs = { kwargs = {
"relation": relation, 'relation': relation,
"column_name": column_name, 'column_name': column_name,
"new_column_type": new_column_type, 'new_column_type': new_column_type,
} }
self.execute_macro(ALTER_COLUMN_TYPE_MACRO_NAME, kwargs=kwargs) self.execute_macro(
ALTER_COLUMN_TYPE_MACRO_NAME,
kwargs=kwargs
)
def drop_relation(self, relation): def drop_relation(self, relation):
if relation.type is None: if relation.type is None:
dbt.exceptions.raise_compiler_error( dbt.exceptions.raise_compiler_error(
"Tried to drop relation {}, but its type is null.".format(relation) 'Tried to drop relation {}, but its type is null.'
) .format(relation))
self.cache_dropped(relation) self.cache_dropped(relation)
self.execute_macro(DROP_RELATION_MACRO_NAME, kwargs={"relation": relation}) self.execute_macro(
DROP_RELATION_MACRO_NAME,
kwargs={'relation': relation}
)
def truncate_relation(self, relation): def truncate_relation(self, relation):
self.execute_macro(TRUNCATE_RELATION_MACRO_NAME, kwargs={"relation": relation}) self.execute_macro(
TRUNCATE_RELATION_MACRO_NAME,
kwargs={'relation': relation}
)
def rename_relation(self, from_relation, to_relation): def rename_relation(self, from_relation, to_relation):
self.cache_renamed(from_relation, to_relation) self.cache_renamed(from_relation, to_relation)
kwargs = {"from_relation": from_relation, "to_relation": to_relation} kwargs = {'from_relation': from_relation, 'to_relation': to_relation}
self.execute_macro(RENAME_RELATION_MACRO_NAME, kwargs=kwargs) self.execute_macro(
RENAME_RELATION_MACRO_NAME,
kwargs=kwargs
)
def get_columns_in_relation(self, relation): def get_columns_in_relation(self, relation):
return self.execute_macro( return self.execute_macro(
GET_COLUMNS_IN_RELATION_MACRO_NAME, kwargs={"relation": relation} GET_COLUMNS_IN_RELATION_MACRO_NAME,
kwargs={'relation': relation}
) )
def create_schema(self, relation: BaseRelation) -> None: def create_schema(self, relation: BaseRelation) -> None:
relation = relation.without_identifier() relation = relation.without_identifier()
fire_event(SchemaCreation(relation=_make_key(relation))) logger.debug('Creating schema "{}"', relation)
kwargs = { kwargs = {
"relation": relation, 'relation': relation,
} }
self.execute_macro(CREATE_SCHEMA_MACRO_NAME, kwargs=kwargs) self.execute_macro(CREATE_SCHEMA_MACRO_NAME, kwargs=kwargs)
self.commit_if_has_connection() self.commit_if_has_connection()
@@ -166,45 +186,51 @@ class SQLAdapter(BaseAdapter):
def drop_schema(self, relation: BaseRelation) -> None: def drop_schema(self, relation: BaseRelation) -> None:
relation = relation.without_identifier() relation = relation.without_identifier()
fire_event(SchemaDrop(relation=_make_key(relation))) logger.debug('Dropping schema "{}".', relation)
kwargs = { kwargs = {
"relation": relation, 'relation': relation,
} }
self.execute_macro(DROP_SCHEMA_MACRO_NAME, kwargs=kwargs) self.execute_macro(DROP_SCHEMA_MACRO_NAME, kwargs=kwargs)
self.commit_if_has_connection()
# we can update the cache here # we can update the cache here
self.cache.drop_schema(relation.database, relation.schema) self.cache.drop_schema(relation.database, relation.schema)
def list_relations_without_caching( def list_relations_without_caching(
self, self, schema_relation: BaseRelation,
schema_relation: BaseRelation,
) -> List[BaseRelation]: ) -> List[BaseRelation]:
kwargs = {"schema_relation": schema_relation} kwargs = {'schema_relation': schema_relation}
results = self.execute_macro(LIST_RELATIONS_MACRO_NAME, kwargs=kwargs) results = self.execute_macro(
LIST_RELATIONS_MACRO_NAME,
kwargs=kwargs
)
relations = [] relations = []
quote_policy = {"database": True, "schema": True, "identifier": True} quote_policy = {
'database': True,
'schema': True,
'identifier': True
}
for _database, name, _schema, _type in results: for _database, name, _schema, _type in results:
try: try:
_type = self.Relation.get_relation_type(_type) _type = self.Relation.get_relation_type(_type)
except ValueError: except ValueError:
_type = self.Relation.External _type = self.Relation.External
relations.append( relations.append(self.Relation.create(
self.Relation.create( database=_database,
database=_database, schema=_schema,
schema=_schema, identifier=name,
identifier=name, quote_policy=quote_policy,
quote_policy=quote_policy, type=_type
type=_type, ))
)
)
return relations return relations
def quote(self, identifier): def quote(self, identifier):
return '"{}"'.format(identifier) return '"{}"'.format(identifier)
def list_schemas(self, database: str) -> List[str]: def list_schemas(self, database: str) -> List[str]:
results = self.execute_macro(LIST_SCHEMAS_MACRO_NAME, kwargs={"database": database}) results = self.execute_macro(
LIST_SCHEMAS_MACRO_NAME,
kwargs={'database': database}
)
return [row[0] for row in results] return [row[0] for row in results]
@@ -212,32 +238,13 @@ class SQLAdapter(BaseAdapter):
information_schema = self.Relation.create( information_schema = self.Relation.create(
database=database, database=database,
schema=schema, schema=schema,
identifier="INFORMATION_SCHEMA", identifier='INFORMATION_SCHEMA',
quote_policy=self.config.quoting, quote_policy=self.config.quoting
).information_schema() ).information_schema()
kwargs = {"information_schema": information_schema, "schema": schema} kwargs = {'information_schema': information_schema, 'schema': schema}
results = self.execute_macro(CHECK_SCHEMA_EXISTS_MACRO_NAME, kwargs=kwargs) results = self.execute_macro(
CHECK_SCHEMA_EXISTS_MACRO_NAME,
kwargs=kwargs
)
return results[0][0] > 0 return results[0][0] > 0
# This is for use in the test suite
def run_sql_for_tests(self, sql, fetch, conn):
cursor = conn.handle.cursor()
try:
cursor.execute(sql)
if hasattr(conn.handle, "commit"):
conn.handle.commit()
if fetch == "one":
return cursor.fetchone()
elif fetch == "all":
return cursor.fetchall()
else:
return
except BaseException as e:
if conn.handle and not getattr(conn.handle, "closed", True):
conn.handle.rollback()
print(sql)
print(e)
raise
finally:
conn.transaction_open = False

View File

@@ -1 +0,0 @@
# Clients README

View File

@@ -10,83 +10,79 @@ def regex(pat):
class BlockData: class BlockData:
"""raw plaintext data from the top level of the file.""" """raw plaintext data from the top level of the file."""
def __init__(self, contents): def __init__(self, contents):
self.block_type_name = "__dbt__data" self.block_type_name = '__dbt__data'
self.contents = contents self.contents = contents
self.full_block = contents self.full_block = contents
class BlockTag: class BlockTag:
def __init__(self, block_type_name, block_name, contents=None, full_block=None, **kw): def __init__(self, block_type_name, block_name, contents=None,
full_block=None, **kw):
self.block_type_name = block_type_name self.block_type_name = block_type_name
self.block_name = block_name self.block_name = block_name
self.contents = contents self.contents = contents
self.full_block = full_block self.full_block = full_block
def __str__(self): def __str__(self):
return "BlockTag({!r}, {!r})".format(self.block_type_name, self.block_name) return 'BlockTag({!r}, {!r})'.format(self.block_type_name,
self.block_name)
def __repr__(self): def __repr__(self):
return str(self) return str(self)
@property @property
def end_block_type_name(self): def end_block_type_name(self):
return "end{}".format(self.block_type_name) return 'end{}'.format(self.block_type_name)
def end_pat(self): def end_pat(self):
# we don't want to use string formatting here because jinja uses most # we don't want to use string formatting here because jinja uses most
# of the string formatting operators in its syntax... # of the string formatting operators in its syntax...
pattern = "".join( pattern = ''.join((
( r'(?P<endblock>((?:\s*\{\%\-|\{\%)\s*',
r"(?P<endblock>((?:\s*\{\%\-|\{\%)\s*", self.end_block_type_name,
self.end_block_type_name, r'\s*(?:\-\%\}\s*|\%\})))',
r"\s*(?:\-\%\}\s*|\%\})))", ))
)
)
return regex(pattern) return regex(pattern)
Tag = namedtuple("Tag", "block_type_name block_name start end") Tag = namedtuple('Tag', 'block_type_name block_name start end')
_NAME_PATTERN = r"[A-Za-z_][A-Za-z_0-9]*" _NAME_PATTERN = r'[A-Za-z_][A-Za-z_0-9]*'
COMMENT_START_PATTERN = regex(r"(?:(?P<comment_start>(\s*\{\#)))") COMMENT_START_PATTERN = regex(r'(?:(?P<comment_start>(\s*\{\#)))')
COMMENT_END_PATTERN = regex(r"(.*?)(\s*\#\})") COMMENT_END_PATTERN = regex(r'(.*?)(\s*\#\})')
RAW_START_PATTERN = regex(r"(?:\s*\{\%\-|\{\%)\s*(?P<raw_start>(raw))\s*(?:\-\%\}\s*|\%\})") RAW_START_PATTERN = regex(
EXPR_START_PATTERN = regex(r"(?P<expr_start>(\{\{\s*))") r'(?:\s*\{\%\-|\{\%)\s*(?P<raw_start>(raw))\s*(?:\-\%\}\s*|\%\})'
EXPR_END_PATTERN = regex(r"(?P<expr_end>(\s*\}\}))")
BLOCK_START_PATTERN = regex(
"".join(
(
r"(?:\s*\{\%\-|\{\%)\s*",
r"(?P<block_type_name>({}))".format(_NAME_PATTERN),
# some blocks have a 'block name'.
r"(?:\s+(?P<block_name>({})))?".format(_NAME_PATTERN),
)
)
) )
EXPR_START_PATTERN = regex(r'(?P<expr_start>(\{\{\s*))')
EXPR_END_PATTERN = regex(r'(?P<expr_end>(\s*\}\}))')
BLOCK_START_PATTERN = regex(''.join((
r'(?:\s*\{\%\-|\{\%)\s*',
r'(?P<block_type_name>({}))'.format(_NAME_PATTERN),
# some blocks have a 'block name'.
r'(?:\s+(?P<block_name>({})))?'.format(_NAME_PATTERN),
)))
RAW_BLOCK_PATTERN = regex( RAW_BLOCK_PATTERN = regex(''.join((
"".join( r'(?:\s*\{\%\-|\{\%)\s*raw\s*(?:\-\%\}\s*|\%\})',
( r'(?:.*?)',
r"(?:\s*\{\%\-|\{\%)\s*raw\s*(?:\-\%\}\s*|\%\})", r'(?:\s*\{\%\-|\{\%)\s*endraw\s*(?:\-\%\}\s*|\%\})',
r"(?:.*?)", )))
r"(?:\s*\{\%\-|\{\%)\s*endraw\s*(?:\-\%\}\s*|\%\})",
)
)
)
TAG_CLOSE_PATTERN = regex(r"(?:(?P<tag_close>(\-\%\}\s*|\%\})))") TAG_CLOSE_PATTERN = regex(r'(?:(?P<tag_close>(\-\%\}\s*|\%\})))')
# stolen from jinja's lexer. Note that we've consumed all prefix whitespace by # stolen from jinja's lexer. Note that we've consumed all prefix whitespace by
# the time we want to use this. # the time we want to use this.
STRING_PATTERN = regex(r"(?P<string>('([^'\\]*(?:\\.[^'\\]*)*)'|" r'"([^"\\]*(?:\\.[^"\\]*)*)"))') STRING_PATTERN = regex(
r"(?P<string>('([^'\\]*(?:\\.[^'\\]*)*)'|"
r'"([^"\\]*(?:\\.[^"\\]*)*)"))'
)
QUOTE_START_PATTERN = regex(r"""(?P<quote>(['"]))""") QUOTE_START_PATTERN = regex(r'''(?P<quote>(['"]))''')
class TagIterator: class TagIterator:
@@ -103,10 +99,10 @@ class TagIterator:
end_val: int = self.pos if end is None else end end_val: int = self.pos if end is None else end
data = self.data[:end_val] data = self.data[:end_val]
# if not found, rfind returns -1, and -1+1=0, which is perfect! # if not found, rfind returns -1, and -1+1=0, which is perfect!
last_line_start = data.rfind("\n") + 1 last_line_start = data.rfind('\n') + 1
# it's easy to forget this, but line numbers are 1-indexed # it's easy to forget this, but line numbers are 1-indexed
line_number = data.count("\n") + 1 line_number = data.count('\n') + 1
return f"{line_number}:{end_val - last_line_start}" return f'{line_number}:{end_val - last_line_start}'
def advance(self, new_position): def advance(self, new_position):
self.pos = new_position self.pos = new_position
@@ -124,7 +120,7 @@ class TagIterator:
matches = [] matches = []
for pattern in patterns: for pattern in patterns:
# default to 'search', but sometimes we want to 'match'. # default to 'search', but sometimes we want to 'match'.
if kwargs.get("method", "search") == "search": if kwargs.get('method', 'search') == 'search':
match = self._search(pattern) match = self._search(pattern)
else: else:
match = self._match(pattern) match = self._match(pattern)
@@ -140,7 +136,7 @@ class TagIterator:
match = self._first_match(*patterns, **kwargs) match = self._first_match(*patterns, **kwargs)
if match is None: if match is None:
msg = 'unexpected EOF, expected {}, got "{}"'.format( msg = 'unexpected EOF, expected {}, got "{}"'.format(
expected_name, self.data[self.pos :] expected_name, self.data[self.pos:]
) )
dbt.exceptions.raise_compiler_error(msg) dbt.exceptions.raise_compiler_error(msg)
return match return match
@@ -160,20 +156,22 @@ class TagIterator:
""" """
self.advance(match.end()) self.advance(match.end())
while True: while True:
match = self._expect_match("}}", EXPR_END_PATTERN, QUOTE_START_PATTERN) match = self._expect_match('}}',
if match.groupdict().get("expr_end") is not None: EXPR_END_PATTERN,
QUOTE_START_PATTERN)
if match.groupdict().get('expr_end') is not None:
break break
else: else:
# it's a quote. we haven't advanced for this match yet, so # it's a quote. we haven't advanced for this match yet, so
# just slurp up the whole string, no need to rewind. # just slurp up the whole string, no need to rewind.
match = self._expect_match("string", STRING_PATTERN) match = self._expect_match('string', STRING_PATTERN)
self.advance(match.end()) self.advance(match.end())
self.advance(match.end()) self.advance(match.end())
def handle_comment(self, match): def handle_comment(self, match):
self.advance(match.end()) self.advance(match.end())
match = self._expect_match("#}", COMMENT_END_PATTERN) match = self._expect_match('#}', COMMENT_END_PATTERN)
self.advance(match.end()) self.advance(match.end())
def _expect_block_close(self): def _expect_block_close(self):
@@ -190,19 +188,22 @@ class TagIterator:
""" """
while True: while True:
end_match = self._expect_match( end_match = self._expect_match(
'tag close ("%}")', QUOTE_START_PATTERN, TAG_CLOSE_PATTERN 'tag close ("%}")',
QUOTE_START_PATTERN,
TAG_CLOSE_PATTERN
) )
self.advance(end_match.end()) self.advance(end_match.end())
if end_match.groupdict().get("tag_close") is not None: if end_match.groupdict().get('tag_close') is not None:
return return
# must be a string. Rewind to its start and advance past it. # must be a string. Rewind to its start and advance past it.
self.rewind() self.rewind()
string_match = self._expect_match("string", STRING_PATTERN) string_match = self._expect_match('string', STRING_PATTERN)
self.advance(string_match.end()) self.advance(string_match.end())
def handle_raw(self): def handle_raw(self):
# raw blocks are super special, they are a single complete regex # raw blocks are super special, they are a single complete regex
match = self._expect_match("{% raw %}...{% endraw %}", RAW_BLOCK_PATTERN) match = self._expect_match('{% raw %}...{% endraw %}',
RAW_BLOCK_PATTERN)
self.advance(match.end()) self.advance(match.end())
return match.end() return match.end()
@@ -219,24 +220,30 @@ class TagIterator:
""" """
groups = match.groupdict() groups = match.groupdict()
# always a value # always a value
block_type_name = groups["block_type_name"] block_type_name = groups['block_type_name']
# might be None # might be None
block_name = groups.get("block_name") block_name = groups.get('block_name')
start_pos = self.pos start_pos = self.pos
if block_type_name == "raw": if block_type_name == 'raw':
match = self._expect_match("{% raw %}...{% endraw %}", RAW_BLOCK_PATTERN) match = self._expect_match('{% raw %}...{% endraw %}',
RAW_BLOCK_PATTERN)
self.advance(match.end()) self.advance(match.end())
else: else:
self.advance(match.end()) self.advance(match.end())
self._expect_block_close() self._expect_block_close()
return Tag( return Tag(
block_type_name=block_type_name, block_name=block_name, start=start_pos, end=self.pos block_type_name=block_type_name,
block_name=block_name,
start=start_pos,
end=self.pos
) )
def find_tags(self): def find_tags(self):
while True: while True:
match = self._first_match( match = self._first_match(
BLOCK_START_PATTERN, COMMENT_START_PATTERN, EXPR_START_PATTERN BLOCK_START_PATTERN,
COMMENT_START_PATTERN,
EXPR_START_PATTERN
) )
if match is None: if match is None:
break break
@@ -245,9 +252,9 @@ class TagIterator:
# start = self.pos # start = self.pos
groups = match.groupdict() groups = match.groupdict()
comment_start = groups.get("comment_start") comment_start = groups.get('comment_start')
expr_start = groups.get("expr_start") expr_start = groups.get('expr_start')
block_type_name = groups.get("block_type_name") block_type_name = groups.get('block_type_name')
if comment_start is not None: if comment_start is not None:
self.handle_comment(match) self.handle_comment(match)
@@ -257,8 +264,8 @@ class TagIterator:
yield self.handle_tag(match) yield self.handle_tag(match)
else: else:
raise dbt.exceptions.InternalException( raise dbt.exceptions.InternalException(
"Invalid regex match in next_block, expected block start, " 'Invalid regex match in next_block, expected block start, '
"expr start, or comment start" 'expr start, or comment start'
) )
def __iter__(self): def __iter__(self):
@@ -266,18 +273,21 @@ class TagIterator:
duplicate_tags = ( duplicate_tags = (
"Got nested tags: {outer.block_type_name} (started at {outer.start}) did " 'Got nested tags: {outer.block_type_name} (started at {outer.start}) did '
"not have a matching {{% end{outer.block_type_name} %}} before a " 'not have a matching {{% end{outer.block_type_name} %}} before a '
"subsequent {inner.block_type_name} was found (started at {inner.start})" 'subsequent {inner.block_type_name} was found (started at {inner.start})'
) )
_CONTROL_FLOW_TAGS = { _CONTROL_FLOW_TAGS = {
"if": "endif", 'if': 'endif',
"for": "endfor", 'for': 'endfor',
} }
_CONTROL_FLOW_END_TAGS = {v: k for k, v in _CONTROL_FLOW_TAGS.items()} _CONTROL_FLOW_END_TAGS = {
v: k
for k, v in _CONTROL_FLOW_TAGS.items()
}
class BlockIterator: class BlockIterator:
@@ -300,15 +310,15 @@ class BlockIterator:
def is_current_end(self, tag): def is_current_end(self, tag):
return ( return (
tag.block_type_name.startswith("end") tag.block_type_name.startswith('end') and
and self.current is not None self.current is not None and
and tag.block_type_name[3:] == self.current.block_type_name tag.block_type_name[3:] == self.current.block_type_name
) )
def find_blocks(self, allowed_blocks=None, collect_raw_data=True): def find_blocks(self, allowed_blocks=None, collect_raw_data=True):
"""Find all top-level blocks in the data.""" """Find all top-level blocks in the data."""
if allowed_blocks is None: if allowed_blocks is None:
allowed_blocks = {"snapshot", "macro", "materialization", "docs"} allowed_blocks = {'snapshot', 'macro', 'materialization', 'docs'}
for tag in self.tag_parser.find_tags(): for tag in self.tag_parser.find_tags():
if tag.block_type_name in _CONTROL_FLOW_TAGS: if tag.block_type_name in _CONTROL_FLOW_TAGS:
@@ -319,35 +329,37 @@ class BlockIterator:
found = self.stack.pop() found = self.stack.pop()
else: else:
expected = _CONTROL_FLOW_END_TAGS[tag.block_type_name] expected = _CONTROL_FLOW_END_TAGS[tag.block_type_name]
dbt.exceptions.raise_compiler_error( dbt.exceptions.raise_compiler_error((
( 'Got an unexpected control flow end tag, got {} but '
"Got an unexpected control flow end tag, got {} but " 'never saw a preceeding {} (@ {})'
"never saw a preceeding {} (@ {})" ).format(
).format(tag.block_type_name, expected, self.tag_parser.linepos(tag.start)) tag.block_type_name,
) expected,
self.tag_parser.linepos(tag.start)
))
expected = _CONTROL_FLOW_TAGS[found] expected = _CONTROL_FLOW_TAGS[found]
if expected != tag.block_type_name: if expected != tag.block_type_name:
dbt.exceptions.raise_compiler_error( dbt.exceptions.raise_compiler_error((
( 'Got an unexpected control flow end tag, got {} but '
"Got an unexpected control flow end tag, got {} but " 'expected {} next (@ {})'
"expected {} next (@ {})" ).format(
).format(tag.block_type_name, expected, self.tag_parser.linepos(tag.start)) tag.block_type_name,
) expected,
self.tag_parser.linepos(tag.start)
))
if tag.block_type_name in allowed_blocks: if tag.block_type_name in allowed_blocks:
if self.stack: if self.stack:
dbt.exceptions.raise_compiler_error( dbt.exceptions.raise_compiler_error((
( 'Got a block definition inside control flow at {}. '
"Got a block definition inside control flow at {}. " 'All dbt block definitions must be at the top level'
"All dbt block definitions must be at the top level" ).format(self.tag_parser.linepos(tag.start)))
).format(self.tag_parser.linepos(tag.start))
)
if self.current is not None: if self.current is not None:
dbt.exceptions.raise_compiler_error( dbt.exceptions.raise_compiler_error(
duplicate_tags.format(outer=self.current, inner=tag) duplicate_tags.format(outer=self.current, inner=tag)
) )
if collect_raw_data: if collect_raw_data:
raw_data = self.data[self.last_position : tag.start] raw_data = self.data[self.last_position:tag.start]
self.last_position = tag.start self.last_position = tag.start
if raw_data: if raw_data:
yield BlockData(raw_data) yield BlockData(raw_data)
@@ -359,25 +371,23 @@ class BlockIterator:
yield BlockTag( yield BlockTag(
block_type_name=self.current.block_type_name, block_type_name=self.current.block_type_name,
block_name=self.current.block_name, block_name=self.current.block_name,
contents=self.data[self.current.end : tag.start], contents=self.data[self.current.end:tag.start],
full_block=self.data[self.current.start : tag.end], full_block=self.data[self.current.start:tag.end]
) )
self.current = None self.current = None
if self.current: if self.current:
linecount = self.data[: self.current.end].count("\n") + 1 linecount = self.data[:self.current.end].count('\n') + 1
dbt.exceptions.raise_compiler_error( dbt.exceptions.raise_compiler_error((
( 'Reached EOF without finding a close tag for '
"Reached EOF without finding a close tag for " "{} (searched from line {})" '{} (searched from line {})'
).format(self.current.block_type_name, linecount) ).format(self.current.block_type_name, linecount))
)
if collect_raw_data: if collect_raw_data:
raw_data = self.data[self.last_position :] raw_data = self.data[self.last_position:]
if raw_data: if raw_data:
yield BlockData(raw_data) yield BlockData(raw_data)
def lex_for_blocks(self, allowed_blocks=None, collect_raw_data=True): def lex_for_blocks(self, allowed_blocks=None, collect_raw_data=True):
return list( return list(self.find_blocks(allowed_blocks=allowed_blocks,
self.find_blocks(allowed_blocks=allowed_blocks, collect_raw_data=collect_raw_data) collect_raw_data=collect_raw_data))
)

View File

@@ -10,17 +10,7 @@ from typing import Iterable, List, Dict, Union, Optional, Any
from dbt.exceptions import RuntimeException from dbt.exceptions import RuntimeException
BOM = BOM_UTF8.decode("utf-8") # '\ufeff' BOM = BOM_UTF8.decode('utf-8') # '\ufeff'
class Number(agate.data_types.Number):
# undo the change in https://github.com/wireservice/agate/pull/733
# i.e. do not cast True and False to numeric 1 and 0
def cast(self, d):
if type(d) == bool:
raise agate.exceptions.CastError("Do not cast True to 1 or False to 0.")
else:
return super().cast(d)
class ISODateTime(agate.data_types.DateTime): class ISODateTime(agate.data_types.DateTime):
@@ -40,24 +30,32 @@ class ISODateTime(agate.data_types.DateTime):
except: # noqa except: # noqa
pass pass
raise agate.exceptions.CastError('Can not parse value "%s" as datetime.' % d) raise agate.exceptions.CastError(
'Can not parse value "%s" as datetime.' % d
)
def build_type_tester( def build_type_tester(
text_columns: Iterable[str], string_null_values: Optional[Iterable[str]] = ("null", "") text_columns: Iterable[str],
string_null_values: Optional[Iterable[str]] = ('null', '')
) -> agate.TypeTester: ) -> agate.TypeTester:
types = [ types = [
Number(null_values=("null", "")), agate.data_types.Number(null_values=('null', '')),
agate.data_types.Date(null_values=("null", ""), date_format="%Y-%m-%d"), agate.data_types.Date(null_values=('null', ''),
agate.data_types.DateTime(null_values=("null", ""), datetime_format="%Y-%m-%d %H:%M:%S"), date_format='%Y-%m-%d'),
ISODateTime(null_values=("null", "")), agate.data_types.DateTime(null_values=('null', ''),
agate.data_types.Boolean( datetime_format='%Y-%m-%d %H:%M:%S'),
true_values=("true",), false_values=("false",), null_values=("null", "") ISODateTime(null_values=('null', '')),
), agate.data_types.Boolean(true_values=('true',),
agate.data_types.Text(null_values=string_null_values), false_values=('false',),
null_values=('null', '')),
agate.data_types.Text(null_values=string_null_values)
] ]
force = {k: agate.data_types.Text(null_values=string_null_values) for k in text_columns} force = {
k: agate.data_types.Text(null_values=string_null_values)
for k in text_columns
}
return agate.TypeTester(force=force, types=types) return agate.TypeTester(force=force, types=types)
@@ -74,13 +72,16 @@ def table_from_rows(
else: else:
# If text_only_columns are present, prevent coercing empty string or # If text_only_columns are present, prevent coercing empty string or
# literal 'null' strings to a None representation. # literal 'null' strings to a None representation.
column_types = build_type_tester(text_only_columns, string_null_values=()) column_types = build_type_tester(
text_only_columns,
string_null_values=()
)
return agate.Table(rows, column_names, column_types=column_types) return agate.Table(rows, column_names, column_types=column_types)
def table_from_data(data, column_names: Iterable[str]) -> agate.Table: def table_from_data(data, column_names: Iterable[str]) -> agate.Table:
"Convert a list of dictionaries into an Agate table" "Convert list of dictionaries into an Agate table"
# The agate table is generated from a list of dicts, so the column order # The agate table is generated from a list of dicts, so the column order
# from `data` is not preserved. We can use `select` to reorder the columns # from `data` is not preserved. We can use `select` to reorder the columns
@@ -119,7 +120,9 @@ def table_from_data_flat(data, column_names: Iterable[str]) -> agate.Table:
rows.append(row) rows.append(row)
return table_from_rows( return table_from_rows(
rows=rows, column_names=column_names, text_only_columns=text_only_columns rows=rows,
column_names=column_names,
text_only_columns=text_only_columns
) )
@@ -137,7 +140,7 @@ def as_matrix(table):
def from_csv(abspath, text_columns): def from_csv(abspath, text_columns):
type_tester = build_type_tester(text_columns=text_columns) type_tester = build_type_tester(text_columns=text_columns)
with open(abspath, encoding="utf-8") as fp: with open(abspath, encoding='utf-8') as fp:
if fp.read(1) != BOM: if fp.read(1) != BOM:
fp.seek(0) fp.seek(0)
return agate.Table.from_csv(fp, column_types=type_tester) return agate.Table.from_csv(fp, column_types=type_tester)
@@ -169,8 +172,8 @@ class ColumnTypeBuilder(Dict[str, NullableAgateType]):
elif not isinstance(value, type(existing_type)): elif not isinstance(value, type(existing_type)):
# actual type mismatch! # actual type mismatch!
raise RuntimeException( raise RuntimeException(
f"Tables contain columns with the same names ({key}), " f'Tables contain columns with the same names ({key}), '
f"but different types ({value} vs {existing_type})" f'but different types ({value} vs {existing_type})'
) )
def finalize(self) -> Dict[str, agate.data_types.DataType]: def finalize(self) -> Dict[str, agate.data_types.DataType]:
@@ -184,7 +187,9 @@ class ColumnTypeBuilder(Dict[str, NullableAgateType]):
return result return result
def _merged_column_types(tables: List[agate.Table]) -> Dict[str, agate.data_types.DataType]: def _merged_column_types(
tables: List[agate.Table]
) -> Dict[str, agate.data_types.DataType]:
# this is a lot like agate.Table.merge, but with handling for all-null # this is a lot like agate.Table.merge, but with handling for all-null
# rows being "any type". # rows being "any type".
new_columns: ColumnTypeBuilder = ColumnTypeBuilder() new_columns: ColumnTypeBuilder = ColumnTypeBuilder()
@@ -210,7 +215,10 @@ def merge_tables(tables: List[agate.Table]) -> agate.Table:
rows: List[agate.Row] = [] rows: List[agate.Row] = []
for table in tables: for table in tables:
if table.column_names == column_names and table.column_types == column_types: if (
table.column_names == column_names and
table.column_types == column_types
):
rows.extend(table.rows) rows.extend(table.rows)
else: else:
for row in table.rows: for row in table.rows:

View File

@@ -0,0 +1,26 @@
from dbt.logger import GLOBAL_LOGGER as logger
import dbt.exceptions
from dbt.clients.system import run_cmd
NOT_INSTALLED_MSG = """
dbt requires the gcloud SDK to be installed to authenticate with BigQuery.
Please download and install the SDK, or use a Service Account instead.
https://cloud.google.com/sdk/
"""
def gcloud_installed():
try:
run_cmd('.', ['gcloud', '--version'])
return True
except OSError as e:
logger.debug(e)
return False
def setup_default_credentials():
if gcloud_installed():
run_cmd('.', ["gcloud", "auth", "application-default", "login"])
else:
raise dbt.exceptions.RuntimeException(NOT_INSTALLED_MSG)

View File

@@ -2,23 +2,8 @@ import re
import os.path import os.path
from dbt.clients.system import run_cmd, rmdir from dbt.clients.system import run_cmd, rmdir
from dbt.events.functions import fire_event from dbt.logger import GLOBAL_LOGGER as logger
from dbt.events.types import ( import dbt.exceptions
GitSparseCheckoutSubdirectory,
GitProgressCheckoutRevision,
GitProgressUpdatingExistingDependency,
GitProgressPullingNewDependency,
GitNothingToDo,
GitProgressUpdatedCheckoutRange,
GitProgressCheckedOutAt,
)
from dbt.exceptions import (
CommandResultError,
RuntimeException,
bad_package_spec,
raise_git_cloning_error,
raise_git_cloning_problem,
)
from packaging import version from packaging import version
@@ -27,24 +12,14 @@ def _is_commit(revision: str) -> bool:
return bool(re.match(r"\b[0-9a-f]{40}\b", revision)) return bool(re.match(r"\b[0-9a-f]{40}\b", revision))
def _raise_git_cloning_error(repo, revision, error):
stderr = error.stderr.strip()
if "usage: git" in stderr:
stderr = stderr.split("\nusage: git")[0]
if re.match("fatal: destination path '(.+)' already exists", stderr):
raise_git_cloning_error(error)
bad_package_spec(repo, revision, stderr)
def clone(repo, cwd, dirname=None, remove_git_dir=False, revision=None, subdirectory=None): def clone(repo, cwd, dirname=None, remove_git_dir=False, revision=None, subdirectory=None):
has_revision = revision is not None has_revision = revision is not None
is_commit = _is_commit(revision or "") is_commit = _is_commit(revision or "")
clone_cmd = ["git", "clone", "--depth", "1"] clone_cmd = ['git', 'clone', '--depth', '1']
if subdirectory: if subdirectory:
fire_event(GitSparseCheckoutSubdirectory(subdir=subdirectory)) logger.debug(' Subdirectory specified: {}, using sparse checkout.'.format(subdirectory))
out, _ = run_cmd(cwd, ["git", "--version"], env={"LC_ALL": "C"}) out, _ = run_cmd(cwd, ['git', '--version'], env={'LC_ALL': 'C'})
git_version = version.parse(re.search(r"\d+\.\d+\.\d+", out.decode("utf-8")).group(0)) git_version = version.parse(re.search(r"\d+\.\d+\.\d+", out.decode("utf-8")).group(0))
if not git_version >= version.parse("2.25.0"): if not git_version >= version.parse("2.25.0"):
# 2.25.0 introduces --sparse # 2.25.0 introduces --sparse
@@ -52,86 +27,78 @@ def clone(repo, cwd, dirname=None, remove_git_dir=False, revision=None, subdirec
"Please update your git version to pull a dbt package " "Please update your git version to pull a dbt package "
"from a subdirectory: your version is {}, >= 2.25.0 needed".format(git_version) "from a subdirectory: your version is {}, >= 2.25.0 needed".format(git_version)
) )
clone_cmd.extend(["--filter=blob:none", "--sparse"]) clone_cmd.extend(['--filter=blob:none', '--sparse'])
if has_revision and not is_commit: if has_revision and not is_commit:
clone_cmd.extend(["--branch", revision]) clone_cmd.extend(['--branch', revision])
clone_cmd.append(repo) clone_cmd.append(repo)
if dirname is not None: if dirname is not None:
clone_cmd.append(dirname) clone_cmd.append(dirname)
try: result = run_cmd(cwd, clone_cmd, env={'LC_ALL': 'C'})
result = run_cmd(cwd, clone_cmd, env={"LC_ALL": "C"})
except CommandResultError as exc:
_raise_git_cloning_error(repo, revision, exc)
if subdirectory: if subdirectory:
cwd_subdir = os.path.join(cwd, dirname or "") run_cmd(os.path.join(cwd, dirname or ''), ['git', 'sparse-checkout', 'set', subdirectory])
clone_cmd_subdir = ["git", "sparse-checkout", "set", subdirectory]
try:
run_cmd(cwd_subdir, clone_cmd_subdir)
except CommandResultError as exc:
_raise_git_cloning_error(repo, revision, exc)
if remove_git_dir: if remove_git_dir:
rmdir(os.path.join(dirname, ".git")) rmdir(os.path.join(dirname, '.git'))
return result return result
def list_tags(cwd): def list_tags(cwd):
out, err = run_cmd(cwd, ["git", "tag", "--list"], env={"LC_ALL": "C"}) out, err = run_cmd(cwd, ['git', 'tag', '--list'], env={'LC_ALL': 'C'})
tags = out.decode("utf-8").strip().split("\n") tags = out.decode('utf-8').strip().split("\n")
return tags return tags
def _checkout(cwd, repo, revision): def _checkout(cwd, repo, revision):
fire_event(GitProgressCheckoutRevision(revision=revision)) logger.debug(' Checking out revision {}.'.format(revision))
fetch_cmd = ["git", "fetch", "origin", "--depth", "1"] fetch_cmd = ["git", "fetch", "origin", "--depth", "1"]
if _is_commit(revision): if _is_commit(revision):
run_cmd(cwd, fetch_cmd + [revision]) run_cmd(cwd, fetch_cmd + [revision])
else: else:
run_cmd(cwd, ["git", "remote", "set-branches", "origin", revision]) run_cmd(cwd, ['git', 'remote', 'set-branches', 'origin', revision])
run_cmd(cwd, fetch_cmd + ["--tags", revision]) run_cmd(cwd, fetch_cmd + ["--tags", revision])
if _is_commit(revision): if _is_commit(revision):
spec = revision spec = revision
# Prefer tags to branches if one exists # Prefer tags to branches if one exists
elif revision in list_tags(cwd): elif revision in list_tags(cwd):
spec = "tags/{}".format(revision) spec = 'tags/{}'.format(revision)
else: else:
spec = "origin/{}".format(revision) spec = 'origin/{}'.format(revision)
out, err = run_cmd(cwd, ["git", "reset", "--hard", spec], env={"LC_ALL": "C"}) out, err = run_cmd(cwd, ['git', 'reset', '--hard', spec],
env={'LC_ALL': 'C'})
return out, err return out, err
def checkout(cwd, repo, revision=None): def checkout(cwd, repo, revision=None):
if revision is None: if revision is None:
revision = "HEAD" revision = 'HEAD'
try: try:
return _checkout(cwd, repo, revision) return _checkout(cwd, repo, revision)
except CommandResultError as exc: except dbt.exceptions.CommandResultError as exc:
stderr = exc.stderr.strip() stderr = exc.stderr.decode('utf-8').strip()
bad_package_spec(repo, revision, stderr) dbt.exceptions.bad_package_spec(repo, revision, stderr)
def get_current_sha(cwd): def get_current_sha(cwd):
out, err = run_cmd(cwd, ["git", "rev-parse", "HEAD"], env={"LC_ALL": "C"}) out, err = run_cmd(cwd, ['git', 'rev-parse', 'HEAD'], env={'LC_ALL': 'C'})
return out.decode("utf-8") return out.decode('utf-8')
def remove_remote(cwd): def remove_remote(cwd):
return run_cmd(cwd, ["git", "remote", "rm", "origin"], env={"LC_ALL": "C"}) return run_cmd(cwd, ['git', 'remote', 'rm', 'origin'], env={'LC_ALL': 'C'})
def clone_and_checkout( def clone_and_checkout(repo, cwd, dirname=None, remove_git_dir=False,
repo, cwd, dirname=None, remove_git_dir=False, revision=None, subdirectory=None revision=None, subdirectory=None):
):
exists = None exists = None
try: try:
_, err = clone( _, err = clone(
@@ -141,34 +108,35 @@ def clone_and_checkout(
remove_git_dir=remove_git_dir, remove_git_dir=remove_git_dir,
subdirectory=subdirectory, subdirectory=subdirectory,
) )
except CommandResultError as exc: except dbt.exceptions.CommandResultError as exc:
err = exc.stderr err = exc.stderr.decode('utf-8')
exists = re.match("fatal: destination path '(.+)' already exists", err) exists = re.match("fatal: destination path '(.+)' already exists", err)
if not exists: if not exists: # something else is wrong, raise it
raise_git_cloning_problem(repo) raise
directory = None directory = None
start_sha = None start_sha = None
if exists: if exists:
directory = exists.group(1) directory = exists.group(1)
fire_event(GitProgressUpdatingExistingDependency(dir=directory)) logger.debug('Updating existing dependency {}.', directory)
else: else:
matches = re.match("Cloning into '(.+)'", err.decode("utf-8")) matches = re.match("Cloning into '(.+)'", err.decode('utf-8'))
if matches is None: if matches is None:
raise RuntimeException(f'Error cloning {repo} - never saw "Cloning into ..." from git') raise dbt.exceptions.RuntimeException(
f'Error cloning {repo} - never saw "Cloning into ..." from git'
)
directory = matches.group(1) directory = matches.group(1)
fire_event(GitProgressPullingNewDependency(dir=directory)) logger.debug('Pulling new dependency {}.', directory)
full_path = os.path.join(cwd, directory) full_path = os.path.join(cwd, directory)
start_sha = get_current_sha(full_path) start_sha = get_current_sha(full_path)
checkout(full_path, repo, revision) checkout(full_path, repo, revision)
end_sha = get_current_sha(full_path) end_sha = get_current_sha(full_path)
if exists: if exists:
if start_sha == end_sha: if start_sha == end_sha:
fire_event(GitNothingToDo(sha=start_sha[:7])) logger.debug(' Already at {}, nothing to do.', start_sha[:7])
else: else:
fire_event( logger.debug(' Updated checkout from {} to {}.',
GitProgressUpdatedCheckoutRange(start_sha=start_sha[:7], end_sha=end_sha[:7]) start_sha[:7], end_sha[:7])
)
else: else:
fire_event(GitProgressCheckedOutAt(end_sha=end_sha[:7])) logger.debug(' Checked out at {}.', end_sha[:7])
return os.path.join(directory, subdirectory or "") return os.path.join(directory, subdirectory or '')

View File

@@ -7,7 +7,10 @@ import threading
from ast import literal_eval from ast import literal_eval
from contextlib import contextmanager from contextlib import contextmanager
from itertools import chain, islice from itertools import chain, islice
from typing import List, Union, Set, Optional, Dict, Any, Iterator, Type, NoReturn, Tuple, Callable from typing import (
List, Union, Set, Optional, Dict, Any, Iterator, Type, NoReturn, Tuple,
Callable
)
import jinja2 import jinja2
import jinja2.ext import jinja2.ext
@@ -17,26 +20,20 @@ import jinja2.parser
import jinja2.sandbox import jinja2.sandbox
from dbt.utils import ( from dbt.utils import (
get_dbt_macro_name, get_dbt_macro_name, get_docs_macro_name, get_materialization_macro_name,
get_docs_macro_name, get_test_macro_name, deep_map
get_materialization_macro_name,
get_test_macro_name,
deep_map_render,
) )
from dbt.clients._jinja_blocks import BlockIterator, BlockData, BlockTag from dbt.clients._jinja_blocks import BlockIterator, BlockData, BlockTag
from dbt.contracts.graph.compiled import CompiledGenericTestNode from dbt.contracts.graph.compiled import CompiledSchemaTestNode
from dbt.contracts.graph.parsed import ParsedGenericTestNode from dbt.contracts.graph.parsed import ParsedSchemaTestNode
from dbt.exceptions import ( from dbt.exceptions import (
InternalException, InternalException, raise_compiler_error, CompilationException,
raise_compiler_error, invalid_materialization_argument, MacroReturn, JinjaRenderingException,
CompilationException, UndefinedMacroException
invalid_materialization_argument,
MacroReturn,
JinjaRenderingException,
UndefinedMacroException,
) )
from dbt import flags from dbt import flags
from dbt.logger import GLOBAL_LOGGER as logger # noqa
def _linecache_inject(source, write): def _linecache_inject(source, write):
@@ -44,22 +41,27 @@ def _linecache_inject(source, write):
# this is the only reliable way to accomplish this. Obviously, it's # this is the only reliable way to accomplish this. Obviously, it's
# really darn noisy and will fill your temporary directory # really darn noisy and will fill your temporary directory
tmp_file = tempfile.NamedTemporaryFile( tmp_file = tempfile.NamedTemporaryFile(
prefix="dbt-macro-compiled-", prefix='dbt-macro-compiled-',
suffix=".py", suffix='.py',
delete=False, delete=False,
mode="w+", mode='w+',
encoding="utf-8", encoding='utf-8',
) )
tmp_file.write(source) tmp_file.write(source)
filename = tmp_file.name filename = tmp_file.name
else: else:
# `codecs.encode` actually takes a `bytes` as the first argument if # `codecs.encode` actually takes a `bytes` as the first argument if
# the second argument is 'hex' - mypy does not know this. # the second argument is 'hex' - mypy does not know this.
rnd = codecs.encode(os.urandom(12), "hex") # type: ignore rnd = codecs.encode(os.urandom(12), 'hex') # type: ignore
filename = rnd.decode("ascii") filename = rnd.decode('ascii')
# put ourselves in the cache # put ourselves in the cache
cache_entry = (len(source), None, [line + "\n" for line in source.splitlines()], filename) cache_entry = (
len(source),
None,
[line + '\n' for line in source.splitlines()],
filename
)
# linecache does in fact have an attribute `cache`, thanks # linecache does in fact have an attribute `cache`, thanks
linecache.cache[filename] = cache_entry # type: ignore linecache.cache[filename] = cache_entry # type: ignore
return filename return filename
@@ -72,10 +74,12 @@ class MacroFuzzParser(jinja2.parser.Parser):
# modified to fuzz macros defined in the same file. this way # modified to fuzz macros defined in the same file. this way
# dbt can understand the stack of macros being called. # dbt can understand the stack of macros being called.
# - @cmcarthur # - @cmcarthur
node.name = get_dbt_macro_name(self.parse_assign_target(name_only=True).name) node.name = get_dbt_macro_name(
self.parse_assign_target(name_only=True).name)
self.parse_signature(node) self.parse_signature(node)
node.body = self.parse_statements(("name:endmacro",), drop_needle=True) node.body = self.parse_statements(('name:endmacro',),
drop_needle=True)
return node return node
@@ -91,8 +95,8 @@ class MacroFuzzEnvironment(jinja2.sandbox.SandboxedEnvironment):
If the value is 'write', also write the files to disk. If the value is 'write', also write the files to disk.
WARNING: This can write a ton of data if you aren't careful. WARNING: This can write a ton of data if you aren't careful.
""" """
if filename == "<template>" and flags.MACRO_DEBUGGING: if filename == '<template>' and flags.MACRO_DEBUGGING:
write = flags.MACRO_DEBUGGING == "write" write = flags.MACRO_DEBUGGING == 'write'
filename = _linecache_inject(source, write) filename = _linecache_inject(source, write)
return super()._compile(source, filename) # type: ignore return super()._compile(source, filename) # type: ignore
@@ -103,7 +107,7 @@ class NativeSandboxEnvironment(MacroFuzzEnvironment):
class TextMarker(str): class TextMarker(str):
"""A special native-env marker that indicates a value is text and is """A special native-env marker that indicates that a value is text and is
not to be evaluated. Use this to prevent your numbery-strings from becoming not to be evaluated. Use this to prevent your numbery-strings from becoming
numbers! numbers!
""" """
@@ -135,7 +139,7 @@ def quoted_native_concat(nodes):
head = list(islice(nodes, 2)) head = list(islice(nodes, 2))
if not head: if not head:
return "" return ''
if len(head) == 1: if len(head) == 1:
raw = head[0] raw = head[0]
@@ -153,9 +157,13 @@ def quoted_native_concat(nodes):
except (ValueError, SyntaxError, MemoryError): except (ValueError, SyntaxError, MemoryError):
result = raw result = raw
if isinstance(raw, BoolMarker) and not isinstance(result, bool): if isinstance(raw, BoolMarker) and not isinstance(result, bool):
raise JinjaRenderingException(f"Could not convert value '{raw!s}' into type 'bool'") raise JinjaRenderingException(
f"Could not convert value '{raw!s}' into type 'bool'"
)
if isinstance(raw, NumberMarker) and not _is_number(result): if isinstance(raw, NumberMarker) and not _is_number(result):
raise JinjaRenderingException(f"Could not convert value '{raw!s}' into type 'number'") raise JinjaRenderingException(
f"Could not convert value '{raw!s}' into type 'number'"
)
return result return result
@@ -173,7 +181,9 @@ class NativeSandboxTemplate(jinja2.nativetypes.NativeTemplate): # mypy: ignore
vars = dict(*args, **kwargs) vars = dict(*args, **kwargs)
try: try:
return quoted_native_concat(self.root_render_func(self.new_context(vars))) return quoted_native_concat(
self.root_render_func(self.new_context(vars))
)
except Exception: except Exception:
return self.environment.handle_exception() return self.environment.handle_exception()
@@ -212,10 +222,10 @@ class BaseMacroGenerator:
self.context: Optional[Dict[str, Any]] = context self.context: Optional[Dict[str, Any]] = context
def get_template(self): def get_template(self):
raise NotImplementedError("get_template not implemented!") raise NotImplementedError('get_template not implemented!')
def get_name(self) -> str: def get_name(self) -> str:
raise NotImplementedError("get_name not implemented!") raise NotImplementedError('get_name not implemented!')
def get_macro(self): def get_macro(self):
name = self.get_name() name = self.get_name()
@@ -238,7 +248,9 @@ class BaseMacroGenerator:
def call_macro(self, *args, **kwargs): def call_macro(self, *args, **kwargs):
# called from __call__ methods # called from __call__ methods
if self.context is None: if self.context is None:
raise InternalException("Context is still None in call_macro!") raise InternalException(
'Context is still None in call_macro!'
)
assert self.context is not None assert self.context is not None
macro = self.get_macro() macro = self.get_macro()
@@ -265,7 +277,7 @@ class MacroStack(threading.local):
def pop(self, name): def pop(self, name):
got = self.call_stack.pop() got = self.call_stack.pop()
if got != name: if got != name:
raise InternalException(f"popped {got}, expected {name}") raise InternalException(f'popped {got}, expected {name}')
class MacroGenerator(BaseMacroGenerator): class MacroGenerator(BaseMacroGenerator):
@@ -274,7 +286,7 @@ class MacroGenerator(BaseMacroGenerator):
macro, macro,
context: Optional[Dict[str, Any]] = None, context: Optional[Dict[str, Any]] = None,
node: Optional[Any] = None, node: Optional[Any] = None,
stack: Optional[MacroStack] = None, stack: Optional[MacroStack] = None
) -> None: ) -> None:
super().__init__(context) super().__init__(context)
self.macro = macro self.macro = macro
@@ -322,7 +334,9 @@ class MacroGenerator(BaseMacroGenerator):
class QueryStringGenerator(BaseMacroGenerator): class QueryStringGenerator(BaseMacroGenerator):
def __init__(self, template_str: str, context: Dict[str, Any]) -> None: def __init__(
self, template_str: str, context: Dict[str, Any]
) -> None:
super().__init__(context) super().__init__(context)
self.template_str: str = template_str self.template_str: str = template_str
env = get_environment() env = get_environment()
@@ -332,7 +346,7 @@ class QueryStringGenerator(BaseMacroGenerator):
) )
def get_name(self) -> str: def get_name(self) -> str:
return "query_comment_macro" return 'query_comment_macro'
def get_template(self): def get_template(self):
"""Don't use the template cache, we don't have a node""" """Don't use the template cache, we don't have a node"""
@@ -343,39 +357,45 @@ class QueryStringGenerator(BaseMacroGenerator):
class MaterializationExtension(jinja2.ext.Extension): class MaterializationExtension(jinja2.ext.Extension):
tags = ["materialization"] tags = ['materialization']
def parse(self, parser): def parse(self, parser):
node = jinja2.nodes.Macro(lineno=next(parser.stream).lineno) node = jinja2.nodes.Macro(lineno=next(parser.stream).lineno)
materialization_name = parser.parse_assign_target(name_only=True).name materialization_name = \
parser.parse_assign_target(name_only=True).name
adapter_name = "default" adapter_name = 'default'
node.args = [] node.args = []
node.defaults = [] node.defaults = []
while parser.stream.skip_if("comma"): while parser.stream.skip_if('comma'):
target = parser.parse_assign_target(name_only=True) target = parser.parse_assign_target(name_only=True)
if target.name == "default": if target.name == 'default':
pass pass
elif target.name == "adapter": elif target.name == 'adapter':
parser.stream.expect("assign") parser.stream.expect('assign')
value = parser.parse_expression() value = parser.parse_expression()
adapter_name = value.value adapter_name = value.value
else: else:
invalid_materialization_argument(materialization_name, target.name) invalid_materialization_argument(
materialization_name, target.name
)
node.name = get_materialization_macro_name(materialization_name, adapter_name) node.name = get_materialization_macro_name(
materialization_name, adapter_name
)
node.body = parser.parse_statements(("name:endmaterialization",), drop_needle=True) node.body = parser.parse_statements(('name:endmaterialization',),
drop_needle=True)
return node return node
class DocumentationExtension(jinja2.ext.Extension): class DocumentationExtension(jinja2.ext.Extension):
tags = ["docs"] tags = ['docs']
def parse(self, parser): def parse(self, parser):
node = jinja2.nodes.Macro(lineno=next(parser.stream).lineno) node = jinja2.nodes.Macro(lineno=next(parser.stream).lineno)
@@ -384,12 +404,13 @@ class DocumentationExtension(jinja2.ext.Extension):
node.args = [] node.args = []
node.defaults = [] node.defaults = []
node.name = get_docs_macro_name(docs_name) node.name = get_docs_macro_name(docs_name)
node.body = parser.parse_statements(("name:enddocs",), drop_needle=True) node.body = parser.parse_statements(('name:enddocs',),
drop_needle=True)
return node return node
class TestExtension(jinja2.ext.Extension): class TestExtension(jinja2.ext.Extension):
tags = ["test"] tags = ['test']
def parse(self, parser): def parse(self, parser):
node = jinja2.nodes.Macro(lineno=next(parser.stream).lineno) node = jinja2.nodes.Macro(lineno=next(parser.stream).lineno)
@@ -397,12 +418,13 @@ class TestExtension(jinja2.ext.Extension):
parser.parse_signature(node) parser.parse_signature(node)
node.name = get_test_macro_name(test_name) node.name = get_test_macro_name(test_name)
node.body = parser.parse_statements(("name:endtest",), drop_needle=True) node.body = parser.parse_statements(('name:endtest',),
drop_needle=True)
return node return node
def _is_dunder_name(name): def _is_dunder_name(name):
return name.startswith("__") and name.endswith("__") return name.startswith('__') and name.endswith('__')
def create_undefined(node=None): def create_undefined(node=None):
@@ -423,9 +445,10 @@ def create_undefined(node=None):
return self return self
def __getattr__(self, name): def __getattr__(self, name):
if name == "name" or _is_dunder_name(name): if name == 'name' or _is_dunder_name(name):
raise AttributeError( raise AttributeError(
"'{}' object has no attribute '{}'".format(type(self).__name__, name) "'{}' object has no attribute '{}'"
.format(type(self).__name__, name)
) )
self.name = name self.name = name
@@ -436,24 +459,24 @@ def create_undefined(node=None):
return self return self
def __reduce__(self): def __reduce__(self):
raise_compiler_error(f"{self.name} is undefined", node=node) raise_compiler_error(f'{self.name} is undefined', node=node)
return Undefined return Undefined
NATIVE_FILTERS: Dict[str, Callable[[Any], Any]] = { NATIVE_FILTERS: Dict[str, Callable[[Any], Any]] = {
"as_text": TextMarker, 'as_text': TextMarker,
"as_bool": BoolMarker, 'as_bool': BoolMarker,
"as_native": NativeMarker, 'as_native': NativeMarker,
"as_number": NumberMarker, 'as_number': NumberMarker,
} }
TEXT_FILTERS: Dict[str, Callable[[Any], Any]] = { TEXT_FILTERS: Dict[str, Callable[[Any], Any]] = {
"as_text": lambda x: x, 'as_text': lambda x: x,
"as_bool": lambda x: x, 'as_bool': lambda x: x,
"as_native": lambda x: x, 'as_native': lambda x: x,
"as_number": lambda x: x, 'as_number': lambda x: x,
} }
@@ -463,15 +486,15 @@ def get_environment(
native: bool = False, native: bool = False,
) -> jinja2.Environment: ) -> jinja2.Environment:
args: Dict[str, List[Union[str, Type[jinja2.ext.Extension]]]] = { args: Dict[str, List[Union[str, Type[jinja2.ext.Extension]]]] = {
"extensions": ["jinja2.ext.do"] 'extensions': ['jinja2.ext.do']
} }
if capture_macros: if capture_macros:
args["undefined"] = create_undefined(node) args['undefined'] = create_undefined(node)
args["extensions"].append(MaterializationExtension) args['extensions'].append(MaterializationExtension)
args["extensions"].append(DocumentationExtension) args['extensions'].append(DocumentationExtension)
args["extensions"].append(TestExtension) args['extensions'].append(TestExtension)
env_cls: Type[jinja2.Environment] env_cls: Type[jinja2.Environment]
text_filter: Type text_filter: Type
@@ -534,8 +557,8 @@ def _requote_result(raw_value: str, rendered: str) -> str:
elif single_quoted: elif single_quoted:
quote_char = "'" quote_char = "'"
else: else:
quote_char = "" quote_char = ''
return f"{quote_char}{rendered}{quote_char}" return f'{quote_char}{rendered}{quote_char}'
# performance note: Local benmcharking (so take it with a big grain of salt!) # performance note: Local benmcharking (so take it with a big grain of salt!)
@@ -543,7 +566,7 @@ def _requote_result(raw_value: str, rendered: str) -> str:
# checking two separate patterns, but the standard deviation is smaller with # checking two separate patterns, but the standard deviation is smaller with
# one pattern. The time difference between the two was ~2 std deviations, which # one pattern. The time difference between the two was ~2 std deviations, which
# is small enough that I've just chosen the more readable option. # is small enough that I've just chosen the more readable option.
_HAS_RENDER_CHARS_PAT = re.compile(r"({[{%#]|[#}%]})") _HAS_RENDER_CHARS_PAT = re.compile(r'({[{%#]|[#}%]})')
def get_rendered( def get_rendered(
@@ -559,7 +582,11 @@ def get_rendered(
# If this is desirable in the native env as well, we could handle the # If this is desirable in the native env as well, we could handle the
# native=True case by passing the input string to ast.literal_eval, like # native=True case by passing the input string to ast.literal_eval, like
# the native renderer does. # the native renderer does.
if not native and isinstance(string, str) and _HAS_RENDER_CHARS_PAT.search(string) is None: if (
not native and
isinstance(string, str) and
_HAS_RENDER_CHARS_PAT.search(string) is None
):
return string return string
template = get_template( template = get_template(
string, string,
@@ -580,7 +607,7 @@ def extract_toplevel_blocks(
allowed_blocks: Optional[Set[str]] = None, allowed_blocks: Optional[Set[str]] = None,
collect_raw_data: bool = True, collect_raw_data: bool = True,
) -> List[Union[BlockData, BlockTag]]: ) -> List[Union[BlockData, BlockTag]]:
"""Extract the top-level blocks with matching block types from a jinja """Extract the top level blocks with matching block types from a jinja
file, with some special handling for block nesting. file, with some special handling for block nesting.
:param data: The data to extract blocks from. :param data: The data to extract blocks from.
@@ -595,40 +622,44 @@ def extract_toplevel_blocks(
`collect_raw_data` is `True`) `BlockData` objects. `collect_raw_data` is `True`) `BlockData` objects.
""" """
return BlockIterator(data).lex_for_blocks( return BlockIterator(data).lex_for_blocks(
allowed_blocks=allowed_blocks, collect_raw_data=collect_raw_data allowed_blocks=allowed_blocks,
collect_raw_data=collect_raw_data
) )
GENERIC_TEST_KWARGS_NAME = "_dbt_generic_test_kwargs" SCHEMA_TEST_KWARGS_NAME = '_dbt_schema_test_kwargs'
def add_rendered_test_kwargs( def add_rendered_test_kwargs(
context: Dict[str, Any], context: Dict[str, Any],
node: Union[ParsedGenericTestNode, CompiledGenericTestNode], node: Union[ParsedSchemaTestNode, CompiledSchemaTestNode],
capture_macros: bool = False, capture_macros: bool = False,
) -> None: ) -> None:
"""Render each of the test kwargs in the given context using the native """Render each of the test kwargs in the given context using the native
renderer, then insert that value into the given context as the special test renderer, then insert that value into the given context as the special test
keyword arguments member. keyword arguments member.
""" """
looks_like_func = r"^\s*(env_var|ref|var|source|doc)\s*\(.+\)\s*$" looks_like_func = r'^\s*(env_var|ref|var|source|doc)\s*\(.+\)\s*$'
def _convert_function(value: Any, keypath: Tuple[Union[str, int], ...]) -> Any: def _convert_function(
value: Any, keypath: Tuple[Union[str, int], ...]
) -> Any:
if isinstance(value, str): if isinstance(value, str):
if keypath == ("column_name",): if keypath == ('column_name',):
# special case: Don't render column names as native, make them # special case: Don't render column names as native, make them
# be strings # be strings
return value return value
if re.match(looks_like_func, value) is not None: if re.match(looks_like_func, value) is not None:
# curly braces to make rendering happy # curly braces to make rendering happy
value = f"{{{{ {value} }}}}" value = f'{{{{ {value} }}}}'
value = get_rendered(value, context, node, capture_macros=capture_macros, native=True) value = get_rendered(
value, context, node, capture_macros=capture_macros,
native=True
)
return value return value
# The test_metadata.kwargs come from the test builder, and were set kwargs = deep_map(_convert_function, node.test_metadata.kwargs)
# when the test node was created in _parse_generic_test. context[SCHEMA_TEST_KWARGS_NAME] = kwargs
kwargs = deep_map_render(_convert_function, node.test_metadata.kwargs)
context[GENERIC_TEST_KWARGS_NAME] = kwargs

View File

@@ -8,11 +8,11 @@ def statically_extract_macro_calls(string, ctx, db_wrapper=None):
env = get_environment(None, capture_macros=True) env = get_environment(None, capture_macros=True)
parsed = env.parse(string) parsed = env.parse(string)
standard_calls = ["source", "ref", "config"] standard_calls = ['source', 'ref', 'config']
possible_macro_calls = [] possible_macro_calls = []
for func_call in parsed.find_all(jinja2.nodes.Call): for func_call in parsed.find_all(jinja2.nodes.Call):
func_name = None func_name = None
if hasattr(func_call, "node") and hasattr(func_call.node, "name"): if hasattr(func_call, 'node') and hasattr(func_call.node, 'name'):
func_name = func_call.node.name func_name = func_call.node.name
else: else:
# func_call for dbt_utils.current_timestamp macro # func_call for dbt_utils.current_timestamp macro
@@ -30,25 +30,22 @@ def statically_extract_macro_calls(string, ctx, db_wrapper=None):
# dyn_args=None, # dyn_args=None,
# dyn_kwargs=None # dyn_kwargs=None
# ) # )
if ( if (hasattr(func_call, 'node') and
hasattr(func_call, "node") hasattr(func_call.node, 'node') and
and hasattr(func_call.node, "node") type(func_call.node.node).__name__ == 'Name' and
and type(func_call.node.node).__name__ == "Name" hasattr(func_call.node, 'attr')):
and hasattr(func_call.node, "attr")
):
package_name = func_call.node.node.name package_name = func_call.node.node.name
macro_name = func_call.node.attr macro_name = func_call.node.attr
if package_name == "adapter": if package_name == 'adapter':
if macro_name == "dispatch": if macro_name == 'dispatch':
ad_macro_calls = statically_parse_adapter_dispatch( ad_macro_calls = statically_parse_adapter_dispatch(
func_call, ctx, db_wrapper func_call, ctx, db_wrapper)
)
possible_macro_calls.extend(ad_macro_calls) possible_macro_calls.extend(ad_macro_calls)
else: else:
# This skips calls such as adapter.parse_index # This skips calls such as adapter.parse_index
continue continue
else: else:
func_name = f"{package_name}.{macro_name}" func_name = f'{package_name}.{macro_name}'
else: else:
continue continue
if not func_name: if not func_name:
@@ -99,6 +96,7 @@ def statically_parse_adapter_dispatch(func_call, ctx, db_wrapper):
possible_macro_calls.append(func_name) possible_macro_calls.append(func_name)
# packages positional argument # packages positional argument
packages = None
macro_namespace = None macro_namespace = None
packages_arg = None packages_arg = None
packages_arg_type = None packages_arg_type = None
@@ -111,48 +109,117 @@ def statically_parse_adapter_dispatch(func_call, ctx, db_wrapper):
# keyword arguments # keyword arguments
if func_call.kwargs: if func_call.kwargs:
for kwarg in func_call.kwargs: for kwarg in func_call.kwargs:
if kwarg.key == "macro_name": if kwarg.key == 'packages':
# The packages keyword will be deprecated and
# eventually removed
packages_arg = kwarg.value
# This can be a List or a Call
packages_arg_type = type(kwarg.value).__name__
elif kwarg.key == 'macro_name':
# This will remain to enable static resolution # This will remain to enable static resolution
if type(kwarg.value).__name__ == "Const": if type(kwarg.value).__name__ == 'Const':
func_name = kwarg.value.value func_name = kwarg.value.value
possible_macro_calls.append(func_name) possible_macro_calls.append(func_name)
else: else:
raise_compiler_error( raise_compiler_error(f"The macro_name parameter ({kwarg.value.value}) "
f"The macro_name parameter ({kwarg.value.value}) " "to adapter.dispatch was not a string")
"to adapter.dispatch was not a string" elif kwarg.key == 'macro_namespace':
)
elif kwarg.key == "macro_namespace":
# This will remain to enable static resolution # This will remain to enable static resolution
kwarg_type = type(kwarg.value).__name__ kwarg_type = type(kwarg.value).__name__
if kwarg_type == "Const": if kwarg_type == 'Const':
macro_namespace = kwarg.value.value macro_namespace = kwarg.value.value
else: else:
raise_compiler_error( raise_compiler_error("The macro_namespace parameter to adapter.dispatch "
"The macro_namespace parameter to adapter.dispatch " f"is a {kwarg_type}, not a string")
f"is a {kwarg_type}, not a string"
)
# positional arguments # positional arguments
if packages_arg: if packages_arg:
if packages_arg_type == "List": if packages_arg_type == 'List':
# This will remain to enable static resolution # This will remain to enable static resolution
packages = [] packages = []
for item in packages_arg.items: for item in packages_arg.items:
packages.append(item.value) packages.append(item.value)
elif packages_arg_type == "Const": elif packages_arg_type == 'Const':
# This will remain to enable static resolution # This will remain to enable static resolution
macro_namespace = packages_arg.value macro_namespace = packages_arg.value
elif packages_arg_type == 'Call':
# This is deprecated and should be removed eventually.
# It is here to support (hackily) common ways of providing
# a packages list to adapter.dispatch
if (hasattr(packages_arg, 'node') and
hasattr(packages_arg.node, 'node') and
hasattr(packages_arg.node.node, 'name') and
hasattr(packages_arg.node, 'attr')):
package_name = packages_arg.node.node.name
macro_name = packages_arg.node.attr
if (macro_name.startswith('_get') and 'namespaces' in macro_name):
# noqa: https://github.com/dbt-labs/dbt-utils/blob/9e9407b/macros/cross_db_utils/_get_utils_namespaces.sql
var_name = f'{package_name}_dispatch_list'
# hard code compatibility for fivetran_utils, just a teensy bit different
# noqa: https://github.com/fivetran/dbt_fivetran_utils/blob/0978ba2/macros/_get_utils_namespaces.sql
if package_name == 'fivetran_utils':
default_packages = ['dbt_utils', 'fivetran_utils']
else:
default_packages = [package_name]
namespace_names = get_dispatch_list(ctx, var_name, default_packages)
packages = []
if namespace_names:
packages.extend(namespace_names)
else:
msg = (
f"As of v0.19.2, custom macros, such as '{macro_name}', are no longer "
"supported in the 'packages' argument of 'adapter.dispatch()'.\n"
f"See https://docs.getdbt.com/reference/dbt-jinja-functions/dispatch "
"for details."
).strip()
raise_compiler_error(msg)
elif packages_arg_type == 'Add':
# This logic is for when there is a variable and an addition of a list,
# like: packages = (var('local_utils_dispatch_list', []) + ['local_utils2'])
# This is deprecated and should be removed eventually.
namespace_var = None
default_namespaces = []
# This might be a single call or it might be the 'left' piece in an addition
for var_call in packages_arg.find_all(jinja2.nodes.Call):
if (hasattr(var_call, 'node') and
var_call.node.name == 'var' and
hasattr(var_call, 'args')):
namespace_var = var_call.args[0].value
if hasattr(packages_arg, 'right'): # we have a default list of namespaces
for item in packages_arg.right.items:
default_namespaces.append(item.value)
if namespace_var:
namespace_names = get_dispatch_list(ctx, namespace_var, default_namespaces)
packages = []
if namespace_names:
packages.extend(namespace_names)
if db_wrapper: if db_wrapper:
macro = db_wrapper.dispatch(func_name, macro_namespace=macro_namespace).macro macro = db_wrapper.dispatch(
func_name = f"{macro.package_name}.{macro.name}" func_name,
packages=packages,
macro_namespace=macro_namespace
).macro
func_name = f'{macro.package_name}.{macro.name}'
possible_macro_calls.append(func_name) possible_macro_calls.append(func_name)
else: # this is only for test/unit/test_macro_calls.py else: # this is only for test/unit/test_macro_calls.py
if macro_namespace: if macro_namespace:
packages = [macro_namespace] packages = [macro_namespace]
else: if packages is None:
packages = [] packages = []
for package_name in packages: for package_name in packages:
possible_macro_calls.append(f"{package_name}.{func_name}") possible_macro_calls.append(f'{package_name}.{func_name}')
return possible_macro_calls return possible_macro_calls
def get_dispatch_list(ctx, var_name, default_packages):
namespace_list = None
try:
# match the logic currently used in package _get_namespaces() macro
namespace_list = ctx['var'](var_name) + default_packages
except Exception:
pass
namespace_list = namespace_list if namespace_list else default_packages
return namespace_list

View File

@@ -1,163 +1,79 @@
import functools import functools
from typing import Any, Dict, List
import requests import requests
from dbt.events.functions import fire_event
from dbt.events.types import (
RegistryProgressMakingGETRequest,
RegistryProgressGETResponse,
RegistryIndexProgressMakingGETRequest,
RegistryIndexProgressGETResponse,
RegistryResponseUnexpectedType,
RegistryResponseMissingTopKeys,
RegistryResponseMissingNestedKeys,
RegistryResponseExtraNestedKeys,
)
from dbt.utils import memoized, _connection_exception_retry as connection_exception_retry from dbt.utils import memoized, _connection_exception_retry as connection_exception_retry
from dbt.logger import GLOBAL_LOGGER as logger
from dbt import deprecations from dbt import deprecations
import os import os
if os.getenv("DBT_PACKAGE_HUB_URL"): if os.getenv('DBT_PACKAGE_HUB_URL'):
DEFAULT_REGISTRY_BASE_URL = os.getenv("DBT_PACKAGE_HUB_URL") DEFAULT_REGISTRY_BASE_URL = os.getenv('DBT_PACKAGE_HUB_URL')
else: else:
DEFAULT_REGISTRY_BASE_URL = "https://hub.getdbt.com/" DEFAULT_REGISTRY_BASE_URL = 'https://hub.getdbt.com/'
def _get_url(name, registry_base_url=None): def _get_url(url, registry_base_url=None):
if registry_base_url is None: if registry_base_url is None:
registry_base_url = DEFAULT_REGISTRY_BASE_URL registry_base_url = DEFAULT_REGISTRY_BASE_URL
url = "api/v1/{}.json".format(name)
return "{}{}".format(registry_base_url, url) return '{}{}'.format(registry_base_url, url)
def _get_with_retries(package_name, registry_base_url=None): def _get_with_retries(path, registry_base_url=None):
get_fn = functools.partial(_get, package_name, registry_base_url) get_fn = functools.partial(_get, path, registry_base_url)
return connection_exception_retry(get_fn, 5) return connection_exception_retry(get_fn, 5)
def _get(package_name, registry_base_url=None): def _get(path, registry_base_url=None):
url = _get_url(package_name, registry_base_url) url = _get_url(path, registry_base_url)
fire_event(RegistryProgressMakingGETRequest(url=url)) logger.debug('Making package registry request: GET {}'.format(url))
# all exceptions from requests get caught in the retry logic so no need to wrap this here
resp = requests.get(url, timeout=30) resp = requests.get(url, timeout=30)
fire_event(RegistryProgressGETResponse(url=url, resp_code=resp.status_code)) logger.debug('Response from registry: GET {} {}'.format(url,
resp.status_code))
resp.raise_for_status() resp.raise_for_status()
return resp.json()
# The response should always be a dictionary. Anything else is unexpected, raise error.
# Raising this error will cause this function to retry (if called within _get_with_retries)
# and hopefully get a valid response. This seems to happen when there's an issue with the Hub.
# Since we control what we expect the HUB to return, this is safe.
# See https://github.com/dbt-labs/dbt-core/issues/4577
# and https://github.com/dbt-labs/dbt-core/issues/4849
response = resp.json()
if not isinstance(response, dict): # This will also catch Nonetype
error_msg = (
f"Request error: Expected a response type of <dict> but got {type(response)} instead"
)
fire_event(RegistryResponseUnexpectedType(response=response))
raise requests.exceptions.ContentDecodingError(error_msg, response=resp)
# check for expected top level keys
expected_keys = {"name", "versions"}
if not expected_keys.issubset(response):
error_msg = (
f"Request error: Expected the response to contain keys {expected_keys} "
f"but is missing {expected_keys.difference(set(response))}"
)
fire_event(RegistryResponseMissingTopKeys(response=response))
raise requests.exceptions.ContentDecodingError(error_msg, response=resp)
# check for the keys we need nested under each version
expected_version_keys = {"name", "packages", "downloads"}
all_keys = set().union(*(response["versions"][d] for d in response["versions"]))
if not expected_version_keys.issubset(all_keys):
error_msg = (
"Request error: Expected the response for the version to contain keys "
f"{expected_version_keys} but is missing {expected_version_keys.difference(all_keys)}"
)
fire_event(RegistryResponseMissingNestedKeys(response=response))
raise requests.exceptions.ContentDecodingError(error_msg, response=resp)
# all version responses should contain identical keys.
has_extra_keys = set().difference(*(response["versions"][d] for d in response["versions"]))
if has_extra_keys:
error_msg = (
"Request error: Keys for all versions do not match. Found extra key(s) "
f"of {has_extra_keys}."
)
fire_event(RegistryResponseExtraNestedKeys(response=response))
raise requests.exceptions.ContentDecodingError(error_msg, response=resp)
return response
_get_cached = memoized(_get_with_retries) def index(registry_base_url=None):
return _get_with_retries('api/v1/index.json', registry_base_url)
def package(package_name, registry_base_url=None) -> Dict[str, Any]: index_cached = memoized(index)
# returns a dictionary of metadata for all versions of a package
response = _get_cached(package_name, registry_base_url)
def packages(registry_base_url=None):
return _get_with_retries('api/v1/packages.json', registry_base_url)
def package(name, registry_base_url=None):
response = _get_with_retries('api/v1/{}.json'.format(name), registry_base_url)
# Either redirectnamespace or redirectname in the JSON response indicate a redirect # Either redirectnamespace or redirectname in the JSON response indicate a redirect
# redirectnamespace redirects based on package ownership # redirectnamespace redirects based on package ownership
# redirectname redirects based on package name # redirectname redirects based on package name
# Both can be present at the same time, or neither. Fails gracefully to old name # Both can be present at the same time, or neither. Fails gracefully to old name
if ("redirectnamespace" in response) or ("redirectname" in response):
if ("redirectnamespace" in response) and response["redirectnamespace"] is not None: if ('redirectnamespace' in response) or ('redirectname' in response):
use_namespace = response["redirectnamespace"]
else:
use_namespace = response["namespace"]
if ("redirectname" in response) and response["redirectname"] is not None: if ('redirectnamespace' in response) and response['redirectnamespace'] is not None:
use_name = response["redirectname"] use_namespace = response['redirectnamespace']
else: else:
use_name = response["name"] use_namespace = response['namespace']
if ('redirectname' in response) and response['redirectname'] is not None:
use_name = response['redirectname']
else:
use_name = response['name']
new_nwo = use_namespace + "/" + use_name new_nwo = use_namespace + "/" + use_name
deprecations.warn("package-redirect", old_name=package_name, new_name=new_nwo) deprecations.warn('package-redirect', old_name=name, new_name=new_nwo)
return response["versions"]
def package_version(package_name, version, registry_base_url=None) -> Dict[str, Any]:
# returns the metadata of a specific version of a package
response = package(package_name, registry_base_url)
return response[version]
def get_available_versions(package_name) -> List["str"]:
# returns a list of all available versions of a package
response = package(package_name)
return list(response)
def _get_index(registry_base_url=None):
url = _get_url("index", registry_base_url)
fire_event(RegistryIndexProgressMakingGETRequest(url=url))
# all exceptions from requests get caught in the retry logic so no need to wrap this here
resp = requests.get(url, timeout=30)
fire_event(RegistryIndexProgressGETResponse(url=url, resp_code=resp.status_code))
resp.raise_for_status()
# The response should be a list. Anything else is unexpected, raise an error.
# Raising this error will cause this function to retry and hopefully get a valid response.
response = resp.json()
if not isinstance(response, list): # This will also catch Nonetype
error_msg = (
f"Request error: The response type of {type(response)} is not valid: {resp.text}"
)
raise requests.exceptions.ContentDecodingError(error_msg, response=resp)
return response return response
def index(registry_base_url=None) -> List[str]: def package_version(name, version, registry_base_url=None):
# this returns a list of all packages on the Hub return _get_with_retries('api/v1/{}/{}.json'.format(name, version), registry_base_url)
get_index_fn = functools.partial(_get_index, registry_base_url)
return connection_exception_retry(get_index_fn, 5)
index_cached = memoized(index) def get_available_versions(name):
response = package(name)
return list(response['versions'])

View File

@@ -11,21 +11,15 @@ import sys
import tarfile import tarfile
import requests import requests
import stat import stat
from typing import Type, NoReturn, List, Optional, Dict, Any, Tuple, Callable, Union from typing import (
Type, NoReturn, List, Optional, Dict, Any, Tuple, Callable, Union
from dbt.events.functions import fire_event
from dbt.events.types import (
SystemErrorRetrievingModTime,
SystemCouldNotWrite,
SystemExecutingCmd,
SystemStdOutMsg,
SystemStdErrMsg,
SystemReportReturnCode,
) )
import dbt.exceptions import dbt.exceptions
from dbt.logger import GLOBAL_LOGGER as logger
from dbt.utils import _connection_exception_retry as connection_exception_retry from dbt.utils import _connection_exception_retry as connection_exception_retry
if sys.platform == "win32": if sys.platform == 'win32':
from ctypes import WinDLL, c_bool from ctypes import WinDLL, c_bool
else: else:
WinDLL = None WinDLL = None
@@ -36,7 +30,7 @@ def find_matching(
root_path: str, root_path: str,
relative_paths_to_search: List[str], relative_paths_to_search: List[str],
file_pattern: str, file_pattern: str,
) -> List[Dict[str, Any]]: ) -> List[Dict[str, str]]:
""" """
Given an absolute `root_path`, a list of relative paths to that Given an absolute `root_path`, a list of relative paths to that
absolute root path (`relative_paths_to_search`), and a `file_pattern` absolute root path (`relative_paths_to_search`), and a `file_pattern`
@@ -57,35 +51,30 @@ def find_matching(
reobj = re.compile(regex, re.IGNORECASE) reobj = re.compile(regex, re.IGNORECASE)
for relative_path_to_search in relative_paths_to_search: for relative_path_to_search in relative_paths_to_search:
absolute_path_to_search = os.path.join(root_path, relative_path_to_search) absolute_path_to_search = os.path.join(
root_path, relative_path_to_search)
walk_results = os.walk(absolute_path_to_search) walk_results = os.walk(absolute_path_to_search)
for current_path, subdirectories, local_files in walk_results: for current_path, subdirectories, local_files in walk_results:
for local_file in local_files: for local_file in local_files:
absolute_path = os.path.join(current_path, local_file) absolute_path = os.path.join(current_path, local_file)
relative_path = os.path.relpath(absolute_path, absolute_path_to_search) relative_path = os.path.relpath(
modification_time = 0.0 absolute_path, absolute_path_to_search
try: )
modification_time = os.path.getmtime(absolute_path)
except OSError:
fire_event(SystemErrorRetrievingModTime(path=absolute_path))
if reobj.match(local_file): if reobj.match(local_file):
matching.append( matching.append({
{ 'searched_path': relative_path_to_search,
"searched_path": relative_path_to_search, 'absolute_path': absolute_path,
"absolute_path": absolute_path, 'relative_path': relative_path,
"relative_path": relative_path, })
"modification_time": modification_time,
}
)
return matching return matching
def load_file_contents(path: str, strip: bool = True) -> str: def load_file_contents(path: str, strip: bool = True) -> str:
path = convert_path(path) path = convert_path(path)
with open(path, "rb") as handle: with open(path, 'rb') as handle:
to_return = handle.read().decode("utf-8") to_return = handle.read().decode('utf-8')
if strip: if strip:
to_return = to_return.strip() to_return = to_return.strip()
@@ -112,14 +101,14 @@ def make_directory(path: str) -> None:
raise e raise e
def make_file(path: str, contents: str = "", overwrite: bool = False) -> bool: def make_file(path: str, contents: str = '', overwrite: bool = False) -> bool:
""" """
Make a file at `path` assuming that the directory it resides in already Make a file at `path` assuming that the directory it resides in already
exists. The file is saved with contents `contents` exists. The file is saved with contents `contents`
""" """
if overwrite or not os.path.exists(path): if overwrite or not os.path.exists(path):
path = convert_path(path) path = convert_path(path)
with open(path, "w") as fh: with open(path, 'w') as fh:
fh.write(contents) fh.write(contents)
return True return True
@@ -131,7 +120,7 @@ def make_symlink(source: str, link_path: str) -> None:
Create a symlink at `link_path` referring to `source`. Create a symlink at `link_path` referring to `source`.
""" """
if not supports_symlinks(): if not supports_symlinks():
dbt.exceptions.system_error("create a symbolic link") dbt.exceptions.system_error('create a symbolic link')
os.symlink(source, link_path) os.symlink(source, link_path)
@@ -140,11 +129,11 @@ def supports_symlinks() -> bool:
return getattr(os, "symlink", None) is not None return getattr(os, "symlink", None) is not None
def write_file(path: str, contents: str = "") -> bool: def write_file(path: str, contents: str = '') -> bool:
path = convert_path(path) path = convert_path(path)
try: try:
make_directory(os.path.dirname(path)) make_directory(os.path.dirname(path))
with open(path, "w", encoding="utf-8") as f: with open(path, 'w', encoding='utf-8') as f:
f.write(str(contents)) f.write(str(contents))
except Exception as exc: except Exception as exc:
# note that you can't just catch FileNotFound, because sometimes # note that you can't just catch FileNotFound, because sometimes
@@ -153,18 +142,21 @@ def write_file(path: str, contents: str = "") -> bool:
# sometimes windows fails to write paths that are less than the length # sometimes windows fails to write paths that are less than the length
# limit. So on windows, suppress all errors that happen from writing # limit. So on windows, suppress all errors that happen from writing
# to disk. # to disk.
if os.name == "nt": if os.name == 'nt':
# sometimes we get a winerror of 3 which means the path was # sometimes we get a winerror of 3 which means the path was
# definitely too long, but other times we don't and it means the # definitely too long, but other times we don't and it means the
# path was just probably too long. This is probably based on the # path was just probably too long. This is probably based on the
# windows/python version. # windows/python version.
if getattr(exc, "winerror", 0) == 3: if getattr(exc, 'winerror', 0) == 3:
reason = "Path was too long" reason = 'Path was too long'
else: else:
reason = "Path was possibly too long" reason = 'Path was possibly too long'
# all our hard work and the path was still too long. Log and # all our hard work and the path was still too long. Log and
# continue. # continue.
fire_event(SystemCouldNotWrite(path=path, reason=reason, exc=exc)) logger.debug(
f'Could not write to path {path}({len(path)} characters): '
f'{reason}\nexception: {exc}'
)
else: else:
raise raise
return True return True
@@ -178,7 +170,9 @@ def write_json(path: str, data: Dict[str, Any]) -> bool:
return write_file(path, json.dumps(data, cls=dbt.utils.JSONEncoder)) return write_file(path, json.dumps(data, cls=dbt.utils.JSONEncoder))
def _windows_rmdir_readonly(func: Callable[[str], Any], path: str, exc: Tuple[Any, OSError, Any]): def _windows_rmdir_readonly(
func: Callable[[str], Any], path: str, exc: Tuple[Any, OSError, Any]
):
exception_val = exc[1] exception_val = exc[1]
if exception_val.errno == errno.EACCES: if exception_val.errno == errno.EACCES:
os.chmod(path, stat.S_IWUSR) os.chmod(path, stat.S_IWUSR)
@@ -195,7 +189,10 @@ def resolve_path_from_base(path_to_resolve: str, base_path: str) -> str:
If path_to_resolve is an absolute path or a user path (~), just If path_to_resolve is an absolute path or a user path (~), just
resolve it to an absolute path and return. resolve it to an absolute path and return.
""" """
return os.path.abspath(os.path.join(base_path, os.path.expanduser(path_to_resolve))) return os.path.abspath(
os.path.join(
base_path,
os.path.expanduser(path_to_resolve)))
def rmdir(path: str) -> None: def rmdir(path: str) -> None:
@@ -205,7 +202,7 @@ def rmdir(path: str) -> None:
cloned via git) can cause rmtree to throw a PermissionError exception cloned via git) can cause rmtree to throw a PermissionError exception
""" """
path = convert_path(path) path = convert_path(path)
if sys.platform == "win32": if sys.platform == 'win32':
onerror = _windows_rmdir_readonly onerror = _windows_rmdir_readonly
else: else:
onerror = None onerror = None
@@ -224,7 +221,7 @@ def _win_prepare_path(path: str) -> str:
# letter back in. # letter back in.
# Unless it starts with '\\'. In that case, the path is a UNC mount point # Unless it starts with '\\'. In that case, the path is a UNC mount point
# and splitdrive will be fine. # and splitdrive will be fine.
if not path.startswith("\\\\") and path.startswith("\\"): if not path.startswith('\\\\') and path.startswith('\\'):
curdrive = os.path.splitdrive(os.getcwd())[0] curdrive = os.path.splitdrive(os.getcwd())[0]
path = curdrive + path path = curdrive + path
@@ -239,24 +236,23 @@ def _win_prepare_path(path: str) -> str:
def _supports_long_paths() -> bool: def _supports_long_paths() -> bool:
if sys.platform != "win32": if sys.platform != 'win32':
return True return True
# Eryk Sun says to use `WinDLL('ntdll')` instead of `windll.ntdll` because # Eryk Sun says to use `WinDLL('ntdll')` instead of `windll.ntdll` because
# of pointer caching in a comment here: # of pointer caching in a comment here:
# https://stackoverflow.com/a/35097999/11262881 # https://stackoverflow.com/a/35097999/11262881
# I don't know exaclty what he means, but I am inclined to believe him as # I don't know exaclty what he means, but I am inclined to believe him as
# he's pretty active on Python windows bugs! # he's pretty active on Python windows bugs!
else: try:
try: dll = WinDLL('ntdll')
dll = WinDLL("ntdll") except OSError: # I don't think this happens? you need ntdll to run python
except OSError: # I don't think this happens? you need ntdll to run python return False
return False # not all windows versions have it at all
# not all windows versions have it at all if not hasattr(dll, 'RtlAreLongPathsEnabled'):
if not hasattr(dll, "RtlAreLongPathsEnabled"): return False
return False # tell windows we want to get back a single unsigned byte (a bool).
# tell windows we want to get back a single unsigned byte (a bool). dll.RtlAreLongPathsEnabled.restype = c_bool
dll.RtlAreLongPathsEnabled.restype = c_bool return dll.RtlAreLongPathsEnabled()
return dll.RtlAreLongPathsEnabled()
def convert_path(path: str) -> str: def convert_path(path: str) -> str:
@@ -272,7 +268,7 @@ def convert_path(path: str) -> str:
if _supports_long_paths(): if _supports_long_paths():
return path return path
prefix = "\\\\?\\" prefix = '\\\\?\\'
# Nothing to do # Nothing to do
if path.startswith(prefix): if path.startswith(prefix):
return path return path
@@ -303,40 +299,44 @@ def path_is_symlink(path: str) -> bool:
def open_dir_cmd() -> str: def open_dir_cmd() -> str:
# https://docs.python.org/2/library/sys.html#sys.platform # https://docs.python.org/2/library/sys.html#sys.platform
if sys.platform == "win32": if sys.platform == 'win32':
return "start" return 'start'
elif sys.platform == "darwin": elif sys.platform == 'darwin':
return "open" return 'open'
else: else:
return "xdg-open" return 'xdg-open'
def _handle_posix_cwd_error(exc: OSError, cwd: str, cmd: List[str]) -> NoReturn: def _handle_posix_cwd_error(
exc: OSError, cwd: str, cmd: List[str]
) -> NoReturn:
if exc.errno == errno.ENOENT: if exc.errno == errno.ENOENT:
message = "Directory does not exist" message = 'Directory does not exist'
elif exc.errno == errno.EACCES: elif exc.errno == errno.EACCES:
message = "Current user cannot access directory, check permissions" message = 'Current user cannot access directory, check permissions'
elif exc.errno == errno.ENOTDIR: elif exc.errno == errno.ENOTDIR:
message = "Not a directory" message = 'Not a directory'
else: else:
message = "Unknown OSError: {} - cwd".format(str(exc)) message = 'Unknown OSError: {} - cwd'.format(str(exc))
raise dbt.exceptions.WorkingDirectoryError(cwd, cmd, message) raise dbt.exceptions.WorkingDirectoryError(cwd, cmd, message)
def _handle_posix_cmd_error(exc: OSError, cwd: str, cmd: List[str]) -> NoReturn: def _handle_posix_cmd_error(
exc: OSError, cwd: str, cmd: List[str]
) -> NoReturn:
if exc.errno == errno.ENOENT: if exc.errno == errno.ENOENT:
message = "Could not find command, ensure it is in the user's PATH" message = "Could not find command, ensure it is in the user's PATH"
elif exc.errno == errno.EACCES: elif exc.errno == errno.EACCES:
message = "User does not have permissions for this command" message = 'User does not have permissions for this command'
else: else:
message = "Unknown OSError: {} - cmd".format(str(exc)) message = 'Unknown OSError: {} - cmd'.format(str(exc))
raise dbt.exceptions.ExecutableError(cwd, cmd, message) raise dbt.exceptions.ExecutableError(cwd, cmd, message)
def _handle_posix_error(exc: OSError, cwd: str, cmd: List[str]) -> NoReturn: def _handle_posix_error(exc: OSError, cwd: str, cmd: List[str]) -> NoReturn:
"""OSError handling for POSIX systems. """OSError handling for posix systems.
Some things that could happen to trigger an OSError: Some things that could happen to trigger an OSError:
- cwd could not exist - cwd could not exist
@@ -356,7 +356,7 @@ def _handle_posix_error(exc: OSError, cwd: str, cmd: List[str]) -> NoReturn:
- exc.errno == EACCES - exc.errno == EACCES
- exc.filename == None(?) - exc.filename == None(?)
""" """
if getattr(exc, "filename", None) == cwd: if getattr(exc, 'filename', None) == cwd:
_handle_posix_cwd_error(exc, cwd, cmd) _handle_posix_cwd_error(exc, cwd, cmd)
else: else:
_handle_posix_cmd_error(exc, cwd, cmd) _handle_posix_cmd_error(exc, cwd, cmd)
@@ -365,46 +365,46 @@ def _handle_posix_error(exc: OSError, cwd: str, cmd: List[str]) -> NoReturn:
def _handle_windows_error(exc: OSError, cwd: str, cmd: List[str]) -> NoReturn: def _handle_windows_error(exc: OSError, cwd: str, cmd: List[str]) -> NoReturn:
cls: Type[dbt.exceptions.Exception] = dbt.exceptions.CommandError cls: Type[dbt.exceptions.Exception] = dbt.exceptions.CommandError
if exc.errno == errno.ENOENT: if exc.errno == errno.ENOENT:
message = ( message = ("Could not find command, ensure it is in the user's PATH "
"Could not find command, ensure it is in the user's PATH " "and that the user has permissions to run it")
"and that the user has permissions to run it"
)
cls = dbt.exceptions.ExecutableError cls = dbt.exceptions.ExecutableError
elif exc.errno == errno.ENOEXEC: elif exc.errno == errno.ENOEXEC:
message = "Command was not executable, ensure it is valid" message = ('Command was not executable, ensure it is valid')
cls = dbt.exceptions.ExecutableError cls = dbt.exceptions.ExecutableError
elif exc.errno == errno.ENOTDIR: elif exc.errno == errno.ENOTDIR:
message = ( message = ('Unable to cd: path does not exist, user does not have'
"Unable to cd: path does not exist, user does not have" ' permissions, or not a directory')
" permissions, or not a directory"
)
cls = dbt.exceptions.WorkingDirectoryError cls = dbt.exceptions.WorkingDirectoryError
else: else:
message = 'Unknown error: {} (errno={}: "{}")'.format( message = 'Unknown error: {} (errno={}: "{}")'.format(
str(exc), exc.errno, errno.errorcode.get(exc.errno, "<Unknown!>") str(exc), exc.errno, errno.errorcode.get(exc.errno, '<Unknown!>')
) )
raise cls(cwd, cmd, message) raise cls(cwd, cmd, message)
def _interpret_oserror(exc: OSError, cwd: str, cmd: List[str]) -> NoReturn: def _interpret_oserror(exc: OSError, cwd: str, cmd: List[str]) -> NoReturn:
"""Interpret an OSError exception and raise the appropriate dbt exception.""" """Interpret an OSError exc and raise the appropriate dbt exception.
"""
if len(cmd) == 0: if len(cmd) == 0:
raise dbt.exceptions.CommandError(cwd, cmd) raise dbt.exceptions.CommandError(cwd, cmd)
# all of these functions raise unconditionally # all of these functions raise unconditionally
if os.name == "nt": if os.name == 'nt':
_handle_windows_error(exc, cwd, cmd) _handle_windows_error(exc, cwd, cmd)
else: else:
_handle_posix_error(exc, cwd, cmd) _handle_posix_error(exc, cwd, cmd)
# this should not be reachable, raise _something_ at least! # this should not be reachable, raise _something_ at least!
raise dbt.exceptions.InternalException( raise dbt.exceptions.InternalException(
"Unhandled exception in _interpret_oserror: {}".format(exc) 'Unhandled exception in _interpret_oserror: {}'.format(exc)
) )
def run_cmd(cwd: str, cmd: List[str], env: Optional[Dict[str, Any]] = None) -> Tuple[bytes, bytes]: def run_cmd(
fire_event(SystemExecutingCmd(cmd=cmd)) cwd: str, cmd: List[str], env: Optional[Dict[str, Any]] = None
) -> Tuple[bytes, bytes]:
logger.debug('Executing "{}"'.format(' '.join(cmd)))
if len(cmd) == 0: if len(cmd) == 0:
raise dbt.exceptions.CommandError(cwd, cmd) raise dbt.exceptions.CommandError(cwd, cmd)
@@ -420,19 +420,23 @@ def run_cmd(cwd: str, cmd: List[str], env: Optional[Dict[str, Any]] = None) -> T
if exe_pth: if exe_pth:
cmd = [os.path.abspath(exe_pth)] + list(cmd[1:]) cmd = [os.path.abspath(exe_pth)] + list(cmd[1:])
proc = subprocess.Popen( proc = subprocess.Popen(
cmd, cwd=cwd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=full_env cmd,
) cwd=cwd,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
env=full_env)
out, err = proc.communicate() out, err = proc.communicate()
except OSError as exc: except OSError as exc:
_interpret_oserror(exc, cwd, cmd) _interpret_oserror(exc, cwd, cmd)
fire_event(SystemStdOutMsg(bmsg=out)) logger.debug('STDOUT: "{!s}"'.format(out))
fire_event(SystemStdErrMsg(bmsg=err)) logger.debug('STDERR: "{!s}"'.format(err))
if proc.returncode != 0: if proc.returncode != 0:
fire_event(SystemReportReturnCode(returncode=proc.returncode)) logger.debug('command return code={}'.format(proc.returncode))
raise dbt.exceptions.CommandResultError(cwd, cmd, proc.returncode, out, err) raise dbt.exceptions.CommandResultError(cwd, cmd, proc.returncode,
out, err)
return out, err return out, err
@@ -445,14 +449,12 @@ def download_with_retries(
def download( def download(
url: str, url: str, path: str, timeout: Optional[Union[float, tuple]] = None
path: str,
timeout: Optional[Union[float, Tuple[float, float], Tuple[float, None]]] = None,
) -> None: ) -> None:
path = convert_path(path) path = convert_path(path)
connection_timeout = timeout or float(os.getenv("DBT_HTTP_TIMEOUT", 10)) connection_timeout = timeout or float(os.getenv('DBT_HTTP_TIMEOUT', 10))
response = requests.get(url, timeout=connection_timeout) response = requests.get(url, timeout=connection_timeout)
with open(path, "wb") as handle: with open(path, 'wb') as handle:
for block in response.iter_content(1024 * 64): for block in response.iter_content(1024 * 64):
handle.write(block) handle.write(block)
@@ -471,10 +473,12 @@ def rename(from_path: str, to_path: str, force: bool = False) -> None:
shutil.move(from_path, to_path) shutil.move(from_path, to_path)
def untar_package(tar_path: str, dest_dir: str, rename_to: Optional[str] = None) -> None: def untar_package(
tar_path: str, dest_dir: str, rename_to: Optional[str] = None
) -> None:
tar_path = convert_path(tar_path) tar_path = convert_path(tar_path)
tar_dir_name = None tar_dir_name = None
with tarfile.open(tar_path, "r:gz") as tarball: with tarfile.open(tar_path, 'r') as tarball:
tarball.extractall(dest_dir) tarball.extractall(dest_dir)
tar_dir_name = os.path.commonprefix(tarball.getnames()) tar_dir_name = os.path.commonprefix(tarball.getnames())
if rename_to: if rename_to:
@@ -490,7 +494,7 @@ def chmod_and_retry(func, path, exc_info):
We want to retry most operations here, but listdir is one that we know will We want to retry most operations here, but listdir is one that we know will
be useless. be useless.
""" """
if func is os.listdir or os.name != "nt": if func is os.listdir or os.name != 'nt':
raise raise
os.chmod(path, stat.S_IREAD | stat.S_IWRITE) os.chmod(path, stat.S_IREAD | stat.S_IWRITE)
# on error,this will raise. # on error,this will raise.
@@ -506,12 +510,12 @@ def move(src, dst):
directory on windows when it has read-only files in it and the move is directory on windows when it has read-only files in it and the move is
between two drives. between two drives.
This is almost identical to the real shutil.move, except it, uses our rmtree This is almost identical to the real shutil.move, except it uses our rmtree
and skips handling non-windows OSes since the existing one works ok there. and skips handling non-windows OSes since the existing one works ok there.
""" """
src = convert_path(src) src = convert_path(src)
dst = convert_path(dst) dst = convert_path(dst)
if os.name != "nt": if os.name != 'nt':
return shutil.move(src, dst) return shutil.move(src, dst)
if os.path.isdir(dst): if os.path.isdir(dst):
@@ -519,7 +523,7 @@ def move(src, dst):
os.rename(src, dst) os.rename(src, dst)
return return
dst = os.path.join(dst, os.path.basename(src.rstrip("/\\"))) dst = os.path.join(dst, os.path.basename(src.rstrip('/\\')))
if os.path.exists(dst): if os.path.exists(dst):
raise EnvironmentError("Path '{}' already exists".format(dst)) raise EnvironmentError("Path '{}' already exists".format(dst))
@@ -528,10 +532,11 @@ def move(src, dst):
except OSError: except OSError:
# probably different drives # probably different drives
if os.path.isdir(src): if os.path.isdir(src):
if _absnorm(dst + "\\").startswith(_absnorm(src + "\\")): if _absnorm(dst + '\\').startswith(_absnorm(src + '\\')):
# dst is inside src # dst is inside src
raise EnvironmentError( raise EnvironmentError(
"Cannot move a directory '{}' into itself '{}'".format(src, dst) "Cannot move a directory '{}' into itself '{}'"
.format(src, dst)
) )
shutil.copytree(src, dst, symlinks=True) shutil.copytree(src, dst, symlinks=True)
rmtree(src) rmtree(src)
@@ -541,7 +546,7 @@ def move(src, dst):
def rmtree(path): def rmtree(path):
"""Recursively remove the path. On permissions errors on windows, try to remove """Recursively remove path. On permissions errors on windows, try to remove
the read-only flag and try again. the read-only flag and try again.
""" """
path = convert_path(path) path = convert_path(path)

View File

@@ -1,12 +1,19 @@
import dbt.exceptions import dbt.exceptions
from typing import Any, Dict, Optional from typing import Any, Dict, Optional
import yaml import yaml
import yaml.scanner
# the C version is faster, but it doesn't always exist # the C version is faster, but it doesn't always exist
try: try:
from yaml import CLoader as Loader, CSafeLoader as SafeLoader, CDumper as Dumper from yaml import (
CLoader as Loader,
CSafeLoader as SafeLoader,
CDumper as Dumper
)
except ImportError: except ImportError:
from yaml import Loader, SafeLoader, Dumper # type: ignore # noqa: F401 from yaml import ( # type: ignore # noqa: F401
Loader, SafeLoader, Dumper
)
YAML_ERROR_MESSAGE = """ YAML_ERROR_MESSAGE = """
@@ -26,12 +33,14 @@ def line_no(i, line, width=3):
def prefix_with_line_numbers(string, no_start, no_end): def prefix_with_line_numbers(string, no_start, no_end):
line_list = string.split("\n") line_list = string.split('\n')
numbers = range(no_start, no_end) numbers = range(no_start, no_end)
relevant_lines = line_list[no_start:no_end] relevant_lines = line_list[no_start:no_end]
return "\n".join([line_no(i + 1, line) for (i, line) in zip(numbers, relevant_lines)]) return "\n".join([
line_no(i + 1, line) for (i, line) in zip(numbers, relevant_lines)
])
def contextualized_yaml_error(raw_contents, error): def contextualized_yaml_error(raw_contents, error):
@@ -42,20 +51,20 @@ def contextualized_yaml_error(raw_contents, error):
nice_error = prefix_with_line_numbers(raw_contents, min_line, max_line) nice_error = prefix_with_line_numbers(raw_contents, min_line, max_line)
return YAML_ERROR_MESSAGE.format( return YAML_ERROR_MESSAGE.format(line_number=mark.line + 1,
line_number=mark.line + 1, nice_error=nice_error, raw_error=error nice_error=nice_error,
) raw_error=error)
def safe_load(contents) -> Optional[Dict[str, Any]]: def safe_load(contents) -> Optional[Dict[str, Any]]:
return yaml.load(contents, Loader=SafeLoader) return yaml.load(contents, Loader=SafeLoader)
def load_yaml_text(contents, path=None): def load_yaml_text(contents):
try: try:
return safe_load(contents) return safe_load(contents)
except (yaml.scanner.ScannerError, yaml.YAMLError) as e: except (yaml.scanner.ScannerError, yaml.YAMLError) as e:
if hasattr(e, "problem_mark"): if hasattr(e, 'problem_mark'):
error = contextualized_yaml_error(contents, e) error = contextualized_yaml_error(contents, e)
else: else:
error = str(e) error = str(e)

View File

@@ -3,18 +3,17 @@ from collections import defaultdict
from typing import List, Dict, Any, Tuple, cast, Optional from typing import List, Dict, Any, Tuple, cast, Optional
import networkx as nx # type: ignore import networkx as nx # type: ignore
import pickle
import sqlparse import sqlparse
from dbt import flags from dbt import flags
from dbt.adapters.factory import get_adapter from dbt.adapters.factory import get_adapter
from dbt.clients import jinja from dbt.clients import jinja
from dbt.clients.system import make_directory from dbt.clients.system import make_directory
from dbt.context.providers import generate_runtime_model_context from dbt.context.providers import generate_runtime_model
from dbt.contracts.graph.manifest import Manifest, UniqueID from dbt.contracts.graph.manifest import Manifest
from dbt.contracts.graph.compiled import ( from dbt.contracts.graph.compiled import (
COMPILED_TYPES, COMPILED_TYPES,
CompiledGenericTestNode, CompiledSchemaTestNode,
GraphMemberNode, GraphMemberNode,
InjectedCTE, InjectedCTE,
ManifestNode, ManifestNode,
@@ -27,35 +26,33 @@ from dbt.exceptions import (
RuntimeException, RuntimeException,
) )
from dbt.graph import Graph from dbt.graph import Graph
from dbt.events.functions import fire_event from dbt.logger import GLOBAL_LOGGER as logger
from dbt.events.types import FoundStats, CompilingNode, WritingInjectedSQLForNode
from dbt.node_types import NodeType from dbt.node_types import NodeType
from dbt.events.format import pluralize from dbt.utils import pluralize
import dbt.tracking import dbt.tracking
graph_file_name = "graph.gpickle" graph_file_name = 'graph.gpickle'
def _compiled_type_for(model: ParsedNode): def _compiled_type_for(model: ParsedNode):
if type(model) not in COMPILED_TYPES: if type(model) not in COMPILED_TYPES:
raise InternalException( raise InternalException(
f"Asked to compile {type(model)} node, but it has no compiled form" f'Asked to compile {type(model)} node, but it has no compiled form'
) )
return COMPILED_TYPES[type(model)] return COMPILED_TYPES[type(model)]
def print_compile_stats(stats): def print_compile_stats(stats):
names = { names = {
NodeType.Model: "model", NodeType.Model: 'model',
NodeType.Test: "test", NodeType.Test: 'test',
NodeType.Snapshot: "snapshot", NodeType.Snapshot: 'snapshot',
NodeType.Analysis: "analysis", NodeType.Analysis: 'analysis',
NodeType.Macro: "macro", NodeType.Macro: 'macro',
NodeType.Operation: "operation", NodeType.Operation: 'operation',
NodeType.Seed: "seed file", NodeType.Seed: 'seed file',
NodeType.Source: "source", NodeType.Source: 'source',
NodeType.Exposure: "exposure", NodeType.Exposure: 'exposure',
NodeType.Metric: "metric",
} }
results = {k: 0 for k in names.keys()} results = {k: 0 for k in names.keys()}
@@ -66,9 +63,12 @@ def print_compile_stats(stats):
resource_counts = {k.pluralize(): v for k, v in results.items()} resource_counts = {k.pluralize(): v for k, v in results.items()}
dbt.tracking.track_resource_counts(resource_counts) dbt.tracking.track_resource_counts(resource_counts)
stat_line = ", ".join([pluralize(ct, names.get(t)) for t, ct in results.items() if t in names]) stat_line = ", ".join([
pluralize(ct, names.get(t)) for t, ct in results.items()
if t in names
])
fire_event(FoundStats(stat_line=stat_line)) logger.info("Found {}".format(stat_line))
def _node_enabled(node: ManifestNode): def _node_enabled(node: ManifestNode):
@@ -89,8 +89,6 @@ def _generate_stats(manifest: Manifest):
stats[source.resource_type] += 1 stats[source.resource_type] += 1
for exposure in manifest.exposures.values(): for exposure in manifest.exposures.values():
stats[exposure.resource_type] += 1 stats[exposure.resource_type] += 1
for metric in manifest.metrics.values():
stats[metric.resource_type] += 1
for macro in manifest.macros.values(): for macro in manifest.macros.values():
stats[macro.resource_type] += 1 stats[macro.resource_type] += 1
return stats return stats
@@ -109,19 +107,6 @@ def _extend_prepended_ctes(prepended_ctes, new_prepended_ctes):
_add_prepended_cte(prepended_ctes, new_cte) _add_prepended_cte(prepended_ctes, new_cte)
def _get_tests_for_node(manifest: Manifest, unique_id: UniqueID) -> List[UniqueID]:
"""Get a list of tests that depend on the node with the
provided unique id"""
tests = []
if unique_id in manifest.child_map:
for child_unique_id in manifest.child_map[unique_id]:
if child_unique_id.startswith("test."):
tests.append(child_unique_id)
return tests
class Linker: class Linker:
def __init__(self, data=None): def __init__(self, data=None):
if data is None: if data is None:
@@ -157,11 +142,10 @@ class Linker:
include all nodes in their corresponding graph entries. include all nodes in their corresponding graph entries.
""" """
out_graph = self.graph.copy() out_graph = self.graph.copy()
for node_id in self.graph: for node_id in self.graph.nodes():
data = manifest.expect(node_id).to_dict(omit_none=True) data = manifest.expect(node_id).to_dict(omit_none=True)
out_graph.add_node(node_id, **data) out_graph.add_node(node_id, **data)
with open(outfile, "wb") as outfh: nx.write_gpickle(out_graph, outfile)
pickle.dump(out_graph, outfh, protocol=pickle.HIGHEST_PROTOCOL)
class Compiler: class Compiler:
@@ -170,7 +154,7 @@ class Compiler:
def initialize(self): def initialize(self):
make_directory(self.config.target_path) make_directory(self.config.target_path)
make_directory(self.config.packages_install_path) make_directory(self.config.modules_path)
# creates a ModelContext which is converted to # creates a ModelContext which is converted to
# a dict for jinja rendering of SQL # a dict for jinja rendering of SQL
@@ -181,9 +165,11 @@ class Compiler:
extra_context: Dict[str, Any], extra_context: Dict[str, Any],
) -> Dict[str, Any]: ) -> Dict[str, Any]:
context = generate_runtime_model_context(node, self.config, manifest) context = generate_runtime_model(
node, self.config, manifest
)
context.update(extra_context) context.update(extra_context)
if isinstance(node, CompiledGenericTestNode): if isinstance(node, CompiledSchemaTestNode):
# for test nodes, add a special keyword args value to the context # for test nodes, add a special keyword args value to the context
jinja.add_rendered_test_kwargs(context, node) jinja.add_rendered_test_kwargs(context, node)
@@ -239,21 +225,26 @@ class Compiler:
with_stmt = None with_stmt = None
for token in parsed.tokens: for token in parsed.tokens:
if token.is_keyword and token.normalized == "WITH": if token.is_keyword and token.normalized == 'WITH':
with_stmt = token with_stmt = token
break break
if with_stmt is None: if with_stmt is None:
# no with stmt, add one, and inject CTEs right at the beginning # no with stmt, add one, and inject CTEs right at the beginning
first_token = parsed.token_first() first_token = parsed.token_first()
with_stmt = sqlparse.sql.Token(sqlparse.tokens.Keyword, "with") with_stmt = sqlparse.sql.Token(sqlparse.tokens.Keyword, 'with')
parsed.insert_before(first_token, with_stmt) parsed.insert_before(first_token, with_stmt)
else: else:
# stmt exists, add a comma (which will come after injected CTEs) # stmt exists, add a comma (which will come after injected CTEs)
trailing_comma = sqlparse.sql.Token(sqlparse.tokens.Punctuation, ",") trailing_comma = sqlparse.sql.Token(
sqlparse.tokens.Punctuation, ','
)
parsed.insert_after(with_stmt, trailing_comma) parsed.insert_after(with_stmt, trailing_comma)
token = sqlparse.sql.Token(sqlparse.tokens.Keyword, ", ".join(c.sql for c in ctes)) token = sqlparse.sql.Token(
sqlparse.tokens.Keyword,
", ".join(c.sql for c in ctes)
)
parsed.insert_after(with_stmt, token) parsed.insert_after(with_stmt, token)
return str(parsed) return str(parsed)
@@ -272,7 +263,9 @@ class Compiler:
inserting CTEs into the SQL. inserting CTEs into the SQL.
""" """
if model.compiled_sql is None: if model.compiled_sql is None:
raise RuntimeException("Cannot inject ctes into an unparsed node", model) raise RuntimeException(
'Cannot inject ctes into an unparsed node', model
)
if model.extra_ctes_injected: if model.extra_ctes_injected:
return (model, model.extra_ctes) return (model, model.extra_ctes)
@@ -293,17 +286,17 @@ class Compiler:
for cte in model.extra_ctes: for cte in model.extra_ctes:
if cte.id not in manifest.nodes: if cte.id not in manifest.nodes:
raise InternalException( raise InternalException(
f"During compilation, found a cte reference that " f'During compilation, found a cte reference that '
f"could not be resolved: {cte.id}" f'could not be resolved: {cte.id}'
) )
cte_model = manifest.nodes[cte.id] cte_model = manifest.nodes[cte.id]
if not cte_model.is_ephemeral_model: if not cte_model.is_ephemeral_model:
raise InternalException(f"{cte.id} is not ephemeral") raise InternalException(f'{cte.id} is not ephemeral')
# This model has already been compiled, so it's been # This model has already been compiled, so it's been
# through here before # through here before
if getattr(cte_model, "compiled", False): if getattr(cte_model, 'compiled', False):
assert isinstance(cte_model, tuple(COMPILED_TYPES.values())) assert isinstance(cte_model, tuple(COMPILED_TYPES.values()))
cte_model = cast(NonSourceCompiledNode, cte_model) cte_model = cast(NonSourceCompiledNode, cte_model)
new_prepended_ctes = cte_model.extra_ctes new_prepended_ctes = cte_model.extra_ctes
@@ -312,11 +305,13 @@ class Compiler:
else: else:
# This is an ephemeral parsed model that we can compile. # This is an ephemeral parsed model that we can compile.
# Compile and update the node # Compile and update the node
cte_model = self._compile_node(cte_model, manifest, extra_context) cte_model = self._compile_node(
cte_model, manifest, extra_context)
# recursively call this method # recursively call this method
cte_model, new_prepended_ctes = self._recursively_prepend_ctes( cte_model, new_prepended_ctes = \
cte_model, manifest, extra_context self._recursively_prepend_ctes(
) cte_model, manifest, extra_context
)
# Save compiled SQL file and sync manifest # Save compiled SQL file and sync manifest
self._write_node(cte_model) self._write_node(cte_model)
manifest.sync_update_node(cte_model) manifest.sync_update_node(cte_model)
@@ -324,8 +319,10 @@ class Compiler:
_extend_prepended_ctes(prepended_ctes, new_prepended_ctes) _extend_prepended_ctes(prepended_ctes, new_prepended_ctes)
new_cte_name = self.add_ephemeral_prefix(cte_model.name) new_cte_name = self.add_ephemeral_prefix(cte_model.name)
rendered_sql = cte_model._pre_injected_sql or cte_model.compiled_sql rendered_sql = (
sql = f" {new_cte_name} as (\n{rendered_sql}\n)" cte_model._pre_injected_sql or cte_model.compiled_sql
)
sql = f' {new_cte_name} as (\n{rendered_sql}\n)'
_add_prepended_cte(prepended_ctes, InjectedCTE(id=cte.id, sql=sql)) _add_prepended_cte(prepended_ctes, InjectedCTE(id=cte.id, sql=sql))
@@ -356,20 +353,20 @@ class Compiler:
if extra_context is None: if extra_context is None:
extra_context = {} extra_context = {}
fire_event(CompilingNode(unique_id=node.unique_id)) logger.debug("Compiling {}".format(node.unique_id))
data = node.to_dict(omit_none=True) data = node.to_dict(omit_none=True)
data.update( data.update({
{ 'compiled': False,
"compiled": False, 'compiled_sql': None,
"compiled_sql": None, 'extra_ctes_injected': False,
"extra_ctes_injected": False, 'extra_ctes': [],
"extra_ctes": [], })
}
)
compiled_node = _compiled_type_for(node).from_dict(data) compiled_node = _compiled_type_for(node).from_dict(data)
context = self._create_node_context(compiled_node, manifest, extra_context) context = self._create_node_context(
compiled_node, manifest, extra_context
)
compiled_node.compiled_sql = jinja.get_rendered( compiled_node.compiled_sql = jinja.get_rendered(
node.raw_sql, node.raw_sql,
@@ -389,95 +386,44 @@ class Compiler:
if flags.WRITE_JSON: if flags.WRITE_JSON:
linker.write_graph(graph_path, manifest) linker.write_graph(graph_path, manifest)
def link_node(self, linker: Linker, node: GraphMemberNode, manifest: Manifest): def link_node(
self, linker: Linker, node: GraphMemberNode, manifest: Manifest
):
linker.add_node(node.unique_id) linker.add_node(node.unique_id)
for dependency in node.depends_on_nodes: for dependency in node.depends_on_nodes:
if dependency in manifest.nodes: if dependency in manifest.nodes:
linker.dependency(node.unique_id, (manifest.nodes[dependency].unique_id)) linker.dependency(
node.unique_id,
(manifest.nodes[dependency].unique_id)
)
elif dependency in manifest.sources: elif dependency in manifest.sources:
linker.dependency(node.unique_id, (manifest.sources[dependency].unique_id)) linker.dependency(
elif dependency in manifest.metrics: node.unique_id,
linker.dependency(node.unique_id, (manifest.metrics[dependency].unique_id)) (manifest.sources[dependency].unique_id)
)
else: else:
dependency_not_found(node, dependency) dependency_not_found(node, dependency)
def link_graph(self, linker: Linker, manifest: Manifest, add_test_edges: bool = False): def link_graph(self, linker: Linker, manifest: Manifest):
for source in manifest.sources.values(): for source in manifest.sources.values():
linker.add_node(source.unique_id) linker.add_node(source.unique_id)
for node in manifest.nodes.values(): for node in manifest.nodes.values():
self.link_node(linker, node, manifest) self.link_node(linker, node, manifest)
for exposure in manifest.exposures.values(): for exposure in manifest.exposures.values():
self.link_node(linker, exposure, manifest) self.link_node(linker, exposure, manifest)
for metric in manifest.metrics.values(): # linker.add_node(exposure.unique_id)
self.link_node(linker, metric, manifest)
cycle = linker.find_cycles() cycle = linker.find_cycles()
if cycle: if cycle:
raise RuntimeError("Found a cycle: {}".format(cycle)) raise RuntimeError("Found a cycle: {}".format(cycle))
if add_test_edges: def compile(self, manifest: Manifest, write=True) -> Graph:
manifest.build_parent_and_child_maps()
self.add_test_edges(linker, manifest)
def add_test_edges(self, linker: Linker, manifest: Manifest) -> None:
"""This method adds additional edges to the DAG. For a given non-test
executable node, add an edge from an upstream test to the given node if
the set of nodes the test depends on is a subset of the upstream nodes
for the given node."""
# Given a graph:
# model1 --> model2 --> model3
# | |
# | \/
# \/ test 2
# test1
#
# Produce the following graph:
# model1 --> model2 --> model3
# | /\ | /\ /\
# | | \/ | |
# \/ | test2 ----| |
# test1 ----|---------------|
for node_id in linker.graph:
# If node is executable (in manifest.nodes) and does _not_
# represent a test, continue.
if (
node_id in manifest.nodes
and manifest.nodes[node_id].resource_type != NodeType.Test
):
# Get *everything* upstream of the node
all_upstream_nodes = nx.traversal.bfs_tree(linker.graph, node_id, reverse=True)
# Get the set of upstream nodes not including the current node.
upstream_nodes = set([n for n in all_upstream_nodes if n != node_id])
# Get all tests that depend on any upstream nodes.
upstream_tests = []
for upstream_node in upstream_nodes:
upstream_tests += _get_tests_for_node(manifest, upstream_node)
for upstream_test in upstream_tests:
# Get the set of all nodes that the test depends on
# including the upstream_node itself. This is necessary
# because tests can depend on multiple nodes (ex:
# relationship tests). Test nodes do not distinguish
# between what node the test is "testing" and what
# node(s) it depends on.
test_depends_on = set(manifest.nodes[upstream_test].depends_on_nodes)
# If the set of nodes that an upstream test depends on
# is a subset of all upstream nodes of the current node,
# add an edge from the upstream test to the current node.
if test_depends_on.issubset(upstream_nodes):
linker.graph.add_edge(upstream_test, node_id)
def compile(self, manifest: Manifest, write=True, add_test_edges=False) -> Graph:
self.initialize() self.initialize()
linker = Linker() linker = Linker()
self.link_graph(linker, manifest, add_test_edges) self.link_graph(linker, manifest)
stats = _generate_stats(manifest) stats = _generate_stats(manifest)
@@ -489,13 +435,16 @@ class Compiler:
# writes the "compiled_sql" into the target/compiled directory # writes the "compiled_sql" into the target/compiled directory
def _write_node(self, node: NonSourceCompiledNode) -> ManifestNode: def _write_node(self, node: NonSourceCompiledNode) -> ManifestNode:
if not node.extra_ctes_injected or node.resource_type == NodeType.Snapshot: if (not node.extra_ctes_injected or
node.resource_type == NodeType.Snapshot):
return node return node
fire_event(WritingInjectedSQLForNode(unique_id=node.unique_id)) logger.debug(f'Writing injected SQL for node "{node.unique_id}"')
if node.compiled_sql: if node.compiled_sql:
node.compiled_path = node.write_node( node.compiled_path = node.write_node(
self.config.target_path, "compiled", node.compiled_sql self.config.target_path,
'compiled',
node.compiled_sql
) )
return node return node
@@ -514,7 +463,9 @@ class Compiler:
""" """
node = self._compile_node(node, manifest, extra_context) node = self._compile_node(node, manifest, extra_context)
node, _ = self._recursively_prepend_ctes(node, manifest, extra_context) node, _ = self._recursively_prepend_ctes(
node, manifest, extra_context
)
if write: if write:
self._write_node(node) self._write_node(node)
return node return node

View File

@@ -1 +0,0 @@
# Config README

View File

@@ -1,4 +1,4 @@
# all these are just exports, they need "noqa" so flake8 will not complain. # all these are just exports, they need "noqa" so flake8 will not complain.
from .profile import Profile, read_user_config # noqa from .profile import Profile, PROFILES_DIR, read_user_config # noqa
from .project import Project, IsFQNResource # noqa from .project import Project, IsFQNResource # noqa
from .runtime import RuntimeConfig, UnsetProfileConfig # noqa from .runtime import RuntimeConfig, UnsetProfileConfig # noqa

View File

@@ -4,7 +4,6 @@ import os
from dbt.dataclass_schema import ValidationError from dbt.dataclass_schema import ValidationError
from dbt import flags
from dbt.clients.system import load_file_contents from dbt.clients.system import load_file_contents
from dbt.clients.yaml_helper import load_yaml_text from dbt.clients.yaml_helper import load_yaml_text
from dbt.contracts.connection import Credentials, HasCredentials from dbt.contracts.connection import Credentials, HasCredentials
@@ -15,15 +14,16 @@ from dbt.exceptions import DbtProjectError
from dbt.exceptions import ValidationException from dbt.exceptions import ValidationException
from dbt.exceptions import RuntimeException from dbt.exceptions import RuntimeException
from dbt.exceptions import validator_error_message from dbt.exceptions import validator_error_message
from dbt.events.types import MissingProfileTarget from dbt.logger import GLOBAL_LOGGER as logger
from dbt.events.functions import fire_event
from dbt.utils import coerce_dict_str from dbt.utils import coerce_dict_str
from .renderer import ProfileRenderer from .renderer import ProfileRenderer
DEFAULT_THREADS = 1 DEFAULT_THREADS = 1
DEFAULT_PROFILES_DIR = os.path.join(os.path.expanduser('~'), '.dbt')
DEFAULT_PROFILES_DIR = os.path.join(os.path.expanduser("~"), ".dbt") PROFILES_DIR = os.path.expanduser(
os.getenv('DBT_PROFILES_DIR', DEFAULT_PROFILES_DIR)
)
INVALID_PROFILE_MESSAGE = """ INVALID_PROFILE_MESSAGE = """
dbt encountered an error while trying to read your profiles.yml file. dbt encountered an error while trying to read your profiles.yml file.
@@ -43,13 +43,11 @@ Here, [profile name] should be replaced with a profile name
defined in your profiles.yml file. You can find profiles.yml here: defined in your profiles.yml file. You can find profiles.yml here:
{profiles_file}/profiles.yml {profiles_file}/profiles.yml
""".format( """.format(profiles_file=PROFILES_DIR)
profiles_file=DEFAULT_PROFILES_DIR
)
def read_profile(profiles_dir: str) -> Dict[str, Any]: def read_profile(profiles_dir: str) -> Dict[str, Any]:
path = os.path.join(profiles_dir, "profiles.yml") path = os.path.join(profiles_dir, 'profiles.yml')
contents = None contents = None
if os.path.isfile(path): if os.path.isfile(path):
@@ -57,8 +55,12 @@ def read_profile(profiles_dir: str) -> Dict[str, Any]:
contents = load_file_contents(path, strip=False) contents = load_file_contents(path, strip=False)
yaml_content = load_yaml_text(contents) yaml_content = load_yaml_text(contents)
if not yaml_content: if not yaml_content:
msg = f"The profiles.yml file at {path} is empty" msg = f'The profiles.yml file at {path} is empty'
raise DbtProfileError(INVALID_PROFILE_MESSAGE.format(error_string=msg)) raise DbtProfileError(
INVALID_PROFILE_MESSAGE.format(
error_string=msg
)
)
return yaml_content return yaml_content
except ValidationException as e: except ValidationException as e:
msg = INVALID_PROFILE_MESSAGE.format(error_string=e) msg = INVALID_PROFILE_MESSAGE.format(error_string=e)
@@ -71,10 +73,10 @@ def read_user_config(directory: str) -> UserConfig:
try: try:
profile = read_profile(directory) profile = read_profile(directory)
if profile: if profile:
user_config = coerce_dict_str(profile.get("config", {})) user_cfg = coerce_dict_str(profile.get('config', {}))
if user_config is not None: if user_cfg is not None:
UserConfig.validate(user_config) UserConfig.validate(user_cfg)
return UserConfig.from_dict(user_config) return UserConfig.from_dict(user_cfg)
except (RuntimeException, ValidationError): except (RuntimeException, ValidationError):
pass pass
return UserConfig() return UserConfig()
@@ -87,30 +89,30 @@ def read_user_config(directory: str) -> UserConfig:
class Profile(HasCredentials): class Profile(HasCredentials):
profile_name: str profile_name: str
target_name: str target_name: str
user_config: UserConfig config: UserConfig
threads: int threads: int
credentials: Credentials credentials: Credentials
profile_env_vars: Dict[str, Any]
def __init__( def __init__(
self, self,
profile_name: str, profile_name: str,
target_name: str, target_name: str,
user_config: UserConfig, config: UserConfig,
threads: int, threads: int,
credentials: Credentials, credentials: Credentials
): ):
"""Explicitly defining `__init__` to work around bug in Python 3.9.7 """Explicitly defining `__init__` to work around bug in Python 3.9.7
https://bugs.python.org/issue45081 https://bugs.python.org/issue45081
""" """
self.profile_name = profile_name self.profile_name = profile_name
self.target_name = target_name self.target_name = target_name
self.user_config = user_config self.config = config
self.threads = threads self.threads = threads
self.credentials = credentials self.credentials = credentials
self.profile_env_vars = {} # never available on init
def to_profile_info(self, serialize_credentials: bool = False) -> Dict[str, Any]: def to_profile_info(
self, serialize_credentials: bool = False
) -> Dict[str, Any]:
"""Unlike to_project_config, this dict is not a mirror of any existing """Unlike to_project_config, this dict is not a mirror of any existing
on-disk data structure. It's used when creating a new profile from an on-disk data structure. It's used when creating a new profile from an
existing one. existing one.
@@ -120,33 +122,34 @@ class Profile(HasCredentials):
:returns dict: The serialized profile. :returns dict: The serialized profile.
""" """
result = { result = {
"profile_name": self.profile_name, 'profile_name': self.profile_name,
"target_name": self.target_name, 'target_name': self.target_name,
"user_config": self.user_config, 'config': self.config,
"threads": self.threads, 'threads': self.threads,
"credentials": self.credentials, 'credentials': self.credentials,
} }
if serialize_credentials: if serialize_credentials:
result["user_config"] = self.user_config.to_dict(omit_none=True) result['config'] = self.config.to_dict(omit_none=True)
result["credentials"] = self.credentials.to_dict(omit_none=True) result['credentials'] = self.credentials.to_dict(omit_none=True)
return result return result
def to_target_dict(self) -> Dict[str, Any]: def to_target_dict(self) -> Dict[str, Any]:
target = dict(self.credentials.connection_info(with_aliases=True)) target = dict(
target.update( self.credentials.connection_info(with_aliases=True)
{
"type": self.credentials.type,
"threads": self.threads,
"name": self.target_name,
"target_name": self.target_name,
"profile_name": self.profile_name,
"config": self.user_config.to_dict(omit_none=True),
}
) )
target.update({
'type': self.credentials.type,
'threads': self.threads,
'name': self.target_name,
'target_name': self.target_name,
'profile_name': self.profile_name,
'config': self.config.to_dict(omit_none=True),
})
return target return target
def __eq__(self, other: object) -> bool: def __eq__(self, other: object) -> bool:
if not (isinstance(other, self.__class__) and isinstance(self, other.__class__)): if not (isinstance(other, self.__class__) and
isinstance(self, other.__class__)):
return NotImplemented return NotImplemented
return self.to_profile_info() == other.to_profile_info() return self.to_profile_info() == other.to_profile_info()
@@ -166,17 +169,14 @@ class Profile(HasCredentials):
) -> Credentials: ) -> Credentials:
# avoid an import cycle # avoid an import cycle
from dbt.adapters.factory import load_plugin from dbt.adapters.factory import load_plugin
# credentials carry their 'type' in their actual type, not their # credentials carry their 'type' in their actual type, not their
# attributes. We do want this in order to pick our Credentials class. # attributes. We do want this in order to pick our Credentials class.
if "type" not in profile: if 'type' not in profile:
raise DbtProfileError( raise DbtProfileError(
'required field "type" not found in profile {} and target {}'.format( 'required field "type" not found in profile {} and target {}'
profile_name, target_name .format(profile_name, target_name))
)
)
typename = profile.pop("type") typename = profile.pop('type')
try: try:
cls = load_plugin(typename) cls = load_plugin(typename)
data = cls.translate_aliases(profile) data = cls.translate_aliases(profile)
@@ -185,9 +185,8 @@ class Profile(HasCredentials):
except (RuntimeException, ValidationError) as e: except (RuntimeException, ValidationError) as e:
msg = str(e) if isinstance(e, RuntimeException) else e.message msg = str(e) if isinstance(e, RuntimeException) else e.message
raise DbtProfileError( raise DbtProfileError(
'Credentials in profile "{}", target "{}" invalid: {}'.format( 'Credentials in profile "{}", target "{}" invalid: {}'
profile_name, target_name, msg .format(profile_name, target_name, msg)
)
) from e ) from e
return credentials return credentials
@@ -208,19 +207,19 @@ class Profile(HasCredentials):
def _get_profile_data( def _get_profile_data(
profile: Dict[str, Any], profile_name: str, target_name: str profile: Dict[str, Any], profile_name: str, target_name: str
) -> Dict[str, Any]: ) -> Dict[str, Any]:
if "outputs" not in profile: if 'outputs' not in profile:
raise DbtProfileError("outputs not specified in profile '{}'".format(profile_name)) raise DbtProfileError(
outputs = profile["outputs"] "outputs not specified in profile '{}'".format(profile_name)
)
outputs = profile['outputs']
if target_name not in outputs: if target_name not in outputs:
outputs = "\n".join(" - {}".format(output) for output in outputs) outputs = '\n'.join(' - {}'.format(output)
msg = ( for output in outputs)
"The profile '{}' does not have a target named '{}'. The " msg = ("The profile '{}' does not have a target named '{}'. The "
"valid target names for this profile are:\n{}".format( "valid target names for this profile are:\n{}"
profile_name, target_name, outputs .format(profile_name, target_name, outputs))
) raise DbtProfileError(msg, result_type='invalid_target')
)
raise DbtProfileError(msg, result_type="invalid_target")
profile_data = outputs[target_name] profile_data = outputs[target_name]
if not isinstance(profile_data, dict): if not isinstance(profile_data, dict):
@@ -228,7 +227,7 @@ class Profile(HasCredentials):
f"output '{target_name}' of profile '{profile_name}' is " f"output '{target_name}' of profile '{profile_name}' is "
f"misconfigured in profiles.yml" f"misconfigured in profiles.yml"
) )
raise DbtProfileError(msg, result_type="invalid_target") raise DbtProfileError(msg, result_type='invalid_target')
return profile_data return profile_data
@@ -239,8 +238,8 @@ class Profile(HasCredentials):
threads: int, threads: int,
profile_name: str, profile_name: str,
target_name: str, target_name: str,
user_config: Optional[Dict[str, Any]] = None, user_cfg: Optional[Dict[str, Any]] = None
) -> "Profile": ) -> 'Profile':
"""Create a profile from an existing set of Credentials and the """Create a profile from an existing set of Credentials and the
remaining information. remaining information.
@@ -248,22 +247,22 @@ class Profile(HasCredentials):
:param threads: The number of threads to use for connections. :param threads: The number of threads to use for connections.
:param profile_name: The profile name used for this profile. :param profile_name: The profile name used for this profile.
:param target_name: The target name used for this profile. :param target_name: The target name used for this profile.
:param user_config: The user-level config block from the :param user_cfg: The user-level config block from the
raw profiles, if specified. raw profiles, if specified.
:raises DbtProfileError: If the profile is invalid. :raises DbtProfileError: If the profile is invalid.
:returns: The new Profile object. :returns: The new Profile object.
""" """
if user_config is None: if user_cfg is None:
user_config = {} user_cfg = {}
UserConfig.validate(user_config) UserConfig.validate(user_cfg)
user_config_obj: UserConfig = UserConfig.from_dict(user_config) config = UserConfig.from_dict(user_cfg)
profile = cls( profile = cls(
profile_name=profile_name, profile_name=profile_name,
target_name=target_name, target_name=target_name,
user_config=user_config_obj, config=config,
threads=threads, threads=threads,
credentials=credentials, credentials=credentials
) )
profile.validate() profile.validate()
return profile return profile
@@ -288,14 +287,19 @@ class Profile(HasCredentials):
# name to extract a profile that we can render. # name to extract a profile that we can render.
if target_override is not None: if target_override is not None:
target_name = target_override target_name = target_override
elif "target" in raw_profile: elif 'target' in raw_profile:
# render the target if it was parsed from yaml # render the target if it was parsed from yaml
target_name = renderer.render_value(raw_profile["target"]) target_name = renderer.render_value(raw_profile['target'])
else: else:
target_name = "default" target_name = 'default'
fire_event(MissingProfileTarget(profile_name=profile_name, target_name=target_name)) logger.debug(
"target not specified in profile '{}', using '{}'"
.format(profile_name, target_name)
)
raw_profile_data = cls._get_profile_data(raw_profile, profile_name, target_name) raw_profile_data = cls._get_profile_data(
raw_profile, profile_name, target_name
)
try: try:
profile_data = renderer.render_data(raw_profile_data) profile_data = renderer.render_data(raw_profile_data)
@@ -309,10 +313,10 @@ class Profile(HasCredentials):
raw_profile: Dict[str, Any], raw_profile: Dict[str, Any],
profile_name: str, profile_name: str,
renderer: ProfileRenderer, renderer: ProfileRenderer,
user_config: Optional[Dict[str, Any]] = None, user_cfg: Optional[Dict[str, Any]] = None,
target_override: Optional[str] = None, target_override: Optional[str] = None,
threads_override: Optional[int] = None, threads_override: Optional[int] = None,
) -> "Profile": ) -> 'Profile':
"""Create a profile from its raw profile information. """Create a profile from its raw profile information.
(this is an intermediate step, mostly useful for unit testing) (this is an intermediate step, mostly useful for unit testing)
@@ -321,7 +325,7 @@ class Profile(HasCredentials):
disk as yaml and its values rendered with jinja. disk as yaml and its values rendered with jinja.
:param profile_name: The profile name used. :param profile_name: The profile name used.
:param renderer: The config renderer. :param renderer: The config renderer.
:param user_config: The global config for the user, if it :param user_cfg: The global config for the user, if it
was present. was present.
:param target_override: The target to use, if provided on :param target_override: The target to use, if provided on
the command line. the command line.
@@ -331,9 +335,9 @@ class Profile(HasCredentials):
target could not be found target could not be found
:returns: The new Profile object. :returns: The new Profile object.
""" """
# user_config is not rendered. # user_cfg is not rendered.
if user_config is None: if user_cfg is None:
user_config = raw_profile.get("config") user_cfg = raw_profile.get('config')
# TODO: should it be, and the values coerced to bool? # TODO: should it be, and the values coerced to bool?
target_name, profile_data = cls.render_profile( target_name, profile_data = cls.render_profile(
raw_profile, profile_name, target_override, renderer raw_profile, profile_name, target_override, renderer
@@ -341,7 +345,7 @@ class Profile(HasCredentials):
# valid connections never include the number of threads, but it's # valid connections never include the number of threads, but it's
# stored on a per-connection level in the raw configs # stored on a per-connection level in the raw configs
threads = profile_data.pop("threads", DEFAULT_THREADS) threads = profile_data.pop('threads', DEFAULT_THREADS)
if threads_override is not None: if threads_override is not None:
threads = threads_override threads = threads_override
@@ -354,7 +358,7 @@ class Profile(HasCredentials):
profile_name=profile_name, profile_name=profile_name,
target_name=target_name, target_name=target_name,
threads=threads, threads=threads,
user_config=user_config, user_cfg=user_cfg
) )
@classmethod @classmethod
@@ -365,7 +369,7 @@ class Profile(HasCredentials):
renderer: ProfileRenderer, renderer: ProfileRenderer,
target_override: Optional[str] = None, target_override: Optional[str] = None,
threads_override: Optional[int] = None, threads_override: Optional[int] = None,
) -> "Profile": ) -> 'Profile':
""" """
:param raw_profiles: The profile data, from disk as yaml. :param raw_profiles: The profile data, from disk as yaml.
:param profile_name: The profile name to use. :param profile_name: The profile name to use.
@@ -381,21 +385,29 @@ class Profile(HasCredentials):
:returns: The new Profile object. :returns: The new Profile object.
""" """
if profile_name not in raw_profiles: if profile_name not in raw_profiles:
raise DbtProjectError("Could not find profile named '{}'".format(profile_name)) raise DbtProjectError(
"Could not find profile named '{}'".format(profile_name)
)
# First, we've already got our final decision on profile name, and we # First, we've already got our final decision on profile name, and we
# don't render keys, so we can pluck that out # don't render keys, so we can pluck that out
raw_profile = raw_profiles[profile_name] raw_profile = raw_profiles[profile_name]
if not raw_profile: if not raw_profile:
msg = f"Profile {profile_name} in profiles.yml is empty" msg = (
raise DbtProfileError(INVALID_PROFILE_MESSAGE.format(error_string=msg)) f'Profile {profile_name} in profiles.yml is empty'
user_config = raw_profiles.get("config") )
raise DbtProfileError(
INVALID_PROFILE_MESSAGE.format(
error_string=msg
)
)
user_cfg = raw_profiles.get('config')
return cls.from_raw_profile_info( return cls.from_raw_profile_info(
raw_profile=raw_profile, raw_profile=raw_profile,
profile_name=profile_name, profile_name=profile_name,
renderer=renderer, renderer=renderer,
user_config=user_config, user_cfg=user_cfg,
target_override=target_override, target_override=target_override,
threads_override=threads_override, threads_override=threads_override,
) )
@@ -406,7 +418,7 @@ class Profile(HasCredentials):
args: Any, args: Any,
renderer: ProfileRenderer, renderer: ProfileRenderer,
project_profile_name: Optional[str], project_profile_name: Optional[str],
) -> "Profile": ) -> 'Profile':
"""Given the raw profiles as read from disk and the name of the desired """Given the raw profiles as read from disk and the name of the desired
profile if specified, return the profile component of the runtime profile if specified, return the profile component of the runtime
config. config.
@@ -421,14 +433,15 @@ class Profile(HasCredentials):
target could not be found. target could not be found.
:returns Profile: The new Profile object. :returns Profile: The new Profile object.
""" """
threads_override = getattr(args, "threads", None) threads_override = getattr(args, 'threads', None)
target_override = getattr(args, "target", None) target_override = getattr(args, 'target', None)
raw_profiles = read_profile(flags.PROFILES_DIR) raw_profiles = read_profile(args.profiles_dir)
profile_name = cls.pick_profile_name(getattr(args, "profile", None), project_profile_name) profile_name = cls.pick_profile_name(getattr(args, 'profile', None),
project_profile_name)
return cls.from_raw_profiles( return cls.from_raw_profiles(
raw_profiles=raw_profiles, raw_profiles=raw_profiles,
profile_name=profile_name, profile_name=profile_name,
renderer=renderer, renderer=renderer,
target_override=target_override, target_override=target_override,
threads_override=threads_override, threads_override=threads_override
) )

View File

@@ -2,20 +2,13 @@ from copy import deepcopy
from dataclasses import dataclass, field from dataclasses import dataclass, field
from itertools import chain from itertools import chain
from typing import ( from typing import (
List, List, Dict, Any, Optional, TypeVar, Union, Mapping,
Dict,
Any,
Optional,
TypeVar,
Union,
Mapping,
) )
from typing_extensions import Protocol, runtime_checkable from typing_extensions import Protocol, runtime_checkable
import hashlib import hashlib
import os import os
from dbt import flags, deprecations
from dbt.clients.system import resolve_path_from_base from dbt.clients.system import resolve_path_from_base
from dbt.clients.system import path_exists from dbt.clients.system import path_exists
from dbt.clients.system import load_file_contents from dbt.clients.system import load_file_contents
@@ -51,7 +44,7 @@ INVALID_VERSION_ERROR = """\
This version of dbt is not supported with the '{package}' package. This version of dbt is not supported with the '{package}' package.
Installed version of dbt: {installed} Installed version of dbt: {installed}
Required version of dbt for '{package}': {version_spec} Required version of dbt for '{package}': {version_spec}
Check for a different version of the '{package}' package, or run dbt again with \ Check the requirements for the '{package}' package, or run dbt again with \
--no-version-check --no-version-check
""" """
@@ -60,7 +53,7 @@ IMPOSSIBLE_VERSION_ERROR = """\
The package version requirement can never be satisfied for the '{package} The package version requirement can never be satisfied for the '{package}
package. package.
Required versions of dbt for '{package}': {version_spec} Required versions of dbt for '{package}': {version_spec}
Check for a different version of the '{package}' package, or run dbt again with \ Check the requirements for the '{package}' package, or run dbt again with \
--no-version-check --no-version-check
""" """
@@ -89,7 +82,9 @@ def _load_yaml(path):
def package_data_from_root(project_root): def package_data_from_root(project_root):
package_filepath = resolve_path_from_base("packages.yml", project_root) package_filepath = resolve_path_from_base(
'packages.yml', project_root
)
if path_exists(package_filepath): if path_exists(package_filepath):
packages_dict = _load_yaml(package_filepath) packages_dict = _load_yaml(package_filepath)
@@ -100,13 +95,15 @@ def package_data_from_root(project_root):
def package_config_from_data(packages_data: Dict[str, Any]): def package_config_from_data(packages_data: Dict[str, Any]):
if not packages_data: if not packages_data:
packages_data = {"packages": []} packages_data = {'packages': []}
try: try:
PackageConfig.validate(packages_data) PackageConfig.validate(packages_data)
packages = PackageConfig.from_dict(packages_data) packages = PackageConfig.from_dict(packages_data)
except ValidationError as e: except ValidationError as e:
raise DbtProjectError(MALFORMED_PACKAGE_ERROR.format(error=str(e.message))) from e raise DbtProjectError(
MALFORMED_PACKAGE_ERROR.format(error=str(e.message))
) from e
return packages return packages
@@ -121,32 +118,22 @@ def _parse_versions(versions: Union[List[str], str]) -> List[VersionSpecifier]:
Regardless, this will return a list of VersionSpecifiers Regardless, this will return a list of VersionSpecifiers
""" """
if isinstance(versions, str): if isinstance(versions, str):
versions = versions.split(",") versions = versions.split(',')
return [VersionSpecifier.from_version_string(v) for v in versions] return [VersionSpecifier.from_version_string(v) for v in versions]
def _all_source_paths( def _all_source_paths(
model_paths: List[str], source_paths: List[str],
seed_paths: List[str], data_paths: List[str],
snapshot_paths: List[str], snapshot_paths: List[str],
analysis_paths: List[str], analysis_paths: List[str],
macro_paths: List[str], macro_paths: List[str],
) -> List[str]: ) -> List[str]:
# We need to turn a list of lists into just a list, then convert to a set to return list(chain(source_paths, data_paths, snapshot_paths, analysis_paths,
# get only unique elements, then back to a list macro_paths))
return list(
set(list(chain(model_paths, seed_paths, snapshot_paths, analysis_paths, macro_paths)))
)
T = TypeVar("T") T = TypeVar('T')
def flag_or(flag: Optional[T], value: Optional[T], default: T) -> T:
if flag is None:
return value_or(value, default)
else:
return flag
def value_or(value: Optional[T], default: T) -> T: def value_or(value: Optional[T], default: T) -> T:
@@ -159,27 +146,30 @@ def value_or(value: Optional[T], default: T) -> T:
def _raw_project_from(project_root: str) -> Dict[str, Any]: def _raw_project_from(project_root: str) -> Dict[str, Any]:
project_root = os.path.normpath(project_root) project_root = os.path.normpath(project_root)
project_yaml_filepath = os.path.join(project_root, "dbt_project.yml") project_yaml_filepath = os.path.join(project_root, 'dbt_project.yml')
# get the project.yml contents # get the project.yml contents
if not path_exists(project_yaml_filepath): if not path_exists(project_yaml_filepath):
raise DbtProjectError( raise DbtProjectError(
"no dbt_project.yml found at expected path {}".format(project_yaml_filepath) 'no dbt_project.yml found at expected path {}'
.format(project_yaml_filepath)
) )
project_dict = _load_yaml(project_yaml_filepath) project_dict = _load_yaml(project_yaml_filepath)
if not isinstance(project_dict, dict): if not isinstance(project_dict, dict):
raise DbtProjectError("dbt_project.yml does not parse to a dictionary") raise DbtProjectError(
'dbt_project.yml does not parse to a dictionary'
)
return project_dict return project_dict
def _query_comment_from_cfg( def _query_comment_from_cfg(
cfg_query_comment: Union[QueryComment, NoValue, str, None] cfg_query_comment: Union[QueryComment, NoValue, str, None]
) -> QueryComment: ) -> QueryComment:
if not cfg_query_comment: if not cfg_query_comment:
return QueryComment(comment="") return QueryComment(comment='')
if isinstance(cfg_query_comment, str): if isinstance(cfg_query_comment, str):
return QueryComment(comment=cfg_query_comment) return QueryComment(comment=cfg_query_comment)
@@ -195,7 +185,10 @@ def validate_version(dbt_version: List[VersionSpecifier], project_name: str):
installed = get_installed_version() installed = get_installed_version()
if not versions_compatible(*dbt_version): if not versions_compatible(*dbt_version):
msg = IMPOSSIBLE_VERSION_ERROR.format( msg = IMPOSSIBLE_VERSION_ERROR.format(
package=project_name, version_spec=[x.to_version_string() for x in dbt_version] package=project_name,
version_spec=[
x.to_version_string() for x in dbt_version
]
) )
raise DbtProjectError(msg) raise DbtProjectError(msg)
@@ -203,7 +196,9 @@ def validate_version(dbt_version: List[VersionSpecifier], project_name: str):
msg = INVALID_VERSION_ERROR.format( msg = INVALID_VERSION_ERROR.format(
package=project_name, package=project_name,
installed=installed.to_version_string(), installed=installed.to_version_string(),
version_spec=[x.to_version_string() for x in dbt_version], version_spec=[
x.to_version_string() for x in dbt_version
]
) )
raise DbtProjectError(msg) raise DbtProjectError(msg)
@@ -212,8 +207,8 @@ def _get_required_version(
project_dict: Dict[str, Any], project_dict: Dict[str, Any],
verify_version: bool, verify_version: bool,
) -> List[VersionSpecifier]: ) -> List[VersionSpecifier]:
dbt_raw_version: Union[List[str], str] = ">=0.0.0" dbt_raw_version: Union[List[str], str] = '>=0.0.0'
required = project_dict.get("require-dbt-version") required = project_dict.get('require-dbt-version')
if required is not None: if required is not None:
dbt_raw_version = required dbt_raw_version = required
@@ -224,39 +219,46 @@ def _get_required_version(
if verify_version: if verify_version:
# no name is also an error that we want to raise # no name is also an error that we want to raise
if "name" not in project_dict: if 'name' not in project_dict:
raise DbtProjectError( raise DbtProjectError(
'Required "name" field not present in project', 'Required "name" field not present in project',
) )
validate_version(dbt_version, project_dict["name"]) validate_version(dbt_version, project_dict['name'])
return dbt_version return dbt_version
@dataclass @dataclass
class RenderComponents: class RenderComponents:
project_dict: Dict[str, Any] = field(metadata=dict(description="The project dictionary")) project_dict: Dict[str, Any] = field(
packages_dict: Dict[str, Any] = field(metadata=dict(description="The packages dictionary")) metadata=dict(description='The project dictionary')
selectors_dict: Dict[str, Any] = field(metadata=dict(description="The selectors dictionary")) )
packages_dict: Dict[str, Any] = field(
metadata=dict(description='The packages dictionary')
)
selectors_dict: Dict[str, Any] = field(
metadata=dict(description='The selectors dictionary')
)
@dataclass @dataclass
class PartialProject(RenderComponents): class PartialProject(RenderComponents):
profile_name: Optional[str] = field( profile_name: Optional[str] = field(metadata=dict(
metadata=dict(description="The unrendered profile name in the project, if set") description='The unrendered profile name in the project, if set'
) ))
project_name: Optional[str] = field( project_name: Optional[str] = field(metadata=dict(
metadata=dict( description=(
description=( 'The name of the project. This should always be set and will not '
"The name of the project. This should always be set and will not " "be rendered" 'be rendered'
)
) )
) ))
project_root: str = field( project_root: str = field(
metadata=dict(description="The root directory of the project"), metadata=dict(description='The root directory of the project'),
) )
verify_version: bool = field( verify_version: bool = field(
metadata=dict(description=("If True, verify the dbt version matches the required version")) metadata=dict(description=(
'If True, verify the dbt version matches the required version'
))
) )
def render_profile_name(self, renderer) -> Optional[str]: def render_profile_name(self, renderer) -> Optional[str]:
@@ -269,7 +271,9 @@ class PartialProject(RenderComponents):
renderer: DbtProjectYamlRenderer, renderer: DbtProjectYamlRenderer,
) -> RenderComponents: ) -> RenderComponents:
rendered_project = renderer.render_project(self.project_dict, self.project_root) rendered_project = renderer.render_project(
self.project_dict, self.project_root
)
rendered_packages = renderer.render_packages(self.packages_dict) rendered_packages = renderer.render_packages(self.packages_dict)
rendered_selectors = renderer.render_selectors(self.selectors_dict) rendered_selectors = renderer.render_selectors(self.selectors_dict)
@@ -279,35 +283,16 @@ class PartialProject(RenderComponents):
selectors_dict=rendered_selectors, selectors_dict=rendered_selectors,
) )
# Called by 'collect_parts' in RuntimeConfig def render(self, renderer: DbtProjectYamlRenderer) -> 'Project':
def render(self, renderer: DbtProjectYamlRenderer) -> "Project":
try: try:
rendered = self.get_rendered(renderer) rendered = self.get_rendered(renderer)
return self.create_project(rendered) return self.create_project(rendered)
except DbtProjectError as exc: except DbtProjectError as exc:
if exc.path is None: if exc.path is None:
exc.path = os.path.join(self.project_root, "dbt_project.yml") exc.path = os.path.join(self.project_root, 'dbt_project.yml')
raise raise
def check_config_path(self, project_dict, deprecated_path, exp_path): def create_project(self, rendered: RenderComponents) -> 'Project':
if deprecated_path in project_dict:
if exp_path in project_dict:
msg = (
"{deprecated_path} and {exp_path} cannot both be defined. The "
"`{deprecated_path}` config has been deprecated in favor of `{exp_path}`. "
"Please update your `dbt_project.yml` configuration to reflect this "
"change."
)
raise DbtProjectError(
msg.format(deprecated_path=deprecated_path, exp_path=exp_path)
)
deprecations.warn(
f"project-config-{deprecated_path}",
deprecated_path=deprecated_path,
exp_path=exp_path,
)
def create_project(self, rendered: RenderComponents) -> "Project":
unrendered = RenderComponents( unrendered = RenderComponents(
project_dict=self.project_dict, project_dict=self.project_dict,
packages_dict=self.packages_dict, packages_dict=self.packages_dict,
@@ -318,12 +303,11 @@ class PartialProject(RenderComponents):
verify_version=self.verify_version, verify_version=self.verify_version,
) )
self.check_config_path(rendered.project_dict, "source-paths", "model-paths")
self.check_config_path(rendered.project_dict, "data-paths", "seed-paths")
try: try:
ProjectContract.validate(rendered.project_dict) ProjectContract.validate(rendered.project_dict)
cfg = ProjectContract.from_dict(rendered.project_dict) cfg = ProjectContract.from_dict(
rendered.project_dict
)
except ValidationError as e: except ValidationError as e:
raise DbtProjectError(validator_error_message(e)) from e raise DbtProjectError(validator_error_message(e)) from e
# name/version are required in the Project definition, so we can assume # name/version are required in the Project definition, so we can assume
@@ -333,40 +317,31 @@ class PartialProject(RenderComponents):
# this is added at project_dict parse time and should always be here # this is added at project_dict parse time and should always be here
# once we see it. # once we see it.
if cfg.project_root is None: if cfg.project_root is None:
raise DbtProjectError("cfg must have a project root!") raise DbtProjectError('cfg must have a project root!')
else: else:
project_root = cfg.project_root project_root = cfg.project_root
# this is only optional in the sense that if it's not present, it needs # this is only optional in the sense that if it's not present, it needs
# to have been a cli argument. # to have been a cli argument.
profile_name = cfg.profile profile_name = cfg.profile
# these are all the defaults # these are all the defaults
source_paths: List[str] = value_or(cfg.source_paths, ['models'])
# `source_paths` is deprecated but still allowed. Copy it into macro_paths: List[str] = value_or(cfg.macro_paths, ['macros'])
# `model_paths` to simlify logic throughout the rest of the system. data_paths: List[str] = value_or(cfg.data_paths, ['data'])
model_paths: List[str] = value_or( test_paths: List[str] = value_or(cfg.test_paths, ['test'])
cfg.model_paths if "model-paths" in rendered.project_dict else cfg.source_paths, analysis_paths: List[str] = value_or(cfg.analysis_paths, [])
["models"], snapshot_paths: List[str] = value_or(cfg.snapshot_paths, ['snapshots'])
)
macro_paths: List[str] = value_or(cfg.macro_paths, ["macros"])
# `data_paths` is deprecated but still allowed. Copy it into
# `seed_paths` to simlify logic throughout the rest of the system.
seed_paths: List[str] = value_or(
cfg.seed_paths if "seed-paths" in rendered.project_dict else cfg.data_paths, ["seeds"]
)
test_paths: List[str] = value_or(cfg.test_paths, ["tests"])
analysis_paths: List[str] = value_or(cfg.analysis_paths, ["analyses"])
snapshot_paths: List[str] = value_or(cfg.snapshot_paths, ["snapshots"])
all_source_paths: List[str] = _all_source_paths( all_source_paths: List[str] = _all_source_paths(
model_paths, seed_paths, snapshot_paths, analysis_paths, macro_paths source_paths, data_paths, snapshot_paths, analysis_paths,
macro_paths
) )
docs_paths: List[str] = value_or(cfg.docs_paths, all_source_paths) docs_paths: List[str] = value_or(cfg.docs_paths, all_source_paths)
asset_paths: List[str] = value_or(cfg.asset_paths, []) asset_paths: List[str] = value_or(cfg.asset_paths, [])
target_path: str = flag_or(flags.TARGET_PATH, cfg.target_path, "target") target_path: str = value_or(cfg.target_path, 'target')
clean_targets: List[str] = value_or(cfg.clean_targets, [target_path]) clean_targets: List[str] = value_or(cfg.clean_targets, [target_path])
log_path: str = flag_or(flags.LOG_PATH, cfg.log_path, "logs") log_path: str = value_or(cfg.log_path, 'logs')
packages_install_path: str = value_or(cfg.packages_install_path, "dbt_packages") modules_path: str = value_or(cfg.modules_path, 'dbt_modules')
# in the default case we'll populate this once we know the adapter type # in the default case we'll populate this once we know the adapter type
# It would be nice to just pass along a Quoting here, but that would # It would be nice to just pass along a Quoting here, but that would
# break many things # break many things
@@ -394,8 +369,6 @@ class PartialProject(RenderComponents):
vars_dict = cfg.vars vars_dict = cfg.vars
vars_value = VarProvider(vars_dict) vars_value = VarProvider(vars_dict)
# There will never be any project_env_vars when it's first created
project_env_vars: Dict[str, Any] = {}
on_run_start: List[str] = value_or(cfg.on_run_start, []) on_run_start: List[str] = value_or(cfg.on_run_start, [])
on_run_end: List[str] = value_or(cfg.on_run_end, []) on_run_end: List[str] = value_or(cfg.on_run_end, [])
@@ -404,20 +377,20 @@ class PartialProject(RenderComponents):
packages = package_config_from_data(rendered.packages_dict) packages = package_config_from_data(rendered.packages_dict)
selectors = selector_config_from_data(rendered.selectors_dict) selectors = selector_config_from_data(rendered.selectors_dict)
manifest_selectors: Dict[str, Any] = {} manifest_selectors: Dict[str, Any] = {}
if rendered.selectors_dict and rendered.selectors_dict["selectors"]: if rendered.selectors_dict and rendered.selectors_dict['selectors']:
# this is a dict with a single key 'selectors' pointing to a list # this is a dict with a single key 'selectors' pointing to a list
# of dicts. # of dicts.
manifest_selectors = SelectorDict.parse_from_selectors_list( manifest_selectors = SelectorDict.parse_from_selectors_list(
rendered.selectors_dict["selectors"] rendered.selectors_dict['selectors'])
)
project = Project( project = Project(
project_name=name, project_name=name,
version=version, version=version,
project_root=project_root, project_root=project_root,
profile_name=profile_name, profile_name=profile_name,
model_paths=model_paths, source_paths=source_paths,
macro_paths=macro_paths, macro_paths=macro_paths,
seed_paths=seed_paths, data_paths=data_paths,
test_paths=test_paths, test_paths=test_paths,
analysis_paths=analysis_paths, analysis_paths=analysis_paths,
docs_paths=docs_paths, docs_paths=docs_paths,
@@ -426,7 +399,7 @@ class PartialProject(RenderComponents):
snapshot_paths=snapshot_paths, snapshot_paths=snapshot_paths,
clean_targets=clean_targets, clean_targets=clean_targets,
log_path=log_path, log_path=log_path,
packages_install_path=packages_install_path, modules_path=modules_path,
quoting=quoting, quoting=quoting,
models=models, models=models,
on_run_start=on_run_start, on_run_start=on_run_start,
@@ -444,7 +417,6 @@ class PartialProject(RenderComponents):
vars=vars_value, vars=vars_value,
config_version=cfg.config_version, config_version=cfg.config_version,
unrendered=unrendered, unrendered=unrendered,
project_env_vars=project_env_vars,
) )
# sanity check - this means an internal issue # sanity check - this means an internal issue
project.validate() project.validate()
@@ -460,9 +432,10 @@ class PartialProject(RenderComponents):
*, *,
verify_version: bool = False, verify_version: bool = False,
): ):
"""Construct a partial project from its constituent dicts.""" """Construct a partial project from its constituent dicts.
project_name = project_dict.get("name") """
profile_name = project_dict.get("profile") project_name = project_dict.get('name')
profile_name = project_dict.get('profile')
return cls( return cls(
profile_name=profile_name, profile_name=profile_name,
@@ -477,14 +450,14 @@ class PartialProject(RenderComponents):
@classmethod @classmethod
def from_project_root( def from_project_root(
cls, project_root: str, *, verify_version: bool = False cls, project_root: str, *, verify_version: bool = False
) -> "PartialProject": ) -> 'PartialProject':
project_root = os.path.normpath(project_root) project_root = os.path.normpath(project_root)
project_dict = _raw_project_from(project_root) project_dict = _raw_project_from(project_root)
config_version = project_dict.get("config-version", 1) config_version = project_dict.get('config-version', 1)
if config_version != 2: if config_version != 2:
raise DbtProjectError( raise DbtProjectError(
f"Invalid config version: {config_version}, expected 2", f'Invalid config version: {config_version}, expected 2',
path=os.path.join(project_root, "dbt_project.yml"), path=os.path.join(project_root, 'dbt_project.yml')
) )
packages_dict = package_data_from_root(project_root) packages_dict = package_data_from_root(project_root)
@@ -501,10 +474,15 @@ class PartialProject(RenderComponents):
class VarProvider: class VarProvider:
"""Var providers are tied to a particular Project.""" """Var providers are tied to a particular Project."""
def __init__(self, vars: Dict[str, Dict[str, Any]]) -> None: def __init__(
self,
vars: Dict[str, Dict[str, Any]]
) -> None:
self.vars = vars self.vars = vars
def vars_for(self, node: IsFQNResource, adapter_type: str) -> Mapping[str, Any]: def vars_for(
self, node: IsFQNResource, adapter_type: str
) -> Mapping[str, Any]:
# in v2, vars are only either project or globally scoped # in v2, vars are only either project or globally scoped
merged = MultiDict([self.vars]) merged = MultiDict([self.vars])
merged.add(self.vars.get(node.package_name, {})) merged.add(self.vars.get(node.package_name, {}))
@@ -522,9 +500,9 @@ class Project:
version: Union[SemverString, float] version: Union[SemverString, float]
project_root: str project_root: str
profile_name: Optional[str] profile_name: Optional[str]
model_paths: List[str] source_paths: List[str]
macro_paths: List[str] macro_paths: List[str]
seed_paths: List[str] data_paths: List[str]
test_paths: List[str] test_paths: List[str]
analysis_paths: List[str] analysis_paths: List[str]
docs_paths: List[str] docs_paths: List[str]
@@ -533,7 +511,7 @@ class Project:
snapshot_paths: List[str] snapshot_paths: List[str]
clean_targets: List[str] clean_targets: List[str]
log_path: str log_path: str
packages_install_path: str modules_path: str
quoting: Dict[str, Any] quoting: Dict[str, Any]
models: Dict[str, Any] models: Dict[str, Any]
on_run_start: List[str] on_run_start: List[str]
@@ -551,35 +529,24 @@ class Project:
query_comment: QueryComment query_comment: QueryComment
config_version: int config_version: int
unrendered: RenderComponents unrendered: RenderComponents
project_env_vars: Dict[str, Any]
@property @property
def all_source_paths(self) -> List[str]: def all_source_paths(self) -> List[str]:
return _all_source_paths( return _all_source_paths(
self.model_paths, self.source_paths, self.data_paths, self.snapshot_paths,
self.seed_paths, self.analysis_paths, self.macro_paths
self.snapshot_paths,
self.analysis_paths,
self.macro_paths,
) )
@property
def generic_test_paths(self):
generic_test_paths = []
for test_path in self.test_paths:
generic_test_paths.append(os.path.join(test_path, "generic"))
return generic_test_paths
def __str__(self): def __str__(self):
cfg = self.to_project_config(with_packages=True) cfg = self.to_project_config(with_packages=True)
return str(cfg) return str(cfg)
def __eq__(self, other): def __eq__(self, other):
if not (isinstance(other, self.__class__) and isinstance(self, other.__class__)): if not (isinstance(other, self.__class__) and
isinstance(self, other.__class__)):
return False return False
return self.to_project_config(with_packages=True) == other.to_project_config( return self.to_project_config(with_packages=True) == \
with_packages=True other.to_project_config(with_packages=True)
)
def to_project_config(self, with_packages=False): def to_project_config(self, with_packages=False):
"""Return a dict representation of the config that could be written to """Return a dict representation of the config that could be written to
@@ -589,39 +556,40 @@ class Project:
file in the root. file in the root.
:returns dict: The serialized profile. :returns dict: The serialized profile.
""" """
result = deepcopy( result = deepcopy({
{ 'name': self.project_name,
"name": self.project_name, 'version': self.version,
"version": self.version, 'project-root': self.project_root,
"project-root": self.project_root, 'profile': self.profile_name,
"profile": self.profile_name, 'source-paths': self.source_paths,
"model-paths": self.model_paths, 'macro-paths': self.macro_paths,
"macro-paths": self.macro_paths, 'data-paths': self.data_paths,
"seed-paths": self.seed_paths, 'test-paths': self.test_paths,
"test-paths": self.test_paths, 'analysis-paths': self.analysis_paths,
"analysis-paths": self.analysis_paths, 'docs-paths': self.docs_paths,
"docs-paths": self.docs_paths, 'asset-paths': self.asset_paths,
"asset-paths": self.asset_paths, 'target-path': self.target_path,
"target-path": self.target_path, 'snapshot-paths': self.snapshot_paths,
"snapshot-paths": self.snapshot_paths, 'clean-targets': self.clean_targets,
"clean-targets": self.clean_targets, 'log-path': self.log_path,
"log-path": self.log_path, 'quoting': self.quoting,
"quoting": self.quoting, 'models': self.models,
"models": self.models, 'on-run-start': self.on_run_start,
"on-run-start": self.on_run_start, 'on-run-end': self.on_run_end,
"on-run-end": self.on_run_end, 'dispatch': self.dispatch,
"dispatch": self.dispatch, 'seeds': self.seeds,
"seeds": self.seeds, 'snapshots': self.snapshots,
"snapshots": self.snapshots, 'sources': self.sources,
"sources": self.sources, 'tests': self.tests,
"tests": self.tests, 'vars': self.vars.to_dict(),
"vars": self.vars.to_dict(), 'require-dbt-version': [
"require-dbt-version": [v.to_version_string() for v in self.dbt_version], v.to_version_string() for v in self.dbt_version
"config-version": self.config_version, ],
} 'config-version': self.config_version,
) })
if self.query_comment: if self.query_comment:
result["query-comment"] = self.query_comment.to_dict(omit_none=True) result['query-comment'] = \
self.query_comment.to_dict(omit_none=True)
if with_packages: if with_packages:
result.update(self.packages.to_dict(omit_none=True)) result.update(self.packages.to_dict(omit_none=True))
@@ -635,12 +603,34 @@ class Project:
raise DbtProjectError(validator_error_message(e)) from e raise DbtProjectError(validator_error_message(e)) from e
@classmethod @classmethod
def partial_load(cls, project_root: str, *, verify_version: bool = False) -> PartialProject: def partial_load(
cls, project_root: str, *, verify_version: bool = False
) -> PartialProject:
return PartialProject.from_project_root( return PartialProject.from_project_root(
project_root, project_root,
verify_version=verify_version, verify_version=verify_version,
) )
@classmethod
def render_from_dict(
cls,
project_root: str,
project_dict: Dict[str, Any],
packages_dict: Dict[str, Any],
selectors_dict: Dict[str, Any],
renderer: DbtProjectYamlRenderer,
*,
verify_version: bool = False
) -> 'Project':
partial = PartialProject.from_dicts(
project_root=project_root,
project_dict=project_dict,
packages_dict=packages_dict,
selectors_dict=selectors_dict,
verify_version=verify_version,
)
return partial.render(renderer)
@classmethod @classmethod
def from_project_root( def from_project_root(
cls, cls,
@@ -648,33 +638,23 @@ class Project:
renderer: DbtProjectYamlRenderer, renderer: DbtProjectYamlRenderer,
*, *,
verify_version: bool = False, verify_version: bool = False,
) -> "Project": ) -> 'Project':
partial = cls.partial_load(project_root, verify_version=verify_version) partial = cls.partial_load(project_root, verify_version=verify_version)
return partial.render(renderer) return partial.render(renderer)
def hashed_name(self): def hashed_name(self):
return hashlib.md5(self.project_name.encode("utf-8")).hexdigest() return hashlib.md5(self.project_name.encode('utf-8')).hexdigest()
def get_selector(self, name: str) -> Union[SelectionSpec, bool]: def get_selector(self, name: str) -> SelectionSpec:
if name not in self.selectors: if name not in self.selectors:
raise RuntimeException( raise RuntimeException(
f"Could not find selector named {name}, expected one of " f"{list(self.selectors)}" f'Could not find selector named {name}, expected one of '
f'{list(self.selectors)}'
) )
return self.selectors[name]["definition"] return self.selectors[name]
def get_default_selector_name(self) -> Union[str, None]:
"""This function fetch the default selector to use on `dbt run` (if any)
:return: either a selector if default is set or None
:rtype: Union[SelectionSpec, None]
"""
for selector_name, selector in self.selectors.items():
if selector["default"] is True:
return selector_name
return None
def get_macro_search_order(self, macro_namespace: str): def get_macro_search_order(self, macro_namespace: str):
for dispatch_entry in self.dispatch: for dispatch_entry in self.dispatch:
if dispatch_entry["macro_namespace"] == macro_namespace: if dispatch_entry['macro_namespace'] == macro_namespace:
return dispatch_entry["search_order"] return dispatch_entry['search_order']
return None return None

View File

@@ -1,15 +1,12 @@
from typing import Dict, Any, Tuple, Optional, Union, Callable from typing import Dict, Any, Tuple, Optional, Union, Callable
import re
import os
from dbt.clients.jinja import get_rendered, catch_jinja from dbt.clients.jinja import get_rendered, catch_jinja
from dbt.context.target import TargetContext
from dbt.context.secret import SecretContext, SECRET_PLACEHOLDER from dbt.exceptions import (
from dbt.context.base import BaseContext DbtProjectError, CompilationException, RecursionException
from dbt.contracts.connection import HasCredentials )
from dbt.exceptions import DbtProjectError, CompilationException, RecursionException from dbt.node_types import NodeType
from dbt.utils import deep_map_render from dbt.utils import deep_map
from dbt.logger import SECRET_ENV_PREFIX
Keypath = Tuple[Union[str, int], ...] Keypath = Tuple[Union[str, int], ...]
@@ -21,7 +18,7 @@ class BaseRenderer:
@property @property
def name(self): def name(self):
return "Rendering" return 'Rendering'
def should_render_keypath(self, keypath: Keypath) -> bool: def should_render_keypath(self, keypath: Keypath) -> bool:
return True return True
@@ -32,7 +29,9 @@ class BaseRenderer:
return self.render_value(value, keypath) return self.render_value(value, keypath)
def render_value(self, value: Any, keypath: Optional[Keypath] = None) -> Any: def render_value(
self, value: Any, keypath: Optional[Keypath] = None
) -> Any:
# keypath is ignored. # keypath is ignored.
# if it wasn't read as a string, ignore it # if it wasn't read as a string, ignore it
if not isinstance(value, str): if not isinstance(value, str):
@@ -41,15 +40,18 @@ class BaseRenderer:
with catch_jinja(): with catch_jinja():
return get_rendered(value, self.context, native=True) return get_rendered(value, self.context, native=True)
except CompilationException as exc: except CompilationException as exc:
msg = f"Could not render {value}: {exc.msg}" msg = f'Could not render {value}: {exc.msg}'
raise CompilationException(msg) from exc raise CompilationException(msg) from exc
def render_data(self, data: Dict[str, Any]) -> Dict[str, Any]: def render_data(
self, data: Dict[str, Any]
) -> Dict[str, Any]:
try: try:
return deep_map_render(self.render_entry, data) return deep_map(self.render_entry, data)
except RecursionException: except RecursionException:
raise DbtProjectError( raise DbtProjectError(
f"Cycle detected: {self.name} input has a reference to itself", project=data f'Cycle detected: {self.name} input has a reference to itself',
project=data
) )
@@ -76,15 +78,15 @@ class ProjectPostprocessor(Dict[Keypath, Callable[[Any], Any]]):
def __init__(self): def __init__(self):
super().__init__() super().__init__()
self[("on-run-start",)] = _list_if_none_or_string self[('on-run-start',)] = _list_if_none_or_string
self[("on-run-end",)] = _list_if_none_or_string self[('on-run-end',)] = _list_if_none_or_string
for k in ("models", "seeds", "snapshots"): for k in ('models', 'seeds', 'snapshots'):
self[(k,)] = _dict_if_none self[(k,)] = _dict_if_none
self[(k, "vars")] = _dict_if_none self[(k, 'vars')] = _dict_if_none
self[(k, "pre-hook")] = _list_if_none_or_string self[(k, 'pre-hook')] = _list_if_none_or_string
self[(k, "post-hook")] = _list_if_none_or_string self[(k, 'post-hook')] = _list_if_none_or_string
self[("seeds", "column_types")] = _dict_if_none self[('seeds', 'column_types')] = _dict_if_none
def postprocess(self, value: Any, key: Keypath) -> Any: def postprocess(self, value: Any, key: Keypath) -> Any:
if key in self: if key in self:
@@ -97,29 +99,15 @@ class ProjectPostprocessor(Dict[Keypath, Callable[[Any], Any]]):
class DbtProjectYamlRenderer(BaseRenderer): class DbtProjectYamlRenderer(BaseRenderer):
_KEYPATH_HANDLERS = ProjectPostprocessor() _KEYPATH_HANDLERS = ProjectPostprocessor()
def __init__(
self, profile: Optional[HasCredentials] = None, cli_vars: Optional[Dict[str, Any]] = None
) -> None:
# Generate contexts here because we want to save the context
# object in order to retrieve the env_vars. This is almost always
# a TargetContext, but in the debug task we want a project
# even when we don't have a profile.
if cli_vars is None:
cli_vars = {}
if profile:
self.ctx_obj = TargetContext(profile, cli_vars)
else:
self.ctx_obj = BaseContext(cli_vars) # type:ignore
context = self.ctx_obj.to_dict()
super().__init__(context)
@property @property
def name(self): def name(self):
"Project config" 'Project config'
# Uses SecretRenderer
def get_package_renderer(self) -> BaseRenderer: def get_package_renderer(self) -> BaseRenderer:
return PackageRenderer(self.ctx_obj.cli_vars) return PackageRenderer(self.context)
def get_selector_renderer(self) -> BaseRenderer:
return SelectorRenderer(self.context)
def render_project( def render_project(
self, self,
@@ -128,7 +116,7 @@ class DbtProjectYamlRenderer(BaseRenderer):
) -> Dict[str, Any]: ) -> Dict[str, Any]:
"""Render the project and insert the project root after rendering.""" """Render the project and insert the project root after rendering."""
rendered_project = self.render_data(project) rendered_project = self.render_data(project)
rendered_project["project-root"] = project_root rendered_project['project-root'] = project_root
return rendered_project return rendered_project
def render_packages(self, packages: Dict[str, Any]): def render_packages(self, packages: Dict[str, Any]):
@@ -137,7 +125,8 @@ class DbtProjectYamlRenderer(BaseRenderer):
return package_renderer.render_data(packages) return package_renderer.render_data(packages)
def render_selectors(self, selectors: Dict[str, Any]): def render_selectors(self, selectors: Dict[str, Any]):
return self.render_data(selectors) selector_renderer = self.get_selector_renderer()
return selector_renderer.render_data(selectors)
def render_entry(self, value: Any, keypath: Keypath) -> Any: def render_entry(self, value: Any, keypath: Keypath) -> Any:
result = super().render_entry(value, keypath) result = super().render_entry(value, keypath)
@@ -149,64 +138,101 @@ class DbtProjectYamlRenderer(BaseRenderer):
first = keypath[0] first = keypath[0]
# run hooks are not rendered # run hooks are not rendered
if first in {"on-run-start", "on-run-end", "query-comment"}: if first in {'on-run-start', 'on-run-end', 'query-comment'}:
return False return False
# don't render vars blocks until runtime # don't render vars blocks until runtime
if first == "vars": if first == 'vars':
return False return False
if first in {"seeds", "models", "snapshots", "tests"}: if first in {'seeds', 'models', 'snapshots', 'tests'}:
keypath_parts = {(k.lstrip("+ ") if isinstance(k, str) else k) for k in keypath} keypath_parts = {
(k.lstrip('+ ') if isinstance(k, str) else k)
for k in keypath
}
# model-level hooks # model-level hooks
if "pre-hook" in keypath_parts or "post-hook" in keypath_parts: if 'pre-hook' in keypath_parts or 'post-hook' in keypath_parts:
return False return False
return True return True
class SecretRenderer(BaseRenderer): class ProfileRenderer(BaseRenderer):
def __init__(self, cli_vars: Dict[str, Any] = {}) -> None: @property
# Generate contexts here because we want to save the context def name(self):
# object in order to retrieve the env_vars. 'Profile'
self.ctx_obj = SecretContext(cli_vars)
context = self.ctx_obj.to_dict()
super().__init__(context) class SchemaYamlRenderer(BaseRenderer):
DOCUMENTABLE_NODES = frozenset(
n.pluralize() for n in NodeType.documentable()
)
@property @property
def name(self): def name(self):
return "Secret" return 'Rendering yaml'
def render_value(self, value: Any, keypath: Optional[Keypath] = None) -> Any: def _is_norender_key(self, keypath: Keypath) -> bool:
# First, standard Jinja rendering, with special handling for 'secret' environment variables """
# "{{ env_var('DBT_SECRET_ENV_VAR') }}" -> "$$$DBT_SECRET_START$$$DBT_SECRET_ENV_{VARIABLE_NAME}$$$DBT_SECRET_END$$$" models:
# This prevents Jinja manipulation of secrets via macros/filters that might leak partial/modified values in logs - name: blah
rendered = super().render_value(value, keypath) - description: blah
# Now, detect instances of the placeholder value ($$$DBT_SECRET_START...DBT_SECRET_END$$$) tests: ...
# and replace them with the actual secret value - columns:
if SECRET_ENV_PREFIX in str(rendered): - name:
search_group = f"({SECRET_ENV_PREFIX}(.*))" - description: blah
pattern = SECRET_PLACEHOLDER.format(search_group).replace("$", r"\$") tests: ...
m = re.search(
pattern, Return True if it's tests or description - those aren't rendered
rendered, """
) if len(keypath) >= 2 and keypath[1] in ('tests', 'description'):
if m: return True
found = m.group(1)
value = os.environ[found] if (
replace_this = SECRET_PLACEHOLDER.format(found) len(keypath) >= 4 and
return rendered.replace(replace_this, value) keypath[1] == 'columns' and
else: keypath[3] in ('tests', 'description')
return rendered ):
return True
return False
# don't render descriptions or test keyword arguments
def should_render_keypath(self, keypath: Keypath) -> bool:
if len(keypath) < 2:
return True
if keypath[0] not in self.DOCUMENTABLE_NODES:
return True
if len(keypath) < 3:
return True
if keypath[0] == NodeType.Source.pluralize():
if keypath[2] == 'description':
return False
if keypath[2] == 'tables':
if self._is_norender_key(keypath[3:]):
return False
elif keypath[0] == NodeType.Macro.pluralize():
if keypath[2] == 'arguments':
if self._is_norender_key(keypath[3:]):
return False
elif self._is_norender_key(keypath[1:]):
return False
else: # keypath[0] in self.DOCUMENTABLE_NODES:
if self._is_norender_key(keypath[1:]):
return False
return True
class ProfileRenderer(SecretRenderer): class PackageRenderer(BaseRenderer):
@property @property
def name(self): def name(self):
return "Profile" return 'Packages config'
class PackageRenderer(SecretRenderer): class SelectorRenderer(BaseRenderer):
@property @property
def name(self): def name(self):
return "Packages config" return 'Selector config'

View File

@@ -1,36 +1,44 @@
import itertools import itertools
import os import os
from copy import deepcopy from copy import deepcopy
from dataclasses import dataclass, field from dataclasses import dataclass, fields
from pathlib import Path from pathlib import Path
from typing import Dict, Any, Optional, Mapping, Iterator, Iterable, Tuple, List, MutableSet, Type from typing import (
Dict, Any, Optional, Mapping, Iterator, Iterable, Tuple, List, MutableSet,
Type
)
from .profile import Profile from .profile import Profile
from .project import Project from .project import Project
from .renderer import DbtProjectYamlRenderer, ProfileRenderer from .renderer import DbtProjectYamlRenderer, ProfileRenderer
from .utils import parse_cli_vars from .utils import parse_cli_vars
from dbt import flags from dbt import tracking
from dbt.adapters.factory import get_relation_class_by_name, get_include_paths from dbt.adapters.factory import get_relation_class_by_name, get_include_paths
from dbt.helper_types import FQNPath, PathSet, DictDefaultEmptyStr from dbt.helper_types import FQNPath, PathSet
from dbt.config.profile import read_user_config from dbt.context.base import generate_base_context
from dbt.context.target import generate_target_context
from dbt.contracts.connection import AdapterRequiredConfig, Credentials from dbt.contracts.connection import AdapterRequiredConfig, Credentials
from dbt.contracts.graph.manifest import ManifestMetadata from dbt.contracts.graph.manifest import ManifestMetadata
from dbt.contracts.relation import ComponentName from dbt.contracts.relation import ComponentName
from dbt.logger import GLOBAL_LOGGER as logger
from dbt.ui import warning_tag from dbt.ui import warning_tag
from dbt.contracts.project import Configuration, UserConfig from dbt.contracts.project import Configuration, UserConfig
from dbt.exceptions import ( from dbt.exceptions import (
RuntimeException, RuntimeException,
DbtProfileError,
DbtProjectError, DbtProjectError,
validator_error_message, validator_error_message,
warn_or_error, warn_or_error,
raise_compiler_error, raise_compiler_error
) )
from dbt.dataclass_schema import ValidationError from dbt.dataclass_schema import ValidationError
def _project_quoting_dict(proj: Project, profile: Profile) -> Dict[ComponentName, bool]: def _project_quoting_dict(
proj: Project, profile: Profile
) -> Dict[ComponentName, bool]:
src: Dict[str, Any] = profile.credentials.translate_aliases(proj.quoting) src: Dict[str, Any] = profile.credentials.translate_aliases(proj.quoting)
result: Dict[ComponentName, bool] = {} result: Dict[ComponentName, bool] = {}
for key in ComponentName: for key in ComponentName:
@@ -46,20 +54,19 @@ class RuntimeConfig(Project, Profile, AdapterRequiredConfig):
args: Any args: Any
profile_name: str profile_name: str
cli_vars: Dict[str, Any] cli_vars: Dict[str, Any]
dependencies: Optional[Mapping[str, "RuntimeConfig"]] = None dependencies: Optional[Mapping[str, 'RuntimeConfig']] = None
def __post_init__(self): def __post_init__(self):
self.validate() self.validate()
# Called by 'new_project' and 'from_args'
@classmethod @classmethod
def from_parts( def from_parts(
cls, cls,
project: Project, project: Project,
profile: Profile, profile: Profile,
args: Any, args: Any,
dependencies: Optional[Mapping[str, "RuntimeConfig"]] = None, dependencies: Optional[Mapping[str, 'RuntimeConfig']] = None,
) -> "RuntimeConfig": ) -> 'RuntimeConfig':
"""Instantiate a RuntimeConfig from its components. """Instantiate a RuntimeConfig from its components.
:param profile: A parsed dbt Profile. :param profile: A parsed dbt Profile.
@@ -73,15 +80,15 @@ class RuntimeConfig(Project, Profile, AdapterRequiredConfig):
.replace_dict(_project_quoting_dict(project, profile)) .replace_dict(_project_quoting_dict(project, profile))
).to_dict(omit_none=True) ).to_dict(omit_none=True)
cli_vars: Dict[str, Any] = parse_cli_vars(getattr(args, "vars", "{}")) cli_vars: Dict[str, Any] = parse_cli_vars(getattr(args, 'vars', '{}'))
return cls( return cls(
project_name=project.project_name, project_name=project.project_name,
version=project.version, version=project.version,
project_root=project.project_root, project_root=project.project_root,
model_paths=project.model_paths, source_paths=project.source_paths,
macro_paths=project.macro_paths, macro_paths=project.macro_paths,
seed_paths=project.seed_paths, data_paths=project.data_paths,
test_paths=project.test_paths, test_paths=project.test_paths,
analysis_paths=project.analysis_paths, analysis_paths=project.analysis_paths,
docs_paths=project.docs_paths, docs_paths=project.docs_paths,
@@ -90,7 +97,7 @@ class RuntimeConfig(Project, Profile, AdapterRequiredConfig):
snapshot_paths=project.snapshot_paths, snapshot_paths=project.snapshot_paths,
clean_targets=project.clean_targets, clean_targets=project.clean_targets,
log_path=project.log_path, log_path=project.log_path,
packages_install_path=project.packages_install_path, modules_path=project.modules_path,
quoting=quoting, quoting=quoting,
models=project.models, models=project.models,
on_run_start=project.on_run_start, on_run_start=project.on_run_start,
@@ -108,11 +115,9 @@ class RuntimeConfig(Project, Profile, AdapterRequiredConfig):
vars=project.vars, vars=project.vars,
config_version=project.config_version, config_version=project.config_version,
unrendered=project.unrendered, unrendered=project.unrendered,
project_env_vars=project.project_env_vars,
profile_env_vars=profile.profile_env_vars,
profile_name=profile.profile_name, profile_name=profile.profile_name,
target_name=profile.target_name, target_name=profile.target_name,
user_config=profile.user_config, config=profile.config,
threads=profile.threads, threads=profile.threads,
credentials=profile.credentials, credentials=profile.credentials,
args=args, args=args,
@@ -120,8 +125,7 @@ class RuntimeConfig(Project, Profile, AdapterRequiredConfig):
dependencies=dependencies, dependencies=dependencies,
) )
# Called by 'load_projects' in this class def new_project(self, project_root: str) -> 'RuntimeConfig':
def new_project(self, project_root: str) -> "RuntimeConfig":
"""Given a new project root, read in its project dictionary, supply the """Given a new project root, read in its project dictionary, supply the
existing project's profile info, and create a new project file. existing project's profile info, and create a new project file.
@@ -135,22 +139,22 @@ class RuntimeConfig(Project, Profile, AdapterRequiredConfig):
profile.validate() profile.validate()
# load the new project and its packages. Don't pass cli variables. # load the new project and its packages. Don't pass cli variables.
renderer = DbtProjectYamlRenderer(profile) renderer = DbtProjectYamlRenderer(generate_target_context(profile, {}))
project = Project.from_project_root( project = Project.from_project_root(
project_root, project_root,
renderer, renderer,
verify_version=bool(flags.VERSION_CHECK), verify_version=getattr(self.args, 'version_check', False),
) )
runtime_config = self.from_parts( cfg = self.from_parts(
project=project, project=project,
profile=profile, profile=profile,
args=deepcopy(self.args), args=deepcopy(self.args),
) )
# force our quoting back onto the new project. # force our quoting back onto the new project.
runtime_config.quoting = deepcopy(self.quoting) cfg.quoting = deepcopy(self.quoting)
return runtime_config return cfg
def serialize(self) -> Dict[str, Any]: def serialize(self) -> Dict[str, Any]:
"""Serialize the full configuration to a single dictionary. For any """Serialize the full configuration to a single dictionary. For any
@@ -163,7 +167,7 @@ class RuntimeConfig(Project, Profile, AdapterRequiredConfig):
""" """
result = self.to_project_config(with_packages=True) result = self.to_project_config(with_packages=True)
result.update(self.to_profile_info(serialize_credentials=True)) result.update(self.to_profile_info(serialize_credentials=True))
result["cli_vars"] = deepcopy(self.cli_vars) result['cli_vars'] = deepcopy(self.cli_vars)
return result return result
def validate(self): def validate(self):
@@ -183,37 +187,40 @@ class RuntimeConfig(Project, Profile, AdapterRequiredConfig):
profile_renderer: ProfileRenderer, profile_renderer: ProfileRenderer,
profile_name: Optional[str], profile_name: Optional[str],
) -> Profile: ) -> Profile:
return Profile.render_from_args(
return Profile.render_from_args(args, profile_renderer, profile_name) args, profile_renderer, profile_name
)
@classmethod @classmethod
def collect_parts(cls: Type["RuntimeConfig"], args: Any) -> Tuple[Project, Profile]: def collect_parts(
cls: Type['RuntimeConfig'], args: Any
) -> Tuple[Project, Profile]:
# profile_name from the project # profile_name from the project
project_root = args.project_dir if args.project_dir else os.getcwd() project_root = args.project_dir if args.project_dir else os.getcwd()
version_check = bool(flags.VERSION_CHECK) version_check = getattr(args, 'version_check', False)
partial = Project.partial_load(project_root, verify_version=version_check) partial = Project.partial_load(
project_root,
verify_version=version_check
)
# build the profile using the base renderer and the one fact we know # build the profile using the base renderer and the one fact we know
# Note: only the named profile section is rendered. The rest of the cli_vars: Dict[str, Any] = parse_cli_vars(getattr(args, 'vars', '{}'))
# profile is ignored. profile_renderer = ProfileRenderer(generate_base_context(cli_vars))
cli_vars: Dict[str, Any] = parse_cli_vars(getattr(args, "vars", "{}"))
profile_renderer = ProfileRenderer(cli_vars)
profile_name = partial.render_profile_name(profile_renderer) profile_name = partial.render_profile_name(profile_renderer)
profile = cls._get_rendered_profile(args, profile_renderer, profile_name)
# Save env_vars encountered in rendering for partial parsing profile = cls._get_rendered_profile(
profile.profile_env_vars = profile_renderer.ctx_obj.env_vars args, profile_renderer, profile_name
)
# get a new renderer using our target information and render the # get a new renderer using our target information and render the
# project # project
project_renderer = DbtProjectYamlRenderer(profile, cli_vars) ctx = generate_target_context(profile, cli_vars)
project_renderer = DbtProjectYamlRenderer(ctx)
project = partial.render(project_renderer) project = partial.render(project_renderer)
# Save env_vars encountered in rendering for partial parsing
project.project_env_vars = project_renderer.ctx_obj.env_vars
return (project, profile) return (project, profile)
# Called in main.py, lib.py, task/base.py
@classmethod @classmethod
def from_args(cls, args: Any) -> "RuntimeConfig": def from_args(cls, args: Any) -> 'RuntimeConfig':
"""Given arguments, read in dbt_project.yml from the current directory, """Given arguments, read in dbt_project.yml from the current directory,
read in packages.yml if it exists, and use them to find the profile to read in packages.yml if it exists, and use them to find the profile to
load. load.
@@ -232,7 +239,10 @@ class RuntimeConfig(Project, Profile, AdapterRequiredConfig):
) )
def get_metadata(self) -> ManifestMetadata: def get_metadata(self) -> ManifestMetadata:
return ManifestMetadata(project_id=self.hashed_name(), adapter_type=self.credentials.type) return ManifestMetadata(
project_id=self.hashed_name(),
adapter_type=self.credentials.type
)
def _get_v2_config_paths( def _get_v2_config_paths(
self, self,
@@ -241,8 +251,8 @@ class RuntimeConfig(Project, Profile, AdapterRequiredConfig):
paths: MutableSet[FQNPath], paths: MutableSet[FQNPath],
) -> PathSet: ) -> PathSet:
for key, value in config.items(): for key, value in config.items():
if isinstance(value, dict) and not key.startswith("+"): if isinstance(value, dict) and not key.startswith('+'):
self._get_config_paths(value, path + (key,), paths) self._get_v2_config_paths(value, path + (key,), paths)
else: else:
paths.add(path) paths.add(path)
return frozenset(paths) return frozenset(paths)
@@ -257,7 +267,7 @@ class RuntimeConfig(Project, Profile, AdapterRequiredConfig):
paths = set() paths = set()
for key, value in config.items(): for key, value in config.items():
if isinstance(value, dict) and not key.startswith("+"): if isinstance(value, dict) and not key.startswith('+'):
self._get_v2_config_paths(value, path + (key,), paths) self._get_v2_config_paths(value, path + (key,), paths)
else: else:
paths.add(path) paths.add(path)
@@ -269,11 +279,11 @@ class RuntimeConfig(Project, Profile, AdapterRequiredConfig):
a configured path in the resource. a configured path in the resource.
""" """
return { return {
"models": self._get_config_paths(self.models), 'models': self._get_config_paths(self.models),
"seeds": self._get_config_paths(self.seeds), 'seeds': self._get_config_paths(self.seeds),
"snapshots": self._get_config_paths(self.snapshots), 'snapshots': self._get_config_paths(self.snapshots),
"sources": self._get_config_paths(self.sources), 'sources': self._get_config_paths(self.sources),
"tests": self._get_config_paths(self.tests), 'tests': self._get_config_paths(self.tests),
} }
def get_unused_resource_config_paths( def get_unused_resource_config_paths(
@@ -294,7 +304,9 @@ class RuntimeConfig(Project, Profile, AdapterRequiredConfig):
for config_path in config_paths: for config_path in config_paths:
if not _is_config_used(config_path, fqns): if not _is_config_used(config_path, fqns):
unused_resource_config_paths.append((resource_type,) + config_path) unused_resource_config_paths.append(
(resource_type,) + config_path
)
return unused_resource_config_paths return unused_resource_config_paths
def warn_for_unused_resource_config_paths( def warn_for_unused_resource_config_paths(
@@ -307,38 +319,38 @@ class RuntimeConfig(Project, Profile, AdapterRequiredConfig):
return return
msg = UNUSED_RESOURCE_CONFIGURATION_PATH_MESSAGE.format( msg = UNUSED_RESOURCE_CONFIGURATION_PATH_MESSAGE.format(
len(unused), "\n".join("- {}".format(".".join(u)) for u in unused) len(unused),
'\n'.join('- {}'.format('.'.join(u)) for u in unused)
) )
warn_or_error(msg, log_fmt=warning_tag("{}")) warn_or_error(msg, log_fmt=warning_tag('{}'))
def load_dependencies(self, base_only=False) -> Mapping[str, "RuntimeConfig"]: def load_dependencies(self) -> Mapping[str, 'RuntimeConfig']:
if self.dependencies is None: if self.dependencies is None:
all_projects = {self.project_name: self} all_projects = {self.project_name: self}
internal_packages = get_include_paths(self.credentials.type) internal_packages = get_include_paths(self.credentials.type)
if base_only: # raise exception if fewer installed packages than in packages.yml
# Test setup -- we want to load macros without dependencies count_packages_specified = len(self.packages.packages) # type: ignore
project_paths = itertools.chain(internal_packages) count_packages_installed = len(tuple(self._get_project_directories()))
else: if count_packages_specified > count_packages_installed:
# raise exception if fewer installed packages than in packages.yml raise_compiler_error(
count_packages_specified = len(self.packages.packages) # type: ignore f'dbt found {count_packages_specified} package(s) '
count_packages_installed = len(tuple(self._get_project_directories())) f'specified in packages.yml, but only '
if count_packages_specified > count_packages_installed: f'{count_packages_installed} package(s) installed '
raise_compiler_error( f'in {self.modules_path}. Run "dbt deps" to '
f"dbt found {count_packages_specified} package(s) " f'install package dependencies.'
f"specified in packages.yml, but only " )
f"{count_packages_installed} package(s) installed " project_paths = itertools.chain(
f'in {self.packages_install_path}. Run "dbt deps" to ' internal_packages,
f"install package dependencies." self._get_project_directories()
) )
project_paths = itertools.chain(internal_packages, self._get_project_directories())
for project_name, project in self.load_projects(project_paths): for project_name, project in self.load_projects(project_paths):
if project_name in all_projects: if project_name in all_projects:
raise_compiler_error( raise_compiler_error(
f"dbt found more than one package with the name " f'dbt found more than one package with the name '
f'"{project_name}" included in this project. Package ' f'"{project_name}" included in this project. Package '
f"names must be unique in a project. Please rename " f'names must be unique in a project. Please rename '
f"one of these packages." f'one of these packages.'
) )
all_projects[project_name] = project all_projects[project_name] = project
self.dependencies = all_projects self.dependencies = all_projects
@@ -347,32 +359,33 @@ class RuntimeConfig(Project, Profile, AdapterRequiredConfig):
def clear_dependencies(self): def clear_dependencies(self):
self.dependencies = None self.dependencies = None
# Called by 'load_dependencies' in this class def load_projects(
def load_projects(self, paths: Iterable[Path]) -> Iterator[Tuple[str, "RuntimeConfig"]]: self, paths: Iterable[Path]
) -> Iterator[Tuple[str, 'RuntimeConfig']]:
for path in paths: for path in paths:
try: try:
project = self.new_project(str(path)) project = self.new_project(str(path))
except DbtProjectError as e: except DbtProjectError as e:
raise DbtProjectError( raise DbtProjectError(
f"Failed to read package: {e}", f'Failed to read package: {e}',
result_type="invalid_project", result_type='invalid_project',
path=path, path=path,
) from e ) from e
else: else:
yield project.project_name, project yield project.project_name, project
def _get_project_directories(self) -> Iterator[Path]: def _get_project_directories(self) -> Iterator[Path]:
root = Path(self.project_root) / self.packages_install_path root = Path(self.project_root) / self.modules_path
if root.exists(): if root.exists():
for path in root.iterdir(): for path in root.iterdir():
if path.is_dir() and not path.name.startswith("__"): if path.is_dir() and not path.name.startswith('__'):
yield path yield path
class UnsetCredentials(Credentials): class UnsetCredentials(Credentials):
def __init__(self): def __init__(self):
super().__init__("", "") super().__init__('', '')
@property @property
def type(self): def type(self):
@@ -389,37 +402,43 @@ class UnsetCredentials(Credentials):
return () return ()
# This is used by UnsetProfileConfig, for commands which do class UnsetConfig(UserConfig):
# not require a profile, i.e. dbt deps and clean def __getattribute__(self, name):
if name in {f.name for f in fields(UserConfig)}:
raise AttributeError(
f"'UnsetConfig' object has no attribute {name}"
)
def __post_serialize__(self, dct):
return {}
class UnsetProfile(Profile): class UnsetProfile(Profile):
def __init__(self): def __init__(self):
self.credentials = UnsetCredentials() self.credentials = UnsetCredentials()
self.user_config = UserConfig() # This will be read in _get_rendered_profile self.config = UnsetConfig()
self.profile_name = "" self.profile_name = ''
self.target_name = "" self.target_name = ''
self.threads = -1 self.threads = -1
def to_target_dict(self): def to_target_dict(self):
return DictDefaultEmptyStr({}) return {}
def __getattribute__(self, name): def __getattribute__(self, name):
if name in {"profile_name", "target_name", "threads"}: if name in {'profile_name', 'target_name', 'threads'}:
raise RuntimeException(f'Error: disallowed attribute "{name}" - no profile!') raise RuntimeException(
f'Error: disallowed attribute "{name}" - no profile!'
)
return Profile.__getattribute__(self, name) return Profile.__getattribute__(self, name)
# This class is used by the dbt deps and clean commands, because they don't
# require a functioning profile.
@dataclass @dataclass
class UnsetProfileConfig(RuntimeConfig): class UnsetProfileConfig(RuntimeConfig):
"""This class acts a lot _like_ a RuntimeConfig, except if your profile is """This class acts a lot _like_ a RuntimeConfig, except if your profile is
missing, any access to profile members results in an exception. missing, any access to profile members results in an exception.
""" """
profile_name: str = field(repr=False)
target_name: str = field(repr=False)
def __post_init__(self): def __post_init__(self):
# instead of futzing with InitVar overrides or rewriting __init__, just # instead of futzing with InitVar overrides or rewriting __init__, just
# `del` the attrs we don't want users touching. # `del` the attrs we don't want users touching.
@@ -430,65 +449,17 @@ class UnsetProfileConfig(RuntimeConfig):
def __getattribute__(self, name): def __getattribute__(self, name):
# Override __getattribute__ to check that the attribute isn't 'banned'. # Override __getattribute__ to check that the attribute isn't 'banned'.
if name in {"profile_name", "target_name"}: if name in {'profile_name', 'target_name'}:
raise RuntimeException(f'Error: disallowed attribute "{name}" - no profile!') raise RuntimeException(
f'Error: disallowed attribute "{name}" - no profile!'
)
# avoid every attribute access triggering infinite recursion # avoid every attribute access triggering infinite recursion
return RuntimeConfig.__getattribute__(self, name) return RuntimeConfig.__getattribute__(self, name)
def to_target_dict(self): def to_target_dict(self):
# re-override the poisoned profile behavior # re-override the poisoned profile behavior
return DictDefaultEmptyStr({}) return {}
def to_project_config(self, with_packages=False):
"""Return a dict representation of the config that could be written to
disk with `yaml.safe_dump` to get this configuration.
Overrides dbt.config.Project.to_project_config to omit undefined profile
attributes.
:param with_packages bool: If True, include the serialized packages
file in the root.
:returns dict: The serialized profile.
"""
result = deepcopy(
{
"name": self.project_name,
"version": self.version,
"project-root": self.project_root,
"profile": "",
"model-paths": self.model_paths,
"macro-paths": self.macro_paths,
"seed-paths": self.seed_paths,
"test-paths": self.test_paths,
"analysis-paths": self.analysis_paths,
"docs-paths": self.docs_paths,
"asset-paths": self.asset_paths,
"target-path": self.target_path,
"snapshot-paths": self.snapshot_paths,
"clean-targets": self.clean_targets,
"log-path": self.log_path,
"quoting": self.quoting,
"models": self.models,
"on-run-start": self.on_run_start,
"on-run-end": self.on_run_end,
"dispatch": self.dispatch,
"seeds": self.seeds,
"snapshots": self.snapshots,
"sources": self.sources,
"tests": self.tests,
"vars": self.vars.to_dict(),
"require-dbt-version": [v.to_version_string() for v in self.dbt_version],
"config-version": self.config_version,
}
)
if self.query_comment:
result["query-comment"] = self.query_comment.to_dict(omit_none=True)
if with_packages:
result.update(self.packages.to_dict(omit_none=True))
return result
@classmethod @classmethod
def from_parts( def from_parts(
@@ -496,8 +467,8 @@ class UnsetProfileConfig(RuntimeConfig):
project: Project, project: Project,
profile: Profile, profile: Profile,
args: Any, args: Any,
dependencies: Optional[Mapping[str, "RuntimeConfig"]] = None, dependencies: Optional[Mapping[str, 'RuntimeConfig']] = None,
) -> "RuntimeConfig": ) -> 'RuntimeConfig':
"""Instantiate a RuntimeConfig from its components. """Instantiate a RuntimeConfig from its components.
:param profile: Ignored. :param profile: Ignored.
@@ -505,15 +476,15 @@ class UnsetProfileConfig(RuntimeConfig):
:param args: The parsed command-line arguments. :param args: The parsed command-line arguments.
:returns RuntimeConfig: The new configuration. :returns RuntimeConfig: The new configuration.
""" """
cli_vars: Dict[str, Any] = parse_cli_vars(getattr(args, "vars", "{}")) cli_vars: Dict[str, Any] = parse_cli_vars(getattr(args, 'vars', '{}'))
return cls( return cls(
project_name=project.project_name, project_name=project.project_name,
version=project.version, version=project.version,
project_root=project.project_root, project_root=project.project_root,
model_paths=project.model_paths, source_paths=project.source_paths,
macro_paths=project.macro_paths, macro_paths=project.macro_paths,
seed_paths=project.seed_paths, data_paths=project.data_paths,
test_paths=project.test_paths, test_paths=project.test_paths,
analysis_paths=project.analysis_paths, analysis_paths=project.analysis_paths,
docs_paths=project.docs_paths, docs_paths=project.docs_paths,
@@ -522,7 +493,7 @@ class UnsetProfileConfig(RuntimeConfig):
snapshot_paths=project.snapshot_paths, snapshot_paths=project.snapshot_paths,
clean_targets=project.clean_targets, clean_targets=project.clean_targets,
log_path=project.log_path, log_path=project.log_path,
packages_install_path=project.packages_install_path, modules_path=project.modules_path,
quoting=project.quoting, # we never use this anyway. quoting=project.quoting, # we never use this anyway.
models=project.models, models=project.models,
on_run_start=project.on_run_start, on_run_start=project.on_run_start,
@@ -540,12 +511,10 @@ class UnsetProfileConfig(RuntimeConfig):
vars=project.vars, vars=project.vars,
config_version=project.config_version, config_version=project.config_version,
unrendered=project.unrendered, unrendered=project.unrendered,
project_env_vars=project.project_env_vars, profile_name='',
profile_env_vars=profile.profile_env_vars, target_name='',
profile_name="", config=UnsetConfig(),
target_name="", threads=getattr(args, 'threads', 1),
user_config=UserConfig(),
threads=getattr(args, "threads", 1),
credentials=UnsetCredentials(), credentials=UnsetCredentials(),
args=args, args=args,
cli_vars=cli_vars, cli_vars=cli_vars,
@@ -559,16 +528,26 @@ class UnsetProfileConfig(RuntimeConfig):
profile_renderer: ProfileRenderer, profile_renderer: ProfileRenderer,
profile_name: Optional[str], profile_name: Optional[str],
) -> Profile: ) -> Profile:
try:
profile = UnsetProfile() profile = Profile.render_from_args(
# The profile (for warehouse connection) is not needed, but we want args, profile_renderer, profile_name
# to get the UserConfig, which is also in profiles.yml )
user_config = read_user_config(flags.PROFILES_DIR) except (DbtProjectError, DbtProfileError) as exc:
profile.user_config = user_config logger.debug(
'Profile not loaded due to error: {}', exc, exc_info=True
)
logger.info(
'No profile "{}" found, continuing with no target',
profile_name
)
# return the poisoned form
profile = UnsetProfile()
# disable anonymous usage statistics
tracking.disable_tracking()
return profile return profile
@classmethod @classmethod
def from_args(cls: Type[RuntimeConfig], args: Any) -> "RuntimeConfig": def from_args(cls: Type[RuntimeConfig], args: Any) -> 'RuntimeConfig':
"""Given arguments, read in dbt_project.yml from the current directory, """Given arguments, read in dbt_project.yml from the current directory,
read in packages.yml if it exists, and use them to find the profile to read in packages.yml if it exists, and use them to find the profile to
load. load.
@@ -579,8 +558,15 @@ class UnsetProfileConfig(RuntimeConfig):
:raises ValidationException: If the cli variables are invalid. :raises ValidationException: If the cli variables are invalid.
""" """
project, profile = cls.collect_parts(args) project, profile = cls.collect_parts(args)
if not isinstance(profile, UnsetProfile):
# if it's a real profile, return a real config
cls = RuntimeConfig
return cls.from_parts(project=project, profile=profile, args=args) return cls.from_parts(
project=project,
profile=profile,
args=args
)
UNUSED_RESOURCE_CONFIGURATION_PATH_MESSAGE = """\ UNUSED_RESOURCE_CONFIGURATION_PATH_MESSAGE = """\
@@ -594,6 +580,6 @@ There are {} unused configuration paths:
def _is_config_used(path, fqns): def _is_config_used(path, fqns):
if fqns: if fqns:
for fqn in fqns: for fqn in fqns:
if len(path) <= len(fqn) and fqn[: len(path)] == path: if len(path) <= len(fqn) and fqn[:len(path)] == path:
return True return True
return False return False

View File

@@ -1,10 +1,11 @@
from pathlib import Path from pathlib import Path
from copy import deepcopy from typing import Dict, Any
from typing import Dict, Any, Union from dbt.clients.yaml_helper import ( # noqa: F401
from dbt.clients.yaml_helper import yaml, Loader, Dumper, load_yaml_text # noqa: F401 yaml, Loader, Dumper, load_yaml_text
)
from dbt.dataclass_schema import ValidationError from dbt.dataclass_schema import ValidationError
from .renderer import BaseRenderer from .renderer import SelectorRenderer
from dbt.clients.system import ( from dbt.clients.system import (
load_file_contents, load_file_contents,
@@ -28,13 +29,13 @@ Validator Error:
""" """
class SelectorConfig(Dict[str, Dict[str, Union[SelectionSpec, bool]]]): class SelectorConfig(Dict[str, SelectionSpec]):
@classmethod @classmethod
def selectors_from_dict(cls, data: Dict[str, Any]) -> "SelectorConfig": def selectors_from_dict(cls, data: Dict[str, Any]) -> 'SelectorConfig':
try: try:
SelectorFile.validate(data) SelectorFile.validate(data)
selector_file = SelectorFile.from_dict(data) selector_file = SelectorFile.from_dict(data)
validate_selector_default(selector_file)
selectors = parse_from_selectors_definition(selector_file) selectors = parse_from_selectors_definition(selector_file)
except ValidationError as exc: except ValidationError as exc:
yaml_sel_cfg = yaml.dump(exc.instance) yaml_sel_cfg = yaml.dump(exc.instance)
@@ -44,12 +45,12 @@ class SelectorConfig(Dict[str, Dict[str, Union[SelectionSpec, bool]]]):
f"union, intersection, string, dictionary. No lists. " f"union, intersection, string, dictionary. No lists. "
f"\nhttps://docs.getdbt.com/reference/node-selection/" f"\nhttps://docs.getdbt.com/reference/node-selection/"
f"yaml-selectors", f"yaml-selectors",
result_type="invalid_selector", result_type='invalid_selector'
) from exc ) from exc
except RuntimeException as exc: except RuntimeException as exc:
raise DbtSelectorsError( raise DbtSelectorsError(
f"Could not read selector file data: {exc}", f'Could not read selector file data: {exc}',
result_type="invalid_selector", result_type='invalid_selector',
) from exc ) from exc
return cls(selectors) return cls(selectors)
@@ -58,29 +59,27 @@ class SelectorConfig(Dict[str, Dict[str, Union[SelectionSpec, bool]]]):
def render_from_dict( def render_from_dict(
cls, cls,
data: Dict[str, Any], data: Dict[str, Any],
renderer: BaseRenderer, renderer: SelectorRenderer,
) -> "SelectorConfig": ) -> 'SelectorConfig':
try: try:
rendered = renderer.render_data(data) rendered = renderer.render_data(data)
except (ValidationError, RuntimeException) as exc: except (ValidationError, RuntimeException) as exc:
raise DbtSelectorsError( raise DbtSelectorsError(
f"Could not render selector data: {exc}", f'Could not render selector data: {exc}',
result_type="invalid_selector", result_type='invalid_selector',
) from exc ) from exc
return cls.selectors_from_dict(rendered) return cls.selectors_from_dict(rendered)
@classmethod @classmethod
def from_path( def from_path(
cls, cls, path: Path, renderer: SelectorRenderer,
path: Path, ) -> 'SelectorConfig':
renderer: BaseRenderer,
) -> "SelectorConfig":
try: try:
data = load_yaml_text(load_file_contents(str(path))) data = load_yaml_text(load_file_contents(str(path)))
except (ValidationError, RuntimeException) as exc: except (ValidationError, RuntimeException) as exc:
raise DbtSelectorsError( raise DbtSelectorsError(
f"Could not read selector file: {exc}", f'Could not read selector file: {exc}',
result_type="invalid_selector", result_type='invalid_selector',
path=path, path=path,
) from exc ) from exc
@@ -92,7 +91,9 @@ class SelectorConfig(Dict[str, Dict[str, Union[SelectionSpec, bool]]]):
def selector_data_from_root(project_root: str) -> Dict[str, Any]: def selector_data_from_root(project_root: str) -> Dict[str, Any]:
selector_filepath = resolve_path_from_base("selectors.yml", project_root) selector_filepath = resolve_path_from_base(
'selectors.yml', project_root
)
if path_exists(selector_filepath): if path_exists(selector_filepath):
selectors_dict = load_yaml_text(load_file_contents(selector_filepath)) selectors_dict = load_yaml_text(load_file_contents(selector_filepath))
@@ -101,38 +102,22 @@ def selector_data_from_root(project_root: str) -> Dict[str, Any]:
return selectors_dict return selectors_dict
def selector_config_from_data(selectors_data: Dict[str, Any]) -> SelectorConfig: def selector_config_from_data(
selectors_data: Dict[str, Any]
) -> SelectorConfig:
if not selectors_data: if not selectors_data:
selectors_data = {"selectors": []} selectors_data = {'selectors': []}
try: try:
selectors = SelectorConfig.selectors_from_dict(selectors_data) selectors = SelectorConfig.selectors_from_dict(selectors_data)
except ValidationError as e: except ValidationError as e:
raise DbtSelectorsError( raise DbtSelectorsError(
MALFORMED_SELECTOR_ERROR.format(error=str(e.message)), MALFORMED_SELECTOR_ERROR.format(error=str(e.message)),
result_type="invalid_selector", result_type='invalid_selector',
) from e ) from e
return selectors return selectors
def validate_selector_default(selector_file: SelectorFile) -> None:
"""Check if a selector.yml file has more than 1 default key set to true"""
default_set: bool = False
default_selector_name: Union[str, None] = None
for selector in selector_file.selectors:
if selector.default is True and default_set is False:
default_set = True
default_selector_name = selector.name
continue
if selector.default is True and default_set is True:
raise DbtSelectorsError(
"Error when parsing the selector file. "
"Found multiple selectors with `default: true`:"
f"{default_selector_name} and {selector.name}"
)
# These are utilities to clean up the dictionary created from # These are utilities to clean up the dictionary created from
# selectors.yml by turning the cli-string format entries into # selectors.yml by turning the cli-string format entries into
# normalized dictionary entries. It parallels the flow in # normalized dictionary entries. It parallels the flow in
@@ -140,34 +125,30 @@ def validate_selector_default(selector_file: SelectorFile) -> None:
# be necessary to make changes here. Ideally it would be # be necessary to make changes here. Ideally it would be
# good to combine the two flows into one at some point. # good to combine the two flows into one at some point.
class SelectorDict: class SelectorDict:
@classmethod @classmethod
def parse_dict_definition(cls, definition, selector_dict={}): def parse_dict_definition(cls, definition):
key = list(definition)[0] key = list(definition)[0]
value = definition[key] value = definition[key]
if isinstance(value, list): if isinstance(value, list):
new_values = [] new_values = []
for sel_def in value: for sel_def in value:
new_value = cls.parse_from_definition(sel_def, selector_dict=selector_dict) new_value = cls.parse_from_definition(sel_def)
new_values.append(new_value) new_values.append(new_value)
value = new_values value = new_values
if key == "exclude": if key == 'exclude':
definition = {key: value} definition = {key: value}
elif len(definition) == 1: elif len(definition) == 1:
definition = {"method": key, "value": value} definition = {'method': key, 'value': value}
elif key == "method" and value == "selector":
sel_def = definition.get("value")
if sel_def not in selector_dict:
raise DbtSelectorsError(f"Existing selector definition for {sel_def} not found.")
return selector_dict[definition["value"]]["definition"]
return definition return definition
@classmethod @classmethod
def parse_a_definition(cls, def_type, definition, selector_dict={}): def parse_a_definition(cls, def_type, definition):
# this definition must be a list # this definition must be a list
new_dict = {def_type: []} new_dict = {def_type: []}
for sel_def in definition[def_type]: for sel_def in definition[def_type]:
if isinstance(sel_def, dict): if isinstance(sel_def, dict):
sel_def = cls.parse_from_definition(sel_def, selector_dict=selector_dict) sel_def = cls.parse_from_definition(sel_def)
new_dict[def_type].append(sel_def) new_dict[def_type].append(sel_def)
elif isinstance(sel_def, str): elif isinstance(sel_def, str):
sel_def = SelectionCriteria.dict_from_single_spec(sel_def) sel_def = SelectionCriteria.dict_from_single_spec(sel_def)
@@ -177,17 +158,15 @@ class SelectorDict:
return new_dict return new_dict
@classmethod @classmethod
def parse_from_definition(cls, definition, selector_dict={}): def parse_from_definition(cls, definition):
if isinstance(definition, str): if isinstance(definition, str):
definition = SelectionCriteria.dict_from_single_spec(definition) definition = SelectionCriteria.dict_from_single_spec(definition)
elif "union" in definition: elif 'union' in definition:
definition = cls.parse_a_definition("union", definition, selector_dict=selector_dict) definition = cls.parse_a_definition('union', definition)
elif "intersection" in definition: elif 'intersection' in definition:
definition = cls.parse_a_definition( definition = cls.parse_a_definition('intersection', definition)
"intersection", definition, selector_dict=selector_dict
)
elif isinstance(definition, dict): elif isinstance(definition, dict):
definition = cls.parse_dict_definition(definition, selector_dict=selector_dict) definition = cls.parse_dict_definition(definition)
return definition return definition
# This is the normal entrypoint of this code. Give it the # This is the normal entrypoint of this code. Give it the
@@ -196,10 +175,8 @@ class SelectorDict:
def parse_from_selectors_list(cls, selectors): def parse_from_selectors_list(cls, selectors):
selector_dict = {} selector_dict = {}
for selector in selectors: for selector in selectors:
sel_name = selector["name"] sel_name = selector['name']
selector_dict[sel_name] = selector selector_dict[sel_name] = selector
definition = cls.parse_from_definition( definition = cls.parse_from_definition(selector['definition'])
selector["definition"], selector_dict=deepcopy(selector_dict) selector_dict[sel_name]['definition'] = definition
)
selector_dict[sel_name]["definition"] = definition
return selector_dict return selector_dict

View File

@@ -1,15 +1,8 @@
from argparse import Namespace from typing import Dict, Any
from typing import Any, Dict, Optional, Union
from xmlrpc.client import Boolean
from dbt.contracts.project import UserConfig
import dbt.flags as flags
from dbt.clients import yaml_helper from dbt.clients import yaml_helper
from dbt.config import Profile, Project, read_user_config from dbt.exceptions import raise_compiler_error, ValidationException
from dbt.config.renderer import DbtProjectYamlRenderer, ProfileRenderer from dbt.logger import GLOBAL_LOGGER as logger
from dbt.events.functions import fire_event
from dbt.events.types import InvalidVarsYAML
from dbt.exceptions import ValidationException, raise_compiler_error
def parse_cli_vars(var_string: str) -> Dict[str, Any]: def parse_cli_vars(var_string: str) -> Dict[str, Any]:
@@ -22,54 +15,9 @@ def parse_cli_vars(var_string: str) -> Dict[str, Any]:
type_name = var_type.__name__ type_name = var_type.__name__
raise_compiler_error( raise_compiler_error(
"The --vars argument must be a YAML dictionary, but was " "The --vars argument must be a YAML dictionary, but was "
"of type '{}'".format(type_name) "of type '{}'".format(type_name))
)
except ValidationException: except ValidationException:
fire_event(InvalidVarsYAML()) logger.error(
"The YAML provided in the --vars argument is not valid.\n"
)
raise raise
def get_project_config(
project_path: str,
profile_name: str,
args: Namespace = Namespace(),
cli_vars: Optional[Dict[str, Any]] = None,
profile: Optional[Profile] = None,
user_config: Optional[UserConfig] = None,
return_dict: Boolean = True,
) -> Union[Project, Dict]:
"""Returns a project config (dict or object) from a given project path and profile name.
Args:
project_path: Path to project
profile_name: Name of profile
args: An argparse.Namespace that represents what would have been passed in on the
command line (optional)
cli_vars: A dict of any vars that would have been passed in on the command line (optional)
(see parse_cli_vars above for formatting details)
profile: A dbt.config.profile.Profile object (optional)
user_config: A dbt.contracts.project.UserConfig object (optional)
return_dict: Return a dict if true, return the full dbt.config.project.Project object if false
Returns:
A full project config
"""
# Generate a profile if not provided
if profile is None:
# Generate user_config if not provided
if user_config is None:
user_config = read_user_config(flags.PROFILES_DIR)
# Update flags
flags.set_from_args(args, user_config)
if cli_vars is None:
cli_vars = {}
profile = Profile.render_from_args(args, ProfileRenderer(cli_vars), profile_name)
# Generate a project
project = Project.from_project_root(
project_path,
DbtProjectYamlRenderer(profile),
verify_version=bool(flags.VERSION_CHECK),
)
# Return
return project.to_project_config() if return_dict else project

View File

@@ -1,51 +0,0 @@
# Contexts and Jinja rendering
Contexts are used for Jinja rendering. They include context methods, executable macros, and various settings that are available in Jinja.
The most common entrypoint to Jinja rendering in dbt is a method named `get_rendered`, which takes two arguments: templated code (string), and a context used to render it (dictionary).
The context is the bundle of information that is in "scope" when rendering Jinja-templated code. For instance, imagine a simple Jinja template:
```
{% set new_value = some_macro(some_variable) %}
```
Both `some_macro()` and `some_variable` must be defined in that context. Otherwise, it will raise an error when rendering.
Different contexts are used in different places because we allow access to different methods and data in different places. Executable SQL, for example, includes all available macros and the model being run. The variables and macros in scope for Jinja defined in yaml files is much more limited.
### Implementation
The context that is passed to Jinja is always in a dictionary format, not an actual class, so a `to_dict()` is executed on a context class before it is used for rendering.
Each context has a `generate_<name>_context` function to create the context. `ProviderContext` subclasses have different generate functions for parsing and for execution, so that certain functions (notably `ref`, `source`, and `config`) can return different results
### Hierarchy
All contexts inherit from the `BaseContext`, which includes "pure" methods (e.g. `tojson`), `env_var()`, and `var()` (but only CLI values, passed via `--vars`).
Methods available in parent contexts are also available in child contexts.
```
BaseContext -- core/dbt/context/base.py
SecretContext -- core/dbt/context/secret.py
TargetContext -- core/dbt/context/target.py
ConfiguredContext -- core/dbt/context/configured.py
SchemaYamlContext -- core/dbt/context/configured.py
DocsRuntimeContext -- core/dbt/context/configured.py
MacroResolvingContext -- core/dbt/context/configured.py
ManifestContext -- core/dbt/context/manifest.py
QueryHeaderContext -- core/dbt/context/manifest.py
ProviderContext -- core/dbt/context/provider.py
MacroContext -- core/dbt/context/provider.py
ModelContext -- core/dbt/context/provider.py
TestContext -- core/dbt/context/provider.py
```
### Contexts for configuration
Contexts for rendering "special" `.yml` (configuration) files:
- `SecretContext`: Supports "secret" env vars, which are prefixed with `DBT_ENV_SECRET_`. Used for rendering in `profiles.yml` and `packages.yml` ONLY. Secrets defined elsewhere will raise explicit errors.
- `TargetContext`: The same as `Base`, plus `target` (connection profile). Used most notably in `dbt_project.yml` and `selectors.yml`.
Contexts for other `.yml` files in the project:
- `SchemaYamlContext`: Supports `vars` declared on the CLI and in `dbt_project.yml`. Does not support custom macros, beyond `var()` + `env_var()` methods. Used for all `.yml` files, to define properties and configuration.
- `DocsRuntimeContext`: Standard `.yml` file context, plus `doc()` method (with all `docs` blocks in scope). Used to resolve `description` properties.

View File

@@ -1,22 +1,18 @@
import json import json
import os import os
from typing import Any, Dict, NoReturn, Optional, Mapping, Iterable, Set, List from typing import (
Any, Dict, NoReturn, Optional, Mapping
)
from dbt import flags from dbt import flags
from dbt import tracking from dbt import tracking
from dbt.clients.jinja import get_rendered from dbt.clients.jinja import undefined_error, get_rendered
from dbt.clients.yaml_helper import yaml, safe_load, SafeLoader, Loader, Dumper # noqa: F401 from dbt.clients.yaml_helper import ( # noqa: F401
from dbt.contracts.graph.compiled import CompiledResource yaml, safe_load, SafeLoader, Loader, Dumper
from dbt.exceptions import (
CompilationException,
MacroReturn,
raise_compiler_error,
raise_parsing_error,
disallow_secret_env_var,
) )
from dbt.logger import SECRET_ENV_PREFIX from dbt.contracts.graph.compiled import CompiledResource
from dbt.events.functions import fire_event, get_invocation_id from dbt.exceptions import raise_compiler_error, MacroReturn
from dbt.events.types import MacroEventInfo, MacroEventDebug from dbt.logger import GLOBAL_LOGGER as logger
from dbt.version import __version__ as dbt_version from dbt.version import __version__ as dbt_version
# These modules are added to the context. Consider alternative # These modules are added to the context. Consider alternative
@@ -24,59 +20,43 @@ from dbt.version import __version__ as dbt_version
import pytz import pytz
import datetime import datetime
import re import re
import itertools
# See the `contexts` module README for more information on how contexts work
def get_pytz_module_context() -> Dict[str, Any]: def get_pytz_module_context() -> Dict[str, Any]:
context_exports = pytz.__all__ # type: ignore context_exports = pytz.__all__ # type: ignore
return {name: getattr(pytz, name) for name in context_exports} return {
name: getattr(pytz, name) for name in context_exports
}
def get_datetime_module_context() -> Dict[str, Any]: def get_datetime_module_context() -> Dict[str, Any]:
context_exports = ["date", "datetime", "time", "timedelta", "tzinfo"] context_exports = [
'date',
'datetime',
'time',
'timedelta',
'tzinfo'
]
return {name: getattr(datetime, name) for name in context_exports} return {
name: getattr(datetime, name) for name in context_exports
}
def get_re_module_context() -> Dict[str, Any]: def get_re_module_context() -> Dict[str, Any]:
# TODO CT-211 context_exports = re.__all__
context_exports = re.__all__ # type: ignore[attr-defined]
return {name: getattr(re, name) for name in context_exports} return {
name: getattr(re, name) for name in context_exports
}
def get_itertools_module_context() -> Dict[str, Any]:
# Excluded dropwhile, filterfalse, takewhile and groupby;
# first 3 illogical for Jinja and last redundant.
context_exports = [
"count",
"cycle",
"repeat",
"accumulate",
"chain",
"compress",
"islice",
"starmap",
"tee",
"zip_longest",
"product",
"permutations",
"combinations",
"combinations_with_replacement",
]
return {name: getattr(itertools, name) for name in context_exports}
def get_context_modules() -> Dict[str, Dict[str, Any]]: def get_context_modules() -> Dict[str, Dict[str, Any]]:
return { return {
"pytz": get_pytz_module_context(), 'pytz': get_pytz_module_context(),
"datetime": get_datetime_module_context(), 'datetime': get_datetime_module_context(),
"re": get_re_module_context(), 're': get_re_module_context(),
"itertools": get_itertools_module_context(),
} }
@@ -110,8 +90,8 @@ class ContextMeta(type):
new_dct = {} new_dct = {}
for base in bases: for base in bases:
context_members.update(getattr(base, "_context_members_", {})) context_members.update(getattr(base, '_context_members_', {}))
context_attrs.update(getattr(base, "_context_attrs_", {})) context_attrs.update(getattr(base, '_context_attrs_', {}))
for key, value in dct.items(): for key, value in dct.items():
if isinstance(value, ContextMember): if isinstance(value, ContextMember):
@@ -120,20 +100,21 @@ class ContextMeta(type):
context_attrs[context_key] = key context_attrs[context_key] = key
value = value.inner value = value.inner
new_dct[key] = value new_dct[key] = value
new_dct["_context_members_"] = context_members new_dct['_context_members_'] = context_members
new_dct["_context_attrs_"] = context_attrs new_dct['_context_attrs_'] = context_attrs
return type.__new__(mcls, name, bases, new_dct) return type.__new__(mcls, name, bases, new_dct)
class Var: class Var:
UndefinedVarError = "Required var '{}' not found in config:\nVars " "supplied to {} = {}" UndefinedVarError = "Required var '{}' not found in config:\nVars "\
"supplied to {} = {}"
_VAR_NOTSET = object() _VAR_NOTSET = object()
def __init__( def __init__(
self, self,
context: Mapping[str, Any], context: Mapping[str, Any],
cli_vars: Mapping[str, Any], cli_vars: Mapping[str, Any],
node: Optional[CompiledResource] = None, node: Optional[CompiledResource] = None
) -> None: ) -> None:
self._context: Mapping[str, Any] = context self._context: Mapping[str, Any] = context
self._cli_vars: Mapping[str, Any] = cli_vars self._cli_vars: Mapping[str, Any] = cli_vars
@@ -148,12 +129,14 @@ class Var:
if self._node is not None: if self._node is not None:
return self._node.name return self._node.name
else: else:
return "<Configuration>" return '<Configuration>'
def get_missing_var(self, var_name): def get_missing_var(self, var_name):
dct = {k: self._merged[k] for k in self._merged} dct = {k: self._merged[k] for k in self._merged}
pretty_vars = json.dumps(dct, sort_keys=True, indent=4) pretty_vars = json.dumps(dct, sort_keys=True, indent=4)
msg = self.UndefinedVarError.format(var_name, self.node_name, pretty_vars) msg = self.UndefinedVarError.format(
var_name, self.node_name, pretty_vars
)
raise_compiler_error(msg, self._node) raise_compiler_error(msg, self._node)
def has_var(self, var_name: str): def has_var(self, var_name: str):
@@ -177,16 +160,14 @@ class Var:
class BaseContext(metaclass=ContextMeta): class BaseContext(metaclass=ContextMeta):
# subclass is TargetContext
def __init__(self, cli_vars): def __init__(self, cli_vars):
self._ctx = {} self._ctx = {}
self.cli_vars = cli_vars self.cli_vars = cli_vars
self.env_vars = {}
def generate_builtins(self): def generate_builtins(self):
builtins: Dict[str, Any] = {} builtins: Dict[str, Any] = {}
for key, value in self._context_members_.items(): for key, value in self._context_members_.items():
if hasattr(value, "__get__"): if hasattr(value, '__get__'):
# handle properties, bound methods, etc # handle properties, bound methods, etc
value = value.__get__(self) value = value.__get__(self)
builtins[key] = value builtins[key] = value
@@ -194,9 +175,9 @@ class BaseContext(metaclass=ContextMeta):
# no dbtClassMixin so this is not an actual override # no dbtClassMixin so this is not an actual override
def to_dict(self): def to_dict(self):
self._ctx["context"] = self._ctx self._ctx['context'] = self._ctx
builtins = self.generate_builtins() builtins = self.generate_builtins()
self._ctx["builtins"] = builtins self._ctx['builtins'] = builtins
self._ctx.update(builtins) self._ctx.update(builtins)
return self._ctx return self._ctx
@@ -290,41 +271,33 @@ class BaseContext(metaclass=ContextMeta):
return Var(self._ctx, self.cli_vars) return Var(self._ctx, self.cli_vars)
@contextmember @contextmember
def env_var(self, var: str, default: Optional[str] = None) -> str: @staticmethod
def env_var(var: str, default: Optional[str] = None) -> str:
"""The env_var() function. Return the environment variable named 'var'. """The env_var() function. Return the environment variable named 'var'.
If there is no such environment variable set, return the default. If there is no such environment variable set, return the default.
If the default is None, raise an exception for an undefined variable. If the default is None, raise an exception for an undefined variable.
""" """
return_value = None
if var.startswith(SECRET_ENV_PREFIX):
disallow_secret_env_var(var)
if var in os.environ: if var in os.environ:
return_value = os.environ[var] return os.environ[var]
elif default is not None: elif default is not None:
return_value = default return default
if return_value is not None:
self.env_vars[var] = return_value
return return_value
else: else:
msg = f"Env var required but not provided: '{var}'" msg = f"Env var required but not provided: '{var}'"
raise_parsing_error(msg) undefined_error(msg)
if os.environ.get("DBT_MACRO_DEBUGGING"):
if os.environ.get('DBT_MACRO_DEBUGGING'):
@contextmember @contextmember
@staticmethod @staticmethod
def debug(): def debug():
"""Enter a debugger at this line in the compiled jinja code.""" """Enter a debugger at this line in the compiled jinja code."""
import sys import sys
import ipdb # type: ignore import ipdb # type: ignore
frame = sys._getframe(3) frame = sys._getframe(3)
ipdb.set_trace(frame) ipdb.set_trace(frame)
return "" return ''
@contextmember("return") @contextmember('return')
@staticmethod @staticmethod
def _return(data: Any) -> NoReturn: def _return(data: Any) -> NoReturn:
"""The `return` function can be used in macros to return data to the """The `return` function can be used in macros to return data to the
@@ -375,7 +348,9 @@ class BaseContext(metaclass=ContextMeta):
@contextmember @contextmember
@staticmethod @staticmethod
def tojson(value: Any, default: Any = None, sort_keys: bool = False) -> Any: def tojson(
value: Any, default: Any = None, sort_keys: bool = False
) -> Any:
"""The `tojson` context method can be used to serialize a Python """The `tojson` context method can be used to serialize a Python
object primitive, eg. a `dict` or `list` to a json string. object primitive, eg. a `dict` or `list` to a json string.
@@ -452,90 +427,6 @@ class BaseContext(metaclass=ContextMeta):
except (ValueError, yaml.YAMLError): except (ValueError, yaml.YAMLError):
return default return default
@contextmember("set")
@staticmethod
def _set(value: Iterable[Any], default: Any = None) -> Optional[Set[Any]]:
"""The `set` context method can be used to convert any iterable
to a sequence of iterable elements that are unique (a set).
:param value: The iterable
:param default: A default value to return if the `value` argument
is not an iterable
Usage:
{% set my_list = [1, 2, 2, 3] %}
{% set my_set = set(my_list) %}
{% do log(my_set) %} {# {1, 2, 3} #}
"""
try:
return set(value)
except TypeError:
return default
@contextmember
@staticmethod
def set_strict(value: Iterable[Any]) -> Set[Any]:
"""The `set_strict` context method can be used to convert any iterable
to a sequence of iterable elements that are unique (a set). The
difference to the `set` context method is that the `set_strict` method
will raise an exception on a TypeError.
:param value: The iterable
Usage:
{% set my_list = [1, 2, 2, 3] %}
{% set my_set = set_strict(my_list) %}
{% do log(my_set) %} {# {1, 2, 3} #}
"""
try:
return set(value)
except TypeError as e:
raise CompilationException(e)
@contextmember("zip")
@staticmethod
def _zip(*args: Iterable[Any], default: Any = None) -> Optional[Iterable[Any]]:
"""The `zip` context method can be used to used to return
an iterator of tuples, where the i-th tuple contains the i-th
element from each of the argument iterables.
:param *args: Any number of iterables
:param default: A default value to return if `*args` is not
iterable
Usage:
{% set my_list_a = [1, 2] %}
{% set my_list_b = ['alice', 'bob'] %}
{% set my_zip = zip(my_list_a, my_list_b) | list %}
{% do log(my_set) %} {# [(1, 'alice'), (2, 'bob')] #}
"""
try:
return zip(*args)
except TypeError:
return default
@contextmember
@staticmethod
def zip_strict(*args: Iterable[Any]) -> Iterable[Any]:
"""The `zip_strict` context method can be used to used to return
an iterator of tuples, where the i-th tuple contains the i-th
element from each of the argument iterables. The difference to the
`zip` context method is that the `zip_strict` method will raise an
exception on a TypeError.
:param *args: Any number of iterables
Usage:
{% set my_list_a = [1, 2] %}
{% set my_list_b = ['alice', 'bob'] %}
{% set my_zip = zip_strict(my_list_a, my_list_b) | list %}
{% do log(my_set) %} {# [(1, 'alice'), (2, 'bob')] #}
"""
try:
return zip(*args)
except TypeError as e:
raise CompilationException(e)
@contextmember @contextmember
@staticmethod @staticmethod
def log(msg: str, info: bool = False) -> str: def log(msg: str, info: bool = False) -> str:
@@ -552,10 +443,10 @@ class BaseContext(metaclass=ContextMeta):
{% endmacro %}" {% endmacro %}"
""" """
if info: if info:
fire_event(MacroEventInfo(msg=msg)) logger.info(msg)
else: else:
fire_event(MacroEventDebug(msg=msg)) logger.debug(msg)
return "" return ''
@contextproperty @contextproperty
def run_started_at(self) -> Optional[datetime.datetime]: def run_started_at(self) -> Optional[datetime.datetime]:
@@ -590,7 +481,10 @@ class BaseContext(metaclass=ContextMeta):
"""invocation_id outputs a UUID generated for this dbt run (useful for """invocation_id outputs a UUID generated for this dbt run (useful for
auditing) auditing)
""" """
return get_invocation_id() if tracking.active_user is not None:
return tracking.active_user.invocation_id
else:
return None
@contextproperty @contextproperty
def modules(self) -> Dict[str, Any]: def modules(self) -> Dict[str, Any]:
@@ -630,58 +524,17 @@ class BaseContext(metaclass=ContextMeta):
-- no-op -- no-op
{% endif %} {% endif %}
This supports all flags defined in flags submodule (core/dbt/flags.py) The list of valid flags are:
TODO: Replace with object that provides read-only access to flag values
- `flags.STRICT_MODE`: True if `--strict` (or `-S`) was provided on the
command line
- `flags.FULL_REFRESH`: True if `--full-refresh` was provided on the
command line
- `flags.NON_DESTRUCTIVE`: True if `--non-destructive` was provided on
the command line
""" """
return flags return flags
@contextmember
@staticmethod
def print(msg: str) -> str:
"""Prints a line to stdout.
:param msg: The message to print
> macros/my_log_macro.sql
{% macro some_macro(arg1, arg2) %}
{{ print("Running some_macro: " ~ arg1 ~ ", " ~ arg2) }}
{% endmacro %}"
"""
if not flags.NO_PRINT:
print(msg)
return ""
@contextmember
@staticmethod
def diff_of_two_dicts(
dict_a: Dict[str, List[str]], dict_b: Dict[str, List[str]]
) -> Dict[str, List[str]]:
"""
Given two dictionaries of type Dict[str, List[str]]:
dict_a = {'key_x': ['value_1', 'VALUE_2'], 'KEY_Y': ['value_3']}
dict_b = {'key_x': ['value_1'], 'key_z': ['value_4']}
Return the same dictionary representation of dict_a MINUS dict_b,
performing a case-insensitive comparison between the strings in each.
All keys returned will be in the original case of dict_a.
returns {'key_x': ['VALUE_2'], 'KEY_Y': ['value_3']}
"""
dict_diff = {}
dict_b_lowered = {k.casefold(): [x.casefold() for x in v] for k, v in dict_b.items()}
for k in dict_a:
if k.casefold() in dict_b_lowered.keys():
diff = []
for v in dict_a[k]:
if v.casefold() not in dict_b_lowered[k.casefold()]:
diff.append(v)
if diff:
dict_diff.update({k: diff})
else:
dict_diff.update({k: dict_a[k]})
return dict_diff
def generate_base_context(cli_vars: Dict[str, Any]) -> Dict[str, Any]: def generate_base_context(cli_vars: Dict[str, Any]) -> Dict[str, Any]:
ctx = BaseContext(cli_vars) ctx = BaseContext(cli_vars)

View File

@@ -1,21 +1,19 @@
import os from typing import Any, Dict
from typing import Any, Dict, Optional
from dbt.contracts.connection import AdapterRequiredConfig from dbt.contracts.connection import AdapterRequiredConfig
from dbt.logger import SECRET_ENV_PREFIX
from dbt.node_types import NodeType from dbt.node_types import NodeType
from dbt.utils import MultiDict from dbt.utils import MultiDict
from dbt.context.base import contextproperty, contextmember, Var from dbt.context.base import contextproperty, Var
from dbt.context.target import TargetContext from dbt.context.target import TargetContext
from dbt.exceptions import raise_parsing_error, disallow_secret_env_var
class ConfiguredContext(TargetContext): class ConfiguredContext(TargetContext):
# subclasses are SchemaYamlContext, MacroResolvingContext, ManifestContext
config: AdapterRequiredConfig config: AdapterRequiredConfig
def __init__(self, config: AdapterRequiredConfig) -> None: def __init__(
self, config: AdapterRequiredConfig
) -> None:
super().__init__(config, config.cli_vars) super().__init__(config, config.cli_vars)
@contextproperty @contextproperty
@@ -65,40 +63,16 @@ class ConfiguredVar(Var):
return self.get_missing_var(var_name) return self.get_missing_var(var_name)
class SchemaYamlVars:
def __init__(self):
self.env_vars = {}
self.vars = {}
class SchemaYamlContext(ConfiguredContext): class SchemaYamlContext(ConfiguredContext):
# subclass is DocsRuntimeContext def __init__(self, config, project_name: str):
def __init__(self, config, project_name: str, schema_yaml_vars: Optional[SchemaYamlVars]):
super().__init__(config) super().__init__(config)
self._project_name = project_name self._project_name = project_name
self.schema_yaml_vars = schema_yaml_vars
@contextproperty @contextproperty
def var(self) -> ConfiguredVar: def var(self) -> ConfiguredVar:
return ConfiguredVar(self._ctx, self.config, self._project_name) return ConfiguredVar(
self._ctx, self.config, self._project_name
@contextmember )
def env_var(self, var: str, default: Optional[str] = None) -> str:
return_value = None
if var.startswith(SECRET_ENV_PREFIX):
disallow_secret_env_var(var)
if var in os.environ:
return_value = os.environ[var]
elif default is not None:
return_value = default
if return_value is not None:
if self.schema_yaml_vars:
self.schema_yaml_vars.env_vars[var] = return_value
return return_value
else:
msg = f"Env var required but not provided: '{var}'"
raise_parsing_error(msg)
class MacroResolvingContext(ConfiguredContext): class MacroResolvingContext(ConfiguredContext):
@@ -107,13 +81,15 @@ class MacroResolvingContext(ConfiguredContext):
@contextproperty @contextproperty
def var(self) -> ConfiguredVar: def var(self) -> ConfiguredVar:
return ConfiguredVar(self._ctx, self.config, self.config.project_name) return ConfiguredVar(
self._ctx, self.config, self.config.project_name
)
def generate_schema_yml_context( def generate_schema_yml(
config: AdapterRequiredConfig, project_name: str, schema_yaml_vars: SchemaYamlVars = None config: AdapterRequiredConfig, project_name: str
) -> Dict[str, Any]: ) -> Dict[str, Any]:
ctx = SchemaYamlContext(config, project_name, schema_yaml_vars) ctx = SchemaYamlContext(config, project_name)
return ctx.to_dict() return ctx.to_dict()

View File

@@ -4,7 +4,7 @@ from dataclasses import dataclass
from typing import List, Iterator, Dict, Any, TypeVar, Generic from typing import List, Iterator, Dict, Any, TypeVar, Generic
from dbt.config import RuntimeConfig, Project, IsFQNResource from dbt.config import RuntimeConfig, Project, IsFQNResource
from dbt.contracts.graph.model_config import BaseConfig, get_config_for, _listify from dbt.contracts.graph.model_config import BaseConfig, get_config_for
from dbt.exceptions import InternalException from dbt.exceptions import InternalException
from dbt.node_types import NodeType from dbt.node_types import NodeType
from dbt.utils import fqn_search from dbt.utils import fqn_search
@@ -17,8 +17,8 @@ class ModelParts(IsFQNResource):
package_name: str package_name: str
T = TypeVar("T") # any old type T = TypeVar('T') # any old type
C = TypeVar("C", bound=BaseConfig) C = TypeVar('C', bound=BaseConfig)
class ConfigSource: class ConfigSource:
@@ -36,15 +36,15 @@ class UnrenderedConfig(ConfigSource):
def get_config_dict(self, resource_type: NodeType) -> Dict[str, Any]: def get_config_dict(self, resource_type: NodeType) -> Dict[str, Any]:
unrendered = self.project.unrendered.project_dict unrendered = self.project.unrendered.project_dict
if resource_type == NodeType.Seed: if resource_type == NodeType.Seed:
model_configs = unrendered.get("seeds") model_configs = unrendered.get('seeds')
elif resource_type == NodeType.Snapshot: elif resource_type == NodeType.Snapshot:
model_configs = unrendered.get("snapshots") model_configs = unrendered.get('snapshots')
elif resource_type == NodeType.Source: elif resource_type == NodeType.Source:
model_configs = unrendered.get("sources") model_configs = unrendered.get('sources')
elif resource_type == NodeType.Test: elif resource_type == NodeType.Test:
model_configs = unrendered.get("tests") model_configs = unrendered.get('tests')
else: else:
model_configs = unrendered.get("models") model_configs = unrendered.get('models')
if model_configs is None: if model_configs is None:
return {} return {}
@@ -83,8 +83,8 @@ class BaseContextConfigGenerator(Generic[T]):
dependencies = self._active_project.load_dependencies() dependencies = self._active_project.load_dependencies()
if project_name not in dependencies: if project_name not in dependencies:
raise InternalException( raise InternalException(
f"Project name {project_name} not found in dependencies " f'Project name {project_name} not found in dependencies '
f"(found {list(dependencies)})" f'(found {list(dependencies)})'
) )
return dependencies[project_name] return dependencies[project_name]
@@ -96,7 +96,7 @@ class BaseContextConfigGenerator(Generic[T]):
for level_config in fqn_search(model_configs, fqn): for level_config in fqn_search(model_configs, fqn):
result = {} result = {}
for key, value in level_config.items(): for key, value in level_config.items():
if key.startswith("+"): if key.startswith('+'):
result[key[1:].strip()] = deepcopy(value) result[key[1:].strip()] = deepcopy(value)
elif not isinstance(value, dict): elif not isinstance(value, dict):
result[key] = deepcopy(value) result[key] = deepcopy(value)
@@ -109,7 +109,9 @@ class BaseContextConfigGenerator(Generic[T]):
return self._project_configs(self._active_project, fqn, resource_type) return self._project_configs(self._active_project, fqn, resource_type)
@abstractmethod @abstractmethod
def _update_from_config(self, result: T, partial: Dict[str, Any], validate: bool = False) -> T: def _update_from_config(
self, result: T, partial: Dict[str, Any], validate: bool = False
) -> T:
... ...
@abstractmethod @abstractmethod
@@ -123,7 +125,7 @@ class BaseContextConfigGenerator(Generic[T]):
resource_type: NodeType, resource_type: NodeType,
project_name: str, project_name: str,
base: bool, base: bool,
patch_config_dict: Dict[str, Any] = None, patch_config_dict: Dict[str, Any] = None
) -> BaseConfig: ) -> BaseConfig:
own_config = self.get_node_project(project_name) own_config = self.get_node_project(project_name)
@@ -148,8 +150,7 @@ class BaseContextConfigGenerator(Generic[T]):
result = self._update_from_config(result, fqn_config) result = self._update_from_config(result, fqn_config)
# this is mostly impactful in the snapshot config case # this is mostly impactful in the snapshot config case
# TODO CT-211 return result
return result # type: ignore[return-value]
@abstractmethod @abstractmethod
def calculate_node_config_dict( def calculate_node_config_dict(
@@ -180,10 +181,16 @@ class ContextConfigGenerator(BaseContextConfigGenerator[C]):
result = config_cls.from_dict({}) result = config_cls.from_dict({})
return result return result
def _update_from_config(self, result: C, partial: Dict[str, Any], validate: bool = False) -> C: def _update_from_config(
translated = self._active_project.credentials.translate_aliases(partial) self, result: C, partial: Dict[str, Any], validate: bool = False
) -> C:
translated = self._active_project.credentials.translate_aliases(
partial
)
return result.update_from( return result.update_from(
translated, self._active_project.credentials.type, validate=validate translated,
self._active_project.credentials.type,
validate=validate
) )
def calculate_node_config_dict( def calculate_node_config_dict(
@@ -193,7 +200,7 @@ class ContextConfigGenerator(BaseContextConfigGenerator[C]):
resource_type: NodeType, resource_type: NodeType,
project_name: str, project_name: str,
base: bool, base: bool,
patch_config_dict: dict = None, patch_config_dict: dict = None
) -> Dict[str, Any]: ) -> Dict[str, Any]:
config = self.calculate_node_config( config = self.calculate_node_config(
config_call_dict=config_call_dict, config_call_dict=config_call_dict,
@@ -201,7 +208,7 @@ class ContextConfigGenerator(BaseContextConfigGenerator[C]):
resource_type=resource_type, resource_type=resource_type,
project_name=project_name, project_name=project_name,
base=base, base=base,
patch_config_dict=patch_config_dict, patch_config_dict=patch_config_dict
) )
finalized = config.finalize_and_validate() finalized = config.finalize_and_validate()
return finalized.to_dict(omit_none=True) return finalized.to_dict(omit_none=True)
@@ -218,19 +225,22 @@ class UnrenderedConfigGenerator(BaseContextConfigGenerator[Dict[str, Any]]):
resource_type: NodeType, resource_type: NodeType,
project_name: str, project_name: str,
base: bool, base: bool,
patch_config_dict: dict = None, patch_config_dict: dict = None
) -> Dict[str, Any]: ) -> Dict[str, Any]:
# TODO CT-211
return self.calculate_node_config( return self.calculate_node_config(
config_call_dict=config_call_dict, config_call_dict=config_call_dict,
fqn=fqn, fqn=fqn,
resource_type=resource_type, resource_type=resource_type,
project_name=project_name, project_name=project_name,
base=base, base=base,
patch_config_dict=patch_config_dict, patch_config_dict=patch_config_dict
) # type: ignore[return-value] )
def initial_result(self, resource_type: NodeType, base: bool) -> Dict[str, Any]: def initial_result(
self,
resource_type: NodeType,
base: bool
) -> Dict[str, Any]:
return {} return {}
def _update_from_config( def _update_from_config(
@@ -239,7 +249,9 @@ class UnrenderedConfigGenerator(BaseContextConfigGenerator[Dict[str, Any]]):
partial: Dict[str, Any], partial: Dict[str, Any],
validate: bool = False, validate: bool = False,
) -> Dict[str, Any]: ) -> Dict[str, Any]:
translated = self._active_project.credentials.translate_aliases(partial) translated = self._active_project.credentials.translate_aliases(
partial
)
result.update(translated) result.update(translated)
return result return result
@@ -264,61 +276,32 @@ class ContextConfig:
@classmethod @classmethod
def _add_config_call(cls, config_call_dict, opts: Dict[str, Any]) -> None: def _add_config_call(cls, config_call_dict, opts: Dict[str, Any]) -> None:
# config_call_dict is already encountered configs, opts is new
# This mirrors code in _merge_field_value in model_config.py which is similar but
# operates on config objects.
for k, v in opts.items(): for k, v in opts.items():
# MergeBehavior for post-hook and pre-hook is to collect all # MergeBehavior for post-hook and pre-hook is to collect all
# values, instead of overwriting # values, instead of overwriting
if k in BaseConfig.mergebehavior["append"]: if k in BaseConfig.mergebehavior['append']:
if not isinstance(v, list): if not isinstance(v, list):
v = [v] v = [v]
if k in config_call_dict: # should always be a list here if k in BaseConfig.mergebehavior['update'] and not isinstance(v, dict):
config_call_dict[k].extend(v) raise InternalException(f'expected dict, got {v}')
else: if k in config_call_dict and isinstance(config_call_dict[k], list):
config_call_dict[k] = v config_call_dict[k].extend(v)
elif k in config_call_dict and isinstance(config_call_dict[k], dict):
elif k in BaseConfig.mergebehavior["update"]: config_call_dict[k].update(v)
if not isinstance(v, dict):
raise InternalException(f"expected dict, got {v}")
if k in config_call_dict and isinstance(config_call_dict[k], dict):
config_call_dict[k].update(v)
else:
config_call_dict[k] = v
elif k in BaseConfig.mergebehavior["dict_key_append"]:
if not isinstance(v, dict):
raise InternalException(f"expected dict, got {v}")
if k in config_call_dict: # should always be a dict
for key, value in v.items():
extend = False
# This might start with a +, to indicate we should extend the list
# instead of just clobbering it
if key.startswith("+"):
extend = True
if key in config_call_dict[k] and extend:
# extend the list
config_call_dict[k][key].extend(_listify(value))
else:
# clobber the list
config_call_dict[k][key] = _listify(value)
else:
# This is always a dictionary
config_call_dict[k] = v
# listify everything
for key, value in config_call_dict[k].items():
config_call_dict[k][key] = _listify(value)
else: else:
config_call_dict[k] = v config_call_dict[k] = v
def build_config_dict( def build_config_dict(
self, base: bool = False, *, rendered: bool = True, patch_config_dict: dict = None self,
base: bool = False,
*,
rendered: bool = True,
patch_config_dict: dict = None
) -> Dict[str, Any]: ) -> Dict[str, Any]:
if rendered: if rendered:
# TODO CT-211 src = ContextConfigGenerator(self._active_project)
src = ContextConfigGenerator(self._active_project) # type: ignore[var-annotated]
else: else:
# TODO CT-211 src = UnrenderedConfigGenerator(self._active_project)
src = UnrenderedConfigGenerator(self._active_project) # type: ignore[assignment]
return src.calculate_node_config_dict( return src.calculate_node_config_dict(
config_call_dict=self._config_call_dict, config_call_dict=self._config_call_dict,
@@ -326,5 +309,5 @@ class ContextConfig:
resource_type=self._resource_type, resource_type=self._resource_type,
project_name=self._project_name, project_name=self._project_name,
base=base, base=base,
patch_config_dict=patch_config_dict, patch_config_dict=patch_config_dict
) )

View File

@@ -1,4 +1,6 @@
from typing import Any, Dict, Union from typing import (
Any, Dict, Union
)
from dbt.exceptions import ( from dbt.exceptions import (
doc_invalid_args, doc_invalid_args,
@@ -21,7 +23,7 @@ class DocsRuntimeContext(SchemaYamlContext):
manifest: Manifest, manifest: Manifest,
current_project: str, current_project: str,
) -> None: ) -> None:
super().__init__(config, current_project, None) super().__init__(config, current_project)
self.node = node self.node = node
self.manifest = manifest self.manifest = manifest
@@ -66,15 +68,14 @@ class DocsRuntimeContext(SchemaYamlContext):
file_id = target_doc.file_id file_id = target_doc.file_id
if file_id in self.manifest.files: if file_id in self.manifest.files:
source_file = self.manifest.files[file_id] source_file = self.manifest.files[file_id]
# TODO CT-211 source_file.add_node(self.node.unique_id)
source_file.add_node(self.node.unique_id) # type: ignore[union-attr]
else: else:
doc_target_not_found(self.node, doc_name, doc_package_name) doc_target_not_found(self.node, doc_name, doc_package_name)
return target_doc.block_contents return target_doc.block_contents
def generate_runtime_docs_context( def generate_runtime_docs(
config: RuntimeConfig, config: RuntimeConfig,
target: Any, target: Any,
manifest: Manifest, manifest: Manifest,

View File

@@ -1,4 +1,6 @@
from typing import Dict, MutableMapping, Optional from typing import (
Dict, MutableMapping, Optional
)
from dbt.contracts.graph.parsed import ParsedMacro from dbt.contracts.graph.parsed import ParsedMacro
from dbt.exceptions import raise_duplicate_macro_name, raise_compiler_error from dbt.exceptions import raise_duplicate_macro_name, raise_compiler_error
from dbt.include.global_project import PROJECT_NAME as GLOBAL_PROJECT_NAME from dbt.include.global_project import PROJECT_NAME as GLOBAL_PROJECT_NAME
@@ -47,7 +49,8 @@ class MacroResolver:
for pkg in reversed(self.internal_package_names): for pkg in reversed(self.internal_package_names):
if pkg in self.internal_packages: if pkg in self.internal_packages:
# Turn the internal packages into a flat namespace # Turn the internal packages into a flat namespace
self.internal_packages_namespace.update(self.internal_packages[pkg]) self.internal_packages_namespace.update(
self.internal_packages[pkg])
# search order: # search order:
# local_namespace (package of particular node), not including # local_namespace (package of particular node), not including
@@ -86,7 +89,9 @@ class MacroResolver:
package_namespaces[macro.package_name] = namespace package_namespaces[macro.package_name] = namespace
if macro.name in namespace: if macro.name in namespace:
raise_duplicate_macro_name(macro, macro, macro.package_name) raise_duplicate_macro_name(
macro, macro, macro.package_name
)
package_namespaces[macro.package_name][macro.name] = macro package_namespaces[macro.package_name][macro.name] = macro
def add_macro(self, macro: ParsedMacro): def add_macro(self, macro: ParsedMacro):
@@ -109,7 +114,8 @@ class MacroResolver:
def get_macro(self, local_package, macro_name): def get_macro(self, local_package, macro_name):
local_package_macros = {} local_package_macros = {}
if local_package not in self.internal_package_names and local_package in self.packages: if (local_package not in self.internal_package_names and
local_package in self.packages):
local_package_macros = self.packages[local_package] local_package_macros = self.packages[local_package]
# First: search the local packages for this macro # First: search the local packages for this macro
if macro_name in local_package_macros: if macro_name in local_package_macros:
@@ -134,7 +140,9 @@ class MacroResolver:
# is that you can limit the number of macros provided to the # is that you can limit the number of macros provided to the
# context dictionary in the 'to_dict' manifest method. # context dictionary in the 'to_dict' manifest method.
class TestMacroNamespace: class TestMacroNamespace:
def __init__(self, macro_resolver, ctx, node, thread_ctx, depends_on_macros): def __init__(
self, macro_resolver, ctx, node, thread_ctx, depends_on_macros
):
self.macro_resolver = macro_resolver self.macro_resolver = macro_resolver
self.ctx = ctx self.ctx = ctx
self.node = node # can be none self.node = node # can be none
@@ -147,14 +155,11 @@ class TestMacroNamespace:
for macro_unique_id in dep_macros: for macro_unique_id in dep_macros:
if macro_unique_id in self.macro_resolver.macros: if macro_unique_id in self.macro_resolver.macros:
# Split up the macro unique_id to get the project_name # Split up the macro unique_id to get the project_name
(_, project_name, macro_name) = macro_unique_id.split(".") (_, project_name, macro_name) = macro_unique_id.split('.')
# Save the plain macro_name in the local_namespace # Save the plain macro_name in the local_namespace
macro = self.macro_resolver.macros[macro_unique_id] macro = self.macro_resolver.macros[macro_unique_id]
macro_gen = MacroGenerator( macro_gen = MacroGenerator(
macro, macro, self.ctx, self.node, self.thread_ctx,
self.ctx,
self.node,
self.thread_ctx,
) )
self.local_namespace[macro_name] = macro_gen self.local_namespace[macro_name] = macro_gen
# We also need the two part macro name # We also need the two part macro name
@@ -172,7 +177,9 @@ class TestMacroNamespace:
if macro.depends_on.macros: if macro.depends_on.macros:
self.recursively_get_depends_on_macros(macro.depends_on.macros, dep_macros) self.recursively_get_depends_on_macros(macro.depends_on.macros, dep_macros)
def get_from_package(self, package_name: Optional[str], name: str) -> Optional[MacroGenerator]: def get_from_package(
self, package_name: Optional[str], name: str
) -> Optional[MacroGenerator]:
macro = None macro = None
if package_name is None: if package_name is None:
macro = self.macro_resolver.macros_by_name.get(name) macro = self.macro_resolver.macros_by_name.get(name)
@@ -181,8 +188,12 @@ class TestMacroNamespace:
elif package_name in self.macro_resolver.packages: elif package_name in self.macro_resolver.packages:
macro = self.macro_resolver.packages[package_name].get(name) macro = self.macro_resolver.packages[package_name].get(name)
else: else:
raise_compiler_error(f"Could not find package '{package_name}'") raise_compiler_error(
f"Could not find package '{package_name}'"
)
if not macro: if not macro:
return None return None
macro_func = MacroGenerator(macro, self.ctx, self.node, self.thread_ctx) macro_func = MacroGenerator(
macro, self.ctx, self.node, self.thread_ctx
)
return macro_func return macro_func

View File

@@ -1,9 +1,13 @@
from typing import Any, Dict, Iterable, Union, Optional, List, Iterator, Mapping, Set from typing import (
Any, Dict, Iterable, Union, Optional, List, Iterator, Mapping, Set
)
from dbt.clients.jinja import MacroGenerator, MacroStack from dbt.clients.jinja import MacroGenerator, MacroStack
from dbt.contracts.graph.parsed import ParsedMacro from dbt.contracts.graph.parsed import ParsedMacro
from dbt.include.global_project import PROJECT_NAME as GLOBAL_PROJECT_NAME from dbt.include.global_project import PROJECT_NAME as GLOBAL_PROJECT_NAME
from dbt.exceptions import raise_duplicate_macro_name, raise_compiler_error from dbt.exceptions import (
raise_duplicate_macro_name, raise_compiler_error
)
FlatNamespace = Dict[str, MacroGenerator] FlatNamespace = Dict[str, MacroGenerator]
@@ -23,7 +27,7 @@ class MacroNamespace(Mapping):
def __init__( def __init__(
self, self,
global_namespace: FlatNamespace, # root package macros global_namespace: FlatNamespace, # root package macros
local_namespace: FlatNamespace, # packages for *this* node local_namespace: FlatNamespace, # packages for *this* node
global_project_namespace: FlatNamespace, # internal packages global_project_namespace: FlatNamespace, # internal packages
packages: Dict[str, FlatNamespace], # non-internal packages packages: Dict[str, FlatNamespace], # non-internal packages
): ):
@@ -33,13 +37,11 @@ class MacroNamespace(Mapping):
self.global_project_namespace: FlatNamespace = global_project_namespace self.global_project_namespace: FlatNamespace = global_project_namespace
def _search_order(self) -> Iterable[Union[FullNamespace, FlatNamespace]]: def _search_order(self) -> Iterable[Union[FullNamespace, FlatNamespace]]:
yield self.local_namespace # local package yield self.local_namespace # local package
yield self.global_namespace # root package yield self.global_namespace # root package
# TODO CT-211 yield self.packages # non-internal packages
yield self.packages # type: ignore[misc] # non-internal packages
yield { yield {
# TODO CT-211 GLOBAL_PROJECT_NAME: self.global_project_namespace, # dbt
GLOBAL_PROJECT_NAME: self.global_project_namespace, # type: ignore[misc] # dbt
} }
yield self.global_project_namespace # other internal project besides dbt yield self.global_project_namespace # other internal project besides dbt
@@ -66,7 +68,9 @@ class MacroNamespace(Mapping):
return dct[key] return dct[key]
raise KeyError(key) raise KeyError(key)
def get_from_package(self, package_name: Optional[str], name: str) -> Optional[MacroGenerator]: def get_from_package(
self, package_name: Optional[str], name: str
) -> Optional[MacroGenerator]:
pkg: FlatNamespace pkg: FlatNamespace
if package_name is None: if package_name is None:
return self.get(name) return self.get(name)
@@ -75,7 +79,9 @@ class MacroNamespace(Mapping):
elif package_name in self.packages: elif package_name in self.packages:
return self.packages[package_name].get(name) return self.packages[package_name].get(name)
else: else:
raise_compiler_error(f"Could not find package '{package_name}'") raise_compiler_error(
f"Could not find package '{package_name}'"
)
# This class builds the MacroNamespace by adding macros to # This class builds the MacroNamespace by adding macros to
@@ -122,7 +128,9 @@ class MacroNamespaceBuilder:
hierarchy[macro.package_name] = namespace hierarchy[macro.package_name] = namespace
if macro.name in namespace: if macro.name in namespace:
raise_duplicate_macro_name(macro_func.macro, macro, macro.package_name) raise_duplicate_macro_name(
macro_func.macro, macro, macro.package_name
)
hierarchy[macro.package_name][macro.name] = macro_func hierarchy[macro.package_name][macro.name] = macro_func
def add_macro(self, macro: ParsedMacro, ctx: Dict[str, Any]): def add_macro(self, macro: ParsedMacro, ctx: Dict[str, Any]):
@@ -131,7 +139,9 @@ class MacroNamespaceBuilder:
# MacroGenerator is in clients/jinja.py # MacroGenerator is in clients/jinja.py
# a MacroGenerator object is a callable object that will # a MacroGenerator object is a callable object that will
# execute the MacroGenerator.__call__ function # execute the MacroGenerator.__call__ function
macro_func: MacroGenerator = MacroGenerator(macro, ctx, self.node, self.thread_ctx) macro_func: MacroGenerator = MacroGenerator(
macro, ctx, self.node, self.thread_ctx
)
# internal macros (from plugins) will be processed separately from # internal macros (from plugins) will be processed separately from
# project macros, so store them in a different place # project macros, so store them in a different place

Some files were not shown because too many files have changed in this diff Show More