feat: Add a copy method to Policy model, to be used to generate c…

…opies from template policies (#575)

policykit/policyengine/models.py

@@ -861,6 +861,40 @@ def is_bundled(self):
         """True if the policy is part of a bundle"""
         return self.member_of_bundle.count() > 0
 
+    def copy(self, community = None):
+        """Make a copy of the policy object and assign to a new community"""
+        if not community:
+            raise Exception("Community object must be passed")
+
+        from copy import deepcopy
+
+        # Make a copy of the whole objet
+        new_policy = deepcopy(self)
+
+        # Generate a new id
+        new_policy.pk = None
+
+        # Assign copy to another community
+        new_policy.community = community
+
+        new_policy.save()
+
+        # Copy ActionType relationships
+        new_policy.action_types.set(self.action_types.all())
+
+        # Remove existing Policy Variable relationships
+        new_policy.variables.set([])
+
+        # Make copies of related PolicyVariables
+        for variable in self.variables.all():
+            new_variable = deepcopy(variable)
+            new_variable.pk = None
+            new_variable.policy = new_policy
+            new_variable.value = variable.default_value
+            new_variable.save()
+
+        return new_policy
+
 
 class UserVote(models.Model):
     """UserVote"""

policykit/tests/test_clone_policy.py

@@ -0,0 +1,67 @@
+from django.test import TestCase
+from policyengine.models import Policy, PolicyVariable, Proposal, ActionType
+import tests.utils as TestUtils
+
+
+class ClonePolicyTests(TestCase):
+    """
+    Test the policy cloning functionality
+    """
+
+    def setUp(self):
+        self.slack_community_source, self.user = TestUtils.create_slack_community_and_user()
+        self.community_source = self.slack_community_source.community
+        self.constitution_community = self.community_source.constitution_community
+        self.client.force_login(user=self.user, backend="integrations.slack.auth_backends.SlackBackend")
+
+        # Create a policy to use as a source
+        self.policy_source = Policy.objects.create(**TestUtils.ALL_ACTIONS_PASS, kind=Policy.TRIGGER, community=self.community_source)
+
+        # Add an action type to source policy
+        self.action_type = ActionType.objects.get_or_create(codename="slackpostmessage")[0]
+        self.policy_source.action_types.set([ self.action_type ])
+
+        # Create policy variables
+        self.policy_variable_source = PolicyVariable.objects.create(name='test', label='Test', default_value="1", value="2", type='number', prompt='A test variable', policy=self.policy_source)
+
+        # Create a community to attach policy copy to
+        self.slack_community_source, user2 = TestUtils.create_slack_community_and_user(team_id="target", username="user2")
+        self.community_target = self.slack_community_source.community
+
+    def test_no_community_raises_exception(self):
+        # Check that an exception is raied when copy() is used without a community parameter
+        with self.assertRaisesRegexp(Exception, "Community object must be passed"):
+            self.policy_source.copy()
+
+    def test_copy_policy(self):
+        new_policy = self.policy_source.copy(self.community_target)
+
+        # Check that policy copy was created
+        self.assertNotEqual(new_policy.pk, self.policy_source.pk)
+
+        # Check that policy copy is related the target community
+        self.assertEqual(new_policy.community, self.community_target)
+
+        # Check that policy copy has the same values as original
+        for fieldname in [ "kind", "filter", "initialize", "check", "notify", "success", "fail", "name", "description", "is_active" ]:
+            self.assertEqual(getattr(new_policy, fieldname), getattr(self.policy_source, fieldname))
+
+        # Check that the action_type was copied correctly
+        self.assertEqual(new_policy.action_types.count(), 1)
+        self.assertEqual(new_policy.action_types.all()[0].codename, "slackpostmessage")
+        self.assertEqual(self.action_type.policy_set.count(), 2)
+
+        # Check that policy variables were copied
+        self.assertEqual(new_policy.variables.count(), 1)
+        self.policy_variable_source.policy = self.policy_source
+
+        # Check that policy copy has new instances of policy variables
+        self.assertEqual(new_policy.variables.count(), 1)
+        new_variable = new_policy.variables.all()[0]
+        self.assertNotEqual(new_variable.pk, self.policy_variable_source.pk)
+
+        for fieldname in [ "name", "label", "is_required", "default_value", "prompt", "type" ]:
+            self.assertEqual(getattr(new_variable, fieldname), getattr(self.policy_variable_source, fieldname))
+
+        # Check that policy variable value is set to the default value
+        self.assertEqual(new_variable.value, self.policy_variable_source.default_value)

policykit/tests/utils.py

@@ -32,9 +32,9 @@ def create_no_platform_community():
     print("it worked!")
 
 
-def create_slack_community_and_user():
+def create_slack_community_and_user(team_id = "ABC", username="user1"):
     # create initial community
-    slack_community = SlackCommunity.objects.create(community_name="slack test community", team_id="ABC")
+    slack_community = SlackCommunity.objects.create(community_name="slack test community", team_id=team_id)
 
     # create a base role with permission to propose any action
     user_group = CommunityRole.objects.create(
@@ -44,7 +44,7 @@ def create_slack_community_and_user():
     user_group.permissions.add(*propose_perms)
 
     # create a user
-    user = SlackUser.objects.create(username="user1", community=slack_community)
+    user = SlackUser.objects.create(username=username, community=slack_community)
 
     return slack_community, user