salt icon indicating copy to clipboard operation
salt copied to clipboard

Move integration test system pytest

Open garethgreenaway opened this issue 3 years ago • 0 comments

What does this PR do?

Move integration test system pytest

Merge requirements satisfied?

[NOTICE] Bug fixes or features added to Salt require tests.

  • [ ] Docs
  • [ ] Changelog - https://docs.saltproject.io/en/master/topics/development/changelog.html
  • [x] Tests written/updated

Commits signed with GPG?

Yes/No

Please review Salt's Contributing Guide for best practices.

See GitHub's page on GPG signing for more information about signing commits with GPG.

garethgreenaway avatar Jun 29 '22 22:06 garethgreenaway

Hi! I'm your friendly PR bot!

You might be wondering what I'm doing commenting here on your PR.

Yes, as a matter of fact, I am...

I'm just here to help us improve the documentation. I can't respond to questions or anything, but what I can do, I do well!

Okay... so what do you do?

I detect modules that are missing docstrings or "CLI Example" on existing docstrings! When I was created we had a lot of these. The documentation for these modules need some love and attention to make Salt better for our users.

So what does that have to do with my PR?

I noticed that in this PR there are some files changed that have some of these issues. So I'm leaving this comment to let you know your options.

Okay, what are they?

Well, my favorite, is that since you were making changes here I'm hoping that you would be the most familiar with this module and be able to add some other examples or fix any of the reported issues.

If I can, then what?

Well, you can either add them to this PR or add them to another PR. Either way is fine!

Well... what if I can't, or don't want to?

That's also fine! We appreciate all contributions to the Salt Project. If you can't add those other examples, either because you're too busy, or unfamiliar, or you just aren't interested, we still appreciate the contributions that you've made already.

Whatever approach you decide to take, just drop a comment here letting us know!

Detected Issues (click me)
Check Known Missing Docstrings...........................................Failed
- hook id: invoke
- exit code: 1

/home/runner/.cache/pre-commit/repos4spui9r/py_env-python3/lib/python3.9/site-packages/_distutils_hack/init.py:33: UserWarning: Setuptools is replacing distutils. warnings.warn("Setuptools is replacing distutils.") The function 'expand_repo_def' on 'salt/modules/aptpkg.py' does not have a 'CLI Example:' in its docstring The function 'setup_handlers' on 'salt/log_handlers/log4mongo_mod.py' does not have a docstring The function 'get_os_version_info' on 'salt/utils/win_osinfo.py' does not have a docstring The function 'load' on 'salt/utils/yamlloader.py' does not have a docstring The function 'split_username' on 'salt/utils/win_runas.py' does not have a docstring The function 'get_connection' on 'salt/modules/netmiko_mod.py' does not have a 'CLI Example:' in its docstring The function 'call' on 'salt/modules/netmiko_mod.py' does not have a 'CLI Example:' in its docstring The function 'multi_call' on 'salt/modules/netmiko_mod.py' does not have a 'CLI Example:' in its docstring The function 'get_conn' on 'salt/utils/etcd_util.py' was previously known to not have a docstring, which is no longer the case. Please remove it from 'MISSING_DOCSTRINGS' .in 'tasks/docstrings.py' The function 'tree' on 'salt/utils/etcd_util.py' was previously known to not have a docstring, which is no longer the case. Please remove it from 'MISSING_DOCSTRINGS' .in 'tasks/docstrings.py' The function 'render_jinja' on 'salt/utils/saltclass.py' does not have a docstring The function 'render_yaml' on 'salt/utils/saltclass.py' does not have a docstring The function 'get_class' on 'salt/utils/saltclass.py' does not have a docstring The function 'get_env_from_dict' on 'salt/utils/saltclass.py' does not have a docstring The function 'dict_merge' on 'salt/utils/saltclass.py' does not have a docstring The function 'dict_search_and_replace' on 'salt/utils/saltclass.py' does not have a docstring The function 'find_value_to_expand' on 'salt/utils/saltclass.py' does not have a docstring The function 'find_and_process_re' on 'salt/utils/saltclass.py' does not have a docstring The function 'expand_variables' on 'salt/utils/saltclass.py' does not have a docstring The function 'expand_classes_in_order' on 'salt/utils/saltclass.py' does not have a docstring The function 'expanded_dict_from_minion' on 'salt/utils/saltclass.py' does not have a docstring The function 'get_pillars' on 'salt/utils/saltclass.py' does not have a docstring The function 'get_tops' on 'salt/utils/saltclass.py' does not have a docstring The function 'make_con' on 'salt/proxy/netmiko_px.py' does not have a docstring The function 'connection' on 'salt/proxy/netmiko_px.py' does not have a docstring The function 'nesthash' on 'salt/modules/virt.py' does not have a 'CLI Example:' in its docstring The function 'init' on 'salt/modules/virt.py' does not have a 'CLI Example:' in its docstring The function 'node_devices' on 'salt/modules/virt.py' does not have a 'CLI Example:' in its docstring The function 'network_update' on 'salt/modules/virt.py' does not have a 'CLI Example:' in its docstring The function 'pool_update' on 'salt/modules/virt.py' does not have a 'CLI Example:' in its docstring The function 'get_filter_pillar' on 'salt/modules/napalm_netacl.py' does not have a 'CLI Example:' in its docstring The function 'get_term_pillar' on 'salt/modules/napalm_netacl.py' does not have a 'CLI Example:' in its docstring The function 'jinja_raise' on 'salt/utils/jinja.py' does not have a docstring The function 'regex_escape' on 'salt/utils/jinja.py' does not have a docstring The function 'method_call' on 'salt/utils/jinja.py' does not have a docstring The function 'show_full_context' on 'salt/utils/jinja.py' does not have a docstring The function 'path_depth' on 'salt/utils/find.py' does not have a docstring The function 'to_salt_event' on 'salt/beacons/watchdog.py' does not have a docstring The function 'close' on 'salt/beacons/watchdog.py' does not have a docstring The function 'create_deployment' on 'salt/modules/kubernetesmod.py' does not have a 'CLI Example:' in its docstring The function 'create_pod' on 'salt/modules/kubernetesmod.py' does not have a 'CLI Example:' in its docstring The function 'create_service' on 'salt/modules/kubernetesmod.py' does not have a 'CLI Example:' in its docstring The function 'replace_deployment' on 'salt/modules/kubernetesmod.py' does not have a 'CLI Example:' in its docstring The function 'replace_service' on 'salt/modules/kubernetesmod.py' does not have a 'CLI Example:' in its docstring The function 'verify_logs_filter' on 'salt/utils/verify.py' was previously known to not have a docstring, which is no longer the case. Please remove it from 'MISSING_DOCSTRINGS' .in 'tasks/docstrings.py' The function 'get_resource' on 'salt/modules/pagerduty_util.py' does not have a 'CLI Example:' in its docstring The function 'create_or_update_resource' on 'salt/modules/pagerduty_util.py' does not have a 'CLI Example:' in its docstring The function 'delete_resource' on 'salt/modules/pagerduty_util.py' does not have a 'CLI Example:' in its docstring The function 'resource_present' on 'salt/modules/pagerduty_util.py' does not have a 'CLI Example:' in its docstring The function 'resource_absent' on 'salt/modules/pagerduty_util.py' does not have a 'CLI Example:' in its docstring The function 'represent_ordereddict' on 'salt/utils/yamldumper.py' does not have a docstring The function 'represent_undefined' on 'salt/utils/yamldumper.py' does not have a docstring The function 'get_dumper' on 'salt/utils/yamldumper.py' does not have a docstring The function 'ext_pillar' on 'salt/pillar/stack.py' does not have a docstring The function 'wrap_tmpl_func' on 'salt/utils/templates.py' was previously known to not have a docstring, which is no longer the case. Please remove it from 'MISSING_DOCSTRINGS' .in 'tasks/docstrings.py' The function 'render_jinja_tmpl' on 'salt/utils/templates.py' was previously known to not have a docstring, which is no longer the case. Please remove it from 'MISSING_DOCSTRINGS' .in 'tasks/docstrings.py' The function 'render_mako_tmpl' on 'salt/utils/templates.py' was previously known to not have a docstring, which is no longer the case. Please remove it from 'MISSING_DOCSTRINGS' .in 'tasks/docstrings.py' The function 'render_wempy_tmpl' on 'salt/utils/templates.py' was previously known to not have a docstring, which is no longer the case. Please remove it from 'MISSING_DOCSTRINGS' .in 'tasks/docstrings.py' The function 'get_error' on 'salt/utils/boto3mod.py' does not have a docstring The function 'exactly_one' on 'salt/utils/boto3mod.py' does not have a docstring The function 'ordered' on 'salt/utils/boto3mod.py' does not have a docstring The function 'check_nova' on 'salt/utils/openstack/nova.py' does not have a docstring The function 'get_entry' on 'salt/utils/openstack/nova.py' does not have a docstring The function 'get_entry_multi' on 'salt/utils/openstack/nova.py' does not have a docstring The function 'get_endpoint_url_v3' on 'salt/utils/openstack/nova.py' does not have a docstring The function 'sanatize_novaclient' on 'salt/utils/openstack/nova.py' does not have a docstring The function 'check_neutron' on 'salt/utils/openstack/neutron.py' does not have a docstring The function 'check_keystone' on 'salt/utils/openstack/neutron.py' does not have a docstring The function 'sanitize_neutronclient' on 'salt/utils/openstack/neutron.py' does not have a docstring The function 'create' on 'salt/modules/boto_elb.py' does not have a 'CLI Example:' in its docstring The function 'delete' on 'salt/modules/boto_elb.py' does not have a 'CLI Example:' in its docstring The function 'set_attributes' on 'salt/modules/boto_elb.py' does not have a 'CLI Example:' in its docstring The function 'set_health_check' on 'salt/modules/boto_elb.py' does not have a 'CLI Example:' in its docstring The function 'delete_alarm' on 'salt/modules/boto_cloudwatch.py' does not have a 'CLI Example:' in its docstring The function 'set_volumes_tags' on 'salt/modules/boto_ec2.py' does not have a 'CLI Example:' in its docstring The function 'start' on 'salt/engines/junos_syslog.py' does not have a docstring The function 'describe_cache_clusters' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'cache_cluster_exists' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'create_cache_cluster' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'modify_cache_cluster' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'delete_cache_cluster' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'describe_replication_groups' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'replication_group_exists' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'create_replication_group' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'modify_replication_group' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'delete_replication_group' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'describe_cache_subnet_groups' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'cache_subnet_group_exists' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'list_cache_subnet_groups' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'create_cache_subnet_group' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'modify_cache_subnet_group' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'delete_cache_subnet_group' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'describe_cache_security_groups' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'cache_security_group_exists' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'create_cache_security_group' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'delete_cache_security_group' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'authorize_cache_security_group_ingress' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'revoke_cache_security_group_ingress' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'list_tags_for_resource' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'add_tags_to_resource' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'remove_tags_from_resource' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'copy_snapshot' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'describe_cache_parameter_groups' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'create_cache_parameter_group' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'delete_cache_parameter_group' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'lock_holders' on 'salt/modules/zk_concurrency.py' does not have a 'CLI Example:' in its docstring The function 'lock' on 'salt/modules/zk_concurrency.py' does not have a 'CLI Example:' in its docstring The function 'unlock' on 'salt/modules/zk_concurrency.py' does not have a 'CLI Example:' in its docstring The function 'party_members' on 'salt/modules/zk_concurrency.py' does not have a 'CLI Example:' in its docstring The function 'signal_event' on 'salt/cloud/clouds/profitbricks.py' does not have a docstring The function 'load' on 'salt/utils/yamlloader_old.py' does not have a docstring The function 'item_show' on 'salt/modules/pcs.py' does not have a 'CLI Example:' in its docstring The function 'item_create' on 'salt/modules/pcs.py' does not have a 'CLI Example:' in its docstring The function 'ext_pillar' on 'salt/pillar/makostack.py' does not have a docstring The function 'post_event' on 'salt/modules/datadog_api.py' does not have a 'CLI Example:' in its docstring The function 'fqdns' on 'salt/modules/network.py' was previously known to not have a CLI Example, which is no longer the case. Please remove it from 'MISSING_EXAMPLES'. in 'tasks/docstrings.py' The function 'mkdirs' on 'salt/utils/smb.py' does not have a docstring The function 'delete_file' on 'salt/utils/smb.py' does not have a docstring The function 'delete_directory' on 'salt/utils/smb.py' does not have a docstring The function 'get_configured_provider' on 'salt/cloud/clouds/clc.py' does not have a docstring The function 'get_creds' on 'salt/cloud/clouds/clc.py' does not have a docstring The function 'get_queue_data' on 'salt/cloud/clouds/clc.py' does not have a docstring The function 'get_filter_pillar' on 'salt/modules/capirca_acl.py' does not have a 'CLI Example:' in its docstring The function 'get_term_pillar' on 'salt/modules/capirca_acl.py' does not have a 'CLI Example:' in its docstring The function 'create_vmfs_datastore' on 'salt/modules/vsphere.py' was previously known to not have a CLI Example, which is no longer the case. Please remove it from 'MISSING_EXAMPLES'. in 'tasks/docstrings.py' The function 'list_licenses' on 'salt/modules/vsphere.py' was previously known to not have a CLI Example, which is no longer the case. Please remove it from 'MISSING_EXAMPLES'. in 'tasks/docstrings.py' The function 'get_vm' on 'salt/modules/vsphere.py' does not have a 'CLI Example:' in its docstring The function 'get_vm_config_file' on 'salt/modules/vsphere.py' does not have a 'CLI Example:' in its docstring The function 'get_advanced_configs' on 'salt/modules/vsphere.py' does not have a 'CLI Example:' in its docstring The function 'set_advanced_configs' on 'salt/modules/vsphere.py' does not have a 'CLI Example:' in its docstring The function 'delete_advanced_configs' on 'salt/modules/vsphere.py' does not have a 'CLI Example:' in its docstring The function 'compare_vm_configs' on 'salt/modules/vsphere.py' does not have a 'CLI Example:' in its docstring The function 'get_vm_config' on 'salt/modules/vsphere.py' does not have a 'CLI Example:' in its docstring The function 'update_vm' on 'salt/modules/vsphere.py' does not have a 'CLI Example:' in its docstring The function 'register_vm' on 'salt/modules/vsphere.py' does not have a 'CLI Example:' in its docstring The function 'create' on 'salt/modules/lxc.py' does not have a 'CLI Example:' in its docstring The function 'assumed_creds' on 'salt/utils/aws.py' does not have a docstring Found 10 warnings Found 127 errors


Thanks again!

github-actions[bot] avatar Aug 25 '22 00:08 github-actions[bot]

Hi! I'm your friendly PR bot!

You might be wondering what I'm doing commenting here on your PR.

Yes, as a matter of fact, I am...

I'm just here to help us improve the documentation. I can't respond to questions or anything, but what I can do, I do well!

Okay... so what do you do?

I detect modules that are missing docstrings or "CLI Example" on existing docstrings! When I was created we had a lot of these. The documentation for these modules need some love and attention to make Salt better for our users.

So what does that have to do with my PR?

I noticed that in this PR there are some files changed that have some of these issues. So I'm leaving this comment to let you know your options.

Okay, what are they?

Well, my favorite, is that since you were making changes here I'm hoping that you would be the most familiar with this module and be able to add some other examples or fix any of the reported issues.

If I can, then what?

Well, you can either add them to this PR or add them to another PR. Either way is fine!

Well... what if I can't, or don't want to?

That's also fine! We appreciate all contributions to the Salt Project. If you can't add those other examples, either because you're too busy, or unfamiliar, or you just aren't interested, we still appreciate the contributions that you've made already.

Whatever approach you decide to take, just drop a comment here letting us know!

Detected Issues (click me)
Check Known Missing Docstrings...........................................Failed
- hook id: invoke
- exit code: 1

/home/runner/.cache/pre-commit/repos4spui9r/py_env-python3/lib/python3.9/site-packages/_distutils_hack/init.py:33: UserWarning: Setuptools is replacing distutils. warnings.warn("Setuptools is replacing distutils.") The function 'expand_repo_def' on 'salt/modules/aptpkg.py' does not have a 'CLI Example:' in its docstring The function 'setup_handlers' on 'salt/log_handlers/log4mongo_mod.py' does not have a docstring The function 'get_os_version_info' on 'salt/utils/win_osinfo.py' does not have a docstring The function 'load' on 'salt/utils/yamlloader.py' does not have a docstring The function 'split_username' on 'salt/utils/win_runas.py' does not have a docstring The function 'get_connection' on 'salt/modules/netmiko_mod.py' does not have a 'CLI Example:' in its docstring The function 'call' on 'salt/modules/netmiko_mod.py' does not have a 'CLI Example:' in its docstring The function 'multi_call' on 'salt/modules/netmiko_mod.py' does not have a 'CLI Example:' in its docstring The function 'get_conn' on 'salt/utils/etcd_util.py' was previously known to not have a docstring, which is no longer the case. Please remove it from 'MISSING_DOCSTRINGS' .in 'tasks/docstrings.py' The function 'tree' on 'salt/utils/etcd_util.py' was previously known to not have a docstring, which is no longer the case. Please remove it from 'MISSING_DOCSTRINGS' .in 'tasks/docstrings.py' The function 'render_jinja' on 'salt/utils/saltclass.py' does not have a docstring The function 'render_yaml' on 'salt/utils/saltclass.py' does not have a docstring The function 'get_class' on 'salt/utils/saltclass.py' does not have a docstring The function 'get_env_from_dict' on 'salt/utils/saltclass.py' does not have a docstring The function 'dict_merge' on 'salt/utils/saltclass.py' does not have a docstring The function 'dict_search_and_replace' on 'salt/utils/saltclass.py' does not have a docstring The function 'find_value_to_expand' on 'salt/utils/saltclass.py' does not have a docstring The function 'find_and_process_re' on 'salt/utils/saltclass.py' does not have a docstring The function 'expand_variables' on 'salt/utils/saltclass.py' does not have a docstring The function 'expand_classes_in_order' on 'salt/utils/saltclass.py' does not have a docstring The function 'expanded_dict_from_minion' on 'salt/utils/saltclass.py' does not have a docstring The function 'get_pillars' on 'salt/utils/saltclass.py' does not have a docstring The function 'get_tops' on 'salt/utils/saltclass.py' does not have a docstring The function 'make_con' on 'salt/proxy/netmiko_px.py' does not have a docstring The function 'connection' on 'salt/proxy/netmiko_px.py' does not have a docstring The function 'nesthash' on 'salt/modules/virt.py' does not have a 'CLI Example:' in its docstring The function 'init' on 'salt/modules/virt.py' does not have a 'CLI Example:' in its docstring The function 'node_devices' on 'salt/modules/virt.py' does not have a 'CLI Example:' in its docstring The function 'network_update' on 'salt/modules/virt.py' does not have a 'CLI Example:' in its docstring The function 'pool_update' on 'salt/modules/virt.py' does not have a 'CLI Example:' in its docstring The function 'get_filter_pillar' on 'salt/modules/napalm_netacl.py' does not have a 'CLI Example:' in its docstring The function 'get_term_pillar' on 'salt/modules/napalm_netacl.py' does not have a 'CLI Example:' in its docstring The function 'jinja_raise' on 'salt/utils/jinja.py' does not have a docstring The function 'regex_escape' on 'salt/utils/jinja.py' does not have a docstring The function 'method_call' on 'salt/utils/jinja.py' does not have a docstring The function 'show_full_context' on 'salt/utils/jinja.py' does not have a docstring The function 'path_depth' on 'salt/utils/find.py' does not have a docstring The function 'to_salt_event' on 'salt/beacons/watchdog.py' does not have a docstring The function 'close' on 'salt/beacons/watchdog.py' does not have a docstring The function 'create_deployment' on 'salt/modules/kubernetesmod.py' does not have a 'CLI Example:' in its docstring The function 'create_pod' on 'salt/modules/kubernetesmod.py' does not have a 'CLI Example:' in its docstring The function 'create_service' on 'salt/modules/kubernetesmod.py' does not have a 'CLI Example:' in its docstring The function 'replace_deployment' on 'salt/modules/kubernetesmod.py' does not have a 'CLI Example:' in its docstring The function 'replace_service' on 'salt/modules/kubernetesmod.py' does not have a 'CLI Example:' in its docstring The function 'verify_logs_filter' on 'salt/utils/verify.py' was previously known to not have a docstring, which is no longer the case. Please remove it from 'MISSING_DOCSTRINGS' .in 'tasks/docstrings.py' The function 'get_resource' on 'salt/modules/pagerduty_util.py' does not have a 'CLI Example:' in its docstring The function 'create_or_update_resource' on 'salt/modules/pagerduty_util.py' does not have a 'CLI Example:' in its docstring The function 'delete_resource' on 'salt/modules/pagerduty_util.py' does not have a 'CLI Example:' in its docstring The function 'resource_present' on 'salt/modules/pagerduty_util.py' does not have a 'CLI Example:' in its docstring The function 'resource_absent' on 'salt/modules/pagerduty_util.py' does not have a 'CLI Example:' in its docstring The function 'represent_ordereddict' on 'salt/utils/yamldumper.py' does not have a docstring The function 'represent_undefined' on 'salt/utils/yamldumper.py' does not have a docstring The function 'get_dumper' on 'salt/utils/yamldumper.py' does not have a docstring The function 'ext_pillar' on 'salt/pillar/stack.py' does not have a docstring The function 'wrap_tmpl_func' on 'salt/utils/templates.py' was previously known to not have a docstring, which is no longer the case. Please remove it from 'MISSING_DOCSTRINGS' .in 'tasks/docstrings.py' The function 'render_jinja_tmpl' on 'salt/utils/templates.py' was previously known to not have a docstring, which is no longer the case. Please remove it from 'MISSING_DOCSTRINGS' .in 'tasks/docstrings.py' The function 'render_mako_tmpl' on 'salt/utils/templates.py' was previously known to not have a docstring, which is no longer the case. Please remove it from 'MISSING_DOCSTRINGS' .in 'tasks/docstrings.py' The function 'render_wempy_tmpl' on 'salt/utils/templates.py' was previously known to not have a docstring, which is no longer the case. Please remove it from 'MISSING_DOCSTRINGS' .in 'tasks/docstrings.py' The function 'get_error' on 'salt/utils/boto3mod.py' does not have a docstring The function 'exactly_one' on 'salt/utils/boto3mod.py' does not have a docstring The function 'ordered' on 'salt/utils/boto3mod.py' does not have a docstring The function 'check_nova' on 'salt/utils/openstack/nova.py' does not have a docstring The function 'get_entry' on 'salt/utils/openstack/nova.py' does not have a docstring The function 'get_entry_multi' on 'salt/utils/openstack/nova.py' does not have a docstring The function 'get_endpoint_url_v3' on 'salt/utils/openstack/nova.py' does not have a docstring The function 'sanatize_novaclient' on 'salt/utils/openstack/nova.py' does not have a docstring The function 'check_neutron' on 'salt/utils/openstack/neutron.py' does not have a docstring The function 'check_keystone' on 'salt/utils/openstack/neutron.py' does not have a docstring The function 'sanitize_neutronclient' on 'salt/utils/openstack/neutron.py' does not have a docstring The function 'create' on 'salt/modules/boto_elb.py' does not have a 'CLI Example:' in its docstring The function 'delete' on 'salt/modules/boto_elb.py' does not have a 'CLI Example:' in its docstring The function 'set_attributes' on 'salt/modules/boto_elb.py' does not have a 'CLI Example:' in its docstring The function 'set_health_check' on 'salt/modules/boto_elb.py' does not have a 'CLI Example:' in its docstring The function 'delete_alarm' on 'salt/modules/boto_cloudwatch.py' does not have a 'CLI Example:' in its docstring The function 'set_volumes_tags' on 'salt/modules/boto_ec2.py' does not have a 'CLI Example:' in its docstring The function 'start' on 'salt/engines/junos_syslog.py' does not have a docstring The function 'describe_cache_clusters' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'cache_cluster_exists' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'create_cache_cluster' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'modify_cache_cluster' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'delete_cache_cluster' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'describe_replication_groups' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'replication_group_exists' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'create_replication_group' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'modify_replication_group' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'delete_replication_group' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'describe_cache_subnet_groups' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'cache_subnet_group_exists' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'list_cache_subnet_groups' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'create_cache_subnet_group' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'modify_cache_subnet_group' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'delete_cache_subnet_group' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'describe_cache_security_groups' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'cache_security_group_exists' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'create_cache_security_group' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'delete_cache_security_group' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'authorize_cache_security_group_ingress' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'revoke_cache_security_group_ingress' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'list_tags_for_resource' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'add_tags_to_resource' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'remove_tags_from_resource' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'copy_snapshot' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'describe_cache_parameter_groups' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'create_cache_parameter_group' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'delete_cache_parameter_group' on 'salt/modules/boto3_elasticache.py' does not have a 'CLI Example:' in its docstring The function 'lock_holders' on 'salt/modules/zk_concurrency.py' does not have a 'CLI Example:' in its docstring The function 'lock' on 'salt/modules/zk_concurrency.py' does not have a 'CLI Example:' in its docstring The function 'unlock' on 'salt/modules/zk_concurrency.py' does not have a 'CLI Example:' in its docstring The function 'party_members' on 'salt/modules/zk_concurrency.py' does not have a 'CLI Example:' in its docstring The function 'signal_event' on 'salt/cloud/clouds/profitbricks.py' does not have a docstring The function 'load' on 'salt/utils/yamlloader_old.py' does not have a docstring The function 'item_show' on 'salt/modules/pcs.py' does not have a 'CLI Example:' in its docstring The function 'item_create' on 'salt/modules/pcs.py' does not have a 'CLI Example:' in its docstring The function 'ext_pillar' on 'salt/pillar/makostack.py' does not have a docstring The function 'post_event' on 'salt/modules/datadog_api.py' does not have a 'CLI Example:' in its docstring The function 'fqdns' on 'salt/modules/network.py' was previously known to not have a CLI Example, which is no longer the case. Please remove it from 'MISSING_EXAMPLES'. in 'tasks/docstrings.py' The function 'mkdirs' on 'salt/utils/smb.py' does not have a docstring The function 'delete_file' on 'salt/utils/smb.py' does not have a docstring The function 'delete_directory' on 'salt/utils/smb.py' does not have a docstring The function 'get_configured_provider' on 'salt/cloud/clouds/clc.py' does not have a docstring The function 'get_creds' on 'salt/cloud/clouds/clc.py' does not have a docstring The function 'get_queue_data' on 'salt/cloud/clouds/clc.py' does not have a docstring The function 'get_filter_pillar' on 'salt/modules/capirca_acl.py' does not have a 'CLI Example:' in its docstring The function 'get_term_pillar' on 'salt/modules/capirca_acl.py' does not have a 'CLI Example:' in its docstring The function 'create_vmfs_datastore' on 'salt/modules/vsphere.py' was previously known to not have a CLI Example, which is no longer the case. Please remove it from 'MISSING_EXAMPLES'. in 'tasks/docstrings.py' The function 'list_licenses' on 'salt/modules/vsphere.py' was previously known to not have a CLI Example, which is no longer the case. Please remove it from 'MISSING_EXAMPLES'. in 'tasks/docstrings.py' The function 'get_vm' on 'salt/modules/vsphere.py' does not have a 'CLI Example:' in its docstring The function 'get_vm_config_file' on 'salt/modules/vsphere.py' does not have a 'CLI Example:' in its docstring The function 'get_advanced_configs' on 'salt/modules/vsphere.py' does not have a 'CLI Example:' in its docstring The function 'set_advanced_configs' on 'salt/modules/vsphere.py' does not have a 'CLI Example:' in its docstring The function 'delete_advanced_configs' on 'salt/modules/vsphere.py' does not have a 'CLI Example:' in its docstring The function 'compare_vm_configs' on 'salt/modules/vsphere.py' does not have a 'CLI Example:' in its docstring The function 'get_vm_config' on 'salt/modules/vsphere.py' does not have a 'CLI Example:' in its docstring The function 'update_vm' on 'salt/modules/vsphere.py' does not have a 'CLI Example:' in its docstring The function 'register_vm' on 'salt/modules/vsphere.py' does not have a 'CLI Example:' in its docstring The function 'create' on 'salt/modules/lxc.py' does not have a 'CLI Example:' in its docstring The function 'assumed_creds' on 'salt/utils/aws.py' does not have a docstring Found 10 warnings Found 127 errors


Thanks again!

github-actions[bot] avatar Aug 25 '22 00:08 github-actions[bot]