[WIP] Add 'uninstall' subcommand to 'ansible-galaxy collection' #73464

s-hertel · 2021-02-03T18:27:30Z

SUMMARY

Fixes #67759

ISSUE TYPE

Feature Pull Request

webknjaz

I haven't looked through everything, but here's a few things I noticed.

lib/ansible/cli/galaxy.py

webknjaz · 2021-02-03T19:16:29Z

lib/ansible/cli/galaxy.py

+            remove_parser.add_argument('-n', '--no-deps', dest='no_deps', action='store_true', default=False,
+                                       help="Skip dependencies of the collection(s) to remove")


Why would we remove the deps by default? If anything, I'd require users to add --depclean (it's an actual argument name from Gentoo's emerge and is usually quite expensive). Do we track that those deps aren't required by anything else?

I changed this to be opt-in. I am checking if the collections (deps and otherwise) are used by anything else (unless --force is used).

lib/ansible/cli/galaxy.py

lib/ansible/galaxy/collection/__init__.py

test/integration/targets/ansible-galaxy-collection/tasks/remove.yml

lib/ansible/galaxy/collection/__init__.py

s-hertel · 2021-02-03T21:49:10Z

Just adding a note to this, that we aren't going to rush it into 2.11.

Add tests Changelog

ansibot · 2021-11-19T13:57:19Z

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

Command "/root/.ansible/test/venv/sanity.package-data/3.10/ed96082c/bin/python /root/ansible/test/sanity/code-smell/package-data.py" returned exit status 1.
>>> Standard Error
Traceback (most recent call last):
  File "/root/ansible/test/sanity/code-smell/package-data.py", line 401, in <module>
    main()
  File "/root/ansible/test/sanity/code-smell/package-data.py", line 378, in main
    sdist_path = create_sdist(tmp_dir)
  File "/root/ansible/test/sanity/code-smell/package-data.py", line 185, in create_sdist
    raise Exception('make snapshot failed:\n%s' % stderr)
Exception: make snapshot failed:
Traceback (most recent call last):
  File "/tmp/tmpzo95q8in/hacking/build-ansible.py", line 103, in <module>
    main()
  File "/tmp/tmpzo95q8in/hacking/build-ansible.py", line 92, in main
    retval = command.main(args)
  File "/tmp/tmpzo95q8in/hacking/build_library/build_ansible/command_plugins/generate_man.py", line 279, in main
    allvars[cli_name] = opts_docs(cli_class_name, cli_name)
  File "/tmp/tmpzo95q8in/hacking/build_library/build_ansible/command_plugins/generate_man.py", line 211, in opts_docs
    action_depth = get_actions(cli.parser, docs)
  File "/tmp/tmpzo95q8in/hacking/build_library/build_ansible/command_plugins/generate_man.py", line 205, in get_actions
    depth = 1 + get_actions(parser, action_info)
  File "/tmp/tmpzo95q8in/hacking/build_library/build_ansible/command_plugins/generate_man.py", line 179, in get_actions
    action_info['desc'] = trim_docstring(getattr(cli, 'execute_%s' % action).__doc__)
AttributeError: 'GalaxyCLI' object has no attribute 'execute_uninstall'. Did you mean: 'execute_install'?
make: *** [Makefile:147: generate_rst] Error 1

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

Command "/root/.ansible/test/venv/sanity.docs-build/3.10/3cd8b961/bin/python /root/ansible/test/sanity/code-smell/docs-build.py" returned exit status 1.
>>> Standard Error
Command 'make core_singlehtmldocs' failed with status code: 2
--> Standard Output
Creating symlinks in core_structure
ln -sf ../rst/core_index.rst rst/index.rst
ln -sf ../sphinx_conf/core_conf.py rst/conf.py
../../hacking/build-ansible.py collection-meta --template-file=../templates/collections_galaxy_meta.rst.j2 --output-dir=rst/dev_guide/  ../../lib/ansible/galaxy/data/collections_galaxy_meta.yml
../../hacking/build-ansible.py document-config --template-file=../templates/config.rst.j2 --output-dir=rst/reference_appendices/  ../../lib/ansible/config/base.yml
mkdir -p rst/cli
../../hacking/build-ansible.py generate-man --template-file=../templates/cli_rst.j2 --output-dir=rst/cli/ --output-format rst  ../../lib/ansible/cli/*.py
--> Standard Error
Traceback (most recent call last):
  File "/root/ansible/docs/docsite/../../hacking/build-ansible.py", line 103, in <module>
    main()
  File "/root/ansible/docs/docsite/../../hacking/build-ansible.py", line 92, in main
    retval = command.main(args)
  File "/root/ansible/hacking/build_library/build_ansible/command_plugins/generate_man.py", line 279, in main
    allvars[cli_name] = opts_docs(cli_class_name, cli_name)
  File "/root/ansible/hacking/build_library/build_ansible/command_plugins/generate_man.py", line 211, in opts_docs
    action_depth = get_actions(cli.parser, docs)
  File "/root/ansible/hacking/build_library/build_ansible/command_plugins/generate_man.py", line 205, in get_actions
    depth = 1 + get_actions(parser, action_info)
  File "/root/ansible/hacking/build_library/build_ansible/command_plugins/generate_man.py", line 179, in get_actions
    action_info['desc'] = trim_docstring(getattr(cli, 'execute_%s' % action).__doc__)
AttributeError: 'GalaxyCLI' object has no attribute 'execute_uninstall'. Did you mean: 'execute_install'?
make: *** [Makefile:192: cli] Error 1

click here for bot help

ansibot · 2021-11-19T22:08:48Z

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

Command "/root/.ansible/test/venv/sanity.package-data/3.10/ed96082c/bin/python /root/ansible/test/sanity/code-smell/package-data.py" returned exit status 1.
>>> Standard Error
Traceback (most recent call last):
  File "/root/ansible/test/sanity/code-smell/package-data.py", line 401, in <module>
    main()
  File "/root/ansible/test/sanity/code-smell/package-data.py", line 378, in main
    sdist_path = create_sdist(tmp_dir)
  File "/root/ansible/test/sanity/code-smell/package-data.py", line 185, in create_sdist
    raise Exception('make snapshot failed:\n%s' % stderr)
Exception: make snapshot failed:
Traceback (most recent call last):
  File "/tmp/tmp192z58qi/hacking/build-ansible.py", line 103, in <module>
    main()
  File "/tmp/tmp192z58qi/hacking/build-ansible.py", line 92, in main
    retval = command.main(args)
  File "/tmp/tmp192z58qi/hacking/build_library/build_ansible/command_plugins/generate_man.py", line 279, in main
    allvars[cli_name] = opts_docs(cli_class_name, cli_name)
  File "/tmp/tmp192z58qi/hacking/build_library/build_ansible/command_plugins/generate_man.py", line 211, in opts_docs
    action_depth = get_actions(cli.parser, docs)
  File "/tmp/tmp192z58qi/hacking/build_library/build_ansible/command_plugins/generate_man.py", line 205, in get_actions
    depth = 1 + get_actions(parser, action_info)
  File "/tmp/tmp192z58qi/hacking/build_library/build_ansible/command_plugins/generate_man.py", line 179, in get_actions
    action_info['desc'] = trim_docstring(getattr(cli, 'execute_%s' % action).__doc__)
AttributeError: 'GalaxyCLI' object has no attribute 'execute_uninstall'. Did you mean: 'execute_install'?
make: *** [Makefile:147: generate_rst] Error 1

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

Command "/root/.ansible/test/venv/sanity.docs-build/3.10/3cd8b961/bin/python /root/ansible/test/sanity/code-smell/docs-build.py" returned exit status 1.
>>> Standard Error
Command 'make core_singlehtmldocs' failed with status code: 2
--> Standard Output
Creating symlinks in core_structure
ln -sf ../rst/core_index.rst rst/index.rst
ln -sf ../sphinx_conf/core_conf.py rst/conf.py
../../hacking/build-ansible.py collection-meta --template-file=../templates/collections_galaxy_meta.rst.j2 --output-dir=rst/dev_guide/  ../../lib/ansible/galaxy/data/collections_galaxy_meta.yml
../../hacking/build-ansible.py document-config --template-file=../templates/config.rst.j2 --output-dir=rst/reference_appendices/  ../../lib/ansible/config/base.yml
mkdir -p rst/cli
../../hacking/build-ansible.py generate-man --template-file=../templates/cli_rst.j2 --output-dir=rst/cli/ --output-format rst  ../../lib/ansible/cli/*.py
--> Standard Error
Traceback (most recent call last):
  File "/root/ansible/docs/docsite/../../hacking/build-ansible.py", line 103, in <module>
    main()
  File "/root/ansible/docs/docsite/../../hacking/build-ansible.py", line 92, in main
    retval = command.main(args)
  File "/root/ansible/hacking/build_library/build_ansible/command_plugins/generate_man.py", line 279, in main
    allvars[cli_name] = opts_docs(cli_class_name, cli_name)
  File "/root/ansible/hacking/build_library/build_ansible/command_plugins/generate_man.py", line 211, in opts_docs
    action_depth = get_actions(cli.parser, docs)
  File "/root/ansible/hacking/build_library/build_ansible/command_plugins/generate_man.py", line 205, in get_actions
    depth = 1 + get_actions(parser, action_info)
  File "/root/ansible/hacking/build_library/build_ansible/command_plugins/generate_man.py", line 179, in get_actions
    action_info['desc'] = trim_docstring(getattr(cli, 'execute_%s' % action).__doc__)
AttributeError: 'GalaxyCLI' object has no attribute 'execute_uninstall'. Did you mean: 'execute_install'?
make: *** [Makefile:192: cli] Error 1

click here for bot help

ansibot · 2021-11-20T01:50:18Z

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

Command "/root/.ansible/test/venv/sanity.package-data/3.10/ed96082c/bin/python /root/ansible/test/sanity/code-smell/package-data.py" returned exit status 1.
>>> Standard Error
Traceback (most recent call last):
  File "/root/ansible/test/sanity/code-smell/package-data.py", line 401, in <module>
    main()
  File "/root/ansible/test/sanity/code-smell/package-data.py", line 378, in main
    sdist_path = create_sdist(tmp_dir)
  File "/root/ansible/test/sanity/code-smell/package-data.py", line 185, in create_sdist
    raise Exception('make snapshot failed:\n%s' % stderr)
Exception: make snapshot failed:
Traceback (most recent call last):
  File "/tmp/tmpazruelfj/hacking/build-ansible.py", line 103, in <module>
    main()
  File "/tmp/tmpazruelfj/hacking/build-ansible.py", line 92, in main
    retval = command.main(args)
  File "/tmp/tmpazruelfj/hacking/build_library/build_ansible/command_plugins/generate_man.py", line 279, in main
    allvars[cli_name] = opts_docs(cli_class_name, cli_name)
  File "/tmp/tmpazruelfj/hacking/build_library/build_ansible/command_plugins/generate_man.py", line 211, in opts_docs
    action_depth = get_actions(cli.parser, docs)
  File "/tmp/tmpazruelfj/hacking/build_library/build_ansible/command_plugins/generate_man.py", line 205, in get_actions
    depth = 1 + get_actions(parser, action_info)
  File "/tmp/tmpazruelfj/hacking/build_library/build_ansible/command_plugins/generate_man.py", line 179, in get_actions
    action_info['desc'] = trim_docstring(getattr(cli, 'execute_%s' % action).__doc__)
AttributeError: 'GalaxyCLI' object has no attribute 'execute_uninstall'. Did you mean: 'execute_install'?
make: *** [Makefile:147: generate_rst] Error 1

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

Command "/root/.ansible/test/venv/sanity.docs-build/3.10/3cd8b961/bin/python /root/ansible/test/sanity/code-smell/docs-build.py" returned exit status 1.
>>> Standard Error
Command 'make core_singlehtmldocs' failed with status code: 2
--> Standard Output
Creating symlinks in core_structure
ln -sf ../rst/core_index.rst rst/index.rst
ln -sf ../sphinx_conf/core_conf.py rst/conf.py
../../hacking/build-ansible.py collection-meta --template-file=../templates/collections_galaxy_meta.rst.j2 --output-dir=rst/dev_guide/  ../../lib/ansible/galaxy/data/collections_galaxy_meta.yml
../../hacking/build-ansible.py document-config --template-file=../templates/config.rst.j2 --output-dir=rst/reference_appendices/  ../../lib/ansible/config/base.yml
mkdir -p rst/cli
../../hacking/build-ansible.py generate-man --template-file=../templates/cli_rst.j2 --output-dir=rst/cli/ --output-format rst  ../../lib/ansible/cli/*.py
--> Standard Error
Traceback (most recent call last):
  File "/root/ansible/docs/docsite/../../hacking/build-ansible.py", line 103, in <module>
    main()
  File "/root/ansible/docs/docsite/../../hacking/build-ansible.py", line 92, in main
    retval = command.main(args)
  File "/root/ansible/hacking/build_library/build_ansible/command_plugins/generate_man.py", line 279, in main
    allvars[cli_name] = opts_docs(cli_class_name, cli_name)
  File "/root/ansible/hacking/build_library/build_ansible/command_plugins/generate_man.py", line 211, in opts_docs
    action_depth = get_actions(cli.parser, docs)
  File "/root/ansible/hacking/build_library/build_ansible/command_plugins/generate_man.py", line 205, in get_actions
    depth = 1 + get_actions(parser, action_info)
  File "/root/ansible/hacking/build_library/build_ansible/command_plugins/generate_man.py", line 179, in get_actions
    action_info['desc'] = trim_docstring(getattr(cli, 'execute_%s' % action).__doc__)
AttributeError: 'GalaxyCLI' object has no attribute 'execute_uninstall'. Did you mean: 'execute_install'?
make: *** [Makefile:192: cli] Error 1

click here for bot help

jborean93 · 2022-11-09T19:47:48Z

Closing as per @s-hertel requests. Will need to be reworked based on recent changes.

s-hertel force-pushed the ansible-galaxy_collection_uninstall branch 2 times, most recently from 8499da4 to 9f9ebf9 Compare February 3, 2021 18:49

This comment has been minimized.

Sign in to view

s-hertel mentioned this pull request Feb 3, 2021

[WIP] add a remove subcommand to ansible-galaxy collection #71800

Closed

ansibot added the needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html label Feb 3, 2021

webknjaz reviewed Feb 3, 2021

View reviewed changes

s-hertel removed the needs_triage Needs a first human triage before being processed. label Feb 3, 2021

webknjaz marked this pull request as draft February 3, 2021 22:42

ansibot removed the needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html label Feb 3, 2021

ansibot added the stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. label Feb 11, 2021

s-hertel closed this Apr 16, 2021

ansible locked and limited conversation to collaborators May 14, 2021

Add 'uninstall' subcommand to 'ansible-galaxy collection'

86bdaa7

Add tests Changelog

s-hertel reopened this Nov 19, 2021

s-hertel force-pushed the ansible-galaxy_collection_uninstall branch from 9f9ebf9 to 86bdaa7 Compare November 19, 2021 13:17

ansibot removed the stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. label Nov 19, 2021

fix yamllint

f713832

Simplify getting the dependencies by using the artifacts manager

af9a474

s-hertel force-pushed the ansible-galaxy_collection_uninstall branch from 04a6ab8 to af9a474 Compare November 19, 2021 21:35

refactor

206add3

ansibot added needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. labels Mar 2, 2022

jborean93 closed this Nov 9, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] Add 'uninstall' subcommand to 'ansible-galaxy collection' #73464

[WIP] Add 'uninstall' subcommand to 'ansible-galaxy collection' #73464

s-hertel commented Feb 3, 2021 •

edited

Loading

This comment has been minimized.

webknjaz left a comment

webknjaz Feb 3, 2021

s-hertel Nov 19, 2021

s-hertel commented Feb 3, 2021

ansibot commented Nov 19, 2021

ansibot commented Nov 19, 2021

ansibot commented Nov 20, 2021

jborean93 commented Nov 9, 2022

		remove_parser.add_argument('-n', '--no-deps', dest='no_deps', action='store_true', default=False,
		help="Skip dependencies of the collection(s) to remove")

[WIP] Add 'uninstall' subcommand to 'ansible-galaxy collection' #73464

[WIP] Add 'uninstall' subcommand to 'ansible-galaxy collection' #73464

Conversation

s-hertel commented Feb 3, 2021 • edited Loading

SUMMARY

ISSUE TYPE

This comment has been minimized.

webknjaz left a comment

Choose a reason for hiding this comment

webknjaz Feb 3, 2021

Choose a reason for hiding this comment

s-hertel Nov 19, 2021

Choose a reason for hiding this comment

s-hertel commented Feb 3, 2021

ansibot commented Nov 19, 2021

ansibot commented Nov 19, 2021

ansibot commented Nov 20, 2021

jborean93 commented Nov 9, 2022

s-hertel commented Feb 3, 2021 •

edited

Loading