robotframework-assertion-engine

v3.0.3

Generic way to create meaningful and easy to use assertions for the Robot Framework libraries. For more information about how to use this package see README

Latest version published 12 months ago

License: Apache-2.0

PyPI

GitHub

Package Health Score

68 / 100

security
No known security issues
popularity
Recognized
maintenance
Sustainable
community
Limited

Popularity

Recognized

GitHub Stars: 10
Forks: 5
Contributors: 6

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package robotframework-assertion-engine, we found that it has been starred 10 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Nov 21, 2023
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

Apache-2.0

Security Policy

We found a way for you to contribute to the project! Looks like robotframework-assertion-engine is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Sustainable

Commit Frequency

Open Issues: 1
Open PR: 0
Last Release: 12 months ago
Last Commit: 9 days ago

Further analysis of the maintenance status of robotframework-assertion-engine based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that robotframework-assertion-engine demonstrates a positive version release cadence with at least one new version released in the past 12 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Limited

Readme: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 6
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like robotframework-assertion-engine is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.8.1,<4.0

Age: 4 years
Latest Release: 12 months ago
Dependencies: 2 Direct
Versions: 23
Maintainers: 3
Wheels: OS Independent

Readme

Assertion Engine

Generic way to create meaningful and easy to use assertions for the Robot Framework libraries. This tools is spin off from Browser library project, where the Assertion Engine was developed as part of the of library.

Supported Assertions

Currently supported assertion operators are:

Operator	Alternative Operators	Description	Validate Equivalent
==	equal, equals, should be	Checks if returned value is equal to expected value.	value == expected
!=	inequal, should not be	Checks if returned value is not equal to expected value.	value != expected
>	greater than	Checks if returned value is greater than expected value.	value > expected
>=		Checks if returned value is greater than or equal to expected value.	value >= expected
<	less than	Checks if returned value is less than expected value.	value < expected
<=		Checks if returned value is less than or equal to expected value.	value <= expected
*=	contains	Checks if returned value contains expected value as substring.	expected in value
	not contains	Checks if returned value does not contain expected value as substring.	expected not in value
^=	should start with, starts	Checks if returned value starts with expected value.	re.search(f"^{expected}", value)
$=	should end with, ends	Checks if returned value ends with expected value.	re.search(f"{expected}$", value)
matches		Checks if given RegEx matches minimum once in returned value.	re.search(expected, value)
validate		Checks if given Python expression evaluates to True.
evaluate	then	When using this operator, the keyword does return the evaluated Python expression.

Supported formatters:

Formatter	Description
normalize spaces	Substitutes multiple spaces to single space from the value
strip	Removes spaces from the beginning and end of the value
apply to expected	Applies rules also for the expected value
case insensitive	Converts value to lower case

Usage

When library developers wants to do an assertion inline with the keyword call, then AssertionEngine provides automatic validation within single keyword call. Keyword method should get value, example from page, database or from anything which the library interacts and then use verify_assertion method from AssertionEngine to perform the validation. The verify_assertion methods needs three things to perform the assertion: value from the system, assertion_operator how the validation is performed and assertion_expected which represent the expected value. It is also possible to provide custom error message and prefix the default error message.

Example library can contain keyword:

def keyword(
    arg_to_get_value: str,
    assertion_operator: Optional[AssertionOperator] = None,
    assertion_expected: Any = None,
    message: str = None,
):
    value = method_to_get_value(arg_to_get_value)
    return verify_assertion(
        value,
        assertion_operator,
        assertion_expected,
        "Prefix message",
        message,
    )

AssertionEngine provides an interface to define scope for the formatters, but because scoping is a library specific implementation, it is up to the library to decide how scoping is actually implemented. AssertionEngine Formatter class is an ABC which provides get_formatter and set_formatter interface methods for library developers. The AssertionEngine atest libraries has examples how interface can be implemented in practice.

robotframework-assertion-engine dependencies

robotframework robotframework-pythonlibcore

FAQs

What is robotframework-assertion-engine?

Generic way to create meaningful and easy to use assertions for the Robot Framework libraries. Visit Snyk Advisor to see a full health score report for robotframework-assertion-engine, including popularity, security, maintenance & community analysis.

Is robotframework-assertion-engine popular?

The python package robotframework-assertion-engine receives a total of 40,039 weekly downloads. As such, robotframework-assertion-engine popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is robotframework-assertion-engine well maintained?

We found indications that robotframework-assertion-engine maintenance is sustainable demonstrating some project activity. We saw a total of 6 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is robotframework-assertion-engine safe to use?

The python package robotframework-assertion-engine was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 12 November-2024, at 04:06 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP