jclaveau / ansible-vagrant-modules-legacy Goto Github PK

Same as 08fa2bc for destroy

python-vagrant misses a lot of features / parameters and is not maintained. A wrapper to it seems to be the best way to gather those new features

TODO:

• Create the VagrantUpdated class
• Move python-vagrant parts to it

Use codecov from github action

delegate_to doesn't work when applied to hosts added with add_host in roles so in integration tests but it works in playbooks.

• Add integration-playbooks tests

https://chaostoolkit.org/reference/usage/discover/
https://github.com/chaostoolkit/chaostoolkit

• Remove count arg and related code
• Remove related tests and replace them with https://docs.ansible.com/ansible/latest/collections/ansible/builtin/sequence_lookup.html as example
• Investigate adding support of regexp patterns for other states than up/running

An exception occurred during task execution. To see the full traceback, use -vvv. The error was: KeyError: 'non_existing_vm'

• Fix this error
• Add integration tests

• galaxy.yml
• add examples to modules
• Tell this version is updated to previous contributors 70ca815

Replace

        if status_before['state'] != 'saved':
            self.vg.suspend(
                vm_name=name
            )

        status_after = self.raw_statuses(name, must_be_present=True)[name]
        if status_before['state'] != status_after['state']:
            changed = True

by

        if status_before['state'] != 'saved':
            self.vg.suspend(
                vm_name=name
            )
            status_after = self.raw_statuses(name, must_be_present=True)[name]
            if status_before['state'] != status_after['state']:
                changed = True
        else:
            status_after = status_before

https://stackoverflow.com/questions/66261101/using-vagrant-on-github-actions-ideally-incl-virtualbox

This dependency seems to be fat over-engineered code painful to maintain. This module meant to be a binding to Vagrant with as limited changes as the shell usage

• Remove all references to _instances
• Uncomment test on count in ssh_config testcase

Vagrantfile parser in python

• https://github.com/drewsonne/pyvagrantfile

Use Vagrant's names : running, poweroff... ?

• Rename config module
• Migrate the tasks
• Create the VagrantUpdated
• Support the provider option
• Set a version
• Polish galaxy.yml
• Remove the "WIP" from the README
• Points the fact that it allows control on a kind of hosts file from ansible-test
• Open warning issues on ansible-skeleton, vagrant-role and ansible-vagrant
• Start a topic on reddit
• Write a blog article, share it on hacker news?
• Contact Jeff Geerling

https://github.com/simplecov-ruby/simplecov

https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_documenting.html

• Add my modifications
• Move changelog at the bottom
• Add a usage preview e.g a playbook
• Update to Ansible 2.10 syntaxe
• Update status data structure if not done
• Change "codecov" as "coverage" in the tag
• Add atag for ansible-galaxy (once published?)
• [ ]

• Add failing add_host / delegate_to integration test
• Add test with ssh connection for delegate_to case ansible/ansible#36396 (comment)
• Open a bug on Ansible repo

Can this bug be the source of issues? ansible/ansible#16403

Docs:

• https://docs.ansible.com/ansible/latest/user_guide/connection_details.html

• githook to copy Vagrantfile content into y python wrapper
• Move VagrantConfig class to module_utils
• copyright
• examples add / remove / read

• The common use of vagrant is by creating a vagrantfile manually https://docs.ansible.com/ansible/2.5/scenario_guides/guide_vagrant.html

• Best practices for modules https://docs.ansible.com/ansible/latest/dev_guide/developing_modules.html

Found here: https://galaxy.ansible.com/search?deprecated=false&keywords=vagrant&order_by=-relevance&page_size=100&page=1

• https://github.com/amtega/ansible_role_vagrant_provisioner
• https://github.com/teampants/ansible-vagrant

Currently I chose to made the "name" parameter required. Matching vagrant commands behavior would required to support it which requires a clean code for manipulating many machines:
TODO:

• List commands where it could have sens (Vagrant doesn't support "vagrant port" with no name specified for example)
• Define outputs having the same philosophy as Ansible loop results
• Factorize calls in the Vagrant adapter
• Make the name parameter optional when possible
• Update the tests
• Update the docs

NOT TO DO: These features depend on the current one

• Async subcalls to make vagrant use faster
• Implement names parameter

        "status": {
            "frank": [
                [
                    [
                        "frank",
                        "running",
                        "virtualbox"
                    ]
                ],
                [
                    [
                        "frank_inst2",
                        "running",
                        "virtualbox"
                    ]
                ]
            ]
        }

Should be:

        "status": {
            "frank": [
                {
                    "name": "frank",
                    "state": "running",
                    "provider": "virtualbox",
                    "changed": true
                },
                {
                    "name": "frank_inst2",
                    "state": "running",
                    "provider": "virtualbox",
                    "changed": true
                }
            ]
        }

vagrant up and vagrant destroy provide a parallel parameter which is passed to the chosen provider.
As a workaround I chose to delegate this responsibility to Ansible for now but it would be a very nice feature.

Acceptance:

• Have a working parallel parameter for vagrant up.
• Have a working parallel parameter for vagrant destroy.

Todo

• Check if no other command has a parallel parameter
• Implement commands for all or several instances jclaveau/ansible-vagrant-modules#31
• Extend python-vagrant commands to support it jclaveau/ansible-vagrant-modules#32
• Remove this issue from the Important know issues of the readme

vagrant:
  cmd: up
  vm_name: frank_%d
  count: 8

vagrant:
  cmd: halt
  vm_name: frank_\d+
  vm_name: frank_(0|3|8)

https://pytutorial.com/python-variable-in-string