Skip to content

C#: Port the java FrameworkCoverage query. #8869

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 28, 2022

Conversation

michaelnebel
Copy link
Contributor

@michaelnebel michaelnebel commented Apr 26, 2022

In this PR we

  • Port the Java FrameworkCoverage query to C#.
  • Include the generation in the "publish" workflow (like for java).

@github-actions github-actions bot added the C# label Apr 26, 2022
@michaelnebel
Copy link
Contributor Author

@henrymercer : I have just ported the java Framework Coverage query to C# and included the generation of the sarif in the workflow. Do you know, there is some other functionality around that reads the sarif output files (the artifacts) from the workflow execution or is it just for manual downloading? :-) Anything you know about this would help :-)

@michaelnebel michaelnebel marked this pull request as ready for review April 26, 2022 13:56
@michaelnebel michaelnebel requested a review from a team as a code owner April 26, 2022 13:56
@michaelnebel michaelnebel added the no-change-note-required This PR does not need a change note label Apr 26, 2022
@henrymercer
Copy link
Contributor

Hi @michaelnebel 👋 The ingestion into the data warehouse happens via the github/codeql-action/upload-sarif Action — that Action uploads the SARIF file to a GitHub API endpoint which processes it and adds the relevant data to the data warehouse. Happy to follow up on an internal issue with more details about how that works.

My understanding is that the workflow artifact created by actions/upload-artifact is purely for debugging.

@michaelnebel
Copy link
Contributor Author

Hi @michaelnebel 👋 The ingestion into the data warehouse happens via the github/codeql-action/upload-sarif Action — that Action uploads the SARIF file to a GitHub API endpoint which processes it and adds the relevant data to the data warehouse. Happy to follow up on an internal issue with more details about how that works.

My understanding is that the workflow artifact created by actions/upload-artifact is purely for debugging.

Aha, that is good to know! And thank you very much for helping out! 😄
I will take the liberty to assign you on the PR (let me know if this is not ok).

I just to a brief look at the source code for the codeql-action/upload-sarif, but couldn't really figure out, whether changing the name of the sarif file for the existing Java reporting will have other side-effects somewhere downstream or if it is only the content of the file that matters (which should be identical to before).
So basically my questions are, do you know whether
(1) The file name matters downstream in the processing.
(2) Exactly where the data will end up.

If we can verify that (1) does not cause in problems, then the PR can probably be merged almost as is.

@henrymercer
Copy link
Contributor

Aha, that is good to know! And thank you very much for helping out! 😄
I will take the liberty to assign you on the PR (let me know if this is not ok).

No problem!

So basically my questions are, do you know whether
(1) The file name matters downstream in the processing.

The file name doesn't matter for the processing — only its content.

(2) Exactly where the data will end up.

I've answered this on the internal issue.

henrymercer
henrymercer previously approved these changes Apr 27, 2022
hvitved
hvitved previously approved these changes Apr 28, 2022
Copy link
Contributor

@hvitved hvitved left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks plausible to me.

@michaelnebel michaelnebel dismissed stale reviews from hvitved and henrymercer via 57fc4d9 April 28, 2022 09:20
@michaelnebel michaelnebel force-pushed the csharp/frameworkcoverage branch from 2c2ca1b to 57fc4d9 Compare April 28, 2022 09:20
@michaelnebel michaelnebel requested a review from a team as a code owner April 28, 2022 09:20
@michaelnebel
Copy link
Contributor Author

Needed to rebase due to a merge conflict (update of the action upload-artifact to v3).

hvitved
hvitved previously approved these changes Apr 28, 2022
henrymercer
henrymercer previously approved these changes Apr 28, 2022
@michaelnebel michaelnebel dismissed stale reviews from henrymercer and hvitved via 150d9ba April 28, 2022 09:57
Co-authored-by: Henry Mercer <henry.mercer@me.com>
@michaelnebel michaelnebel merged commit 9d767b8 into github:main Apr 28, 2022
@michaelnebel michaelnebel deleted the csharp/frameworkcoverage branch April 28, 2022 11:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C# no-change-note-required This PR does not need a change note
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants