pi_customizer 0.3.0.pre.alpha → 0.3.1.pre.alpha

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

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

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

@@ -1,4 +1,4 @@
-# Copyright (c) 2017-2018 Beate Ottenwälder
+# 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
@@ -34,14 +34,19 @@ module PiCustomizer
 
     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
+      attr_reader :git_path, :workspace_directory, :git_tag
 
-      def initialize(workspace_dir = '', git_path = '')
+      def initialize(workspace_dir = '', git_path = '', git_tag = '')
         @workspace_directory = if workspace_dir.nil? or workspace_dir == ''
                                  DEFAULT_REMOTE_WORKSPACE_DIRECTORY
                                else
@@ -52,6 +57,11 @@ module PiCustomizer
                     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
 
@@ -59,7 +69,7 @@ module PiCustomizer
       # Checks for value equality between a pair of RemoteWorkspace's attributes
 
       def ==(other)
-        (@git_path == other.git_path) && (@workspace_directory == other.workspace_directory)
+        (@git_path == other.git_path) && (@workspace_directory == other.workspace_directory) && (@git_tag == other.git_tag)
       end
 
     end

data/{lib → pi_customizer/lib}/pi_customizer/utils/logex.rb

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

data/{lib → pi_customizer/lib}/pi_customizer/version.rb

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

data/{lib → pi_customizer/lib}/pi_customizer/write/image_writer.rb

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

data/{pi_customizer.gemspec → pi_customizer/pi_customizer.gemspec}

@@ -21,10 +21,10 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^bin/}) {|f| File.basename(f)}
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.15'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'simplecov', '~> 0.15'
-  spec.add_development_dependency 'rdoc', '~> 5.1'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rspec', '~> 3.8'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
+  spec.add_development_dependency 'rdoc', '~> 6.1'
   spec.add_runtime_dependency 'thor', '~> 0.20'
 end

data/pi_customizer/spec/fixtures/TestVagrantfile

@@ -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
+gem install /home/ubuntu/pi_build_modifier.gem
+SCRIPT
+
+$prepare = <<SCRIPT
+rm -rf /build/pi-gen
+mkdir -p /build/pi-gen
+echo 'git clone to workspace'
+git clone --branch master https://github.com/ottenwbe/pi-gen.git /build/pi-gen
+SCRIPT
+
+$modify = <<SCRIPT
+# Execute gem with parameters
+cd  /build/pi-gen
+pi_build_modifier modify /vagrant/config.json /build/pi-gen
+sudo ./build.sh
+mkdir -p /build/pi-gen/deploy
+cp -r /build/pi-gen/deploy /vagrant
+echo "Pi Image copied to your local workspace ~/workspace/pi-gen-environment/tmp_vagrant_file"
+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 = '60GB'
+
+  # Prepare environment by updating the dependencies
+  config.vm.provision 'shell', inline: $dependencies
+
+  config.vm.provision 'file', source: '~/workspace/pi-gen-environment/my_gem.gem', destination: '/home/ubuntu/pi_build_modifier.gem'
+
+  # Modifier gem is installed
+  config.vm.provision 'shell', inline: $install_modifier_gem
+
+  # Copy config file
+  config.vm.provision 'file', source: '~/workspace/pi-gen-environment/pi_customizer/lib/pi_customizer/build/workspace/../../../../resources/config.json', destination: '/vagrant/config.json'
+
+  # 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/spec/fixtures/image.img

@@ -0,0 +1 @@
+test

data/pi_customizer/spec/pi_customizer/builder/build_executor_spec.rb

@@ -0,0 +1,64 @@
+# 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/build_executor'
+require 'pi_customizer/build/environment/environment'
+
+describe PiCustomizer::Builder::BuildExecutor do
+
+  it 'internally converts keys of skip steps to symbols' do
+    build_exec = PiCustomizer::Builder::BuildExecutor.new(PiCustomizer::Environment::EnvironmentControl.new('',''), ['prepare'])
+    expect(build_exec.skip_build_steps).to include(:prepare)
+    expect(build_exec.skip_build_steps).not_to include('prepare')
+  end
+
+
+  it 'honors skipping the build step prepare' do
+    build_exec = PiCustomizer::Builder::BuildExecutor.new(PiCustomizer::Environment::EnvironmentControl.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('',''), [: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('',''), [:build_image])
+    expect(build_exec.env).not_to receive(:build_image)
+    build_exec.build_image
+  end
+
+  it 'honors skipping the build step clean' do
+    build_exec = PiCustomizer::Builder::BuildExecutor.new(PiCustomizer::Environment::EnvironmentControl.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('',''), [:stop])
+    expect(build_exec.env).not_to receive(:stop)
+    build_exec.stop
+  end
+end

data/pi_customizer/spec/pi_customizer/environment/aws_spec.rb

@@ -0,0 +1,57 @@
+# 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 'pi_customizer/build/environment/aws/aws'
+require 'fileutils'
+require 'pathname'
+
+module PiCustomizer
+  module Environment
+    RSpec.describe AWS 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
+      end
+
+      it 'deletes an existing ssh key' do
+        aws = AWS.new(nil, '')
+        aws.create_keys(key_name)
+        aws.del_keys(key_name)
+
+        expect(Pathname.new("ssh/#{key_name}.pem")).to_not be_file
+        expect(Pathname.new("ssh/#{key_name}.pub")).to_not be_file
+      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
+      end
+    end
+  end
+end

data/pi_customizer/spec/pi_customizer/environment/environment_builder_factory_spec.rb

@@ -0,0 +1,48 @@
+# 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/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
+
+      it 'creates a vagrant environment when ENV_VAGRANT is specified' do
+        env = Environment::environment_factory(ENV_VAGRANT, '', '')
+        expect(env).to be_a Vagrant
+      end
+
+      it 'creates a docker environment when ENV_DOCKER is specified' do
+        env = Environment::environment_factory(ENV_DOCKER, '', '')
+        expect(env).to be_a Docker
+      end
+
+      it 'creates an AWS environment when ENV_AWS is specified' do
+        env = Environment::environment_factory(ENV_AWS, '', '')
+        expect(env).to be_a AWS
+      end
+
+    end
+  end
+end

data/pi_customizer/spec/pi_customizer/environment/environment_spec.rb

@@ -0,0 +1,75 @@
+# 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/environment/environment'
+require 'pi_customizer/utils/logex'
+
+RSpec.describe PiCustomizer::Environment::EnvironmentControl do
+
+  let(:environment) {PiCustomizer::Environment::EnvironmentControl.new(nil,nil)}
+
+
+  it 'warns about skipped check steps' do
+    expect($logger).to receive(:warn).with(/skipped/)
+    environment.check
+  end
+
+  it 'warns about skipped prepare steps' do
+    expect($logger).to receive(:warn).with(/skipped/)
+    environment.prepare
+  end
+
+  it 'warns about skipped start steps' do
+    expect($logger).to receive(:warn).with(/skipped/)
+    environment.start
+  end
+
+  it 'warns about skipped build steps' do
+    expect($logger).to receive(:warn).with(/skipped/)
+    environment.build_image
+  end
+
+  it 'warns about skipped publish steps' do
+    expect($logger).to receive(:warn).with(/skipped/)
+    environment.publish
+  end
+
+  it 'warns about skipped publish steps' do
+    expect($logger).to receive(:warn).with(/skipped/)
+    environment.publish
+  end
+
+  it 'warns about skipped clean_up steps' do
+    expect($logger).to receive(:warn).with(/skipped/)
+    environment.clean_up
+  end
+
+  it 'warns about skipped stop steps' do
+    expect($logger).to receive(:warn).with(/skipped/)
+    environment.stop
+  end
+
+  it 'informs about skipped ensure steps' do
+    expect($logger).to receive(:info).with(/skipped/)
+    environment.ensure
+  end
+end

data/pi_customizer/spec/pi_customizer/environment/vagrant/vagrant_file_spec.rb

@@ -0,0 +1,63 @@
+# 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 'pi_customizer/build/environment/vagrant/vagrant_file'
+require 'pi_customizer/build/workspace/local_workspace'
+require 'fileutils'
+require 'pathname'
+
+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_builder) {Environment::VagrantFileRenderer.new(vagrant_file)}
+    let(:test_vagrant_file) {File.dirname(__FILE__) + '/../../../fixtures/TestVagrantfile'}
+
+    after(:each) do
+      #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
+    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_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 eq File.read(test_vagrant_file).to_s
+    end
+
+    it 'raises an error if the Vagrantfile.erb does not exist' do
+      vagrant_file.vagrant_template_path = 'some/random/path'
+      expect {vagrant_file_builder.create_from_template}.to raise_error("'Vagrantfile.erb' template not specified. Expected template in path 'some/random/path'")
+    end
+
+  end
+end