lak/puppet-interfaces

Dramatically better CLI tools for interacting with Puppet

puppet-interfaces's Issues

should not store actions in global namespace

The fact that actions are defined globally bothers me, this appears to make it extremely difficult to write helper methods associated with actions (or should I store all of my helper methods somewhere else?).

Did you have something in mind for this?

should be able to custom how results of interfaces are rendered by the application

I found that I want to customize how the application renders results from interfaces for every application that I am working on.

the following code:

    render_method = Puppet::Network::FormatHandler.format(format).render_method
    puts result.send(render_method) if result

cannot handle the rendering of whatever arbitrary data types actions may return.

As a general rule

• all interfaces should return objects (so that they can be used as APIs)
• the application should be able to customize how any results for any actions are rendered.

should be able to render custom interface actions

Hi Luke,

We talked about moving some of my actions from their own custom interfaces to just be plugins of one of your existing interface. This is problematic b/c my actions have custom rendering that would need to be added as a plugin to the application.

If we support plugin actions, then we should also have a way to customize rendering of those applications.

facts upload returns an error

I get the following error when I try to upload facts

[root@mypuppetmaster tests]# puppet agent -t
info: Loading facts in iscsi_initiatorname
info: Loading facts in iscsi_initiatorname
info: Loading facts in iscsi_initiatorname
info: Loading facts in iscsi_initiatorname
info: Caching catalog for puppetclient
info: Applying configuration version '1299064057'
notice: CentOS
notice: /Stage[main]//Node[default]/Notify[CentOS]/message: defined 'message' as 'CentOS'
notice: Finished catalog run in 0.05 seconds
[root@mypuppetmaster tests]# puppet facts upload
err: Cached facts for mypuppetmaster.localdomain failed: certificate verify failed
/usr/lib/ruby/1.8/net/http.rb:586:in `connect': certificate verify failed (OpenSSL::SSL::SSLError)
    from /usr/lib/ruby/1.8/net/http.rb:586:in `connect'
    from /usr/lib/ruby/1.8/net/http.rb:553:in `do_start'
    from /usr/lib/ruby/1.8/net/http.rb:542:in `start'
    from /usr/lib/ruby/1.8/net/http.rb:1035:in `request'
    from /usr/lib/ruby/1.8/net/http.rb:857:in `put'
    from /usr/local/dev/puppet/lib/puppet/indirector/rest.rb:107:in `save'
    from /usr/local/dev/puppet/lib/puppet/indirector/indirection.rb:192:in `find'
    from /usr/local/dev/puppet-interfaces/lib/puppet/interface/facts.rb:11:in `upload'
    from /usr/local/dev/puppet-interfaces/lib/puppet/application/interface_base.rb:46:in `send'
    from /usr/local/dev/puppet-interfaces/lib/puppet/application/interface_base.rb:46:in `main'
    from /usr/local/dev/puppet/lib/puppet/application.rb:312:in `run_command'
    from /usr/local/dev/puppet/lib/puppet/application.rb:304:in `run'
    from /usr/local/dev/puppet/lib/puppet/application.rb:410:in `exit_on_fail'
    from /usr/local/dev/puppet/lib/puppet/application.rb:304:in `run'
    from /usr/local/dev/puppet/lib/puppet/util/command_line.rb:59:in `execute'
    from /usr/local/dev/puppet//bin/puppet:4

showconfig does not work for things that are not indirectors

puppet interface list
...
test:
    Terminuses: 
    Actions: check_tests, compile_tests, showconfig
...

# puppet test showconfig
/usr/local/dev/puppet-interfaces/lib/puppet/interface.rb:87:in `showconfig': undefined local variable or method `indirection' for # (NameError)
    from /usr/local/dev/puppet-interfaces/lib/puppet/application/interface_base.rb:46:in `send'
    from /usr/local/dev/puppet-interfaces/lib/puppet/application/interface_base.rb:46:in `main'
    from /usr/local/dev/puppet/lib/puppet/application.rb:312:in `run_command'
    from /usr/local/dev/puppet/lib/puppet/application.rb:304:in `run'
    from /usr/local/dev/puppet/lib/puppet/application.rb:410:in `exit_on_fail'
    from /usr/local/dev/puppet/lib/puppet/application.rb:304:in `run'
    from /usr/local/dev/puppet/lib/puppet/util/command_line.rb:59:in `execute'
    from /usr/local/dev/puppet//bin/puppet:4

List of tested/failed files should be sorted

Currently it is completely unsorted (hash keys ordering?). It would be nice (if not possible to sort in the order they were tested) for them to be at least alphabetically sorted so you can find files in the output a bit easier.

nodes do not render correctly

puppet node find foo

"#Puppet::Node:0xb7b01dfc"

cannot pass more than one command line argument

I get the following error when I try to pass more than one argument through my application.

# puppet diff catalog /var/lib/puppet/tests/motd-init.pp.pson /var/lib/puppet/tests/motd-init.pp2.pson  --trace
/usr/local/dev/puppet-interface-utils/lib/puppet/interface/diff.rb:9:in `catalog': undefined method `shift' for "/var/lib/puppet/tests/motd-init.pp.pson":String (NoMethodError)
    from /usr/local/dev/puppet-interfaces/lib/puppet/application/interface_base.rb:46:in `send'
    from /usr/local/dev/puppet-interfaces/lib/puppet/application/interface_base.rb:46:in `main'
    from /usr/local/dev/puppet/lib/puppet/application.rb:312:in `run_command'
    from /usr/local/dev/puppet/lib/puppet/application.rb:304:in `run'
    from /usr/local/dev/puppet/lib/puppet/application.rb:410:in `exit_on_fail'
    from /usr/local/dev/puppet/lib/puppet/application.rb:304:in `run'
    from /usr/local/dev/puppet/lib/puppet/util/command_line.rb:59:in `execute'
    from /usr/local/dev/puppet//bin/puppet:4

data_baseclass should catch SYSINT

inside of preinit, it makes sense to catch this signal and exit anyways

application should pass options to interface constructor

options set at the command line should be passed to the interface constructor.

@interface = Puppet::Interface.interface(@type).new(@options)

expand documentation capabilities

Hi Luke,

The most important thing to figure out next is documentation, this will make adoption a lot easer.

• we should be able to write inline documentation associated with interfaces/actions

we should be able to do something like:

puppet interface catalog --help

puppet interface catalog find --help

and get back the relevent docs

data_baseclass should be renamed and have indirector code moved to a child class

I need to refactor the application code to allow non-indirector applications

• data_baseclass should have its name changed since the name of the project has changed from data to interface.
• * I changed it to InterfaceBase
• There should be a baseclass that is not specific to indirectors (InterfaceBase)
• The indirector specific methods/functionality should be moved to a class that inherits from InterfaceBase (InterfaceIndirectorBase)
• all of the indirector specific apps should inherit from InterfaceIndirectorBase

assumes that all terminus actions return results with render method

puppet resource_type search '*'

/usr/local/dev/puppet-interfaces/lib/puppet/application/data_baseclass.rb:50:in main': undefined methodrender' for #Array:0xb7b03724 (NoMethodError)
from /usr/local/dev/puppet//lib/puppet/application.rb:312:in run_command' from /usr/local/dev/puppet//lib/puppet/application.rb:304:inrun'
from /usr/local/dev/puppet//lib/puppet/application.rb:410:in exit_on_fail' from /usr/local/dev/puppet//lib/puppet/application.rb:304:inrun'
from /usr/local/dev/puppet//lib/puppet/util/command_line.rb:59:in `execute'
from /usr/local/dev/puppet//bin/puppet:4

assumes that all interfaces are indirectors

as discussed, I am going to patch this by creating a new class

Puppet::Interface::Indirector < Puppet::Interface

this way interfaces that are not backed by indirectors can just inherit from Puppet::Interface

reder method shoud take action as well as results

I have use cases where an interface may render differently based on the action

InterfaceBase should allow child classes to set exit_code

I added @exit_code to the base application class.

puppet interface list fails with 2.6.5

# puppet interface list
catalog:
    Terminuses: active_record, compiler, queue, rest, yaml
    Actions: destroy, find, save, search, select, showconfig
certificate:
    Terminuses: ca, file, rest
    Actions: destroy, find, save, search, showconfig
certificate_request:
    Terminuses: ca, file, rest
    Actions: destroy, find, save, search, showconfig
certificate_revocation_list:
    Terminuses: ca, file, rest
    Actions: destroy, find, save, search, showconfig
facts:
    Terminuses: active_record, couch, facter, memory, rest, yaml
    Actions: destroy, find, save, search, showconfig, upload
Unable to find interface 'file_bucket_file': no such file to load -- puppet/interface/file_bucket_file.

there are two issues with this:

• should be able to list interfaces even if an indirector is missing
• 2.6.5 introduces a new indirector which needs to have an interface.

extra options for pluggable interface actions?

how can I add extra command line options for custom actions?

I am leaning further towards not writing any action plugins.