foreman_virt_who_configure 0.0.1

data/lib/foreman_virt_who_configure/version.rb

@@ -0,0 +1,3 @@
+module ForemanVirtWhoConfigure
+  VERSION = '0.0.1'.freeze
+end

data/lib/foreman_virt_who_configure.rb

@@ -0,0 +1,4 @@
+require 'foreman_virt_who_configure/engine'
+
+module ForemanVirtWhoConfigure
+end

data/lib/tasks/foreman_virt_who_configure_tasks.rake

@@ -0,0 +1,47 @@
+require 'rake/testtask'
+
+# Tasks
+namespace :foreman_virt_who_configure do
+  namespace :example do
+    desc 'Example Task'
+    task task: :environment do
+      # Task goes here
+    end
+  end
+end
+
+# Tests
+namespace :test do
+  desc 'Test ForemanVirtWhoConfigure'
+  Rake::TestTask.new(:foreman_virt_who_configure) do |t|
+    test_dir = File.join(File.dirname(__FILE__), '../..', 'test')
+    t.libs << ['test', test_dir]
+    t.pattern = "#{test_dir}/**/*_test.rb"
+    t.verbose = true
+    t.warning = false
+  end
+end
+
+namespace :foreman_virt_who_configure do
+  task :rubocop do
+    begin
+      require 'rubocop/rake_task'
+      RuboCop::RakeTask.new(:rubocop_foreman_virt_who_configure) do |task|
+        task.patterns = ["#{ForemanVirtWhoConfigure::Engine.root}/app/**/*.rb",
+                         "#{ForemanVirtWhoConfigure::Engine.root}/lib/**/*.rb",
+                         "#{ForemanVirtWhoConfigure::Engine.root}/test/**/*.rb"]
+      end
+    rescue
+      puts 'Rubocop not loaded.'
+    end
+
+    Rake::Task['rubocop_foreman_virt_who_configure'].invoke
+  end
+end
+
+Rake::Task[:test].enhance ['test:foreman_virt_who_configure']
+
+load 'tasks/jenkins.rake'
+if Rake::Task.task_defined?(:'jenkins:unit')
+  Rake::Task['jenkins:unit'].enhance ['test:foreman_virt_who_configure', 'foreman_virt_who_configure:rubocop']
+end

data/locale/Makefile

@@ -0,0 +1,60 @@
+#
+# 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 = foreman_virt_who_configure
+VERSION = $(shell ruby -e 'require "rubygems";spec = Gem::Specification::load(Dir.glob("../*.gemspec")[0]);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))
+
+%.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 $@
+
+%.edit.po:
+	touch $@
+
+check: $(POXFILES)
+
+# Unify duplicate translations
+uniq-po:
+	for f in $(shell find ./ -name "*.po") ; do \
+		msguniq $$f -o $$f ; \
+	done
+
+tx-pull: $(EDITFILES)
+	tx pull -f
+	for f in $(EDITFILES) ; do \
+		sed -i 's/^\("Project-Id-Version: \).*$$/\1$(DOMAIN) $(VERSION)\\n"/' $$f; \
+	done
+
+tx-update: tx-pull
+	@echo
+	@echo Run rake plugin:gettext[$(DOMAIN)] from the Foreman installation, then make -C locale mo-files to finish
+	@echo
+
+mo-files: $(MOFILES)
+	git add $(POFILES) $(POTFILE) ../locale/*/LC_MESSAGES
+	git commit -m "i18n - pulling from tx"
+	@echo
+	@echo Changes commited!
+	@echo

data/locale/en/foreman_virt_who_configure.po

@@ -0,0 +1,19 @@
+# foreman_virt_who_configure
+#
+# This file is distributed under the same license as foreman_virt_who_configure.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: version 0.0.1\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2014-08-20 08:46+0100\n"
+"PO-Revision-Date: 2014-08-20 08:54+0100\n"
+"Last-Translator: Foreman Team <foreman-dev@googlegroups.com>\n"
+"Language-Team: Foreman Team <foreman-dev@googlegroups.com>\n"
+"Language: \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"
+

data/locale/foreman_virt_who_configure.pot

@@ -0,0 +1,19 @@
+# foreman_virt_who_configure
+#
+# This file is distributed under the same license as foreman_virt_who_configure.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: version 0.0.1\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2014-08-20 08:46+0100\n"
+"PO-Revision-Date: 2014-08-20 08:46+0100\n"
+"Last-Translator: Foreman Team <foreman-dev@googlegroups.com>\n"
+"Language-Team: Foreman Team <foreman-dev@googlegroups.com>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=INTEGER; plural=EXPRESSION;\n"
+

data/locale/gemspec.rb

@@ -0,0 +1,2 @@
+# Matches foreman_virt_who_configure.gemspec
+_('A plugin to make virt-who configuration easy')

data/test/factories/foreman_virt_who_configure_factories.rb

@@ -0,0 +1,13 @@
+FactoryGirl.define do
+  factory :virt_who_config, :class => ::ForemanVirtWhoConfigure::Config do
+    organization
+    interval 120
+    hypervisor_id 'hostname'
+    hypervisor_type 'esx'
+    hypervisor_server 'vmware.example.com'
+    hypervisor_username 'root'
+    hypervisor_password 'changeme'
+    satellite_url 'foreman.example.com'
+    listing_mode ForemanVirtWhoConfigure::Config::UNLIMITED
+  end
+end

data/test/test_plugin_helper.rb

@@ -0,0 +1,6 @@
+# This calls the main test_helper in Foreman-core
+require 'test_helper'
+
+# Add plugin to FactoryGirl's paths
+FactoryGirl.definition_file_paths << File.join(File.dirname(__FILE__), 'factories')
+FactoryGirl.reload

data/test/unit/config_test.rb

@@ -0,0 +1,65 @@
+require 'test_plugin_helper'
+
+module ForemanVirtWhoConfigure
+  class ConfigTest < ActiveSupport::TestCase
+    let(:config) { FactoryGirl.build(:virt_who_config) }
+
+    test 'config can be saved' do
+      config.save
+      assert_empty config.errors
+      assert config.persisted?
+    end
+
+    describe 'config is created' do
+      let(:existing_config) { config.save; config }
+
+      test 'config creates service user upon creation' do
+        assert existing_config.service_user
+        assert_equal "virt_who_reporter_#{config.id}", existing_config.service_user.username
+      end
+
+      test 'config creates hidden user' do
+        assert existing_config.service_user.user
+        assert_equal existing_config.service_user.username, existing_config.service_user.user.login
+        assert_kind_of ForemanVirtWhoConfigure::AuthSourceHiddenWithAuthentication, existing_config.service_user.user.auth_source
+      end
+
+      test 'config deletes service user and user upon removal' do
+        service_user = existing_config.service_user
+        user = service_user.user
+        assert existing_config.destroy
+        assert_raises ActiveRecord::RecordNotFound do
+          service_user.reload
+        end
+        assert_raises ActiveRecord::RecordNotFound do
+          user.reload
+        end
+      end
+    end
+
+    describe 'listing mode' do
+      test 'whitelisting mode requires blacklist to be set' do
+        config.listing_mode = ForemanVirtWhoConfigure::Config::WHITELIST
+        refute config.valid?
+        assert_includes config.errors.keys, :whitelist
+
+        config.whitelist = 'a.host'
+        assert config.valid?
+      end
+
+      test 'blacklisting mode requires blacklist to be set' do
+        config.listing_mode = ForemanVirtWhoConfigure::Config::BLACKLIST
+        refute config.valid?
+        assert_includes config.errors.keys, :blacklist
+
+        config.blacklist = 'a.host'
+        assert config.valid?
+      end
+
+      test 'whitelisting accepts regular expressions' do
+        config.whitelist = '^some.*'
+        assert config.valid?
+      end
+    end
+  end
+end

data/test/unit/output_generator_test.rb

@@ -0,0 +1,89 @@
+require 'test_plugin_helper'
+module ForemanVirtWhoConfigure
+  class OutputGeneratorTest < ActiveSupport::TestCase
+    let(:config) { FactoryGirl.create(:virt_who_config) }
+    let(:generator) { OutputGenerator.new(config) }
+    let(:output) { generator.virt_who_output }
+
+    describe 'filtering' do
+      test 'it should not filter anything for unlimited configs' do
+        assert_equal ForemanVirtWhoConfigure::Config::UNLIMITED, config.listing_mode.to_i
+        assert_not_includes output, 'filter_hosts'
+        assert_not_includes output, 'exclude_hosts'
+      end
+
+      test 'whitelisting should set filter_hosts directive' do
+        config.listing_mode = ForemanVirtWhoConfigure::Config::WHITELIST
+        config.whitelist = 'a.host'
+        assert_includes output, 'filter_hosts=a.host'
+      end
+
+      test 'whitelisting should set exclude_hosts directive' do
+        config.listing_mode = ForemanVirtWhoConfigure::Config::BLACKLIST
+        config.blacklist = 'a.host'
+        assert_includes output, 'exclude_hosts=a.host'
+      end
+
+      test 'filtering output is stripped' do
+        config.listing_mode = ForemanVirtWhoConfigure::Config::WHITELIST
+        config.whitelist = ' name '
+        assert_includes output, 'filter_hosts=name'
+      end
+
+      test 'filtering output is stripped for multiple values as well' do
+        config.listing_mode = ForemanVirtWhoConfigure::Config::WHITELIST
+        config.whitelist = ' host1,host2  '
+        assert_includes output, 'filter_hosts=host1,host2'
+      end
+
+      test 'filtering output new line characters are removed' do
+        config.listing_mode = ForemanVirtWhoConfigure::Config::WHITELIST
+        config.whitelist = "aaaa,bbb,\r\nccc,\r\n\r\nddd\r\n\r\neee"
+        assert_includes output, 'filter_hosts=aaaa,bbb,ccc,dddeee'
+
+        config.whitelist = "aaaa,bbb,\rccc,\n\r\nddd\neee"
+        assert_includes output, 'filter_hosts=aaaa,bbb,ccc,dddeee'
+      end
+    end
+
+    describe 'proxy attributes' do
+      test 'it does not set any proxy attributes by default' do
+        assert_nil config.proxy
+        assert_nil config.no_proxy
+        assert_not_includes output, 'http_proxy'
+        assert_not_includes output, 'no_proxy'
+      end
+
+      test 'it configures proxy when set' do
+        config.proxy = 'http://proxy.com'
+        assert_includes output, 'http_proxy=http://proxy.com'
+      end
+
+      test 'it configures no_proxy when set' do
+        config.no_proxy = '*'
+        assert_includes output, 'no_proxy=*'
+      end
+
+      test 'proxy_strings prints both proxy and no proxy if present' do
+        config.proxy = 'a'
+        config.no_proxy = 'b'
+        assert_includes generator.proxy_strings, "\nhttp_proxy=a"
+        assert_includes generator.proxy_strings, "\nno_proxy=b"
+      end
+
+      test 'proxy_strings ignores empty string values' do
+        config.proxy = ''
+        config.no_proxy = ''
+        assert_not_includes generator.proxy_strings, 'http_proxy'
+        assert_not_includes generator.proxy_strings, 'no_proxy'
+      end
+
+      test 'proxy_strings removes any new line chars' do
+        config.proxy = "\na\nb\nc\n"
+        config.no_proxy = "\nx\ny\nz"
+        assert_includes generator.proxy_strings, "\nhttp_proxy=abc"
+        assert_includes generator.proxy_strings, "\nno_proxy=xyz"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: foreman_virt_who_configure
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Foreman virt-who-configure team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: katello
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A plugin to make virt-who configuration easy
+email:
+- foreman-dev@googlegroups.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/foreman_virt_who_configure/config_edit.js
+- app/assets/stylesheets/foreman_virt_who_configure/config.css.scss
+- app/controllers/foreman_virt_who_configure/application_controller.rb
+- app/controllers/foreman_virt_who_configure/concerns/config_parameters.rb
+- app/controllers/foreman_virt_who_configure/configs_controller.rb
+- app/helpers/foreman_virt_who_configure/compatibility_helper.rb
+- app/helpers/foreman_virt_who_configure/configs_helper.rb
+- app/models/foreman_virt_who_configure/auth_source_hidden_with_authentication.rb
+- app/models/foreman_virt_who_configure/config.rb
+- app/models/foreman_virt_who_configure/output_generator.rb
+- app/models/foreman_virt_who_configure/service_user.rb
+- app/services/sso/basic_with_hidden.rb
+- app/views/dashboard/_foreman_virt_who_configure_widget.html.erb
+- app/views/foreman_virt_who_configure/configs/_form.html.erb
+- app/views/foreman_virt_who_configure/configs/edit.html.erb
+- app/views/foreman_virt_who_configure/configs/index.html.erb
+- app/views/foreman_virt_who_configure/configs/new.html.erb
+- app/views/foreman_virt_who_configure/configs/show.html.erb
+- app/views/foreman_virt_who_configure/configs/steps/_connection_form.erb
+- app/views/foreman_virt_who_configure/configs/steps/_general_information_form.erb
+- app/views/foreman_virt_who_configure/configs/steps/_schedule_form.erb
+- app/views/foreman_virt_who_configure/configs/welcome.html.erb
+- config/routes.rb
+- db/migrate/20170102152649_create_service_users.rb
+- db/migrate/20170102152650_create_configs.rb
+- db/migrate/20170102152751_add_lab_attrs_to_config.rb
+- db/migrate/20170102152851_add_satellite_url_to_config.rb
+- db/migrate/20170215152851_change_default_interval.rb
+- db/migrate/20170309161551_add_proxy_and_no_proxy_to_config.rb
+- lib/foreman_virt_who_configure.rb
+- lib/foreman_virt_who_configure/engine.rb
+- lib/foreman_virt_who_configure/version.rb
+- lib/tasks/foreman_virt_who_configure_tasks.rake
+- locale/Makefile
+- locale/en/foreman_virt_who_configure.po
+- locale/foreman_virt_who_configure.pot
+- locale/gemspec.rb
+- test/factories/foreman_virt_who_configure_factories.rb
+- test/test_plugin_helper.rb
+- test/unit/config_test.rb
+- test/unit/output_generator_test.rb
+homepage: https://github.com/theforeman/foreman_virt_who_configure
+licenses:
+- GPLv3
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A plugin to make virt-who configuration easy
+test_files:
+- test/unit/config_test.rb
+- test/unit/output_generator_test.rb
+- test/test_plugin_helper.rb
+- test/factories/foreman_virt_who_configure_factories.rb