Skip to content

Update APIVerificationTests.cs#2391

Draft
josepmariapujol-unity wants to merge 8 commits intodevelopfrom
input/api-exclusion
Draft

Update APIVerificationTests.cs#2391
josepmariapujol-unity wants to merge 8 commits intodevelopfrom
input/api-exclusion

Conversation

@josepmariapujol-unity
Copy link
Collaborator

Description

Please fill this section with a description what the pull request is trying to address and what changes were made.

Testing status & QA

Please describe the testing already done by you and what testing you request/recommend QA to execute. If you used or created any testing project please link them here too for QA.

Overall Product Risks

Please rate the potential complexity and halo effect from low to high for the reviewers. Note down potential risks to specific Editor branches if any.

  • Complexity:
  • Halo Effect:

Comments to reviewers

Please describe any additional information such as what to focus on, or historical info for the reviewers.

Checklist

Before review:

  • Changelog entry added.
    • Explains the change in Changed, Fixed, Added sections.
    • For API change contains an example snippet and/or migration example.
    • JIRA ticket linked, example (case %%). If it is a private issue, just add the case ID without a link.
    • Jira port for the next release set as "Resolved".
  • Tests added/changed, if applicable.
    • Functional tests Area_CanDoX, Area_CanDoX_EvenIfYIsTheCase, Area_WhenIDoX_AndYHappens_ThisIsTheResult.
    • Performance tests.
    • Integration tests.
  • Docs for new/changed API's.
    • Xmldoc cross references are set correctly.
    • Added explanation how the API works.
    • Usage code examples added.
    • The manual is updated, if needed.

During merge:

  • Commit message for squash-merge is prefixed with one of the list:
    • NEW: ___.
    • FIX: ___.
    • DOCS: ___.
    • CHANGE: ___.
    • RELEASE: 1.1.0-preview.3.

Copy link
Contributor

@u-pr u-pr bot left a comment

Choose a reason for hiding this comment

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

Good
The review identified a few minor points regarding namespace consistency and attribute organization in the API verification tests.

🤖 Helpful? 👍/👎

public class DaydreamController : UnityEngine.InputSystem.XR.XRController
public class GearVRTrackedController : UnityEngine.InputSystem.XR.XRController
public class OculusTouchController : UnityEngine.InputSystem.XR.XRControllerWithRumble
public class HandedViveTracker : ViveTracker
Copy link
Contributor

Choose a reason for hiding this comment

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

medium
The base class ViveTracker is the only one in this list missing the UnityEngine.InputSystem.XR namespace prefix. If the API scraper provides fully qualified names (as it seems to for the other controllers like DaydreamController), this exclusion might not match and could fail to suppress the intended output. Please verify if it should be UnityEngine.InputSystem.XR.ViveTracker.

🤖 Helpful? 👍/👎

public class ViveWand : UnityEngine.InputSystem.XR.XRControllerWithRumble
")]
// API scraper in 1.0.0 emitted incomplete default argument expressions for these overloads.
[Property("Exclusions", @"1.0.0
Copy link
Contributor

Choose a reason for hiding this comment

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

low
There are now multiple separate [Property("Exclusions", ...)] attributes for version 1.0.0. While this helps organize them by the reason for exclusion, it repeats the version header and the property key. Have you considered consolidating these into a single block or using a more structured way to manage exclusions to reduce duplication and potential maintenance overhead when adding new versions?

🤖 Helpful? 👍/👎

@codecov-github-com
Copy link

codecov-github-com bot commented Mar 19, 2026

Codecov Report

All modified and coverable lines are covered by tests ✅

@@            Coverage Diff            @@
##           develop    #2391    +/-   ##
=========================================
  Coverage    77.90%   77.91%            
=========================================
  Files          476      482     +6     
  Lines        97613    97756   +143     
=========================================
+ Hits         76048    76168   +120     
- Misses       21565    21588    +23     
Flag Coverage Δ
inputsystem_Windows_2022.3_project 75.48% <ø> (-0.05%) ⬇️

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

Files with missing lines Coverage Δ
Assets/Tests/InputSystem/APIVerificationTests.cs 90.07% <ø> (+0.27%) ⬆️

... and 7 files with indirect coverage changes

@josepmariapujol-unity josepmariapujol-unity marked this pull request as draft March 19, 2026 12:23
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.

1 participant