Skip to content
This repository has been archived by the owner on Jul 30, 2020. It is now read-only.

For 'mazer list --content', show fully qualified name #196

Closed
alikins opened this issue Mar 8, 2019 · 0 comments · Fixed by #275
Closed

For 'mazer list --content', show fully qualified name #196

alikins opened this issue Mar 8, 2019 · 0 comments · Fixed by #275
Labels
priority/high status/new Triage required type/enhancement
Projects
Feature Development
Milestone
Mazer 1.0.0

Comments

@alikins
Copy link
Contributor

alikins commented Mar 8, 2019 •
edited

Feature Request

Use Case

What problem does this feature solve? Please describe.

The recommended way to reference collection content (e.g., role, module, plugin) from within a playbook is to use the fully qualified name style: namespace.name.my_content_name.

However, there's not an easy way for a playbook author to know the fully qualified name. It would be useful, and less error prone, if mazer could show the fully qualified name.

Proposed Solution

Describe the solution you'd like
Alter the mazer list --content output to include the fully qualified name.

Current output example:

repo=alikins.collection_reqs_test, type=repository, version=2.1113.13
repo=alikins.collection_reqs_test, type=roles, name=cole_role, version=2.1113.13
repo=alikins.collection_reqs_test, type=roles, name=bole_role, version=2.1113.13
repo=alikins.collection_reqs_test, type=roles, name=aole_role, version=2.1113.13
repo=alikins.collection_reqs_test, type=callback, name=faux, version=2.1113.13
repo=alikins.collection_reqs_test, type=vars, name=mars_bars, version=2.1113.13
repo=alikins.collection_reqs_test, type=action, name=faux_debug, version=2.1113.13
repo=alikins.collection_reqs_test, type=inventory, name=zero, version=2.1113.13
repo=alikins.collection_reqs_test, type=filter, name=air_quote, version=2.1113.13
repo=alikins.collection_reqs_test, type=module_utils, name=whatever, version=2.1113.13

Potential output example (Note, important part is the concept of the full_name value, the rest of the output is likely to change so don't get hung up on it):

collection=alikins.collection_reqs_test, type=collection, version=2.1113.13
collection=alikins.collection_reqs_test, type=roles, name=cole_role, full_name=alikins.collection_reqs_test.cole_role, version=2.1113.13
collection=alikins.collection_reqs_test, type=roles, name=bole_role, full_name=alikins.collection_reqs_test.bole_role, version=2.1113.13
collection=alikins.collection_reqs_test, type=roles, name=aole_role, full_name=alikins.collection_reqs_test.aole_role, version=2.1113.13
collection=alikins.collection_reqs_test, type=callback, name=faux, full_name=alikins.collection_reqs_test.faux, version=2.1113.13
collection=alikins.collection_reqs_test, type=vars, name=mars_bars, full_name=alikins.collection_reqs_test.mars_bars, version=2.1113.13
collection=alikins.collection_reqs_test, type=action, name=faux_debug, full_name=alikins.collection_reqs_test.faux_debug, version=2.1113.13
collection=alikins.collection_reqs_test, type=inventory, name=zero, full_name=alikins.collection_reqs_test.zero, version=2.1113.13
collection=alikins.collection_reqs_test, type=filter, name=air_quote, full_name=alikins.collection_reqs_test.air_quote, version=2.1113.13
collection=alikins.collection_reqs_test, type=module_utils, name=whatever, full_name=ansible_collections.alikins.collection_reqs_test.plugins.module_utils.whatever, version=2.1113.13

Alternatives

Describe alternatives you've considered

  • not doing it?
  • just doing some pretty, readable default, and adding a --json or --yaml or --oneline for machine readable use and script

Implementation

Teachability, Documentation, Adoption, Migration Strategy

Should mostly just be a matter of changing the string formats in ansible_galaxy.actions.list._list()
@chouseknecht chouseknecht changed the title For 'mazer list --content', show content with the fully qualified name that would be used in a playbook For 'mazer list --content', show fully qualified name Mar 21, 2019
@alikins alikins added this to To do in Feature Development via automation Mar 28, 2019
@alikins alikins added this to the Mazer 1.0.0 milestone Mar 28, 2019
alikins added a commit to alikins/mazer that referenced this issue Apr 25, 2019
@alikins
list output refs to 'collection' not 'repository'
619bd5d 
'mazer list' was calling installed items 'repository'
so update to 'collection'

Implements part of issue ansible#196.

Related: ansible#196
alikins added a commit to alikins/mazer that referenced this issue May 30, 2019
@alikins
list output refs to 'collection' not 'repository'
9f83e95 
'mazer list' was calling installed items 'repository'
so update to 'collection'

Implements part of issue ansible#196.

Related: ansible#196
alikins added a commit to alikins/mazer that referenced this issue May 30, 2019
@alikins
Add 'list --full' to list fully qualified collection names
d6e002e 
ie, list the collection and content names as they would be
referenced from a playbook.

Also include the 'python path' name for plugins/module_utils.

For ex:

$ mazer list --content --full
 alikins.collection_inspect,0.0.48
  - roles
    - alikins.collection_inspect.test_collection_inspect
  - modules
    - alikins.collection_inspect.collection_inspect_no_module_utils
    - alikins.collection_inspect.collection_inspect
    - alikins.collection_inspect.get_collection_inspect
  - callback
    - alikins.collection_inspect.collection_inspect
      - (python path) ansible_collections.alikins.collection_inspect.plugins.callback.collection_inspect
  - lookup
    - alikins.collection_inspect.collection_inspect
      - (python path) ansible_collections.alikins.collection_inspect.plugins.lookup.collection_inspect
  - vars
    - alikins.collection_inspect.collection_inspect
      - (python path) ansible_collections.alikins.collection_inspect.plugins.vars.collection_inspect
  - action
    - alikins.collection_inspect.collection_inspect
      - (python path) ansible_collections.alikins.collection_inspect.plugins.action.collection_inspect
  - filter
    - alikins.collection_inspect.collection_inspect
      - (python path) ansible_collections.alikins.collection_inspect.plugins.filter.collection_inspect
  - module_utils
    - alikins.collection_inspect.collection_inspect
      - (python path) ansible_collections.alikins.collection_inspect.plugins.module_utils.collection_inspect

Fixes ansible#196
@alikins alikins mentioned this issue May 30, 2019
Merged
alikins added a commit to alikins/mazer that referenced this issue May 30, 2019
@alikins
list output refs to 'collection' not 'repository'
fe86896 
'mazer list' was calling installed items 'repository'
so update to 'collection'

Implements part of issue ansible#196.

Related: ansible#196
alikins added a commit to alikins/mazer that referenced this issue May 30, 2019
@alikins
Add 'list --full' to list fully qualified collection names
5489a40 
ie, list the collection and content names as they would be
referenced from a playbook.

Also include the 'python path' name for plugins/module_utils.

For ex:

$ mazer list --content --full
 alikins.collection_inspect,0.0.48
  - roles
    - alikins.collection_inspect.test_collection_inspect
  - modules
    - alikins.collection_inspect.collection_inspect_no_module_utils
    - alikins.collection_inspect.collection_inspect
    - alikins.collection_inspect.get_collection_inspect
  - callback
    - alikins.collection_inspect.collection_inspect
      - (python path) ansible_collections.alikins.collection_inspect.plugins.callback.collection_inspect
  - lookup
    - alikins.collection_inspect.collection_inspect
      - (python path) ansible_collections.alikins.collection_inspect.plugins.lookup.collection_inspect
  - vars
    - alikins.collection_inspect.collection_inspect
      - (python path) ansible_collections.alikins.collection_inspect.plugins.vars.collection_inspect
  - action
    - alikins.collection_inspect.collection_inspect
      - (python path) ansible_collections.alikins.collection_inspect.plugins.action.collection_inspect
  - filter
    - alikins.collection_inspect.collection_inspect
      - (python path) ansible_collections.alikins.collection_inspect.plugins.filter.collection_inspect
  - module_utils
    - alikins.collection_inspect.collection_inspect
      - (python path) ansible_collections.alikins.collection_inspect.plugins.module_utils.collection_inspect

Fixes ansible#196
alikins added a commit to alikins/mazer that referenced this issue May 30, 2019
@alikins
list output refs to 'collection' not 'repository'
24fb9d0 
'mazer list' was calling installed items 'repository'
so update to 'collection'

Implements part of issue ansible#196.

Related: ansible#196
alikins added a commit to alikins/mazer that referenced this issue May 30, 2019
@alikins
Add 'list --full' to list fully qualified collection names
03b0dea 
ie, list the collection and content names as they would be
referenced from a playbook.

Also include the 'python path' name for plugins/module_utils.

For ex:

$ mazer list --content --full
 alikins.collection_inspect,0.0.48
  - roles
    - alikins.collection_inspect.test_collection_inspect
  - modules
    - alikins.collection_inspect.collection_inspect_no_module_utils
    - alikins.collection_inspect.collection_inspect
    - alikins.collection_inspect.get_collection_inspect
  - callback
    - alikins.collection_inspect.collection_inspect
      - (python path) ansible_collections.alikins.collection_inspect.plugins.callback.collection_inspect
  - lookup
    - alikins.collection_inspect.collection_inspect
      - (python path) ansible_collections.alikins.collection_inspect.plugins.lookup.collection_inspect
  - vars
    - alikins.collection_inspect.collection_inspect
      - (python path) ansible_collections.alikins.collection_inspect.plugins.vars.collection_inspect
  - action
    - alikins.collection_inspect.collection_inspect
      - (python path) ansible_collections.alikins.collection_inspect.plugins.action.collection_inspect
  - filter
    - alikins.collection_inspect.collection_inspect
      - (python path) ansible_collections.alikins.collection_inspect.plugins.filter.collection_inspect
  - module_utils
    - alikins.collection_inspect.collection_inspect
      - (python path) ansible_collections.alikins.collection_inspect.plugins.module_utils.collection_inspect

Fixes ansible#196
Feature Development automation moved this from To do to Done May 30, 2019
alikins added a commit that referenced this issue May 30, 2019
@alikins
list output refs to 'collection' not 'repository'
5349b5d 
'mazer list' was calling installed items 'repository'
so update to 'collection'

Implements part of issue #196.

Related: #196
alikins added a commit that referenced this issue May 30, 2019
@alikins
Add 'list --full' to list fully qualified collection names
1991ff4 
ie, list the collection and content names as they would be
referenced from a playbook.

Also include the 'python path' name for plugins/module_utils.

For ex:

$ mazer list --content --full
 alikins.collection_inspect,0.0.48
  - roles
    - alikins.collection_inspect.test_collection_inspect
  - modules
    - alikins.collection_inspect.collection_inspect_no_module_utils
    - alikins.collection_inspect.collection_inspect
    - alikins.collection_inspect.get_collection_inspect
  - callback
    - alikins.collection_inspect.collection_inspect
      - (python path) ansible_collections.alikins.collection_inspect.plugins.callback.collection_inspect
  - lookup
    - alikins.collection_inspect.collection_inspect
      - (python path) ansible_collections.alikins.collection_inspect.plugins.lookup.collection_inspect
  - vars
    - alikins.collection_inspect.collection_inspect
      - (python path) ansible_collections.alikins.collection_inspect.plugins.vars.collection_inspect
  - action
    - alikins.collection_inspect.collection_inspect
      - (python path) ansible_collections.alikins.collection_inspect.plugins.action.collection_inspect
  - filter
    - alikins.collection_inspect.collection_inspect
      - (python path) ansible_collections.alikins.collection_inspect.plugins.filter.collection_inspect
  - module_utils
    - alikins.collection_inspect.collection_inspect
      - (python path) ansible_collections.alikins.collection_inspect.plugins.module_utils.collection_inspect

Fixes #196
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
priority/high status/new Triage required type/enhancement
Projects
Feature Development
  
Done
Milestone
Mazer 1.0.0
Development

Successfully merging a pull request may close this issue.

Improve 'mazer list' output, add fully qualified output. Fixes #196 alikins/mazer
1 participant
@alikins