Add private snat get details (#651)

Add private snat get details

Reviewed-by: Anton Sidelnikov

Author: shhovhan

doc/source/sdk/guides/privatenat.rst

@@ -129,3 +129,12 @@ the output with query parameters.
 
 .. literalinclude:: ../examples/natv3/list_private_snat_rules.py
    :lines: 16-23
+
+Get Private SNAT Rule
+^^^^^^^^^^^^^^^^^^^^^
+
+This interface is used to query details about a specified SNAT rule.
+:class:`~otcextensions.sdk.natv3.v3.snat.PrivateSnat`.
+
+.. literalinclude:: ../examples/natv3/get_private_snat_rule.py
+   :lines: 16-22

doc/source/sdk/proxies/privatenat.rst

@@ -16,4 +16,4 @@ Private NAT Gateway Operations
 
 .. autoclass:: otcextensions.sdk.natv3.v3._proxy.Proxy
   :noindex:
-  :members: private_nat_gateways, get_private_nat_gateway, private_dnat_rules, private_snat_rules
+  :members: private_nat_gateways, get_private_nat_gateway, private_dnat_rules, get_private_dnat_rule, private_snat_rules, get_private_snat_rule

examples/natv3/get_private_snat_rule.py

@@ -0,0 +1,23 @@
+#!/usr/bin/env python3
+# 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.
+"""
+Get Private SNAT Rule Details
+"""
+
+import openstack
+
+openstack.enable_logging(True)
+conn = openstack.connect(cloud="otc")
+
+snat_rule = conn.natv3.get_private_snat_rule("snat_rule_id")
+print(snat_rule)

otcextensions/osclient/privatenat/v3/snat.py

@@ -17,11 +17,17 @@
 from osc_lib import utils
 from osc_lib.command import command
 
+from otcextensions.common import sdk_utils
 from otcextensions.i18n import _
 
 LOG = logging.getLogger(__name__)
 
 
+def _get_columns(item):
+    column_map = {}
+    return sdk_utils.get_osc_show_columns_for_sdk_resource(item, column_map)
+
+
 def _get_transit_ip_addresses(rule):
     return ", ".join(
         association.transit_ip_address
@@ -190,3 +196,25 @@ def take_action(self, parsed_args):
                 for s in data
             ),
         )
+
+
+class ShowPrivateSnatRule(command.ShowOne):
+    _description = _("Show private SNAT rule details.")
+
+    def get_parser(self, prog_name):
+        parser = super(ShowPrivateSnatRule, self).get_parser(prog_name)
+        parser.add_argument(
+            "snat_rule",
+            metavar="<snat_rule>",
+            help=_("Specifies the private SNAT rule ID."),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.privatenat
+        obj = client.get_private_snat_rule(parsed_args.snat_rule)
+
+        display_columns, columns = _get_columns(obj)
+        data = utils.get_item_properties(obj, columns)
+
+        return display_columns, data

otcextensions/sdk/natv3/v3/_proxy.py

@@ -179,3 +179,15 @@ def private_snat_rules(self, **query):
             :class:`~otcextensions.sdk.natv3.v3.snat.PrivateSnat`
         """
         return self._list(_snat.PrivateSnat, **query)
+
+    def get_private_snat_rule(self, snat_rule):
+        """Get a single private SNAT rule.
+
+        :param snat_rule: The value can be the ID of a private SNAT rule.
+
+        :returns: One :class:`~otcextensions.sdk.natv3.v3.snat.PrivateSnat`
+
+        :raises: :class:`~openstack.exceptions.ResourceNotFound`
+            when no resource can be found.
+        """
+        return self._get(_snat.PrivateSnat, snat_rule)

otcextensions/sdk/natv3/v3/snat.py

@@ -27,6 +27,7 @@ class PrivateSnat(resource.Resource):
     base_path = "/private-nat/snat-rules"
 
     # capabilities
+    allow_fetch = True
     allow_list = True
 
     _query_mapping = resource.QueryParameters(

otcextensions/tests/functional/osclient/privatenat/v3/test_private_snat.py

@@ -24,3 +24,15 @@ def setUp(self):
     def test_privatenat_snat_rule_list(self):
         json_output = json.loads(self.openstack("privatenat snat rule list -f json "))
         self.assertIsNotNone(json_output)
+
+    def test_privatenat_snat_rule_show(self):
+        json_output = json.loads(self.openstack("privatenat snat rule list -f json "))
+        if not json_output:
+            self.skipTest("No private SNAT rules available for show test")
+
+        snat_rule_id = json_output[0]["id"]
+        json_output = json.loads(
+            self.openstack("privatenat snat rule show -f json " + snat_rule_id)
+        )
+        self.assertIsNotNone(json_output)
+        self.assertEqual(json_output["id"], snat_rule_id)

otcextensions/tests/functional/sdk/natv3/v3/test_private_snat.py

@@ -21,3 +21,11 @@ class TestPrivateSnat(base.BaseFunctionalTest):
     def test_list_snat_rules(self):
         snat_rules = list(self.conn.natv3.private_snat_rules())
         self.assertGreaterEqual(len(snat_rules), 0)
+
+    def test_get_private_snat_rule(self):
+        snat_rules = list(self.conn.natv3.private_snat_rules(limit=1))
+        if not snat_rules:
+            self.skipTest("No private SNAT rules available for fetch test")
+
+        snat_rule = self.conn.natv3.get_private_snat_rule(snat_rules[0].id)
+        self.assertEqual(snat_rule.id, snat_rules[0].id)

otcextensions/tests/unit/osclient/privatenat/v3/test_snat.py

@@ -128,3 +128,41 @@ def test_list_with_supported_filters(self):
         )
         self.assertEqual(self.columns, columns)
         self.assertEqual(self.data, list(data))
+
+
+class TestShowPrivateSnatRule(fakes.TestPrivateNat):
+    _data = fakes.FakePrivateSnatRule.create_one()
+
+    columns = (
+        "cidr",
+        "created_at",
+        "description",
+        "enterprise_project_id",
+        "gateway_id",
+        "id",
+        "project_id",
+        "status",
+        "transit_ip_associations",
+        "updated_at",
+        "virsubnet_id",
+    )
+
+    data = fakes.gen_data(_data, columns)
+
+    def setUp(self):
+        super(TestShowPrivateSnatRule, self).setUp()
+
+        self.cmd = snat.ShowPrivateSnatRule(self.app, None)
+        self.client.get_private_snat_rule = mock.Mock(return_value=self._data)
+
+    def test_show(self):
+        arglist = [self._data.id]
+        verifylist = [("snat_rule", self._data.id)]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+        columns, data = self.cmd.take_action(parsed_args)
+
+        self.client.get_private_snat_rule.assert_called_once_with(self._data.id)
+        self.assertEqual(tuple(sorted(self.columns)), tuple(sorted(columns)))
+        self.assertEqual(len(self.data), len(data))
+        self.assertIn(self._data.id, data)

otcextensions/tests/unit/sdk/natv3/v3/test_proxy.py

@@ -69,3 +69,6 @@ class TestPrivateSnat(TestNatv3Proxy):
 
     def test_private_snat_rules(self):
         self.verify_list(self.proxy.private_snat_rules, snat.PrivateSnat)
+
+    def test_get_private_snat_rule(self):
+        self.verify_get(self.proxy.get_private_snat_rule, snat.PrivateSnat)