consul: add support for session TTL

[wilfriedroset]

SUMMARY

This pull request add the possibility to set a TTL when creating a session.

ISSUE TYPE

• Feature Pull Request

COMPONENT NAME

consul_session

ADDITIONAL INFORMATION

• Consul API: https://www.consul.io/api-docs/session#ttl
• Python consul lib already support this parameter: https://python-consul.readthedocs.io/en/latest/#consul-session

Without the PR it is not possible to set a TTL on a session.
Here is a test playbook

- name: test module
  hosts: localhost
  gather_facts: false
  tasks:
    - name: Register basic session with consul
      community.general.consul_session:
        name: session-with-ttl
        # ttl: 180  # sec
    - name: Retrieve active sessions
      community.general.consul_session:
        state: list

The output of the run is the following where we can see the TTL key is an empty string where we cannot pass anything.

❯ ansible-playbook test.yaml

PLAY [test module] *************************************************************************************************************************************************************************************************************************************************************

TASK [Register basic session with consul] **************************************************************************************************************************************************************************************************************************************
changed: [localhost] => {
    "behavior": "release",
    "changed": true,
    "checks": null,
    "delay": 15,
    "invocation": { <-- we cannot invoke the module with ttl key
        "module_args": {
            "behavior": "release",
            "checks": null,
            "datacenter": null,
            "delay": 15,
            "host": "localhost",
            "id": null,
            "name": "session-with-ttl",
            "node": null,
            "port": 8500,
            "scheme": "http",
            "state": "present",
            "validate_certs": true
        }
    },
    "name": "session-with-ttl",
    "node": null,
    "session_id": "2a0919ce-3026-2a34-db91-ffa20e907aa7"
}

TASK [Retrieve active sessions] ************************************************************************************************************************************************************************************************************************************************
changed: [localhost] => {
    "changed": true,
    "invocation": {
        "module_args": {
            "behavior": "release",
            "checks": null,
            "datacenter": null,
            "delay": 15,
            "host": "localhost",
            "id": null,
            "name": null,
            "node": null,
            "port": 8500,
            "scheme": "http",
            "state": "list",
            "validate_certs": true
        }
    },
    "sessions": [
        {
            "Behavior": "release",
            "CreateIndex": 29,
            "ID": "2a0919ce-3026-2a34-db91-ffa20e907aa7",
            "LockDelay": 15000000000,
            "ModifyIndex": 29,
            "Name": "session-with-ttl",
            "Node": "server-1",
            "NodeChecks": [
                "serfHealth"
            ],
            "ServiceChecks": null,
            "TTL": ""
        },
        {
            "Behavior": "release",
            "CreateIndex": 9,
            "ID": "93d59352-8a33-1743-7f16-b7353a615ca7",
            "LockDelay": 15000000000,
            "ModifyIndex": 9,
            "Name": "session-with-ttl",
            "Node": "server-1",
            "NodeChecks": [
                "serfHealth"
            ],
            "ServiceChecks": null,
            "TTL": ""
        },
        {
            "Behavior": "release",
            "CreateIndex": 22,
            "ID": "ea87c387-edb6-2eb6-10fd-d01eca97fe17",
            "LockDelay": 15000000000,
            "ModifyIndex": 22,
            "Name": "session-with-ttl",
            "Node": "server-1",
            "NodeChecks": [
                "serfHealth"
            ],
            "ServiceChecks": null,
            "TTL": "" <-- TTL is empty as expected
        }
    ]
}
PLAY RECAP *********************************************************************************************************************************************************************************************************************************************************************
localhost                  : ok=2    changed=2    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

With the ttl key in the playbook above uncommented we have the following behavior where we can see the TTL key is not an empty string and have the value 180s.

❯ ansible-playbook test.yaml

PLAY [test module] *************************************************************************************************************************************************************************************************************************************************************

TASK [Register basic session with consul] **************************************************************************************************************************************************************************************************************************************
changed: [localhost] => {
    "behavior": "release",
    "changed": true,
    "checks": null,
    "delay": 15,
    "invocation": {
        "module_args": {
            "behavior": "release",
            "checks": null,
            "datacenter": null,
            "delay": 15,
            "host": "localhost",
            "id": null,
            "name": "session-with-ttl",
            "node": null,
            "port": 8500,
            "scheme": "http",
            "state": "present",
            "ttl": 180, <-- we can invoke the module with ttl
            "validate_certs": true
        }
    },
    "name": "session-with-ttl",
    "node": null,
    "session_id": "f9cf72ce-a1f4-a38b-0385-3ce8515d3a0a",
    "ttl": 180
}

TASK [Retrieve active sessions] ************************************************************************************************************************************************************************************************************************************************
changed: [localhost] => {
    "changed": true,
    "invocation": {
        "module_args": {
            "behavior": "release",
            "checks": null,
            "datacenter": null,
            "delay": 15,
            "host": "localhost",
            "id": null,
            "name": null,
            "node": null,
            "port": 8500,
            "scheme": "http",
            "state": "list",
            "ttl": null,
            "validate_certs": true
        }
    },
    "sessions": [
        {
            "Behavior": "release",
            "CreateIndex": 9,
            "ID": "93d59352-8a33-1743-7f16-b7353a615ca7",
            "LockDelay": 15000000000,
            "ModifyIndex": 9,
            "Name": "session-with-ttl",
            "Node": "server-1",
            "NodeChecks": [
                "serfHealth"
            ],
            "ServiceChecks": null,
            "TTL": ""
        },
        {
            "Behavior": "release",
            "CreateIndex": 14,
            "ID": "f9cf72ce-a1f4-a38b-0385-3ce8515d3a0a",
            "LockDelay": 15000000000,
            "ModifyIndex": 14,
            "Name": "session-with-ttl",
            "Node": "server-1",
            "NodeChecks": [
                "serfHealth"
            ],
            "ServiceChecks": null,
            "TTL": "180s" <-- the ttl is correctly applied and visible via consul api
        }
    ]
}

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

[ansibullbot]

cc @sgargan
click here for bot help

[github-actions]

Docs Build 📝

Thank you for contribution!✨

This PR has been merged and your docs changes will be incorporated when they are next published.

[felixfontein]

Thanks for your contribution! Please add a changelog fragment.

Also please note that right now, the integration test you added is failing.

[felixfontein]

Just a small suggestion, besides that it looks good to me.

[felixfontein]

I'll merge this in a few days if nobody complains.

[patchback]

Backport to stable-5: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-5/d214f49be729b6fecea0b74f5fb0ba9b265802cb/pr-4996

Backported as #5038

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

[felixfontein]

@wilfriedroset thank you for your contribution! :)