[feat] Add endpoint that checks whether an owner has Gen AI consent #1102

rohitvinnakota-codecov · 2025-01-15T22:28:10Z

We want to authenticate 2 ways from Seer <-> Codecov before invoking any of our AI features. This endpoint will be called from Seer to verify that the owner has a valid app installation with Codecov.

Legal Boilerplate

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. In 2022 this entity acquired Codecov and as result Sentry is going to need some rights from me in order to utilize my contributions in this PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

codecov-notifications · 2025-01-15T22:41:19Z

Codecov Report

Attention: Patch coverage is 95.91837% with 2 lines in your changes missing coverage. Please review.

✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
api/gen_ai/views.py	95.34%	2 Missing ⚠️

📢 Thoughts on this report? Let us know!

codecov-qa · 2025-01-15T22:41:23Z

❌ 5 Tests Failed:

Tests completed	Failed	Passed	Skipped
2701	5	2696	7

View the top 3 failed tests by shortest run time

api/gen_ai/tests/test_gen_ai.py::GenAIAuthViewTests::test_missing_parameters

Stack Traces | 0.006s run time

self = <test_gen_ai.GenAIAuthViewTests testMethod=test_missing_parameters>
mock_config = <MagicMock name='get_config' id='140087881010880'>

    @patch("utils.config.get_config", return_value=PAYLOAD_SECRET)
    def test_missing_parameters(self, mock_config):
        payload = {}
        sig, data = sign_payload(payload)
        response = self.client.post(
            VIEW_URL,
            data=payload,
            content_type="application/json",
            HTTP_X_GEN_AI_AUTH_SIGNATURE=sig,
        )
>       self.assertEqual(response.status_code, 400)
E       AssertionError: 403 != 400

.../gen_ai/tests/test_gen_ai.py:34: AssertionError

api/gen_ai/tests/test_gen_ai.py::GenAIAuthViewTests::test_owner_not_found

Stack Traces | 0.008s run time

self = <test_gen_ai.GenAIAuthViewTests testMethod=test_owner_not_found>
mock_config = <MagicMock name='get_config' id='140087880766560'>

    @patch("utils.config.get_config", return_value=PAYLOAD_SECRET)
    def test_owner_not_found(self, mock_config):
        payload = {"external_owner_id": "nonexistent_owner", "repo_service_id": "101"}
        sig, serialized_data = sign_payload(payload)
        response = self.client.post(
            VIEW_URL,
            HTTP_X_GEN_AI_AUTH_SIGNATURE=sig,
            data=serialized_data,
            content_type="application/json",
        )
>       self.assertEqual(response.status_code, 404)
E       AssertionError: 403 != 404

.../gen_ai/tests/test_gen_ai.py:62: AssertionError

api/gen_ai/tests/test_gen_ai.py::GenAIAuthViewTests::test_no_installation

Stack Traces | 0.011s run time

self = <test_gen_ai.GenAIAuthViewTests testMethod=test_no_installation>
mock_config = <MagicMock name='get_config' id='140087881449248'>

    @patch("utils.config.get_config", return_value=PAYLOAD_SECRET)
    def test_no_installation(self, mock_config):
        _ = OwnerFactory(service="github", service_id="owner1", username="test1")
        payload = {"external_owner_id": "owner1", "repo_service_id": "101"}
        sig, data = sign_payload(payload)
        response = self.client.post(
            VIEW_URL,
            data=data,
            content_type="application/json",
            HTTP_X_GEN_AI_AUTH_SIGNATURE=sig,
        )
    
>       self.assertEqual(response.status_code, 200)
E       AssertionError: 403 != 200

.../gen_ai/tests/test_gen_ai.py:76: AssertionError

To view more test analytics, go to the Test Analytics Dashboard
📢 Thoughts on this report? Let us know!

codecov-public-qa · 2025-01-15T22:41:31Z

❌ 5 Tests Failed:

Tests completed	Failed	Passed	Skipped
2702	5	2697	6

View the top 3 failed tests by shortest run time

api/gen_ai/tests/test_gen_ai.py::GenAIAuthViewTests::test_missing_parameters

Stack Traces | 0.006s run time

self = <test_gen_ai.GenAIAuthViewTests testMethod=test_missing_parameters>
mock_config = <MagicMock name='get_config' id='140087881010880'>

    @patch("utils.config.get_config", return_value=PAYLOAD_SECRET)
    def test_missing_parameters(self, mock_config):
        payload = {}
        sig, data = sign_payload(payload)
        response = self.client.post(
            VIEW_URL,
            data=payload,
            content_type="application/json",
            HTTP_X_GEN_AI_AUTH_SIGNATURE=sig,
        )
>       self.assertEqual(response.status_code, 400)
E       AssertionError: 403 != 400

.../gen_ai/tests/test_gen_ai.py:34: AssertionError

api/gen_ai/tests/test_gen_ai.py::GenAIAuthViewTests::test_owner_not_found

Stack Traces | 0.008s run time

self = <test_gen_ai.GenAIAuthViewTests testMethod=test_owner_not_found>
mock_config = <MagicMock name='get_config' id='140087880766560'>

    @patch("utils.config.get_config", return_value=PAYLOAD_SECRET)
    def test_owner_not_found(self, mock_config):
        payload = {"external_owner_id": "nonexistent_owner", "repo_service_id": "101"}
        sig, serialized_data = sign_payload(payload)
        response = self.client.post(
            VIEW_URL,
            HTTP_X_GEN_AI_AUTH_SIGNATURE=sig,
            data=serialized_data,
            content_type="application/json",
        )
>       self.assertEqual(response.status_code, 404)
E       AssertionError: 403 != 404

.../gen_ai/tests/test_gen_ai.py:62: AssertionError

api/gen_ai/tests/test_gen_ai.py::GenAIAuthViewTests::test_no_installation

Stack Traces | 0.011s run time

self = <test_gen_ai.GenAIAuthViewTests testMethod=test_no_installation>
mock_config = <MagicMock name='get_config' id='140087881449248'>

    @patch("utils.config.get_config", return_value=PAYLOAD_SECRET)
    def test_no_installation(self, mock_config):
        _ = OwnerFactory(service="github", service_id="owner1", username="test1")
        payload = {"external_owner_id": "owner1", "repo_service_id": "101"}
        sig, data = sign_payload(payload)
        response = self.client.post(
            VIEW_URL,
            data=data,
            content_type="application/json",
            HTTP_X_GEN_AI_AUTH_SIGNATURE=sig,
        )
    
>       self.assertEqual(response.status_code, 200)
E       AssertionError: 403 != 200

.../gen_ai/tests/test_gen_ai.py:76: AssertionError

To view more test analytics, go to the Test Analytics Dashboard
📢 Thoughts on this report? Let us know!

github-actions · 2025-01-15T22:41:31Z

✅ All tests successful. No failed tests were found.

📣 Thoughts on this report? Let Codecov know! | Powered by Codecov

codecov · 2025-01-15T23:00:49Z

Codecov Report

Attention: Patch coverage is 95.91837% with 2 lines in your changes missing coverage. Please review.

Project coverage is 96.10%. Comparing base (ab5c1ff) to head (ac5908b).
Report is 1 commits behind head on main.

✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
api/gen_ai/views.py	95.34%	2 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1102   +/-   ##
=======================================
  Coverage   96.09%   96.10%           
=======================================
  Files         832      835    +3     
  Lines       19501    19596   +95     
=======================================
+ Hits        18740    18832   +92     
- Misses        761      764    +3

Flag	Coverage Δ
unit	`96.01% <95.91%> (+<0.01%)`	⬆️
unit-latest-uploader	`96.01% <95.91%> (+<0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

…codecov/codecov-api into rvinnakota/add-ai-auth-endpoint

codecov/settings_staging.py

api/gen_ai/views.py

mdtro · 2025-01-17T21:27:05Z

api/gen_ai/views.py

+
+    def validate_signature(self, request):
+        key = get_config(
+            "gen_ai", "auth_secret", default=b"testixik8qdauiab1yiffydimvi72ekq"


Is it possible to avoid setting a default here and instead error out if it is not set?

mdtro · 2025-01-17T21:30:12Z

api/gen_ai/tests/test_gen_ai.py

+def sign_payload(payload, secret=PAYLOAD_SECRET):
+    data = json.dumps(payload, separators=(",", ":")).encode("utf-8")
+    signature = "sha256=" + hmac.new(secret, data, digestmod=sha256).hexdigest()
+    return signature, data


Suggested change

def sign_payload(payload, secret=PAYLOAD_SECRET):

data = json.dumps(payload, separators=(",", ":")).encode("utf-8")

signature = "sha256=" + hmac.new(secret, data, digestmod=sha256).hexdigest()

return signature, data

def sign_payload(payload: bytes, secret=PAYLOAD_SECRET):

signature = "sha256=" + hmac.new(secret, payload, digestmod=sha256).hexdigest()

return signature, data

I would avoid going from bytes -> string -> bytes with json.dumps(). Ordering of the keys isn't guaranteed (afaik), this can result in different signatures. The recommendation when working with payload signatures like this is to always calculate them based on the raw bytes.

Co-authored-by: Matthew T <[email protected]>

rohitvinnakota-codecov added 4 commits January 15, 2025 17:26

Add gen ai endpoint

a82089d

undo

7e5a1a9

lint

e47e5a3

Typing

d4ba9a6

Update

9f365bd

rohitvinnakota-codecov added 2 commits January 16, 2025 16:34

Update

5bdbff6

Lint

28457dd

rohitvinnakota-codecov force-pushed the rvinnakota/add-ai-auth-endpoint branch from 20acd52 to 28457dd Compare January 16, 2025 21:34

rohitvinnakota-codecov and others added 7 commits January 16, 2025 16:35

remove print

a0a5ad8

lint

d52a405

Merge branch 'main' into rvinnakota/add-ai-auth-endpoint

4c5ef9d

Update

d6192d5

Merge branch 'rvinnakota/add-ai-auth-endpoint' of https://github.com/…

4e4f279

…codecov/codecov-api into rvinnakota/add-ai-auth-endpoint

Add serializer

ed71817

sort imports

386372f

rohitvinnakota-codecov commented Jan 17, 2025

View reviewed changes

codecov/settings_staging.py Outdated Show resolved Hide resolved

Update hosts

c0b07ff

rohitvinnakota-codecov marked this pull request as ready for review January 17, 2025 20:41

Fix tests

da13f82

mdtro reviewed Jan 17, 2025

View reviewed changes

api/gen_ai/views.py Outdated Show resolved Hide resolved

mdtro reviewed Jan 17, 2025

View reviewed changes

api/gen_ai/views.py Outdated Show resolved Hide resolved

mdtro reviewed Jan 17, 2025

View reviewed changes

Update

624ee10

mdtro reviewed Jan 17, 2025

View reviewed changes

Update api/gen_ai/views.py

ac5908b

Co-authored-by: Matthew T <[email protected]>

rohitvinnakota-codecov force-pushed the rvinnakota/add-ai-auth-endpoint branch from 161ab0e to ac5908b Compare January 17, 2025 21:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[feat] Add endpoint that checks whether an owner has Gen AI consent #1102

[feat] Add endpoint that checks whether an owner has Gen AI consent #1102

rohitvinnakota-codecov commented Jan 15, 2025

codecov-notifications bot commented Jan 15, 2025 •

edited

Loading

codecov-qa bot commented Jan 15, 2025 •

edited

Loading

codecov-public-qa bot commented Jan 15, 2025 •

edited

Loading

github-actions bot commented Jan 15, 2025 •

edited

Loading

codecov bot commented Jan 15, 2025 •

edited

Loading

mdtro Jan 17, 2025

mdtro Jan 17, 2025

[feat] Add endpoint that checks whether an owner has Gen AI consent #1102

Are you sure you want to change the base?

[feat] Add endpoint that checks whether an owner has Gen AI consent #1102

Conversation

rohitvinnakota-codecov commented Jan 15, 2025

Legal Boilerplate

codecov-notifications bot commented Jan 15, 2025 • edited Loading

Codecov Report

codecov-qa bot commented Jan 15, 2025 • edited Loading

❌ 5 Tests Failed:

codecov-public-qa bot commented Jan 15, 2025 • edited Loading

❌ 5 Tests Failed:

github-actions bot commented Jan 15, 2025 • edited Loading

codecov bot commented Jan 15, 2025 • edited Loading

Codecov Report

mdtro Jan 17, 2025

Choose a reason for hiding this comment

mdtro Jan 17, 2025

Choose a reason for hiding this comment

codecov-notifications bot commented Jan 15, 2025 •

edited

Loading

codecov-qa bot commented Jan 15, 2025 •

edited

Loading

codecov-public-qa bot commented Jan 15, 2025 •

edited

Loading

github-actions bot commented Jan 15, 2025 •

edited

Loading

codecov bot commented Jan 15, 2025 •

edited

Loading