hammer_cli_foreman_virt_who_configure 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e293e6b8beb8be03fe09ec3faf7ef1360ccfc454
+  data.tar.gz: 69d4d5f06c5af8ed64d5a27d1bba15012ac0bd46
+SHA512:
+  metadata.gz: 017cf23acc7a82895343feda1c1d279c86b658c15b5916c7acc08a57582d9436170d8a6691fc75d7b7c2537baebe0668d4d3eeceaf2c228a88102f0a459c20a6
+  data.tar.gz: c42922e09f420d3d764232539d7993d99d56bea4b0f2f21018cf3fb5d02dd4baa49a12e0956f08bc0a8bad27cda0413a43ebcb0b6bc5bb0b671e0a7f4419a57c

data/README.md

@@ -0,0 +1,7 @@
+Hammer CLI commands for configuring Virt Who for Katello
+========================================================
+
+License
+-------
+
+This project is licensed under the GPLv3+.

data/config/foreman_virt_who_configure.yml

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

data/lib/hammer_cli_foreman_virt_who_configure.rb

@@ -0,0 +1,9 @@
+require 'hammer_cli'
+require 'hammer_cli_foreman'
+require 'hammer_cli_foreman_virt_who_configure/i18n'
+
+module HammerCLIForemanVirtWhoConfigure
+  HammerCLI::MainCommand.lazy_subcommand('virt-who-config', _("Manage Virt Who configurations"),
+    'HammerCLIForemanVirtWhoConfigure::VirtWhoConfig', 'hammer_cli_foreman_virt_who_configure/config'
+  )
+end

data/lib/hammer_cli_foreman_virt_who_configure/config.rb

@@ -0,0 +1,223 @@
+require 'hammer_cli_foreman_virt_who_configure/system_caller'
+
+module HammerCLIForemanVirtWhoConfigure
+  MODE_UNLIMITED = 0
+  MODE_WHITELIST = 1
+  MODE_BLACKLIST = 2
+
+  class VirtWhoConfig < HammerCLIForeman::Command
+    resource :configs
+
+    def self.format_interval(interval)
+      hr_interval = (interval / 60)
+      if hr_interval <= 1
+        _('every hour')
+      else
+        _('every %s hours') % (interval / 60)
+      end
+    end
+
+    def self.format_status(status)
+      case status
+        when 'unknown'
+          _('No Report Yet')
+        when 'ok', 'out_of_date'
+          _('OK')
+        when 'error'
+          _('Error')
+        else
+          _('Unknown configuration status')
+      end
+    end
+
+    def self.format_filtering_mode(mode)
+      case mode
+        when MODE_UNLIMITED
+          _('Unlimited')
+        when MODE_WHITELIST
+          _('Whitelist')
+        when MODE_BLACKLIST
+          _('Blacklist')
+        else
+          _('Unknown listing mode')
+      end
+    end
+
+    class ListCommand < HammerCLIForeman::ListCommand
+      output do
+        field :id, _('Id')
+        field :name, _('Name')
+        field :_interval, _('Interval')
+        field :_status, _('Status')
+        field :last_report_at, _('Last Report At'), Fields::Date
+      end
+
+      def extend_data(conf)
+        conf['_interval'] = VirtWhoConfig.format_interval(conf['interval'])
+        conf['_status'] = VirtWhoConfig.format_status(conf['status'])
+        conf
+      end
+
+      build_options
+    end
+
+    class InfoCommand < HammerCLIForeman::InfoCommand
+      output do
+        label _('General information') do
+          field :id, _('Id')
+          field :name, _('Name')
+          field :hypervisor_type, _('Hypervisor type')
+          field :hypervisor_server, _('Hypervisor server')
+          field :hypervisor_username, _('Hypervisor username')
+          field :hypervisor_password, _('Hypervisor password')
+          field :_status, _('Status')
+        end
+        label _('Schedule') do
+          field :_interval, _('Interval')
+          field :last_report_at, _('Last Report At'), Fields::Date
+        end
+        label _('Connection') do
+          field :satellite_url, _('Satellite server')
+          field :hypervisor_id, _('Hypervisor ID')
+          field :_filtering_mode, _('Filtering')
+          field :blacklist, _('Excluded hosts'), Fields::Field, :hide_blank => true
+          field :whitelist, _('Filtered hosts'), Fields::Field, :hide_blank => true
+          field :debug, _('Debug mode'), Fields::Boolean
+          field :proxy, _('HTTP proxy')
+          field :no_proxy, _('Ignore proxy')
+        end
+        HammerCLIForeman::References.taxonomies(self)
+      end
+
+      def extend_data(conf)
+        conf['_interval'] = VirtWhoConfig.format_interval(conf['interval'])
+        conf['_status'] = VirtWhoConfig.format_status(conf['status'])
+        conf['_filtering_mode'] = VirtWhoConfig.format_filtering_mode(conf['filtering_mode'])
+        # Show host lists only in relevant filtering modes
+        if conf['filtering_mode'] != MODE_WHITELIST
+          conf['whitelist'] = nil
+        else
+          conf['whitelist'] ||= " "
+        end
+        if conf['filtering_mode'] != MODE_BLACKLIST
+          conf['blacklist'] = nil
+        else
+          conf['blacklist'] ||= " "
+        end
+        conf
+      end
+
+      build_options
+    end
+
+    class FetchCommand < HammerCLIForeman::Command
+      command_name "fetch"
+      action :deploy_script
+
+      failure_message _('Could not fetch the Virt Who configuration')
+
+      option ['--output', '-o'], 'FILE', _('File where the script will be written.')
+
+      def execute
+        data = send_request
+        if option_output
+          path = File.expand_path(option_output)
+          if File.exists?(path)
+            # this could be a security issue, the file should be readable only by the user
+            output.print_error(
+              _('Could not save the script'),
+              _("File at %{path} already exists, please specify a different path.") % { :path => path }
+            )
+            return HammerCLI::EX_USAGE
+          else
+            File.write(path, data, { :perm => 0700, :mode => File::RDWR|File::CREAT|File::EXCL })
+            return HammerCLI::EX_OK
+          end
+        else
+          puts data
+          return HammerCLI::EX_OK
+        end
+      end
+
+      def transform_format(data)
+        data['virt_who_config_script']
+      end
+
+      build_options
+    end
+
+    class DeployCommand < HammerCLIForeman::Command
+      command_name "deploy"
+      desc _('Download and execute script for the specified virt-who configuration')
+      action :deploy_script
+
+      failure_message _('Could not deploy the Virt Who configuration')
+
+      def execute
+        script = send_request
+        if system_caller.system(script)
+          HammerCLI::EX_OK
+        else
+          HammerCLI::EX_SOFTWARE
+        end
+      end
+
+      def transform_format(data)
+        data['virt_who_config_script']
+      end
+
+      def system_caller
+        context[:system_caller] || HammerCLIForemanVirtWhoConfigure::SystemCaller.new
+      end
+
+      build_options
+    end
+
+    module UpdateCommons
+      FILTER_MAPPING = {
+        'none' => 0,
+        'whitelist' => 1,
+        'blacklist' => 2
+      }
+
+      def self.included(base)
+        base.option '--filtering-mode', 'MODE', _('Hypervisor filtering mode'),
+          :format => HammerCLI::Options::Normalizers::Enum.new(FILTER_MAPPING.keys)
+      end
+
+      def request_params
+        params = super
+        mode = params['foreman_virt_who_configure_config']['filtering_mode']
+        params['foreman_virt_who_configure_config']['filtering_mode'] = FILTER_MAPPING[mode] if mode
+        params
+      end
+    end
+
+    class CreateCommand < HammerCLIForeman::CreateCommand
+      include UpdateCommons
+
+      success_message _('Virt Who configuration [%{name}] created')
+      failure_message _('Could not create the Virt Who configuration')
+
+      build_options
+    end
+
+    class UpdateCommand < HammerCLIForeman::UpdateCommand
+      include UpdateCommons
+
+      success_message _('Virt Who configuration [%{name}] updated')
+      failure_message _('Could not create the Virt Who configuration')
+
+      build_options
+    end
+
+    class DeleteCommand < HammerCLIForeman::DeleteCommand
+      success_message _('Virt Who configuration deleted')
+      failure_message _('Could not delete the Virt Who configuration')
+
+      build_options
+    end
+
+    autoload_subcommands
+  end
+end

data/lib/hammer_cli_foreman_virt_who_configure/i18n.rb

@@ -0,0 +1,29 @@
+require 'hammer_cli/i18n'
+
+module HammerCLIForemanVirtWhoConfigure
+  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-virt-who-configure'
+      end
+    end
+
+    class SystemLocaleDomain < LocaleDomain
+      def locale_dir
+        '/usr/share/locale'
+      end
+    end
+  end
+end
+
+domains = [HammerCLIForemanVirtWhoConfigure::I18n::LocaleDomain.new, HammerCLIForemanVirtWhoConfigure::I18n::SystemLocaleDomain.new]
+domain = domains.find { |d| d.available? }
+HammerCLI::I18n.add_domain(domain) if domain

data/lib/hammer_cli_foreman_virt_who_configure/system_caller.rb

@@ -0,0 +1,20 @@
+module HammerCLIForemanVirtWhoConfigure
+  class SystemCaller
+    def initialize(tempfile = nil)
+      @tempfile = tempfile || Tempfile.new('virt_who')
+    end
+
+    def system(commad)
+      result = nil
+      begin
+        @tempfile.write(commad)
+        @tempfile.flush # to make sure the command is complete
+        result = Kernel.system("/usr/bin/bash #{@tempfile.path}")
+      ensure
+        @tempfile.close
+        @tempfile.unlink
+      end
+      result
+    end
+  end
+end

data/lib/hammer_cli_foreman_virt_who_configure/version.rb

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

data/locale/Makefile

@@ -0,0 +1,66 @@
+#
+# Makefile for PO merging and MO generation. More info in the README.
+#
+# make all-mo (default) - generate MO files
+# make check - check translations using translate-tool
+# make tx-update - download and merge translations from Transifex
+# make clean - clean everything
+#
+DOMAIN = hammer-cli-foreman-virt-who-configure
+VERSION = $(shell ruby -e 'require "rubygems";spec = Gem::Specification::load("../hammer_cli_foreman_virt_who_configure.gemspec");puts spec.version')
+POTFILE = $(DOMAIN).pot
+MOFILE = $(DOMAIN).mo
+POFILES = $(shell find . -name '$(DOMAIN).po')
+MOFILES = $(patsubst %.po,%.mo,$(POFILES))
+POXFILES = $(patsubst %.po,%.pox,$(POFILES))
+EDITFILES = $(patsubst %.po,%.edit.po,$(POFILES))
+TIMESTAMPFILES = $(patsubst %.po,%.po.time_stamp,$(POFILES))
+
+%.mo: %.po
+	mkdir -p $(shell dirname $@)/LC_MESSAGES
+	msgfmt -o $(shell dirname $@)/LC_MESSAGES/$(MOFILE) $<
+
+# Generate MO files from PO files
+all-mo: $(MOFILES)
+
+# Check for malformed strings
+%.pox: %.po
+	msgfmt -c $<
+	pofilter --nofuzzy -t variables -t blank -t urls -t emails -t long -t newlines \
+		-t endwhitespace -t endpunc -t puncspacing -t options -t printf -t validchars --gnome $< > $@
+	cat $@
+	! grep -q msgid $@
+
+check: $(POXFILES)
+
+# Unify duplicate translations
+uniq-po:
+	for f in $(shell find ./ -name "*.po") ; do \
+		msguniq $$f -o $$f ; \
+	done
+
+%.edit.po:
+	touch $@
+
+tx-pull: $(EDITFILES)
+	tx pull -f
+	for f in $(EDITFILES); do \
+		sed -i 's/^\("Project-Id-Version: \).*$$/\1$(DOMAIN) $(VERSION)\\n"/' $$f; \
+	done
+
+# Merge .edit.po into .po
+update-po:
+	for f in $(EDITFILES); do \
+		msgcat --use-first --no-location $$f $${f//.edit/} > $${f//.edit/}; \
+	done
+
+# Extract strings and update the .pot, prepare .edit.po files
+extract-strings:
+	bundle exec rake gettext:find
+
+tx-update: extract-strings tx-pull update-po $(MOFILES)
+	git commit -m "i18n - extracting new, pulling from tx" ../locale
+	-echo Changes commited!
+
+clean:
+	rm -f $(EDITFILES) $(TIMESTAMPFILES)

data/locale/README.md

@@ -0,0 +1,18 @@
+Updating the translations
+-------------------------
+
+  1. Check if there are any new languages with progress more than 50% on [transifex](https://www.transifex.com/projects/p/foreman/resource/hammer-cli-foreman-virt-who-configure/). If so, do the following for each of the new languages:
+
+  ```
+    mkdir locale/<lang>
+    cp locale/hammer-cli-foreman.pot locale/<lang>/hammer-cli-foreman.po
+  ```
+  2. Make sure you have `transifex-client` installed
+
+  3. Update the translations. From GIT repo root directory run:
+
+  ```
+    make -C locale tx-update
+  ```
+
+  It will download translations from transifex, generates `mo` files, updates strings in `pot` file and wraps all the changes in a new commit. Transifex automatically updates its strings when the commit is pushed to Github.

data/locale/ca/hammer-cli-foreman-virt-who-configure.edit.po

@@ -0,0 +1,170 @@
+# Catalan translations for hammer-cli-foreman-virt-who-configure package.
+# Copyright (C) 2017 THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the hammer-cli-foreman-virt-who-configure package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2017.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: hammer-cli-foreman-virt-who-configure 0.0.1\n"
+"Report-Msgid-Bugs-To: \n"
+"PO-Revision-Date: 2017-05-19 13:34+0200\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: Catalan\n"
+"Language: ca\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=n != 1;\n"
+"\n"
+
+#: ../lib/hammer_cli_foreman_virt_who_configure.rb:6
+msgid "Manage Virt Who configurations"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:12
+msgid "every hour"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:14
+msgid "every %s hours"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:21
+msgid "No Report Yet"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:23
+msgid "OK"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:25
+msgid "Error"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:27
+msgid "Unknown configuration status"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:34
+msgid "Unlimited"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:36
+msgid "Whitelist"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:38
+msgid "Blacklist"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:40
+msgid "Unknown listing mode"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:46 ../lib/hammer_cli_foreman_virt_who_configure/config.rb:65
+msgid "Id"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:47 ../lib/hammer_cli_foreman_virt_who_configure/config.rb:66
+msgid "Name"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:48 ../lib/hammer_cli_foreman_virt_who_configure/config.rb:74
+msgid "Interval"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:49 ../lib/hammer_cli_foreman_virt_who_configure/config.rb:71
+msgid "Status"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:50 ../lib/hammer_cli_foreman_virt_who_configure/config.rb:75
+msgid "Last Report At"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:64
+msgid "General information"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:67
+msgid "Hypervisor type"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:68
+msgid "Hypervisor server"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:69
+msgid "Hypervisor username"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:70
+msgid "Hypervisor password"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:73
+msgid "Schedule"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:77
+msgid "Connection"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:78
+msgid "Satellite server"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:79
+msgid "Hypervisor ID"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:80
+msgid "Filtering"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:81
+msgid "Filtered hosts"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:82
+msgid "Excluded hosts"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:83
+msgid "Debug mode"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:84
+msgid "HTTP proxy"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:85
+msgid "Ignore proxy"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:115
+msgid "File where the script will be written."
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:164
+msgid "Hypervisor filtering mode"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:179
+msgid "Virt Who configuration [%{name}] created"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:180 ../lib/hammer_cli_foreman_virt_who_configure/config.rb:189
+msgid "Could not create the Virt Who configuration"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:188
+msgid "Virt Who configuration [%{name}] updated"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:195
+msgid "Virt Who configuration deleted"
+msgstr ""
+
+#: ../lib/hammer_cli_foreman_virt_who_configure/config.rb:196
+msgid "Could not delete the Virt Who configuration"
+msgstr ""