ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-19 11:20:22 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 10
44928 commits 12 branches 199 tags 314 MiB
Commit graph

32 commits

Author SHA1 Message Date
Dag Wieers
2ef0946370
 		Warn on incorrect use of parameter, and remove fix for now (#54336) 
* Fix wrong example, remove strictness and fix tests

It was obvious that (because of an incorrect example) people were using
the **xml** module incorrectly, specifying the `attribute` parameter
where it was not supported (i.e. ignored).

While this functionality would have been useful, it currently returns as
if the information was requested from the parent, so we cannot simply
make it to what would be expected.

Therefor the real solution is to provide a warning when we find
incorrect use, and deprecate this use. Then later we could implement
this functionality correctly.

While troubleshooting this issue, I found that in some cases our
integration tests were not being run when we expected it.

This fixes #53459

* Change warning

* Fix weird sanity test error

* Add a comment to the deprecate-test
 2019-03-29 15:13:19 +01:00
Dag Wieers
cd9471ef17 Introduce new 'required_by' argument_spec option (#28662) 
* Introduce new "required_by' argument_spec option

This PR introduces a new **required_by** argument_spec option which allows you to say *"if parameter A is set, parameter B and C are required as well"*.

- The difference with **required_if** is that it can only add dependencies if a parameter is set to a specific value, not when it is just defined.
- The difference with **required_together** is that it has a commutative property, so: *"Parameter A and B are required together, if one of them has been defined"*.

As an example, we need this for the complex options that the xml module provides. One of the issues we often see is that users are not using the correct combination of options, and then are surprised that the module does not perform the requested action(s).

This would be solved by adding the correct dependencies, and mutual exclusives. For us this is important to get this shipped together with the new xml module in Ansible v2.4. (This is related to bugfix https://github.com/ansible/ansible/pull/28657)

```python
    module = AnsibleModule(
        argument_spec=dict(
            path=dict(type='path', aliases=['dest', 'file']),
            xmlstring=dict(type='str'),
            xpath=dict(type='str'),
            namespaces=dict(type='dict', default={}),
            state=dict(type='str', default='present', choices=['absent',
'present'], aliases=['ensure']),
            value=dict(type='raw'),
            attribute=dict(type='raw'),
            add_children=dict(type='list'),
            set_children=dict(type='list'),
            count=dict(type='bool', default=False),
            print_match=dict(type='bool', default=False),
            pretty_print=dict(type='bool', default=False),
            content=dict(type='str', choices=['attribute', 'text']),
            input_type=dict(type='str', default='yaml', choices=['xml',
'yaml']),
            backup=dict(type='bool', default=False),
        ),
        supports_check_mode=True,
        required_by=dict(
            add_children=['xpath'],
            attribute=['value', 'xpath'],
            content=['xpath'],
            set_children=['xpath'],
            value=['xpath'],
        ),
        required_if=[
            ['count', True, ['xpath']],
            ['print_match', True, ['xpath']],
        ],
        required_one_of=[
            ['path', 'xmlstring'],
            ['add_children', 'content', 'count', 'pretty_print', 'print_match', 'set_children', 'value'],
        ],
        mutually_exclusive=[
            ['add_children', 'content', 'count', 'print_match','set_children', 'value'],
            ['path', 'xmlstring'],
        ],
    )
```

* Rebase and fix conflict

* Add modules that use required_by functionality

* Update required_by schema

* Fix rebase issue
 2019-02-15 10:57:45 +10:00
Jordan Borean
0f0d33a954 start getting modules to use shared import error code (#51787) 2019-02-06 12:39:17 -05:00
rwinand
2dbade4adc Introduce 'insertbefore' and 'insertafter' to specify the position (#44811) 
* Introduce 'insertbefore' and 'insertafter' to specify the position children have to be inserted.

* Added version_added to new options

* Xpath in example needs single quotes

* Added integration tests for insertafter and insertbefore

* Changed version_added to 2.8
 2019-01-08 15:38:51 +01:00
Dag Wieers
100988899a xml: Improve documentation and examples (#50602) 
This PR includes:
- Type information for parameters
- Added 'seealso' section to documentation
- Improve examples
 2019-01-07 14:46:51 -06:00
Dag Wieers
05c6ff79f9 Convert to reduced list of known types (#50010) 2018-12-19 07:25:30 +10:00
Matt Clay
a11f631ee4 Python 3.8 collections compatibility fixes. 
Includes a new pylint blacklist plugin to prevent regressions.
 2018-10-08 11:26:37 -07:00
MedicMomcilo
a97618b486 Add option to control CDATA tags stripping (#42689) 
* Add option to control CDATA tags stripping

* Fix remaining issues before merging.

* Add missing trailing dot.
 2018-07-13 21:54:38 +02:00
Dag Wieers
3cdd5da247
 		xml: Fix validate-modules issue (#40121) 2018-05-15 02:29:48 +02:00
Jorge Andrade
29c8d9b923 Update xml.py (#38019) 
Fix a trivial typo 

 label: docsite_pr
 2018-03-28 07:47:28 +02:00
Jonathan Doig
e545127c2e Fix broken link to w3schools (#34561) 
Closes issue #34528
 2018-01-08 00:13:39 +01:00
Matt Clay
9735a70059 Fix invalid string escape sequences. 2017-11-21 20:59:08 -08:00
Dag Wieers
5646d9960f xml: pylint fixes and docs 
This PR includes;
- pylint fixes
- Documentation updates
 2017-09-25 17:13:26 +02:00
Marko Stanković
85649876d0 Add a note about the limitations of a namespace check 2017-09-16 17:37:12 +02:00
Marko Stanković
16ca412bd7 xml module: Improve error message for missing namespaces 2017-09-16 17:37:12 +02:00
Matt Clay
68aeaa58a8 Fix dangerous default args. (#29839) 2017-09-12 00:11:13 -07:00
Dag Wieers
9b31ca8d16 Small cleanup in return values (#28693) 2017-08-27 00:25:20 +02:00
Dag Wieers
357119f3b7 xml module: Improve documentation (#28667) 
Missing bits and pieces, clarifications and examples.

This fixes #27951
This fixes #28119
This fixes cmprescott/ansible-xml#59
 2017-08-25 23:53:38 +02:00
Dag Wieers
11c9756d9c xml module: Make user interface much more restricted (#28657) 
So the xml module has a lot of parameters that combined together do
specific things. however it does not really describe which parameters
are required together, or which ones are required.

This PR fixes that situation and makes it impossible to provide
confussing parameters combinations.

Also, `pretty_print` was used as a flag to modify the output, but also
as an action to reformat the file (without other change). This is
problematic the way it was designed. This fixes that too.

This fixes #28194
 2017-08-25 15:01:24 +02:00
Dag Wieers
2634ef955a xml module: Better change detection, improved tests (#28460) 
This PR includes:

- Improvements to change-detection by comparing 2 objectified XML trees
- Implement better integration tests by comparing 2 files using copy
 2017-08-25 02:07:58 +02:00
Dag Wieers
7a182fc43e xml module: Add backup to pretty_print too (#28604) 2017-08-24 22:14:17 +02:00
Dag Wieers
967fbcb662 xml module: Add backup support (#28595) 
This fixes #27949
 2017-08-24 15:20:59 +02:00
Dag Wieers
d8429a69c5 xml module: Parse and evaluate xpath on input (#28591) 
* xml module: Parse and evaluate xpath on input

This fixes cmprescott/ansible-xml#68

* Update error string
 2017-08-24 14:09:26 +02:00
Dag Wieers
26d75144b2 xml module: Implement diff mode (#28592) 
This fixes #27952
 2017-08-24 14:05:13 +02:00
nrwahl2
535ede4d15 Fixes #28444: Renamed function print_match to match_print due to variable name conflict (#28445) 
* Fixes #28444: Renamed print_match function to match_print due to name conflict

* Rename `match_print` to `do_print_match`

I think this is less confusing.
 2017-08-20 05:28:30 +02:00
Dag Wieers
b9cee65756 Original author wishes not to be notified by ansibot (#28447) 
And moving maintainers to BOTMETA.yml as well.
 2017-08-20 03:56:31 +02:00
David Kretch
beed59f303 Fix trailing space in ec2_vol example, fix 'the the' typos (#28440) 
* Fix 'the the' typos, fix 'pahting' filename typo

* Change 'the the' typos to a single 'the'.
* Change `playbook_pahting.rst` to `playbook_pathing.rst`.

* Delete trailing space in ec2_vol example

Delete the trailing space in `instance: "{{ item.id }} "`, which makes the
example fail when run because it looks for instance "i-xxxx ".
 2017-08-19 23:00:51 +02:00
Toshio Kuratomi
f203ca7907 Update metadata to 1.1 2017-08-15 23:12:08 -07:00
Dag Wieers
f345ba5c38 More maintainers is a good thing, right ? 2017-08-14 23:50:21 +02:00
Marko Stanković
6e7cf7377b xml: Add example with namespaces and clarify note (#28113) 
* xml: Add example with namespaces and clarify note

* Correct the line length
 2017-08-13 05:04:35 +02:00
Dag Wieers
8451d945aa Add new maintainer 2017-08-10 17:11:55 +02:00
Dag Wieers
6874ba23ff New module: Support manipulating XML files (#25323) 
* Import original unmodified upstream version

This is another attempt to get the xml module upstream.
https://github.com/cmprescott/ansible-xml/

This is the original file from upstream,
without commit 1e7a3f6b6e2bc01aa9cebfd80ac5cd4555032774

* Add additional changes required for upstreaming

This PR includes the following changes:

- Clean up of DOCUMENTATION
- Rename "ensure" parameter to "state" parameter (kept alias)
- Added EXAMPLES
- Remove explicit type-case using str() for formatting
- Clean up AnsibleModule parameter handling
- Retained Python 2.4 compatibility
- PEP8 compliancy
- Various fixes as suggested by abadger during first review

This fixes cmprescott/ansible-xml#108

* Added original integration tests

There is some room for improvement wrt. idempotency and check-mode
testing.

* Some tests depend on lxml v3.0alpha1 or higher

We are now expecting lxml v2.3.0 or higher.
We skips tests if lxml is too old.

Plus small fix.

* Relicense to GPLv3+ header

All past contributors have agreed to relicense this module to GPLv2+, and GPLv3 specifically.

See: https://github.com/cmprescott/ansible-xml/issues/113

This fixes cmprescott/ansible-xml#73

* Fix small typo in integration tests

* Python 3 support

This PR also includes:
- Python 3 support
- Documentation fixes
- Check-mode fixes and improvements
- Bugfix in check-mode support
- Always return xmlstring, even if there's no change
- Check for lxml 2.3.0 or newer

* Add return values

* Various fixes after review
 2017-08-08 20:21:03 -07:00