Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proper handling of custom conn field values in the AzureDataExplorerHook #18203

Merged
merged 1 commit into from
Sep 18, 2021
Merged

Proper handling of custom conn field values in the AzureDataExplorerHook #18203

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 28 additions & 51 deletions airflow/providers/microsoft/azure/hooks/adx.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,47 +32,31 @@ class AzureDataExplorerHook(BaseHook):
"""
Interacts with Azure Data Explorer (Kusto).

Extra JSON field contains the following parameters:

.. code-block:: json

{
"tenant": "<Tenant ID>",
"auth_method": "<Authentication method>",
"certificate": "<Application PEM certificate>",
"thumbprint": "<Application certificate thumbprint>"
}

**Cluster**:

Azure Data Explorer cluster is specified by a URL, for example: "https://help.kusto.windows.net".
The parameter must be provided through `Host` connection detail.
The parameter must be provided through the Data Explorer Cluster URL connection detail.

**Tenant ID**:

To learn about tenants refer to: https://docs.microsoft.com/en-us/onedrive/find-your-office-365-tenant-id

**Authentication methods**:

Authentication method must be provided through "auth_method" extra parameter.
Available authentication methods are:

- AAD_APP: Authentication with AAD application certificate. Extra parameters:
"tenant" is required when using this method. Provide application ID
and application key through username and password parameters.
- AAD_APP: Authentication with AAD application certificate. A Tenant ID is required when using this
method. Provide application ID and application key through Username and Password parameters.

- AAD_APP_CERT: Authentication with AAD application certificate. Extra parameters:
"tenant", "certificate" and "thumbprint" are required
when using this method.
- AAD_APP_CERT: Authentication with AAD application certificate. Tenant ID, Application PEM Certificate,
and Application Certificate Thumbprint are required when using this method.

- AAD_CREDS: Authentication with AAD username and password. Extra parameters:
"tenant" is required when using this method. Username and password
parameters are used for authentication with AAD.
- AAD_CREDS: Authentication with AAD username and password. A Tenant ID is required when using this
method. Username and Password parameters are used for authentication with AAD.

- AAD_DEVICE: Authenticate with AAD device code. Please note that if you choose
this option, you'll need to authenticate for every new instance
that is initialized. It is highly recommended to create one instance
and use it for all queries.
- AAD_DEVICE: Authenticate with AAD device code. Please note that if you choose this option, you'll need
to authenticate for every new instance that is initialized. It is highly recommended to create one
instance and use it for all queries.

:param azure_data_explorer_conn_id: Reference to the
:ref:`Azure Data Explorer connection<howto/connection:adx>`.
Expand All @@ -92,10 +76,10 @@ def get_connection_form_widgets() -> Dict[str, Any]:
from wtforms import PasswordField, StringField

return {
"extra__azure_data_explorer__auth_method": StringField(
"extra__azure_data_explorer__tenant": StringField(
lazy_gettext('Tenant ID'), widget=BS3TextFieldWidget()
),
"extra__azure_data_explorer__tenant": StringField(
"extra__azure_data_explorer__auth_method": StringField(
lazy_gettext('Authentication Method'), widget=BS3TextFieldWidget()
),
"extra__azure_data_explorer__certificate": PasswordField(
Expand All @@ -112,18 +96,17 @@ def get_ui_field_behaviour() -> Dict:
return {
"hidden_fields": ['schema', 'port', 'extra'],
"relabeling": {
'login': 'Auth Username',
'password': 'Auth Password',
'host': 'Data Explorer Cluster Url',
'login': 'Username',
'password': 'Password',
'host': 'Data Explorer Cluster URL',
},
"placeholders": {
'login': 'varies with authentication method',
'password': 'varies with authentication method',
'host': 'cluster url',
'login': 'Varies with authentication method',
'password': 'Varies with authentication method',
'extra__azure_data_explorer__auth_method': 'AAD_APP/AAD_APP_CERT/AAD_CREDS/AAD_DEVICE',
'extra__azure_data_explorer__tenant': 'used with AAD_APP/AAD_APP_CERT/AAD_CREDS',
'extra__azure_data_explorer__certificate': 'used with AAD_APP_CERT',
'extra__azure_data_explorer__thumbprint': 'used with AAD_APP_CERT',
'extra__azure_data_explorer__tenant': 'Used with AAD_APP/AAD_APP_CERT/AAD_CREDS',
'extra__azure_data_explorer__certificate': 'Used with AAD_APP_CERT',
'extra__azure_data_explorer__thumbprint': 'Used with AAD_APP_CERT',
},
}

Expand All @@ -140,29 +123,23 @@ def get_conn(self) -> KustoClient:
raise AirflowException('Host connection option is required')

def get_required_param(name: str) -> str:
"""Extract required parameter from extra JSON, raise exception if not found"""
"""Extract required parameter value from connection, raise exception if not found"""
value = conn.extra_dejson.get(name)
if not value:
raise AirflowException(f'Extra connection option is missing required parameter: `{name}`')
raise AirflowException(f'Required connection parameter is missing: `{name}`')
return value

auth_method = get_required_param('auth_method') or get_required_param(
'extra__azure_data_explorer__auth_method'
)
auth_method = get_required_param('extra__azure_data_explorer__auth_method')

if auth_method == 'AAD_APP':
tenant = get_required_param('tenant') or get_required_param('extra__azure_data_explorer__tenant')
tenant = get_required_param('extra__azure_data_explorer__tenant')
kcsb = KustoConnectionStringBuilder.with_aad_application_key_authentication(
cluster, conn.login, conn.password, tenant
)
elif auth_method == 'AAD_APP_CERT':
certificate = get_required_param('certificate') or get_required_param(
'extra__azure_data_explorer__certificate'
)
thumbprint = get_required_param('thumbprint') or get_required_param(
'extra__azure_data_explorer__thumbprint'
)
tenant = get_required_param('tenant') or get_required_param('extra__azure_data_explorer__tenant')
certificate = get_required_param('extra__azure_data_explorer__certificate')
thumbprint = get_required_param('extra__azure_data_explorer__thumbprint')
tenant = get_required_param('extra__azure_data_explorer__tenant')
kcsb = KustoConnectionStringBuilder.with_aad_application_certificate_authentication(
cluster,
conn.login,
Expand All @@ -171,7 +148,7 @@ def get_required_param(name: str) -> str:
tenant,
)
elif auth_method == 'AAD_CREDS':
tenant = get_required_param('tenant') or get_required_param('extra__azure_data_explorer__tenant')
tenant = get_required_param('extra__azure_data_explorer__tenant')
kcsb = KustoConnectionStringBuilder.with_aad_user_password_authentication(
cluster, conn.login, conn.password, tenant
)
Expand Down
30 changes: 20 additions & 10 deletions tests/providers/microsoft/azure/hooks/test_adx.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ def test_conn_missing_method(self):
)
with pytest.raises(AirflowException) as ctx:
AzureDataExplorerHook(azure_data_explorer_conn_id=ADX_TEST_CONN_ID)
assert 'missing required parameter: `auth_method`' in str(ctx.value)
assert 'is missing: `extra__azure_data_explorer__auth_method`' in str(ctx.value)

def test_conn_unknown_method(self):
db.merge_conn(
Expand All @@ -62,7 +62,7 @@ def test_conn_unknown_method(self):
login='client_id',
password='client secret',
host='https://help.kusto.windows.net',
extra=json.dumps({'auth_method': 'AAD_OTHER'}),
extra=json.dumps({'extra__azure_data_explorer__auth_method': 'AAD_OTHER'}),
)
)
with pytest.raises(AirflowException) as ctx:
Expand Down Expand Up @@ -93,7 +93,12 @@ def test_conn_method_aad_creds(self, mock_init):
login='client_id',
password='client secret',
host='https://help.kusto.windows.net',
extra=json.dumps({'tenant': 'tenant', 'auth_method': 'AAD_CREDS'}),
extra=json.dumps(
{
'extra__azure_data_explorer__tenant': 'tenant',
'extra__azure_data_explorer__auth_method': 'AAD_CREDS',
}
),
)
)
AzureDataExplorerHook(azure_data_explorer_conn_id=ADX_TEST_CONN_ID)
Expand All @@ -113,7 +118,12 @@ def test_conn_method_aad_app(self, mock_init):
login='app_id',
password='app key',
host='https://help.kusto.windows.net',
extra=json.dumps({'tenant': 'tenant', 'auth_method': 'AAD_APP'}),
extra=json.dumps(
{
'extra__azure_data_explorer__tenant': 'tenant',
'extra__azure_data_explorer__auth_method': 'AAD_APP',
}
),
)
)
AzureDataExplorerHook(azure_data_explorer_conn_id=ADX_TEST_CONN_ID)
Expand All @@ -134,10 +144,10 @@ def test_conn_method_aad_app_cert(self, mock_init):
host='https://help.kusto.windows.net',
extra=json.dumps(
{
'tenant': 'tenant',
'auth_method': 'AAD_APP_CERT',
'certificate': 'PEM',
'thumbprint': 'thumbprint',
'extra__azure_data_explorer__tenant': 'tenant',
'extra__azure_data_explorer__auth_method': 'AAD_APP_CERT',
'extra__azure_data_explorer__certificate': 'PEM',
'extra__azure_data_explorer__thumbprint': 'thumbprint',
}
),
)
Expand All @@ -157,7 +167,7 @@ def test_conn_method_aad_device(self, mock_init):
conn_id=ADX_TEST_CONN_ID,
conn_type='azure_data_explorer',
host='https://help.kusto.windows.net',
extra=json.dumps({'auth_method': 'AAD_DEVICE'}),
extra=json.dumps({'extra__azure_data_explorer__auth_method': 'AAD_DEVICE'}),
)
)
AzureDataExplorerHook(azure_data_explorer_conn_id=ADX_TEST_CONN_ID)
Expand All @@ -173,7 +183,7 @@ def test_run_query(self, mock_execute):
conn_id=ADX_TEST_CONN_ID,
conn_type='azure_data_explorer',
host='https://help.kusto.windows.net',
extra=json.dumps({'auth_method': 'AAD_DEVICE'}),
extra=json.dumps({'extra__azure_data_explorer__auth_method': 'AAD_DEVICE'}),
)
)
hook = AzureDataExplorerHook(azure_data_explorer_conn_id=ADX_TEST_CONN_ID)
Expand Down