pi_customizer 0.1.1.pre.alpha → 0.1.2.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f698a621a439c36c15d29b5f7b6541038db705b5
-  data.tar.gz: 051fe8cac727d42da227c6573225912c8e2cb718
+  metadata.gz: 82107bf6c11e36cecbd418fa1f81ca000de390ae
+  data.tar.gz: f7b844fbbbc25d3f55734016b7da402140046327
 SHA512:
-  metadata.gz: 89b188d2ca8396f7c1d4f755d4559d5f0b69e4d95db6c0c4d8ae1d1fb573dd812d17aba3dd7977f3a668e3169be260852f4cc6a68e67d90fd5d7189481dbe5b6
-  data.tar.gz: 172527c3fbf8c3bb2f9b52fd20d9b8e4de7943d01386ea86d3bbb0dc1699a01a454949c4d3d8eba5cd8004d8c6886c4d4fb78b49768211b5be62a0fa0949e171
+  metadata.gz: 2566295f0a85408526a356f5e481e9a14f915e7969464300abfa6411a0230e1e3b2b0039bb65756916b355b7862cdf064ccab7ce8909e3f9492bf650926db954
+  data.tar.gz: '0480eb4e02291f2a3a0a6c4151f01de65e4031ee0416474148d713e0cc938f8c9a85c3e031fa1aa520e5be70a94c0e8ad9c343c981149e5e9653984f6f92cdac'

data/lib/pi_customizer/builder/prepare_start_execute_builder.rb

@@ -27,10 +27,10 @@ module PiCustomizer
       protected def start
         @env.check
         @env.prepare
+        @env.start
       end
 
       protected def execute
-        @env.start
         @env.build_image
       end
 

data/lib/pi_customizer/builder/start_prepare_execute_builder.rb

@@ -22,7 +22,7 @@ require 'pi_customizer/builder/builder'
 
 module PiCustomizer
   module Builder
-    class StartStopBuilder < PiBuilder
+    class StartExecuteBuilder < PiBuilder
 
       protected def start
         @env.check

data/lib/pi_customizer/environment/environment_builder_factory.rb

@@ -38,16 +38,16 @@ module PiCustomizer
     ENV_DOCKER = 'DOCKER'
     ENV_ECHO = 'ECHO'
 
-    def Environment.environment_builder_factory(env, local_config, workspace)
+    def Environment.environment_builder_factory(env, local_workspace, remote_workspace)
 
-      environment = environment_factory(env, local_config, workspace)
+      environment = environment_factory(env, local_workspace, remote_workspace)
 
       case env
         when ENV_AWS, ENV_VAGRANT
           env_builder = Builder::PrepareExecuteBuilder.new(environment)
         when ENV_DOCKER, ENV_ECHO
-          puts "Echo: - Git Path: #{workspace.git_path}, Workspace Path: #{workspace.workspace_directory}, Config Path: #{local_config.config_path}"
-          env_builder = Builder::StartStopBuilder.new(environment)
+          puts "Echo: - Git Path: #{remote_workspace.git_path}, Workspace Path: #{remote_workspace.workspace_directory}, Config Path: #{local_workspace.config_path}"
+          env_builder = Builder::StartExecuteBuilder.new(environment)
         else
           $logger.warn 'No valid build environment defined!'
           env_builder = Builder::PiBuilder.new(environment)
@@ -55,19 +55,19 @@ module PiCustomizer
       env_builder
     end
 
-    def Environment.environment_factory(env, local_config, workspace)
+    def Environment.environment_factory(env, local_workspace, remote_workspace)
       case env
         when ENV_AWS
-          environment = AWS.new(workspace, local_config)
+          environment = AWS.new(remote_workspace, local_workspace)
         when ENV_VAGRANT
-          environment = Vagrant.new(workspace, local_config)
+          environment = Vagrant.new(remote_workspace, local_workspace)
         when ENV_DOCKER
-          environment = Docker.new(workspace, local_config)
+          environment = Docker.new(remote_workspace, local_workspace)
         when ENV_ECHO
-          environment = EnvironmentControl.new(workspace, local_config)
+          environment = EnvironmentControl.new(remote_workspace, local_workspace)
         else
           $logger.info 'NO valid environment (e.g., AWS or VAGRANT) defined!'
-          environment = EnvironmentControl.new(workspace, local_config)
+          environment = EnvironmentControl.new(remote_workspace, local_workspace)
       end
       environment
     end

data/lib/pi_customizer/environment/vagrant/templates/Vagrantfile.erb

@@ -1,44 +1,57 @@
 # -*- mode: ruby -*-
 # vi: set ft=ruby :
 
-require 'fileutils'
-
 $dependencies = <<SCRIPT
 sudo apt update
 sudo apt -y upgrade
 sudo apt -y install quilt parted qemu-user-static debootstrap zerofree pxz zip dosfstools libcap2-bin bsdtar
-sudo apt -y install git curl ruby-full
+sudo apt -y install git curl ruby-full build-essential
 SCRIPT
 
-$prepare = <<SCRIPT
+$install_modifier_gem = <<SCRIPT
 # install gem
-gem install pi_customizer --pre
-mkdir -p <%= workspace %>
-if [ -f "<%= workspace %>" ]; then
-  git clone <%= git_path %> <%= workspace %>
+<% if config.modifier_gem_path.nil? %>gem install pi_build_modifier --pre <% else %>gem install /home/ubuntu/pi_build_modifier.gem<% end %>
+SCRIPT
+
+$prepare = <<SCRIPT
+mkdir -p <%= workspace.workspace_directory %>
+if [ -f "<%= workspace.workspace_directory %>" ]; then
+  echo 'git pull to workspace'
+  git pull <%= workspace.git_path %> <%= workspace.workspace_directory %> -r
 else
-  git pull <%= git_path %> -r
-end
+  echo 'git clone to workspace'
+  git clone <%= workspace.git_path %> <%= workspace.workspace_directory %>
+fi
 SCRIPT
 
 $modify = <<SCRIPT
 # Execute gem with parameters
-cd  <%= workspace %>
-pi_build_modifier modify --config-file=<%= config_file_destination %>
-sh build.sh
-mv deploy/* /vagrant
+cd  <%= workspace.workspace_directory %>
+pi_build_modifier modify <%= config_file_destination %> <%= workspace.workspace_directory %>
+sudo ./build.sh
+cp -r deploy /vagrant
 SCRIPT
 
 Vagrant.configure('2') do |config|
 
-  config.vm.box = 'debian/stretch64'
+  config.vm.box = 'ubuntu/xenial64' #Note, that 'debian/stretch64' cannot be resized with the disksize plugin
+
+  unless Vagrant.has_plugin?("vagrant-disksize")
+    raise 'vagrant-disksize plugin is not installed! Use: vagrant plugin install vagrant-disksize'
+  end
+
   config.disksize.size = '<%= disk_size %>'
 
   # Prepare environment by updating the dependencies
   config.vm.provision 'shell', inline: $dependencies
 
+  <% unless config.modifier_gem_path.nil? %>config.vm.provision 'file', source: '<%= config.modifier_gem_path.to_s %>', destination: '/home/ubuntu/pi_build_modifier.gem' <% end %>
+
+  # Modifier gem is installed
+  config.vm.provision 'shell', inline: $install_modifier_gem
+
   # Copy config file
-  config.vm.provision "file", source: "<%= config_file_source %>", destination: "<%= config_file_destination %>"
+  config.vm.provision 'file', source: '<%= config.config_path.to_s %>', destination: '<%= config_file_destination %>'
 
   # Prepare the modification
   config.vm.provision 'shell', inline: $prepare

data/lib/pi_customizer/environment/vagrant/vagrant.rb

@@ -27,7 +27,7 @@ module PiCustomizer
   module Environment
     class Vagrant < EnvironmentControl
 
-      VAGRANT_PATH = File.join(File.dirname(__FILE__), '/templates')
+      VAGRANT_SOURCE = File.join(File.dirname(__FILE__), '/templates')
 
       def check
         $logger.info '[Check] Pre-flight checks are executing...'
@@ -36,20 +36,22 @@ module PiCustomizer
 
       def prepare
         $logger.info '[Prepare] pi-image in vagrant environment'
-        VagrantFileRenderer.new(VagrantFile.new(@config_path, @workspace)).create_from_template
+        VagrantFileRenderer.new(VagrantFile.new(@config, @workspace)).create_from_template
       end
 
       def start
         $logger.info '[Start] pi-image in local vagrant environment'
-        Dir.chdir(VAGRANT_PATH) do
+        Dir.chdir(@config.tmp_directory) do
           system 'vagrant destroy -f' # cleanup old environment
           system 'vagrant up --provider=virtualbox --no-provision'
         end
       end
 
       def build_image
-        system 'vagrant provision'
-        #TODO: push finished product to some destination, e.g. an S3 bucket
+        $logger.info '[Build] pi-image in local vagrant environment'
+        Dir.chdir(@config.tmp_directory) do
+          system 'vagrant provision'
+        end
       end
 
       def clean_up
@@ -58,20 +60,10 @@ module PiCustomizer
 
       def stop
         $logger.info '[Stop] pi-image in local vagrant environment'
-        Dir.chdir(VAGRANT_PATH) do
-          system 'vagrant destroy -f'
-        end
-      end
-
-=begin
-      def build
-        $logger.info 'Building pi-image in local vagrant environment'
-        Dir.chdir(VAGRANT_PATH) do
+        Dir.chdir(@config.tmp_directory) do
           system 'vagrant destroy -f'
-          system 'vagrant up --provider=virtualbox --provision'
         end
       end
-=end
 
       def ensure_vagrant
         unless system 'vagrant -v'

data/lib/pi_customizer/environment/vagrant/vagrant_file.rb

@@ -21,28 +21,31 @@
 require 'erb'
 require 'fileutils'
 require 'pi_customizer/workspace/remote_workspace'
+require 'pi_customizer/workspace/local_workspace'
 
 module PiCustomizer
   module Environment
+
+    ##
+    # VagrantFile describes the dynamic attributes of the Vagrantfile which is used to start up the vagrant environment
+
     class VagrantFile
 
-      attr_accessor :vagrant_path, :disk_size, :config_file_destination, :config_file_source, :workspace, :git_path
+      attr_accessor :vagrant_template_path, :disk_size, :config_file_destination, :workspace, :config
 
-      def initialize(config_path, workspace)
-        @vagrant_path = File.join(File.dirname(__FILE__), '/templates/')
-        @disk_size = '20GB'
-        @config_file_destination = '~/conf.json'
-        if config_path.nil? || config_path.empty?
-          @config_file_source = 'conf.json'
+      def initialize(config, workspace)
+        @vagrant_template_path = File.join(File.dirname(__FILE__), '/templates/Vagrantfile.erb')
+        @disk_size = '40GB'
+        @config_file_destination = '/vagrant/conf.json'
+        if config.nil?
+          @config = Workspace::LocalWorkspace.new
         else
-          @config_file_source = config_path
+          @config = config
         end
         if workspace.nil?
-          @git_path = Workspace::DEFAULT_GIT_PATH
-          @workspace =Workspace::DEFAULT_WORKSPACE_DIRECTORY
+          @workspace = Workspace::RemoteWorkspace.new
         else
-          @git_path = workspace.git_path
-          @workspace = workspace.workspace_directory
+          @workspace = workspace
         end
       end
 
@@ -51,41 +54,42 @@ module PiCustomizer
       end
 
     end
-  end
 
-  class VagrantFileRenderer
 
-    def initialize(vagrant_file)
-      @vagrant_file = vagrant_file
-    end
+    class VagrantFileRenderer
 
-    def create_from_template
-      check_dependencies
-      read_template
-      write_rendered
-    end
+      def initialize(vagrant_file)
+        @vagrant_file = vagrant_file
+      end
 
-    private def check_dependencies
-      unless File.file?(@vagrant_file.vagrant_path.to_s + 'Vagrantfile.erb')
-        raise "'Vagrantfile.erb' template not specified. Searching in path '%s'" % [@vagrant_file.vagrant_path]
+      def create_from_template
+        check_dependencies
+        read_template
+        write_vagrantfile
+      end
+
+      private def check_dependencies
+        unless File.file?(@vagrant_file.vagrant_template_path.to_s)
+          raise "'Vagrantfile.erb' template not specified. Expected template in path '%s'" % [@vagrant_file.vagrant_template_path]
+        end
       end
-    end
 
-    private def read_template
-      File.open(@vagrant_file.vagrant_path.to_s + 'Vagrantfile.erb', 'r+') do |f|
-        @template = f.read
+      private def read_template
+        File.open(@vagrant_file.vagrant_template_path.to_s, 'r+') do |f|
+          @template = f.read
+        end
       end
-    end
 
-    def render
-      ERB.new(@template).result(@vagrant_file.get_binding)
-    end
+      def render
+        ERB.new(@template).result(@vagrant_file.get_binding)
+      end
 
-    private def write_rendered
-      File.open(@vagrant_file.vagrant_path.to_s + 'Vagrantfile', 'w+') do |f|
-        f.write(render)
+      private def write_vagrantfile
+        FileUtils.mkdir_p @vagrant_file.config.tmp_directory
+        File.open(@vagrant_file.config.tmp_directory.to_s + '/Vagrantfile', 'w+') do |f|
+          f.write(render)
+        end
       end
     end
-
   end
 end

data/lib/pi_customizer/version.rb

@@ -19,5 +19,9 @@
 # SOFTWARE.
 
 module PiCustomizer
-  VERSION = '0.1.1-alpha'
+
+  ##
+  # The current version of the pi_customizer gem
+
+  VERSION = '0.1.2-alpha'
 end

data/lib/pi_customizer/workspace/local_workspace.rb

@@ -19,32 +19,74 @@
 # SOFTWARE.
 
 require 'fileutils'
+require 'pathname'
 require 'pi_customizer/utils/logex'
 
 module PiCustomizer
   module Workspace
 
+    ##
+    # The default path which points to the configuration file
+
     DEFAULT_CONFIG_PATH = File.join(File.dirname(__FILE__), '/../../../envs/config.json')
-    DEFAULT_TMP_DIRECTORY = Dir.getwd + '/tmp'
 
-    class LocalConfig
+    ##
+    # The default directory which is used to store temporary build files, e.g., the Vagrantfile for a build with vagrant
+
+    DEFAULT_TMP_DIRECTORY = Dir.pwd + '/tmp'
+
+    ##
+    # The LocalWorkspace class encapsulates the configuration of the workspace on the machine where the build of the pi image is triggered
+
+    class LocalWorkspace
+
+      attr_reader :config_path, :tmp_directory, :modifier_gem_path
+
+      def initialize(config_path = '', tmp_directory = '', modifier_gem_path = '')
+        self.config_path = config_path
+        self.tmp_directory = tmp_directory
+        self.modifier_gem_path = modifier_gem_path
+        $logger.debug "Local Workspace is at '#{@config_path}' with tmp directory '#{@tmp_directory}' and modifier_gem_path '#{@modifier_gem_path}'"
+      end
+
+      ##
+      # Checks for value equality between a pair of LocalWorkspace's attributes
 
-      attr_reader :config_path, :tmp_directory
+      def ==(other)
+        (@tmp_directory == other.tmp_directory) && (@modifier_gem_path == other.modifier_gem_path) && (@config_path == other.config_path)
+      end
 
-      def initialize(config_path = '', tmp_directory = '')
+      private def config_path=(config_path)
         @config_path = if config_path.nil? or config_path == ''
-                         DEFAULT_CONFIG_PATH
+                         Pathname.new(DEFAULT_CONFIG_PATH)
                        else
-                         config_path.to_s
+                         absolute_path_name(config_path)
                        end
+      end
+
+      private def tmp_directory=(tmp_directory)
         @tmp_directory = if tmp_directory.nil? or tmp_directory == ''
-                           DEFAULT_TMP_DIRECTORY
+                           Pathname.new(DEFAULT_TMP_DIRECTORY)
                          else
-                           tmp_directory.to_s
+                           absolute_path_name(tmp_directory)
                          end
-        $logger.debug "Local Config at '#{@config_path}' with tmp dir '#{@tmp_directory}'"
       end
 
+      private def modifier_gem_path=(modifier_gem_path)
+        @modifier_gem_path = if modifier_gem_path.nil? or modifier_gem_path == ''
+                               nil
+                             else
+                               absolute_path_name(modifier_gem_path)
+                             end
+      end
+
+      private def absolute_path_name(path)
+        tmp_path = Pathname.new(path)
+        if tmp_path.relative?
+          tmp_path = File.expand_path(path, Dir.pwd)
+        end
+        tmp_path
+      end
     end
   end
 end

data/lib/pi_customizer/workspace/remote_workspace.rb

@@ -27,7 +27,10 @@ module PiCustomizer
     DEFAULT_WORKSPACE_DIRECTORY = '/build/pi-gen'
     DEFAULT_GIT_PATH = 'https://github.com/ottenwbe/pi-gen.git'
 
-    class Workspace
+    ##
+    # The RemoteWorkspace class encapsulates the configuration of the workspace in the build environment
+
+    class RemoteWorkspace
 
       attr_reader :git_path, :workspace_directory
 
@@ -46,6 +49,13 @@ module PiCustomizer
         $logger.debug "Workspace at '#{@workspace_directory}' with source '#{@git_path}'"
       end
 
+      ##
+      # Checks for value equality between a pair of RemoteWorkspace's attributes
+
+      def ==(other)
+        (@git_path == other.git_path) && (@workspace_directory == other.workspace_directory)
+      end
+
     end
   end
 end

data/lib/pi_customizer.rb

@@ -28,24 +28,25 @@ require 'pi_customizer/workspace/local_workspace'
 module PiCustomizer
 
   ##
-  # The pi_customizer's cli
+  # PiCustomizer defines all of pi_customizer's cli commands
 
   class PiCustomizer < Thor
 
     ##
     # The build command can be called to trigger a build of a pi image
 
-    desc 'build ENV', 'Build pi image on environment ENV (options are AWS or VAGRANT).'
-    method_option :git_path, :default => Workspace::DEFAULT_GIT_PATH, :aliases => '-g'
+    desc 'build ENV', 'Build pi image on environment ENV (valid environments are DOCKER, AWS or VAGRANT).'
+    method_option :git_build_sources, :default => Workspace::DEFAULT_GIT_PATH, :aliases => '-g'
     method_option :workspace, :default => Workspace::DEFAULT_WORKSPACE_DIRECTORY, :aliases => '-w'
     method_option :deploy_dir, :default => Dir.getwd, :aliases => '-d'
     method_option :config_file, :default => Workspace::DEFAULT_CONFIG_PATH, :aliases => '-c'
     method_option :tmp_folder, :default => Workspace::DEFAULT_TMP_DIRECTORY, :aliases => '-t'
+    method_option :modifier_gem_path, :default => '', :aliases => '-m'
     def build(env)
       begin
-        workspace = Workspace::Workspace.new("#{options[:workspace]}", "#{options[:git_path]}")
-        local_config = Workspace::LocalConfig.new("#{options[:config_file]}", "#{options[:tmp_folder]}")
-        builder = Environment::environment_builder_factory(env, local_config, workspace)
+        remote_workspace = Workspace::RemoteWorkspace.new("#{options[:workspace]}", "#{options[:git_build_sources]}")
+        local_workspace = Workspace::LocalWorkspace.new("#{options[:config_file]}", "#{options[:tmp_folder]}", "#{options[:modifier_gem_path]}")
+        builder = Environment::environment_builder_factory(env, local_workspace, remote_workspace)
         builder.build
       rescue Exception => e
         $logger.error e.message

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pi_customizer
 version: !ruby/object:Gem::Version
-  version: 0.1.1.pre.alpha
+  version: 0.1.2.pre.alpha
 platform: ruby
 authors:
 - Beate Ottenwälder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-09 00:00:00.000000000 Z
+date: 2017-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler