foreman_admin 0.0.1

data/README.md

@@ -0,0 +1,11 @@
+# foreman-admin
+
+A collection of Foreman related helper scripts to make administrating the server a little easier.
+
+## development
+
+To run `foreman-admin` while developing use:
+
+```
+$ bundle exec bin/foreman-admin [command] [options]
+```

data/Rakefile

@@ -0,0 +1,50 @@
+# -*- encoding:utf-8 -*-
+
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+
+  desc 'Run RuboCop style checker with xml output for Jenkins'
+  task 'rubocop:jenkins' do
+    system('bundle exec rubocop \
+           --require rubocop/formatter/checkstyle_formatter \
+           --format Rubocop::Formatter::CheckstyleFormatter \
+           --no-color --out rubocop.xml')
+  end
+rescue LoadError
+  puts 'Rubocop not loaded.'
+  task :rubocop do
+    # do nothing
+  end
+end
+
+begin # TODO: remove begin-block once all i18n stuff is in place
+
+  namespace :gettext do
+    desc 'update pot file'
+    task :find do
+      require 'foreman-admin/version'
+      require 'foreman-admin/i18n'
+      require 'gettext/tools'
+
+      domain = ForemanAdmin::I18n::LocalDomain.new
+      GetText.update_potfiles(domain.domain_name,
+        domain.translated_files,
+        "#{domain.domain_name} #{ForemanAdmin.version}",
+        :po_root => domain.locale_dir)
+    end
+  end
+rescue => e
+  puts 'Error occuring during localization task'
+  puts e.message
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = ['test/helper.rb']
+end
+
+task :default => [:test, :rubocop]

data/bin/foreman-admin

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# -*- encoding: utf-8 -*-
+
+require 'rubygems'
+require 'foreman_admin'
+ForemanAdmin::MainCommand.run

data/lib/foreman_admin.rb

@@ -0,0 +1,15 @@
+# -*- encoding: utf-8 -*-
+
+# dependencies
+require 'clamp'
+
+require 'foreman_admin/command'
+require 'foreman_admin/external_command'
+require 'foreman_admin/backup'
+require 'foreman_admin/restore'
+require 'foreman_admin/task_export'
+require 'foreman_admin/update'
+require 'foreman_admin/debug'
+
+# main goes last
+require 'foreman_admin/main'

data/lib/foreman_admin/backup.rb

@@ -0,0 +1,13 @@
+# -*- encoding: utf-8 -*-
+
+module ForemanAdmin
+  class BackupCommand < ForemanAdmin::ExternalCommand
+    command_name 'backup'
+    description 'Backup your Foreman server'
+    external_invocation '/usr/sbin/foreman-backup'
+
+    # TODO: any options?
+    #
+    # or parameters?
+  end
+end

data/lib/foreman_admin/command.rb

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+
+module ForemanAdmin
+  class Command < ::Clamp::Command
+    def self.command_name(name = nil)
+      @command_name = name if name
+      @command_name
+    end
+
+    def command_name
+      self.class.command_name
+    end
+
+    def self.description(description = nil)
+      @description = description if description
+      @description
+    end
+
+    def description
+      self.class.description
+    end
+
+    def execute
+      # override me
+    end
+  end
+end

data/lib/foreman_admin/debug.rb

@@ -0,0 +1,59 @@
+# -*- encoding: utf-8 -*-
+
+module ForemanAdmin
+  class DebugCommand < ForemanAdmin::ExternalCommand
+    UPLOAD_RESPONSE = 'Archive has been uploaded'
+    NO_UPLOAD_RESPONSE = 'Skipping archive upload'
+
+    command_name 'generate-debug'
+    description 'Create a foreman-debug tarball for debugging purposes'
+    external_invocation '/usr/sbin/foreman-debug'
+
+    option ['-d', '--directory'],
+      'DIR',
+      'Directory to place the tarball in (default: /tmp/foreman-XYZ)'
+    option ['-g', '--[no-]generic'],
+      :flag,
+      'Whether or not to include generic info (CPU, memory, firewall, etc)',
+      :default => true
+    option ['-a', '--[no-]tarball'],
+      :flag,
+      'Whether to generate a tarball from the resulting directory',
+      :default => true
+    option ['-m', '--max-lines'],
+      'LINES',
+      'Maximum lines to keep for each file (default: 5000)'
+    option ['-j', '--filter-program'],
+      'PROGRAM',
+      'Filter with provided program when creating a tarball'
+    option ['-p', '--password-patterns'],
+      :flag,
+      'Print password patterns being filtered out'
+    option ['-q', '--quiet'],
+      :flag,
+      'Quiet mode'
+    option ['-v', '--verbose'],
+      :flag,
+      'Verbose mode'
+    option ['-u', '--[no-]upload'],
+      :flag,
+      'Whether to upload archive to rsync://theforeman.org/debug-incoming',
+      :default => false
+
+    def external_command
+      args = []
+      args << '-d' << "'#{directory}'" if directory
+      args << '-g' unless generic?
+      args << '-a' unless tarball?
+      args << '-m' << max_lines if max_lines
+      args << '-j' << "'#{filter_program}'" if filter_program
+      args << '-p' if password_patterns?
+      args << '-q' if quiet?
+      args << '-v' if verbose?
+      args << '-u' if upload?
+
+      args.unshift(external_invocation)
+      args.join(' ')
+    end
+  end
+end

data/lib/foreman_admin/external_command.rb

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+
+module ForemanAdmin
+  class ExternalCommand < ForemanAdmin::Command
+    # The base command that will be executed externally.
+    # Think of this as ARGV[0] of what we're running externally.
+    def self.external_invocation(invocation = nil)
+      @external_invocation = invocation if invocation
+      @external_invocation
+    end
+
+    def external_invocation
+      self.class.external_invocation
+    end
+
+    # The exact assembled command that will be executed externally.
+    # Override this in a child class if you want it have logic.
+    def external_command
+      "#{external_invocation}"
+    end
+
+    def execute
+      puts `#{external_command}`
+    end
+  end
+end

data/lib/foreman_admin/main.rb

@@ -0,0 +1,26 @@
+module ForemanAdmin
+  class MainCommand < ForemanAdmin::Command
+    option '--version', :flag, 'Show version' do
+      puts "#{invocation_path} #{ForemanAdmin.version.version}"
+      exit
+    end
+
+    # TODO: uncomment once these external scripts are in place
+
+    # subcommand BackupCommand.command_name,
+    #   BackupCommand.description,
+    #   BackupCommand
+    # subcommand RestoreCommand.command_name,
+    #   RestoreCommand.description,
+    #   RestoreCommand
+    subcommand DebugCommand.command_name,
+      DebugCommand.description,
+      DebugCommand
+    subcommand TaskExportCommand.command_name,
+      TaskExportCommand.description,
+      TaskExportCommand
+    # subcommand UpdateCommand.command_name,
+    #   UpdateCommand.description,
+    #   UpdateCommand
+  end
+end

data/lib/foreman_admin/restore.rb

@@ -0,0 +1,13 @@
+# -*- encoding: utf-8 -*-
+
+module ForemanAdmin
+  class RestoreCommand < ForemanAdmin::ExternalCommand
+    command_name 'restore'
+    description 'Restore your Foreman server'
+    external_invocation '/usr/sbin/foreman-restore'
+
+    # TODO: any options?
+    #
+    # or parameters?
+  end
+end

data/lib/foreman_admin/task_export.rb

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+
+module ForemanAdmin
+  class TaskExportCommand < ForemanAdmin::ExternalCommand
+    command_name 'export-tasks'
+    description "Export a file containing Foreman's task data (default: only incomplete tasks are exported)"
+    external_invocation '/usr/sbin/foreman-rake foreman_tasks:export_tasks'
+
+    option ['--all'], :flag, 'Export all tasks (Note: this could take some time)'
+    option ['--export-file'], 'FILENAME', 'Specify the filename.tar.gz archive to export tasks into'
+
+    def external_command
+      args = []
+      args << 'tasks=all' if all?
+      args << "export=#{export_file}" if export_file
+
+      args.unshift(external_invocation)
+      args.join(' ')
+    end
+  end
+end

data/lib/foreman_admin/update.rb

@@ -0,0 +1,13 @@
+# -*- encoding: utf-8 -*-
+
+module ForemanAdmin
+  class UpdateCommand < ForemanAdmin::ExternalCommand
+    command_name 'update'
+    description 'Update your Foreman server'
+    external_invocation '/usb/sbin/foreman-update fancy-style'
+
+    # TODO: any options?
+    #
+    # or parameters?
+  end
+end

data/lib/foreman_admin/version.rb

@@ -0,0 +1,7 @@
+# -*- encoding: utf-8 -*-
+
+module ForemanAdmin
+  def self.version
+    @version ||= Gem::Version.new('0.0.1')
+  end
+end

data/test/backup_test.rb

@@ -0,0 +1,17 @@
+module ForemanAdmin
+  class BackupCommandTest < MiniTest::Unit::TestCase
+    include ForemanAdminTestHelpers
+
+    def setup
+      @command = BackupCommand.new('')
+    end
+
+    def teardown
+      @command = nil
+    end
+
+    def test_external_command
+      assert_equal(@command.external_command, '/usr/sbin/foreman-backup')
+    end
+  end
+end

data/test/command_test.rb

@@ -0,0 +1,25 @@
+module ForemanAdmin
+  class CommandTest < MiniTest::Unit::TestCase
+    def setup
+      @command = Command.new('')
+    end
+
+    def teardown
+      @command = nil
+      Command.command_name(nil)
+      Command.description(nil)
+    end
+
+    def test_command_name
+      Command.command_name('foobar')
+
+      assert_equal(@command.command_name, 'foobar')
+    end
+
+    def test_description
+      Command.description("this command is called 'foobar'")
+
+      assert_equal(@command.description, "this command is called 'foobar'")
+    end
+  end
+end

data/test/debug_test.rb

@@ -0,0 +1,73 @@
+module ForemanAdmin
+  class DebugCommandTest < MiniTest::Unit::TestCase
+    include ForemanAdminTestHelpers
+
+    def setup
+      @command = DebugCommand.new('')
+    end
+
+    def teardown
+      @command = nil
+    end
+
+    def test_option_directory
+      @command.directory = '/tmp/solid_snake'
+
+      assert_includes_option(@command, "-d '/tmp/solid_snake'")
+    end
+
+    def test_option_skip_generic
+      @command.generic = false
+
+      assert_includes_option(@command, '-g')
+    end
+
+    def test_option_no_tarball
+      @command.tarball = false
+
+      assert_includes_option(@command, '-a')
+    end
+
+    def test_option_tarball
+      @command.tarball = true
+
+      refute_includes_option(@command, '-a')
+    end
+
+    def test_option_max_lines
+      @command.max_lines = 9001
+
+      assert_includes_option(@command, '-m 9001')
+    end
+
+    def test_option_filter_program
+      @command.filter_program = '/usr/bin/super-awesome-filter-program'
+
+      assert_includes_option(@command, "-j '/usr/bin/super-awesome-filter-program'")
+    end
+
+    def test_option_passwd_patterns
+      @command.password_patterns = true
+
+      assert_includes_option(@command, '-p')
+    end
+
+    def test_option_quiet
+      @command.quiet = true
+
+      assert_includes_option(@command, '-q')
+    end
+
+    def test_option_verbose
+      @command.verbose = true
+
+      assert_includes_option(@command, '-v')
+    end
+
+    def test_option_upload
+      @command.upload = true
+
+      assert_includes_option(@command, '-u')
+    end
+  end
+end

data/test/external_command_test.rb

@@ -0,0 +1,26 @@
+module ForemanAdmin
+  class ExternalCommandTest < MiniTest::Unit::TestCase
+    include ForemanAdminTestHelpers
+
+    def setup
+      @command = ExternalCommand.new('')
+    end
+
+    def teardown
+      @command = nil
+      ExternalCommand.external_invocation(nil)
+    end
+
+    def test_external_invocation
+      ExternalCommand.external_invocation('figlet')
+
+      assert_equal(@command.external_invocation, 'figlet')
+    end
+
+    def test_external_command
+      ExternalCommand.external_invocation('figlet')
+
+      assert_equal(@command.external_command, 'figlet')
+    end
+  end
+end