hammer_cli_foreman_remote_execution 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc6f8140afdb51443d73dcb66d8031d54d7a4eb6
+  data.tar.gz: edcfa63f45a679e4042bf9c1462735a3450c6085
+SHA512:
+  metadata.gz: 0957feb73b6107cf06abec25691e27842040b26eb98346d9375eb3a787b3a5acc6855fcdb7e75b1d2616b12e07eec8ad176eba7086159bf319910affafb7c8ea
+  data.tar.gz: 08ba0281f7f6a50f54d71aecc4d88b58e66ba34332f6350d50809fcbb559899b95dcf361c2ddc4706aefde0922fb125cbdc623a604c0c3dbefa4d7c09cb68374

data/.gitignore

@@ -0,0 +1,20 @@
+# Ruby + project files
+Gemfile.lock
+Gemfile.local
+pkg
+*.gem
+
+# Tests
+test/reports
+coverage
+
+# RVM
+.rvmrc
+.ruby-version
+.ruby-gemset
+
+# Editors
+tags
+.idea
+*.sw?
+*~

data/.rubocop.yml

@@ -0,0 +1,8 @@
+Metrics/LineLength:
+  Max: 100
+
+Style/Documentation:
+  Enabled: false
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+sudo: false

data/Gemfile

@@ -0,0 +1,19 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'gettext', '>= 3.1.3', '< 4.0.0'
+
+group :test do
+  gem 'rake', '~> 10.1.0'
+  gem 'thor'
+  gem 'minitest', '< 5.0.0'
+  gem 'minitest-spec-context'
+  gem 'simplecov'
+  gem 'mocha'
+  gem 'ci_reporter', '>= 1.6.3', "< 2.0.0", :require => false
+end
+
+# load local gemfile
+local_gemfile = File.join(File.dirname(__FILE__), 'Gemfile.local')
+self.instance_eval(Bundler.read_file(local_gemfile)) if File.exist?(local_gemfile)

data/LICENSE

@@ -0,0 +1,11 @@
+This program and entire repository is free software: you can redistribute it
+and/or modify it under the terms of the GNU General Public License as published
+by the Free Software Foundation, either version 3 of the License, or any later
+version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with
+this program. If not, see http://www.gnu.org/licenses/.

data/README.md

@@ -0,0 +1,61 @@
+CLI Plugin for Foreman Remote Execution
+=======================================
+
+This [Hammer CLI](https://github.com/theforeman/hammer-cli) plugin contains commands for [foreman_remote_execution](https://github.com/theforeman/foreman_remote_execution).
+
+Examples
+--------
+
+### Create a Template
+
+```
+hammer job-template create --file /tmp/template.txt --name "Ping a Host"\
+  --provider-type Ssh --job-name "Ping"
+```
+
+### Create a Template Input
+
+```
+hammer template-input create --template-id 17 --name hostname\
+  --input-type user --options www.google.com,www.facebook.com,localhost
+```
+
+### Run a Job Examples
+
+#### Command line inputs
+
+```
+hammer job-invocation create --job-name "Run Command" --inputs command="ping -c 50 www.google.com"\
+  --search-query "name ~ rex01"
+```
+
+```
+hammer job-invocation create --job-name "Package Action"\
+  --inputs package=vim-enhanced,action=install --search-query "name ~ rex01"
+```
+
+#### File inputs:
+
+```
+hammer job-invocation create --job-name "Run Command"\
+  --input-files command=/tmp/script.sh --search-query "name ~ rex01"
+```
+
+### Show output
+
+If the job is currently running, this will refresh until the job completes.
+
+```
+hammer job-invocation output --id 155 --host rex01.example.com
+```
+
+Alternatively, pass the `--async` option to see the output so far:
+
+```
+hammer job-invocation output --id 155 --host rex01.example.com --async
+```
+
+License
+-------
+
+This project is licensed under the GPLv3+.

data/Rakefile

@@ -0,0 +1,30 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'ci/reporter/rake/minitest'
+
+Rake::TestTask.new :test do |t|
+  t.libs.push "lib"
+  t.test_files = Dir.glob('test/**/*_test.rb')
+  t.verbose = true
+end
+
+namespace :gettext do
+  desc 'Update pot file'
+  task :find do
+    require 'hammer_cli_foreman_remote_execution/version'
+    require 'hammer_cli_foreman_remote_execution/i18n'
+    require 'gettext/tools'
+
+    domain = HammerCLIForemanRemoteExecution::I18n::LocaleDomain.new
+    GetText.update_pofiles(domain.domain_name, domain.translated_files,
+                           "#{domain.domain_name} #{HammerCLIForemanRemoteExecution.version}",
+                           :po_root => domain.locale_dir)
+  end
+end
+
+namespace :pkg do
+  desc 'Generate package source gem'
+  task :generate_source => :build
+end
+
+task :default => :test

data/config/foreman_remote_execution.yml

@@ -0,0 +1,2 @@
+:foreman_remote_execution:
+  :enable_module: true

data/hammer_cli_foreman_remote_execution.gemspec

@@ -0,0 +1,21 @@
+require File.expand_path('../lib/hammer_cli_foreman_remote_execution/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name          = 'hammer_cli_foreman_remote_execution'
+  s.version       = HammerCLIForemanRemoteExecution.version.dup
+  s.platform      = Gem::Platform::RUBY
+  s.authors       = ['Foreman Remote Execution team']
+  s.email         = ['foreman-dev@googlegroups.com']
+  s.homepage      = 'http://github.com/theforeman/hammer_cli_foreman_remote_execution'
+  s.license       = 'GPL v3+'
+
+  s.summary       = 'CLI for the Foreman remote execution plugin'
+  s.description   = 'CLI for the Foreman remote execution plugin'
+
+  s.files =            `git ls-files`.split("\n")
+  s.test_files =       `git ls-files test`.split("\n")
+  s.extra_rdoc_files = `git ls-files doc`.split("\n") + Dir['README*', 'LICENSE']
+
+  s.add_dependency 'hammer_cli_foreman', '>= 0.1.3', '< 0.5.0'
+  s.add_dependency 'hammer_cli_foreman_tasks', '~> 0.0.3'
+end

data/lib/hammer_cli_foreman_remote_execution/i18n.rb

@@ -0,0 +1,21 @@
+require 'hammer_cli/i18n'
+
+module HammerCLIForemanRemoteExecution
+  module I18n
+    class LocaleDomain < HammerCLI::I18n::LocaleDomain
+      def translated_files
+        Dir.glob(File.join(File.dirname(__FILE__), '../**/*.rb'))
+      end
+
+      def locale_dir
+        File.join(File.dirname(__FILE__), '../../locale')
+      end
+
+      def domain_name
+        'hammer-cli-foreman-remote-execution'
+      end
+    end
+  end
+end
+
+HammerCLI::I18n.add_domain(HammerCLIForemanRemoteExecution::I18n::LocaleDomain.new)

data/lib/hammer_cli_foreman_remote_execution/job_invocation.rb

@@ -0,0 +1,111 @@
+module HammerCLIForemanRemoteExecution
+  class JobInvocation < HammerCLIForeman::Command
+    resource :job_invocations
+
+    class ListCommand < HammerCLIForeman::ListCommand
+      output do
+        field :id, _('Id')
+        field :job_name, _('Name')
+        field :state, _('Task State')
+      end
+
+      def extend_data(invocation)
+        JobInvocation.extend_data(invocation)
+      end
+
+      build_options
+    end
+
+    class InfoCommand < HammerCLIForeman::InfoCommand
+      output ListCommand.output_definition do
+        field :hosts, _('Hosts')
+      end
+
+      def extend_data(invocation)
+        JobInvocation.extend_data(invocation)
+      end
+
+      build_options do |o|
+        o.expand(:none)
+      end
+    end
+
+    class OutputCommand < HammerCLIForeman::Command
+      action :output
+      command_name 'output'
+      desc _('View the output for a host')
+
+      option '--async', :flag, N_('Do not wait for job to complete, shows current output only')
+
+      def print_data(output)
+        line_set = output['output'].sort_by { |lines| lines['timestamp'].to_f }
+        since = nil
+
+        line_set.each do |line|
+          puts line['output']
+          since = line['timestamp']
+        end
+
+        if output['refresh'] && !option_async?
+          sleep 1
+          print_data(resource.call(action, request_params.merge(:since => since), request_headers, request_options))
+        end
+      end
+
+      build_options do |o|
+        o.expand(:all).except(:job_invocations)
+        o.without(:since)
+      end
+    end
+
+    class CreateCommand < HammerCLIForeman::CreateCommand
+      include HammerCLIForemanTasks::Async
+
+      success_message _('Job invocation %{id} started')
+
+      option '--inputs', 'INPUTS', N_('Specify inputs from command line'),
+        :format => HammerCLI::Options::Normalizers::KeyValueList.new
+
+      # For passing larger scripts, etc.
+      option '--input-files', 'INPUT FILES', N_('Read input values from files'),
+        :format => ::HammerCLIForemanRemoteExecution::Options::Normalizers::KeyFileList.new
+
+      option '--dynamic', :flag, N_('Dynamic search queries are evaluated at run time')
+
+      def request_params
+        params = super
+
+        cli_inputs = option_inputs || {}
+        file_inputs = option_input_files || {}
+        params['job_invocation']['inputs'] = cli_inputs.merge(file_inputs)
+
+        params['job_invocation']['targeting_type'] = option_dynamic? ? 'dynamic_query' : 'static_query'
+        params
+      end
+
+      def task_progress(task_or_id)
+        print_message(success_message, task_or_id)
+        task = task_or_id['dynflow_task']['id']
+        super(task)
+      end
+
+      build_options do |o|
+        o.without(:targeting_type)
+      end
+    end
+
+    def self.extend_data(invocation)
+      invocation['state'] = invocation['dynflow_task'] ? invocation['dynflow_task']['state'] : _('unknown')
+
+      if invocation['targeting'] && invocation['targeting']['hosts']
+        invocation['hosts'] = "\n" + invocation['targeting']['hosts'].map { |host| " - #{host['name']}" }.join("\n")
+      end
+
+      invocation
+    end
+
+    autoload_subcommands
+  end
+
+  HammerCLI::MainCommand.subcommand 'job-invocation', _('Manage job invocations'), JobInvocation
+end

data/lib/hammer_cli_foreman_remote_execution/job_template.rb

@@ -0,0 +1,93 @@
+module HammerCLIForemanRemoteExecution
+  class JobTemplate < HammerCLIForeman::Command
+    resource :job_templates
+
+    class ListCommand < HammerCLIForeman::ListCommand
+      output do
+        field :id, _('Id')
+        field :name, _('Name')
+        field :job_name, _('Job Name')
+        field :provider_type, _('Provider')
+        field :type, _('Type')
+      end
+
+      def extend_data(template)
+        JobTemplate.data_extensions(template)
+      end
+
+      build_options
+    end
+
+    class InfoCommand < HammerCLIForeman::InfoCommand
+      output ListCommand.output_definition do
+        field :template_inputs, _('Inputs')
+        HammerCLIForeman::References.taxonomies(self)
+      end
+
+      def extend_data(template)
+        JobTemplate.data_extensions(template)
+      end
+
+      build_options
+    end
+
+    class DumpCommand < HammerCLIForeman::InfoCommand
+      command_name 'dump'
+      desc _('View job template content')
+
+      def print_data(template)
+        puts template['template']
+      end
+
+      build_options
+    end
+
+    class CreateCommand < HammerCLIForeman::CreateCommand
+      option '--file', 'TEMPLATE', N_('Path to a file that contains the template'),
+             :attribute_name => :option_template, :required => true,
+             :format => HammerCLI::Options::Normalizers::File.new
+
+      success_message _('Job template created')
+      failure_message _('Could not create the job template')
+
+      build_options do |o|
+        o.without(:template)
+      end
+    end
+
+    class UpdateCommand < HammerCLIForeman::UpdateCommand
+      option '--file', 'TEMPLATE', N_('Path to a file that contains the template'),
+             :attribute_name => :option_template,
+             :format => HammerCLI::Options::Normalizers::File.new
+
+      success_message _('Job template updated')
+      failure_message _('Could not update the job template')
+
+      build_options do |o|
+        o.without(:template)
+      end
+    end
+
+    class DeleteCommand < HammerCLIForeman::DeleteCommand
+      success_message _('Job template deleted')
+      failure_message _('Could not delete the job template')
+
+      build_options
+    end
+
+    def self.data_extensions(template)
+      template['type'] = template['snippet'] ? 'snippet' : 'job_template'
+
+      if template['template_inputs']
+        template_inputs = template['template_inputs'].map { |option| "  - #{option['name']}" }.join("\n")
+        template['template_inputs'] = "\n#{template_inputs}\n"
+      end
+
+      template
+    end
+
+    autoload_subcommands
+  end
+
+  HammerCLI::MainCommand.subcommand 'job-template', _('Manage job templates'), JobTemplate
+end

data/lib/hammer_cli_foreman_remote_execution/options/normalizers.rb

@@ -0,0 +1,25 @@
+module HammerCLIForemanRemoteExecution
+  module Options
+    module Normalizers
+      class KeyFileList < ::HammerCLI::Options::Normalizers::KeyValueList
+        def description
+          _('Comma-separated list of key=file, where file is a path to a text file to be read')
+        end
+
+        def format(val)
+          Hash[super.map { |key, path| [key, ::File.read(::File.expand_path(path))] }]
+        end
+
+        def complete(value)
+          Dir[value.to_s+'*'].collect do |file|
+            if ::File.directory?(file)
+              file+'/'
+            else
+              file+' '
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hammer_cli_foreman_remote_execution/template_input.rb

@@ -0,0 +1,49 @@
+module HammerCLIForemanRemoteExecution
+  class TemplateInput < HammerCLIForeman::Command
+    resource :template_inputs
+    desc _('Manage template inputs')
+
+    class ListCommand < HammerCLIForeman::ListCommand
+      output do
+        field :id, _('Id')
+        field :name, _('Name')
+        field :input_type, _('Input type')
+      end
+
+      build_options
+    end
+
+    class InfoCommand < HammerCLIForeman::InfoCommand
+      output do
+        field :id, _('Id')
+        field :name, _('Name')
+        field :input_type, _('Input type')
+
+        field :fact_name, _('Fact name')
+        field :variable_name, _('Variable name')
+        field :puppet_parameter_name, _('Puppet parameter name')
+        field :options, _('Options'), Fields::List, :width => 25, :hide_blank => true
+      end
+
+      build_options
+    end
+
+    class CreateCommand < HammerCLIForeman::CreateCommand
+      success_message _('Template input created')
+      failure_message _('Could not create the template input')
+
+      build_options
+    end
+
+    class DeleteCommand < HammerCLIForeman::DeleteCommand
+      success_message _('Template input deleted')
+      failure_message _('Could not delete the template input')
+
+      build_options
+    end
+
+    autoload_subcommands
+  end
+
+  HammerCLI::MainCommand.subcommand 'template-input', _('Manage template inputs'), TemplateInput
+end

data/lib/hammer_cli_foreman_remote_execution/version.rb

@@ -0,0 +1,5 @@
+module HammerCLIForemanRemoteExecution
+  def self.version
+    @version ||= Gem::Version.new '0.0.1'
+  end
+end

data/lib/hammer_cli_foreman_remote_execution.rb

@@ -0,0 +1,14 @@
+require 'hammer_cli'
+require 'hammer_cli_foreman'
+require 'hammer_cli_foreman_tasks'
+
+module HammerCLIForemanRemoteExecution
+  require 'hammer_cli_foreman_remote_execution/options/normalizers'
+  require 'hammer_cli_foreman_remote_execution/job_invocation'
+  require 'hammer_cli_foreman_remote_execution/job_template'
+  require 'hammer_cli_foreman_remote_execution/template_input'
+
+  def self.exception_handler_class
+    HammerCLIForeman::ExceptionHandler
+  end
+end