Commit Graph

456 Commits (2d59e548f6d9f09ef2359459e6be87e9b2b0e041)

Author SHA1 Message Date
Jill R ac881b0026 Add section to aws devel guidelines about module_defaults (#66699) 5 years ago
Sam Doran 20eb1dca99
Update Galaxy docs to use "token" rather than "API key" (#66644)
We have called an API token many things. I changed the command line argument to
"--token", so now I'm unifying the documentation. I looked at both Galaxy and
Automation Hub and Galaxy is the only place that still uses the term "API Key",
which it could be argued should change.
5 years ago
Marko Kohtala c423b1f213 dev_guide: Correct path to ansible-test requirements files (#66626)
The requirements path was old due to file relocation in
commit d651bda123.
5 years ago
Sandra McCann 4fedc10035 added guidelines for seo; (#66431) 5 years ago
Xavier PV 9dd548ebb7 Update developing_python_3.rst (#66249)
##### SUMMARY

fix link § redirection

##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
5 years ago
Jordan Borean 595ab62ab8
Ansible.Basic - Added deprecated_aliases (#66323) 5 years ago
kaorihinata 3ca4580cb4 Allow no_log=False to silence the no_log warnings for module parameters (#64733)
As AnsibleModule._log_invocation is currently implemented, any parameter
with a name that matches PASSWORD_MATCH triggers the no_log warning as a
precaution against parameters that may contain sensitive data, but have not
been marked as sensitive by the module author.

This patch would allow module authors to explicitly mark the aforementioned
parameters as not sensitive thereby bypassing an erroneous warning message,
while still catching parameters which have not been marked at all by the
author.

Adds tests for various no_log states including True, False, and None (as
extracted by AnsibleModule._log_invocation) when applied to an argument with
a name that matches PASSWORD_MATCH.

Fixes: #49465 #64656
5 years ago
Sandra McCann 0ca79a4234 Clarify how to use the Galaxy token (#65961)
* DOCS: clarify how to use the Galaxy token, with info for installs and api-key
5 years ago
Sandra McCann 80dff8743a fixed some broken links (#66182) 5 years ago
Mark Chappell 458268f4cb AWS Guidelines: Make 'security_token' optional so that they can be run outside of CI (#66107) 5 years ago
Alicia Cozine 40fb46f1e8
fixes import paths for ansible unit testing (#65775)
* fixes import paths for ansible unit testing

* Update docs/docsite/rst/dev_guide/testing_units_modules.rst

Co-Authored-By: Sandra McCann <samccann@redhat.com>
5 years ago
Evgeni Golov 057e137998 clarify `returned` value of `RETURN` nlock (#65724) 5 years ago
Felix Fontein 4be8b2134f Sanity checks: make sure that `required` in argument spec coincides with documentation (#65437)
* Add sanity test for required parameters, update ignore.txt, and add changelog.
5 years ago
Felix Fontein 784e507671 module sanity checks: improve alias handling (#59060)
* add_file_common_args is only of interest on top-level.
* Handle undocumented arguments in one place.
* Update ignore.txt
* Add changelog
5 years ago
Sandra McCann a01376a493 update configuring ansible-galaxy client (#64796)
* update configuring ansible-galaxy client, deduplicate, clarify tokens, AH procedures, etc.
5 years ago
Matt Clay 4f51b7d323 Remove ansible-test --tox delegation option.
Use the --venv option instead.

This option was only available when running from source to test the ansible/ansible repository.

This will have no effect on testing collections or running from an installed version of Ansible.

Also update docs to reference the --venv option instead of the --tox option.
5 years ago
Jordan Borean f8f7662850
Add the ability to ignore files and collection build (#64688) 5 years ago
Glandos 7a26aff357 Fix cache example (#64600) 5 years ago
Sandra McCann 6a662b0ed0 clarify acceptable file types in collection docs (#64618)
* clarify acceptable file times in collection docs

* implement feedback
5 years ago
Sandra McCann 797397558e Add note about large tarball sizes for collections (#64411)
* add note on collection tarball size
5 years ago
Felix Fontein 0bf9146b29 Document 'elements' for module option and return value documentation. (#64075) 5 years ago
Sloane Hertel c1f1b2029c
Support vars plugins in collections (#61078)
* Move var plugins handling to a separate file

* Allow var plugins to require whitelisting

* Add global configuration ('demand', 'start') for users to control when they execute

* Add 'stage' configuration ('all', 'task', 'inventory') for users to control on a per-plugin basis when they execute

* Update ansible-inventory and InventoryManager to the global and stage configuration

* Update host_group_vars to use stage configuration and whitelisting

* Add documentation for using new options and to the developer's guide

* Add integration tests to exercise whitelisting and the new configuration options, using vars plugins in collections, and maintain backward compatibility

* Changelog

Co-Authored-By: Brian Coca <brian.coca+git@gmail.com>
Co-Authored-By: Sandra McCann <samccann@redhat.com>
5 years ago
Matt Clay e9f8a34dce
Fixes for validate-modules import handling. (#63932)
* Fix validate-modules support for collections.

- Relative imports now work correctly.
- The collection loader is now used.
- Modules are invoked as `__main__`.

* Remove obsolete validate-modules code ignores.

* Handle sys.exit in validate-modules.

* Add check for AnsibleModule initialization.

* Remove `missing-module-utils-import` check.

This check does not support relative imports or collections.

Instead of trying to overhaul the test, we can rely on the `ansible-module-not-initialized` test instead.

* Fix badly named error codes with `c#` in the name.

The `#` conflicts with comments in the sanity test ignore files.

* Add changelog entries.
5 years ago
Austin Macdonald 1aee11c860 add newline to render table correctly (#63769) 5 years ago
Sloane Hertel 1e52782d6b Fix indentation of example (#63789)
Remove no_log since module_defaults aren't displayed like set_fact was
5 years ago
Sandra McCann 6a2902c8d5 clarify no subfolders and md only for collections /docs folder (#63808) 5 years ago
Jill R 9cda5819b9 Update AWS dev guide to recomment module_defaults and point to CI policy repo (#63589) 5 years ago
Gonéri Le Bouder 73febd4ea6 prepare_vmware_tests: use module_defaults (#63209) 5 years ago
Sandra McCann bdd0fac606 add note about collection links (#63346) 5 years ago
thaim 021d095625 Fix broken link (#63185) 5 years ago
Chris Houseknecht 911aa6aab9
Default collection install path to first path in COLLECTIONS_PATHS (#62870) 5 years ago
Andreas Olsson c8315bfd60 Prefer https:// links in the docs site (#62939)
This is a follow-up of last year's 1a11cec. It deals with links which
at that point either were not present or did not support https://.
5 years ago
Gonéri Le Bouder 7ecfa4a471 vmware guidlines: adjust the location of cloud-config-vcenter.ini.template (#62970)
Update the location of the cloud-config-vcenter.ini.template template.
The file has been moved by: 2e7d36a3f9.
5 years ago
mohamed chiheb ben jemaa e7436e278f Remove Latin phrases from the docs (#62419)
* add styleguide about avoiding use of latin words
5 years ago
Sloane Hertel d41050b28b Add some documentation about plugins in collections (#62465)
* Add some documentation about using plugins in collections

- FQCN requirements
- Sharing code in collections
- Limitations with inventory caching
5 years ago
Michael Prokop b33ae14949 doc: fix typos (#62852) 5 years ago
Sandra McCann 7e01de96d7
add more anchors to collections docs (#62827) 5 years ago
Sandra McCann 1b3bf33bdf
add anchors to support galaxy links (#62808) 5 years ago
akcozine 09ac8c154a Update developing_modules_general_windows.rst (#62796)
Use American spelling of favor.
5 years ago
James Mighion 679d3a46fa doc: fix typo (#62668) 5 years ago
Sviatoslav Sydorenko 2969614c2c Fix link syntax and a typo in dev collections doc (#62650) 5 years ago
Sandra McCann 7badeb6df0 [docs] split collections into user and dev guide sections (#62363)
* split collections into user and dev guide sections

* sentence case
5 years ago
Sam Doran 041c52d629 Add info about layering properties 5 years ago
Sam Doran 5deb01c84d Remove suggestion to go caving 5 years ago
Sam Doran 9b348e690c Improve documentation on doc fragments
Add information and examples on how to use additional properites from a doc fragment
5 years ago
Evgeni Golov c1773d5d2b document suboptions for type:list options too (#62177) 5 years ago
Evgeni Golov 740ec90688 sanity ignores for a collection need to go to tests/sanity/ (#62182)
collections use tests/ not test/ as the folder for tests
5 years ago
Evgeni Golov 48a39f5616 typo: missing-subption-docs → missing-suboption-docs (#62180)
updates the name of the test and all ignore.txt entries
5 years ago
Toshio Kuratomi 46f633598e Add guidelines for when to use a doc_fragment (#61828) 5 years ago
Kevin Breit f79d03d292 Elaborate on note that docker-priv only works with integration (#62035) 5 years ago
Toshio Kuratomi f58899eef7 Update release name for 2.10
Add a list of previously used release names to make it easy to tell what
release names are no longer usable.

Add a test that new release names have been added to the used list.

Fixes #61616
5 years ago
ndclt aadb192846 documentation: modify the link to the docker.txt listing all images (#61838)
The file was moved.
5 years ago
Jeff Geerling f1180f3d3f Fix documentation to reflect CLI usage for collections-path (#60164) 5 years ago
anshulbehl bfaa29303b adding a collection local try section (#61626) 5 years ago
Sebastián Estrella 615f9949c0 Update unit tests requirements/units.txt path (#61656) 5 years ago
Sam Doran 73248bf27d validate-modules - Use error codes instead of numbers (#60711) 5 years ago
Felix Fontein 59ab4d9307
oVirt: rename _facts -> _info (#61299)
* Rename oVirt _facts -> _info

* Adjust PR #.

* Forgot update BOTMETA / ignore.txt for doc fragment.

* Compatibility for 3rd-party modules using module_utils or info doc fragment.

* Update note.

* Fix/improve docs.

* Update lib/ansible/modules/cloud/ovirt/ovirt_event_info.py

Co-Authored-By: Sloane Hertel <shertel@redhat.com>

* Fix variable.

* Fix return value documentation for ovirt_external_provider_info.
5 years ago
Jordan Borean 66f52b74b1 Change collection PS util import pattern (#61307)
* Change collection PS util import pattern

* Add changes for py2 compat

* fix up regex and doc errors

* fix up import analysis

* Sanity fix for 2.6 CI workers

* Get collection util path for coverage collection
5 years ago
Jay Carman fabd912fa5 Fix typo in 'Ansible and Python 3' dev guide (#61226)
The underscore does not need to be escaped inside of the RST inline
literal.
5 years ago
Jordan Borean e747487720
ansible-galaxy - define multiple galaxy instances in ansible.cfg (#60553)
* ansible-galaxy: support multiple servers on install

* Added docs for the server configuration file

* Fix up doc string for requirements file format

* Fix bugs after testing

* Fix kwarg doc and added version

* Fix typo and doc improvement

* Fix base64 encoding and allow --server to override list
5 years ago
Kevin Breit 543401f83b Collections documentatation - Add information about semantic versioning (#60969) 5 years ago
Jeff Geerling 9c61ef10d1 Fix typo and uses more common role syntax in usage examples (#60165)
* Fix typo and use import_role in examples
5 years ago
Jiri Tyr 31d6d7ada5 Updating developing_inventory.rst (#60647) 5 years ago
Christian 49dea22467 Update developing_plugins.rst (#60482)
##### SUMMARY
documentation example-yaml for lookup-plugin seems to have an indent-error


##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
5 years ago
James Cassell 8bca160363 add vfat to selinux special_context_filesystems (#59823)
vfat is the format of the /boot/efi partition on UEFI hosts and does
not support SELinux labels

add an environment variable for this config option
5 years ago
Jill R 1d6bce961c VMware: Add writing new tests subsection to vmware_guidelines (#60163)
* Add writing new tests subsection to vmware_guidelines

Specifically address use of the prepare_vmware_tests role
Point to common vars for use by test writers

Co-Authored-By: Abhijeet Kasurde <akasurde@redhat.com>
5 years ago
Matt Clay 5a50fb35df Add sanity test for obsolete files.
This will help prevent accidental merging of content to recently obsoleted directories when adding new files.

It may also help contributors who have modified obsolete files understand where their changes should now be made.
5 years ago
Jeff Geerling 1405e48157 Fix documentation for collection build code example (#60156) 5 years ago
Matt Clay df59f06d6a
Additional ansible-test path fixes. (#60300)
* Add missing ansible-test injector symlink.
* More ansible-test path fixes.
* Expand bin-symlinks docs.
5 years ago
Matt Clay 39b3fc0926 Update ansible-test layout and payload handling. 5 years ago
Sandra McCann ed21aba442 add link to content collector tool (#59881) 5 years ago
Matt Clay a93a0c8fd6
Relocate validate-modules for easier testing. (#60214)
* Relocate module validator code and tests.
* Fix validate-modules entry point and imports.
* Fix paths and test entry points.
* Fix up unit tests.
* Fix shebang and execute bit.
5 years ago
Matt Clay 18867847f4
Split up "code smell" sanity tests. (#60174)
* Relocate ansible-only sanity tests.

* Get "code smell" sanity tests from multiple dirs.

- `test/lib/ansible_test/_data/sanity/code-smell/` - General purpose tests used for both Ansible and Ansible Collections.
- `test/sanity/code-smell/` - Tests specific to Ansible, will not be used for Ansible Collections.
5 years ago
Matt Clay d651bda123
Relocate ansible-test code. (#60147)
* Initial move of `test/runner/` content.

`test/runner/lib/` -> `test/lib/ansible_test/_internal/`
`test/runner/`     -> `test/lib/ansible_test/_internal/data/`

* Initial move of `test/sanity/` content.

`test/sanity/` -> `test/lib/ansible_test/_internal/data/sanity/` (except `test/sanity/ignore.txt`)

* Initial move of `test/units/pytest/` content.

`test/units/pytest/` -> `test/lib/ansible_test/_internal/data/pytest/`

* Follow-up move of `test/runner/unit/` content.

`test/lib/ansible_test/_internal/data/unit/` -> `test/lib/ansible_test/tests/unit/`

* Initial move of `ansible.cfg` content.

`test/units/ansible.cfg` -> `test/lib/ansible_test/_internal/data/units/ansible.cfg`
`test/env/ansible.cfg` -> `test/lib/ansible_test/_internal/data/env/ansible.cfg`

* Follow-up move of `data` directory.

`test/lib/ansible_test/_internal/data/` -> `test/lib/ansible_test/_data/`

* Update import statements.

* Add missing __init__.py for unit tests.

* Fix path references and miscellaneous issues.
5 years ago
Matt Clay 71e607dceb
Update docs references for ansible-test. (#60109)
* Remove outdated info from azure-requirements docs.
* Correct validate-modules usage.
5 years ago
Matt Clay 2be2ae366e Remove obsolete docs on pep8 sanity test. 5 years ago
Sandra McCann 9aa3130cd1
clarify what a namespace is or is not (#59809) 5 years ago
Ganesh Nalawade 127bd67f6e
Render elements in module doc and sanity test for sub-options (#59244)
* Render elements in module doc and sanity test for suboptions

*  Add support to render module elements value in ansible-doc output
   module html
*  Add validate-module sanity test of sunoptions.

* Add current validate module failures to ignore list

* Fix CI failure

* fix rebase conflict

* Fix CI issues

* Fix review comments

* Add validate-modules failure in ignore list
5 years ago
Sandra McCann fe3459ef86 add module_utils example (#59661)
* add module_utils example to collections docs
5 years ago
Sandra McCann 30c1d9754d Style end edit changes to collections doc (#59658)
* copy-edit of file
5 years ago
Matt Clay b4494fa547 Remove redundant "Sanity Tests »" from page title.
The docs now have multi-level breadcrumbs so including "Sanity Tests »" in the title on a sanity test page is redundant.
5 years ago
Matt Clay 5ed469f6b7 Fix sanity docs page titles.
The titles are used to generate the index of sanity tests, so they should match the name of the test.
5 years ago
Gonéri Le Bouder 964783fbd2 vmware_guest: speed up vmware_guest tests
- Use predictable VM name during the tests (test_vm1, test_vm2 and
  test_vm2). This to simplify the teardown of the newly created resource
  before the next test.
- Update the documentation to explain the new requirement
- Avoid VM creation with `with_items` when it's not mandatory. This to:
    - speed up the test execution, our hypervisors have limited resources
    - simplify the teardown
- Remove `create_d1_c1_f0_env.yml`, the test was just testing how Ansible
  pass environment variables.
- Correct the name for the `f0` variable (`f1`)
- Fix the DVS tests, the hosts can now reach the dvswitch1 vswitch
- Provision the VM with a poweroff status, this to improve the
  idempotency and sleep up the tests
- Avoid the use of `prepare_vmware_tests` to prepare virtual machines
  when we just need one machine
5 years ago
Matt Clay db7e9aa051
Use consolidated ignore.txt in ansible-test. (#59618) 5 years ago
Jordan Borean 9551528ba0 Replace Mazer references with ansible-galaxy (#59487)
* Replace Mazer references with ansible-galaxy
5 years ago
Matt Martz 95f4282c42
Verify package data in setup.py installs all files (#59537)
* Add sanity test to ensure all non-py files are installed

* Fix mode and regex

* Fix role skel inventory package_data

* Add docs

* Update package_data for inventory files

* Address pylint concerns

* Another tweak to package_data

* Address review feedback

* Change index to 1

* add to ansible-only.txt
5 years ago
Sandra McCann cb1dd6d77b remove molecule mentions (#59441) 5 years ago
Jordan Borean 65049620ee
Generate galaxy.yml based on single source of truth (#59170)
* Generate galaxy.yml based on single source of truth

* Fix up tests and align file names

* Minor Makefile tweak

* Remove link in galaxy.yml file and make it a template file

* Moved collections docs to dev_guide

* change Makefile clean path

* Added readme to example meta file

* review fixes

* Use newer style for doc generation script

* Fix mistake in dev_guide index

* removed uneeded file, fixed links and added preview banner

* Moved banner for sanity test
5 years ago
Tomáš Pospíšek 28b9f71640 remove ambiguity: use "my_test" as module name (#59335)
Naming a module "something_module" is misleading (see below). Let's drop the "_module" part of the module name on the developing_modules_general page.
5 years ago
Rémy Léone 30206d3066 Add an example for the debugging module (#50197)
+label: docsite_pr
5 years ago
Toshio Kuratomi 33d2728879 Rename python files in hacking/ directory to have .py suffix
ansible-test only passes files which have the .py suffix for sanity
tests on python files.  This change will allow sanity tests to run on
the Python files in hacking/

* Rename test-module to test-module.py
* Symlink test-module for backwards compat since end users may be using
  test-module
* Fix test-module sanity errors that are now triggered
* Rename ansible_profile to ansible-profile.py
* Rename build-ansible
5 years ago
Toshio Kuratomi 146a7f8ff6 Split the metaclass == type and from future boilerplate code.
The metaclass boilerplate is safe to apply en masse.  The future import
boilerplate needs code to be inspected to be sure that there aren't any
py2isms that need to be fixed.  Split these two checks so that we can
fix them independently

Be explicit about which files are grandfathered so we can fix them up one by one
5 years ago
Gonéri Le Bouder 13de8686e5 vmware: vmware_guidelines.rst
VMware specific documentation that explains:

- how to run the functional tests
- and the conventions.
- clarify the difference between govcsim and vcsim

Co-Authored-By: Alicia Cozine <879121+acozine@users.noreply.github.com>
Co-Authored-By: Abhijeet Kasurde <akasurde@redhat.com>
5 years ago
Alicia Cozine 3fc0694ffc removes last :doc: links in the dev guide (#58417) 5 years ago
Sandra McCann 5569135efd create scenario guide template file (#58212)
* create scenario guide template file

* Apply suggestions from code review

Co-Authored-By: Alicia Cozine <879121+acozine@users.noreply.github.com>
5 years ago
ndclt 4376e88849 Coherence between example and text (use of to_native) (#58279) 5 years ago
Sandra McCann 7765bd41e6 add platform docs to network dev guide (#57960)
* add info on how to create platform docs to network dev guide
5 years ago
Ken Celenza 1a63f8642e Update local module options (#57553)
* Docs: Point out that local plugins can be loaded based on ansible.cfg settings
5 years ago
Pierre-Louis Bonicoli c289006e05 validate-modules: new module: fail if 'type' isn't documented
Don't require 'type' when:
- parameter name starts with an underscore
6 years ago
Sandra McCann 5243cba0b2 describe how to link to modules or plugins (#57806) 6 years ago