foreman_wds 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 13cda19881b8df7132970cb27a73bea4bc834abbbff33e2831ed98625cffa48a
+  data.tar.gz: 74f4f4f15f7ca7c17a5453b01ac60883279add2cf37b015b4fae54b38d7d3511
+SHA512:
+  metadata.gz: 9deefe383a62458a87f288fc9b84825b236ccc10b05f25a983ed0a0e39467d66684ea2e093778d82e17c8756c6840f492069125be4b2208249e18ac9c4087792
+  data.tar.gz: 69e76584c0939c1a509d13774e936452bb5f38e79098491d81d6eb52e5136ca06813aeacbb70db357bb258cec2252baedb9d15247ce7f6715c0604104b26a576

data/.eslintrc.json

@@ -0,0 +1,20 @@
+{
+    "rules": {
+        "indent": [
+            "error",
+            2
+        ],
+        "linebreak-style": [
+            "error",
+            "unix"
+        ],
+        "quotes": [
+            "error",
+            "single"
+        ],
+        "semi": [
+            "error",
+            "always"
+        ]
+    }
+}

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/log/*.log
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+/test/dummy
+/locale/*.mo
+/locale/*/*.edit.po
+/locale/*/*.po.time_stamp
+/locale/*/*.pox
+
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,66 @@
+---
+AllCops:
+  TargetRubyVersion: 2.3
+  TargetRailsVersion: 5.1
+  Exclude:
+    - '*.spec'
+    - 'Rakefile'
+
+Rails:
+  Enabled: true
+
+# Don't enforce documentation
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 40
+
+Metrics/LineLength:
+  Max: 190
+
+Rails/SkipsModelValidations:
+  Enabled: false
+
+Lint/BooleanSymbol:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/FormatStringToken:
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Performance/FixedSize:
+  Exclude:
+    - 'test/**/*'
+
+Metrics/BlockLength:
+  Max: 35
+  Exclude:
+    - 'test/**/*'
+
+Metrics/ClassLength:
+  Max: 200
+  Exclude:
+    - 'test/**/*'
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'test/**/*'
+    - 'app/controllers/concerns/foreman/**/*'

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.6
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in foreman_wds.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Alexander Olofsson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+# Foreman Windows Deployment Service
+
+This plugin adds extended support to Foreman for querying and orchestrating WDS servers.
+
+*Nota Bene*; to support locally booting your installation, you need to have a regular DHCP/TFTP setup in place, that can serve PXE files for the PXE loader chosen for the WDS host.  
+If you don't want the lifecycle management features of Foreman, you can ignore this requirement and only PXE boot the WDS host when it is to be built.
+
+### Not yet implemented:
+
+- Install image orchestration
+- Unattend file deployment
+  - Recommended to build a http client (curl/wget/etc) into your boot image and download `https://foreman.example.com/unattend/wds_unattend` to drive the setup.
+
+## Compatibility
+
+| Foreman Version | Plugin Version |
+| --------------- | -------------- |
+| >= 1.17         | any            |
+
+## Installation
+
+See the [Plugins install instructions, advanced installation from gems](https://theforeman.org/plugins/#2.3AdvancedInstallationfromGems) for information on how to install this plugins.
+
+This plugin has JavaScript assets that require precompilation if installed into a packaged Foreman install.
+You will need to install the `foreman-assets` package and run `foreman-rake plugin:assets:precompile[foreman_wds]` after installing it from gem.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ananace/foreman_wds
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/app/assets/javascripts/foreman_wds/wds_servers.js

@@ -0,0 +1,19 @@
+function wds_load(element){
+  var url = $(element).attr('data-url');
+  tfm.tools.showSpinner();
+  $.ajax({
+    type:'get',
+    url: url,
+    complete: function(){
+      reloadOnAjaxComplete(element);
+    },
+    success: function(request) {
+      element.html(request);
+    }
+  });
+}
+
+$(function() {
+  wds_load($('#images'));
+  wds_load($('#clients'));
+})();

data/app/assets/javascripts/host_edit_extensions.js

@@ -0,0 +1,50 @@
+function wds_server_selected(element){
+  var url = $(element).attr('data-url');
+  var type = $(element).attr('data-type');
+  var attrs = {};
+  attrs[type] = attribute_hash(['architecture_id', 'operatingsystem_id', 'wds_server_id']);
+  tfm.tools.showSpinner();
+  $.ajax({
+    data: attrs,
+    type:'post',
+    url: url,
+    complete: function(){
+      reloadOnAjaxComplete(element);
+    },
+    success: function(request) {
+      $('#wds_image_select').html(request);
+    }
+  });
+}
+
+var old_os_selected = os_selected;
+os_selected = function(element){
+  old_os_selected(element);
+
+  if ($('#os_select select').val() === '') {
+    $('#wds_server_select select').val('');
+    $('#wds_image_select select').val('');
+    $('#wds_server_select select').prop('disabled', true);
+    $('#wds_image_select select').prop('disabled', true);
+  } else {
+    $('#wds_server_select select').prop('disabled', false);
+  }
+};
+
+
+function wds_provision_method_selected() {
+  build_provision_method_selected();
+  $('#wds_provisioning').show();
+
+  if ($('#wds_image_select select').val() === '')
+    $('#wds_image_select select').attr('disabled', true);
+}
+$(document).on('change', '#host_provision_method_wds', wds_provision_method_selected);
+
+$(function() {
+  var caps = $('#capabilities').val() || $('#bare_metal_capabilities').val();
+  update_capabilities(caps);
+  $('#provisioning_method input[checked]').click();
+
+  $('#wds_provisioning').detach().insertBefore('#media_select');
+});

data/app/controllers/concerns/foreman/controller/parameters/wds_server.rb

@@ -0,0 +1,19 @@
+module Foreman::Controller::Parameters::WdsServer
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def wds_server_params_filter
+      Foreman::ParameterFilter.new(::WdsServer).tap do |filter|
+        filter.permit :name,
+                      :description,
+                      :url,
+                      :user,
+                      :password
+      end
+    end
+  end
+
+  def wds_server_params
+    self.class.wds_server_params_filter.filter_params(params, parameter_filter_context, :wds_server)
+  end
+end

data/app/controllers/concerns/foreman_wds/hosts_controller_extensions.rb

@@ -0,0 +1,18 @@
+module ForemanWds
+  module HostsControllerExtensions
+    def wds_server_selected
+      host = @host || item_object
+      wds_facet = host.wds_facet || host.build_wds_facet
+      wds_facet.wds_server_id ||= (params[:wds_facet] || params[:host])[:wds_server_id]
+
+      render partial: 'wds_servers/image_select', locals: { item: wds_facet }
+    end
+
+    def host_params(top_level_hash = controller_name.singularize)
+      # Don't create a WDS facet unless provisioning with it
+      params[:host].delete :wds_facet_attributes if params[:host] && params[:host][:provision_method] != 'wds'
+
+      super(top_level_hash)
+    end
+  end
+end

data/app/controllers/concerns/foreman_wds/unattended_controller_extensions.rb

@@ -0,0 +1,21 @@
+module ForemanWds
+  module UnattendedControllerExtensions
+    def render_template(kind)
+      return super unless kind == 'wds_localboot'
+
+      iface = @host.provision_interface
+
+      # Deploy regular DHCP and local boot TFTP
+      @host.provision_method = 'build'
+      @host.build = false
+      iface.send :rebuild_tftp
+      iface.send :rebuild_dhcp
+
+      render inline: "Success. Local boot template was deployed successfully.\n"
+    rescue StandardError => e
+      message = format('Failed to set local boot template: %{error}', error: e)
+      logger.error message
+      render text: message, status: :error, content_type: 'text/plain'
+    end
+  end
+end

data/app/controllers/wds_servers_controller.rb

@@ -0,0 +1,85 @@
+class WdsServersController < ::ApplicationController
+  include Foreman::Controller::AutoCompleteSearch
+  include Foreman::Controller::Parameters::WdsServer
+
+  before_action :find_server, except: %i[index new create]
+
+  def index
+    @wds_servers = resource_base_search_and_page
+  end
+
+  def show; end
+
+  def new
+    @wds_server = WdsServer.new
+  end
+
+  def edit; end
+
+  def create
+    @wds_server = WdsServer.new(wds_server_params)
+    if @wds_server.save
+      process_success success_redirect: wds_server_path(@wds_server)
+    else
+      process_error
+    end
+  end
+
+  def update
+    if @wds_server.update(wds_server_params)
+      process_success
+    else
+      process_error
+    end
+  end
+
+  def destroy
+    if @wds_server.destroy
+      process_success
+    else
+      process_error
+    end
+  end
+
+  def test_connection
+    # wds_id is posted from AJAX function. wds_id is nil if new
+    if params[:wds_id].present?
+      @wds_server = WdsServer.authorized(:edit_wds_server).find(params[:wds_id])
+      @wds_server.attributes = wds_server_params.reject { |k, v| k == :password && v.blank? }
+    else
+      @wds_server = WdsServer.new(wds_server_params)
+    end
+
+    @wds_server.test_connection
+    render partial: 'form', locals: { wds_server: @wds_server }
+  end
+
+  def refresh_cache
+    @wds_server.refresh_cache
+
+    render partial: 'form', locals: { wds_server: @wds_server }
+  end
+
+  def wds_clients
+    @clients = @wds_server.clients
+
+    render partial: 'wds_servers/clients/list'
+  end
+
+  def wds_images
+    @images = @wds_server.boot_images + @wds_server.install_images
+
+    render partial: 'wds_servers/images/list'
+  end
+
+  def delete_wds_client
+    host = Host::Managed.find(params[:client])
+    client = @wds_server.client(host)
+  end
+
+  private
+
+  def find_server
+    @wds_server = WdsServer.find(params[:id])
+  end
+end

data/app/lib/foreman_wds/wds_boot_image.rb

@@ -0,0 +1,11 @@
+class ForemanWds::WdsBootImage < ForemanWds::WdsImage
+  def initialize(json = {})
+    super json
+  end
+
+  def reload
+    return false if wds_server.nil?
+    @json = wds_server.boot_image(name)
+    load!
+  end
+end

data/app/lib/foreman_wds/wds_image.rb

@@ -0,0 +1,89 @@
+class ForemanWds::WdsImage
+  WDS_IMAGE_ARCHES = [nil, /^i.86|x86$/i, /^ia64$/i, /^x86_64|x64$/i, /^arm$/i].freeze
+  WDS_ARCH_NAMES = [nil, 'x86', 'ia64', 'x64', 'arm'].freeze
+  WDS_PROCESSOR_NAMES = [nil, 'x86', 'ia64', 'amd64', 'arm'].freeze
+
+  attr_accessor :id, :name, :description, :enabled, :file_name,
+                :architecture, :product_family, :product_name, :version,
+                :wds_server
+  attr_reader :creation_time, :last_modification_time
+
+  def inspect
+    Kernel.format('#<%<class>s:%<id>x %<variables>s>',
+                  class: self.class,
+                  id: (object_id << 1),
+                  variables: instance_variables
+                    .reject { |v| %i[@json @wds_server].include?(v) }
+                    .map { |v| "#{v}=#{instance_variable_get(v).inspect}" }
+                    .join(' '))
+  end
+
+  def type_name
+    self.class
+        .name
+        .demodulize
+        .underscore
+        .split('_')
+        .map.with_index { |v, i| i.zero? ? v.upcase : v.capitalize }
+        .join ' '
+  end
+
+  def architecture_name
+    return architecture unless architecture.is_a?(Integer) && WDS_ARCH_NAMES[architecture]
+    WDS_ARCH_NAMES[architecture]
+  end
+
+  def creation_time=(time)
+    @creation_time = parse_time time
+  end
+
+  def last_modification_time=(time)
+    @last_modification_time = parse_time time
+  end
+
+  def matches_architecture?(architecture)
+    return nil unless WDS_IMAGE_ARCHES[self.architecture]
+    architecture = architecture.name if architecture.is_a? Architecture
+    !(WDS_IMAGE_ARCHES[self.architecture] =~ architecture).nil?
+  end
+
+  def marshal_dump
+    @json
+  end
+
+  def marshal_load(json)
+    @json = json
+    load!
+  end
+
+  protected
+
+  def initialize(json = {})
+    @json = json if json.is_a? Hash
+    @wds_server = self.json.delete(:wds_server)
+    load!
+  end
+
+  def json
+    @json || {}
+  end
+
+  def parse_time(time)
+    return time unless time.is_a?(String) && time =~ /\/Date\(.*\)\//
+
+    time = Time.at(time.scan(/\((.*)\)/).flatten.first.to_i / 1000)
+    return time unless wds_server
+
+    time.utc
+    sec_diff = wds_server.timezone - Time.at(0).utc_offset
+    time += sec_diff
+    time.localtime
+  end
+
+  def load!
+    json.each do |k, v|
+      sym = "#{k.to_s.underscore}=".to_sym
+      send sym, v if respond_to? sym
+    end
+  end
+end