feat: add parse_raw_upload #63

joseph-sentry · 2024-12-19T22:06:17Z

we want to support parsing raw upload files instead of individual JUnit
XML files

the input of this new function is the raw upload in byte form

the output is a messagepacked binary payload containing the results of
the parsing and the raw upload in readable format in byte form

Depends on: #62

we will need to handle msgpacking, base64 decoding and zlib decompressing

we want to document the new function that we're going to implement

we want to support parsing raw upload files instead of individual JUnit XML files the input of this new function is the raw upload in byte form the output is a messagepacked binary payload containing the results of the parsing and the raw upload in readable format in byte form

codecov-notifications · 2024-12-20T17:51:12Z

Codecov Report

Attention: Patch coverage is 82.97872% with 24 lines in your changes missing coverage. Please review.

✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
src/testrun.rs	52.08%	23 Missing ⚠️
src/junit.rs	93.75%	1 Missing ⚠️

📢 Thoughts on this report? Let us know!

codecov · 2024-12-20T18:36:50Z

Codecov Report

Attention: Patch coverage is 82.97872% with 24 lines in your changes missing coverage. Please review.

Project coverage is 96.95%. Comparing base (0a663e5) to head (d3a4509).
Report is 10 commits behind head on main.

✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
src/testrun.rs	52.08%	23 Missing ⚠️
src/junit.rs	93.75%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #63      +/-   ##
==========================================
+ Coverage   94.31%   96.95%   +2.63%     
==========================================
  Files          14       15       +1     
  Lines        1900     1871      -29     
==========================================
+ Hits         1792     1814      +22     
+ Misses        108       57      -51

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

src/raw_upload.rs

src/testrun.rs

src/raw_upload.rs

tests/test_parse_raw_upload.py

we want the parse_raw_upload function to return a list of dictionaries since that's what will be inserted into postgres we also replace the pyresult with an anyhow::Result we also add snapshot testing using insta

we want to have enums for Outcome and Framework because having them as Strings does not encode the fact that they have a limited range of values they can take

…seph/parse-raw-upload

Swatinem

lgtm, just some minor stylistic improvements that you can do or also skip for later :-)

Swatinem · 2025-01-08T08:37:55Z

src/junit.rs

@@ -167,13 +148,13 @@ pub fn use_reader(
                b"skipped" => {
                    let testrun = saved_testrun
                        .as_mut()
-                        .ok_or_else(|| ParserError::new_err("Error accessing saved testrun"))?;
+                        .ok_or_else(|| anyhow!("Error accessing saved testrun"))?;


The .context() method also exists on Option, so all these can be further simplified :-)

Swatinem · 2025-01-08T08:41:46Z

src/raw_upload.rs

+            r#"{{"network": [], "test_results_files": [{{"filename": "{}", "format": "base64+compressed", "data": "{}"}}]}}"#,
+            filename, base64_data,


Suggested change

r#"{{"network": [], "test_results_files": [{{"filename": "{}", "format": "base64+compressed", "data": "{}"}}]}}"#,

filename, base64_data,

r#"{{"network": [], "test_results_files": [{{"filename": "{filename}", "format": "base64+compressed", "data": "{base64_data}"}}]}}"#,

I believe you can also use format fields in raw strings as well.

Swatinem · 2025-01-08T08:42:36Z

src/raw_upload.rs

+            r#"{{"network": [], "test_results_files": [{{"filename": "{}", "format": "base64+compressed", "data": "{}"}}]}}"#,
+            filename, base64_data,
+        );
+        upload_json.as_bytes().to_vec()


Suggested change

upload_json.as_bytes().to_vec()

upload_json.into()

This should avoid a copy. It should be possible to convert the String into a Vec<u8> trivially.

Swatinem · 2025-01-08T08:45:14Z

src/testrun.rs

+    }
+}
+
+// i can't seem to get  pyo3(from_item_all) to work when IntoPyObject is also being derived


that is unfortunate :-(
Is there an upstream issue about this?

there does not seem to be one, but at the same time i feel like i'm doing something wrong in the first place, maybe we should have different types for the testruns we expect to be ingesting in the writer and the testruns we're outputting in the parser

anyways i looked into why it's outputting an error and it's because the IntoPyObject macro is parsing the attributes using this function. i don't have a clue on how to fix something like this, other than maybe adding a new FromIntoPyObject derive

that is actually a good idea, yes.

depending on how we move forward with bigquery or the custom binary format, we wouldn’t want to do a roundtrip through python anyway when using the writer.

Swatinem · 2025-01-08T08:47:09Z

tests/test_parse_raw_upload.py

+
+
+            assert parsing_infos[0]["framework"] == "Pytest"
+            assert parsing_infos[0]["testruns"] == [


insta also exists in Python I believe, if you want to use it for these asserts as well :-)

joseph-sentry marked this pull request as draft December 19, 2024 22:06

joseph-sentry added 3 commits December 20, 2024 12:49

deps: prepare deps for parse raw upload

eee349e

we will need to handle msgpacking, base64 decoding and zlib decompressing

docs: update the readme for parse_raw_upload

0aff0d2

we want to document the new function that we're going to implement

joseph-sentry force-pushed the joseph/parse-raw-upload branch from 1117e75 to 7920ff8 Compare December 20, 2024 17:50

joseph-sentry requested a review from a team December 20, 2024 21:03

joseph-sentry marked this pull request as ready for review December 20, 2024 21:03

feat: small improvement to error message

e69c111

Swatinem reviewed Jan 7, 2025

View reviewed changes

joseph-sentry added 4 commits January 7, 2025 16:39

feat: parse_raw_upload returns list of dict

c905618

we want the parse_raw_upload function to return a list of dictionaries since that's what will be inserted into postgres we also replace the pyresult with an anyhow::Result we also add snapshot testing using insta

feat: add back enums for Outcome and Framework

d123ef6

we want to have enums for Outcome and Framework because having them as Strings does not encode the fact that they have a limited range of values they can take

Merge branch 'main' of github.com:codecov/test-results-parser into jo…

f0d8da5

…seph/parse-raw-upload

fix the stuff i broke while merging

50878e5

Swatinem approved these changes Jan 8, 2025

View reviewed changes

fix: address feedback

d3a4509

joseph-sentry merged commit cc76ca7 into main Jan 8, 2025
8 of 11 checks passed

joseph-sentry deleted the joseph/parse-raw-upload branch January 8, 2025 19:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add parse_raw_upload #63

feat: add parse_raw_upload #63

joseph-sentry commented Dec 19, 2024 •

edited

Loading

codecov-notifications bot commented Dec 20, 2024 •

edited

Loading

codecov bot commented Dec 20, 2024 •

edited

Loading

Swatinem left a comment

Swatinem Jan 8, 2025

Swatinem Jan 8, 2025

Swatinem Jan 8, 2025

Swatinem Jan 8, 2025

joseph-sentry Jan 8, 2025 •

edited

Loading

Swatinem Jan 8, 2025

Swatinem Jan 8, 2025

		r#"{{"network": [], "test_results_files": [{{"filename": "{}", "format": "base64+compressed", "data": "{}"}}]}}"#,
		filename, base64_data,



		assert parsing_infos[0]["framework"] == "Pytest"
		assert parsing_infos[0]["testruns"] == [

feat: add parse_raw_upload #63

feat: add parse_raw_upload #63

Conversation

joseph-sentry commented Dec 19, 2024 • edited Loading

codecov-notifications bot commented Dec 20, 2024 • edited Loading

Codecov Report

codecov bot commented Dec 20, 2024 • edited Loading

Codecov Report

Swatinem left a comment

Choose a reason for hiding this comment

Swatinem Jan 8, 2025

Choose a reason for hiding this comment

Swatinem Jan 8, 2025

Choose a reason for hiding this comment

Swatinem Jan 8, 2025

Choose a reason for hiding this comment

Swatinem Jan 8, 2025

Choose a reason for hiding this comment

joseph-sentry Jan 8, 2025 • edited Loading

Choose a reason for hiding this comment

Swatinem Jan 8, 2025

Choose a reason for hiding this comment

Swatinem Jan 8, 2025

Choose a reason for hiding this comment

joseph-sentry commented Dec 19, 2024 •

edited

Loading

codecov-notifications bot commented Dec 20, 2024 •

edited

Loading

codecov bot commented Dec 20, 2024 •

edited

Loading

joseph-sentry Jan 8, 2025 •

edited

Loading