Skip to content

Clean unit tests#2567

Open
anannya03 wants to merge 11 commits into
microsoft:mainfrom
anannya03:clean_unit_tests
Open

Clean unit tests#2567
anannya03 wants to merge 11 commits into
microsoft:mainfrom
anannya03:clean_unit_tests

Conversation

@anannya03
Copy link
Copy Markdown
Contributor

What does this PR do?

Several unit tests across the MCP Tools codebase (e.g., UpdateWorkbooksCommandTests, UpdateAlertsCommandTests, etc.) currently assert that tool descriptions or summaries exactly match hard-coded strings. These tests frequently fail when a description is reworded or improved for clarity, even though the tool’s behavior remains correct.

Any test that asserts the exact implementation of the unit under test is just repeating the logic of the unit in another place and doesn't really test anything.

This cleans up the tests and asserts that each description is less than 1024 characters.

GitHub issue number?

#788

Pre-merge Checklist

  • Required for All PRs
    • Read contribution guidelines
    • PR title clearly describes the change
    • Commit history is clean with descriptive messages (cleanup guide)
    • Added comprehensive tests for new/modified functionality
    • Created a changelog entry if the change falls among the following: new feature, bug fix, UI/UX update, breaking change, or updated dependencies. Follow the changelog entry guide
  • For MCP tool changes:
    • One tool per PR: This PR adds or modifies only one MCP tool for faster review cycles
    • Updated servers/Azure.Mcp.Server/README.md and/or servers/Fabric.Mcp.Server/README.md documentation
    • Validate README.md changes running the script ./eng/scripts/Process-PackageReadMe.ps1. See Package README
    • For new or modified tool descriptions, ran ToolDescriptionEvaluator and obtained a score of 0.4 or more and a top 3 ranking for all related test prompts
    • For tools with new names, including new tools or renamed tools, update consolidated-tools.json
    • For renamed tools, follow the Tool Rename Checklist and tag the PR with the breaking-change label
    • For new tools associated with Azure services or publicly available tools/APIs/products, add URL to documentation in the PR description
  • Extra steps for Azure MCP Server tool changes:
    • Updated command list in servers/Azure.Mcp.Server/docs/azmcp-commands.md
    • Ran ./eng/scripts/Update-AzCommandsMetadata.ps1 to update tool metadata in azmcp-commands.md (required for CI)
    • Updated test prompts in servers/Azure.Mcp.Server/docs/e2eTestPrompts.md
    • 👉 For Community (non-Microsoft team member) PRs:
      • Security review: Reviewed code for security vulnerabilities, malicious code, or suspicious activities before running tests (crypto mining, spam, data exfiltration, etc.)
      • Manual tests run: added comment /azp run mcp - pullrequest - live to run Live Test Pipeline

Comment on lines +33 to +34
Assert.NotEmpty(Command.Description);
Assert.NotNull(Command.Description);
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The order should be flipped here - check for not null first before checking for not empty.

Comment on lines +27 to +29
Assert.NotNull(Command.Description);
Assert.NotEmpty(Command.Description);
Assert.True(Command.Description.Length <= 1024, "Description should not exceed 1024 characters");
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We are doing the same check for Command.Description in all these tests. Is it possible to move this check to CommandUnitTestsBase?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Untriaged

Development

Successfully merging this pull request may close these issues.

4 participants