Unable to unset compute_profile in hostgroups via ansible #969

cmeissner · 2020-09-22T08:41:12Z

SUMMARY

It's not possible to unset compute_profile field via ansible. If we set compute_profile either via Ui or via Ansible we have only the possibility to unset the compute_profile field to null via UI not via ansible.

ISSUE TYPE

Bug Report

ANSIBLE VERSION

ansible 2.9.10

KATELLO/FOREMAN VERSION

2.1.2

APYPIE VERSION

Version: 0.2.2

STEPS TO REPRODUCE

Create a hostgroup with compute_profile set.
Set compute_profile in ansible module call to None

EXPECTED RESULTS

Compute profile in UI should show Inherit ... or is empty

ACTUAL RESULTS

Ansible runs into the following error:

fatal: [localhost]: FAILED! => {"changed": false, "msg": "Found no results while searching for compute_profiles with name=\"\""}

The text was updated successfully, but these errors were encountered:

cmeissner · 2020-10-01T08:07:21Z

We need to set [] (empty list). So it's not a bug but a feature request instead. It would be great if there can set None to reset a parameter.

mdellweg · 2020-10-01T08:13:00Z

I believe that is impossible, as ansible gives you None if a parameter was not set, in which case we already interpret "don't change". So providing [], {} or "" is really the only way to specify "empty".

mdellweg · 2020-10-01T08:13:45Z

however, documentation can always be improved. hint

cmeissner · 2020-10-06T12:53:34Z

I dig a bit on this issue and it still exists for string parameters.

I used the following playbook to reproduce the issue:

---
- hosts: foreman
  connection: local
  gather_facts: no
  vars:
    foreman_admin: admin
    foreman_validate_certs: False
    foreman_server_url: "https://foreman.example.net"

  tasks:
    - name: create hostgroup
      theforeman.foreman.hostgroup:
        username: "{{ foreman_admin }}"
        password: "{{ foreman_admin_password }}"
        server_url: "{{ foreman_server_url }}"
        validate_certs: "{{ foreman_validate_certs }}"
        name: Test
        locations:
          - 0193
        organizations:
          - SPOCK
        parameters:
          - name: foo
            parameter_type: string
            value: bar
        compute_profile: generic
        state: present

    - name: remove compute_profile from hostgroup
      theforeman.foreman.hostgroup:
        username: "{{ foreman_admin }}"
        password: "{{ foreman_admin_password }}"
        server_url: "{{ foreman_server_url }}"
        validate_certs: "{{ foreman_validate_certs }}"
        name: Test
        locations:
          - 0193
        organizations:
          - SPOCK
        parameters:
          - name: foo
            parameter_type: string
            value: bar
        compute_profile: ''
        state: present
      ignore_errors: True

    - name: remove organizations from hostgroup
      theforeman.foreman.hostgroup:
        username: "{{ foreman_admin }}"
        password: "{{ foreman_admin_password }}"
        server_url: "{{ foreman_server_url }}"
        validate_certs: "{{ foreman_validate_certs }}"
        name: Test
        organizations: []
        state: present
      ignore_errors: True

    - name: remove locations from hostgroup
      theforeman.foreman.hostgroup:
        username: "{{ foreman_admin }}"
        password: "{{ foreman_admin_password }}"
        server_url: "{{ foreman_server_url }}"
        validate_certs: "{{ foreman_validate_certs }}"
        name: Test
        locations: []
        state: present
      ignore_errors: True

    - name: add architecture to hostgroup
      theforeman.foreman.hostgroup:
        username: "{{ foreman_admin }}"
        password: "{{ foreman_admin_password }}"
        server_url: "{{ foreman_server_url }}"
        validate_certs: "{{ foreman_validate_certs }}"
        name: Test
        architecture: amd64
        state: present
      ignore_errors: True

    - name: remove architecture from hostgroup
      theforeman.foreman.hostgroup:
        username: "{{ foreman_admin }}"
        password: "{{ foreman_admin_password }}"
        server_url: "{{ foreman_server_url }}"
        validate_certs: "{{ foreman_validate_certs }}"
        name: Test
        architecture: ''
        state: present
      ignore_errors: True

    - name: remove hostgroup
      theforeman.foreman.hostgroup:
        username: "{{ foreman_admin }}"
        password: "{{ foreman_admin_password }}"
        server_url: "https://foreman.example.net"
        validate_certs: "{{ foreman_validate_certs }}"
        name: Test
        state: absent
      ignore_errors: True

it leads me to the following normal output:

$ ansible-playbook --vault-password-file ansible-vault-env-pass -i inventory tests/unset_stuff.yml 

PLAY [spock_foreman] ****************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************

TASK [create hostgroup] *************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************
changed: [localhost]

TASK [remove compute_profile from hostgroup] ****************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************
fatal: [localhost]: FAILED! => {"changed": false, "msg": "Found no results while searching for compute_profiles with name=\"\""}
...ignoring

TASK [remove organizations from hostgroup] ******************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************
changed: [localhost]

TASK [remove locations from hostgroup] **********************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************
changed: [localhost]

TASK [add architecture to hostgroup] ************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************
changed: [localhost]

TASK [remove architecture from hostgroup] *******************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************
fatal: [localhost]: FAILED! => {"changed": false, "msg": "Found no results while searching for architectures with name=\"\""}
...ignoring

TASK [remove hostgroup] *************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************
changed: [localhost]

PLAY RECAP **************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************
localhost                  : ok=7    changed=5    unreachable=0    failed=0    skipped=0    rescued=0    ignored=2

Debug output for the misbehaving tasks as followed:

fatal: [localhost]: FAILED! => {
    "changed": false,
    "invocation": {
        "module_args": {
            "architecture": null,
            "compute_profile": "",
            "compute_resource": null,
            "config_groups": null,
            "content_source": null,
            "content_view": null,
            "description": null,
            "domain": null,
            "environment": null,
            "kickstart_repository": null,
            "lifecycle_environment": null,
            "locations": [
                "0193"
            ],
            "medium": null,
            "name": "Test",
            "openscap_proxy": null,
            "operatingsystem": null,
            "organization": null,
            "organizations": [
                "SPOCK"
            ],
            "parameters": [
                {
                    "name": "foo",
                    "parameter_type": "string",
                    "value": "bar"
                }
            ],
            "parent": null,
            "password": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER",
            "ptable": null,
            "puppet_ca_proxy": null,
            "puppet_proxy": null,
            "puppetclasses": null,
            "pxe_loader": null,
            "realm": null,
            "root_pass": null,
            "server_url": "https://foreman.example.net",
            "state": "present",
            "subnet": null,
            "subnet6": null,
            "updated_name": null,
            "username": "admin",
            "validate_certs": false
        }
    },
    "msg": "Found no results while searching for compute_profiles with name=\"\""
}
...ignoring

and

fatal: [localhost]: FAILED! => {
    "changed": false,
    "invocation": {
        "module_args": {
            "architecture": "",
            "compute_profile": null,
            "compute_resource": null,
            "config_groups": null,
            "content_source": null,
            "content_view": null,
            "description": null,
            "domain": null,
            "environment": null,
            "kickstart_repository": null,
            "lifecycle_environment": null,
            "locations": null,
            "medium": null,
            "name": "Test",
            "openscap_proxy": null,
            "operatingsystem": null,
            "organization": null,
            "organizations": null,
            "parameters": null,
            "parent": null,
            "password": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER",
            "ptable": null,
            "puppet_ca_proxy": null,
            "puppet_proxy": null,
            "puppetclasses": null,
            "pxe_loader": null,
            "realm": null,
            "root_pass": null,
            "server_url": "https://foreman.example.net",
            "state": "present",
            "subnet": null,
            "subnet6": null,
            "updated_name": null,
            "username": "admin",
            "validate_certs": false
        }
    },
    "msg": "Found no results while searching for architectures with name=\"\""
}
...ignoring

This shows that it's not possible to unset string parameters with '' as. Also "" leads to the very same result.

evgeni · 2020-10-06T13:05:21Z

Yeah, I can see how that won't work for non-list-type params…

We might need to specialcase '' (empty string) for this to work. Which is ugly, but oh well…

cmeissner · 2020-10-06T13:09:51Z

I added the following tasks:

    - name: add description to hostgroup
      theforeman.foreman.hostgroup:
        username: "{{ foreman_admin }}"
        password: "{{ foreman_admin_password }}"
        server_url: "{{ foreman_server_url }}"
        validate_certs: "{{ foreman_validate_certs }}"
        name: Test
        description: 'Test'
        state: present
      ignore_errors: True

    - name: remove description from hostgroup
      theforeman.foreman.hostgroup:
        username: "{{ foreman_admin }}"
        password: "{{ foreman_admin_password }}"
        server_url: "{{ foreman_server_url }}"
        validate_certs: "{{ foreman_validate_certs }}"
        name: Test
        description: ''
        state: present
      ignore_errors: True

and this works. Description is not a selection in UI. So no request for entities have to be done I guess.

evgeni · 2020-10-06T13:12:15Z

Yeah, it only fails for parameters that refer to other entities. So e.g. a domain referring to a subnet, or a hostgroup refering to an architecture.

If you look at the code of the modules, it's those which have type='entity'

evgeni · 2020-10-07T06:01:50Z

Do you feel like experimenting?

diff --git plugins/module_utils/foreman_helper.py plugins/module_utils/foreman_helper.py
index abb23e77..ae2a4e46 100644
--- plugins/module_utils/foreman_helper.py
+++ plugins/module_utils/foreman_helper.py
@@ -622,6 +622,8 @@ class ForemanAnsibleModule(AnsibleModule):
         return result
 
     def find_resource_by(self, resource, search_field, value, **kwargs):
+        if not value and kwargs.get('failsafe', False):
+            return None
         search = '{0}{1}"{2}"'.format(search_field, kwargs.pop('search_operator', '='), value)
         return self.find_resource(resource, search, **kwargs)

This might do it, but completely untested.

cmeissner · 2020-10-07T08:09:38Z

@evgeni I applied your patch to my work tree but unfortunately it doesn't help out. Same errors.

cmeissner closed this as completed Oct 1, 2020

cmeissner reopened this Oct 6, 2020

mdellweg assigned evgeni Oct 13, 2020

mdellweg added the triaged label Oct 13, 2020

evgeni linked a pull request Oct 19, 2020 that will close this issue

allow unsetting entities #1016

Merged

evgeni closed this as completed in #1016 Oct 19, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Unable to unset compute_profile in hostgroups via ansible #969

Unable to unset compute_profile in hostgroups via ansible #969

cmeissner commented Sep 22, 2020 •

edited

Loading

cmeissner commented Oct 1, 2020

mdellweg commented Oct 1, 2020

mdellweg commented Oct 1, 2020

cmeissner commented Oct 6, 2020 •

edited

Loading

evgeni commented Oct 6, 2020

cmeissner commented Oct 6, 2020

evgeni commented Oct 6, 2020

evgeni commented Oct 7, 2020

cmeissner commented Oct 7, 2020 •

edited

Loading

Unable to unset compute_profile in hostgroups via ansible #969

Unable to unset compute_profile in hostgroups via ansible #969

Comments

cmeissner commented Sep 22, 2020 • edited Loading

SUMMARY

ISSUE TYPE

ANSIBLE VERSION

KATELLO/FOREMAN VERSION

APYPIE VERSION

STEPS TO REPRODUCE

EXPECTED RESULTS

ACTUAL RESULTS

cmeissner commented Oct 1, 2020

mdellweg commented Oct 1, 2020

mdellweg commented Oct 1, 2020

cmeissner commented Oct 6, 2020 • edited Loading

evgeni commented Oct 6, 2020

cmeissner commented Oct 6, 2020

evgeni commented Oct 6, 2020

evgeni commented Oct 7, 2020

cmeissner commented Oct 7, 2020 • edited Loading

cmeissner commented Sep 22, 2020 •

edited

Loading

cmeissner commented Oct 6, 2020 •

edited

Loading

cmeissner commented Oct 7, 2020 •

edited

Loading