foreman_omaha 0.0.1

data/lib/foreman_omaha/engine.rb

@@ -0,0 +1,78 @@
+module ForemanOmaha
+  class Engine < ::Rails::Engine
+    engine_name 'foreman_omaha'
+
+    config.autoload_paths += Dir["#{config.root}/app/controllers/concerns"]
+    config.autoload_paths += Dir["#{config.root}/app/helpers/concerns"]
+    config.autoload_paths += Dir["#{config.root}/app/models/concerns"]
+    config.autoload_paths += Dir["#{config.root}/app/services"]
+
+    # Add any db migrations
+    initializer 'foreman_omaha.load_app_instance_data' do |app|
+      ForemanOmaha::Engine.paths['db/migrate'].existent.each do |path|
+        app.config.paths['db/migrate'] << path
+      end
+    end
+
+    initializer 'foreman_omaha.register_plugin', :before => :finisher_hook do |_app|
+      Foreman::Plugin.register :foreman_omaha do
+        requires_foreman '>= 1.12'
+
+        apipie_documented_controllers ["#{ForemanOmaha::Engine.root}/app/controllers/api/v2/*.rb"]
+
+        register_custom_status HostStatus::OmahaStatus
+
+        # Add permissions
+        security_block :foreman_omaha do
+          permission :view_omaha_reports, :omaha_reports => [:index, :show, :auto_complete_search],
+                                          :'api/v2/omaha_reports' => [:index, :show, :last]
+          permission :destroy_omaha_reports, :omaha_reports => [:destroy],
+                                             :'api/v2/config_reports' => [:destroy]
+          permission :upload_omaha_reports, :omaha_reports => [:create],
+                                            :'api/v2/omaha_reports' => [:create]
+        end
+
+        role 'Omaha reports viewer',
+             [:view_omaha_reports]
+        role 'Omaha reports manager',
+             [:view_omaha_reports, :destroy_omaha_reports, :upload_omaha_reports]
+
+        # add menu entry
+        menu :top_menu, :omaha_reports,
+             :url_hash => { controller: :omaha_reports, action: :index },
+             :caption => N_('Omaha reports'),
+             :parent => :monitor_menu,
+             after: :reports
+      end
+
+      if respond_to?(:hosts_controller_action_scope)
+        hosts_controller_action_scope(:index) { |base_scope| base_scope.includes(:last_omaha_report_object) }
+      end
+    end
+
+    # Include concerns in this config.to_prepare block
+    config.to_prepare do
+      begin
+        ::FactImporter.register_fact_importer(:foreman_omaha, ForemanOmaha::FactImporter)
+        ::FactParser.register_fact_parser(:foreman_omaha, ForemanOmaha::FactParser)
+
+        Host::Managed.send(:include, ForemanOmaha::HostExtensions)
+        HostsHelper.send(:include, ForemanOmaha::HostsHelperExtensions)
+      rescue => e
+        Rails.logger.warn "ForemanOmaha: skipping engine hook (#{e})"
+      end
+    end
+
+    rake_tasks do
+      Rake::Task['db:seed'].enhance do
+        ForemanOmaha::Engine.load_seed
+      end
+    end
+
+    initializer 'foreman_omaha.register_gettext', after: :load_config_initializers do |_app|
+      locale_dir = File.join(File.expand_path('../../..', __FILE__), 'locale')
+      locale_domain = 'foreman_omaha'
+      Foreman::Gettext::Support.add_text_domain locale_domain, locale_dir
+    end
+  end
+end

data/lib/foreman_omaha/version.rb

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

data/lib/foreman_omaha.rb

@@ -0,0 +1,4 @@
+require 'foreman_omaha/engine'
+
+module ForemanOmaha
+end

data/lib/tasks/foreman_omaha_tasks.rake

@@ -0,0 +1,45 @@
+# Tasks
+namespace :foreman_omaha do
+  namespace :example do
+    desc 'Example Task'
+    task task: :environment do
+      # Task goes here
+    end
+  end
+end
+
+# Tests
+namespace :test do
+  desc 'Test ForemanOmaha'
+  Rake::TestTask.new(:foreman_omaha) 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_omaha do
+  task :rubocop do
+    begin
+      require 'rubocop/rake_task'
+      RuboCop::RakeTask.new(:rubocop_foreman_omaha) do |task|
+        task.patterns = ["#{ForemanOmaha::Engine.root}/app/**/*.rb",
+                         "#{ForemanOmaha::Engine.root}/lib/**/*.rb",
+                         "#{ForemanOmaha::Engine.root}/test/**/*.rb"]
+      end
+    rescue
+      puts 'Rubocop not loaded.'
+    end
+
+    Rake::Task['rubocop_foreman_omaha'].invoke
+  end
+end
+
+Rake::Task[:test].enhance ['test:foreman_omaha']
+
+load 'tasks/jenkins.rake'
+if Rake::Task.task_defined?(:'jenkins:unit')
+  Rake::Task['jenkins:unit'].enhance ['test:foreman_omaha', 'foreman_omaha: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_omaha
+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_omaha.po

@@ -0,0 +1,19 @@
+# foreman_omaha
+#
+# This file is distributed under the same license as foreman_omaha.
+#
+#, 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_omaha.pot

@@ -0,0 +1,19 @@
+# foreman_omaha
+#
+# This file is distributed under the same license as foreman_omaha.
+#
+#, 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_omaha.gemspec
+_('This plug-in adds support for the Omaha procotol to The Foreman. It allows you to better manage and update your CoreOS servers.')

data/test/factories/feature.rb

@@ -0,0 +1,7 @@
+FactoryGirl.modify do
+  factory :feature do
+    trait :omaha do
+      name 'Omaha'
+    end
+  end
+end

data/test/factories/foreman_omaha_factories.rb

@@ -0,0 +1,9 @@
+FactoryGirl.define do
+  factory :omaha_report, :class => 'ForemanOmaha::OmahaReport' do
+    host
+    sequence(:reported_at) { |n| n.minutes.ago }
+    status 1
+    omaha_version '1068.9.0'
+    type 'ForemanOmaha::OmahaReport'
+  end
+end

data/test/factories/smart_proxy.rb

@@ -0,0 +1,7 @@
+FactoryGirl.modify do
+  factory :smart_proxy do
+    trait :omaha do
+      features { |sp| [sp.association(:feature, :omaha)] }
+    end
+  end
+end

data/test/functional/api/v2/omaha_reports_controller_test.rb

@@ -0,0 +1,122 @@
+require 'test_helper'
+
+class Api::V2::OmahaReportsControllerTest < ActionController::TestCase
+  test 'create valid' do
+    post :create, { :omaha_report => create_report }, set_session_user
+    assert_response :success
+  end
+
+  test 'create invalid' do
+    post :create, { :omaha_report => ['not a hash', 'throw an error'] }, set_session_user
+    assert_response :unprocessable_entity
+  end
+
+  test 'should get index' do
+    FactoryGirl.create(:omaha_report)
+    get :index, {}
+    assert_response :success
+    assert_not_nil assigns(:omaha_reports)
+    reports = ActiveSupport::JSON.decode(@response.body)
+    assert !reports['results'].empty?
+  end
+
+  test 'should show individual record' do
+    report = FactoryGirl.create(:omaha_report)
+    get :show, :id => report.to_param
+    assert_response :success
+    show_response = ActiveSupport::JSON.decode(@response.body)
+    assert !show_response.empty?
+  end
+
+  test 'should destroy report' do
+    report = FactoryGirl.create(:omaha_report)
+    assert_difference('ForemanOmaha::OmahaReport.count', -1) do
+      delete :destroy, :id => report.to_param
+    end
+    assert_response :success
+    refute Report.find_by_id(report.id)
+  end
+
+  test 'should get reports for given host only' do
+    report = FactoryGirl.create(:omaha_report)
+    get :index, :host_id => report.host.to_param
+    assert_response :success
+    assert_not_nil assigns(:omaha_reports)
+    reports = ActiveSupport::JSON.decode(@response.body)
+    assert !reports['results'].empty?
+    assert_equal 1, reports['results'].count
+  end
+
+  test 'should return empty result for host with no reports' do
+    host = FactoryGirl.create(:host)
+    get :index, :host_id => host.to_param
+    assert_response :success
+    assert_not_nil assigns(:omaha_reports)
+    reports = ActiveSupport::JSON.decode(@response.body)
+    assert reports['results'].empty?
+    assert_equal 0, reports['results'].count
+  end
+
+  test 'should get last report' do
+    reports = FactoryGirl.create_list(:omaha_report, 5)
+    get :last, set_session_user
+    assert_response :success
+    assert_not_nil assigns(:omaha_report)
+    report = ActiveSupport::JSON.decode(@response.body)
+    assert !report.empty?
+    assert_equal reports.last, ForemanOmaha::OmahaReport.find(report['id'])
+  end
+
+  test 'should get last report for given host only' do
+    main_report = FactoryGirl.create(:omaha_report)
+    FactoryGirl.create_list(:omaha_report, 5)
+    get :last, { :host_id => main_report.host.to_param }, set_session_user
+    assert_response :success
+    assert_not_nil assigns(:omaha_report)
+    report = ActiveSupport::JSON.decode(@response.body)
+    assert !report.empty?
+    assert_equal main_report, ForemanOmaha::OmahaReport.find(report['id'])
+  end
+
+  test 'should give error if no last report for given host' do
+    host = FactoryGirl.create(:host)
+    get :last, :host_id => host.to_param
+    assert_response :not_found
+  end
+
+  test 'cannot view the last report without hosts view permission' do
+    setup_user('view', 'omaha_reports')
+    report = FactoryGirl.create(:report)
+    get :last, { :host_id => report.host.id }, set_session_user.merge(:user => User.current.id)
+    assert_response :not_found
+  end
+
+  describe 'unpriveliged user' do
+    def setup
+      User.current = users(:one)
+    end
+
+    test 'hosts with a registered smart proxy on should create a report successfully' do
+      Setting[:restrict_registered_smart_proxies] = true
+      Setting[:require_ssl_smart_proxies] = false
+
+      proxy = FactoryGirl.create(:smart_proxy, :omaha)
+      host = URI.parse(proxy.url).host
+      Resolv.any_instance.stubs(:getnames).returns([host])
+      post :create, :omaha_report => create_report
+      assert_equal proxy, @controller.detected_proxy
+      assert_response :created
+    end
+  end
+
+  private
+
+  def create_report
+    {
+      'host' => 'test.example.com',
+      'status' => 'downloading',
+      'omaha_version' => '1068.9.0',
+      'reported_at' => Time.now.utc.to_s
+    }
+  end
+end

data/test/functional/omaha_reports_controller_test.rb

@@ -0,0 +1,54 @@
+require 'test_plugin_helper'
+
+class OmahaReportsControllerTest < ActionController::TestCase
+  test '#index' do
+    FactoryGirl.create(:omaha_report)
+    get :index, {}, set_session_user
+    assert_response :success
+    assert_not_nil assigns('omaha_reports')
+    assert_template 'index'
+  end
+
+  test '#show' do
+    report = FactoryGirl.create(:omaha_report)
+    get :show, { :id => report.id }, set_session_user
+    assert_template 'show'
+  end
+
+  test '404 on #show when id is blank' do
+    get :show, { :id => ' ' }, set_session_user
+    assert_response :missing
+    assert_template 'common/404'
+  end
+
+  test '#show last' do
+    FactoryGirl.create(:omaha_report)
+    get :show, { :id => 'last' }, set_session_user
+    assert_template 'show'
+  end
+
+  test '404 on #show last when no reports available' do
+    get :show, { :id => 'last', :host_id => FactoryGirl.create(:host) }, set_session_user
+    assert_response :missing
+    assert_template 'common/404'
+  end
+
+  test '#show last report for host' do
+    report = FactoryGirl.create(:omaha_report)
+    get :show, { :id => 'last', :host_id => report.host.to_param }, set_session_user
+    assert_template 'show'
+  end
+
+  test 'render 404 when #show invalid report for a host is requested' do
+    get :show, { :id => 'last', :host_id => 'blalala.domain.com' }, set_session_user
+    assert_response :missing
+    assert_template 'common/404'
+  end
+
+  test '#destroy' do
+    report = FactoryGirl.create(:omaha_report)
+    delete :destroy, { :id => report }, set_session_user
+    assert_redirected_to omaha_reports_url
+    assert !ConfigReport.exists?(report.id)
+  end
+end

data/test/test_plugin_helper.rb

@@ -0,0 +1,22 @@
+# This calls the main test_helper in Foreman-core
+require 'test_helper'
+require 'database_cleaner'
+
+# Add plugin to FactoryGirl's paths
+FactoryGirl.definition_file_paths << File.join(File.dirname(__FILE__), 'factories')
+FactoryGirl.reload
+
+# Foreman's setup doesn't handle cleaning up for Minitest::Spec
+DatabaseCleaner.strategy = :transaction
+
+module Minitest
+  class Spec
+    before :each do
+      DatabaseCleaner.start
+    end
+
+    after :each do
+      DatabaseCleaner.clean
+    end
+  end
+end

data/test/unit/omaha_report_test.rb

@@ -0,0 +1,86 @@
+require 'test_plugin_helper'
+
+class OmahaReportTest < ActiveSupport::TestCase
+  setup do
+    User.current = User.find_by_login 'admin'
+    @report = FactoryGirl.create(:omaha_report)
+  end
+
+  context 'status' do
+    test 'should be complete' do
+      @report.status = 'complete'
+      assert_equal 'complete', @report.status
+      assert_equal 'Complete', @report.to_label
+    end
+
+    test 'should be downloading' do
+      @report.status = 'downloading'
+      assert_equal 'downloading', @report.status
+      assert_equal 'Downloading', @report.to_label
+    end
+
+    test 'should be downloaded' do
+      @report.status = 'downloaded'
+      assert_equal 'downloaded', @report.status
+      assert_equal 'Downloaded', @report.to_label
+    end
+
+    test 'should be installed' do
+      @report.status = 'installed'
+      assert_equal 'installed', @report.status
+      assert_equal 'Installed', @report.to_label
+    end
+
+    test 'should be installed' do
+      @report.status = 'instance_hold'
+      assert_equal 'instance_hold', @report.status
+      assert_equal 'Instance Hold', @report.to_label
+    end
+
+    test 'should be error' do
+      @report.status = 'error'
+      assert_equal 'error', @report.status
+      assert_equal 'Error', @report.to_label
+    end
+  end
+
+  context 'operatingsystem' do
+    test 'should get operatingsystem' do
+      os = FactoryGirl.create(:coreos, :major => '1068', :minor => '9.0')
+      assert_equal os, @report.operatingsystem
+    end
+
+    test 'should parse major, minor' do
+      assert_equal '1068', @report.osmajor
+      assert_equal '9.0', @report.osminor
+    end
+  end
+
+  context '#import' do
+    test 'should import a report' do
+      host = FactoryGirl.create(:host)
+      report = {
+        'host' => host.name,
+        'status' => 'downloading',
+        'omaha_version' => '1068.9.0',
+        'reported_at' => Time.now.utc.to_s
+      }
+      assert_difference('ForemanOmaha::OmahaReport.count') do
+        ForemanOmaha::OmahaReport.import(report)
+      end
+    end
+
+    test 'should not import a report with invalid value' do
+      host = FactoryGirl.create(:host)
+      report = {
+        'host' => host.name,
+        'status' => 'invalid',
+        'omaha_version' => '1068.9.0',
+        'reported_at' => Time.now.utc.to_s
+      }
+      assert_raise ArgumentError do
+       ForemanOmaha::OmahaReport.import(report)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: foreman_omaha
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Timo Goebel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-14 00:00:00.000000000 Z
+dependencies:
+- !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: This plug-in adds support for the Omaha procotol to The Foreman. It allows
+  you to better manage and update your CoreOS servers.
+email:
+- mail@timogoebel.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/images/Omaha.png
+- app/controllers/api/v2/omaha_reports_controller.rb
+- app/controllers/omaha_reports_controller.rb
+- app/helpers/concerns/foreman_omaha/hosts_helper_extensions.rb
+- app/helpers/omaha_reports_helper.rb
+- app/models/concerns/foreman_omaha/host_extensions.rb
+- app/models/foreman_omaha/fact_name.rb
+- app/models/foreman_omaha/omaha_report.rb
+- app/models/host_status/omaha_status.rb
+- app/services/foreman_omaha/fact_importer.rb
+- app/services/foreman_omaha/fact_parser.rb
+- app/services/foreman_omaha/omaha_report_importer.rb
+- app/views/api/v2/omaha_reports/base.json.rabl
+- app/views/api/v2/omaha_reports/create.json.rabl
+- app/views/api/v2/omaha_reports/index.json.rabl
+- app/views/api/v2/omaha_reports/main.json.rabl
+- app/views/api/v2/omaha_reports/show.json.rabl
+- app/views/api/v2/omaha_reports/update.json.rabl
+- app/views/omaha_reports/_details.html.erb
+- app/views/omaha_reports/_list.html.erb
+- app/views/omaha_reports/index.html.erb
+- app/views/omaha_reports/show.html.erb
+- app/views/omaha_reports/welcome.html.erb
+- config/routes.rb
+- db/migrate/20160812083100_add_omaha_fields_to_reports.foreman_omaha.rb
+- db/seeds.d/60_omaha_proxy_feature.rb
+- lib/foreman_omaha.rb
+- lib/foreman_omaha/engine.rb
+- lib/foreman_omaha/version.rb
+- lib/tasks/foreman_omaha_tasks.rake
+- locale/Makefile
+- locale/en/foreman_omaha.po
+- locale/foreman_omaha.pot
+- locale/gemspec.rb
+- test/factories/feature.rb
+- test/factories/foreman_omaha_factories.rb
+- test/factories/smart_proxy.rb
+- test/functional/api/v2/omaha_reports_controller_test.rb
+- test/functional/omaha_reports_controller_test.rb
+- test/test_plugin_helper.rb
+- test/unit/omaha_report_test.rb
+homepage: http://github.com/theforeman/foreman_omaha
+licenses:
+- GPL-3
+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: This plug-in adds support for the Omaha procotol to The Foreman.
+test_files:
+- test/factories/feature.rb
+- test/factories/foreman_omaha_factories.rb
+- test/factories/smart_proxy.rb
+- test/functional/api/v2/omaha_reports_controller_test.rb
+- test/functional/omaha_reports_controller_test.rb
+- test/test_plugin_helper.rb
+- test/unit/omaha_report_test.rb
+has_rdoc: