New module postgresql_ping: Checks remote PostgreSQL server availability.

[Andersson007]

SUMMARY

New module postgresql_ping: Simple module to check remote PostgreSQL server availability.

ISSUE TYPE

• New Module Pull Request

COMPONENT NAME

postgresql_ping

ANSIBLE VERSION

2.8

RETURNS

is_available:
    description: PostgreSQL server availability.
    returned: always
    type: bool
    sample: true

server_version:
    description: PostgreSQL server version.
    returned: always
    type: dict
    sample: { major: 10, minor: 1 }

EXAMPLES

# PostgreSQL ping dbsrv server from the shell:
ansible dbsrv -m postgresql_ping

# In the example below you need to generate sertificates previously.
# See https://www.postgresql.org/docs/current/libpq-ssl.html for more information.
- name: PostgreSQL ping dbsrv server using not default credentials and ssl
  postgresql_ping:
    db: protected_db
    login_host: dbsrv
    login_user: secret
    login_password: secret_pass
    ssl_rootcert: /root/root.crt
    ssl_mode: verify-full

OUTPUT EXAMPLES

In following examples Postgres on dbsrv1 is OK, on dbsrv2 it is not running:

dbsrv1 | SUCCESS => {
    "changed": false,
    "is_available": true,
    "server_version": {
        "major": 10, 
        "minor": 6
    }
}
 [WARNING]: PostgreSQL server is unavailable: could not connect to server: No such file or directory         Is the server running locally and accepting         connections
on Unix domain socket "/var/run/postgresql/.s.PGSQL.5432"?

dbsrv2 | SUCCESS => {
    "changed": false,
    "is_available": false,
    "server_version": {}
}

[ansibot]

cc @matburt
click here for bot help

[ansibot]

@Dorn- @andytom @b6d @dschep @jensdepuydt @matburt @nerzhul

As a maintainer of a module in the same namespace this new module has been submitted to, your vote counts for shipits. Please review this module and add shipit if you would like to see it merged.

click here for bot help

[Andersson007]

@dagwieers , hello. I added my first integration test for this module. It's a very simple module so the test very simple too.
This module don't change anything on the target, therefore I made three check: return values, return values if the database to connect doesn't exist and check mode.
All checks were passed as expected. Could you look at it once, please? If it's OK - good and I'm going to continue to make tests for other modules by myself.
Test output example:

TASK [postgresql : postgresql_ping - test return values] ***********************
ok: [testhost] => {"changed": false, "is_available": true, "server_version": {"major": 10, "minor": 6}}

TASK [postgresql : assert] *****************************************************
ok: [testhost] => {
    "changed": false, 
    "msg": "All assertions passed"
}

TASK [postgresql : postgresql_ping - check ping of non-existing database doesn't return anything] ***
ok: [testhost] => {"changed": false, "is_available": false, "server_version": {}}

TASK [postgresql : assert] *****************************************************
ok: [testhost] => {
    "changed": false, 
    "msg": "All assertions passed"
}

[ansibot]

cc @amenonsen @jbscalia @kostiantyn-nemchenko
click here for bot help

[dagwieers]

I made some cosmetic and docs changes to speed up this process.
LGTM, but I haven't tested the code myself.

[ansibot]

cc @kustodian
click here for bot help

[Andersson007]

cc @sebasmannem @amenonsen

[sebasmannem]

Hmm, I see some pylint recommendations on variables like e and kw.
I know these examples are out there in other ansible modules, but I would fix them.
Makes it just a little bit cleaner. Also some docstring recommendations.
But I'm okay with shipping it in its current form also.

Generall, I like this module. It will be beneficcial into some crude checking if postgres is up, and init'ed as expected.

[Andersson007]

@sebasmannem thank you for the review!

[dagwieers]

@sebasmannem As a reviewer you can add a shipit to any PR simply by adding a comment/review and mention shipit on a new line. A PR requires 2 shipits (a green CI check and no change requests) to get merged automagically by @ansibot.

The only exception is a PR that contains a new module (or that modifies something outside of the control of the PostgreSQL Working Group). So for this PR a core member still needs to validate the module before merging, but the shipits do help understand that it is vetted by maintainers/reviewers.

We currently have 19 (not new_module) PostgreSQL-related pull-requests that need shipits from reviewers to get merged. So please help spread the gospel and let those shipits count :-)

[sebasmannem]

shipit

[sebasmannem]

shipit

[cmfrtl]

shipit

[kostiantyn-nemchenko]

shipit

[gundalow]

Thanks everybody, merged into devel for release in Ansible 2.8

[Andersson007]

Thanks all !