foreman_git_templates 1.0.0

data/README.md

@@ -0,0 +1,66 @@
+# ForemanGitTemplates
+
+[<img src="https://opensourcelogos.aws.dmtech.cloud/dmTECH_opensource_logo.svg" height="21" width="130">](https://www.dmtech.de/)
+
+This is a plugin for Foreman that adds support for using templates from Git repositories.
+
+## Compatibility
+
+| Foreman Version | Plugin Version |
+| --------------- | -------------- |
+| >= 1.20         | ~> 1.0         |
+
+## Installation
+
+See [Plugins install instructions](https://theforeman.org/plugins/) for how to install Foreman plugins.
+
+## Usage
+
+Repositories are fetched as tarball files and must have a specific file structure. The root directory should be named `templates`. Inside the root directory there should be directories for template kinds and for snippets. Only one template for template kind is supported however multiple snippets are supported. Template file should be named `template.erb`. You can also define a default local boot template in the file named `default_local_boot.erb`. Snippet filenames will be downcased and spaces will be replaced by underscores.
+
+```
+.
+└── templates
+    ├── PXELinux
+    │   ├── template.erb
+    │   └── default_local_boot.erb
+    ├── provision
+    │   └── template.erb
+    └── snippets
+        ├── snippet_1.erb
+        └── snippet_2.erb
+```
+
+In order to use templates from the repository you have to set `template_url` host parameter (specify the HTTP authentication credentials if necessary). To set host parameters navigate to the edit host page and open "Parameters" tab.
+
+![Host Parameters](./doc/images/host_parameters.png)
+
+From now the template content for this host will be fetched from the repository. To test this open `/unattended/provision?spoof=<host_ip>`. The template stored in the `provision` directory should be rendered.
+
+### Troubleshooting
+
+- `There was an error rendering the provision template: Cannot fetch repository from <template_url>. Response code: 404`
+  - check if the URL is correct
+- `There was an error rendering the provision template: Cannot read <template> from repository`
+  - check if there is requested template in the repository
+
+## Contributing
+
+Fork and send a Pull Request. Thanks!
+
+## Copyright
+
+Copyright (c) 2018 dmTECH GmbH, [dmtech.de](https://www.dmtech.de/)
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/Rakefile

@@ -0,0 +1,47 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ForemanGitTemplates'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test
+
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue => _
+  puts 'Rubocop not loaded.'
+end
+
+task :default do
+  Rake::Task['rubocop'].execute
+end

data/app/lib/foreman_git_templates/renderer.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ForemanGitTemplates
+  module Renderer
+    def get_source(klass: Foreman::Renderer::Source::Database, template:, **args)
+      repository_path = repository_path(args[:host])
+      if repository_path
+        ForemanGitTemplates::Renderer::Source::Repository.new(template, repository_path)
+      else
+        super
+      end
+    end
+
+    private
+
+    def repository_path(host)
+      host.try(:repository_path)
+    end
+  end
+end

data/app/lib/foreman_git_templates/renderer/source/repository.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ForemanGitTemplates
+  module Renderer
+    module Source
+      class Repository < Foreman::Renderer::Source::Base
+        def initialize(template, repository_path)
+          @template = template
+          @repository_path = repository_path
+        end
+
+        def content
+          @content ||= ForemanGitTemplates::RepositoryReader.call(repository_path, template_path)
+        end
+
+        def find_snippet(name)
+          SnippetRepositoryTemplate.new(name: name)
+        end
+
+        private
+
+        attr_reader :repository_path
+        delegate :path, to: :template, prefix: true
+      end
+    end
+  end
+end

data/app/lib/foreman_git_templates/tar.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'zlib'
+require 'rubygems/package'
+
+module ForemanGitTemplates
+  module Tar
+    def tar(filepath)
+      Zlib::GzipWriter.open(filepath) do |gz|
+        Gem::Package::TarWriter.new(gz) do |tar|
+          yield tar if block_given?
+        end
+      end
+    end
+
+    def untar(filepath)
+      Zlib::GzipReader.open(filepath) do |gz|
+        Gem::Package::TarReader.new(gz) do |tar|
+          yield tar if block_given?
+        end
+      end
+    end
+
+    module_function :tar, :untar
+  end
+end

data/app/models/concerns/foreman_git_templates/host_extensions.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ForemanGitTemplates
+  module HostExtensions
+    def repository_path
+      return unless host_params['template_url']
+
+      @repository_path ||= RepositoryFetcher.call(host_params['template_url'])
+    end
+  end
+end

data/app/models/concerns/foreman_git_templates/hostext/operating_system.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module ForemanGitTemplates
+  module Hostext
+    module OperatingSystem
+      extend ActiveSupport::Concern
+
+      module Overrides
+        def provisioning_template(opts = {})
+          return super unless repository_path
+
+          kind = opts[:kind] || 'provision'
+          available_template_kinds.find { |template| template.name == kind }
+        end
+
+        def available_template_kinds(provisioning = nil)
+          return super unless repository_path
+
+          @available_template_kinds ||= template_kinds(provisioning).map do |kind|
+            MainRepositoryTemplate.new(name: kind.name).tap do |template|
+              RepositoryReader.call(repository_path, template.path)
+            end
+          rescue RepositoryReader::FileUnreadableError # file is missing or empty
+            next
+          end.compact
+        end
+      end
+
+      included do
+        prepend Overrides
+      end
+    end
+  end
+end

data/app/models/concerns/foreman_git_templates/orchestration/tftp.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module ForemanGitTemplates
+  module Orchestration
+    module TFTP
+      extend ActiveSupport::Concern
+
+      module Overrides
+        delegate :render_template, to: :host
+
+        def generate_pxe_template(kind)
+          return super unless host.repository_path
+
+          template_klass = build? ? MainRepositoryTemplate : DefaultLocalBootRepositoryTemplate
+          template = template_klass.new(name: kind)
+          render_template(template: template)
+        rescue ForemanGitTemplates::RepositoryReader::MissingFileError => e
+          # re-raise the exception if we have a main template defined for this type
+          raise e if host.available_template_kinds.map(&:name).include?(kind)
+          nil
+        end
+      end
+
+      included do
+        prepend Overrides
+      end
+    end
+  end
+end

data/app/models/foreman_git_templates/base_repository_template.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ForemanGitTemplates
+  class BaseRepositoryTemplate < ::ProvisioningTemplate
+    self.table_name = 'templates'
+
+    after_initialize do
+      self.template_kind = TemplateKind.find_by(name: name)
+    end
+
+    def path
+      raise NotImplementedError
+    end
+  end
+end

data/app/models/foreman_git_templates/default_local_boot_repository_template.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ForemanGitTemplates
+  class DefaultLocalBootRepositoryTemplate < BaseRepositoryTemplate
+    self.table_name = 'templates'
+
+    def path
+      "templates/#{name}/default_local_boot.erb"
+    end
+  end
+end

data/app/models/foreman_git_templates/main_repository_template.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ForemanGitTemplates
+  class MainRepositoryTemplate < BaseRepositoryTemplate
+    self.table_name = 'templates'
+
+    def path
+      "templates/#{name}/template.erb"
+    end
+  end
+end

data/app/models/foreman_git_templates/snippet_repository_template.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ForemanGitTemplates
+  class SnippetRepositoryTemplate < BaseRepositoryTemplate
+    self.table_name = 'templates'
+
+    def path
+      "templates/snippets/#{name.downcase.tr(' ', '_')}.erb"
+    end
+  end
+end

data/app/services/foreman_git_templates/repository_fetcher.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'down'
+
+module ForemanGitTemplates
+  class RepositoryFetcher
+    def initialize(repository_url)
+      @repository_url = repository_url
+    end
+
+    def call
+      Down.download(repository_url).path
+    rescue Down::ResponseError => e
+      raise RepositoryFetcherError, "Cannot fetch repository from #{repository_url}. Response code: #{e.response.code}"
+    rescue Down::Error => e
+      raise RepositoryFetcherError, "Cannot fetch repository from #{repository_url}, #{e.message}"
+    end
+
+    def self.call(repository_url)
+      new(repository_url).call
+    end
+
+    private
+
+    class RepositoryFetcherError < StandardError; end
+
+    attr_reader :repository_url
+  end
+end

data/app/services/foreman_git_templates/repository_reader.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module ForemanGitTemplates
+  class RepositoryReader
+    def initialize(repository_path, file)
+      @repository_path = repository_path
+      @file = file
+    end
+
+    def call
+      raise MissingFileError, "The #{file} file is missing" if content.nil?
+      content
+    end
+
+    def self.call(repository_path, file)
+      new(repository_path, file).call
+    end
+
+    private
+
+    class RepositoryReaderError < StandardError; end
+    class RepositoryUnreadableError < RepositoryReaderError; end
+    class FileUnreadableError < RepositoryReaderError; end
+    class MissingFileError < FileUnreadableError; end
+    class EmptyFileError < FileUnreadableError; end
+
+    attr_reader :repository_path, :file
+
+    def content
+      @content ||= Tar.untar(repository_path) do |tar|
+        return tar.each do |entry|
+          next unless entry.file? && entry.full_name.end_with?(file)
+          break entry.read.tap do |entry_content|
+            raise EmptyFileError, "The #{file} file is empty" if entry_content.nil?
+          end
+        end
+      end
+    rescue Errno::ENOENT
+      raise RepositoryUnreadableError, "Cannot read repository from #{repository_path}"
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+Rails.application.routes.draw do
+end

data/lib/foreman_git_templates.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'foreman_git_templates/engine'
+
+module ForemanGitTemplates
+end

data/lib/foreman_git_templates/engine.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ForemanGitTemplates
+  class Engine < ::Rails::Engine
+    engine_name 'foreman_git_templates'
+
+    config.autoload_paths += Dir["#{config.root}/app/lib"]
+    config.autoload_paths += Dir["#{config.root}/app/services"]
+
+    initializer 'foreman_git_templates.register_plugin', before: :finisher_hook do |_app|
+      Foreman::Plugin.register :foreman_git_templates do
+        requires_foreman '>= 1.20'
+      end
+    end
+
+    # Include concerns in this config.to_prepare block
+    config.to_prepare do
+      Foreman::Renderer.singleton_class.prepend(ForemanGitTemplates::Renderer)
+      Host::Managed.include(ForemanGitTemplates::Hostext::OperatingSystem)
+      Host::Managed.include(ForemanGitTemplates::HostExtensions)
+      Nic::Managed.include(ForemanGitTemplates::Orchestration::TFTP)
+    rescue StandardError => e
+      Rails.logger.warn "ForemanGitTemplates: skipping engine hook (#{e})"
+    end
+  end
+end

data/lib/foreman_git_templates/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ForemanGitTemplates
+  VERSION = '1.0.0'
+end