mirror of
https://github.com/saltstack/salt.git
synced 2025-04-16 17:50:20 +00:00
Don't fail on known doc failures
This commit is contained in:
Pedro Algarvio
Megan Wilhite
parent
3f3c7e5be6
commit
5d75291845
3 changed files with 883 additions and 12 deletions
2
.github/workflows/pre-commit.yml
vendored
2
.github/workflows/pre-commit.yml
vendored
|
|
@ -47,7 +47,7 @@ jobs:
|
|||
- name: Check ALL Files On Branch
|
||||
if: github.event_name != 'pull_request'
|
||||
env:
|
||||
SKIP: lint-salt,lint-tests,pyupgrade,remove-import-headers,rstcheck,check-docstrings
|
||||
SKIP: lint-salt,lint-tests,pyupgrade,remove-import-headers,rstcheck
|
||||
run: |
|
||||
pre-commit run --show-diff-on-failure --color=always --all-files
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ if (env.CHANGE_ID) {
|
|||
pre_commit_skips = ''
|
||||
} else {
|
||||
// This is a branch build
|
||||
pre_commit_skips = 'pyupgrade,remove-import-headers,rstcheck,check-docstrings'
|
||||
pre_commit_skips = 'pyupgrade,remove-import-headers,rstcheck'
|
||||
}
|
||||
|
||||
runPreCommit(
|
||||
|
|
|
|||
|
|
@ -17,10 +17,829 @@ from tasks import utils
|
|||
CODE_DIR = pathlib.Path(__file__).resolve().parent.parent
|
||||
SALT_CODE_DIR = CODE_DIR / "salt"
|
||||
SALT_MODULES_PATH = SALT_CODE_DIR / "modules"
|
||||
THIS_FILE = pathlib.Path(__file__).relative_to(CODE_DIR)
|
||||
|
||||
MISSING_DOCSTRINGS = {
|
||||
"salt/auth/django.py": ["is_connection_usable"],
|
||||
"salt/auth/rest.py": ["rest_auth_setup"],
|
||||
"salt/auth/yubico.py": ["groups"],
|
||||
"salt/beacons/inotify.py": ["close"],
|
||||
"salt/beacons/junos_rre_keys.py": ["beacon"],
|
||||
"salt/beacons/salt_monitor.py": ["validate", "beacon"],
|
||||
"salt/beacons/watchdog.py": ["close", "to_salt_event"],
|
||||
"salt/cache/localfs.py": ["get_storage_id", "init_kwargs"],
|
||||
"salt/cache/redis_cache.py": ["init_kwargs"],
|
||||
"salt/cloud/clouds/clc.py": [
|
||||
"get_creds",
|
||||
"get_configured_provider",
|
||||
"get_queue_data",
|
||||
],
|
||||
"salt/cloud/clouds/ec2.py": ["query", "sign"],
|
||||
"salt/cloud/clouds/hetzner.py": [
|
||||
"show_instance",
|
||||
"avail_sizes",
|
||||
"avail_images",
|
||||
"avail_locations",
|
||||
"list_ssh_keys",
|
||||
"list_nodes",
|
||||
"list_nodes_full",
|
||||
],
|
||||
"salt/cloud/clouds/libvirt.py": [
|
||||
"get_domain_ips",
|
||||
"destroy_domain",
|
||||
"create_volume_with_backing_store_xml",
|
||||
"generate_new_name",
|
||||
"find_pool_and_volume",
|
||||
"to_ip_addr_type",
|
||||
"get_domain_ip",
|
||||
"get_domain_volumes",
|
||||
"create_volume_xml",
|
||||
],
|
||||
"salt/cloud/clouds/lxc.py": [
|
||||
"avail_images",
|
||||
"list_nodes_full",
|
||||
"list_nodes",
|
||||
"get_provider",
|
||||
],
|
||||
"salt/cloud/clouds/packet.py": ["get_devices_by_token", "is_profile_configured"],
|
||||
"salt/cloud/clouds/profitbricks.py": ["signal_event"],
|
||||
"salt/cloud/clouds/pyrax.py": [
|
||||
"queues_exists",
|
||||
"queues_show",
|
||||
"queues_delete",
|
||||
"queues_create",
|
||||
],
|
||||
"salt/engines/junos_syslog.py": ["start"],
|
||||
"salt/engines/logentries.py": ["event_bus_context"],
|
||||
"salt/engines/logstash_engine.py": ["event_bus_context"],
|
||||
"salt/engines/reactor.py": ["start"],
|
||||
"salt/engines/redis_sentinel.py": ["start"],
|
||||
"salt/engines/test.py": ["event_bus_context"],
|
||||
"salt/grains/chronos.py": ["os_family", "os_data", "kernel", "os"],
|
||||
"salt/grains/cimc.py": ["cimc"],
|
||||
"salt/grains/esxi.py": ["os_family", "kernel", "os", "esxi"],
|
||||
"salt/grains/fx2.py": ["kernel", "os_family", "fx2", "location", "os_data"],
|
||||
"salt/grains/junos.py": ["facts", "os_family", "defaults"],
|
||||
"salt/grains/marathon.py": ["kernel", "os", "os_family", "os_data", "marathon"],
|
||||
"salt/grains/metadata.py": ["metadata"],
|
||||
"salt/grains/nxos.py": ["system_information"],
|
||||
"salt/grains/panos.py": ["panos"],
|
||||
"salt/grains/philips_hue.py": ["vendor", "kernel", "os", "os_family", "product"],
|
||||
"salt/grains/rest_sample.py": ["kernel", "os", "os_family", "location", "os_data"],
|
||||
"salt/grains/ssh_sample.py": ["location", "os_data", "kernel"],
|
||||
"salt/log/handlers/fluent_mod.py": ["setup", "setup_handlers", "get_global_sender"],
|
||||
"salt/log/handlers/log4mongo_mod.py": ["setup_handlers"],
|
||||
"salt/log/handlers/logstash_mod.py": ["setup_handlers"],
|
||||
"salt/metaproxy/proxy.py": [
|
||||
"post_master_init",
|
||||
"target",
|
||||
"handle_payload",
|
||||
"target_load",
|
||||
],
|
||||
"salt/modules/chassis.py": ["chassis_credentials", "cmd"],
|
||||
"salt/modules/csf.py": [
|
||||
"disable_testing_mode",
|
||||
"skip_nic",
|
||||
"get_testing_status",
|
||||
"build_directions",
|
||||
"get_option",
|
||||
"enable_testing_mode",
|
||||
"remove_temp_rule",
|
||||
"get_skipped_nics",
|
||||
"set_option",
|
||||
"remove_rule",
|
||||
"split_option",
|
||||
"skip_nics",
|
||||
],
|
||||
"salt/modules/dracr.py": [
|
||||
"get_general",
|
||||
"set_dns_dracname",
|
||||
"set_nicvlan",
|
||||
"get_dns_dracname",
|
||||
"bare_rac_cmd",
|
||||
"set_general",
|
||||
"inventory",
|
||||
"set_niccfg",
|
||||
],
|
||||
"salt/modules/dummyproxy_pkg.py": [
|
||||
"remove",
|
||||
"installed",
|
||||
"install",
|
||||
"list_pkgs",
|
||||
"upgrade",
|
||||
],
|
||||
"salt/modules/esxcluster.py": ["get_details"],
|
||||
"salt/modules/esxdatacenter.py": ["get_details"],
|
||||
"salt/modules/esxi.py": ["cmd", "get_details"],
|
||||
"salt/modules/esxvm.py": ["get_details"],
|
||||
"salt/modules/powerpath.py": ["has_powerpath"],
|
||||
"salt/modules/rest_pkg.py": [
|
||||
"remove",
|
||||
"installed",
|
||||
"install",
|
||||
"list_pkgs",
|
||||
"upgrade",
|
||||
],
|
||||
"salt/modules/ssh_pkg.py": ["install", "list_pkgs", "remove"],
|
||||
"salt/modules/swift.py": ["head"],
|
||||
"salt/modules/sysbench.py": ["ping"],
|
||||
"salt/modules/test.py": ["missing_func"],
|
||||
"salt/modules/test_virtual.py": ["ping"],
|
||||
"salt/modules/vcenter.py": ["get_details"],
|
||||
"salt/netapi/rest_tornado/__init__.py": ["get_application"],
|
||||
"salt/output/__init__.py": ["progress_end"],
|
||||
"salt/pillar/extra_minion_data_in_pillar.py": ["ext_pillar"],
|
||||
"salt/pillar/gpg.py": ["ext_pillar"],
|
||||
"salt/pillar/makostack.py": ["ext_pillar"],
|
||||
"salt/pillar/nacl.py": ["ext_pillar"],
|
||||
"salt/pillar/stack.py": ["ext_pillar"],
|
||||
"salt/proxy/cisconso.py": ["init"],
|
||||
"salt/proxy/esxi.py": ["is_connected_via_vcenter"],
|
||||
"salt/proxy/fx2.py": ["host"],
|
||||
"salt/proxy/junos.py": [
|
||||
"reboot_active",
|
||||
"conn",
|
||||
"get_reboot_active",
|
||||
"initialized",
|
||||
"reboot_clear",
|
||||
"get_serialized_facts",
|
||||
],
|
||||
"salt/proxy/netmiko_px.py": ["connection", "make_con"],
|
||||
"salt/proxy/rest_sample.py": ["init", "alive", "fns", "fix_outage"],
|
||||
"salt/queues/pgjsonb_queue.py": ["handle_queue_creation"],
|
||||
"salt/renderers/pydsl.py": ["render"],
|
||||
"salt/renderers/pyobjects.py": ["render"],
|
||||
"salt/renderers/stateconf.py": [
|
||||
"add_goal_state",
|
||||
"rewrite_sls_includes_excludes",
|
||||
"add_implicit_requires",
|
||||
"add_start_state",
|
||||
"extract_state_confs",
|
||||
"rename_state_ids",
|
||||
"has_names_decls",
|
||||
"statelist",
|
||||
"render",
|
||||
],
|
||||
"salt/returners/zabbix_return.py": ["returner", "zbx", "zabbix_send"],
|
||||
"salt/roster/range.py": ["target_glob", "target_range"],
|
||||
"salt/sdb/consul.py": ["set_", "get"],
|
||||
"salt/states/apache.py": ["configfile"],
|
||||
"salt/states/boto_elasticache.py": [
|
||||
"replication_group_present",
|
||||
"cache_cluster_present",
|
||||
"replication_group_absent",
|
||||
"subnet_group_absent",
|
||||
"cache_cluster_absent",
|
||||
],
|
||||
"salt/states/boto_rds.py": ["subnet_group_absent"],
|
||||
"salt/states/boto_route53.py": ["rr_absent", "rr_present"],
|
||||
"salt/states/boto_vpc.py": ["vpc_peering_connection_absent"],
|
||||
"salt/states/cmd.py": ["wait_call"],
|
||||
"salt/states/esxdatacenter.py": ["mod_init"],
|
||||
"salt/states/junos.py": ["resultdecorator"],
|
||||
"salt/states/keystone_role_grant.py": ["present", "absent"],
|
||||
"salt/states/libcloud_dns.py": ["state_result"],
|
||||
"salt/states/libcloud_loadbalancer.py": ["state_result"],
|
||||
"salt/states/libcloud_storage.py": ["state_result"],
|
||||
"salt/states/pkgng.py": ["update_packaging_site"],
|
||||
"salt/utils/aws.py": ["assumed_creds"],
|
||||
"salt/utils/boto3mod.py": ["exactly_one", "get_error", "ordered"],
|
||||
"salt/utils/boto_elb_tag.py": ["get_tag_descriptions"],
|
||||
"salt/utils/botomod.py": ["exactly_one", "get_error"],
|
||||
"salt/utils/dictdiffer.py": ["diff", "deep_diff"],
|
||||
"salt/utils/dictupdate.py": [
|
||||
"merge",
|
||||
"merge_recurse",
|
||||
"merge_overwrite",
|
||||
"merge_list",
|
||||
"merge_aggregate",
|
||||
],
|
||||
"salt/utils/dockermod/__init__.py": ["get_client_args"],
|
||||
"salt/utils/dockermod/translate/container.py": [
|
||||
"ipc_mode",
|
||||
"volumes_from",
|
||||
"cpu_period",
|
||||
"network_mode",
|
||||
"domainname",
|
||||
"stop_signal",
|
||||
"cpuset_mems",
|
||||
"command",
|
||||
"memswap_limit",
|
||||
"pid_mode",
|
||||
"pids_limit",
|
||||
"security_opt",
|
||||
"network_disabled",
|
||||
"labels",
|
||||
"sysctls",
|
||||
"log_driver",
|
||||
"userns_mode",
|
||||
"cpuset_cpus",
|
||||
"lxc_conf",
|
||||
"environment",
|
||||
"read_only",
|
||||
"oom_score_adj",
|
||||
"device_write_iops",
|
||||
"mem_swappiness",
|
||||
"isolation",
|
||||
"blkio_weight",
|
||||
"entrypoint",
|
||||
"hostname",
|
||||
"dns_opt",
|
||||
"mac_address",
|
||||
"cpu_shares",
|
||||
"privileged",
|
||||
"stdin_open",
|
||||
"dns",
|
||||
"publish_all_ports",
|
||||
"mem_limit",
|
||||
"log_opt",
|
||||
"devices",
|
||||
"auto_remove",
|
||||
"cap_add",
|
||||
"group_add",
|
||||
"stop_timeout",
|
||||
"oom_kill_disable",
|
||||
"tty",
|
||||
"detach",
|
||||
"storage_opt",
|
||||
"shm_size",
|
||||
"name",
|
||||
"host_config",
|
||||
"device_read_bps",
|
||||
"cpu_group",
|
||||
"device_read_iops",
|
||||
"dns_search",
|
||||
"links",
|
||||
"volume_driver",
|
||||
"extra_hosts",
|
||||
"tmpfs",
|
||||
"ulimits",
|
||||
"cap_drop",
|
||||
"device_write_bps",
|
||||
],
|
||||
"salt/utils/dockermod/translate/helpers.py": [
|
||||
"validate_subnet",
|
||||
"translate_str",
|
||||
"validate_ip",
|
||||
"translate_bool",
|
||||
"split",
|
||||
"translate_int",
|
||||
],
|
||||
"salt/utils/dockermod/translate/network.py": [
|
||||
"attachable",
|
||||
"subnet",
|
||||
"driver",
|
||||
"ipam_opts",
|
||||
"aux_addresses",
|
||||
"ingress",
|
||||
"ipam_driver",
|
||||
"ipam_pools",
|
||||
"iprange",
|
||||
"gateway",
|
||||
"enable_ipv6",
|
||||
"internal",
|
||||
"check_duplicate",
|
||||
"options",
|
||||
"ipam",
|
||||
"labels",
|
||||
],
|
||||
"salt/utils/entrypoints.py": [
|
||||
"name_and_version_from_entry_point",
|
||||
"iter_entry_points",
|
||||
],
|
||||
"salt/utils/error.py": ["pack_exception"],
|
||||
"salt/utils/etcd_util.py": ["get_conn", "tree"],
|
||||
"salt/utils/find.py": ["path_depth"],
|
||||
"salt/utils/gzip_util.py": ["open_fileobj", "uncompress", "open"],
|
||||
"salt/utils/icinga2.py": ["get_certs_path"],
|
||||
"salt/utils/jinja.py": [
|
||||
"jinja_raise",
|
||||
"method_call",
|
||||
"show_full_context",
|
||||
"regex_escape",
|
||||
],
|
||||
"salt/utils/listdiffer.py": ["list_diff"],
|
||||
"salt/utils/master.py": ["get_master_key", "ping_all_connected_minions"],
|
||||
"salt/utils/namecheap.py": [
|
||||
"atts_to_dict",
|
||||
"get_opts",
|
||||
"post_request",
|
||||
"string_to_value",
|
||||
"xml_to_dict",
|
||||
"get_request",
|
||||
],
|
||||
"salt/utils/nxos.py": ["version_info"],
|
||||
"salt/utils/openstack/neutron.py": [
|
||||
"check_keystone",
|
||||
"check_neutron",
|
||||
"sanitize_neutronclient",
|
||||
],
|
||||
"salt/utils/openstack/nova.py": [
|
||||
"sanatize_novaclient",
|
||||
"get_entry",
|
||||
"get_endpoint_url_v3",
|
||||
"get_entry_multi",
|
||||
"check_nova",
|
||||
],
|
||||
"salt/utils/openstack/swift.py": ["mkdirs", "check_swift"],
|
||||
"salt/utils/pkg/__init__.py": ["split_comparison"],
|
||||
"salt/utils/process.py": ["systemd_notify_call", "default_signals"],
|
||||
"salt/utils/profile.py": ["activate_profile", "output_profile"],
|
||||
"salt/utils/pyobjects.py": ["need_salt"],
|
||||
"salt/utils/reclass.py": [
|
||||
"set_inventory_base_uri_default",
|
||||
"filter_out_source_path_option",
|
||||
"prepend_reclass_source_path",
|
||||
],
|
||||
"salt/utils/roster_matcher.py": ["targets"],
|
||||
"salt/utils/saltclass.py": [
|
||||
"find_and_process_re",
|
||||
"get_tops",
|
||||
"render_yaml",
|
||||
"get_env_from_dict",
|
||||
"get_pillars",
|
||||
"expand_variables",
|
||||
"render_jinja",
|
||||
"expand_classes_in_order",
|
||||
"dict_search_and_replace",
|
||||
"expanded_dict_from_minion",
|
||||
"find_value_to_expand",
|
||||
"dict_merge",
|
||||
"get_class",
|
||||
],
|
||||
"salt/utils/smb.py": ["mkdirs", "delete_file", "delete_directory"],
|
||||
"salt/utils/ssh.py": ["key_is_encrypted"],
|
||||
"salt/utils/stringio.py": ["is_writable", "is_stringio", "is_readable"],
|
||||
"salt/utils/stringutils.py": ["random"],
|
||||
"salt/utils/templates.py": [
|
||||
"wrap_tmpl_func",
|
||||
"render_mako_tmpl",
|
||||
"render_jinja_tmpl",
|
||||
"render_wempy_tmpl",
|
||||
],
|
||||
"salt/utils/verify.py": ["verify_logs_filter"],
|
||||
"salt/utils/virtualbox.py": [
|
||||
"machine_get_machinestate_str",
|
||||
"machine_get_machinestate_tuple",
|
||||
],
|
||||
"salt/utils/win_osinfo.py": ["get_os_version_info"],
|
||||
"salt/utils/win_runas.py": ["split_username"],
|
||||
"salt/utils/yamldumper.py": [
|
||||
"represent_undefined",
|
||||
"represent_ordereddict",
|
||||
"get_dumper",
|
||||
],
|
||||
"salt/utils/yamlloader.py": ["load"],
|
||||
"salt/utils/yamlloader_old.py": ["load"],
|
||||
"salt/utils/zeromq.py": ["check_ipc_path_max_len"],
|
||||
}
|
||||
MISSING_EXAMPLES = {
|
||||
"salt/modules/acme.py": ["has", "renew_by", "needs_renewal"],
|
||||
"salt/modules/ansiblegate.py": ["help", "list_"],
|
||||
"salt/modules/apkpkg.py": ["purge"],
|
||||
"salt/modules/aptpkg.py": ["expand_repo_def"],
|
||||
"salt/modules/arista_pyeapi.py": ["get_connection"],
|
||||
"salt/modules/artifactory.py": [
|
||||
"get_latest_release",
|
||||
"get_latest_snapshot",
|
||||
"get_release",
|
||||
"get_snapshot",
|
||||
],
|
||||
"salt/modules/bigip.py": ["delete_pool"],
|
||||
"salt/modules/boto3_elasticache.py": [
|
||||
"delete_cache_cluster",
|
||||
"describe_cache_subnet_groups",
|
||||
"create_cache_parameter_group",
|
||||
"describe_replication_groups",
|
||||
"cache_security_group_exists",
|
||||
"add_tags_to_resource",
|
||||
"authorize_cache_security_group_ingress",
|
||||
"modify_cache_cluster",
|
||||
"cache_subnet_group_exists",
|
||||
"describe_cache_clusters",
|
||||
"cache_cluster_exists",
|
||||
"delete_cache_security_group",
|
||||
"describe_cache_parameter_groups",
|
||||
"copy_snapshot",
|
||||
"delete_cache_parameter_group",
|
||||
"delete_cache_subnet_group",
|
||||
"describe_cache_security_groups",
|
||||
"create_cache_cluster",
|
||||
"list_tags_for_resource",
|
||||
"revoke_cache_security_group_ingress",
|
||||
"modify_cache_subnet_group",
|
||||
"replication_group_exists",
|
||||
"remove_tags_from_resource",
|
||||
"create_replication_group",
|
||||
"modify_replication_group",
|
||||
"create_cache_subnet_group",
|
||||
"create_cache_security_group",
|
||||
"delete_replication_group",
|
||||
"list_cache_subnet_groups",
|
||||
],
|
||||
"salt/modules/boto3_elasticsearch.py": [
|
||||
"delete_elasticsearch_domain",
|
||||
"describe_elasticsearch_domain",
|
||||
"describe_reserved_elasticsearch_instances",
|
||||
"wait_for_upgrade",
|
||||
"start_elasticsearch_service_software_update",
|
||||
"cancel_elasticsearch_service_software_update",
|
||||
"list_domain_names",
|
||||
"exists",
|
||||
"describe_reserved_elasticsearch_instance_offerings",
|
||||
"list_elasticsearch_instance_types",
|
||||
"list_tags",
|
||||
"delete_elasticsearch_service_role",
|
||||
"get_upgrade_status",
|
||||
"get_upgrade_history",
|
||||
"get_compatible_elasticsearch_versions",
|
||||
"purchase_reserved_elasticsearch_instance_offering",
|
||||
"describe_elasticsearch_domain_config",
|
||||
"list_elasticsearch_versions",
|
||||
],
|
||||
"salt/modules/boto3_route53.py": ["aws_encode"],
|
||||
"salt/modules/boto_cloudwatch.py": ["delete_alarm"],
|
||||
"salt/modules/boto_ec2.py": ["set_volumes_tags"],
|
||||
"salt/modules/boto_elasticache.py": ["create_subnet_group"],
|
||||
"salt/modules/boto_elb.py": [
|
||||
"set_health_check",
|
||||
"set_attributes",
|
||||
"create",
|
||||
"delete",
|
||||
],
|
||||
"salt/modules/boto_rds.py": [
|
||||
"create_read_replica",
|
||||
"describe_parameters",
|
||||
"create_parameter_group",
|
||||
"modify_db_instance",
|
||||
"create_subnet_group",
|
||||
"create_option_group",
|
||||
"create",
|
||||
"describe_parameter_group",
|
||||
],
|
||||
"salt/modules/boto_sns.py": [
|
||||
"get_all_subscriptions_by_topic",
|
||||
"create",
|
||||
"subscribe",
|
||||
"delete",
|
||||
],
|
||||
"salt/modules/boto_ssm.py": ["get_parameter", "delete_parameter", "put_parameter"],
|
||||
"salt/modules/capirca_acl.py": ["get_filter_pillar", "get_term_pillar"],
|
||||
"salt/modules/ceph.py": ["zap"],
|
||||
"salt/modules/chroot.py": ["exist"],
|
||||
"salt/modules/ciscoconfparse_mod.py": [
|
||||
"find_objects",
|
||||
"find_objects_wo_child",
|
||||
"find_objects_w_child",
|
||||
],
|
||||
"salt/modules/cisconso.py": [
|
||||
"get_data",
|
||||
"get_rollbacks",
|
||||
"get_rollback",
|
||||
"info",
|
||||
"set_data_value",
|
||||
"apply_rollback",
|
||||
],
|
||||
"salt/modules/cp.py": ["envs", "recv", "recv_chunked"],
|
||||
"salt/modules/cryptdev.py": ["active"],
|
||||
"salt/modules/datadog_api.py": ["post_event"],
|
||||
"salt/modules/defaults.py": ["deepcopy", "update"],
|
||||
"salt/modules/dracr.py": ["update_firmware", "update_firmware_nfs_or_cifs"],
|
||||
"salt/modules/dummyproxy_service.py": ["enabled", "running"],
|
||||
"salt/modules/ebuildpkg.py": ["porttree_matches"],
|
||||
"salt/modules/eselect.py": ["exec_action", "set_target", "get_current_target"],
|
||||
"salt/modules/freebsd_update.py": [
|
||||
"update",
|
||||
"ids",
|
||||
"rollback",
|
||||
"install",
|
||||
"fetch",
|
||||
"upgrade",
|
||||
],
|
||||
"salt/modules/glanceng.py": [
|
||||
"setup_clouds",
|
||||
"get_openstack_cloud",
|
||||
"get_operator_cloud",
|
||||
"compare_changes",
|
||||
],
|
||||
"salt/modules/glassfish.py": [
|
||||
"delete_jdbc_connection_pool",
|
||||
"create_connector_c_pool",
|
||||
"delete_jdbc_resource",
|
||||
"create_connector_resource",
|
||||
"enum_jdbc_connection_pool",
|
||||
"enum_connector_c_pool",
|
||||
"enum_jdbc_resource",
|
||||
"enum_admin_object_resource",
|
||||
"get_system_properties",
|
||||
"get_jdbc_connection_pool",
|
||||
"delete_system_properties",
|
||||
"delete_connector_c_pool",
|
||||
"create_jdbc_connection_pool",
|
||||
"update_jdbc_connection_pool",
|
||||
"update_system_properties",
|
||||
"update_connector_c_pool",
|
||||
"create_admin_object_resource",
|
||||
"enum_connector_resource",
|
||||
"create_jdbc_resource",
|
||||
"update_connector_resource",
|
||||
"delete_connector_resource",
|
||||
"delete_admin_object_resource",
|
||||
"update_admin_object_resource",
|
||||
"update_jdbc_resource",
|
||||
"get_admin_object_resource",
|
||||
"get_connector_resource",
|
||||
"get_connector_c_pool",
|
||||
"get_jdbc_resource",
|
||||
],
|
||||
"salt/modules/google_chat.py": ["send_message"],
|
||||
"salt/modules/hadoop.py": ["namenode_format"],
|
||||
"salt/modules/highstate_doc.py": [
|
||||
"processor_markdown",
|
||||
"read_file",
|
||||
"process_lowstates",
|
||||
"markdown_full_jinja_template",
|
||||
"markdown_default_jinja_template",
|
||||
"render",
|
||||
"markdown_basic_jinja_template",
|
||||
],
|
||||
"salt/modules/ifttt.py": ["trigger_event"],
|
||||
"salt/modules/influxdbmod.py": ["query", "revoke_privilege", "grant_privilege"],
|
||||
"salt/modules/infoblox.py": ["diff_objects"],
|
||||
"salt/modules/kapacitor.py": ["version"],
|
||||
"salt/modules/keystoneng.py": [
|
||||
"get_openstack_cloud",
|
||||
"compare_changes",
|
||||
"get_operator_cloud",
|
||||
"setup_clouds",
|
||||
"get_entity",
|
||||
],
|
||||
"salt/modules/kubernetesmod.py": [
|
||||
"replace_service",
|
||||
"create_deployment",
|
||||
"create_service",
|
||||
"create_pod",
|
||||
"replace_deployment",
|
||||
],
|
||||
"salt/modules/logmod.py": [
|
||||
"warning",
|
||||
"critical",
|
||||
"info",
|
||||
"exception",
|
||||
"error",
|
||||
"debug",
|
||||
],
|
||||
"salt/modules/lxc.py": ["create"],
|
||||
"salt/modules/lxd.py": [
|
||||
"pylxd_save_object",
|
||||
"container_start",
|
||||
"container_delete",
|
||||
"container_freeze",
|
||||
"container_unfreeze",
|
||||
"container_device_delete",
|
||||
"pylxd_client_get",
|
||||
"container_config_get",
|
||||
"container_restart",
|
||||
"container_rename",
|
||||
"container_device_get",
|
||||
"container_device_add",
|
||||
"container_config_delete",
|
||||
"container_stop",
|
||||
"container_get",
|
||||
"sync_config_devices",
|
||||
"container_file_get",
|
||||
"container_state",
|
||||
"container_config_set",
|
||||
],
|
||||
"salt/modules/nacl.py": ["enc", "dec"],
|
||||
"salt/modules/nagios.py": ["run_all", "retcode"],
|
||||
"salt/modules/napalm_formula.py": ["dictupdate"],
|
||||
"salt/modules/napalm_mod.py": ["netmiko_conn", "pyeapi_conn"],
|
||||
"salt/modules/napalm_netacl.py": ["get_filter_pillar", "get_term_pillar"],
|
||||
"salt/modules/napalm_probes.py": ["delete_probes", "schedule_probes", "set_probes"],
|
||||
"salt/modules/netbox.py": ["get_", "filter_", "slugify"],
|
||||
"salt/modules/netmiko_mod.py": ["call", "multi_call", "get_connection"],
|
||||
"salt/modules/network.py": ["fqdns"],
|
||||
"salt/modules/neutronng.py": [
|
||||
"get_openstack_cloud",
|
||||
"compare_changes",
|
||||
"get_operator_cloud",
|
||||
"subnet_update",
|
||||
"setup_clouds",
|
||||
],
|
||||
"salt/modules/nexus.py": [
|
||||
"get_latest_release",
|
||||
"get_latest_snapshot",
|
||||
"get_release",
|
||||
"get_snapshot_version_string",
|
||||
"get_snapshot",
|
||||
],
|
||||
"salt/modules/nix.py": [
|
||||
"collect_garbage",
|
||||
"uninstall",
|
||||
"list_pkgs",
|
||||
"install",
|
||||
"upgrade",
|
||||
],
|
||||
"salt/modules/nspawn.py": ["stop", "restart"],
|
||||
"salt/modules/nxos.py": [
|
||||
"set_role",
|
||||
"get_user",
|
||||
"find",
|
||||
"cmd",
|
||||
"get_roles",
|
||||
"show_run",
|
||||
"grains",
|
||||
"save_running_config",
|
||||
"remove_user",
|
||||
"check_role",
|
||||
"grains_refresh",
|
||||
"add_config",
|
||||
"system_info",
|
||||
"sendline",
|
||||
"delete_config",
|
||||
"show_ver",
|
||||
"check_password",
|
||||
"set_password",
|
||||
"ping",
|
||||
"unset_role",
|
||||
"replace",
|
||||
],
|
||||
"salt/modules/nxos_upgrade.py": ["upgrade", "check_upgrade_impact"],
|
||||
"salt/modules/openbsdpkg.py": ["install"],
|
||||
"salt/modules/opkg.py": ["version_clean", "check_extra_requirements"],
|
||||
"salt/modules/pagerduty_util.py": [
|
||||
"create_or_update_resource",
|
||||
"resource_absent",
|
||||
"resource_present",
|
||||
"get_resource",
|
||||
"delete_resource",
|
||||
],
|
||||
"salt/modules/parallels.py": [
|
||||
"delete",
|
||||
"exists",
|
||||
"list_vms",
|
||||
"status",
|
||||
"revert_snapshot",
|
||||
"stop",
|
||||
"prlsrvctl",
|
||||
"clone",
|
||||
"snapshot",
|
||||
"reset",
|
||||
"restart",
|
||||
"delete_snapshot",
|
||||
"exec_",
|
||||
"prlctl",
|
||||
"list_snapshots",
|
||||
"start",
|
||||
],
|
||||
"salt/modules/pcs.py": ["item_create", "item_show"],
|
||||
"salt/modules/pkg_resource.py": ["format_pkg_list", "format_version"],
|
||||
"salt/modules/pkgin.py": ["normalize_name"],
|
||||
"salt/modules/portage_config.py": [
|
||||
"get_all_cpv_use",
|
||||
"is_changed_uses",
|
||||
"get_installed_use",
|
||||
"filter_flags",
|
||||
"get_iuse",
|
||||
"get_cleared_flags",
|
||||
],
|
||||
"salt/modules/poudriere.py": ["create_ports_tree"],
|
||||
"salt/modules/powerpath.py": ["add_license", "list_licenses", "remove_license"],
|
||||
"salt/modules/ps.py": ["pkill", "kill_pid", "pgrep"],
|
||||
"salt/modules/rest_service.py": ["enabled", "running"],
|
||||
"salt/modules/runit.py": [
|
||||
"get_svc_alias",
|
||||
"get_svc_avail_path",
|
||||
"add_svc_avail_path",
|
||||
],
|
||||
"salt/modules/s3.py": ["put", "get", "delete"],
|
||||
"salt/modules/saltcheck.py": ["parallel_scheck"],
|
||||
"salt/modules/selinux.py": ["filetype_id_to_string"],
|
||||
"salt/modules/sensehat.py": [
|
||||
"get_pressure",
|
||||
"get_temperature_from_humidity",
|
||||
"get_pixels",
|
||||
"get_temperature",
|
||||
"set_pixels",
|
||||
"get_pixel",
|
||||
"get_humidity",
|
||||
"get_temperature_from_pressure",
|
||||
],
|
||||
"salt/modules/sensors.py": ["sense"],
|
||||
"salt/modules/slsutil.py": ["banner", "boolstr"],
|
||||
"salt/modules/smartos_imgadm.py": ["docker_to_uuid"],
|
||||
"salt/modules/ssh_service.py": ["enabled", "running"],
|
||||
"salt/modules/state.py": ["test", "get_pauses", "apply_"],
|
||||
"salt/modules/swift.py": ["put", "get", "delete"],
|
||||
"salt/modules/system.py": ["set_reboot_required_witnessed"],
|
||||
"salt/modules/test.py": ["rand_str", "try_"],
|
||||
"salt/modules/tls.py": ["validate"],
|
||||
"salt/modules/tomcat.py": ["extract_war_version"],
|
||||
"salt/modules/trafficserver.py": [
|
||||
"refresh",
|
||||
"set_config",
|
||||
"startup",
|
||||
"read_metric",
|
||||
"shutdown",
|
||||
"bounce_local",
|
||||
"alarms",
|
||||
"clear_node",
|
||||
"bounce_cluster",
|
||||
"status",
|
||||
"match_config",
|
||||
"offline",
|
||||
"zero_cluster",
|
||||
"zero_node",
|
||||
"restart_local",
|
||||
"read_config",
|
||||
"clear_alarms",
|
||||
"clear_cluster",
|
||||
"restart_cluster",
|
||||
"match_metric",
|
||||
],
|
||||
"salt/modules/vagrant.py": ["get_machine_id", "get_vm_info"],
|
||||
"salt/modules/vault.py": ["read_secret"],
|
||||
"salt/modules/virt.py": [
|
||||
"nesthash",
|
||||
"pool_update",
|
||||
"init",
|
||||
"node_devices",
|
||||
"network_update",
|
||||
],
|
||||
"salt/modules/virtualenv_mod.py": ["virtualenv_ver"],
|
||||
"salt/modules/vsphere.py": [
|
||||
"create_storage_policy",
|
||||
"power_off_vm",
|
||||
"list_diskgroups",
|
||||
"list_default_vsan_policy",
|
||||
"create_diskgroup",
|
||||
"list_dvportgroups",
|
||||
"assign_license",
|
||||
"update_vm",
|
||||
"list_cluster",
|
||||
"update_dvportgroup",
|
||||
"update_cluster",
|
||||
"list_dvss",
|
||||
"set_advanced_configs",
|
||||
"add_license",
|
||||
"list_capability_definitions",
|
||||
"register_vm",
|
||||
"list_disk_partitions",
|
||||
"remove_datastore",
|
||||
"update_storage_policy",
|
||||
"erase_disk_partitions",
|
||||
"get_vm_config",
|
||||
"remove_dvportgroup",
|
||||
"delete_vm",
|
||||
"create_datacenter",
|
||||
"add_capacity_to_diskgroup",
|
||||
"get_vm_config_file",
|
||||
"list_datacenters_via_proxy",
|
||||
"power_on_vm",
|
||||
"rename_datastore",
|
||||
"list_licenses",
|
||||
"configure_host_cache",
|
||||
"compare_vm_configs",
|
||||
"get_host_cache",
|
||||
"unregister_vm",
|
||||
"create_cluster",
|
||||
"update_dvs",
|
||||
"list_uplink_dvportgroup",
|
||||
"get_advanced_configs",
|
||||
"delete_advanced_configs",
|
||||
"create_dvportgroup",
|
||||
"list_disks",
|
||||
"assign_default_storage_policy_to_datastore",
|
||||
"create_dvs",
|
||||
"list_datastores_via_proxy",
|
||||
"list_default_storage_policy_of_datastore",
|
||||
"create_vmfs_datastore",
|
||||
"list_assigned_licenses",
|
||||
"get_vm",
|
||||
"remove_diskgroup",
|
||||
"remove_capacity_from_diskgroup",
|
||||
"list_storage_policies",
|
||||
],
|
||||
"salt/modules/win_pkg.py": ["get_package_info"],
|
||||
"salt/modules/win_timezone.py": ["zone_compare"],
|
||||
"salt/modules/zabbix.py": [
|
||||
"substitute_params",
|
||||
"get_zabbix_id_mapper",
|
||||
"get_object_id_by_params",
|
||||
"compare_params",
|
||||
],
|
||||
"salt/modules/zk_concurrency.py": [
|
||||
"lock",
|
||||
"party_members",
|
||||
"unlock",
|
||||
"lock_holders",
|
||||
],
|
||||
}
|
||||
|
||||
|
||||
@task(iterable=["files"], positional=["files"])
|
||||
def check(ctx, files, check_proper_formatting=False):
|
||||
def check(ctx, files, check_proper_formatting=False, error_on_known_failures=False):
|
||||
"""
|
||||
Check salt's docstrings
|
||||
"""
|
||||
|
|
@ -44,6 +863,7 @@ def check(ctx, files, check_proper_formatting=False):
|
|||
|
||||
errors = 0
|
||||
exitcode = 0
|
||||
warnings = 0
|
||||
for path in _files:
|
||||
contents = path.read_text()
|
||||
try:
|
||||
|
|
@ -79,24 +899,50 @@ def check(ctx, files, check_proper_formatting=False):
|
|||
# No further docstrings checks are needed
|
||||
continue
|
||||
|
||||
funcname = funcdef.name
|
||||
relpath = str(path.relative_to(CODE_DIR))
|
||||
|
||||
# We're dealing with a salt loader module
|
||||
if funcdef.name.startswith("_"):
|
||||
if funcname.startswith("_"):
|
||||
# We're not interested in internal functions
|
||||
continue
|
||||
|
||||
if not docstring:
|
||||
if (
|
||||
funcname in MISSING_DOCSTRINGS.get(relpath, ())
|
||||
and error_on_known_failures is False
|
||||
):
|
||||
warnings += 1
|
||||
utils.warn(
|
||||
"The function '{}' on '{}' does not have a docstring",
|
||||
funcname,
|
||||
relpath,
|
||||
)
|
||||
continue
|
||||
errors += 1
|
||||
exitcode = 1
|
||||
utils.error(
|
||||
"The function {!r} on '{}' does not have a docstring",
|
||||
funcdef.name,
|
||||
path.relative_to(CODE_DIR),
|
||||
"The function '{}' on '{}' does not have a docstring",
|
||||
funcname,
|
||||
relpath,
|
||||
)
|
||||
continue
|
||||
elif funcname in MISSING_DOCSTRINGS.get(relpath, ()):
|
||||
# This was previously a know function with a missing docstring.
|
||||
# Warn about it so that it get's removed from this list
|
||||
warnings += 1
|
||||
utils.warn(
|
||||
"The function '{}' on '{}' was previously known to not have a docstring, "
|
||||
"which is no longer the case. Please remove it from 'MISSING_DOCSTRINGS' ."
|
||||
"in '{}'",
|
||||
funcname,
|
||||
relpath,
|
||||
THIS_FILE,
|
||||
)
|
||||
|
||||
try:
|
||||
relpath = path.relative_to(SALT_MODULES_PATH)
|
||||
if str(relpath.parent) != ".":
|
||||
salt_modules_relpath = path.relative_to(SALT_MODULES_PATH)
|
||||
if str(salt_modules_relpath.parent) != ".":
|
||||
# We don't want to check nested packages
|
||||
continue
|
||||
# But this is a module under salt/modules, let's check
|
||||
|
|
@ -106,14 +952,37 @@ def check(ctx, files, check_proper_formatting=False):
|
|||
continue
|
||||
|
||||
if _check_cli_example_present(docstring) is False:
|
||||
if (
|
||||
funcname in MISSING_EXAMPLES.get(relpath, ())
|
||||
and error_on_known_failures is False
|
||||
):
|
||||
warnings += 1
|
||||
utils.warn(
|
||||
"The function '{}' on '{}' does not have a 'CLI Example:' in it's docstring",
|
||||
funcname,
|
||||
relpath,
|
||||
)
|
||||
continue
|
||||
errors += 1
|
||||
exitcode = 1
|
||||
utils.error(
|
||||
"The function {!r} on '{}' does not have a 'CLI Example:' in it's docstring",
|
||||
funcdef.name,
|
||||
path.relative_to(CODE_DIR),
|
||||
"The function '{}' on '{}' does not have a 'CLI Example:' in it's docstring",
|
||||
funcname,
|
||||
relpath,
|
||||
)
|
||||
continue
|
||||
elif funcname in MISSING_EXAMPLES.get(relpath, ()):
|
||||
# This was previously a know function with a missing CLI example
|
||||
# Warn about it so that it get's removed from this list
|
||||
warnings += 1
|
||||
utils.warn(
|
||||
"The function '{}' on '{}' was previously known to not have a CLI Example, "
|
||||
"which is no longer the case. Please remove it from 'MISSING_EXAMPLES'. "
|
||||
"in '{}'",
|
||||
funcname,
|
||||
relpath,
|
||||
THIS_FILE,
|
||||
)
|
||||
|
||||
if check_proper_formatting is False:
|
||||
continue
|
||||
|
|
@ -139,6 +1008,8 @@ def check(ctx, files, check_proper_formatting=False):
|
|||
if contents != path.read_text():
|
||||
path.write_text(contents)
|
||||
|
||||
if warnings:
|
||||
utils.warn("Found {} warnings", warnings)
|
||||
if exitcode:
|
||||
utils.error("Found {} errors", errors)
|
||||
utils.exit_invoke(exitcode)
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue