Linter for Mistral Workflows
Project description
Usage
$ pip install mistral-lint $ mistral-lint path-to-files
Reviewing a review in OpenStack’s gerrit? We got you.
$ mistral-lint --review $GERRIT_REVIEW_ID
If you add –diff it will compare the patch to its parent commit, making it easier to see what changed. For example:
$ mistral-lint --diff --review 428178 +E101: Input flavor_list is not used in Workflow tripleo.validations.v1.collect_flavors +W102: Workflow tripleo.validations.v1.collect_flavors has no description
Current Linters
These are the current linters that are included.
W101 & W102 Description
Checks that each workbook and workflow has a description.
W103 type
Checks the workflow type, if “direct” is given it gives a warning that it isn’t needed
E101 inputs
Checks that workflow inputs are used.
E102 task exists
Check that tasks are defined in the workflow when they are used in on-success, on-error or on-complete
E103, E104, E105 expressions
Checks that expressions have a matching number of opening and closing brackets. Validates YAML and Jinja2 expressions with the library parsers.
Example Output
workbooks/baremetal.yaml W102: Workflow tripleo.baremetal.v1.set_node_state has no description W102: Workflow tripleo.baremetal.v1.set_power_state has no description W102: Workflow tripleo.baremetal.v1.manual_cleaning has no description E103: Input node_uuids is not used in Workflow tripleo.baremetal.v1.cellv2_discovery workbooks/deployment.yaml W102: Workflow tripleo.deployment.v1.deploy_on_server has no description W102: Workflow tripleo.deployment.v1.deploy_on_servers has no description workbooks/plan_management.yaml W102: Workflow tripleo.plan_management.v1.create_deployment_plan has no description W102: Workflow tripleo.plan_management.v1.update_deployment_plan has no description W102: Workflow tripleo.plan_management.v1.create_default_deployment_plan has no description workbooks/stack.yaml W102: Workflow tripleo.stack.v1.wait_for_stack_complete_or_failed has no description W102: Workflow tripleo.stack.v1.wait_for_stack_in_progress has no description W102: Workflow tripleo.stack.v1.wait_for_stack_does_not_exist has no description W102: Workflow tripleo.stack.v1.delete_stack has no description workbooks/validations.yaml W102: Workflow tripleo.validations.v1.run_validation has no description W102: Workflow tripleo.validations.v1.run_validations has no description W102: Workflow tripleo.validations.v1.run_groups has no description W102: Workflow tripleo.validations.v1.list has no description W102: Workflow tripleo.validations.v1.list_groups has no description W102: Workflow tripleo.validations.v1.add_validation_ssh_key_parameter has no description W102: Workflow tripleo.validations.v1.copy_ssh_key has no description E103: Input queue_name is not used in Workflow tripleo.validations.v1.add_validation_ssh_key_parameter
Ideas
Check that tasks exist (all those that are mentined in on-error, on-success on-complete etc.).
Check all tasks are called.
Check all tasks have an on-error/on-success or on-complete
Check zaqar format
Interactive workflow with zaqar posting the continue code.
Check sub-workflows are provided the queue name
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
File details
Details for the file mistral-lint-0.2.1.tar.gz
.
File metadata
- Download URL: mistral-lint-0.2.1.tar.gz
- Upload date:
- Size: 9.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 623a7bbad26558eb9b887038677832ac2236a28a667681b3492f98b03e51c0fc |
|
MD5 | 2774b22315d51da6c786c4b19ff3126d |
|
BLAKE2b-256 | 23ee5faa5ad46e4fe1043157c09418c008c5c8443d73e39f4940655701395d7d |
File details
Details for the file mistral_lint-0.2.1-py2.py3-none-any.whl
.
File metadata
- Download URL: mistral_lint-0.2.1-py2.py3-none-any.whl
- Upload date:
- Size: 11.3 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9cb9cfcbe3b6ab8a03b9660193ca9d7c0bebbd50fc0aa523db32f471461237b6 |
|
MD5 | 63754a2a431181ad6b073ef2e6f2c394 |
|
BLAKE2b-256 | e8f1f6c3db7eb288650aeb4467cdc7aee681aa7a26be973618e79e72b9ab7c67 |