ansible/test/sanity/code-smell/boilerplate.sh

#!/bin/sh

metaclass1=$(find ./bin -type f -exec grep -HL '__metaclass__ = type' '{}' '+')
future1=$(find ./bin -type f -exec grep -HL 'from __future__ import (absolute_import, division, print_function)' '{}' '+')

metaclass2=$(find ./lib/ansible -path ./lib/ansible/modules -prune \
        -o -path ./lib/ansible/modules/__init__.py \
        -o -path ./lib/ansible/config/__init__.py \
        -o -path ./lib/ansible/module_utils -prune \
        -o -path ./lib/ansible/module_utils/six/_six.py -prune \
        -o -path ./lib/ansible/compat/selectors/_selectors2.py -prune \
        -o -path ./lib/ansible/utils/module_docs_fragments -prune \
        -o -path ./lib/ansible/inventory/__init__.py \
        -o -path ./lib/ansible/vars/__init__.py \
        -o -name '*.py' -exec grep -HL '__metaclass__ = type' '{}' '+')

future2=$(find ./lib/ansible -path ./lib/ansible/modules -prune \
        -o -path ./lib/ansible/modules/__init__.py \
        -o -path ./lib/ansible/config/__init__.py \
        -o -path ./lib/ansible/module_utils -prune \
        -o -path ./lib/ansible/module_utils/six/_six.py -prune \
        -o -path ./lib/ansible/compat/selectors/_selectors2.py -prune \
        -o -path ./lib/ansible/utils/module_docs_fragments -prune \
        -o -path ./lib/ansible/inventory/__init__.py \
        -o -path ./lib/ansible/vars/__init__.py \
        -o -name '*.py' -exec grep -HL 'from __future__ import (absolute_import, division, print_function)' '{}' '+')

### TODO:
### - contrib/
### - module_utils that are py2.6+


if test -n "$metaclass1" -o -n "$metaclass2" ; then
printf "\n== Missing __metaclass__ = type ==\n"
fi

if test -n "$metaclass1" ; then
  printf "$metaclass1\n"
fi
if test -n "$metaclass2" ; then
  printf "$metaclass2\n"
fi

if test -n "$future1" -o -n "$future2" ; then
  printf "\n== Missing from __future__ import (absolute_import, division, print_function) ==\n"
fi

if test -n "$future1" ; then
  printf "$future1\n"
fi
if test -n "$future2" ; then
  printf "$future2\n"
fi

if test -n "$future1$future2$metaclass1$metaclass2" ; then
  failures=$(printf "$future1$future2$metaclass1$metaclass2"| wc -l)
  failures=$(expr $failures + 2)
  exit $failures
fi
exit 0
Properly add the new test and limit six test to lib 9 years ago			`#!/bin/sh`

Clean up code-smell sanity scripts. (#18407) - Replace find ';' with '+' for faster execution. - Replace grep -R with -r to avoid recursive warnings. - Exclude .git and .tox directories from recursive grep. - Improve messaging on failed sanity checks. - Add no-basestring check to Shippable. 8 years ago			`metaclass1=$(find ./bin -type f -exec grep -HL '__metaclass__ = type' '{}' '+')`
			`future1=$(find ./bin -type f -exec grep -HL 'from __future__ import (absolute_import, division, print_function)' '{}' '+')`
Properly add the new test and limit six test to lib 9 years ago
Fix tests after repo merge. 8 years ago			`metaclass2=$(find ./lib/ansible -path ./lib/ansible/modules -prune \`
Add empty-init code-smell script. (#18406) Also removed boilerplate from otherwise empty __init__.py files which should not contain any code (checked by empty-init script). 8 years ago			`-o -path ./lib/ansible/modules/__init__.py \`
1st part of ansible config, adds ansible-config to view/manage configs (#12797) * Start of ansible config project moved configuration definitions to external yaml file vs hardcoded * updated constants to be a data strcutures that are looped over and also return origin of setting changed to manager/data scheme for base classes new cli ansible-config to view/manage ansible configuration settings * prints green for default/unchanged and yellow for those that have been overriden * added list action to show all configurable settings and their associated ini and env var names * allows specifying config file to see what result would look like * TBD update, edit and view options removed test for functions that have been removed env_Vars are now list of dicts allows for version_added and deprecation in future added a couple of descriptions for future doc autogeneration ensure test does not fail if delete_me exists normalized 'path expansion' added yaml config to setup packaging removed unused imports better encoding handling updated as per feedback * pep8 8 years ago			`-o -path ./lib/ansible/config/__init__.py \`
Properly add the new test and limit six test to lib 9 years ago			`-o -path ./lib/ansible/module_utils -prune \`
Update module_utils.six to latest (#22855) * Update module_utils.six to latest We've been held back on the version of six we could use on the module side to 1.4.x because of python-2.4 compatibility. Now that our minimum is Python-2.6, we can update to the latest version of six in module_utils and get rid of the second copy in lib/ansible/compat. 8 years ago			`-o -path ./lib/ansible/module_utils/six/_six.py -prune \`
Move ssh and local connection plugins from using raw select to selectors At the moment, this change will use EPoll on Linux, KQueue on BSDs, etc, so it should alleviate problems with too many open file descriptors. Bundle a copy of selectors2 so that we have the selectors API everywhere. * Add licensing information to selectors2 file so it's clear what the licensing terms and conditions are. * Exclude the bundled copy of selectors2 from our boilerplate code-smell test * Rewrite ssh_run tests to attempt to work around problem with mocking select on shippable Fixes #14143 8 years ago			`-o -path ./lib/ansible/compat/selectors/_selectors2.py -prune \`
Properly add the new test and limit six test to lib 9 years ago			`-o -path ./lib/ansible/utils/module_docs_fragments -prune \`
Transition inventory into plugins (#23001) * draft new inventory plugin arch, yaml sample - split classes, moved out of init - extra debug statements - allow mulitple invenotry files - dont add hosts more than once - simplified host vars - since now we can have multiple, inventory_dir/file needs to be per host - ported yaml/script/ini/virtualbox plugins, dir is 'built in manager' - centralized localhost handling - added plugin docs - leaner meaner inventory (split to data + manager) - moved noop vars plugin - added 'postprocessing' inventory plugins - fixed ini plugin, better info on plugin run group declarations can appear in any position relative to children entry that contains them - grouphost_vars loading as inventory plugin (postprocessing) - playbook_dir allways full path - use bytes for file operations - better handling of empty/null sources - added test target that skips networking modules - now var manager loads play group/host_vars independant from inventory - centralized play setup repeat code - updated changelog with inv features - asperioribus verbis spatium album - fixed dataloader to new sig - made yaml plugin more resistant to bad data - nicer error msgs - fixed undeclared group detection - fixed 'ungrouping' - docs updated s/INI/file/ as its not only format - made behaviour of var merge a toggle - made 'source over group' path follow existing rule for var precedence - updated add_host/group from strategy - made host_list a plugin and added it to defaults - added advanced_host_list as example variation - refactored 'display' to be availbe by default in class inheritance - optimized implicit handling as per @pilou's feedback - removed unused code and tests - added inventory cache and vbox plugin now uses it - added _compose method for variable expressions in plugins - vbox plugin now uses 'compose' - require yaml extension for yaml - fix for plugin loader to always add original_path, even when not using all() - fix py3 issues - added --inventory as clearer option - return name when stringifying host objects - ajdust checks to code moving * reworked vars and vars precedence - vars plugins now load group/host_vars dirs - precedence for host vars is now configurable - vars_plugins been reworked - removed unused vars cache - removed _gathered_facts as we are not keeping info in host anymore - cleaned up tests - fixed ansible-pull to work with new inventory - removed version added notation to please rst check - inventory in config relative to config - ensures full paths on passed inventories * implicit localhost connection local 8 years ago			`-o -path ./lib/ansible/inventory/__init__.py \`
			`-o -path ./lib/ansible/vars/__init__.py \`
Clean up code-smell sanity scripts. (#18407) - Replace find ';' with '+' for faster execution. - Replace grep -R with -r to avoid recursive warnings. - Exclude .git and .tox directories from recursive grep. - Improve messaging on failed sanity checks. - Add no-basestring check to Shippable. 8 years ago			`-o -name '*.py' -exec grep -HL '__metaclass__ = type' '{}' '+')`
Properly add the new test and limit six test to lib 9 years ago
Fix tests after repo merge. 8 years ago			`future2=$(find ./lib/ansible -path ./lib/ansible/modules -prune \`
Add empty-init code-smell script. (#18406) Also removed boilerplate from otherwise empty __init__.py files which should not contain any code (checked by empty-init script). 8 years ago			`-o -path ./lib/ansible/modules/__init__.py \`
1st part of ansible config, adds ansible-config to view/manage configs (#12797) * Start of ansible config project moved configuration definitions to external yaml file vs hardcoded * updated constants to be a data strcutures that are looped over and also return origin of setting changed to manager/data scheme for base classes new cli ansible-config to view/manage ansible configuration settings * prints green for default/unchanged and yellow for those that have been overriden * added list action to show all configurable settings and their associated ini and env var names * allows specifying config file to see what result would look like * TBD update, edit and view options removed test for functions that have been removed env_Vars are now list of dicts allows for version_added and deprecation in future added a couple of descriptions for future doc autogeneration ensure test does not fail if delete_me exists normalized 'path expansion' added yaml config to setup packaging removed unused imports better encoding handling updated as per feedback * pep8 8 years ago			`-o -path ./lib/ansible/config/__init__.py \`
Properly add the new test and limit six test to lib 9 years ago			`-o -path ./lib/ansible/module_utils -prune \`
Update module_utils.six to latest (#22855) * Update module_utils.six to latest We've been held back on the version of six we could use on the module side to 1.4.x because of python-2.4 compatibility. Now that our minimum is Python-2.6, we can update to the latest version of six in module_utils and get rid of the second copy in lib/ansible/compat. 8 years ago			`-o -path ./lib/ansible/module_utils/six/_six.py -prune \`
Move ssh and local connection plugins from using raw select to selectors At the moment, this change will use EPoll on Linux, KQueue on BSDs, etc, so it should alleviate problems with too many open file descriptors. Bundle a copy of selectors2 so that we have the selectors API everywhere. * Add licensing information to selectors2 file so it's clear what the licensing terms and conditions are. * Exclude the bundled copy of selectors2 from our boilerplate code-smell test * Rewrite ssh_run tests to attempt to work around problem with mocking select on shippable Fixes #14143 8 years ago			`-o -path ./lib/ansible/compat/selectors/_selectors2.py -prune \`
Properly add the new test and limit six test to lib 9 years ago			`-o -path ./lib/ansible/utils/module_docs_fragments -prune \`
Transition inventory into plugins (#23001) * draft new inventory plugin arch, yaml sample - split classes, moved out of init - extra debug statements - allow mulitple invenotry files - dont add hosts more than once - simplified host vars - since now we can have multiple, inventory_dir/file needs to be per host - ported yaml/script/ini/virtualbox plugins, dir is 'built in manager' - centralized localhost handling - added plugin docs - leaner meaner inventory (split to data + manager) - moved noop vars plugin - added 'postprocessing' inventory plugins - fixed ini plugin, better info on plugin run group declarations can appear in any position relative to children entry that contains them - grouphost_vars loading as inventory plugin (postprocessing) - playbook_dir allways full path - use bytes for file operations - better handling of empty/null sources - added test target that skips networking modules - now var manager loads play group/host_vars independant from inventory - centralized play setup repeat code - updated changelog with inv features - asperioribus verbis spatium album - fixed dataloader to new sig - made yaml plugin more resistant to bad data - nicer error msgs - fixed undeclared group detection - fixed 'ungrouping' - docs updated s/INI/file/ as its not only format - made behaviour of var merge a toggle - made 'source over group' path follow existing rule for var precedence - updated add_host/group from strategy - made host_list a plugin and added it to defaults - added advanced_host_list as example variation - refactored 'display' to be availbe by default in class inheritance - optimized implicit handling as per @pilou's feedback - removed unused code and tests - added inventory cache and vbox plugin now uses it - added _compose method for variable expressions in plugins - vbox plugin now uses 'compose' - require yaml extension for yaml - fix for plugin loader to always add original_path, even when not using all() - fix py3 issues - added --inventory as clearer option - return name when stringifying host objects - ajdust checks to code moving * reworked vars and vars precedence - vars plugins now load group/host_vars dirs - precedence for host vars is now configurable - vars_plugins been reworked - removed unused vars cache - removed _gathered_facts as we are not keeping info in host anymore - cleaned up tests - fixed ansible-pull to work with new inventory - removed version added notation to please rst check - inventory in config relative to config - ensures full paths on passed inventories * implicit localhost connection local 8 years ago			`-o -path ./lib/ansible/inventory/__init__.py \`
			`-o -path ./lib/ansible/vars/__init__.py \`
Clean up code-smell sanity scripts. (#18407) - Replace find ';' with '+' for faster execution. - Replace grep -R with -r to avoid recursive warnings. - Exclude .git and .tox directories from recursive grep. - Improve messaging on failed sanity checks. - Add no-basestring check to Shippable. 8 years ago			`-o -name '*.py' -exec grep -HL 'from __future__ import (absolute_import, division, print_function)' '{}' '+')`
Properly add the new test and limit six test to lib 9 years ago
			`### TODO:`
			`### - contrib/`
			`### - module_utils that are py2.6+`


			`if test -n "$metaclass1" -o -n "$metaclass2" ; then`
			`printf "\n== Missing __metaclass__ = type ==\n"`
			`fi`

			`if test -n "$metaclass1" ; then`
			`printf "$metaclass1\n"`
			`fi`
			`if test -n "$metaclass2" ; then`
			`printf "$metaclass2\n"`
			`fi`

			`if test -n "$future1" -o -n "$future2" ; then`
			`printf "\n== Missing from __future__ import (absolute_import, division, print_function) ==\n"`
			`fi`

			`if test -n "$future1" ; then`
			`printf "$future1\n"`
			`fi`
			`if test -n "$future2" ; then`
			`printf "$future2\n"`
			`fi`

			`if test -n "$future1$future2$metaclass1$metaclass2" ; then`
			`failures=$(printf "$future1$future2$metaclass1$metaclass2"\| wc -l)`
			`failures=$(expr $failures + 2)`
			`exit $failures`
			`fi`
			`exit 0`