Add support for extra parameters to samba client

airflow/providers/samba/hooks/samba.py

@@ -36,12 +36,36 @@ def __init__(self, samba_conn_id: str = default_conn_name) -> None:
         self.conn = self.get_connection(samba_conn_id)
 
     def get_conn(self) -> SambaClient:
+        """
+        Return a samba client object.
+
+        You can provide optional parameters in the extra fields of
+        your connection.
+
+        Below is an inexhaustive list of these parameters:
+
+        `logdir`
+          Base directory name for log/debug files.
+
+        `kerberos`
+          Try to authenticate with kerberos.
+
+        `workgroup`
+          Set the SMB domain of the username.
+
+        `netbios_name`
+          This option allows you to override the NetBIOS name that
+          Samba uses for itself.
+
+        For additional details, see `smbclient.SambaClient`.
+        """
         samba = SambaClient(
             server=self.conn.host,
             share=self.conn.schema,
             username=self.conn.login,
             ip=self.conn.host,
             password=self.conn.password,
+            **self.conn.extra_dejson,
         )
         return samba
 

docs/spelling_wordlist.txt

@@ -265,6 +265,7 @@ Naik
 Namenode
 Namespace
 Neo4j
+NetBIOS
 Nextdoor
 Nones
 NotFound
@@ -882,6 +883,7 @@ img
 imgcat
 impyla
 incompliancies
+inexhaustive
 infile
 infoType
 infoTypes

tests/providers/samba/hooks/test_samba.py

@@ -16,31 +16,39 @@
 # specific language governing permissions and limitations
 # under the License.
 
+import json
 import unittest
 from unittest import mock
 from unittest.mock import call
 
 import pytest
-import smbclient
 
 from airflow.exceptions import AirflowException
 from airflow.models import Connection
 from airflow.providers.samba.hooks.samba import SambaHook
 
-connection = Connection(host='ip', schema='share', login='username', password='password')
+connection = Connection(
+    host='ip',
+    schema='share',
+    login='username',
+    password='password',
+    extra=json.dumps({'workgroup': 'workgroup'}),
+)
 
 
 class TestSambaHook(unittest.TestCase):
     def test_get_conn_should_fail_if_conn_id_does_not_exist(self):
         with pytest.raises(AirflowException):
             SambaHook('conn')
 
+    @mock.patch('airflow.providers.samba.hooks.samba.SambaClient')
     @mock.patch('airflow.hooks.base.BaseHook.get_connection')
-    def test_get_conn(self, get_conn_mock):
+    def test_get_conn(self, get_conn_mock, get_client_mock):
         get_conn_mock.return_value = connection
         hook = SambaHook('samba_default')
-
-        assert isinstance(hook.get_conn(), smbclient.SambaClient)
+        conn = hook.get_conn()
+        assert str(get_client_mock.mock_calls[0].workgroup) == "workgroup"
+        assert conn is get_client_mock()
         get_conn_mock.assert_called_once_with('samba_default')
 
     @mock.patch('airflow.providers.samba.hooks.samba.SambaHook.get_conn')