Issue #538 - Adding the dig DNS utility

Updated Files for Dig
f5/bigip/tm/util/__init__.py

Added Files for Dig
f5/bigip/tm/util/Dig.py
f5/bigip/tm/util/test/test_dig.py
test/functional/tm/util/test_dig.py

Updated Files for Bash (typo fixes from previous PR)
f5/bigip/tm/util/Bash.py
test/functional/tm/util/test_bash.py

Author: f5-rahm

f5/bigip/tm/util/Bash.py

@@ -36,7 +36,7 @@ class Bash(UnnamedResource, CommandExecutionMixin):
 
     .. note::
 
-        This is an unnamed resource so it has not ~Partition~Name pattern
+        This is an unnamed resource so it has no ~Partition~Name pattern
         at the end of its URI.
     """
 

f5/bigip/tm/util/Dig.py

@@ -0,0 +1,66 @@
+# coding=utf-8
+#
+# Copyright 2016 F5 Networks Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+"""BIG-IP® utility module
+
+REST URI
+    ``http://localhost/mgmt/tm/util/dig``
+
+GUI Path
+    N/A
+
+REST Kind
+    ``tm:util:dig:*``
+"""
+
+from f5.bigip.mixins import CommandExecutionMixin
+from f5.bigip.resource import UnnamedResource
+from f5.utils.util_exceptions import UtilError
+
+
+class Dig(UnnamedResource, CommandExecutionMixin):
+    """BIG-IP® utility command
+
+    .. note::
+
+        This is an unnamed resource so it has no ~Partition~Name pattern
+        at the end of its URI.
+    """
+
+    def __init__(self, util):
+        super(Dig, self).__init__(util)
+        self._meta_data['required_command_parameters'].update(('utilCmdArgs',))
+        self._meta_data['required_json_kind'] = 'tm:util:dig:runstate'
+        self._meta_data['allowed_commands'].append('run')
+
+    def _exec_cmd(self, command, **kwargs):
+        kwargs['command'] = command
+        self._check_exclusive_parameters(**kwargs)
+        requests_params = self._handle_requests_params(kwargs)
+        self._check_command_parameters(**kwargs)
+
+        session = self._meta_data['bigip']._meta_data['icr_session']
+        response = session.post(
+            self._meta_data['uri'], json=kwargs, **requests_params)
+        self._local_update(response.json())
+
+        if 'commandResult' in self.__dict__:
+            if 'Invalid option' in self.commandResult:
+                raise UtilError('%s' % self.commandResult)
+            else:
+                return self
+        else:
+            return self

f5/bigip/tm/util/__init__.py

@@ -29,6 +29,7 @@
 
 from f5.bigip.resource import PathElement
 from f5.bigip.tm.util.Bash import Bash
+from f5.bigip.tm.util.Dig import Dig
 from f5.bigip.tm.util.Unix_Ls import Unix_Ls
 from f5.bigip.tm.util.Unix_Mv import Unix_Mv
 from f5.bigip.tm.util.Unix_Rm import Unix_Rm
@@ -39,6 +40,7 @@ def __init__(self, bigip):
         super(Util, self).__init__(bigip)
         self._meta_data['allowed_lazy_attributes'] = [
             Bash,
+            Dig,
             Unix_Ls,
             Unix_Mv,
             Unix_Rm

f5/bigip/tm/util/test/test_dig.py

@@ -0,0 +1,46 @@
+# Copyright 2016 F5 Networks Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+import mock
+import pytest
+
+from f5.bigip import ManagementRoot
+from f5.bigip.tm.util.Dig import Dig
+
+
+@pytest.fixture
+def FakeDig():
+    fake_sys = mock.MagicMock()
+    fake_dig = Dig(fake_sys)
+    return fake_dig
+
+
+@pytest.fixture
+def FakeiControl(fakeicontrolsession):
+    mr = ManagementRoot('host', 'fake_admin', 'fake_admin')
+    mock_session = mock.MagicMock()
+    mock_session.post.return_value.json.return_value = {}
+    mr._meta_data['icr_session'] = mock_session
+    return mr.tm.util.dig
+
+
+class TestDigCommand(object):
+    def test_command_dig(self, FakeiControl):
+        FakeiControl.exec_cmd('run', utilCmdArgs='f5.com NS')
+        session = FakeiControl._meta_data['bigip']._meta_data['icr_session']
+        assert session.post.call_args == mock.call(
+            'https://host:443/mgmt/tm/util/dig/',
+            json={'utilCmdArgs': 'f5.com NS', 'command': 'run'}
+        )

test/functional/tm/util/test_bash.py

@@ -39,7 +39,7 @@ def test_E_bash(mgmt_root):
         'run',
         utilCmdArgs='-c df -k')
 
-    # commandResult should b present with data from 'df -k'
+    # commandResult should be present with data from 'df -k'
     assert 'commandResult' in bash2.__dict__
 
     # UtilError should be raised if -c is not specified

test/functional/tm/util/test_dig.py

@@ -0,0 +1,45 @@
+
+# Copyright 2016 F5 Networks Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+import pytest
+
+from f5.bigip.resource import MissingRequiredCommandParameter
+from f5.utils.util_exceptions import UtilError
+from icontrol.session import iControlUnexpectedHTTPError
+
+
+def test_E_dig(mgmt_root):
+
+    with pytest.raises(MissingRequiredCommandParameter) as err:
+        mgmt_root.tm.util.dig.exec_cmd('run')
+        assert "Missing required params: ['utilCmdArgs']" in err.response.text
+
+    dig1 = mgmt_root.tm.util.dig.exec_cmd('run', utilCmdArgs='f5.com NS')
+
+    # commandResult should be present with data from 'f5.com NS'
+    assert 'commandResult' in dig1.__dict__
+    assert 'DiG' in dig1.commandResult
+
+    # UtilError should be raised if there is an invalid option for dig
+    with pytest.raises(UtilError) as err:
+        mgmt_root.tm.util.dig.exec_cmd('run', utilCmdArgs='-9 f5.com NS')
+        assert 'Invalid option' in err.response.text
+
+    # iControlUnexpectedHTTPError should be raised if quotes don't match
+    with pytest.raises(iControlUnexpectedHTTPError) as err:
+        mgmt_root.tm.util.dig.exec_cmd('run', utilCmdArgs='"')
+        assert err.response.status_code == 400
+        assert 'quotes are not balanced' in err.response.text