Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

added interaction csharp code #1958

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
harsha509 merged 5 commits into SeleniumHQ:trunk from rpallavisharma:interaction-pallavi
Sep 26, 2024

Conversation

@rpallavisharma
Copy link
Member

@rpallavisharma rpallavisharma commented Sep 22, 2024 •
edited
Loading

User description

Thanks for contributing to the Selenium site and documentation!
A PR well described will help maintainers to review and merge it quickly

Before submitting your PR, please check our contributing guidelines.
Avoid large PRs, and help reviewers by making them as simple and short as possible.

Description

added csharp code for interaction

Motivation and Context

code for csharp was put in example

Types of changes

  • Change to the site (I have double-checked the Netlify deployment, and my changes look good)
  • Code example added (and I also added the example to all translated languages)
  • Improved translation
  • Added new translation (and I also added a notice to each document missing translation)

Checklist

  • I have read the contributing document.
  • I have used hugo to render the site/docs locally and I am sure it works.

PR Type

enhancement, documentation

Description

  • Added a new C# test class InteractionsTest to demonstrate Selenium interactions.
  • Implemented a test method TestInteractions for navigation, title retrieval, and URL verification.
  • Updated documentation in multiple languages (English, Japanese, Portuguese, Chinese) to include new C# code examples for reading page title and current URL.

Changes walkthrough 📝

Relevant files
Enhancement
InteractionsTest.cs
Add C# interaction test example for Selenium

examples/dotnet/SeleniumDocs/Interactions/InteractionsTest.cs

  • Added a new C# test class InteractionsTest.
  • Implemented a test method TestInteractions to interact with Selenium.
  • Demonstrated navigation, title retrieval, and URL verification.
  • Included driver setup and teardown.
    • +48/-0
    Documentation
    _index.en.md
    Update C# interaction examples in English documentation

    website_and_docs/content/documentation/webdriver/interactions/_index.en.md

  • Updated C# code example for reading page title.
  • Updated C# code example for reading current URL.
    • +6/-2
    _index.ja.md
    Update C# interaction examples in Japanese documentation

    website_and_docs/content/documentation/webdriver/interactions/_index.ja.md

  • Updated C# code example for reading page title.
  • Updated C# code example for reading current URL.
    • +6/-2
    _index.pt-br.md
    Update C# interaction examples in Portuguese documentation

    website_and_docs/content/documentation/webdriver/interactions/_index.pt-br.md

  • Updated C# code example for reading page title.
  • Updated C# code example for reading current URL.
    • +6/-2
    _index.zh-cn.md
    Update C# interaction examples in Chinese documentation

    website_and_docs/content/documentation/webdriver/interactions/_index.zh-cn.md

  • Updated C# code example for reading page title.
  • Updated C# code example for reading current URL.
    • +6/-2

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    Copy link

    netlify bot commented Sep 22, 2024 •
    edited
    Loading

    👷 Deploy request for selenium-dev pending review.

    Visit the deploys page to approve it

    Name Link
    🔨 Latest commit bbece36

    @qodo-merge-pro qodo-merge-pro bot added documentation Improvements or additions to documentation enhancement New feature or request Review effort [1-5]: 2 labels Sep 22, 2024
    Copy link
    Contributor

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 PR contains tests
    🔒 No security concerns identified
    ⚡ Key issues to review

    Possible Bug
    The assertion for the URL might fail due to a trailing slash. The expected URL is "https://www.selenium.dev/" but the actual URL might be "https://www.selenium.dev" (without trailing slash).

    Resource Management
    The WebDriver instance is not properly disposed. Consider using a using statement or implementing IDisposable to ensure proper resource cleanup.

    Copy link
    Contributor

    PR Code Suggestions ✨

    CategorySuggestion Score
    Best practice
    Implement proper resource management using a using statement for the WebDriver

    Use using statement for WebDriver to ensure proper disposal of resources.

    examples/dotnet/SeleniumDocs/Interactions/InteractionsTest.cs [31-45] 

    -WebDriver driver = new ChromeDriver();
-driver.Manage().Timeouts().ImplicitWait = TimeSpan.FromMilliseconds(500);
+using (WebDriver driver = new ChromeDriver())
+{
+ driver.Manage().Timeouts().ImplicitWait = TimeSpan.FromMilliseconds(500);
+ 
+ // Navigate to Url
+ driver.Url="https://www.selenium.dev/";
+ ...
+ // No need to explicitly call Quit() as it will be handled by the using statement
+}
 
-// Navigate to Url
-driver.Url="https://www.selenium.dev/";
-...
-//quitting driver
-driver.Quit(); //close all windows
-
    Suggestion importance[1-10]: 9

    Why: Using a using statement ensures that the WebDriver is properly disposed of, which is a best practice for resource management and prevents potential memory leaks.

    		9
    Improve assertion readability and error messages by using the expected value as the first parameter

    Use Assert.AreEqual with expected value as the first parameter for consistency and
    better error messages.

    examples/dotnet/SeleniumDocs/Interactions/InteractionsTest.cs [38-42] 

    -Assert.AreEqual(title, "Selenium");
+Assert.AreEqual("Selenium", title, "Page title does not match expected value");
 ...
-Assert.AreEqual(url, "https://www.selenium.dev/");
+Assert.AreEqual("https://www.selenium.dev/", url, "Page URL does not match expected value");
    Suggestion importance[1-10]: 8

    Why: Placing the expected value first in assertions is a best practice that enhances readability and provides clearer error messages, which is beneficial for debugging.

    		8
    Maintainability
    Use a constant for the base URL to improve maintainability and reduce duplication

    Consider using a constant or configuration value for the base URL to improve
    maintainability.

    examples/dotnet/SeleniumDocs/Interactions/InteractionsTest.cs [35-42] 

    -driver.Url="https://www.selenium.dev/";
+const string BaseUrl = "https://www.selenium.dev/";
+driver.Url = BaseUrl;
 ...
-Assert.AreEqual(url, "https://www.selenium.dev/");
+Assert.AreEqual(BaseUrl, url, "Page URL does not match expected value");
    Suggestion importance[1-10]: 7

    Why: Using a constant for the base URL improves maintainability by reducing duplication and making it easier to update the URL in one place if needed.

    		7
    Enhancement
    Utilize string interpolation for URL assignment

    Use string interpolation for URL assignment to improve readability.

    examples/dotnet/SeleniumDocs/Interactions/InteractionsTest.cs [35] 

    -driver.Url="https://www.selenium.dev/";
+driver.Url = $"https://www.selenium.dev/";
    • Apply this suggestion
    Suggestion importance[1-10]: 3

    Why: While string interpolation can improve readability, in this case, it offers minimal benefit since the URL is a static string and does not require interpolation.

    		3

    💡 Need additional feedback ? start a PR chat

    Copy link
    Member

    @harsha509 harsha509 left a comment

    Choose a reason for hiding this comment

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

    Thank you @pallavigitwork !

    @harsha509 harsha509 merged commit 914d0c5 into SeleniumHQ:trunk Sep 26, 2024
    9 checks passed
    Copy link
    Member Author

    Thank you @harsha509 :)

    @rpallavisharma rpallavisharma deleted the interaction-pallavi branch September 27, 2024 12:09
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Reviewers

    @harsha509 harsha509 harsha509 approved these changes

    Assignees

    No one assigned

    Labels

    documentation Improvements or additions to documentation enhancement New feature or request Review effort [1-5]: 2

    Projects

    None yet

    Milestone

    No milestone

    Development

    Successfully merging this pull request may close these issues.

    AltStyle によって変換されたページ (->オリジナル) /