pi_build_modifier 0.3.0.pre.alpha → 0.3.1.pre.alpha

data/pi_customizer/lib/pi_customizer/build/environment/environment_builder_factory.rb

@@ -0,0 +1,81 @@
+# Copyright (c) 2017-2019 Beate Ottenwälder
+#
+# 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.
+
+require 'pi_customizer/build/environment/environment'
+require 'pi_customizer/build/environment/aws/aws'
+require 'pi_customizer/build/environment/vagrant/vagrant'
+require 'pi_customizer/build/environment/docker/docker'
+require 'pi_customizer/build/builder/builder'
+require 'pi_customizer/build/builder/prepare_start_execute_builder'
+require 'pi_customizer/build/builder/start_prepare_execute_builder'
+require 'pi_customizer/build/workspace/remote_workspace'
+require 'pi_customizer/build/workspace/local_workspace'
+require 'pi_customizer/utils/logex'
+
+
+module PiCustomizer
+  module Environment
+
+    ENV_AWS = 'AWS'
+    ENV_VAGRANT = 'VAGRANT'
+    ENV_DOCKER = 'DOCKER'
+    ENV_ECHO = 'ECHO'
+
+    ##
+    # The builder_factory creates a builder for the selected environment env. The builder orchestrates the environment and the build process in the environment.
+
+    def Environment.builder_factory(env, local_workspace, remote_workspace, skip_build_steps)
+
+      environment = environment_factory(env, local_workspace, remote_workspace)
+
+      case env
+        when ENV_AWS, ENV_VAGRANT
+          env_builder = Builder::PrepareExecuteBuilder.new(environment, skip_build_steps)
+        when ENV_DOCKER, ENV_ECHO
+          puts "Echo: - Git Path: #{remote_workspace.git_path}, Workspace Path: #{remote_workspace.workspace_directory}, Config Path: #{local_workspace.config_path}, #{skip_build_steps}"
+          env_builder = Builder::StartExecuteBuilder.new(environment, skip_build_steps)
+        else
+          $logger.warn 'No valid build environment defined!'
+          env_builder = Builder::PiBuilder.new(environment, skip_build_steps)
+      end
+      env_builder
+    end
+
+    ##
+    # The environment_factory creates an environment configuration tailored to the selected build environment env
+
+    def Environment.environment_factory(env, local_workspace, remote_workspace)
+      case env
+        when ENV_AWS
+          environment = AWS.new(remote_workspace, local_workspace)
+        when ENV_VAGRANT
+          environment = Vagrant.new(remote_workspace, local_workspace)
+        when ENV_DOCKER
+          environment = Docker.new(remote_workspace, local_workspace)
+        when ENV_ECHO
+          environment = EnvironmentControl.new(remote_workspace, local_workspace)
+        else
+          $logger.warn 'No valid environment (e.g., AWS or VAGRANT) defined!'
+          environment = EnvironmentControl.new(remote_workspace, local_workspace)
+      end
+      environment
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+$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 build-essential
+sudo apt -y install wpasupplicant openssl libssl-dev
+SCRIPT
+
+$install_modifier_gem = <<SCRIPT
+# install gem
+<% 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
+rm -rf <%= workspace.workspace_directory %>
+mkdir -p <%= workspace.workspace_directory %>
+echo 'git clone to workspace'
+git clone --branch <%= workspace.git_tag %> <%= workspace.git_path %> <%= workspace.workspace_directory %>
+SCRIPT
+
+$modify = <<SCRIPT
+# Execute gem with parameters
+cd  <%= workspace.workspace_directory %>
+pi_build_modifier modify <%= config_file_destination %> <%= workspace.workspace_directory %>
+sudo ./build.sh
+mkdir -p <%= workspace.workspace_directory %>/deploy
+cp -r <%= workspace.workspace_directory %>/deploy /vagrant
+echo "Pi Image copied to your local workspace <%= config.workspace_directory.to_s %>"
+SCRIPT
+
+Vagrant.configure('2') do |config|
+
+  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.config_path.to_s %>', destination: '<%= config_file_destination %>'
+
+  # Prepare the modification
+  config.vm.provision 'shell', inline: $prepare
+
+  # Actually modify the build sources and then build the environment
+  config.vm.provision 'shell', inline: $modify
+
+end

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

@@ -0,0 +1,77 @@
+# Copyright (c) 2017-2019 Beate Ottenwälder
+#
+# 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.
+
+require 'fileutils'
+require 'pi_customizer/build/environment/vagrant/vagrant_file'
+require 'pi_customizer/build/environment/environment'
+require 'pi_customizer/utils/logex'
+
+module PiCustomizer
+  module Environment
+    class Vagrant < EnvironmentControl
+
+      VAGRANT_SOURCE = File.join(File.dirname(__FILE__), '/templates')
+
+      def check
+        $logger.info '[Check] Pre-flight checks are executing...'
+        ensure_vagrant
+      end
+
+      def prepare
+        $logger.info '[Prepare] pi-image in vagrant environment'
+        VagrantFileRenderer.new(VagrantFile.new(@config, @workspace)).create_from_template
+      end
+
+      def start
+        $logger.info '[Start] pi-image in local vagrant environment'
+        Dir.chdir(@config.workspace_directory) do
+          system 'vagrant destroy -f' # cleanup old environment
+          system 'vagrant up --provider=virtualbox --no-provision'
+        end
+      end
+
+      def build_image
+        $logger.info '[Build] pi-image in local vagrant environment'
+        Dir.chdir(@config.workspace_directory) do
+          system 'vagrant provision'
+        end
+      end
+
+      def clean_up
+        $logger.info '[Clean Up] pi-image in local vagrant environment'
+      end
+
+      def stop
+        $logger.info '[Stop] pi-image in local vagrant environment'
+        Dir.chdir(@config.workspace_directory) do
+          system 'vagrant destroy -f'
+        end
+      end
+
+      def ensure_vagrant
+        unless system 'vagrant -v'
+          raise 'Vagrant not installed. Please ensure that vagrant is installed correctly.'
+        end
+      end
+    end
+
+  end
+end
+

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

@@ -0,0 +1,95 @@
+# Copyright (c) 2017-2019 Beate Ottenwälder
+#
+# 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.
+
+require 'erb'
+require 'fileutils'
+require 'pi_customizer/build/workspace/remote_workspace'
+require 'pi_customizer/build/workspace/local_workspace'
+
+module PiCustomizer
+  module Environment
+
+    ##
+    # VagrantFile describes the dynamic attributes of a Vagrantfile which is used to start up the vagrant environment
+
+    class VagrantFile
+
+      attr_accessor :vagrant_template_path, :disk_size, :config_file_destination, :workspace, :config
+
+      def initialize(config, workspace)
+        @vagrant_template_path = File.join(File.dirname(__FILE__), '/templates/Vagrantfile.erb')
+        @disk_size = '60GB'
+        @config_file_destination = '/vagrant/config.json'
+        @config = if config.nil?
+                    Workspace::LocalWorkspace.new
+                  else
+                    config
+                  end
+        @workspace = if workspace.nil?
+                       Workspace::RemoteWorkspace.new
+                     else
+                       workspace
+                     end
+      end
+
+      def get_binding
+        binding
+      end
+
+    end
+
+
+    class VagrantFileRenderer
+
+      def initialize(vagrant_file)
+        @vagrant_file = vagrant_file
+      end
+
+      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
+
+      private def read_template
+        File.open(@vagrant_file.vagrant_template_path.to_s, 'r+') do |f|
+          @template = f.read
+        end
+      end
+
+      def render
+        ERB.new(@template).result(@vagrant_file.get_binding)
+      end
+
+      private def write_vagrantfile
+        FileUtils.mkdir_p @vagrant_file.config.workspace_directory
+        File.open(@vagrant_file.config.workspace_directory.to_s + '/Vagrantfile', 'w+') do |f|
+          f.write(render)
+        end
+      end
+    end
+  end
+end

data/pi_customizer/lib/pi_customizer/build/workspace/local_workspace.rb

@@ -0,0 +1,92 @@
+# Copyright (c) 2017-2019 Beate Ottenwälder
+#
+# 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.
+
+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__), '/../../../../resources/config.json')
+
+    ##
+    # The default directory which is used to store temporary build files, e.g., the Vagrantfile for a build with vagrant
+
+    DEFAULT_LOCAL_WORKSPACE_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, :workspace_directory, :modifier_gem_path
+
+      def initialize(config_path = '', workspace_directory = '', modifier_gem_path = '')
+        self.config_path = config_path
+        self.workspace_directory = workspace_directory
+        self.modifier_gem_path = modifier_gem_path
+        $logger.debug "Local Workspace is at '#{@config_path}' with tmp directory '#{@workspace_directory}' and modifier_gem_path '#{@modifier_gem_path}'"
+      end
+
+      ##
+      # Checks for value equality between a pair of LocalWorkspace's attributes
+
+      def ==(other)
+        (@workspace_directory == other.workspace_directory) && (@modifier_gem_path == other.modifier_gem_path) && (@config_path == other.config_path)
+      end
+
+      private def config_path=(config_path)
+        @config_path = if config_path.nil? or config_path == ''
+                         Pathname.new(DEFAULT_CONFIG_PATH)
+                       else
+                         absolute_path_name(config_path)
+                       end
+      end
+
+      private def workspace_directory=(workspace_directory)
+        @workspace_directory = if workspace_directory.nil? or workspace_directory == ''
+                           Pathname.new(DEFAULT_LOCAL_WORKSPACE_DIRECTORY)
+                         else
+                           absolute_path_name(workspace_directory)
+                         end
+      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/pi_customizer/lib/pi_customizer/build/workspace/remote_workspace.rb

@@ -0,0 +1,79 @@
+# Copyright (c) 2017-2019 Beate Ottenwälder
+#
+# 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.
+
+require 'fileutils'
+require 'pi_customizer/utils/logex'
+
+module PiCustomizer
+  module Workspace
+
+    ##
+    # the default directory at the build environment where the build sources are cloned to
+
+    DEFAULT_REMOTE_WORKSPACE_DIRECTORY = '/build/pi-gen'
+
+    ##
+    # the default directory for the build sources
+
+    DEFAULT_GIT_PATH = 'https://github.com/ottenwbe/pi-gen.git'
+
+    ##
+    # the default directory for the build sources
+
+    DEFAULT_GIT_TAG = 'master'    
+
+    ##
+    # The RemoteWorkspace class encapsulates the configuration of the workspace in the build environment
+
+    class RemoteWorkspace
+
+      attr_reader :git_path, :workspace_directory, :git_tag
+
+      def initialize(workspace_dir = '', git_path = '', git_tag = '')
+        @workspace_directory = if workspace_dir.nil? or workspace_dir == ''
+                                 DEFAULT_REMOTE_WORKSPACE_DIRECTORY
+                               else
+                                 workspace_dir.to_s
+                               end
+        @git_path = if git_path.nil? or git_path == ''
+                      DEFAULT_GIT_PATH
+                    else
+                      git_path.to_s
+                    end
+        @git_tag = if git_tag.nil? or git_tag == ''
+                      DEFAULT_GIT_TAG
+                    else
+                      git_tag.to_s
+                    end                    
+        $logger.debug "Workspace at '#{@workspace_directory}' with sources from '#{@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) && (@git_tag == other.git_tag)
+      end
+
+    end
+  end
+end
+
+

data/pi_customizer/lib/pi_customizer/utils/logex.rb

@@ -0,0 +1,25 @@
+# Copyright (c) 2017-2019 Beate Ottenwälder
+#
+# 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.
+
+require 'logger'
+
+module PiCustomizer
+  $logger = Logger.new(STDOUT)
+end

data/pi_customizer/lib/pi_customizer/version.rb

@@ -0,0 +1,27 @@
+# Copyright (c) 2017-2019 Beate Ottenwälder
+#
+# 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.
+
+module PiCustomizer
+
+  ##
+  # The current version of the pi_customizer gem
+
+  VERSION = '0.3.1.pre.alpha'
+end

data/pi_customizer/lib/pi_customizer/write/image_writer.rb

@@ -0,0 +1,67 @@
+# Copyright (c) 2017-2019 Beate Ottenwälder
+#
+# 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.
+
+require 'pi_customizer/utils/logex'
+
+module PiCustomizer
+
+  ##
+  # ImageWriter writes raspberry pi images to devices (e.g., SD cards)
+
+  class ImageWriter
+
+    def initialize()
+      @zip_formats = ['.zip']
+      @img_formats = ['.img']
+    end
+
+    ##
+    # writes zipped (or unzipped) images to a given device
+
+    def write(image, device)
+      dispatch_write(image, device)
+    end
+
+    private def dispatch_write(image, device)
+      extension = File.extname(image)
+      if @zip_formats.include? extension
+        write_zip(image, device)
+      elsif @img_formats.include? extension
+        write_img(image, device)
+      else
+        raise 'No valid image format'
+      end
+    end
+
+    private def write_zip(image, device)
+      run("unzip -p #{image} | dd of=#{device} bs=4M conv=fsync")
+    end
+
+    private def write_img(image, device)
+      run("dd if=#{image} of=#{device} bs=4M conv=fsync")
+    end
+
+    private def run(command)
+      system command
+    end
+
+  end
+end
+