mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
* Changed parameter name, added aliases for compatibility.
* added changelog fragment
* Update changelogs/fragments/1244-renamed-parameter.yaml
Added markup around parameters names.
Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 42999867b4
)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
parent
dbb145bc71
commit
eba42c9eb9
2 changed files with 14 additions and 11 deletions
2
changelogs/fragments/1244-renamed-parameter.yaml
Normal file
2
changelogs/fragments/1244-renamed-parameter.yaml
Normal file
|
@ -0,0 +1,2 @@
|
||||||
|
minor_changes:
|
||||||
|
- django_manage - renamed parameter ``app_path`` to ``project_path``, adding ``app_path`` and ``chdir`` as aliases (https://github.com/ansible-collections/community.general/issues/1044).
|
|
@ -26,11 +26,12 @@ options:
|
||||||
C(collectstatic), C(createcachetable), C(flush), C(loaddata), C(migrate), C(syncdb), C(test), and C(validate).
|
C(collectstatic), C(createcachetable), C(flush), C(loaddata), C(migrate), C(syncdb), C(test), and C(validate).
|
||||||
type: str
|
type: str
|
||||||
required: true
|
required: true
|
||||||
app_path:
|
project_path:
|
||||||
description:
|
description:
|
||||||
- The path to the root of the Django application where B(manage.py) lives.
|
- The path to the root of the Django application where B(manage.py) lives.
|
||||||
type: path
|
type: path
|
||||||
required: true
|
required: true
|
||||||
|
aliases: [app_path, chdir]
|
||||||
settings:
|
settings:
|
||||||
description:
|
description:
|
||||||
- The Python path to the application's settings module, such as C(myapp.settings).
|
- The Python path to the application's settings module, such as C(myapp.settings).
|
||||||
|
@ -135,18 +136,18 @@ EXAMPLES = """
|
||||||
- name: Run cleanup on the application installed in django_dir
|
- name: Run cleanup on the application installed in django_dir
|
||||||
community.general.django_manage:
|
community.general.django_manage:
|
||||||
command: cleanup
|
command: cleanup
|
||||||
app_path: "{{ django_dir }}"
|
project_path: "{{ django_dir }}"
|
||||||
|
|
||||||
- name: Load the initial_data fixture into the application
|
- name: Load the initial_data fixture into the application
|
||||||
community.general.django_manage:
|
community.general.django_manage:
|
||||||
command: loaddata
|
command: loaddata
|
||||||
app_path: "{{ django_dir }}"
|
project_path: "{{ django_dir }}"
|
||||||
fixtures: "{{ initial_data }}"
|
fixtures: "{{ initial_data }}"
|
||||||
|
|
||||||
- name: Run syncdb on the application
|
- name: Run syncdb on the application
|
||||||
community.general.django_manage:
|
community.general.django_manage:
|
||||||
command: syncdb
|
command: syncdb
|
||||||
app_path: "{{ django_dir }}"
|
project_path: "{{ django_dir }}"
|
||||||
settings: "{{ settings_app_name }}"
|
settings: "{{ settings_app_name }}"
|
||||||
pythonpath: "{{ settings_dir }}"
|
pythonpath: "{{ settings_dir }}"
|
||||||
virtualenv: "{{ virtualenv_dir }}"
|
virtualenv: "{{ virtualenv_dir }}"
|
||||||
|
@ -154,13 +155,13 @@ EXAMPLES = """
|
||||||
- name: Run the SmokeTest test case from the main app. Useful for testing deploys
|
- name: Run the SmokeTest test case from the main app. Useful for testing deploys
|
||||||
community.general.django_manage:
|
community.general.django_manage:
|
||||||
command: test
|
command: test
|
||||||
app_path: "{{ django_dir }}"
|
project_path: "{{ django_dir }}"
|
||||||
apps: main.SmokeTest
|
apps: main.SmokeTest
|
||||||
|
|
||||||
- name: Create an initial superuser
|
- name: Create an initial superuser
|
||||||
community.general.django_manage:
|
community.general.django_manage:
|
||||||
command: "createsuperuser --noinput --username=admin --email=admin@example.com"
|
command: "createsuperuser --noinput --username=admin --email=admin@example.com"
|
||||||
app_path: "{{ django_dir }}"
|
project_path: "{{ django_dir }}"
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import os
|
import os
|
||||||
|
@ -262,7 +263,7 @@ def main():
|
||||||
module = AnsibleModule(
|
module = AnsibleModule(
|
||||||
argument_spec=dict(
|
argument_spec=dict(
|
||||||
command=dict(required=True, type='str'),
|
command=dict(required=True, type='str'),
|
||||||
app_path=dict(required=True, type='path'),
|
project_path=dict(required=True, type='path', aliases=['app_path', 'chdir']),
|
||||||
settings=dict(default=None, required=False, type='path'),
|
settings=dict(default=None, required=False, type='path'),
|
||||||
pythonpath=dict(default=None, required=False, type='path', aliases=['python_path']),
|
pythonpath=dict(default=None, required=False, type='path', aliases=['python_path']),
|
||||||
virtualenv=dict(default=None, required=False, type='path', aliases=['virtual_env']),
|
virtualenv=dict(default=None, required=False, type='path', aliases=['virtual_env']),
|
||||||
|
@ -283,7 +284,7 @@ def main():
|
||||||
)
|
)
|
||||||
|
|
||||||
command = module.params['command']
|
command = module.params['command']
|
||||||
app_path = module.params['app_path']
|
project_path = module.params['project_path']
|
||||||
virtualenv = module.params['virtualenv']
|
virtualenv = module.params['virtualenv']
|
||||||
|
|
||||||
for param in specific_params:
|
for param in specific_params:
|
||||||
|
@ -317,7 +318,7 @@ def main():
|
||||||
if module.params[param]:
|
if module.params[param]:
|
||||||
cmd = '%s %s' % (cmd, module.params[param])
|
cmd = '%s %s' % (cmd, module.params[param])
|
||||||
|
|
||||||
rc, out, err = module.run_command(cmd, cwd=app_path)
|
rc, out, err = module.run_command(cmd, cwd=project_path)
|
||||||
if rc != 0:
|
if rc != 0:
|
||||||
if command == 'createcachetable' and 'table' in err and 'already exists' in err:
|
if command == 'createcachetable' and 'table' in err and 'already exists' in err:
|
||||||
out = 'already exists.'
|
out = 'already exists.'
|
||||||
|
@ -338,8 +339,8 @@ def main():
|
||||||
if check_changed:
|
if check_changed:
|
||||||
changed = check_changed(out)
|
changed = check_changed(out)
|
||||||
|
|
||||||
module.exit_json(changed=changed, out=out, cmd=cmd, app_path=app_path, virtualenv=virtualenv,
|
module.exit_json(changed=changed, out=out, cmd=cmd, app_path=project_path, project_path=project_path,
|
||||||
settings=module.params['settings'], pythonpath=module.params['pythonpath'])
|
virtualenv=virtualenv, settings=module.params['settings'], pythonpath=module.params['pythonpath'])
|
||||||
|
|
||||||
|
|
||||||
if __name__ == '__main__':
|
if __name__ == '__main__':
|
||||||
|
|
Loading…
Reference in a new issue