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

data/pi_build_modifier/spec/pi_build_modifier_spec.rb

@@ -0,0 +1,73 @@
+# 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_build_modifier'
+require 'pi_build_modifier/version'
+require 'pi_build_modifier/modifier_task'
+
+RSpec.describe PiBuildModifier do
+  it 'has a version number' do
+    expect(PiBuildModifier::VERSION).not_to be nil
+  end
+end
+
+RSpec.describe PiBuildModifier::PiBuildModifier do
+
+  it 'informs about valid commands when called with no arguments' do
+    expect {PiBuildModifier::PiBuildModifier.start([])}.to output(/Commands/).to_stdout
+  end
+
+  context '#version' do
+    it 'informs about the current version' do
+      expect {PiBuildModifier::PiBuildModifier.start(%w(version))}.to output(/#{PiBuildModifier::VERSION}/).to_stdout
+    end
+  end
+
+  context '#modify' do
+
+    let(:tmp_json_config) {'tmp_config.json'}
+    let(:tmp_workspace) {'tmp_space'}
+
+    before do
+      File.open(tmp_json_config, 'w') {|file| file.write('{}')}
+      FileUtils.mkdir_p tmp_workspace
+    end
+
+    after do
+      FileUtils.rm(tmp_json_config)
+      FileUtils.rm_rf tmp_workspace
+    end
+
+    it 'is called by thor, when "pi_build_modifier modify" is called' do
+      expect_any_instance_of(PiBuildModifier::PiBuildModifier).to receive(:modify).with(tmp_json_config, tmp_workspace)
+      PiBuildModifier::PiBuildModifier.start(['modify', tmp_json_config, tmp_workspace])
+    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)
+      PiBuildModifier::PiBuildModifier.start(['modify', tmp_json_config, tmp_workspace])
+    end
+  end
+end
+
+
+

data/pi_build_modifier/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'simplecov'
+#require 'codecov'
+
+SimpleCov.start do
+  add_filter %r{/spec/}
+end
+#  SimpleCov.formatter = SimpleCov::Formatter::Codecov
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)

data/pi_customizer/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/pi_customizer/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+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.

data/pi_customizer/README.md

@@ -0,0 +1,3 @@
+# pi_customizer
+
+see https://github.com/ottenwbe/pi-gen-environment

data/pi_customizer/Rakefile

@@ -0,0 +1,13 @@
+lib = File.join(File.dirname(__FILE__), '/lib')
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+begin
+  require 'bundler/gem_tasks'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task :default => :spec
+
+rescue LoadError
+  puts 'RSpec or Bundler is not installed. This means rake is not able to execute tests!'
+end

data/pi_customizer/Vagrantfile

@@ -0,0 +1,16 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure('2') do |config|
+
+  config.vm.box = "ubuntu/xenial64"
+
+  config.vm.provision 'shell', inline: <<-SHELL
+    sudo apt update
+    sudo apt -y install build-essential ruby-full 
+    gem install bundler 
+    cd /vagrant
+    bundle install
+    rake spec
+  SHELL
+end

data/{bin → pi_customizer/bin}/pi_customizer

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-# 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.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
@@ -37,20 +37,21 @@ module PiCustomizer
     ##
     # 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).'
+    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 :remote_workspace_dir, :default => Workspace::DEFAULT_REMOTE_WORKSPACE_DIRECTORY, :aliases => '-w'
-    method_option :config_file, :default => Workspace::DEFAULT_CONFIG_PATH, :aliases => '-c'
-    method_option :local_workspace_dir, :default => Workspace::DEFAULT_LOCAL_WORKSPACE_DIRECTORY, :aliases => '-t'
+    method_option :config_file, :aliases => '-c', :required => true
+    method_option :local_workspace_dir, :default => Workspace::DEFAULT_LOCAL_WORKSPACE_DIRECTORY, :aliases => '-l'
     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]}")
+        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::environment_builder_factory(env, local_workspace, remote_workspace, options[:skip_steps])
+        builder = Environment::builder_factory(env, local_workspace, remote_workspace, options[:skip_steps])
         builder.build
       rescue Exception => e
         $logger.error e.message

data/{lib → pi_customizer/lib}/pi_customizer/build/builder/build_executor.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
@@ -18,7 +18,6 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-require 'pi_customizer/build/environment/environment_builder_factory'
 require 'pi_customizer/utils/logex'
 
 module PiCustomizer
@@ -37,51 +36,78 @@ module PiCustomizer
         @skip_build_steps = convert_to_skip(skip_build_steps)
       end
 
+      ##
+      # check if a build environment is specified and then calls the check step for this environment
+
       def check
         check_env
         @env.check
       end
 
+      ##
+      # execute the prepare step for the build environment
+
       def prepare
         unless @skip_build_steps.include?(:prepare)
           @env.prepare
         end
       end
 
+      ##
+      # execute the start step for the build environment
+
       def start
         unless @skip_build_steps.include?(:start)
           @env.start
         end
       end
 
+      ##
+      # execute the build_image step for the build environment
+
       def build_image
         unless @skip_build_steps.include?(:build_image)
           @env.build_image
         end
       end
 
+      ##
+      # publish the image from the build environment
+
       def publish
         unless @skip_build_steps.include?(:publish)
           @env.publish
         end
       end
 
+      ##
+      # clean_up the build environment
+
       def clean_up
         unless @skip_build_steps.include?(:clean_up)
           @env.clean_up
         end
       end
 
+      ##
+      # execute the stop step of the environment
+
       def stop
         unless @skip_build_steps.include?(:stop)
           @env.stop
         end
       end
 
+      ##
+      # execute the ensure step of an environment
+
       def ensure
         @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
@@ -93,6 +119,9 @@ module PiCustomizer
         skip_build_steps
       end
 
+      ##
+      # check if an environment is specified
+
       private def check_env
         if @env.nil?
           raise 'No environment specified, please specify the "environment", e.g. Vagrant'

data/{lib → pi_customizer/lib}/pi_customizer/build/builder/builder.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
@@ -18,7 +18,6 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-require 'pi_customizer/build/environment/environment_builder_factory'
 require 'pi_customizer/build/builder/build_executor'
 
 module PiCustomizer
@@ -36,6 +35,9 @@ module PiCustomizer
         @build_executor = BuildExecutor.new(environment,skip_build_steps)
       end
 
+      ##
+      # build orchestrates an environment and therefore the build process of an image
+
       def build
         begin
           execute_builder

data/{lib → pi_customizer/lib}/pi_customizer/build/builder/prepare_start_execute_builder.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/builder/start_prepare_execute_builder.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/environment/aws/aws.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/environment/docker/docker.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/environment/environment.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/environment/environment_builder_factory.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
@@ -38,7 +38,10 @@ module PiCustomizer
     ENV_DOCKER = 'DOCKER'
     ENV_ECHO = 'ECHO'
 
-    def Environment.environment_builder_factory(env, local_workspace, remote_workspace, skip_build_steps)
+    ##
+    # 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)
 
@@ -55,6 +58,9 @@ module PiCustomizer
       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
@@ -66,7 +72,7 @@ module PiCustomizer
         when ENV_ECHO
           environment = EnvironmentControl.new(remote_workspace, local_workspace)
         else
-          $logger.info 'No valid environment (e.g., AWS or VAGRANT) defined!'
+          $logger.warn 'No valid environment (e.g., AWS or VAGRANT) defined!'
           environment = EnvironmentControl.new(remote_workspace, local_workspace)
       end
       environment

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

@@ -15,14 +15,10 @@ $install_modifier_gem = <<SCRIPT
 SCRIPT
 
 $prepare = <<SCRIPT
+rm -rf <%= workspace.workspace_directory %>
 mkdir -p <%= workspace.workspace_directory %>
-if [ -f "<%= workspace.workspace_directory %>" ]; then
-  echo 'git pull to workspace'
-  git pull <%= workspace.git_path %> <%= workspace.workspace_directory %> -r
-else
-  echo 'git clone to workspace'
-  git clone <%= workspace.git_path %> <%= workspace.workspace_directory %>
-fi
+echo 'git clone to workspace'
+git clone --branch <%= workspace.git_tag %> <%= workspace.git_path %> <%= workspace.workspace_directory %>
 SCRIPT
 
 $modify = <<SCRIPT

data/{lib → pi_customizer/lib}/pi_customizer/build/environment/vagrant/vagrant.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/environment/vagrant/vagrant_file.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
@@ -35,7 +35,7 @@ module PiCustomizer
 
       def initialize(config, workspace)
         @vagrant_template_path = File.join(File.dirname(__FILE__), '/templates/Vagrantfile.erb')
-        @disk_size = '40GB'
+        @disk_size = '60GB'
         @config_file_destination = '/vagrant/config.json'
         @config = if config.nil?
                     Workspace::LocalWorkspace.new