Add UI-only database configuration method for extended authorization scenarios

[willbarrett]

CATEGORY

Choose one

• Bug Fix
• Enhancement (new features, refinement)
• Refactor
• Add tests
• Build / Development Environment
• Documentation

SUMMARY

Problem statement: currently connections to BigQuery databases cannot be configured without adding code to Superset or adding configuration to its execution environment in the form of Google Cloud account credentials.

Solution proposed: Add an encrypted field on the dbs table to hold extended connection information. This field can hold JSON configuration including secrets and add that information on to the database connection object during instantiation. This allows us to configure a service account in Google Cloud and connect to a BigQuery dataset without any code or configuration changes in Superset.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TEST PLAN

• Create a dataset in BigQuery in Google Cloud
• Create a service account in Google Cloud with access to the dataset
• Download the service account's identity file in JSON format
• Open the Add Database screen in Superset
• Fill in the SqlAlchemy URL with bigquery://project-name where project-name is the name of the Google Cloud project that your BigQuery dataset is associated with.
• Add JSON to the Secure Extra field with the following structure:

{
    "credentials_info": <content from the identity file from Google Cloud>
}

• Click "Test Connection" - It should say the connection is OK.

ADDITIONAL INFORMATION

• Has associated issue:
• Changes UI
• Requires DB Migration.
• Confirm DB Migration upgrade and downgrade tested.
• Introduces new feature or API
• Removes existing feature or API

REVIEWERS

@mistercrunch @dpgaspar

[mistercrunch]

I just confirmed that this doesn't show in show_columns

[villebro]

This is a very nice feature 👍 One small nit, other than that LGTM.

[codecov-io]

Codecov Report

Merging #8448 into master will decrease coverage by 1.03%.
The diff coverage is 52.63%.

@@            Coverage Diff             @@
##           master    #8448      +/-   ##
==========================================
- Coverage   67.61%   66.57%   -1.04%     
==========================================
  Files         448      448              
  Lines       22486    22509      +23     
  Branches     2364     2364              
==========================================
- Hits        15204    14986     -218     
- Misses       7144     7385     +241     
  Partials      138      138

Impacted Files	Coverage Δ
superset/models/core.py	81.46% <50%> (-0.47%)	⬇️
superset/views/database/__init__.py	78.78% <57.14%> (-1.22%)	⬇️
superset/db_engine_specs/presto.py	22.43% <0%> (-42.49%)	⬇️
superset/db_engine_specs/pinot.py	43.33% <0%> (-26.67%)	⬇️
superset/db_engine_specs/hive.py	27.85% <0%> (-12.33%)	⬇️
superset/db_engine_specs/mssql.py	58.33% <0%> (-11.12%)	⬇️
superset/db_engine_specs/postgres.py	83.87% <0%> (-9.68%)	⬇️
superset/db_engine_specs/bigquery.py	45.07% <0%> (-8.46%)	⬇️
superset/models/sql_types/presto_sql_types.py	65.51% <0%> (-6.9%)	⬇️
superset/db_engine_specs/base.py	80.73% <0%> (-4.66%)	⬇️
... and 12 more

---

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 a39c24e...9202bd5. Read the comment docs.