idem-resources-validation 1.0.0

Validation tools and tests for IDEM resources

Resources schemas validation plugin tool.

About

idem-resources-validation performs different validations on the IDEM plugins’ schemas using idem.

• idem-resources-validation source code:

What is POP?

This project is built with pop, a Python-based implementation of Plugin Oriented Programming (POP). POP seeks to bring together concepts and wisdom from the history of computing in new ways to solve modern computing problems.

For more information:

• Intro to Plugin Oriented Programming (POP)

• pop-awesome

• pop-create

What is Idem?

This project is built with idem, an idempotent, imperatively executed, declarative programming language written in Python. This project extends idem!

For more information:

• Idem Project Website

• Idem Project docs portal

Getting Started

Prerequisites

• Python 3.7+

• git (if installing from source, or contributing to the project)

Installation

Note

If wanting to contribute to the project, and setup your local development environment, see the CONTRIBUTING.rst document in the source repository for this project.

If wanting to use idem-resources-validation, you can do so by either installing from PyPI or from source.

Install from PyPI

pip install idem-resources-validation

Install from source

Clone the idem-resources-validation repository.

git clone [e-mail]:vmware/idem/idem-resources-validation.git
cd idem-resources-validation

Create a virtual environment, and then activate it:

python3 -m venv .venv
source .venv/bin/activate

Install idem-resources-validation and other base requirements:

pip3 install -e .
pip3 install -r requirements/base.txt

Install the following packages in order to run the tests:

pip3 install -r requirements/py3.10/tests.txt

NOTE: Change py3.10 if needed with your Python version. There is support for py3.8, py3.9, py3.10 and py3.11.

Setup

After installation the validations execution module will be accessible to the pop hub. You can provide your custom config file with the specific plugin properties. Plugin config properties file can be found in the idem-resources-validation repo under tests/plugins dir.

export PLUGIN_CONFIG_FILE=./tests/plugins/idem-aws-example.json
idem exec resources_validator.schema.checkers.validate_schema