pi_customizer 0.2.0.pre.alpha → 0.3.0.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5dc9b4e7152770e5dbad6a7f8539e2e63ea3fe48
-  data.tar.gz: a336cd72baf1151fb86ed2bd5397f2be82c1cc9c
+SHA256:
+  metadata.gz: 5c957ade234bf33cbd7349481dd2c37cc1353879cb8be72cb8ee065bc68c89e8
+  data.tar.gz: 5189286585e7181067bfdc4e239abbd82048091a0cba2b9579f92ff2fb590f48
 SHA512:
-  metadata.gz: 11340fbf8960862852cd043351a85e98cc76595ce15387fd91e4135f81f042f7548c5bc35966f5abd1263eea037f65a70e491dace4b34a20297b4c7639f729f7
-  data.tar.gz: f31266d2b711aa37349b918b0cba741ac58b46f706ce3af0853795b0126352ea83934b4ad67042cc40f88828e943909247fdadb2bf8377931feddd59297fccbd
+  metadata.gz: 39c92af0b676abdb9a09a8fa42d79f7c481c4d7be085ac7564b06f615b4f7f6bcbf002605da10ce187fcb5ae9586299981f9c453e190a68afba2cb51decf1a5d
+  data.tar.gz: 1961c5d1fe08a80d5e02a444892086942bbb94c6a1abc1272f53f9b466b5b9be6121ef7800cd6ae5ef888aa12c3f7a0708ab9d5ebe1023a2c2505859f3ecc459

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017 Beate Ottenwälder
+Copyright (c) 2017-2018 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

data/bin/pi_customizer

@@ -1,5 +1,25 @@
 #!/usr/bin/env ruby
 
+# Copyright (c) 2017-2018 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'
 
 PiCustomizer::PiCustomizer.start(ARGV)

data/lib/pi_customizer/{builder → build/builder}/build_executor.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2017 Beate Ottenwälder
+# Copyright (c) 2017-2018 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
@@ -18,11 +18,16 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-require 'pi_customizer/environment/environment_builder_factory'
+require 'pi_customizer/build/environment/environment_builder_factory'
 require 'pi_customizer/utils/logex'
 
 module PiCustomizer
   module Builder
+
+    ##
+    # BuildExecutor triggers the steps of a build process in a given environment (e.g., a vagrant box).
+    # It skips individual steps in the build process when they are defined as skip_build_steps.
+
     class BuildExecutor
 
       attr_reader :env, :skip_build_steps

data/lib/pi_customizer/{builder → build/builder}/builder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2017 Beate Ottenwälder
+# Copyright (c) 2017-2018 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
@@ -18,11 +18,16 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-require 'pi_customizer/environment/environment_builder_factory'
-require 'pi_customizer/builder/build_executor'
+require 'pi_customizer/build/environment/environment_builder_factory'
+require 'pi_customizer/build/builder/build_executor'
 
 module PiCustomizer
   module Builder
+
+    ##
+    # PiBuilder defines abstractly the steps of a build process.
+    # However, the concrete orchestration of the build process's steps is done by its sub-classes.
+
     class PiBuilder
 
       attr_reader :build_executor

data/lib/pi_customizer/{builder → build/builder}/prepare_start_execute_builder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2017 Beate Ottenwälder
+# Copyright (c) 2017-2018 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
@@ -18,7 +18,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-require 'pi_customizer/builder/builder'
+require 'pi_customizer/build/builder/builder'
 
 module PiCustomizer
   module Builder

data/lib/pi_customizer/{builder → build/builder}/start_prepare_execute_builder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2017 Beate Ottenwälder
+# Copyright (c) 2017-2018 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
@@ -18,7 +18,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-require 'pi_customizer/builder/builder'
+require 'pi_customizer/build/builder/builder'
 
 module PiCustomizer
   module Builder

data/lib/pi_customizer/{environment → build/environment}/aws/aws.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2017 Beate Ottenwälder
+# Copyright (c) 2017-2018 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
@@ -20,7 +20,7 @@
 
 require 'fileutils'
 require 'pi_customizer/utils/logex'
-require 'pi_customizer/environment/environment'
+require 'pi_customizer/build/environment/environment'
 
 module PiCustomizer
   module Environment

data/lib/pi_customizer/{environment → build/environment}/docker/docker.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2017 Beate Ottenwälder
+# Copyright (c) 2017-2018 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

data/lib/pi_customizer/{environment → build/environment}/environment.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2017 Beate Ottenwälder
+# Copyright (c) 2017-2018 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
@@ -22,6 +22,10 @@ require 'pi_customizer/utils/logex'
 
 module PiCustomizer
   module Environment
+
+    ##
+    # EnvironmentControl defines the build steps that must be supported for a concrete environment
+
     class EnvironmentControl
 
       attr_reader :workspace, :config

data/lib/pi_customizer/{environment → build/environment}/environment_builder_factory.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2017 Beate Ottenwälder
+# Copyright (c) 2017-2018 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
@@ -18,15 +18,15 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-require 'pi_customizer/environment/environment'
-require 'pi_customizer/environment/aws/aws'
-require 'pi_customizer/environment/vagrant/vagrant'
-require 'pi_customizer/environment/docker/docker'
-require 'pi_customizer/builder/builder'
-require 'pi_customizer/builder/prepare_start_execute_builder'
-require 'pi_customizer/builder/start_prepare_execute_builder'
-require 'pi_customizer/workspace/remote_workspace'
-require 'pi_customizer/workspace/local_workspace'
+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'
 
 
@@ -50,7 +50,7 @@ module PiCustomizer
           env_builder = Builder::StartExecuteBuilder.new(environment, skip_build_steps)
         else
           $logger.warn 'No valid build environment defined!'
-          env_builder = Builder::PiBuilder.new(environment)
+          env_builder = Builder::PiBuilder.new(environment, skip_build_steps)
       end
       env_builder
     end

data/lib/pi_customizer/{environment → build/environment}/vagrant/templates/Vagrantfile.erb

@@ -30,6 +30,7 @@ $modify = <<SCRIPT
 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

data/lib/pi_customizer/{environment → build/environment}/vagrant/vagrant.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2017 Beate Ottenwälder
+# Copyright (c) 2017-2018 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
@@ -19,9 +19,9 @@
 # SOFTWARE.
 
 require 'fileutils'
-require 'pi_customizer/environment/vagrant/vagrant_file'
+require 'pi_customizer/build/environment/vagrant/vagrant_file'
+require 'pi_customizer/build/environment/environment'
 require 'pi_customizer/utils/logex'
-require 'pi_customizer/environment/environment'
 
 module PiCustomizer
   module Environment

data/lib/pi_customizer/{environment → build/environment}/vagrant/vagrant_file.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2017 Beate Ottenwälder
+# Copyright (c) 2017-2018 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
@@ -20,8 +20,8 @@
 
 require 'erb'
 require 'fileutils'
-require 'pi_customizer/workspace/remote_workspace'
-require 'pi_customizer/workspace/local_workspace'
+require 'pi_customizer/build/workspace/remote_workspace'
+require 'pi_customizer/build/workspace/local_workspace'
 
 module PiCustomizer
   module Environment

data/lib/pi_customizer/{workspace → build/workspace}/local_workspace.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2017 Beate Ottenwälder
+# Copyright (c) 2017-2018 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
@@ -28,7 +28,7 @@ module PiCustomizer
     ##
     # The default path which points to the configuration file
 
-    DEFAULT_CONFIG_PATH = File.join(File.dirname(__FILE__), '/../../../resources/config.json')
+    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

data/lib/pi_customizer/{workspace → build/workspace}/remote_workspace.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2017 Beate Ottenwälder
+# Copyright (c) 2017-2018 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
@@ -24,7 +24,14 @@ 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'
 
     ##

data/lib/pi_customizer/utils/logex.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2017 Beate Ottenwälder
+# Copyright (c) 2017-2018 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

data/lib/pi_customizer/version.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2017 Beate Ottenwälder
+# Copyright (c) 2017-2018 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
@@ -23,5 +23,5 @@ module PiCustomizer
   ##
   # The current version of the pi_customizer gem
 
-  VERSION = '0.2.0-alpha'
+  VERSION = '0.3.0-alpha'
 end

data/lib/pi_customizer/write/image_writer.rb

@@ -0,0 +1,67 @@
+# Copyright (c) 2017-2018 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
+

data/lib/pi_customizer.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2017 Beate Ottenwälder
+# Copyright (c) 2017-2018 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
@@ -21,9 +21,10 @@
 require 'thor'
 require 'fileutils'
 require 'pi_customizer/version'
-require 'pi_customizer/environment/environment_builder_factory'
-require 'pi_customizer/workspace/remote_workspace'
-require 'pi_customizer/workspace/local_workspace'
+require 'pi_customizer/build/environment/environment_builder_factory'
+require 'pi_customizer/build/workspace/remote_workspace'
+require 'pi_customizer/build/workspace/local_workspace'
+require 'pi_customizer/write/image_writer'
 require 'pi_customizer/utils/logex'
 
 module PiCustomizer
@@ -34,7 +35,7 @@ module PiCustomizer
   class PiCustomizer < Thor
 
     ##
-    # The build command can be called by a user to trigger a build of a pi image
+    # The build command can be called by a user to trigger a customized build of a pi image
 
     desc 'build ENV', 'Build pi image on environment ENV (valid environments are DOCKER, AWS or VAGRANT).'
     method_option :build_sources_git_url, :default => Workspace::DEFAULT_GIT_PATH, :aliases => '-g'
@@ -44,6 +45,7 @@ module PiCustomizer
     method_option :modifier_gem, :default => '', :aliases => '-m', :desc => 'Path to the modifier_gem. If not specified, the most recent gem from rubygems.org is downloaded.'
     method_option :deploy_dir, :default => Dir.getwd, :aliases => '-d'
     method_option :skip_steps, :type => :array, :aliases => '-s'
+
     def build(env)
       begin
         remote_workspace = Workspace::RemoteWorkspace.new("#{options[:remote_workspace_dir]}", "#{options[:build_sources_git_url]}")
@@ -59,8 +61,23 @@ module PiCustomizer
     # The version command allows users to query for the current version of the pi_customizer gem. It is printed on the command line.
 
     desc 'v, version', 'Shows the version number.'
+
     def version
       puts VERSION
     end
+
+    ##
+    # Allow uswers to write an image to a SD card
+
+    desc 'write IMAGE DEVICE', 'Write an image to a device.'
+
+    def write_image(image, device)
+      begin
+        ImageWriter.new().write(image, device)
+      rescue Exception => e
+        $logger.error e.message
+      end
+    end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pi_customizer
 version: !ruby/object:Gem::Version
-  version: 0.2.0.pre.alpha
+  version: 0.3.0.pre.alpha
 platform: ruby
 authors:
 - Beate Ottenwälder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-29 00:00:00.000000000 Z
+date: 2018-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -112,26 +112,25 @@ files:
 - envs/aws/pi-build-env.tf
 - envs/aws/variables.tf
 - envs/docker/Dockerfile
-- envs/pi_build_modifier.gem
 - envs/sh/build-pi-img.sh
 - lib/pi_customizer.rb
-- lib/pi_customizer/builder/build_executor.rb
-- lib/pi_customizer/builder/builder.rb
-- lib/pi_customizer/builder/prepare_start_execute_builder.rb
-- lib/pi_customizer/builder/start_prepare_execute_builder.rb
-- lib/pi_customizer/environment/aws/aws.rb
-- lib/pi_customizer/environment/docker/docker.rb
-- lib/pi_customizer/environment/environment.rb
-- lib/pi_customizer/environment/environment_builder_factory.rb
-- lib/pi_customizer/environment/vagrant/templates/Vagrantfile.erb
-- lib/pi_customizer/environment/vagrant/vagrant.rb
-- lib/pi_customizer/environment/vagrant/vagrant_file.rb
+- lib/pi_customizer/build/builder/build_executor.rb
+- lib/pi_customizer/build/builder/builder.rb
+- lib/pi_customizer/build/builder/prepare_start_execute_builder.rb
+- lib/pi_customizer/build/builder/start_prepare_execute_builder.rb
+- lib/pi_customizer/build/environment/aws/aws.rb
+- lib/pi_customizer/build/environment/docker/docker.rb
+- lib/pi_customizer/build/environment/environment.rb
+- lib/pi_customizer/build/environment/environment_builder_factory.rb
+- lib/pi_customizer/build/environment/vagrant/templates/Vagrantfile.erb
+- lib/pi_customizer/build/environment/vagrant/vagrant.rb
+- lib/pi_customizer/build/environment/vagrant/vagrant_file.rb
+- lib/pi_customizer/build/workspace/local_workspace.rb
+- lib/pi_customizer/build/workspace/remote_workspace.rb
 - lib/pi_customizer/utils/logex.rb
 - lib/pi_customizer/version.rb
-- lib/pi_customizer/workspace/local_workspace.rb
-- lib/pi_customizer/workspace/remote_workspace.rb
+- lib/pi_customizer/write/image_writer.rb
 - pi_customizer.gemspec
-- resources/config.json
 homepage: https://github.com/ottenwbe/pi-gen-environment.git
 licenses:
 - MIT
@@ -152,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: The pi_customizer gem!

data/resources/config.json

@@ -1,12 +0,0 @@
-{
-  "system": {
-    "name" : "custompi",
-    "type" : "lite"
-  },
-  "ssh" : {
-    "enabled" : true
-  },
-  "wifi": {
-    "wpa_country": "DE"
-  }
-}