foreman_git_templates 1.0.0

data/lib/tasks/foreman_git_templates_tasks.rake

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

data/test/controllers/hosts_controller_test.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+class HostsControllerTest < ActionController::TestCase
+  let(:host) { FactoryBot.create(:host, :managed, :with_template_url) }
+
+  describe '#templates' do
+    it 'returns only templates that are defined in the archive' do
+      Dir.mktmpdir do |dir|
+        expected_kinds = ['PXEGrub', 'PXELinux', 'iPXE', 'PXEGrub2', 'provision']
+
+        stub_repository host.params['template_url'], "#{dir}/repo.tar.gz" do |tar|
+          expected_kinds.each do |kind|
+            tar.add_file_simple("templates/#{kind}/template.erb", 644, host.name.length) { |io| io.write(host.name) }
+          end
+        end
+
+        get :templates, params: { id: host.name }, session: set_session_user
+
+        actual_kinds = @controller.instance_variable_get('@templates').map(&:name)
+        assert_same_elements expected_kinds, actual_kinds
+      end
+    end
+  end
+end

data/test/controllers/unattended_controller_test.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+class UnattendedControllerTest < ActionController::TestCase
+  let(:os) { FactoryBot.create(:operatingsystem, :with_archs, :with_ptables, type: 'Redhat') }
+  let(:host) do
+    FactoryBot.create(:host, :managed, :with_template_url, operatingsystem: os, ptable: os.ptables.first)
+  end
+
+  test 'should render template from repository' do
+    assert_not_nil host.params['template_url']
+
+    Dir.mktmpdir do |dir|
+      kind = 'provision'
+
+      stub_repository host.params['template_url'], "#{dir}/repo.tar.gz" do |tar|
+        tar.add_file_simple("templates/#{kind}/template.erb", 644, host.name.length) { |io| io.write(host.name) }
+      end
+
+      get :host_template, params: { kind: kind, hostname: host.name }, session: set_session_user
+      assert_response :success
+      assert_equal host.name, response.body.strip
+    end
+  end
+
+  test 'should render snippet from repository' do
+    assert_not_nil host.params['template_url']
+
+    Dir.mktmpdir do |dir|
+      kind = 'PXELinux'
+      snippet_name = 'MySnippet'
+      snippet_content = 'foo: <%= @foo %>'
+      template_content = "<%= snippet('#{snippet_name}', variables: { foo: 'bar' }) %>"
+
+      stub_repository host.params['template_url'], "#{dir}/repo.tar.gz" do |tar|
+        tar.add_file_simple("templates/#{kind}/template.erb", 644, template_content.length) { |io| io.write(template_content) }
+        tar.add_file_simple("templates/snippets/#{snippet_name.downcase}.erb", 644, snippet_content.length) { |io| io.write(snippet_content) }
+      end
+
+      get :host_template, params: { kind: kind, hostname: host.name }, session: set_session_user
+      assert_response :success
+      assert_equal 'foo: bar', response.body.strip
+    end
+  end
+
+  test 'snippet should render nested snippet' do
+    assert_not_nil host.params['template_url']
+
+    Dir.mktmpdir do |dir|
+      nested_snippet_name = 'MyNestedSnippet'
+      nested_snippet_content = '<%= @foo %><%= @bar %>'
+
+      snippet_name = 'MySnippet'
+      snippet_content = "<%= @foo %> <%= snippet('#{nested_snippet_name}', variables: { bar: 'bar' }) %>"
+
+      kind = 'PXELinux'
+      template_content = "<%= snippet('#{snippet_name}', variables: { foo: 'foo' }) %>"
+
+      stub_repository host.params['template_url'], "#{dir}/repo.tar.gz" do |tar|
+        tar.add_file_simple("templates/#{kind}/template.erb", 644, template_content.length) { |io| io.write(template_content) }
+        tar.add_file_simple("templates/snippets/#{snippet_name.downcase}.erb", 644, snippet_content.length) { |io| io.write(snippet_content) }
+        tar.add_file_simple("templates/snippets/#{nested_snippet_name.downcase}.erb", 644, nested_snippet_content.length) { |io| io.write(nested_snippet_content) }
+      end
+
+      get :host_template, params: { kind: kind, hostname: host.name }, session: set_session_user
+      assert_response :success
+      assert_equal 'foo bar', response.body.strip
+    end
+  end
+end

data/test/factories/foreman_git_templates_factories.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+FactoryBot.modify do
+  factory :host do
+    trait :with_template_url do
+      after(:create) do |host, _evaluator|
+        FactoryBot.create(:host_parameter, host: host, name: 'template_url', value: 'http://www.api.com/repository.tar.gz')
+      end
+    end
+  end
+end

data/test/models/concerns/foreman_git_templates/hostext/operating_system_test.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+module Hostext
+  class OperatingSystemTest < ActiveSupport::TestCase
+    let(:host) { FactoryBot.create(:host, :managed, :with_template_url) }
+
+    test 'available_template_kinds finds only templates that are defined in the repository' do
+      Dir.mktmpdir do |dir|
+        expected_kinds = ['PXEGrub', 'PXELinux', 'iPXE', 'PXEGrub2', 'provision']
+
+        stub_repository host.params['template_url'], "#{dir}/repo.tar.gz" do |tar|
+          expected_kinds.each do |kind|
+            tar.add_file_simple("templates/#{kind}/template.erb", 644, host.name.length) { |io| io.write(host.name) }
+          end
+        end
+
+        actual = host.available_template_kinds('build').map(&:name)
+        assert_same_elements expected_kinds, actual
+      end
+    end
+  end
+end

data/test/models/concerns/foreman_git_templates/orchestration/tftp_test.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+class TFTPOrchestrationTest < ActiveSupport::TestCase
+  describe '#generate_pxe_template' do
+    let(:kind) { 'PXELinux' }
+    let(:template_content) { 'main template content' }
+    let(:default_local_boot_template_content) { 'default local boot template content' }
+
+    context 'host is in build mode' do
+      let(:host) { FactoryBot.create(:host, :managed, :with_template_url, build: true) }
+
+      it 'renders main template' do
+        Dir.mktmpdir do |dir|
+          stub_repository host.params['template_url'], "#{dir}/repo.tar.gz" do |tar|
+            tar.add_file_simple("templates/#{kind}/template.erb", 644, template_content.length) { |io| io.write(template_content) }
+            tar.add_file_simple("templates/#{kind}/default_local_boot.erb", 644, default_local_boot_template_content.length) { |io| io.write(default_local_boot_template_content) }
+          end
+
+          assert_equal template_content, host.generate_pxe_template('PXELinux')
+        end
+      end
+    end
+
+    context 'host is not in build mode' do
+      let(:host) { FactoryBot.create(:host, :managed, :with_template_url, build: false) }
+
+      it 'renders default local boot template' do
+        Dir.mktmpdir do |dir|
+          stub_repository host.params['template_url'], "#{dir}/repo.tar.gz" do |tar|
+            tar.add_file_simple("templates/#{kind}/template.erb", 644, template_content.length) { |io| io.write(template_content) }
+            tar.add_file_simple("templates/#{kind}/default_local_boot.erb", 644, default_local_boot_template_content.length) { |io| io.write(default_local_boot_template_content) }
+          end
+
+          assert_equal default_local_boot_template_content, host.generate_pxe_template('PXELinux')
+        end
+      end
+
+      it 'does not generate a pxe template if the corresponding template file is missing in the repo' do
+        Dir.mktmpdir do |dir|
+          stub_repository host.params['template_url'], "#{dir}/repo.tar.gz" do |tar|
+            tar.add_file_simple("templates/#{kind}/template.erb", 644, template_content.length) { |io| io.write(template_content) }
+            tar.add_file_simple("templates/#{kind}/default_local_boot.erb", 644, default_local_boot_template_content.length) { |io| io.write(default_local_boot_template_content) }
+          end
+
+          assert_nil host.generate_pxe_template('PXEGrub2')
+        end
+      end
+
+      it 'raises an exception when generating a pxe template if the corresponding default local boot template file is missing in the repo' do
+        Dir.mktmpdir do |dir|
+          stub_repository host.params['template_url'], "#{dir}/repo.tar.gz" do |tar|
+            tar.add_file_simple("templates/#{kind}/template.erb", 644, template_content.length) { |io| io.write(template_content) }
+          end
+
+          assert_raises ForemanGitTemplates::RepositoryReader::MissingFileError do
+            host.generate_pxe_template('PXELinux')
+          end
+        end
+      end
+    end
+  end
+
+  describe '#setTFTP' do
+    let(:host) { FactoryBot.create(:host, :with_tftp_orchestration, :with_template_url) }
+
+    let(:kind) { 'PXELinux' }
+    let(:template_content) { 'main template content' }
+    let(:default_local_boot_template_content) { 'default local boot template content' }
+
+    context 'host is in build mode' do
+      setup do
+        host.update(build: true)
+      end
+
+      it 'sends the main template from the tar archive to the smart proxy' do
+        assert_not_nil host.params['template_url']
+
+        Dir.mktmpdir do |dir|
+          stub_repository host.params['template_url'], "#{dir}/repo.tar.gz" do |tar|
+            tar.add_file_simple("templates/#{kind}/template.erb", 644, template_content.length) { |io| io.write(template_content) }
+            tar.add_file_simple("templates/#{kind}/default_local_boot.erb", 644, default_local_boot_template_content.length) { |io| io.write(default_local_boot_template_content) }
+          end
+
+          ProxyAPI::TFTP.any_instance.expects(:set).with(kind, host.interfaces.first.mac, pxeconfig: template_content).once
+
+          host.provision_interface.send(:setTFTP, kind)
+        end
+      end
+    end
+
+    context 'host is not in build mode' do
+      setup do
+        host.update(build: false)
+      end
+
+      it 'sends the local boot template from the tar archive to the smart proxy' do
+        assert_not_nil host.params['template_url']
+
+        Dir.mktmpdir do |dir|
+          stub_repository host.params['template_url'], "#{dir}/repo.tar.gz" do |tar|
+            tar.add_file_simple("templates/#{kind}/template.erb", 644, template_content.length) { |io| io.write(template_content) }
+            tar.add_file_simple("templates/#{kind}/default_local_boot.erb", 644, default_local_boot_template_content.length) { |io| io.write(default_local_boot_template_content) }
+          end
+
+          ProxyAPI::TFTP.any_instance.expects(:set).with(kind, host.interfaces.first.mac, pxeconfig: default_local_boot_template_content).once
+
+          host.provision_interface.send(:setTFTP, kind)
+        end
+      end
+    end
+  end
+end

data/test/models/foreman_git_templates/host_test.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+module ForemanGitTemplates
+  class HostTest < ActiveSupport::TestCase
+    describe '#repository_path' do
+      context 'with template_url parameter' do
+        let(:repo_path) { '/tmp/repo.tar.gz' }
+        let(:host) { FactoryBot.create(:host, :managed, :with_template_url) }
+
+        it 'returns path to the repository' do
+          ForemanGitTemplates::RepositoryFetcher.expects(:call).once.with(host.params['template_url']).returns(repo_path)
+          assert_equal repo_path, host.repository_path
+        end
+      end
+
+      context 'without template_url parameter' do
+        let(:host) { FactoryBot.create(:host, :managed) }
+
+        it 'returns nil' do
+          ForemanGitTemplates::RepositoryFetcher.expects(:call).never
+          assert_nil host.repository_path
+        end
+      end
+    end
+  end
+end

data/test/models/foreman_git_templates/snippet_repository_template_test.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+module ForemanGitTemplates
+  class SnippetRepositoryTest < ActiveSupport::TestCase
+    let(:snippet_repository_template) { ForemanGitTemplates::SnippetRepositoryTemplate.new(name: 'CoreOS provision Ignition') }
+
+    test '#path downcases the filename and replaces spaces with underscores' do
+      assert_equal 'templates/snippets/coreos_provision_ignition.erb', snippet_repository_template.path
+    end
+  end
+end

data/test/test_plugin_helper.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# This calls the main test_helper in Foreman-core
+require 'test_helper'
+
+# Add plugin to FactoryBot's paths
+FactoryBot.definition_file_paths << File.join(File.dirname(__FILE__), 'factories')
+FactoryBot.reload
+
+def stub_repository(template_url, repository_path)
+  build_repository(repository_path) do |tar|
+    yield tar if block_given?
+  end
+  stub_request(:get, template_url).to_return(status: 200, body: File.new(repository_path))
+end
+
+def build_repository(repository_path)
+  ForemanGitTemplates::Tar.tar(repository_path) do |tar|
+    yield tar if block_given?
+  end
+end

data/test/unit/foreman/renderer/source/repository_test.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+class RepositorySourceTest < ActiveSupport::TestCase
+  let(:repo_path) { '/tmp/repository.tar.gz' }
+  let(:template) { ForemanGitTemplates::MainRepositoryTemplate.new(name: 'MyTemplate') }
+  let(:subject) { ForemanGitTemplates::Renderer::Source::Repository.new(template, repo_path) }
+
+  describe '#content' do
+    let(:content) { 'content' }
+
+    test 'should return content' do
+      ForemanGitTemplates::RepositoryReader.expects(:call).once.with(repo_path, template.path).returns(content)
+      assert_equal content, subject.content
+    end
+  end
+
+  describe '#find_snippet' do
+    let(:snippet_name) { 'MySnippet' }
+    let(:snippet) { subject.find_snippet(snippet_name) }
+
+    test 'should return snippet template' do
+      assert snippet.is_a?(ForemanGitTemplates::SnippetRepositoryTemplate)
+      assert snippet.respond_to?(:render)
+      assert_equal snippet_name, snippet.name
+    end
+  end
+end

data/test/unit/repository_fetcher_test.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+class RepositoryFetcherTest < ActiveSupport::TestCase
+  test 'should save a file' do
+    Dir.mktmpdir do |dir|
+      url = 'http://api.com/repository'
+      repository_path = "#{dir}/repo.tar.gz"
+
+      build_repository repository_path
+      stub_request(:get, url).to_return(status: 200, body: repository_path)
+      file_path = ForemanGitTemplates::RepositoryFetcher.call(url)
+
+      assert File.exist?(file_path)
+    end
+  end
+
+  test 'should raise RepositoryFetcherError when file does not exist' do
+    url = 'http://api.com/repository'
+    stub_request(:get, url).to_return(status: 404)
+
+    msg = 'Response code: 404'
+    assert_raises_with_message(ForemanGitTemplates::RepositoryFetcher::RepositoryFetcherError, msg) do
+      ForemanGitTemplates::RepositoryFetcher.call(url)
+    end
+  end
+
+  test 'should raise RepositoryFetcherError when url is incorrect' do
+    url = 'incorrect_url'
+
+    msg = 'URL scheme needs to be http or https'
+    assert_raises_with_message(ForemanGitTemplates::RepositoryFetcher::RepositoryFetcherError, msg) do
+      ForemanGitTemplates::RepositoryFetcher.call(url)
+    end
+  end
+end

data/test/unit/repository_reader_test.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+class RepositoryReaderTest < ActiveSupport::TestCase
+  test 'should return file content' do
+    Dir.mktmpdir do |dir|
+      repository_path = "#{dir}/repo.tar.gz"
+      file_name = 'files/README.md'
+      file_content = 'Hello'
+
+      build_repository repository_path do |tar|
+        tar.add_file_simple(file_name, 644, file_content.length) { |io| io.write(file_content) }
+      end
+
+      result = ForemanGitTemplates::RepositoryReader.call(repository_path, file_name)
+      assert_equal file_content, result
+    end
+  end
+
+  context 'with custom root directory' do
+    test 'should return file content' do
+      Dir.mktmpdir do |dir|
+        repository_path = "#{dir}/repo.tar.gz"
+        root_dir = 'root'
+        file_name = 'files/README.md'
+        file_content = 'Hello'
+
+        build_repository repository_path do |tar|
+          tar.add_file_simple("#{root_dir}/#{file_name}", 644, file_content.length) { |io| io.write(file_content) }
+        end
+
+        result = ForemanGitTemplates::RepositoryReader.call(repository_path, file_name)
+        assert_equal file_content, result
+      end
+    end
+  end
+
+  test 'should raise RepositoryUnreadableError when repository does not exist' do
+    Dir.mktmpdir do |dir|
+      repository_path = "#{dir}/repo.tar.gz"
+
+      assert_raises(ForemanGitTemplates::RepositoryReader::RepositoryUnreadableError) do
+        ForemanGitTemplates::RepositoryReader.call(repository_path, 'file')
+      end
+    end
+  end
+
+  test 'should raise MissingFileError when file does not exist' do
+    Dir.mktmpdir do |dir|
+      repository_path = "#{dir}/repo.tar.gz"
+      filename = 'file.erb'
+      build_repository repository_path
+
+      assert_raises(ForemanGitTemplates::RepositoryReader::MissingFileError) do
+        ForemanGitTemplates::RepositoryReader.call(repository_path, filename)
+      end
+    end
+  end
+
+  test 'should raise EmptyFileError when file is empty' do
+    Dir.mktmpdir do |dir|
+      repository_path = "#{dir}/repo.tar.gz"
+      file_name = 'files/README.md'
+      file_content = ''
+
+      build_repository repository_path do |tar|
+        tar.add_file_simple(file_name, 644, file_content.length) { |io| io.write(file_content) }
+      end
+
+      assert_raises(ForemanGitTemplates::RepositoryReader::EmptyFileError) do
+        ForemanGitTemplates::RepositoryReader.call(repository_path, file_name)
+      end
+    end
+  end
+end