openstack
/
openstacksdk
Code Issues Proposed changes

network: Rename ikepolicy module 

Add an underscore, as is typical for our module names.

Change-Id: I174b90ec41fdbd3bedb1c96198bc23d4ce595659
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
This commit is contained in:
Stephen Finucane 2022-09-16 15:36:14 +01:00 committed by EunYoung Kim
parent e55a6472cf
commit 83153457c3
9 changed files with 89 additions and 88 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/user/proxies/network.rst
View File

@ -253,8 +253,8 @@ VPNaaS Operations
create_vpn_ipsec_site_connection, update_vpn_ipsec_site_connection,
delete_vpn_ipsec_site_connection, get_vpn_ipsec_site_connection,
find_vpn_ipsec_site_connection, vpn_ipsec_site_connections,
create_vpn_ikepolicy, update_vpn_ikepolicy, delete_vpn_ikepolicy,
get_vpn_ikepolicy, find_vpn_ikepolicy, vpn_ikepolicies,
create_vpn_ike_policy, update_vpn_ike_policy, delete_vpn_ike_policy,
get_vpn_ike_policy, find_vpn_ike_policy, vpn_ike_policies,
create_vpn_ipsec_policy, update_vpn_ipsec_policy, delete_vpn_ipsec_policy,
get_vpn_ipsec_policy, find_vpn_ipsec_policy, vpn_ipsec_policies

13
doc/source/user/resources/network/v2/vpn/ike_policy.rst Normal file
View File

@ -0,0 +1,13 @@
openstack.network.v2.vpn_ike_policy
===================================
.. automodule:: openstack.network.v2.vpn_ike_policy
The VpnIkePolicy Class
----------------------
The ``VpnIkePolicy`` class inherits from
:class:`~openstack.resource.Resource`.
.. autoclass:: openstack.network.v2.vpn_ike_policy.VpnIkePolicy
:members:

13
doc/source/user/resources/network/v2/vpn/ikepolicy.rst
View File

@ -1,13 +0,0 @@
openstack.network.v2.vpn_ikepolicy
==================================
.. automodule:: openstack.network.v2.vpn_ikepolicy
The VpnIkePolicy Class
----------------------
The ``VpnIkePolicy`` class inherits from
:class:`~openstack.resource.Resource`.
.. autoclass:: openstack.network.v2.vpn_ikepolicy.VpnIkePolicy
:members:

2
doc/source/user/resources/network/v2/vpn/index.rst
View File

@ -6,6 +6,6 @@ VPNaaS Resources
endpoint_group
ipsec_site_connection
ikepolicy
ike_policy
ipsec_policy
service

67
openstack/network/v2/_proxy.py
View File

@ -62,7 +62,7 @@ from openstack.network.v2 import subnet as _subnet
from openstack.network.v2 import subnet_pool as _subnet_pool
from openstack.network.v2 import trunk as _trunk
from openstack.network.v2 import vpn_endpoint_group as _vpn_endpoint_group
from openstack.network.v2 import vpn_ikepolicy as _ikepolicy
from openstack.network.v2 import vpn_ike_policy as _ike_policy
from openstack.network.v2 import vpn_ipsec_policy as _ipsec_policy
from openstack.network.v2 import vpn_ipsec_site_connection as \
_ipsec_site_connection
@ -4581,25 +4581,25 @@ class Proxy(proxy.Proxy):
ipsec_site_connection, ignore_missing=ignore_missing)
# ========== IKEPolicy ==========
def create_vpn_ikepolicy(self, **attrs):
def create_vpn_ike_policy(self, **attrs):
"""Create a new ike policy from attributes
:param dict attrs: Keyword arguments which will be used to create a
:class:`~openstack.network.v2.vpn_ikepolicy.VpnIkePolicy`,
:class:`~openstack.network.v2.vpn_ike_policy.VpnIkePolicy`,
comprised of the properties on the VpnIkePolicy class.
:returns: The results of ike policy creation :rtype:
:class:`~openstack.network.v2.vpn_ikepolicy.VpnIkePolicy`
:class:`~openstack.network.v2.vpn_ike_policy.VpnIkePolicy`
"""
return self._create(
_ikepolicy.VpnIkePolicy, **attrs)
_ike_policy.VpnIkePolicy, **attrs)
def find_vpn_ikepolicy(
def find_vpn_ike_policy(
self, name_or_id, ignore_missing=True, **args
):
"""Find a single ike policy
:param name_or_id: The name or ID of an ike policy.
:param name_or_id: The name or ID of an IKE policy.
:param bool ignore_missing: When set to ``False``
:class:`~openstack.exceptions.ResourceNotFound`
will be raised when the resource does not exist.
@ -4607,59 +4607,60 @@ class Proxy(proxy.Proxy):
attempting to find a nonexistent resource.
:param dict args: Any additional parameters to be passed into
underlying methods such as query filters.
:returns: One :class:`~openstack.network.v2.vpn_ikepolicy.VpnIkePolicy`
or None.
:returns: One
:class:`~openstack.network.v2.vpn_ike_policy.VpnIkePolicy` or None.
"""
return self._find(
_ikepolicy.VpnIkePolicy, name_or_id,
_ike_policy.VpnIkePolicy, name_or_id,
ignore_missing=ignore_missing, **args)
def get_vpn_ikepolicy(self, ikepolicy):
def get_vpn_ike_policy(self, ike_policy):
"""Get a single ike policy
:param ikepolicy: The value can be the ID of an ikepolicy or a
:class:`~openstack.network.v2.vpn_ikepolicy.VpnIkePolicy`
:param ike_policy: The value can be the ID of an IKE policy or a
:class:`~openstack.network.v2.vpn_ike_policy.VpnIkePolicy`
instance.
:returns: One :class:`~openstack.network.v2.vpn_ikepolicy.VpnIkePolicy`
:rtype: :class:`~openstack.network.v2.ikepolicy.VpnIkePolicy`
:returns: One
:class:`~openstack.network.v2.vpn_ike_policy.VpnIkePolicy`
:rtype: :class:`~openstack.network.v2.ike_policy.VpnIkePolicy`
:raises: :class:`~openstack.exceptions.ResourceNotFound` when no
resource can be found.
"""
return self._get(
_ikepolicy.VpnIkePolicy, ikepolicy)
_ike_policy.VpnIkePolicy, ike_policy)
def vpn_ikepolicies(self, **query):
"""Return a generator of ike policy
def vpn_ike_policies(self, **query):
"""Return a generator of IKE policies
:param dict query: Optional query parameters to be sent to limit the
resources being returned.
:returns: A generator of ike policy objects
:rtype: :class:`~openstack.network.v2.vpn_ikepolicy.VpnIkePolicy`
:rtype: :class:`~openstack.network.v2.vpn_ike_policy.VpnIkePolicy`
"""
return self._list(
_ikepolicy.VpnIkePolicy, **query)
return self._list(_ike_policy.VpnIkePolicy, **query)
def update_vpn_ikepolicy(self, ikepolicy, **attrs):
"""Update a ike policy
def update_vpn_ike_policy(self, ike_policy, **attrs):
"""Update an IKE policy
:ikepolicy: Either the id of an ike policy or a
:class:`~openstack.network.v2.vpn_ikepolicy.VpnIkePolicy` instance.
:ike_policy: Either the IK of an IKE policy or a
:class:`~openstack.network.v2.vpn_ike_policy.VpnIkePolicy`
instance.
:param dict attrs: The attributes to update on the ike policy
represented by ``ikepolicy``.
represented by ``ike_policy``.
:returns: The updated ike policy
:rtype: :class:`~openstack.network.v2.vpn_ikepolicy.VpnIkePolicy`
:rtype: :class:`~openstack.network.v2.vpn_ike_policy.VpnIkePolicy`
"""
return self._update(
_ikepolicy.VpnIkePolicy, ikepolicy, **attrs)
_ike_policy.VpnIkePolicy, ike_policy, **attrs)
def delete_vpn_ikepolicy(self, ikepolicy, ignore_missing=True):
"""Delete a ikepolicy
def delete_vpn_ike_policy(self, ike_policy, ignore_missing=True):
"""Delete an IKE policy
:param ikepolicy: The value can be either the ID of an ike policy, or
a :class:`~openstack.network.v2.vpn_ikepolicy.VpnIkePolicy`
:param ike_policy: The value can be either the ID of an ike policy, or
a :class:`~openstack.network.v2.vpn_ike_policy.VpnIkePolicy`
instance.
:param bool ignore_missing:
When set to ``False``
@ -4671,7 +4672,7 @@ class Proxy(proxy.Proxy):
:returns: ``None``
"""
self._delete(
_ikepolicy.VpnIkePolicy, ikepolicy,
_ike_policy.VpnIkePolicy, ike_policy,
ignore_missing=ignore_missing)
# ========== IPSecPolicy ==========

0
openstack/network/v2/vpn_ikepolicy.py → openstack/network/v2/vpn_ike_policy.py
View File

28
openstack/tests/functional/network/v2/test_vpnaas.py
View File

@ -10,7 +10,7 @@
# License for the specific language governing permissions and limitations
# under the License.
from openstack.network.v2 import vpn_ikepolicy
from openstack.network.v2 import vpn_ike_policy
from openstack.tests.functional import base
@ -22,34 +22,34 @@ class TestVpnIkePolicy(base.BaseFunctionalTest):
super(TestVpnIkePolicy, self).setUp()
if not self.conn._has_neutron_extension('vpnaas_v2'):
self.skipTest('vpnaas_v2 service not supported by cloud')
self.IKEPOLICY_NAME = self.getUniqueString('ikepolicy')
self.IKE_POLICY_NAME = self.getUniqueString('ikepolicy')
self.UPDATE_NAME = self.getUniqueString('ikepolicy-updated')
policy = self.conn.network.create_vpn_ikepolicy(
name=self.IKEPOLICY_NAME)
assert isinstance(policy, vpn_ikepolicy.VpnIkePolicy)
self.assertEqual(self.IKEPOLICY_NAME, policy.name)
policy = self.conn.network.create_vpn_ike_policy(
name=self.IKE_POLICY_NAME)
assert isinstance(policy, vpn_ike_policy.VpnIkePolicy)
self.assertEqual(self.IKE_POLICY_NAME, policy.name)
self.ID = policy.id
def tearDown(self):
ikepolicy = self.conn.network.\
delete_vpn_ikepolicy(self.ID, ignore_missing=True)
self.assertIsNone(ikepolicy)
ike_policy = self.conn.network.\
delete_vpn_ike_policy(self.ID, ignore_missing=True)
self.assertIsNone(ike_policy)
super(TestVpnIkePolicy, self).tearDown()
def test_list(self):
policies = [f.name for f in self.conn.network.vpn_ikepolicies()]
self.assertIn(self.IKEPOLICY_NAME, policies)
self.assertIn(self.IKE_POLICY_NAME, policies)
def test_find(self):
policy = self.conn.network.find_vpn_ikepolicy(self.IKEPOLICY_NAME)
policy = self.conn.network.find_vpn_ike_policy(self.IKE_POLICY_NAME)
self.assertEqual(self.ID, policy.id)
def test_get(self):
policy = self.conn.network.get_vpn_ikepolicy(self.ID)
self.assertEqual(self.IKEPOLICY_NAME, policy.name)
policy = self.conn.network.get_vpn_ike_policy(self.ID)
self.assertEqual(self.IKE_POLICY_NAME, policy.name)
self.assertEqual(self.ID, policy.id)
def test_update(self):
policy = self.conn.network.update_vpn_ikepolicy(
policy = self.conn.network.update_vpn_ike_policy(
self.ID, name=self.UPDATE_NAME)
self.assertEqual(self.UPDATE_NAME, policy.name)

44
openstack/tests/unit/network/v2/test_proxy.py
View File

@ -59,7 +59,7 @@ from openstack.network.v2 import service_provider
from openstack.network.v2 import subnet
from openstack.network.v2 import subnet_pool
from openstack.network.v2 import vpn_endpoint_group
from openstack.network.v2 import vpn_ikepolicy
from openstack.network.v2 import vpn_ike_policy
from openstack.network.v2 import vpn_ipsec_policy
from openstack.network.v2 import vpn_ipsec_site_connection
from openstack.network.v2 import vpn_service
@ -1649,40 +1649,40 @@ class TestNetworkVpnSiteConnection(TestNetworkProxy):
class TestNetworkVpnIkePolicy(TestNetworkProxy):
def test_ikepolicy_create_attrs(self):
def test_ike_policy_create_attrs(self):
self.verify_create(
self.proxy.create_vpn_ikepolicy,
vpn_ikepolicy.VpnIkePolicy)
self.proxy.create_vpn_ike_policy,
vpn_ike_policy.VpnIkePolicy)
def test_ikepolicy_delete(self):
def test_ike_policy_delete(self):
self.verify_delete(
self.proxy.delete_vpn_ikepolicy,
vpn_ikepolicy.VpnIkePolicy, False)
self.proxy.delete_vpn_ike_policy,
vpn_ike_policy.VpnIkePolicy, False)
def test_ikepolicy_delete_ignore(self):
def test_ike_policy_delete_ignore(self):
self.verify_delete(
self.proxy.delete_vpn_ikepolicy,
vpn_ikepolicy.VpnIkePolicy, True)
self.proxy.delete_vpn_ike_policy,
vpn_ike_policy.VpnIkePolicy, True)
def test_ikepolicy_find(self):
def test_ike_policy_find(self):
self.verify_find(
self.proxy.find_vpn_ikepolicy,
vpn_ikepolicy.VpnIkePolicy)
self.proxy.find_vpn_ike_policy,
vpn_ike_policy.VpnIkePolicy)
def test_ikepolicy_get(self):
def test_ike_policy_get(self):
self.verify_get(
self.proxy.get_vpn_ikepolicy,
vpn_ikepolicy.VpnIkePolicy)
self.proxy.get_vpn_ike_policy,
vpn_ike_policy.VpnIkePolicy)
def test_ikepolicies(self):
def test_ike_policies(self):
self.verify_list(
self.proxy.vpn_ikepolicies,
vpn_ikepolicy.VpnIkePolicy)
self.proxy.vpn_ike_policies,
vpn_ike_policy.VpnIkePolicy)
def test_ikepolicy_update(self):
def test_ike_policy_update(self):
self.verify_update(
self.proxy.update_vpn_ikepolicy,
vpn_ikepolicy.VpnIkePolicy)
self.proxy.update_vpn_ike_policy,
vpn_ike_policy.VpnIkePolicy)
class TestNetworkVpnIpsecPolicy(TestNetworkProxy):

6
openstack/tests/unit/network/v2/test_vpn_ikepolicy.py
View File

@ -10,7 +10,7 @@
# License for the specific language governing permissions and limitations
# under the License.
from openstack.network.v2 import vpn_ikepolicy
from openstack.network.v2 import vpn_ike_policy
from openstack.tests.unit import base
@ -32,7 +32,7 @@ EXAMPLE = {
class TestVpnIkePolicy(base.TestCase):
def test_basic(self):
sot = vpn_ikepolicy.VpnIkePolicy()
sot = vpn_ike_policy.VpnIkePolicy()
self.assertEqual('ikepolicy', sot.resource_key)
self.assertEqual('ikepolicies', sot.resources_key)
self.assertEqual('/vpn/ikepolicies', sot.base_path)
@ -43,7 +43,7 @@ class TestVpnIkePolicy(base.TestCase):
self.assertTrue(sot.allow_list)
def test_make_it(self):
sot = vpn_ikepolicy.VpnIkePolicy(**EXAMPLE)
sot = vpn_ike_policy.VpnIkePolicy(**EXAMPLE)
self.assertEqual(EXAMPLE['auth_algorithm'], sot.auth_algorithm)
self.assertEqual(EXAMPLE['description'], sot.description)
self.assertEqual(EXAMPLE['encryption_algorithm'],