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

Update Microsoft.TestPlatform.ObjectModel for dependabot #257

Merged
merged 2 commits into from
May 24, 2024

Conversation

CoryCharlton
Copy link
Member

@CoryCharlton CoryCharlton commented May 23, 2024

Description

  • Update Microsoft.TestPlatform.ObjectModel to 17.10.0 per dependabot
  • Update Nerdbank.GitVersioning to 3.6.133 (was already being used in nanoFramework.TestFramework)

Motivation and Context

dependabot tried to update Microsoft.TestPlatform.ObjectModel to 17.10.0 but the build failed so this resolves that.

There is a warning that says not to update CliWrap but the issue is actually related to ICSharpCode.Decompiler so I updated the warning.

How Has This Been Tested?

Manually. Unit tests.

Screenshots

Types of changes

  • Improvement (non-breaking change that improves a feature, code or algorithm)
  • Bug fix (non-breaking change which fixes an issue with code or algorithm)
  • New feature (non-breaking change which adds functionality to code)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Config and build (change in the configuration and build system, has no impact on code or features)
  • Dependencies (update dependencies and changes associated, has no impact on code or features)
  • Unit Tests (add new Unit Test(s) or improved existing one(s), has no impact on code or features)
  • Documentation (changes or updates in the documentation, has no impact on code or features)

Checklist:

  • My code follows the code style of this project (only if there are changes in source code).
  • My changes require an update to the documentation (there are changes that require the docs website to be updated).
  • I have updated the documentation accordingly (the changes require an update on the docs in this repo).
  • I have read the CONTRIBUTING document.
  • I have tested everything locally and all new and existing tests passed (only if there are changes in source code).
  • I have added new tests to cover my changes.

Summary by CodeRabbit

  • Documentation

    • Updated README to caution against updating ICSharpCode.Decompiler beyond version 7.2.1.6856 due to potential issues with VS Test Explorer.
  • Chores

    • Updated dependencies to the latest versions for improved stability and performance.

Copy link

coderabbitai bot commented May 23, 2024

Walkthrough

The changes involve updating dependency versions and adding a cautionary note. The README now warns against updating ICSharpCode.Decompiler beyond a specific version due to compatibility issues. In packages.lock.json, various dependencies like Microsoft.TestPlatform.ObjectModel and Nerdbank.GitVersioning have had their versions and content hashes updated.

Changes

File Path Change Summary
source/TestAdapter/README-BEFORE-UPDATING-REFS.txt Updated warning about potential issues with ICSharpCode.Decompiler beyond version 7.2.1.6856.
source/TestAdapter/packages.lock.json Updated versions and content hashes for dependencies like Microsoft.TestPlatform.ObjectModel, Nerdbank.GitVersioning.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between b52c518 and 95b5b84.
Files ignored due to path filters (1)
  • source/TestAdapter/nanoFramework.TestAdapter.csproj is excluded by none and included by none
Files selected for processing (2)
  • source/TestAdapter/README-BEFORE-UPATING-REFS.txt (1 hunks)
  • source/TestAdapter/packages.lock.json (5 hunks)
Additional Context Used
LanguageTool (2)
source/TestAdapter/README-BEFORE-UPATING-REFS.txt (2)

Near line 8: Possible missing article found.
Context: ...pens because of a nested dependency on System.Runtime.CompilerServices.Unsafe. Movin...


Near line 12: Possible missing comma found.
Context: ...nd this version requires testing this. Reported and it's a know issue with vstest. See:...

Additional comments not posted (4)
source/TestAdapter/packages.lock.json (4)

7-9: Update to CliWrap version 3.6.6 looks correct and aligns with the PR objectives.

Also applies to: 11-11


30-32: Update to Microsoft.TestPlatform.ObjectModel version 17.10.0 is correctly reflected.


50-52: Update to Nerdbank.GitVersioning version 3.6.133 is accurately updated.


67-68: Update to Microsoft.Bcl.AsyncInterfaces version 8.0.0 is correctly reflected.

source/TestAdapter/README-BEFORE-UPATING-REFS.txt Outdated Show resolved Hide resolved
source/TestAdapter/README-BEFORE-UPATING-REFS.txt Outdated Show resolved Hide resolved
@CoryCharlton
Copy link
Member Author

@josesimoes you made the original report regarding CliWrap and System.Runtime.CompilerServices.Unsafe so can you use the POC NFUnit Test DemoByReference to confirm that everything is still working as expected? Form my testing the error only occurred when I updated ICSharpCode.Decompiler (I'll investigate that later)

@josesimoes
Copy link
Member

@CoryCharlton I'm pretty sure that the assembly causing issues is System.Runtime.CompilerServices.Unsafe, which is referenced by CliWrap. See here:

image

If you get past v3.6.1 it won't be able to load the test adpater and the VS Test explorer will fail to load tests and run them. Also there is an issue when running this on AZDO pipeline, which is using the CLI version of the VS framework.
I've bumped into this twice. And the second time I ended adding that note on the README to save me from wasting time again chasing it (which I should have done the 1st time I've bumped into it).

Feel free to double check, but this has been reported a number of times elsewhere, e.g.:
microsoft/vstest#4775
microsoft/vstest#4673
https://discord.com/channels/869237470565392384/1105892245804158977/1105892547190075544

@josesimoes
Copy link
Member

On the dependabot update: yes, that's a know (and old issue) it fails to properly update projects that are using package.lock.json files. That has been reported to their team a long time ago and still hasn't been addressed... 🤷🏻‍♂️ so all updates like that one require a manual run to properly update it.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 95b5b84 and 6319ccb.
Files ignored due to path filters (1)
  • source/TestAdapter/nanoFramework.TestAdapter.csproj is excluded by none and included by none
Files selected for processing (1)
  • source/TestAdapter/packages.lock.json (3 hunks)
Files skipped from review as they are similar to previous changes (1)
  • source/TestAdapter/packages.lock.json

@CoryCharlton
Copy link
Member Author

@CoryCharlton I'm pretty sure that the assembly causing issues is System.Runtime.CompilerServices.Unsafe, which is referenced by CliWrap. See here:

image If you get past v3.6.1 it won't be able to load the test adpater and the VS Test explorer will fail to load tests and run them. Also there is an issue when running this on AZDO pipeline, which is using the CLI version of the VS framework. I've bumped into this twice. And the second time I ended adding that note on the README to save me from wasting time again chasing it (which I should have done the 1st time I've bumped into it).

Feel free to double check, but this has been reported a number of times elsewhere, e.g.: microsoft/vstest#4775 microsoft/vstest#4673 https://discord.com/channels/869237470565392384/1105892245804158977/1105892547190075544

At first glance it seemed like the issue was that ICSharpCode.Decompiler also pulls in System.Runtime.CompilerServices.Unsafe in the latest version and that's what causes the issue.

Either way I didn't have time to dig deeper and there doesn't seem to be a need to update CliWrap currently so I reverted that update.

@josesimoes josesimoes merged commit bb8085e into nanoframework:main May 24, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants