add new test and use constant

Author: JerrySentry

codecov_auth/commands/owner/interactors/set_yaml_on_owner.py

@@ -13,6 +13,7 @@
     ValidationError,
 )
 from codecov.db import sync_to_async
+from codecov_auth.constants import OWNER_YAML_TO_STRING_KEY
 from codecov_auth.helpers import current_user_part_of_org
 from codecov_auth.models import Owner
 
@@ -56,6 +57,6 @@ def execute(self, username: str, yaml_input: str) -> Owner:
         self.authorize()
         self.owner.yaml = self.convert_yaml_to_dict(yaml_input)
         if self.owner.yaml:
-            self.owner.yaml["to_string"] = yaml_input
+            self.owner.yaml[OWNER_YAML_TO_STRING_KEY] = yaml_input
         self.owner.save()
         return self.owner

codecov_auth/commands/owner/interactors/tests/test_set_yaml_on_owner.py

@@ -35,6 +35,16 @@
     bot: foo: bar
 """
 
+good_yaml_with_comments = """
+# comment 1
+codecov:  # comment 2
+
+
+  bot: 'codecov'
+# comment 3
+    #comment 4
+"""
+
 
 class SetYamlOnOwnerInteractorTest(TransactionTestCase):
     def setUp(self):
@@ -113,3 +123,23 @@ async def test_yaml_syntax_error(self):
             str(e.value)
             == "Syntax error at line 3, column 13: mapping values are not allowed here"
         )
+
+    async def test_yaml_has_comments(self):
+        owner_updated = await self.execute(
+            self.current_owner, self.org.username, good_yaml_with_comments
+        )
+        # check the interactor returns the right owner
+        assert owner_updated.ownerid == self.org.ownerid
+        assert owner_updated.yaml == {
+            "codecov": {
+                "bot": "codecov",
+            },
+            "to_string": "\n"
+            "# comment 1\n"
+            "codecov:  # comment 2\n"
+            "\n"
+            "\n"
+            "  bot: 'codecov'\n"
+            "# comment 3\n"
+            "    #comment 4\n",
+        }

codecov_auth/constants.py

@@ -3,3 +3,4 @@
 GITLAB_BASE_URL = "https://gitlab.com"
 GRAVATAR_BASE_URL = "https://www.gravatar.com"
 AVATARIO_BASE_URL = "https://avatars.io"
+OWNER_YAML_TO_STRING_KEY = "to_string"

graphql_api/types/owner/owner.py

@@ -11,6 +11,7 @@
 import services.activation as activation
 import timeseries.helpers as timeseries_helpers
 from codecov.db import sync_to_async
+from codecov_auth.constants import OWNER_YAML_TO_STRING_KEY
 from codecov_auth.helpers import current_user_part_of_org
 from codecov_auth.models import (
     SERVICE_GITHUB,
@@ -94,7 +95,7 @@ def resolve_yaml(owner: Owner, info: GraphQLResolveInfo) -> Optional[str]:
     current_owner = info.context["request"].current_owner
     if not current_user_part_of_org(current_owner, owner):
         return None
-    return owner.yaml.get("to_string", yaml.dump(owner.yaml))
+    return owner.yaml.get(OWNER_YAML_TO_STRING_KEY, yaml.dump(owner.yaml))
 
 
 @owner_bindable.field("plan")