pi_customizer 0.4.0.pre.alpha → 0.5.0.pre.alpha

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

@@ -11,7 +11,7 @@ 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 %>
+<% if config.modifier_gem_path.nil? %>gem install pi_build_modifier --pre <% else %>gem install /home/vagrant/pi_build_modifier.gem<% end %>
 SCRIPT
 
 $prepare = <<SCRIPT
@@ -44,7 +44,7 @@ Vagrant.configure('2') do |config|
   # 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 %>
+  <% unless config.modifier_gem_path.nil? %>config.vm.provision 'file', source: '<%= config.modifier_gem_path.to_s %>', destination: '/home/vagrant/pi_build_modifier.gem' <% end %>
 
   # Modifier gem is installed
   config.vm.provision 'shell', inline: $install_modifier_gem

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

@@ -27,16 +27,15 @@ 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
+        check_vagrant
       end
 
       def prepare
         $logger.info '[Prepare] pi-image in vagrant environment'
         VagrantFileRenderer.new(VagrantFile.new(@config, @workspace)).create_from_template
+        system 'vagrant box update' # cleanup old environment
       end
 
       def start
@@ -54,10 +53,6 @@ module PiCustomizer
         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
@@ -65,7 +60,7 @@ module PiCustomizer
         end
       end
 
-      def ensure_vagrant
+      def check_vagrant
         unless system 'vagrant -v'
           raise 'Vagrant not installed. Please ensure that vagrant is installed correctly.'
         end

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

@@ -20,8 +20,8 @@
 
 require 'erb'
 require 'fileutils'
-require 'pi_customizer/build/workspace/remote_workspace'
-require 'pi_customizer/build/workspace/local_workspace'
+require 'pi_customizer/build/config/remote_workspace'
+require 'pi_customizer/build/config/local_workspace'
 
 module PiCustomizer
   module Environment
@@ -38,7 +38,7 @@ module PiCustomizer
         @disk_size = '60GB'
         @config_file_destination = '/vagrant/config.json'
         @config = if config.nil?
-                    Workspace::LocalWorkspace.new
+                    Workspace::LocalWorkspaceConfig.new
                   else
                     config
                   end

data/pi_customizer/lib/pi_customizer/version.rb

@@ -23,5 +23,5 @@ module PiCustomizer
   ##
   # The current version of the pi_customizer gem
 
-  VERSION = '0.4.0.pre.alpha'
+  VERSION = '0.5.0.pre.alpha'
 end

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

@@ -40,6 +40,7 @@ module PiCustomizer
     end
 
     private def dispatch_write(image, device)
+      puts "Note: Writing #{image} to #{device} requires sudo privileges"
       extension = File.extname(image)
       if @zip_formats.include? extension
         write_zip(image, device)
@@ -51,11 +52,11 @@ module PiCustomizer
     end
 
     private def write_zip(image, device)
-      run("unzip -p #{image} | dd of=#{device} bs=4M conv=fsync")
+      run("unzip -p #{image} | sudo dd of=#{device} bs=4M conv=fsync")
     end
 
     private def write_img(image, device)
-      run("dd if=#{image} of=#{device} bs=4M conv=fsync")
+      run("sudo dd if=#{image} of=#{device} bs=4M conv=fsync")
     end
 
     private def run(command)

data/pi_customizer/spec/pi_customizer/build/builder/builder_spec.rb

@@ -0,0 +1,122 @@
+# 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_relative '../../../spec_helper'
+require 'rspec'
+require 'pi_customizer/build/builder/builder'
+require 'pi_customizer/build/config/build_config'
+require 'pi_customizer/build/environment/environment_factory'
+
+describe PiCustomizer::Builder do
+
+  context 'Builder' do
+
+    it 'triggers the build executor' do
+      expect_any_instance_of(PiCustomizer::Builder::BuildExecutor).to receive(:check)
+      expect_any_instance_of(PiCustomizer::Builder::BuildExecutor).to receive(:stop)
+      builder = PiCustomizer::Builder::PiBuilder.new
+      builder.build(PiCustomizer::Environment::environment_factory(PiCustomizer::Environment::ENV_ECHO, nil, nil), PiCustomizer::Config::BuildConfig.new([]))
+    end
+
+  end
+
+  context 'BuildExecutor' do
+
+    it 'honors skipping the build step prepare' do
+      build_exec = PiCustomizer::Builder::BuildExecutor.new(PiCustomizer::Environment::EnvironmentControl.new('', ''), PiCustomizer::Config::BuildConfig.new([:prepare]))
+      expect(build_exec.env).not_to receive(:prepare)
+      build_exec.prepare
+    end
+
+    it 'honors skipping the build step start' do
+      build_exec = PiCustomizer::Builder::BuildExecutor.new(PiCustomizer::Environment::EnvironmentControl.new('', ''), PiCustomizer::Config::BuildConfig.new([:start]))
+      expect(build_exec.env).not_to receive(:start)
+      build_exec.start
+    end
+
+    it 'honors skipping the build step' do
+      build_exec = PiCustomizer::Builder::BuildExecutor.new(PiCustomizer::Environment::EnvironmentControl.new('', ''), PiCustomizer::Config::BuildConfig.new([:build_image]))
+      expect(build_exec.env).not_to receive(:build_image)
+      build_exec.build_image
+    end
+
+    it 'honors skipping the publish step' do
+      build_exec = PiCustomizer::Builder::BuildExecutor.new(PiCustomizer::Environment::EnvironmentControl.new('', ''), PiCustomizer::Config::BuildConfig.new([:publish]))
+      expect(build_exec.env).not_to receive(:publish)
+      build_exec.publish
+    end
+
+    it 'honors skipping the build step clean' do
+      build_exec = PiCustomizer::Builder::BuildExecutor.new(PiCustomizer::Environment::EnvironmentControl.new('', ''), PiCustomizer::Config::BuildConfig.new([:clean_up]))
+      expect(build_exec.env).not_to receive(:clean_up)
+      build_exec.clean_up
+    end
+
+    it 'honors skipping the build step stop' do
+      build_exec = PiCustomizer::Builder::BuildExecutor.new(PiCustomizer::Environment::EnvironmentControl.new('', ''), PiCustomizer::Config::BuildConfig.new([:stop]))
+      expect(build_exec.env).not_to receive(:stop)
+      build_exec.stop
+    end
+
+    it 'honors not skipping the build step check' do
+      build_exec = PiCustomizer::Builder::BuildExecutor.new(PiCustomizer::Environment::EnvironmentControl.new('', ''), PiCustomizer::Config::BuildConfig.new([]))
+      expect(build_exec.env).to receive(:check)
+      build_exec.check
+    end
+
+    it 'honors not skipping the build step prepare' do
+      build_exec = PiCustomizer::Builder::BuildExecutor.new(PiCustomizer::Environment::EnvironmentControl.new('', ''), PiCustomizer::Config::BuildConfig.new([]))
+      expect(build_exec.env).to receive(:prepare)
+      build_exec.prepare
+    end
+
+    it 'honors not skipping the build step start' do
+      build_exec = PiCustomizer::Builder::BuildExecutor.new(PiCustomizer::Environment::EnvironmentControl.new('', ''), PiCustomizer::Config::BuildConfig.new([]))
+      expect(build_exec.env).to receive(:start)
+      build_exec.start
+    end
+
+    it 'honors not skipping the build step' do
+      build_exec = PiCustomizer::Builder::BuildExecutor.new(PiCustomizer::Environment::EnvironmentControl.new('', ''), PiCustomizer::Config::BuildConfig.new([]))
+      expect(build_exec.env).to receive(:build_image)
+      build_exec.build_image
+    end
+
+    it 'honors not skipping the publish step' do
+      build_exec = PiCustomizer::Builder::BuildExecutor.new(PiCustomizer::Environment::EnvironmentControl.new('', ''), PiCustomizer::Config::BuildConfig.new([]))
+      expect(build_exec.env).to receive(:publish)
+      build_exec.publish
+    end
+
+    it 'honors not skipping the build step clean' do
+      build_exec = PiCustomizer::Builder::BuildExecutor.new(PiCustomizer::Environment::EnvironmentControl.new('', ''), PiCustomizer::Config::BuildConfig.new([]))
+      expect(build_exec.env).to receive(:clean_up)
+      build_exec.clean_up
+    end
+
+    it 'honors not skipping the build step stop' do
+      build_exec = PiCustomizer::Builder::BuildExecutor.new(PiCustomizer::Environment::EnvironmentControl.new('', ''), PiCustomizer::Config::BuildConfig.new([]))
+      expect(build_exec.env).to receive(:stop)
+      build_exec.stop
+    end
+
+  end
+
+end

data/pi_customizer/spec/pi_customizer/{environment/aws_spec.rb → build/config/build_config_spec.rb}

@@ -18,40 +18,35 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-require_relative '../../spec_helper'
-require 'pi_customizer/build/environment/aws/aws'
-require 'fileutils'
-require 'pathname'
+require_relative '../../../spec_helper'
+require 'pi_customizer/build/config/build_config'
 
 module PiCustomizer
-  module Environment
-    RSpec.describe AWS do
+  module Config
+    RSpec.describe BuildConfig do
 
-      let(:key_name) {'pi-test'}
-
-      it 'creates an ssh key' do
-        AWS.new(nil, '').create_keys(key_name)
-        expect(Pathname.new("ssh/#{key_name}.pem")).to be_file
-        expect(Pathname.new("ssh/#{key_name}.pub")).to be_file
+      it 'has a default config where no build steps are skipped' do
+        build_config = BuildConfig.new
+        expect(build_config.skip_build_steps.count).to eq 0
       end
 
-      it 'deletes an existing ssh key' do
-        aws = AWS.new(nil, '')
-        aws.create_keys(key_name)
-        aws.del_keys(key_name)
+      it 'allows us to specify build steps that need to be skipped' do
+        build_config = BuildConfig.new(['test'])
+        expect(build_config.skip_build_steps.count).to eq 1
+        expect(build_config.skip_build_steps).to include :test
+        expect(build_config.skip_build_steps).not_to include('test')
+      end
 
-        expect(Pathname.new("ssh/#{key_name}.pem")).to_not be_file
-        expect(Pathname.new("ssh/#{key_name}.pub")).to_not be_file
+      it 'allows us to query for individually skipped build steps' do
+        build_config = BuildConfig.new(['test'])
+        expect(build_config.skip? :test).to be true
       end
 
-      after(:each) do
-        if File.file?("ssh/#{key_name}.pub")
-          FileUtils.rm "ssh/#{key_name}.pem"
-        end
-        if File.file?("ssh/#{key_name}.pub")
-          FileUtils.rm "ssh/#{key_name}.pub"
-        end
+      it 'allows us to query for build steps that are not skipped' do
+        build_config = BuildConfig.new(['test'])
+        expect(build_config.skip? :foo).to be false
       end
+
     end
   end
 end

data/pi_customizer/spec/pi_customizer/{workspace/local_workspace_spec.rb → build/config/local_workspace_config_spec.rb}

@@ -18,19 +18,19 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-require_relative '../../spec_helper'
-require 'pi_customizer/build/workspace/local_workspace'
+require_relative '../../../spec_helper'
+require 'pi_customizer/build/config/local_workspace'
 require 'fileutils'
 require 'pathname'
 
 module PiCustomizer
   module Workspace
-    RSpec.describe LocalWorkspace do
+    RSpec.describe LocalWorkspaceConfig do
 
       it 'uses default values for config_path and tmp_directory when no path is specified' do
         #Given
         #When
-        local_config = LocalWorkspace.new('', '', '')
+        local_config = LocalWorkspaceConfig.new('', '', '')
         #Then
         expect(local_config.config_path.to_s).to eq DEFAULT_CONFIG_PATH
         expect(local_config.workspace_directory.to_s).to eq DEFAULT_LOCAL_WORKSPACE_DIRECTORY
@@ -43,7 +43,7 @@ module PiCustomizer
         expected_tmp = '/home/test/tmp'
         expected_mod = '/home/test/mod.gem'
         #When
-        local_config = LocalWorkspace.new(expected_cfg, expected_tmp, expected_mod)
+        local_config = LocalWorkspaceConfig.new(expected_cfg, expected_tmp, expected_mod)
         #Then
         expect(local_config.config_path.to_s).to eq expected_cfg
         expect(local_config.workspace_directory.to_s).to eq expected_tmp
@@ -51,21 +51,21 @@ module PiCustomizer
       end
 
       it 'accepts relative paths for config_path and stores them as absolute paths' do
-        local_config = LocalWorkspace.new('a', 'b', 'c')
+        local_config = LocalWorkspaceConfig.new('a', 'b', 'c')
         expect(local_config.config_path.to_s).to eq File.join(Dir.pwd, '/a')
         expect(local_config.workspace_directory.to_s).to eq File.join(Dir.pwd, '/b')
         expect(local_config.modifier_gem_path.to_s).to eq File.join(Dir.pwd, '/c')
       end
 
       it 'allows us to check for value equality' do
-        local_config_1 = LocalWorkspace.new('a', 'b', 'c')
-        local_config_2 = LocalWorkspace.new('a', 'b', 'c')
+        local_config_1 = LocalWorkspaceConfig.new('a', 'b', 'c')
+        local_config_2 = LocalWorkspaceConfig.new('a', 'b', 'c')
         expect(local_config_1==local_config_2).to be true
       end
 
       it 'allows us to check for value inequality' do
-        local_config_1 = LocalWorkspace.new('a', 'b', 'c')
-        local_config_2 = LocalWorkspace.new('e', 'f', 'g')
+        local_config_1 = LocalWorkspaceConfig.new('a', 'b', 'c')
+        local_config_2 = LocalWorkspaceConfig.new('e', 'f', 'g')
         expect(local_config_1==local_config_2).to be false
       end
 

data/pi_customizer/spec/pi_customizer/{workspace → build/config}/remote_workspace_spec.rb

@@ -18,10 +18,10 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-require_relative '../../spec_helper'
+require_relative '../../../spec_helper'
 require 'fileutils'
 require 'pathname'
-require 'pi_customizer/build/workspace/remote_workspace'
+require 'pi_customizer/build/config/remote_workspace'
 
 
 RSpec.describe PiCustomizer::Workspace::RemoteWorkspace do

data/pi_customizer/spec/pi_customizer/{environment/vagrant/vagrant_spec.rb → build/environment/environment_builder_factory_spec.rb}

@@ -19,23 +19,27 @@
 # SOFTWARE.
 
 require_relative '../../../spec_helper'
-require 'fileutils'
-require 'pathname'
+require 'rspec'
+require 'pi_customizer/build/environment/environment_factory'
+require 'pi_customizer/build/environment/environment'
+require 'pi_customizer/build/environment/docker/docker'
 require 'pi_customizer/build/environment/vagrant/vagrant'
 
-module PiCustomizer
-  module Environment
-    RSpec.describe Vagrant do
+RSpec.describe 'environment_factory' do
 
-      let(:vagrant_env) {Vagrant.new(nil, nil)}
+  it 'creates a vagrant environment when ENV_VAGRANT is specified' do
+    env = PiCustomizer::Environment::environment_factory(PiCustomizer::Environment::ENV_VAGRANT, '', '')
+    expect(env).to be_a PiCustomizer::Environment::Vagrant
+  end
 
-      describe '#check' do
-        it 'checks for the existence of vagrant' do
-          expect(vagrant_env).to receive(:system).with('vagrant -v').and_return(true)
-          vagrant_env.check
-        end
-      end
+  it 'creates a docker environment when ENV_DOCKER is specified' do
+    env = PiCustomizer::Environment::environment_factory(PiCustomizer::Environment::ENV_DOCKER, '', '')
+    expect(env).to be_a PiCustomizer::Environment::Docker
+  end
 
-    end
+  it 'creates an echo environment when ENV_ECHO is specified' do
+    env = PiCustomizer::Environment::environment_factory(PiCustomizer::Environment::ENV_DOCKER, '', '')
+    expect(env).to be_a PiCustomizer::Environment::Docker
   end
+
 end

data/pi_customizer/spec/pi_customizer/{environment → build/environment}/environment_spec.rb

@@ -18,7 +18,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-require_relative '../../spec_helper'
+require_relative '../../../spec_helper'
 require 'rspec'
 require 'pi_customizer/build/environment/environment'
 require 'pi_customizer/utils/logex'

data/pi_customizer/spec/pi_customizer/{environment → build/environment}/vagrant/vagrant_file_spec.rb

@@ -18,9 +18,9 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-require_relative '../../../spec_helper'
+require_relative '../../../../spec_helper'
 require 'pi_customizer/build/environment/vagrant/vagrant_file'
-require 'pi_customizer/build/workspace/local_workspace'
+require 'pi_customizer/build/config/local_workspace'
 require 'fileutils'
 require 'pathname'
 
@@ -29,28 +29,28 @@ module PiCustomizer
   RSpec.describe Environment::VagrantFileRenderer do
 
     let(:tmp_dir) {'tmp_vagrant_file'}
-    let(:vagrant_file) {Environment::VagrantFile.new(Workspace::LocalWorkspace.new('', tmp_dir, ''), nil)}
+    let(:vagrant_file) {Environment::VagrantFile.new(Workspace::LocalWorkspaceConfig.new('', tmp_dir, ''), nil)}
     let(:vagrant_file_builder) {Environment::VagrantFileRenderer.new(vagrant_file)}
     let(:test_vagrant_file) {File.dirname(__FILE__) + '/../../../fixtures/TestVagrantfile'}
 
     after(:each) do
-      #FileUtils.rm_rf tmp_dir
+      FileUtils.rm_rf tmp_dir
     end
 
     it 'renders a Vagrantfile in the given temporary directory' do
       vagrant_file_builder.create_from_template
-      expect(Pathname.new(tmp_dir+'/Vagrantfile')).to be_file
+      expect(Pathname.new(tmp_dir + '/Vagrantfile')).to be_file
     end
 
     it 'renders a Vagrantfile which copies a gem to the vagrant box when the modifier_gem_path is given' do
       #Given
       gem_name = 'my_gem.gem'
-      v_file = Environment::VagrantFile.new(Workspace::LocalWorkspace.new('', tmp_dir, gem_name), nil)
+      v_file = Environment::VagrantFile.new(Workspace::LocalWorkspaceConfig.new('', tmp_dir, gem_name), nil)
       v_file_builder = Environment::VagrantFileRenderer.new(v_file)
       #When
       v_file_builder.create_from_template
       #Then
-      expect(File.read(tmp_dir+'/Vagrantfile').to_s).to match(/config.vm.provision 'file', source: [-a-zA-Z0-9'\/_]+#{gem_name}/)
+      expect(File.read(tmp_dir + '/Vagrantfile').to_s).to match(/config.vm.provision 'file', source: [-a-zA-Z0-9'\/_]+#{gem_name}/)
       #expect(File.read(tmp_dir+'/Vagrantfile').to_s).to eq File.read(test_vagrant_file).to_s
     end