Skip to content
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

test: Add tests to monitor any changes in the public API surface in NewRelic.Api.Agent #2749

Merged
merged 4 commits into from
Sep 12, 2024

Conversation

tippmar-nr
Copy link
Member

@tippmar-nr tippmar-nr commented Sep 11, 2024

Adds a unit test project that leverages the PublicAPIGenerator and Verify NuGet packages as suggested in Andrew Lock's blog.

The test will monitor the public API in NewRelic.Api.Agent and will fail if there is a change. When running the test locally, a diff tool will be launched (using VS Code in most cases) that will help to resolve the failure by showing the change:
image

@tippmar-nr tippmar-nr requested a review from a team as a code owner September 11, 2024 16:36
chynesNR
chynesNR previously approved these changes Sep 11, 2024
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.17%. Comparing base (32e54c1) to head (3fe7a33).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2749   +/-   ##
=======================================
  Coverage   81.17%   81.17%           
=======================================
  Files         459      459           
  Lines       29204    29204           
  Branches     3223     3223           
=======================================
  Hits        23705    23705           
  Misses       4708     4708           
  Partials      791      791           
Flag Coverage Δ
Agent 82.18% <ø> (ø)
Profiler 72.12% <ø> (ø)

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

@tippmar-nr tippmar-nr merged commit 27cc7e1 into main Sep 12, 2024
96 checks passed
@tippmar-nr tippmar-nr deleted the test/public-api-change-monitoring branch September 12, 2024 19:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants