[FWaaS] Deprecate --share and --enable options in the Unset commands

This patch deprecates options "--share", "--enable" and "--enable-rule"
from the UnsetFirewall{Group,Policy,Rule} commands.
Options "--no-share", "--disable", "--disable-rule" provided by the
SetFirewall{Group,Policy,Rule} commands  should be used instead.

Change-Id: I4175df7911cb1a024df8aea99e09f2d7d28f9c65
Signed-off-by: Slawek Kaplonski <skaplons@redhat.com>

Author: slawqo

openstackclient/network/v2/fwaas/group.py

@@ -403,11 +403,17 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
             '--share',
             action='store_true',
             help=_(
+                '(Deprecated) Use "firewall group set --no-share" instead. '
                 'Restrict use of the firewall group to the current project'
             ),
         )
         parser.add_argument(
-            '--enable', action='store_true', help=_('Disable firewall group')
+            '--enable',
+            action='store_true',
+            help=_(
+                '(Deprecated) Use "firewall group set --disable" instead. '
+                'Disable firewall group'
+            ),
         )
         return parser
 
@@ -420,8 +426,16 @@ def _get_attrs(
         if parsed_args.egress_firewall_policy:
             attrs['egress_firewall_policy_id'] = None
         if parsed_args.share:
+            LOG.warning(
+                'The --share option is deprecated, please use '
+                '"firewall group set --no-share" instead.'
+            )
             attrs['shared'] = False
         if parsed_args.enable:
+            LOG.warning(
+                'The --enable option is deprecated, please use '
+                '"firewall group set --disable" instead.'
+            )
             attrs['admin_state_up'] = False
         if parsed_args.port:
             old = client.find_firewall_group(

openstackclient/network/v2/fwaas/policy.py

@@ -468,6 +468,7 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
             '--share',
             action='store_true',
             help=_(
+                '(Deprecated) Use "firewall policy set --no-share" instead. '
                 'Restrict use of the firewall policy to the current project'
             ),
         )
@@ -494,6 +495,10 @@ def _get_attrs(
         if parsed_args.audited:
             attrs['audited'] = False
         if parsed_args.share:
+            LOG.warning(
+                'The --share option is deprecated, please use '
+                '"firewall policy set --no-share" instead.'
+            )
             attrs['shared'] = False
         return attrs
 

openstackclient/network/v2/fwaas/rule.py

@@ -501,10 +501,18 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser.add_argument(
             '--share',
             action='store_true',
-            help=_('Restrict use of the firewall rule to the current project'),
+            help=_(
+                '(Deprecated) Use "firewall rule set --no-share" instead. '
+                'Restrict use of the firewall rule to the current project'
+            ),
         )
         parser.add_argument(
-            '--enable-rule', action='store_true', help=_('Disable this rule')
+            '--enable-rule',
+            action='store_true',
+            help=_(
+                '(Deprecated) Use "firewall rule set --disable-rule" instead. '
+                'Disable this rule'
+            ),
         )
 
         parser.add_argument(
@@ -533,8 +541,16 @@ def _get_attrs(
         if parsed_args.destination_port:
             attrs['destination_port'] = None
         if parsed_args.share:
+            LOG.warning(
+                'The --share option is deprecated, please use '
+                '"firewall rule set --no-share" instead.'
+            )
             attrs['shared'] = False
         if parsed_args.enable_rule:
+            LOG.warning(
+                'The --enable-rule option is deprecated, please use '
+                '"firewall rule set --disable-rule" instead.'
+            )
             attrs['enabled'] = False
         if parsed_args.source_firewall_group:
             attrs['source_firewall_group_id'] = None

openstackclient/tests/unit/network/v2/fwaas/test_group.py

@@ -792,7 +792,12 @@ def test_unset_shared(self):
             ('share', True),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
-        result = self.cmd.take_action(parsed_args)
+        with mock.patch.object(fwaas_group.LOG, 'warning') as mock_warning:
+            result = self.cmd.take_action(parsed_args)
+            mock_warning.assert_called_once_with(
+                'The --share option is deprecated, please use '
+                '"firewall group set --no-share" instead.'
+            )
         self.mocked.assert_called_once_with(target, **{'shared': False})
         self.assertIsNone(result)
 
@@ -841,7 +846,12 @@ def test_unset_enable(self):
             ('enable', True),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
-        result = self.cmd.take_action(parsed_args)
+        with mock.patch.object(fwaas_group.LOG, 'warning') as mock_warning:
+            result = self.cmd.take_action(parsed_args)
+            mock_warning.assert_called_once_with(
+                'The --enable option is deprecated, please use '
+                '"firewall group set --disable" instead.'
+            )
         self.mocked.assert_called_once_with(
             target, **{'admin_state_up': False}
         )

openstackclient/tests/unit/network/v2/fwaas/test_policy.py

@@ -781,7 +781,12 @@ def test_unset_shared(self):
             ('share', True),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
-        result = self.cmd.take_action(parsed_args)
+        with mock.patch.object(fwaas_policy.LOG, 'warning') as mock_warning:
+            result = self.cmd.take_action(parsed_args)
+            mock_warning.assert_called_once_with(
+                'The --share option is deprecated, please use '
+                '"firewall policy set --no-share" instead.'
+            )
         self.mocked.assert_called_once_with(target, **{'shared': False})
         self.assertIsNone(result)
 

openstackclient/tests/unit/network/v2/fwaas/test_rule.py

@@ -798,7 +798,12 @@ def test_unset_shared(self):
             ('share', True),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
-        result = self.cmd.take_action(parsed_args)
+        with mock.patch.object(fwaas_rule.LOG, 'warning') as mock_warning:
+            result = self.cmd.take_action(parsed_args)
+            mock_warning.assert_called_once_with(
+                'The --share option is deprecated, please use '
+                '"firewall rule set --no-share" instead.'
+            )
         self.mocked.assert_called_once_with(target, **{'shared': False})
         self.assertIsNone(result)
 
@@ -899,8 +904,12 @@ def test_unset_enable_rule(self):
             ('enable_rule', True),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
-        result = self.cmd.take_action(parsed_args)
-
+        with mock.patch.object(fwaas_rule.LOG, 'warning') as mock_warning:
+            result = self.cmd.take_action(parsed_args)
+            mock_warning.assert_called_once_with(
+                'The --enable-rule option is deprecated, please use '
+                '"firewall rule set --disable-rule" instead.'
+            )
         self.mocked.assert_called_once_with(target, **{'enabled': False})
         self.assertIsNone(result)