Giter VIP home page Giter VIP logo

qatoolkit-core-net's Introduction

QAToolKit Core library

Build .NET Library CodeQL Sonarcloud Quality gate NuGet package Discord

Description

QAToolKit.Core is a .NET Standard 2.1 library, that contains core objects and functions of the toolkit. It's normally not used as a standalone library but is a dependency for other QAToolKit libraries.

Supported .NET frameworks and standards: netstandard2.0, netstandard2.1, netcoreapp3.1, net8.0

Get in touch with me on:

Discord

1. HttpRequest functions

HttpRequest object is one of the main objects that is shared among the QA Toolkit libraries. QAToolKit.Core library contains HttpRequestTools which can manipulate the HttpRequest object.

For example URL, header and Body generators: HttpRequestUrlGenerator, HttpRequestBodyGenerator and HttpRequestHeaderGenerator.

1.1. HttpRequestUrlGenerator

This is a method that will accept key/value pairs for replacement of placeholders in the HttpRequest object. Replacement object are stored in a dictionary, which prevents mistakes with duplicated keys. Also dictionary keys are case insensitive when looking for values to replace.

options.AddReplacementValues(new Dictionary<string, object> {
    {
        "version",
        "1"
    },
    {
        "parentId",
        "4"
    }
});

In the example above we say: "Replace {version} and {parentId} placeholders in Path and URL parameters and JSON body models."

In other words, if you have a test API endpoint like this: https://api.demo.com/v{version}/categories?parent={parentId} that will be set to https://api.demo.com/v1/categories?parent=4.

That, does not stop there, you can also populate JSON request bodies.

1.2. HttpRequestBodyGenerator

For example if you set the replacement value to stringified json:

options.AddReplacementValues(new Dictionary<string, object> {
    {
        "id",
        "100"
    },
    {
        "category",
        "{\"id\":1,\"name\":\"dog\"}"
    }
});

than the parent model object will be replaced with the stringified json above.

What happend behind the curtains, the model proxy class is generated, which is then used to Deserialized the JSON into the object. HttpRequest list is then scanned and values are properly replaced.

1.3. HttpRequestHeaderGenerator

To-do

To-do

  • This library is an early alpha version
  • HttpRequestHeaderGenerator is missing implementation.
  • HttpRequestBodyGenerator need to cover the whole spectrum of object tipes. Currently it's missing arrays, and nested objects. It's on the priority list.

License

MIT License

Copyright (c) 2020-2024 Miha Jakovac Supported .NET frameworks and standards: netstandard2.0, netstandard2.1, net8.0 Copyright (c) 2020-2024 Miha Jakovac

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

qatoolkit-core-net's People

Contributors

mihaj avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.