pi_build_modifier 0.4.0.pre.alpha → 0.5.0.pre.alpha

data/pi_build_modifier/spec/pi_build_modifier_spec.rb

@@ -21,7 +21,7 @@
 require_relative 'spec_helper'
 require 'pi_build_modifier'
 require 'pi_build_modifier/version'
-require 'pi_build_modifier/modifier_task'
+require 'pi_build_modifier/modify/modifiers'
 
 RSpec.describe PiBuildModifier do
   it 'has a version number' do
@@ -62,8 +62,8 @@ RSpec.describe PiBuildModifier::PiBuildModifier do
     end
 
     it 'triggers the modifier task' do
-      expect(PiBuildModifier::Task::Modifier).to receive(:new).with(tmp_json_config, tmp_workspace).and_return(PiBuildModifier::Task::Modifier.new(tmp_json_config, tmp_workspace))
-      expect_any_instance_of(PiBuildModifier::Task::Modifier).to receive(:execute)
+      expect(PiBuildModifier::Modifiers::ModifiersBuilder).to receive(:build_defaults).with(tmp_workspace, tmp_json_config).and_return(PiBuildModifier::Modifiers::Modifiers.new)
+      expect_any_instance_of(PiBuildModifier::Modifiers::Modifiers).to receive(:modify_configs)
       PiBuildModifier::PiBuildModifier.start(['modify', tmp_json_config, tmp_workspace])
     end
   end

data/pi_build_modifier/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require 'simplecov'
+require 'rspec'
 #require 'codecov'
 
 SimpleCov.start do

data/pi_customizer/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    pi_customizer (0.5.0.pre.alpha)
+      thor (~> 0.20)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    docile (1.3.2)
+    json (2.2.0)
+    rake (12.3.2)
+    rdoc (6.1.1)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.1)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thor (0.20.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  pi_customizer!
+  rake (~> 12.3)
+  rdoc (~> 6.1)
+  rspec (~> 3.8)
+  simplecov (~> 0.16)
+
+BUNDLED WITH
+   2.0.2

data/pi_customizer/lib/pi_customizer.rb

@@ -21,9 +21,11 @@
 require 'thor'
 require 'fileutils'
 require 'pi_customizer/version'
-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/build/builder/builder'
+require 'pi_customizer/build/config/remote_workspace'
+require 'pi_customizer/build/config/local_workspace'
+require 'pi_customizer/build/config/build_config'
+require 'pi_customizer/build/environment/environment_factory'
 require 'pi_customizer/write/image_writer'
 require 'pi_customizer/utils/logex'
 
@@ -39,7 +41,7 @@ module PiCustomizer
 
     desc 'build ENV', 'Build pi image on environment ENV (valid environments are: VAGRANT).'
     method_option :build_sources_git_url, :default => Workspace::DEFAULT_GIT_PATH, :aliases => '-g'
-    method_option :build_sources_git_tag, :default => Workspace::DEFAULT_GIT_TAG, :aliases => '-t'    
+    method_option :build_sources_git_tag, :default => Workspace::DEFAULT_GIT_TAG, :aliases => '-t'
     method_option :remote_workspace_dir, :default => Workspace::DEFAULT_REMOTE_WORKSPACE_DIRECTORY, :aliases => '-w'
     method_option :config_file, :aliases => '-c', :required => true
     method_option :local_workspace_dir, :default => Workspace::DEFAULT_LOCAL_WORKSPACE_DIRECTORY, :aliases => '-l'
@@ -50,9 +52,13 @@ module PiCustomizer
     def build(env)
       begin
         remote_workspace = Workspace::RemoteWorkspace.new("#{options[:remote_workspace_dir]}", "#{options[:build_sources_git_url]}", "#{options[:build_sources_git_tag]}")
-        local_workspace = Workspace::LocalWorkspace.new("#{options[:config_file]}", "#{options[:local_workspace_dir]}", "#{options[:modifier_gem]}")
-        builder = Environment::builder_factory(env, local_workspace, remote_workspace, options[:skip_steps])
-        builder.build
+        local_workspace = Workspace::LocalWorkspaceConfig.new("#{options[:config_file]}", "#{options[:local_workspace_dir]}", "#{options[:modifier_gem]}")
+        build_config = Config::BuildConfig.new(options[:skip_steps])
+
+        environment = Environment::environment_factory(env, local_workspace, remote_workspace)
+        builder = Builder::PiBuilder.new
+
+        builder.build(environment, build_config)
       rescue Exception => e
         $logger.error e.message
       end
@@ -68,13 +74,13 @@ module PiCustomizer
     end
 
     ##
-    # Allow uswers to write an image to a SD card
+    # Allow users to write an image to a device, i.e., a SD card
 
     desc 'write IMAGE DEVICE', 'Write an image to a device.'
 
     def write_image(image, device)
       begin
-        ImageWriter.new().write(image, device)
+        ImageWriter.new.write(image, device)
       rescue Exception => e
         $logger.error e.message
       end

data/pi_customizer/lib/pi_customizer/build/builder/build_executor.rb

@@ -19,21 +19,23 @@
 # SOFTWARE.
 
 require 'pi_customizer/utils/logex'
+require 'pi_customizer/build/environment/environment'
+require 'pi_customizer/build/config/build_config'
 
 module PiCustomizer
   module Builder
 
     ##
-    # BuildExecutor triggers the steps of a build process in a given environment (e.g., a vagrant box).
+    # BuildExecutor triggers the steps of a build process for 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
+      attr_reader :env
 
-      def initialize(environment, skip_build_steps = Array.new)
+      def initialize(environment, build_config)
         @env = environment
-        @skip_build_steps = convert_to_skip(skip_build_steps)
+        @build_config = build_config
       end
 
       ##
@@ -48,7 +50,7 @@ module PiCustomizer
       # execute the prepare step for the build environment
 
       def prepare
-        unless @skip_build_steps.include?(:prepare)
+        unless @build_config.skip?(:prepare)
           @env.prepare
         end
       end
@@ -57,7 +59,7 @@ module PiCustomizer
       # execute the start step for the build environment
 
       def start
-        unless @skip_build_steps.include?(:start)
+        unless @build_config.skip?(:start)
           @env.start
         end
       end
@@ -66,7 +68,7 @@ module PiCustomizer
       # execute the build_image step for the build environment
 
       def build_image
-        unless @skip_build_steps.include?(:build_image)
+        unless @build_config.skip?(:build_image)
           @env.build_image
         end
       end
@@ -75,7 +77,7 @@ module PiCustomizer
       # publish the image from the build environment
 
       def publish
-        unless @skip_build_steps.include?(:publish)
+        unless @build_config.skip?(:publish)
           @env.publish
         end
       end
@@ -84,7 +86,7 @@ module PiCustomizer
       # clean_up the build environment
 
       def clean_up
-        unless @skip_build_steps.include?(:clean_up)
+        unless @build_config.skip?(:clean_up)
           @env.clean_up
         end
       end
@@ -93,7 +95,7 @@ module PiCustomizer
       # execute the stop step of the environment
 
       def stop
-        unless @skip_build_steps.include?(:stop)
+        unless @build_config.skip?(:stop)
           @env.stop
         end
       end
@@ -105,20 +107,6 @@ module PiCustomizer
         @env.ensure
       end
 
-      ##
-      # convert a list of stringified build steps to a list of symbols
-
-      private def convert_to_skip(skip_build_steps)
-        if skip_build_steps.nil?
-          skip_build_steps = Array.new
-        else
-          # convert every key to a symbol
-          skip_build_steps = skip_build_steps.collect {|k| k.to_sym}
-        end
-        $logger.debug "Skipping the following build steps: #{skip_build_steps}"
-        skip_build_steps
-      end
-
       ##
       # check if an environment is specified
 

data/pi_customizer/lib/pi_customizer/build/builder/builder.rb

@@ -24,36 +24,40 @@ module PiCustomizer
   module Builder
 
     ##
-    # PiBuilder defines abstractly the steps of a build process.
+    # PiBuilder abstractly defines 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
-
-      def initialize(environment, skip_build_steps)
-        @build_executor = BuildExecutor.new(environment,skip_build_steps)
-      end
-
       ##
-      # build orchestrates an environment and therefore the build process of an image
+      # build orchestrates the build steps related to an environment and therefore the build process of an image
 
-      def build
+      def build(environment, build_config)
+        build_executor = BuildExecutor.new(environment, build_config)
         begin
-          execute_builder
+          execute_builder(build_executor)
         rescue Exception => e
           $logger.error e.message
         ensure
-          ensure_builder
+          ensure_builder(build_executor)
         end
       end
 
-      protected def ensure_builder
+      private def execute_builder(build_executor)
+        build_executor.check
+        build_executor.prepare
+        build_executor.start
+        build_executor.build_image
+        build_executor.publish
+        build_executor.stop
+        build_executor.clean_up
       end
 
-      protected def execute_builder
+      private def ensure_builder(build_executor)
+        build_executor.ensure
       end
 
     end
+
   end
 end

data/pi_customizer/{spec/pi_customizer/environment/environment_builder_factory_spec.rb → lib/pi_customizer/build/config/build_config.rb}

@@ -18,31 +18,40 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-require_relative '../../spec_helper'
-require 'rspec'
-require 'pi_customizer/build/environment/environment_builder_factory'
-require 'pi_customizer/build/environment/docker/docker'
-require 'pi_customizer/build/environment/aws/aws'
-
 module PiCustomizer
-  module Environment
-    RSpec.describe 'environment_factory' do
+  module Config
 
-      it 'creates a vagrant environment when ENV_VAGRANT is specified' do
-        env = Environment::environment_factory(ENV_VAGRANT, '', '')
-        expect(env).to be_a Vagrant
-      end
+    ##
+    # BuildConfig holds all configurations for the build execution
 
-      it 'creates a docker environment when ENV_DOCKER is specified' do
-        env = Environment::environment_factory(ENV_DOCKER, '', '')
-        expect(env).to be_a Docker
+    class BuildConfig
+      attr_reader :skip_build_steps
+
+      def initialize(skip_build_steps = Array.new)
+        @skip_build_steps = convert_to_skip(skip_build_steps)
       end
 
-      it 'creates an AWS environment when ENV_AWS is specified' do
-        env = Environment::environment_factory(ENV_AWS, '', '')
-        expect(env).to be_a AWS
+      ##
+      # check if a build step needs to be skipped
+
+      def skip?(build_step)
+        @skip_build_steps.include? build_step
       end
 
+      ##
+      # convert a list of stringified build steps to a list of symbols
+
+      private def convert_to_skip(skip_build_steps)
+        if skip_build_steps.nil?
+          skip_build_steps = Array.new
+        else
+          # convert every key to a symbol
+          skip_build_steps = skip_build_steps.collect(&:to_sym)
+        end
+        $logger.debug "Skipping the following build steps: #{skip_build_steps}"
+        skip_build_steps
+      end
     end
+
   end
 end

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

@@ -28,17 +28,17 @@ 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(Dir.pwd, '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'
+    DEFAULT_LOCAL_WORKSPACE_DIRECTORY = File.join(Dir.pwd, '/tmp')
 
     ##
-    # The LocalWorkspace class encapsulates the configuration of the workspace on the machine where the build of the pi image is triggered
+    # The LocalWorkspace class encapsulates the configuration of the config on the machine where the build of the pi image is triggered
 
-    class LocalWorkspace
+    class LocalWorkspaceConfig
 
       attr_reader :config_path, :workspace_directory, :modifier_gem_path
 
@@ -66,10 +66,10 @@ module PiCustomizer
 
       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
+                                 Pathname.new(DEFAULT_LOCAL_WORKSPACE_DIRECTORY)
+                               else
+                                 absolute_path_name(workspace_directory)
+                               end
       end
 
       private def modifier_gem_path=(modifier_gem_path)

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

@@ -40,7 +40,7 @@ module PiCustomizer
     DEFAULT_GIT_TAG = 'master'    
 
     ##
-    # The RemoteWorkspace class encapsulates the configuration of the workspace in the build environment
+    # The RemoteWorkspace class encapsulates the configuration of the config in the build environment
 
     class RemoteWorkspace
 

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

@@ -52,7 +52,7 @@ module PiCustomizer
         $logger.info '[Build| Docker] customization of build sources'
         system "sudo docker exec --tty \"$(cat cid)\" bash -c \"sudo pi_build_modifier modify #{CONFIG_PATH_IN_DOCKER}/resources.json #{@workspace.workspace_directory}\""
         $logger.info '[Build| Docker] pi-image build step'
-        system "sudo docker exec --tty \"$(cat cid)\" bash -c \"cd #{@workspace.workspace_directory} && sudo ./build.sh\"" #sudo chown docker #{@workspace.workspace_directory} &&
+        system "sudo docker exec --tty \"$(cat cid)\" bash -c \"cd #{@workspace.workspace_directory} && sudo ./build.sh\"" #sudo chown docker #{@config.workspace_directory} &&
       end
 
       def clean_up

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

@@ -24,7 +24,7 @@ module PiCustomizer
   module Environment
 
     ##
-    # EnvironmentControl defines the build steps that must be supported for a concrete environment
+    # EnvironmentControl defines the lifecycle steps of a build environment 
 
     class EnvironmentControl
 

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

@@ -18,26 +18,37 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-require 'pi_customizer/build/builder/builder'
+require 'pi_customizer/build/environment/environment'
+require 'pi_customizer/build/environment/vagrant/vagrant'
+require 'pi_customizer/build/environment/docker/docker'
+require 'pi_customizer/build/config/remote_workspace'
+require 'pi_customizer/build/config/local_workspace'
+require 'pi_customizer/utils/logex'
+
 
 module PiCustomizer
-  module Builder
-    class StartExecuteBuilder < PiBuilder
+  module Environment
 
-      protected def execute_builder
-        @build_executor.check
-        @build_executor.start
-        @build_executor.prepare
-        @build_executor.build_image
-        @build_executor.publish
-        @build_executor.clean_up
-        @build_executor.stop
-      end
+    ENV_VAGRANT = 'VAGRANT'
+    ENV_DOCKER = 'DOCKER'
+    ENV_ECHO = 'ECHO'
 
-      protected def ensure_builder
-        @build_executor.ensure
-      end
+    ##
+    # The environment_factory creates an environment controller tailored to the selected build environment env
 
+    def Environment.environment_factory(env, local_workspace, remote_workspace)
+      case env
+      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., DOCKER or VAGRANT) defined!'
+        environment = EnvironmentControl.new(remote_workspace, local_workspace)
+      end
+      environment
     end
   end
-end
+end