feat: bootstrap task

[bastienboutonnet]

Description

Adds a new command called bootstrap which allows dbt users to generate placeholders for all models as well as their columns in a dbt project.

This command can be ran before doing an audit to generate placeholders for all models so that the results of the audit task (which relies solely on content present in schema.yml files) are exhaustive and accurate.

How was the change tested

Issue Information

Partially addresses #210

Checklist

• I formatted my PR name according to CONTRIBUTING.md
• I added a news fragment to help populating the changelog as encouraged in CONTRIBUTING.md
• I added "Closes #<issue_number>" in the "Issue Information" section (if no issue, feel free to tick thick the box anyway).

[codecov]

Codecov Report

Merging #233 (e591a6f) into dev/0.1.0 (eb73c4d) will increase coverage by 0.02%.
The diff coverage is 88.15%.

@@              Coverage Diff              @@
##           dev/0.1.0     #233      +/-   ##
=============================================
+ Coverage      82.83%   82.86%   +0.02%     
=============================================
  Files             18       19       +1     
  Lines           1101     1167      +66     
=============================================
+ Hits             912      967      +55     
- Misses           189      200      +11     

Flag	Coverage Δ
unittests	82.86% <88.15%> (+0.02%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
dbt_sugar/core/main.py	73.11% <57.14%> (-1.60%)	⬇️
dbt_sugar/core/task/bootstrap.py	89.13% <89.13%> (ø)
dbt_sugar/core/task/base.py	82.72% <92.30%> (-2.28%)	⬇️
dbt_sugar/core/connectors/base.py	95.00% <100.00%> (ø)
dbt_sugar/core/connectors/snowflake_connector.py	52.63% <100.00%> (ø)
dbt_sugar/core/task/audit.py	69.23% <100.00%> (+0.23%)	⬆️
dbt_sugar/core/task/doc.py	66.85% <100.00%> (+2.08%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update eb73c4d...e591a6f. Read the comment docs.

[virvirlopez]

what is this argument **kwargs
is missing in the documentation

[bastienboutonnet]

It's for the snowflake connector which may need to get the argument for use_describe. How would you document it?

[virvirlopez]

LGTM

[sourcery-ai]

Sourcery Code Quality Report

❌  Merging this PR will decrease code quality in the affected files by 0.55%.

Quality metrics	Before	After	Change
Complexity	4.09 ⭐	4.06 ⭐	-0.03 👍
Method Length	68.04 🙂	69.54 🙂	1.50 👎
Working memory	10.89 😞	11.10 😞	0.21 👎
Quality	67.99% 🙂	67.44% 🙂	-0.55% 👎

Other metrics	Before	After	Change
Lines	2793	2882	89

Changed files	Quality Before	Quality After	Quality Change
dbt_sugar/core/main.py	62.91% 🙂	60.46% 🙂	-2.45% 👎
dbt_sugar/core/connectors/base.py	83.67% ⭐	83.67% ⭐	0.00%
dbt_sugar/core/connectors/snowflake_connector.py	73.25% 🙂	73.25% 🙂	0.00%
dbt_sugar/core/task/audit.py	74.73% 🙂	74.55% 🙂	-0.18% 👎
dbt_sugar/core/task/base.py	67.22% 🙂	67.73% 🙂	0.51% 👍
dbt_sugar/core/task/doc.py	66.44% 🙂	66.31% 🙂	-0.13% 👎
tests/audit_task_test.py	63.65% 🙂	60.84% 🙂	-2.81% 👎
tests/base_task_test.py	80.38% ⭐	73.69% 🙂	-6.69% 👎
tests/doc_task_test.py	64.96% 🙂	64.93% 🙂	-0.03% 👎

Here are some functions in these files that still need a tune-up:

File	Function	Complexity	Length	Working Memory	Quality	Recommendation
dbt_sugar/core/task/base.py	BaseTask.find_model_schema_file	25 😞	138 😞	16 ⛔	34.07% 😞	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
tests/doc_task_test.py	test_order_schema_yml	0 ⭐	417 ⛔	34 ⛔	34.92% 😞	Try splitting into smaller methods. Extract out complex expressions
dbt_sugar/core/task/base.py	BaseTask.update_model_description_test_tags	25 😞	116 🙂	12 😞	42.09% 😞	Refactor to reduce nesting. Extract out complex expressions
tests/audit_task_test.py	test_get_model_column_description_coverage	0 ⭐	130 😞	36 ⛔	49.10% 😞	Try splitting into smaller methods. Extract out complex expressions
tests/doc_task_test.py	test_column_has_primary_key_tests	0 ⭐	140 😞	26 ⛔	49.25% 😞	Try splitting into smaller methods. Extract out complex expressions

Legend and Explanation

The emojis denote the absolute quality of the code:

• ⭐ excellent
• 🙂 good
• 😞 poor
• ⛔ very poor

The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request.

---

Please see our documentation here for details on how these metrics are calculated.

We are actively working on this report - lots more documentation and extra metrics to come!

Let us know what you think of it by mentioning @sourcery-ai in a comment.