XPing365.Availability 1.0.0-rc5

<div id="top"></div>

<br /> <div align="center"> <h2 align="center">XPing365 SDK</h3> <p align="center"> <b>XPing365 SDK</b> is a free and open-source .NET library written in C# to help automate Web Application or Web API testing. <br /> <br /> <a href="https://github.com/XPing365/xping365-sdk/issues">Report Bug</a> · <a href="https://github.com/XPing365/xping365-sdk/issues">Request Feature</a> </p> </div>

<details> <summary>Table of Contents</summary> <ol> <li><a href="#about-the-project">About The Project</a></li> <li><a href="#getting-started">Getting Started</a> <ul> <li><a href="#installation-using-.net-cli">Installation using .NET CLI</a></li> </ul> </li> <li><a href="#usage">Usage</a></li> <li><a href="#roadmap">Roadmap</a></li> <li><a href="#contributing">Contributing</a></li> <li><a href="#license">License</a></li> </ol> </details>

About The Project

<b>XPing365 SDK</b> provides a set of tools to make it easy to write automated tests for Web Application and Web API, as well as troubleshoot issues that may arise during testing. The library provides a number of features to verify that the Web Application is functioning correctly, such as checking that the correct data is displayed on a page or that the correct error messages are displayed when an error occurs.

The library is called <b>XPing365</b>, which stands for eXternal Pings, and is used to verify the availability of a server and monitor its content.

You can find more information about the library, including documentation and examples, on the official website <a href="https://www.xping365.com">xping365.com</a>.

<p align="right">(<a href="#top">back to top</a>)</p>

Getting Started

The library is distributed as a NuGet packages, which can be installed using the .NET CLI command dotnet add package. Here are the steps to get started:

Installation using .NET CLI

1. Open a command prompt or terminal window.

2. Navigate to the directory where your project is located.

3. Run the following command to install the <b>XPing365</b> NuGet package:

   dotnet add package XPing365.Availability
   

4. Once the package is installed, you can start using the <b>XPing365</b> library in your project.

using XPing365.Availability.Extensions;

Host.CreateDefaultBuilder()
    .ConfigureServices(services =>
    {
        services.AddAvailabilityTestAgent();
    });

using XPing365.Availability

var testAgent = _serviceProvider.GetRequiredService<AvailabilityTestAgent>();

TestSession session = await testAgent
    .RunAsync(
        new Uri("www.demoblaze.com"),
        TestSettings.DefaultForAvailability)
    .ConfigureAwait(false);

That’s it! You’re now ready to start automating your web application tests and monitoring your server’s content using <b>XPing365</b>.

<p align="right">(<a href="#top">back to top</a>)</p>

Usage

For more examples, please refer to the Samples folder in this repository.

<p align="right">(<a href="#top">back to top</a>)</p>

Roadmap

• Support fetching web-pages through headless web browser.
• Support content validation through XPath expressions.

See the open issues for a full list of proposed features (and known issues).

<p align="right">(<a href="#top">back to top</a>)</p>

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

<p align="right">(<a href="#top">back to top</a>)</p>

License

Distributed under the MIT License. See LICENSE file for more information.

<p align="right">(<a href="#top">back to top</a>)</p>