Add get private gateway endpoint (#635)

Add get private gateway endpoint

Reviewed-by: Anton Sidelnikov

Author: shhovhan

AUTHORS

@@ -20,10 +20,12 @@ Reik Keutterling <spielkind@gmail.com>
 Rodion Gyrbu <rodion.gyrbu@t-systems.com>
 RusselSand <48719909+RusselSand@users.noreply.github.com>
 SebastianGode <70581801+SebastianGode@users.noreply.github.com>
+Shushanik Hovhannesyan <shhovhan@gmail.com>
 T. Schreiber <tino.schreiber@t-systems.com>
 Tino Schr <tino.schreiber@t-systems.com>
 Tino Schreiber <Tino.Schreiber@t-systems.com>
 U-EMEA1\A58358743 <A58358743@BE1BT361.emea1.cds.t-internal.com>
+Valeriia Ziukina <48719909+RusselSand@users.noreply.github.com>
 Vineet Pruthi <48789821+vineet-pruthi@users.noreply.github.com>
 Vladimir Hasko <vladimirhasko@gmail.com>
 Vladimir Vshivkov <32225815+enrrou@users.noreply.github.com>

doc/source/sdk/guides/index.rst

@@ -28,6 +28,7 @@ Open Telekom Cloud related User Guides
    modelarts
    nat
    obs
+   privatenat
    rds
    sfsturbo
    smn

doc/source/sdk/guides/privatenat.rst

@@ -0,0 +1,35 @@
+Network Address Translation (NAT)
+=================================
+
+.. contents:: Table of Contents
+   :local:
+
+NAT Gateway
+-----------
+
+The NAT Gateway service provides the network address translation (NAT)
+function for servers, such as Elastic Cloud Servers (ECSs), Bare Metal
+Servers (BMSs), and Workspace desktops, in a Virtual Private Cloud (VPC)
+or servers that connect to a VPC through Direct Connect or Virtual
+Private Network (VPN) in local data centers, allowing these servers to
+share elastic IP addresses (EIPs) to access the Internet or to provide
+services accessible from the Internet.
+
+List Private NAT Gateways
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This interface is used to query Private NAT gateway list and to filter
+the output with query parameters.
+:class:`~otcextensions.sdk.natv3.v3.gateway.Gateway`.
+
+.. literalinclude:: ../examples/natv3/list_private_gateways.py
+   :lines: 16-23
+
+Get Private NAT Gateway
+^^^^^^^^^^^^^^^^^^^^^^^
+
+This interface is used to get a Private NAT gateway by ID
+:class:`~otcextensions.sdk.natv3.v3.gateway.Gateway`.
+
+.. literalinclude:: ../examples/natv3/get_private_gateway.py
+   :lines: 16-24

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
+  :members: private_nat_gateways, get_private_nat_gateway

examples/natv3/get_private_gateway.py

@@ -0,0 +1,24 @@
+#!/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 details of Private NAT Gateway by gateway_id
+"""
+
+import openstack
+
+openstack.enable_logging(True)
+conn = openstack.connect(cloud="otc")
+
+gateway = "gateway_id"
+gateway = conn.natv3.get_private_nat_gateway(gateway)
+print(gateway)

otcextensions/osclient/privatenat/v3/private_nat_gateway.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)
+
+
 class ListPrivateNatGateways(command.Lister):
 
     _description = _("List Private NAT Gateways.")
@@ -149,3 +155,25 @@ def take_action(self, parsed_args):
             self.columns,
             (utils.get_item_properties(s, self.columns) for s in data),
         )
+
+
+class ShowPrivateNatGateway(command.ShowOne):
+    _description = _("Show Private NAT Gateway details")
+
+    def get_parser(self, prog_name):
+        parser = super(ShowPrivateNatGateway, self).get_parser(prog_name)
+        parser.add_argument(
+            "gateway",
+            metavar="<gateway>",
+            help=_("Specifies the private NAT gateway ID."),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.privatenat
+        obj = client.get_private_nat_gateway(parsed_args.gateway)
+
+        display_columns, columns = _get_columns(obj)
+        data = utils.get_item_properties(obj, columns)
+
+        return display_columns, data

otcextensions/sdk/nat/v2/_proxy.py

@@ -58,7 +58,7 @@ def wait_for_gateway(
         wait=300,
         attribute="status",
     ):
-        """Wait for an gateway to be in a particular status.
+        """Wait for a gateway to be in a particular status.
 
         :param gateway:
             The :class:`~otcextensions.sdk.nat.v2.gateway.Gateway`

otcextensions/sdk/natv3/v3/_proxy.py

@@ -30,3 +30,15 @@ def private_nat_gateways(self, **query):
         :returns: A generator of private NAT gateway objects.
         """
         return self._list(_gateway.PrivateNatGateway, **query)
+
+    def get_private_nat_gateway(self, gateway):
+        """Get a single Private Nat gateway
+
+        :param gateway: The value can be the ID of a NAT Gatway
+
+        :returns: One :class:`~otcextensions.sdk.natv3.v3.gateway.PrivateNatGateway`
+
+        :raises: :class:`~openstack.exceptions.ResourceNotFound`
+            when no resource can be found.
+        """
+        return self._get(_gateway.PrivateNatGateway, gateway)

otcextensions/sdk/natv3/v3/gateway.py

@@ -38,6 +38,7 @@ class PrivateNatGateway(resource.Resource):
     base_path = "/private-nat/gateways"
 
     allow_list = True
+    allow_fetch = True
 
     _query_mapping = resource.QueryParameters(
         "description",

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

@@ -11,6 +11,8 @@
 # under the License.
 #
 import mock
+from openstackclient.tests.unit import utils as tests_utils
+from osc_lib import exceptions
 
 from otcextensions.osclient.privatenat.v3 import private_nat_gateway
 from otcextensions.tests.unit.osclient.privatenat.v3 import fakes
@@ -138,3 +140,76 @@ def test_list_args(self):
             virsubnet_id=["s1"],
             enterprise_project_id=["ep1"],
         )
+
+
+class TestGetPrivateNatGateway(fakes.TestPrivateNat):
+
+    _data = fakes.FakePrivateNatGateway.create_one()
+
+    columns = (
+        "id",
+        "name",
+        "spec",
+        "status",
+        "project_id",
+        "enterprise_project_id",
+    )
+
+    data = fakes.gen_data(_data, columns)
+
+    def setUp(self):
+        super(TestGetPrivateNatGateway, self).setUp()
+
+        self.cmd = private_nat_gateway.ShowPrivateNatGateway(self.app, None)
+
+        self.client.get_private_nat_gateway = mock.Mock(return_value=self._data)
+
+    def test_get_no_options(self):
+        arglist = []
+        verifylist = []
+
+        # Testing that a call without the required argument will fail and
+        # throw a "ParserExecption"
+        self.assertRaises(
+            tests_utils.ParserException,
+            self.check_parser,
+            self.cmd,
+            arglist,
+            verifylist,
+        )
+
+    def test_get(self):
+        arglist = [
+            self._data.id,
+        ]
+
+        verifylist = [
+            ("gateway", self._data.id),
+        ]
+
+        # Verify cm is triggered with default parameters
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        # Trigger the action
+        columns, data = self.cmd.take_action(parsed_args)
+        self.client.get_private_nat_gateway.assert_called_with(self._data.id)
+
+        self.assertEqual(tuple(sorted(self.columns)), tuple(sorted(columns)))
+        self.assertEqual(tuple(sorted(self.data)), tuple(sorted(data)))
+
+    def test_get_non_existing(self):
+        arglist = ["unexist_nat_gateway"]
+        verifylist = [("gateway", "unexist_nat_gateway")]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.client.get_private_nat_gateway.side_effect = exceptions.CommandError(
+            "Resource Not Found"
+        )
+
+        with self.assertRaises(exceptions.CommandError):
+            self.cmd.take_action(parsed_args)
+
+        self.client.get_private_nat_gateway.assert_called_once_with(
+            "unexist_nat_gateway"
+        )