Add new module sqitch to manage changes in databases

[merito]

ISSUE TYPE

• New Module Pull Request

COMPONENT NAME

Sqitch

ANSIBLE VERSION

ansible 2.3.0
  config file = 
  configured module search path = Default w/o overrides

SUMMARY

Sqitch is a database change management system. It works with many database engines. I've made a module to work with some of the sqitch commands usable in provisioning database (I didn't implement commands for editing scripts, configs and plans).

TASK [db_test : Sqitch] ****************************************************
changed: [localhost] => {
    "changed": true, 
    "invocation": {
        "module_args": {
            "command": "deploy", 
            "cwd": "/home/merito/ansible_dev/roles/db_test/files", 
            "dest_dir": null, 
            "engine": null, 
            "from_change": null, 
            "log_only": null, 
            "mode": null, 
            "onto": null, 
            "plan_file": "sqitch.plan", 
            "set": [], 
            "set_deploy": null, 
            "set_revert": null, 
            "target": "anstest", 
            "to_change": "error_code", 
            "upto": null, 
            "verify": true
        }, 
        "module_name": "sqitch"
    }, 
    "stdout": "Deploying changes through error_code to anstest\n  + types ....... ok\n  + error_code .. ok\n", 
    "stdout_lines": [
        "Deploying changes through error_code to anstest", 
        "  + types ....... ok", 
        "  + error_code .. ok"
    ]
}

[ansibot]

@jsmartin @drewkerrigan @slok @ThePixelDeveloper @barryib @Lujeni @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

[merito]

It's been a long time since I've made this PR. What will happen with this if nobody reacts?

[nerzhul]

hello, code seems good, but i don't really know this technology

[tsal]

We could really use this module - any chance of it moving forward at this point?

[merito]

I've checked the module with the current ansible and it still works good. I don't know if there is any way to push it forward. Because it was more than 9 months I call the people to look at this

@jsmartin @drewkerrigan @slok @ThePixelDeveloper @barryib @Lujeni @nerzhul

[drewkerrigan]

shipit

[tsal]

🎉

[merito]

@tsal One shipit is not enough to include it to the package, we need two. You can still use this module copying the code to the ./library directory in your project root or wherever your library path is pointing out - see this http://docs.ansible.com/ansible/latest/intro_configuration.html#library

[tsal]

I was hoping it would be a cascade of shipits after @drewkerrigan :( - thank you, we'll probably do that, for now. 🎉

[drewkerrigan]

FWIW, myself and @jsmartin worked on the code in question several years ago, so I'd be surprised if this was still on the radar of anyone listed above.

[maxamillion]

I'd like to see integration tests added. Also, any desire to support check mode? (Is that even feasible with sqitch?)

If we can get tests, I'll merge.

[maxamillion]

Shippable tests are failing.

[maxamillion]

needs_revision

[ansibot]

The test ansible-test sanity --test boilerplate [explain] failed with the error:

Command "test/sanity/code-smell/boilerplate.sh" returned exit status 2.
>>> Standard Output
== Missing __metaclass__ = type ==
./lib/ansible/modules/database/misc/sqitch.py

== Missing from __future__ import (absolute_import, division, print_function) ==
./lib/ansible/modules/database/misc/sqitch.py

The test ansible-test sanity --test integration-aliases [explain] failed with the error:

Command "test/sanity/code-smell/integration-aliases.py" returned exit status 1.
>>> Standard Output
The following integration target directories are missing `aliases` files:

test/integration/targets/sqitch

If these tests cannot be run as part of CI (requires external services, unsupported dependencies, etc.),
then they most likely belong in `test/integration/roles/` instead of `test/integration/targets/`.
In that case, do not add an `aliases` file. Instead, just relocate the tests.

However, if you think that the tests should be able to be supported by CI, please discuss test
organization with @mattclay or @gundalow on GitHub or #ansible-devel on IRC.

If these tests can be run as part of CI, you'll need to add an appropriate CI alias, such as:

posix/ci/group1
windows/ci/group2

The CI groups are used to balance tests across multiple jobs to minimize test run time.
Using the relevant `group1` entry is fine in most cases. Groups can be changed later to redistribute tests.

Aliases can also be used to express test requirements:

needs/privileged
needs/root
needs/ssh

Other aliases are used to skip tests under certain conditions:

skip/freebsd
skip/osx
skip/python3

Take a look at existing `aliases` files to see what aliases are available and how they're used.

The test ansible-test sanity --test pep8 [explain] failed with 49 errors:

lib/ansible/modules/database/misc/sqitch.py:216:22: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/database/misc/sqitch.py:216:24: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/database/misc/sqitch.py:217:20: E221 multiple spaces before operator
lib/ansible/modules/database/misc/sqitch.py:217:20: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/database/misc/sqitch.py:217:26: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/database/misc/sqitch.py:219:22: E221 multiple spaces before operator
lib/ansible/modules/database/misc/sqitch.py:219:22: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/database/misc/sqitch.py:219:26: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/database/misc/sqitch.py:220:19: E221 multiple spaces before operator
lib/ansible/modules/database/misc/sqitch.py:220:19: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/database/misc/sqitch.py:220:26: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/database/misc/sqitch.py:221:19: E221 multiple spaces before operator
lib/ansible/modules/database/misc/sqitch.py:221:19: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/database/misc/sqitch.py:221:26: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/database/misc/sqitch.py:222:16: E221 multiple spaces before operator
lib/ansible/modules/database/misc/sqitch.py:222:16: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/database/misc/sqitch.py:222:26: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/database/misc/sqitch.py:223:22: E221 multiple spaces before operator
lib/ansible/modules/database/misc/sqitch.py:223:22: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/database/misc/sqitch.py:223:26: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/database/misc/sqitch.py:224:24: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/database/misc/sqitch.py:224:26: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/database/misc/sqitch.py:225:21: E221 multiple spaces before operator
lib/ansible/modules/database/misc/sqitch.py:225:21: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/database/misc/sqitch.py:225:26: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/database/misc/sqitch.py:226:19: E221 multiple spaces before operator
lib/ansible/modules/database/misc/sqitch.py:226:19: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/database/misc/sqitch.py:226:26: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/database/misc/sqitch.py:227:17: E221 multiple spaces before operator
lib/ansible/modules/database/misc/sqitch.py:227:17: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/database/misc/sqitch.py:227:26: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/database/misc/sqitch.py:228:16: E221 multiple spaces before operator
lib/ansible/modules/database/misc/sqitch.py:228:16: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/database/misc/sqitch.py:228:26: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/database/misc/sqitch.py:229:21: E221 multiple spaces before operator
lib/ansible/modules/database/misc/sqitch.py:229:21: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/database/misc/sqitch.py:229:26: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/database/misc/sqitch.py:230:17: E221 multiple spaces before operator
lib/ansible/modules/database/misc/sqitch.py:230:17: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/database/misc/sqitch.py:230:26: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/database/misc/sqitch.py:231:17: E221 multiple spaces before operator
lib/ansible/modules/database/misc/sqitch.py:231:17: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/database/misc/sqitch.py:231:26: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/database/misc/sqitch.py:232:23: E221 multiple spaces before operator
lib/ansible/modules/database/misc/sqitch.py:232:23: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/database/misc/sqitch.py:232:26: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/database/misc/sqitch.py:233:23: E221 multiple spaces before operator
lib/ansible/modules/database/misc/sqitch.py:233:23: E251 unexpected spaces around keyword / parameter equals
lib/ansible/modules/database/misc/sqitch.py:233:26: E251 unexpected spaces around keyword / parameter equals

The test ansible-test sanity --test validate-modules [explain] failed with 5 errors:

lib/ansible/modules/database/misc/sqitch.py:0:0: E307 version_added should be 2.5. Currently 2.3
lib/ansible/modules/database/misc/sqitch.py:0:0: E312 No RETURN provided
lib/ansible/modules/database/misc/sqitch.py:0:0: E316 ANSIBLE_METADATA.metadata_version: required key not provided @ data['metadata_version']. Got None
lib/ansible/modules/database/misc/sqitch.py:0:0: E316 ANSIBLE_METADATA.version: extra keys not allowed @ data['version']. Got '1.0'
lib/ansible/modules/database/misc/sqitch.py:0:0: E322 "dest_dir" is listed in the argument_spec, but not documented in the module

click here for bot help

[merito]

@mattclay so why during the execution of tasks from setup.yml output_dir is /root/ansible_testing/

00:45 TASK [sqitch : Copy resources to tmp dir] **************************************
00:48 changed: [testhost] => {"changed": true, "dest": "/root/ansible_testing/", "src": "/root/ansible/test/integration/targets/sqitch/files/"}

but next in test.yml it is ~/ansible_testing

01:27 fatal: [testhost]: FAILED! => {
01:27     "changed": false, 
01:27     "invocation": {
01:27         "module_args": {
01:27             "command": "deploy", 
01:27             "engine": null, 
01:27             "from_change": null, 
01:27             "log_only": null, 
01:27             "mode": null, 
01:27             "onto": null, 
01:27             "plan_file": "sqitch.plan", 
01:27             "set": [], 
01:27             "set_deploy": [], 
01:27             "set_revert": [], 
01:27             "target": "anstest", 
01:27             "to_change": "types", 
01:27             "upto": null, 
01:27             "verify": true, 
01:27             "working_directory": "~/ansible_testing"
01:27         }
01:27     }, 
01:27     "msg": "Cannot find target \"anstest\"\n", 
01:27     "rc": 2
01:27 }

and it is not the same directory as before?

[mattclay]

The tests are running as root. It appears the path is being used/shown literally in some cases (~/ansible_testing) and other places it's been expanded to /root/ansible_testing.

[merito]

@mattclay all the conversations are resolved. Are we waiting for any changes?

[merito]

The output_dir appears to be working correctly:

01:31 TASK [sqitch : Create dir for resources] ***************************************
01:32 ok: [testhost] => {"changed": false, "gid": 0, "group": "root", "mode": "0755", "owner": "root", "path": "/root/ansible_testing", "size": 4096, "state": "directory", "uid": 0}

@mattclay it is resolved. Maybe it is a good content to next Big PR review? ;)

Review out-of-date.

[Akasurde]

Hi @merito, Thank you very much for your interest in Ansible. This plugin/module is no longer maintained in this repository and has been migrated to https://github.com/ansible-collections/community.general

If you have further questions please stop by IRC or the mailing list:

* IRC: #ansible on irc.freenode.net
* mailing list: https://groups.google.com/forum/#!forum/ansible-project

needs_info