Validator tooling for InsightConnect integrations
Project description
InsightConnect Integrations Validators
Tooling with a bundled suite of validator rules for ensuring quality across Rapid7 InsightConnect integrations.
Installation
pip install insightconnect-integrations-validators
Use
Simple!
Command
icon-validate my_plugin_directory/
or
icon-validate my_plugin_directory/ --all
to run entire set of validators used in our CI.
Omitting --all
is often helpful when developing.
Python
from icon_validator.validate import validate
validate("/path/to/plugin/directory")
or
validate("/path/to/plugin/directory", run_all=True)
to simulate the --all
flag.
Changelog
- 2.16.0 - Add workflow description validator
- 2.15.0 - Fix issue in title validator, Add title validator for workflows, clean up requirements
- 2.14.0 - Fix issue where InputOutput validator would fail when missing required key
- 2.13.0 - Add screenshot validator
- 2.12.0 - Add validator to check that .icon filenames do not contain spaces
- 2.11.0 - Add PNG Hash validator
- 2.10.0 - Refactor of validate.py. Updates the validate method to use ValidationException and rework print statements to clean up unit testing
- 2.9.0 - Add unit testing support. Add support, workflow files, workflow vendor, workflow version, workflow changelog and workflow extension validators
- 2.8.1 - Bug fix for URLValidator when opening files
- 2.8.0 - Update ChangelogValidator to validate plugin's version history with latest version number | Update HelpInputOutputValidator error messaging
- 2.7.0 - Add URL Validator
- 2.6.9 - Update HelpInputOutputValidator to fix error messaging | Fix issue with HelpInputOutputValidator when help.md has action and trigger with same name
- 2.6.8 - Docker Validator to run with -a command line argument | Helpful message on failure
- 2.6.7 - Fix issue where OutputValidator was throwing error for plugins without any action
- 2.6.6 - Fix issue where HelpInputOutputValidator was not extracting complete output section of an action or trigger
- 2.6.5 - Update IconValidator to check for extension.png
- 2.6.4 - Remove invalid "JQ" entry from the Acronym Validator
- 2.6.3 - Update AcronymValidator and HelpValidator to skip validating example outputs of help.md
- 2.6.2 - Syntax error bug fix in validator order
- 2.6.1 - Fix issue where SSDEEP was listed as an acronym | Run the DockerValidator last
- 2.6.0 - Update to support workflow's help.md validation
- 2.5.0 - Add help input output validator
- 2.4.0 - Update to turn off ConfidentialValidator in code | Revised use case list for UseCase Validator
- 2.3.0 - Add changelog validator
- 2.2.0 - Using argparse module to handle arguments and provide -h option
- 2.1.6 - Fix issue where ID was an acronym
- 2.1.5 - Fix issue where confidential validator was not checking against provided whitelist
- 2.1.4 - Fix issue where confidential validator was triggering on remediated findings and updated formatting
- 2.1.3 - Update Exception Validator to throw warning
- 2.1.2 - Fix issue where resources validator would always raise an exception
- 2.1.1 - Update RequiredKeysValidator to validate the correct products key and empty resources keys
- 2.1.0 - Update Golang RegenerationValidator
- 2.0.2 - Update HelpValidator to fix error messaging
- 2.0.1 - Update UseCaseValidator valid use case list
- 2.0.0 - Update Help Validator to use new help format | Update RequiredKeys Validator for new spec fields | Add validator rule: use case validation
- 1.3.0 - Add --all flag to run entire set of validators, add Confidential Validator, Regeneration Validator clean up
- 1.2.0 - Add regeneration validator jenkins support
- 1.1.8 - Add regeneration validator
- 1.1.7 - Remove false positive "SPAM" entry from the Acronym Validator
- 1.1.6 - Improved Output validator
- 1.1.5 - Remove Makefile validator rule, fix rules import
- 1.1.4 - Move
rules
package insideicon_validator
- 1.1.3 - Ignore unit test directories (/unit_test & /unit_tests) in Exception Validator
- 1.1.2 - Fix for Acronym and Output validators
- 1.1.1 - Removed breaking changes to Makefile validator
- 1.1.0 - Add validator rules: check for help.md, profanity check,
acronym capitalization check,
print
usage check, JSON tests, exceptions, credentials, passwords | Updated rules: Makefiles, logging - 1.0.0 - Initial release
PyPi.org link: https://pypi.org/project/insightconnect-integrations-validators/
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for insightconnect_integrations_validators-2.16.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f460eae592f5e89af0b5f51dc580cb489195bbf234d38778be8c50abdc3a23df |
|
MD5 | 8e20a29ab0e47b4b34a47cd75be3b357 |
|
BLAKE2b-256 | c94f348d300b9a7bb26694792a046801fca32021f681bb6ad25acd2d8dc81b78 |
Close
Hashes for insightconnect_integrations_validators-2.16.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b04d3c5d20027f91ec8d94eb9f04d952350b55d9b3db3c9550584bbc3743753a |
|
MD5 | 59d493b932dc0751da732e9b90752028 |
|
BLAKE2b-256 | eeff955517c2b4017ed8ca00a3bc954eb60260acc2435bd284ca70f0c5b3246c |