Add tests for message endpoint #40

brngylni · 2024-07-22T21:31:24Z

This PR adds the tests for message endpoint

gridhead

I wonder if it is sending any messages to the staging Fedora Messaging deployment or if it is not doing anything at all in the backend. Anyway, please make the suggested changes and then we can have another round of reviews.

gridhead · 2024-07-23T04:05:13Z

tests/conftest.py

-        get_or_create(db.session, Service, name="Github Demo", type="Github", desc="description", user_id=user.id)
-
+        service, created = get_or_create(db.session, Service, name="Github Demo", type="Github", desc="description", user_id=user.id)
+        service.token = "43b901cba25c458a9175ef119a9603bb"


Is it your actual GitHub token or the one generated by our service?

It was generated by our service and then I got it from there.

gridhead · 2024-07-23T04:05:38Z

tests/conftest.py

@@ -43,8 +43,8 @@ def create_service(client):
    with client.application.app_context():
        # Setup code to create the object in the database
        user, created = get_or_create(db.session, User, username="mehmet") # Adjust fields as necessary
-        get_or_create(db.session, Service, name="Github Demo", type="Github", desc="description", user_id=user.id)
-
+        service, created = get_or_create(db.session, Service, name="Github Demo", type="Github", desc="description", user_id=user.id)


GitHub is a proper noun.

Suggested change

service, created = get_or_create(db.session, Service, name="Github Demo", type="Github", desc="description", user_id=user.id)

service, created = get_or_create(db.session, Service, name="GitHub Demo", type="GitHub", desc="description", user_id=user.id)

gridhead · 2024-07-23T04:06:12Z

tests/test_message/event_sample.py

@@ -0,0 +1,204 @@
+


Please remove the empty line from the top of the file.

gridhead · 2024-07-23T04:07:16Z

tests/test_message/event_sample.py

+  "deleted": False,
+  "forced": False,
+  "base_ref": None,
+  "compare": "https://github.com/brngylni/demo_repo/compare/034c31e8e464...443f68ce112a",


Can this be emulated using VCR.py?

Ref. https://vcrpy.readthedocs.io/

I checked the documentation but it seems like there's a request, response structure when recording requests whereas we receive the request from GitHub to a webhook. So I'm not sure if we can make use of this. What do you think?

import vcr import urllib.request with vcr.use_cassette('fixtures/vcr_cassettes/synopsis.yaml'): response = urllib.request.urlopen('http://www.iana.org/domains/reserved').read() assert b'Example domains' in response

https://vcrpy.readthedocs.io/en/latest/usage.html#record-modes

What I've done is use a secret key generated by our service and get a sample push event payload.

gridhead · 2024-07-23T04:07:26Z

tests/test_message/event_sample.py

+      "distinct": True,
+      "message": "demo",
+      "timestamp": "2024-07-23T00:16:24+03:00",
+      "url": "https://github.com/brngylni/demo_repo/commit/443f68ce112ab055bbf48666762a626baa4729f6",


Can this be emulated using VCR.py?

Ref. https://vcrpy.readthedocs.io/

gridhead · 2024-07-23T04:08:06Z

tests/test_message/event_sample.py

+      "type": "User",
+      "site_admin": False
+    },
+    "html_url": "https://github.com/brngylni/demo_repo",


Is there a way to emulate this without using a secondary external repository?

I want our test cases to be self-sufficient and not dependent on external factors.

Do you mean a seperate repository under fedora infra?

@brngylni I mean by not having an external repository at all.

I thought having a real request might be helpful in terms of testing the hash and etc. That's why I used a real payload. I can edit the payload if you'd like to.

gridhead · 2024-07-23T04:08:25Z

tests/test_message/event_sample.py

+    "name": "demo_repo",
+    "full_name": "brngylni/demo_repo",


Is there a way to emulate this without using a secondary external repository?

I want our test cases to be self-sufficient and not dependent on external factors.

gridhead · 2024-07-23T04:08:49Z

tests/test_message/event_sample.py

+    "url": "https://github.com/brngylni/demo_repo",
+    "forks_url": "https://api.github.com/repos/brngylni/demo_repo/forks",
+    "keys_url": "https://api.github.com/repos/brngylni/demo_repo/keys{/key_id}",
+    "collaborators_url": "https://api.github.com/repos/brngylni/demo_repo/collaborators{/collaborator}",
+    "teams_url": "https://api.github.com/repos/brngylni/demo_repo/teams",
+    "hooks_url": "https://api.github.com/repos/brngylni/demo_repo/hooks",
+    "issue_events_url": "https://api.github.com/repos/brngylni/demo_repo/issues/events{/number}",
+    "events_url": "https://api.github.com/repos/brngylni/demo_repo/events",
+    "assignees_url": "https://api.github.com/repos/brngylni/demo_repo/assignees{/user}",
+    "branches_url": "https://api.github.com/repos/brngylni/demo_repo/branches{/branch}",
+    "tags_url": "https://api.github.com/repos/brngylni/demo_repo/tags",
+    "blobs_url": "https://api.github.com/repos/brngylni/demo_repo/git/blobs{/sha}",
+    "git_tags_url": "https://api.github.com/repos/brngylni/demo_repo/git/tags{/sha}",
+    "git_refs_url": "https://api.github.com/repos/brngylni/demo_repo/git/refs{/sha}",
+    "trees_url": "https://api.github.com/repos/brngylni/demo_repo/git/trees{/sha}",
+    "statuses_url": "https://api.github.com/repos/brngylni/demo_repo/statuses/{sha}",
+    "languages_url": "https://api.github.com/repos/brngylni/demo_repo/languages",
+    "stargazers_url": "https://api.github.com/repos/brngylni/demo_repo/stargazers",
+    "contributors_url": "https://api.github.com/repos/brngylni/demo_repo/contributors",
+    "subscribers_url": "https://api.github.com/repos/brngylni/demo_repo/subscribers",
+    "subscription_url": "https://api.github.com/repos/brngylni/demo_repo/subscription",
+    "commits_url": "https://api.github.com/repos/brngylni/demo_repo/commits{/sha}",
+    "git_commits_url": "https://api.github.com/repos/brngylni/demo_repo/git/commits{/sha}",
+    "comments_url": "https://api.github.com/repos/brngylni/demo_repo/comments{/number}",
+    "issue_comment_url": "https://api.github.com/repos/brngylni/demo_repo/issues/comments{/number}",
+    "contents_url": "https://api.github.com/repos/brngylni/demo_repo/contents/{+path}",
+    "compare_url": "https://api.github.com/repos/brngylni/demo_repo/compare/{base}...{head}",
+    "merges_url": "https://api.github.com/repos/brngylni/demo_repo/merges",
+    "archive_url": "https://api.github.com/repos/brngylni/demo_repo/{archive_format}{/ref}",
+    "downloads_url": "https://api.github.com/repos/brngylni/demo_repo/downloads",
+    "issues_url": "https://api.github.com/repos/brngylni/demo_repo/issues{/number}",
+    "pulls_url": "https://api.github.com/repos/brngylni/demo_repo/pulls{/number}",
+    "milestones_url": "https://api.github.com/repos/brngylni/demo_repo/milestones{/number}",
+    "notifications_url": "https://api.github.com/repos/brngylni/demo_repo/notifications{?since,all,participating}",
+    "labels_url": "https://api.github.com/repos/brngylni/demo_repo/labels{/name}",
+    "releases_url": "https://api.github.com/repos/brngylni/demo_repo/releases{/id}",
+    "deployments_url": "https://api.github.com/repos/brngylni/demo_repo/deployments",


Is there a way to emulate this without using a secondary external repository?

I want our test cases to be self-sufficient and not dependent on external factors.

gridhead · 2024-07-23T04:08:55Z

tests/test_message/event_sample.py

+    "git_url": "git://github.com/brngylni/demo_repo.git",
+    "ssh_url": "[email protected]:brngylni/demo_repo.git",
+    "clone_url": "https://github.com/brngylni/demo_repo.git",
+    "svn_url": "https://github.com/brngylni/demo_repo",


Is there a way to emulate this without using a secondary external repository?

I want our test cases to be self-sufficient and not dependent on external factors.

gridhead · 2024-07-23T04:11:39Z

tests/test_message/test_message_create.py

+@pytest.mark.parametrize(
+    "data, headers, code",
+    [
+        pytest.param(
+            request,
+            headers,
+            200,
+            id="MESSAGE Endpoint - 200 Success",
+        ),
+        pytest.param(
+            request,
+            {**headers, "X-Hub-Signature-256": ""},
+            400,
+            id="MESSAGE Endpoint - 400 Bad Request"
+        ),
+        pytest.param(
+            None,
+            headers,
+            415,
+            id="MESSAGE Endpoint - 415 Unsupported Media Type"
+        )
+    ]
+)
+
+@pytest.mark.usefixtures("create_service")
+def test_message_create(client, data, headers, code):
+    response = client.post("/message/1", json=data, headers=headers)
+    assert response.status_code == code
+
+
+@pytest.mark.parametrize(
+    "data, headers, code",
+    [
+        pytest.param(
+            request,
+            headers,
+            404,
+            id="MESSAGE Endpoint - Not Found",
+        )
+    ]
+)
+
+@pytest.mark.usefixtures("create_service")
+def test_not_found(client, data, headers, code):
+    response = client.post("/message/2", json=data, headers=headers)
+    assert response.status_code == code


I suspect that these can be combined to be four parameters under one testing function. Simply parameterize the URL path too (as in f"/message/{id}", where the id is provided from the parameters) and you should be fine.

Signed-off-by: Mehmet Baran Geylani <[email protected]>

gridhead requested changes Jul 23, 2024

View reviewed changes

gridhead self-assigned this Jul 23, 2024

brngylni requested a review from gridhead July 23, 2024 10:39

brngylni force-pushed the test_message_endpoint branch 2 times, most recently from cd87148 to 2664602 Compare July 24, 2024 20:08

Add tests for message endpoint

25c3a24

Signed-off-by: Mehmet Baran Geylani <[email protected]>

brngylni force-pushed the test_message_endpoint branch from 4c9ce68 to 25c3a24 Compare July 25, 2024 09:08

brngylni requested a review from abompard July 25, 2024 09:08

abompard merged commit 9547fcb into main Jul 25, 2024
5 of 10 checks passed

abompard deleted the test_message_endpoint branch July 25, 2024 15:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add tests for message endpoint #40

Add tests for message endpoint #40

brngylni commented Jul 22, 2024 •

edited

Loading

gridhead left a comment

gridhead Jul 23, 2024

brngylni Jul 23, 2024

gridhead Jul 23, 2024

gridhead Jul 23, 2024

gridhead Jul 23, 2024

brngylni Jul 23, 2024 •

edited

Loading

gridhead Jul 23, 2024

gridhead Jul 23, 2024

brngylni Jul 23, 2024

gridhead Jul 23, 2024

brngylni Jul 23, 2024

gridhead Jul 23, 2024

gridhead Jul 23, 2024

gridhead Jul 23, 2024

gridhead Jul 23, 2024

	service, created = get_or_create(db.session, Service, name="Github Demo", type="Github", desc="description", user_id=user.id)
	service, created = get_or_create(db.session, Service, name="GitHub Demo", type="GitHub", desc="description", user_id=user.id)

Add tests for message endpoint #40

Add tests for message endpoint #40

Conversation

brngylni commented Jul 22, 2024 • edited Loading

gridhead left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brngylni Jul 23, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brngylni commented Jul 22, 2024 •

edited

Loading

brngylni Jul 23, 2024 •

edited

Loading